4 * This is the other half of the webserver. It handles the task of hooking
5 * up HTTP requests with the sessions they belong to, using HTTP cookies to
6 * keep track of things. If the HTTP request doesn't belong to any currently
7 * active session, a new session is started.
12 #include "webserver.h"
13 #include "modules_init.h"
15 /* Only one thread may manipulate SessionList at a time... */
16 pthread_mutex_t SessionListMutex;
18 wcsession *SessionList = NULL; /**< our sessions ????*/
20 pthread_key_t MyConKey; /**< TSD key for MySession() */
21 HashList *HttpReqTypes = NULL;
22 HashList *HttpHeaderHandler = NULL;
23 extern HashList *HandlerHash;
25 void DestroyHttpHeaderHandler(void *V)
28 pHdr = (OneHttpHeader*) V;
29 FreeStrBuf(&pHdr->Val);
33 void shutdown_sessions(void)
37 for (sptr = SessionList; sptr != NULL; sptr = sptr->next) {
42 void do_housekeeping(void)
45 wcsession *sessions_to_kill = NULL;
47 static int num_threads = MIN_WORKER_THREADS;
50 * Lock the session list, moving any candidates for euthanasia into
53 pthread_mutex_lock(&SessionListMutex);
55 for (sptr = SessionList; sptr != NULL; sptr = sptr->next) {
58 /** Kill idle sessions */
59 if ((time(NULL) - (sptr->lastreq)) >
60 (time_t) WEBCIT_TIMEOUT) {
64 /** Remove sessions flagged for kill */
67 /** remove session from linked list */
68 if (sptr == SessionList) {
69 SessionList = SessionList->next;
71 else for (ss=SessionList;ss!=NULL;ss=ss->next) {
72 if (ss->next == sptr) {
73 ss->next = ss->next->next;
77 sptr->next = sessions_to_kill;
78 sessions_to_kill = sptr;
81 pthread_mutex_unlock(&SessionListMutex);
84 * Now free up and destroy the culled sessions.
86 while (sessions_to_kill != NULL) {
87 lprintf(3, "Destroying session %d\n", sessions_to_kill->wc_session);
88 pthread_mutex_lock(&sessions_to_kill->SessionMutex);
89 pthread_mutex_unlock(&sessions_to_kill->SessionMutex);
90 sptr = sessions_to_kill->next;
92 session_destroy_modules(&sessions_to_kill);
93 sessions_to_kill = sptr;
98 * If there are more sessions than threads, then we should spawn
99 * more threads ... up to a predefined maximum.
101 while ( (num_sessions > num_threads)
102 && (num_threads <= MAX_WORKER_THREADS) ) {
103 spawn_another_worker_thread();
105 lprintf(3, "There are %d sessions and %d threads active.\n",
106 num_sessions, num_threads);
112 * Wake up occasionally and clean house
114 void housekeeping_loop(void)
117 sleeeeeeeeeep(HOUSEKEEPING);
124 * Create a Session id
125 * Generate a unique WebCit session ID (which is not the same thing as the
126 * Citadel session ID).
128 int GenerateSessionID(void)
130 static int seq = (-1);
133 seq = (int) time(NULL);
139 wcsession *FindSession(wcsession **wclist, ParsedHttpHdrs *Hdr, pthread_mutex_t *ListMutex)
141 wcsession *sptr, *TheSession = NULL;
143 pthread_mutex_lock(ListMutex);
145 ((sptr != NULL) && (TheSession == NULL));
148 /** If HTTP-AUTH, look for a session with matching credentials */
149 switch (Hdr->HR.got_auth)
152 if ( (Hdr->HR.SessionKey != sptr->SessionKey))
155 if ((!strcasecmp(ChrPtr(Hdr->c_username), ChrPtr(sptr->wc_username))) &&
156 (!strcasecmp(ChrPtr(Hdr->c_password), ChrPtr(sptr->wc_password))) )
160 /** If cookie-session, look for a session with matching session ID */
161 if ( (Hdr->HR.desired_session != 0) &&
162 (sptr->wc_session == Hdr->HR.desired_session))
169 pthread_mutex_unlock(ListMutex);
173 wcsession *CreateSession(int Lockable, wcsession **wclist, ParsedHttpHdrs *Hdr, pthread_mutex_t *ListMutex)
175 wcsession *TheSession;
176 lprintf(3, "Creating a new session\n");
177 TheSession = (wcsession *)
178 malloc(sizeof(wcsession));
179 memset(TheSession, 0, sizeof(wcsession));
180 TheSession->Hdr = Hdr;
181 TheSession->SessionKey = Hdr->HR.SessionKey;
182 TheSession->serv_sock = (-1);
183 TheSession->chat_sock = (-1);
184 TheSession->is_mobile = -1;
186 pthread_setspecific(MyConKey, (void *)TheSession);
188 /* If we're recreating a session that expired, it's best to give it the same
189 * session number that it had before. The client browser ought to pick up
190 * the new session number and start using it, but in some rare situations it
191 * doesn't, and that's a Bad Thing because it causes lots of spurious sessions
194 if (Hdr->HR.desired_session == 0) {
195 TheSession->wc_session = GenerateSessionID();
198 TheSession->wc_session = Hdr->HR.desired_session;
201 session_new_modules(TheSession);
204 pthread_mutex_init(&TheSession->SessionMutex, NULL);
206 if (ListMutex != NULL)
207 pthread_mutex_lock(ListMutex);
209 if (wclist != NULL) {
210 TheSession->nonce = rand();
211 TheSession->next = *wclist;
212 *wclist = TheSession;
214 if (ListMutex != NULL)
215 pthread_mutex_unlock(ListMutex);
222 * \brief Detects a 'mobile' user agent
224 int is_mobile_ua(char *user_agent) {
225 if (strstr(user_agent,"iPhone OS") != NULL) {
227 } else if (strstr(user_agent,"Windows CE") != NULL) {
229 } else if (strstr(user_agent,"SymbianOS") != NULL) {
231 } else if (strstr(user_agent, "Opera Mobi") != NULL) {
233 } else if (strstr(user_agent, "Firefox/2.0.0 Opera 9.51 Beta") != NULL) {
234 /* For some reason a new install of Opera 9.51beta decided to spoof. */
240 /* If it's a "force 404" situation then display the error and bail. */
243 hprintf("HTTP/1.1 404 Not found\r\n");
244 hprintf("Content-Type: text/plain\r\n");
245 wprintf("Not found\r\n");
249 int ReadHttpSubject(ParsedHttpHdrs *Hdr, StrBuf *Line, StrBuf *Buf)
252 void *vLine, *vHandler;
253 const char *Pos = NULL;
256 Hdr->HR.ReqLine = Line;
257 /* The requesttype... GET, POST... */
258 StrBufExtract_token(Buf, Hdr->HR.ReqLine, 0, ' ');
259 if (GetHash(HttpReqTypes, SKEY(Buf), &vLine) &&
262 Hdr->HR.eReqType = *(long*)vLine;
265 Hdr->HR.eReqType = eGET;
268 StrBufCutLeft(Hdr->HR.ReqLine, StrLength(Buf) + 1);
270 /* the HTTP Version... */
271 StrBufExtract_token(Buf, Hdr->HR.ReqLine, 1, ' ');
272 StrBufCutRight(Hdr->HR.ReqLine, StrLength(Buf) + 1);
274 if (StrLength(Buf) == 0) {
275 Hdr->HR.eReqType = eGET;
279 StrBufAppendBuf(Hdr->this_page, Hdr->HR.ReqLine, 0);
280 /* chop Filename / query arguments */
281 Args = strchr(ChrPtr(Hdr->HR.ReqLine), '?');
282 if (Args == NULL) /* whe're not that picky about params... TODO: this will spoil '&' in filenames.*/
283 Args = strchr(ChrPtr(Hdr->HR.ReqLine), '&');
285 Args ++; /* skip the ? */
286 StrBufPlain(Hdr->PlainArgs,
288 StrLength(Hdr->HR.ReqLine) -
289 (Args - ChrPtr(Hdr->HR.ReqLine)));
290 StrBufCutAt(Hdr->HR.ReqLine, 0, Args - 1);
291 } /* don't parse them yet, maybe we don't even care... */
293 /* now lookup what we are going to do with this... */
294 /* skip first slash */
295 StrBufExtract_NextToken(Buf, Hdr->HR.ReqLine, &Pos, '/');
297 StrBufExtract_NextToken(Buf, Hdr->HR.ReqLine, &Pos, '/');
299 GetHash(HandlerHash, SKEY(Buf), &vHandler),
300 Hdr->HR.Handler = (WebcitHandler*) vHandler;
301 if (Hdr->HR.Handler == NULL)
304 * If the request is prefixed by "/webcit" then chop that off. This
305 * allows a front end web server to forward all /webcit requests to us
306 * while still using the same web server port for other things.
308 if ((Hdr->HR.Handler->Flags & URLNAMESPACE) != 0)
312 /* remove the handlername from the URL */
314 StrBufCutLeft(Hdr->HR.ReqLine,
315 Pos - ChrPtr(Hdr->HR.ReqLine));
318 if (Hdr->HR.Handler != NULL) {
319 if ((Hdr->HR.Handler->Flags & BOGUS) != 0)
321 Hdr->HR.DontNeedAuth = (Hdr->HR.Handler->Flags & ISSTATIC) != 0;
327 int AnalyseHeaders(ParsedHttpHdrs *Hdr)
333 HashPos *at = GetNewHashPos(Hdr->HTTPHeaders, 0);
335 while (GetNextHashPos(Hdr->HTTPHeaders, at, &HKLen, &HashKey, &vHdr) &&
337 pHdr = (OneHttpHeader *)vHdr;
338 if (pHdr->HaveEvaluator)
339 pHdr->H(pHdr->Val, Hdr);
346 /*const char *nix(void *vptr) {return ChrPtr( (StrBuf*)vptr);}*/
349 * Read in the request
351 int ReadHTTPRequset (ParsedHttpHdrs *Hdr)
353 const char *pch, *pchs, *pche;
355 StrBuf *Line, *LastLine, *HeaderName;
360 HeaderName = NewStrBuf();
366 if (ClientGetLine(Hdr, Line) < 0) return 1;
368 if (StrLength(Line) == 0) {
373 Hdr->HTTPHeaders = NewHash(1, NULL);
374 pHdr = (OneHttpHeader*) malloc(sizeof(OneHttpHeader));
375 memset(pHdr, 0, sizeof(OneHttpHeader));
377 Put(Hdr->HTTPHeaders, HKEY("GET /"), pHdr, DestroyHttpHeaderHandler);
378 lprintf(9, "%s\n", ChrPtr(Line));
379 isbogus = ReadHttpSubject(Hdr, Line, HeaderName);
384 /* Do we need to Unfold? */
385 if ((LastLine != NULL) &&
386 (isspace(*ChrPtr(Line)))) {
387 pch = pchs = ChrPtr(Line);
388 pche = pchs + StrLength(Line);
389 while (isspace(*pch) && (pch < pche))
391 StrBufCutLeft(Line, pch - pchs);
392 StrBufAppendBuf(LastLine, Line, 0);
398 StrBufSanitizeAscii(Line, '§');
399 StrBufExtract_token(HeaderName, Line, 0, ':');
402 pch = pchs + StrLength(HeaderName) + 1;
403 pche = pchs + StrLength(Line);
404 while (isspace(*pch) && (pch < pche))
406 StrBufCutLeft(Line, pch - pchs);
408 StrBufUpCase(HeaderName);
410 pHdr = (OneHttpHeader*) malloc(sizeof(OneHttpHeader));
411 memset(pHdr, 0, sizeof(OneHttpHeader));
414 if (GetHash(HttpHeaderHandler, SKEY(HeaderName), &vF) &&
417 OneHttpHeader *FHdr = (OneHttpHeader*) vF;
419 pHdr->HaveEvaluator = 1;
421 Put(Hdr->HTTPHeaders, SKEY(HeaderName), pHdr, DestroyHttpHeaderHandler);
423 } while (Line != NULL);
425 FreeStrBuf(&HeaderName);
435 * This loop gets called once for every HTTP connection made to WebCit. At
436 * this entry point we have an HTTP socket with a browser allegedly on the
437 * other end, but we have not yet bound to a WebCit session.
439 * The job of this function is to locate the correct session and bind to it,
440 * or create a session if necessary and bind to it, then run the WebCit
441 * transaction loop. Afterwards, we unbind from the session. When this
442 * function returns, the worker thread is then free to handle another
445 void context_loop(ParsedHttpHdrs *Hdr)
448 wcsession *TheSession;
449 struct timeval tx_start;
450 struct timeval tx_finish;
452 gettimeofday(&tx_start, NULL); /* start a stopwatch for performance timing */
455 * Find out what it is that the web browser is asking for
457 isbogus = ReadHTTPRequset(Hdr);
460 isbogus = AnalyseHeaders(Hdr);
463 ((Hdr->HR.Handler != NULL) &&
464 ((Hdr->HR.Handler->Flags & BOGUS) != 0)))
468 Bogus = CreateSession(0, NULL, Hdr, NULL);
472 lprintf(9, "HTTP: 404 [%ld.%06ld] %s %s \n",
473 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) / 1000000,
474 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) % 1000000,
475 ReqStrs[Hdr->HR.eReqType],
476 ChrPtr(Hdr->this_page)
478 session_detach_modules(Bogus);
479 session_destroy_modules(&Bogus);
483 if ((Hdr->HR.Handler != NULL) &&
484 ((Hdr->HR.Handler->Flags & ISSTATIC) != 0))
487 Static = CreateSession(0, NULL, Hdr, NULL);
489 Hdr->HR.Handler->F();
491 /* How long did this transaction take? */
492 gettimeofday(&tx_finish, NULL);
495 if ((Hdr->HR.Handler == NULL) ||
496 ((Hdr->HR.Handler->Flags & LOGCHATTY) == 0))
498 lprintf(9, "HTTP: 200 [%ld.%06ld] %s %s \n",
499 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) / 1000000,
500 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) % 1000000,
501 ReqStrs[Hdr->HR.eReqType],
502 ChrPtr(Hdr->this_page)
504 session_detach_modules(Static);
505 session_destroy_modules(&Static);
509 if (Hdr->HR.got_auth == AUTH_BASIC)
513 TODO HKEY("/static/nocookies.html?force_close_session=yes"));
516 /* dbg_PrintHash(HTTPHeaders, nix, NULL); */
519 * See if there's an existing session open with the desired ID or user/pass
523 if (TheSession == NULL) {
524 TheSession = FindSession(&SessionList, Hdr, &SessionListMutex);
528 * Create a new session if we have to
530 if (TheSession == NULL) {
531 TheSession = CreateSession(1, &SessionList, Hdr, &SessionListMutex);
533 if (StrLength(Hdr->c_language) > 0) {
534 lprintf(9, "Session cookie requests language '%s'\n", ChrPtr(Hdr->c_language));
535 set_selected_language(ChrPtr(Hdr->c_language));
536 go_selected_language();
541 * A future improvement might be to check the session integrity
542 * at this point before continuing.
546 * Bind to the session and perform the transaction
548 pthread_mutex_lock(&TheSession->SessionMutex); /* bind */
549 pthread_setspecific(MyConKey, (void *)TheSession);
551 TheSession->lastreq = time(NULL); /* log */
552 TheSession->Hdr = Hdr;
554 session_attach_modules(TheSession);
555 session_loop(); /* do transaction */
558 /* How long did this transaction take? */
559 gettimeofday(&tx_finish, NULL);
562 if ((Hdr->HR.Handler == NULL) ||
563 ((Hdr->HR.Handler->Flags & LOGCHATTY) == 0))
564 lprintf(9, "HTTP: 200 [%ld.%06ld] %s %s \n",
565 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) / 1000000,
566 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) % 1000000,
567 ReqStrs[Hdr->HR.eReqType],
568 ChrPtr(Hdr->this_page)
571 session_detach_modules(TheSession);
573 TheSession->Hdr = NULL;
574 pthread_mutex_unlock(&TheSession->SessionMutex); /* unbind */
577 void tmplput_nonce(StrBuf *Target, WCTemplputParams *TP)
580 StrBufAppendPrintf(Target, "%ld",
581 (WCC != NULL)? WCC->nonce:0);
584 void tmplput_current_user(StrBuf *Target, WCTemplputParams *TP)
586 StrBufAppendTemplate(Target, TP, WC->wc_fullname, 0);
589 void tmplput_current_room(StrBuf *Target, WCTemplputParams *TP)
591 StrBufAppendTemplate(Target, TP, WC->wc_roomname, 0);
594 void Header_HandleContentLength(StrBuf *Line, ParsedHttpHdrs *hdr)
596 hdr->HR.ContentLength = StrToi(Line);
599 void Header_HandleContentType(StrBuf *Line, ParsedHttpHdrs *hdr)
601 hdr->HR.ContentType = Line;
604 void Header_HandleUserAgent(StrBuf *Line, ParsedHttpHdrs *hdr)
606 hdr->HR.user_agent = Line;
608 /* TODO: do this later on session creating
609 if ((WCC->is_mobile < 0) && is_mobile_ua(&buf[12])) {
620 void Header_HandleHost(StrBuf *Line, ParsedHttpHdrs *hdr)
622 if ((follow_xff) && (hdr->HR.http_host != NULL))
625 hdr->HR.http_host = Line;
628 void Header_HandleXFFHost(StrBuf *Line, ParsedHttpHdrs *hdr)
631 hdr->HR.http_host = Line;
635 void Header_HandleXFF(StrBuf *Line, ParsedHttpHdrs *hdr)
637 hdr->HR.browser_host = Line;
639 while (StrBufNum_tokens(hdr->HR.browser_host, ',') > 1) {
640 StrBufRemove_token(hdr->HR.browser_host, 0, ',');
642 StrBufTrim(hdr->HR.browser_host);
645 void Header_HandleIfModSince(StrBuf *Line, ParsedHttpHdrs *hdr)
647 hdr->HR.if_modified_since = httpdate_to_timestamp(Line);
650 void Header_HandleAcceptEncoding(StrBuf *Line, ParsedHttpHdrs *hdr)
655 if (strstr(&ChrPtr(Line)[16], "gzip")) {
659 const char *ReqStrs[eNONE] = {
672 ServerStartModule_CONTEXT
676 HttpReqTypes = NewHash(1, NULL);
677 HttpHeaderHandler = NewHash(1, NULL);
679 v = malloc(sizeof(long));
681 Put(HttpReqTypes, HKEY("GET"), v, NULL);
683 v = malloc(sizeof(long));
685 Put(HttpReqTypes, HKEY("POST"), v, NULL);
687 v = malloc(sizeof(long));
689 Put(HttpReqTypes, HKEY("OPTIONS"), v, NULL);
691 v = malloc(sizeof(long));
693 Put(HttpReqTypes, HKEY("PROPFIND"), v, NULL);
695 v = malloc(sizeof(long));
697 Put(HttpReqTypes, HKEY("PUT"), v, NULL);
699 v = malloc(sizeof(long));
701 Put(HttpReqTypes, HKEY("DELETE"), v, NULL);
703 v = malloc(sizeof(long));
705 Put(HttpReqTypes, HKEY("HEAD"), v, NULL);
707 v = malloc(sizeof(long));
709 Put(HttpReqTypes, HKEY("MOVE"), v, NULL);
711 v = malloc(sizeof(long));
713 Put(HttpReqTypes, HKEY("COPY"), v, NULL);
717 ServerShutdownModule_CONTEXT
720 DeleteHash(&HttpReqTypes);
721 DeleteHash(&HttpHeaderHandler);
724 void RegisterHeaderHandler(const char *Name, long Len, Header_Evaluator F)
727 pHdr = (OneHttpHeader*) malloc(sizeof(OneHttpHeader));
728 memset(pHdr, 0, sizeof(OneHttpHeader));
730 Put(HttpHeaderHandler, Name, Len, pHdr, DestroyHttpHeaderHandler);
738 RegisterHeaderHandler(HKEY("CONTENT-LENGTH"), Header_HandleContentLength);
739 RegisterHeaderHandler(HKEY("CONTENT-TYPE"), Header_HandleContentType);
740 RegisterHeaderHandler(HKEY("USER-AGENT"), Header_HandleUserAgent);
741 RegisterHeaderHandler(HKEY("X-FORWARDED-HOST"), Header_HandleXFFHost);
742 RegisterHeaderHandler(HKEY("HOST"), Header_HandleHost);
743 RegisterHeaderHandler(HKEY("X-FORWARDED-FOR"), Header_HandleXFF);
744 RegisterHeaderHandler(HKEY("ACCEPT-ENCODING"), Header_HandleAcceptEncoding);
745 RegisterHeaderHandler(HKEY("IF-MODIFIED-SINCE"), Header_HandleIfModSince);
747 RegisterNamespace("CURRENT_USER", 0, 1, tmplput_current_user, CTX_NONE);
748 RegisterNamespace("CURRENT_ROOM", 0, 1, tmplput_current_room, CTX_NONE);
749 RegisterNamespace("NONCE", 0, 0, tmplput_nonce, 0);
751 WebcitAddUrlHandler(HKEY("404"), do_404, ANONYMOUS|COOKIEUNNEEDED);
753 * Look for commonly-found probes of malware such as worms, viruses, trojans, and Microsoft Office.
754 * Short-circuit these requests so we don't have to send them through the full processing loop.
756 WebcitAddUrlHandler(HKEY("scripts"), do_404, ANONYMOUS|BOGUS); /* /root.exe /* Worms and trojans and viruses, oh my! */
757 WebcitAddUrlHandler(HKEY("c"), do_404, ANONYMOUS|BOGUS); /* /winnt */
758 WebcitAddUrlHandler(HKEY("MSADC"), do_404, ANONYMOUS|BOGUS);
759 WebcitAddUrlHandler(HKEY("_vti"), do_404, ANONYMOUS|BOGUS); /* Broken Microsoft DAV implementation */
760 WebcitAddUrlHandler(HKEY("MSOffice"), do_404, ANONYMOUS|BOGUS); /* Stoopid MSOffice thinks everyone is IIS */
761 WebcitAddUrlHandler(HKEY("nonexistenshit"), do_404, ANONYMOUS|BOGUS); /* Exploit found in the wild January 2009 */
766 HttpNewModule_CONTEXT
767 (ParsedHttpHdrs *httpreq)
769 httpreq->PlainArgs = NewStrBuf();
770 httpreq->this_page = NewStrBuf();
774 HttpDetachModule_CONTEXT
775 (ParsedHttpHdrs *httpreq)
777 FlushStrBuf(httpreq->PlainArgs);
778 FlushStrBuf(httpreq->this_page);
779 FlushStrBuf(httpreq->PlainArgs);
780 DeleteHash(&httpreq->HTTPHeaders);
781 memset(&httpreq->HR, 0, sizeof(HdrRefs));
785 HttpDestroyModule_CONTEXT
786 (ParsedHttpHdrs *httpreq)
788 FreeStrBuf(&httpreq->this_page);
789 FreeStrBuf(&httpreq->PlainArgs);
790 FreeStrBuf(&httpreq->this_page);
791 FreeStrBuf(&httpreq->PlainArgs);
792 DeleteHash(&httpreq->HTTPHeaders);