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 Hdr->this_page = NewStrBufDup(Hdr->HR.ReqLine);
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 Hdr->PlainArgs = NewStrBufPlain(
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();
361 Hdr->ReadBuf = NewStrBuf();
367 if (ClientGetLine(Hdr, Line) < 0) return 1;
369 if (StrLength(Line) == 0) {
374 Hdr->HTTPHeaders = NewHash(1, NULL);
375 pHdr = (OneHttpHeader*) malloc(sizeof(OneHttpHeader));
376 memset(pHdr, 0, sizeof(OneHttpHeader));
378 Put(Hdr->HTTPHeaders, HKEY("GET /"), pHdr, DestroyHttpHeaderHandler);
379 lprintf(9, "%s\n", ChrPtr(Line));
380 isbogus = ReadHttpSubject(Hdr, Line, HeaderName);
385 /* Do we need to Unfold? */
386 if ((LastLine != NULL) &&
387 (isspace(*ChrPtr(Line)))) {
388 pch = pchs = ChrPtr(Line);
389 pche = pchs + StrLength(Line);
390 while (isspace(*pch) && (pch < pche))
392 StrBufCutLeft(Line, pch - pchs);
393 StrBufAppendBuf(LastLine, Line, 0);
399 StrBufSanitizeAscii(Line, '§');
400 StrBufExtract_token(HeaderName, Line, 0, ':');
403 pch = pchs + StrLength(HeaderName) + 1;
404 pche = pchs + StrLength(Line);
405 while (isspace(*pch) && (pch < pche))
407 StrBufCutLeft(Line, pch - pchs);
409 StrBufUpCase(HeaderName);
411 pHdr = (OneHttpHeader*) malloc(sizeof(OneHttpHeader));
412 memset(pHdr, 0, sizeof(OneHttpHeader));
415 if (GetHash(HttpHeaderHandler, SKEY(HeaderName), &vF) &&
418 OneHttpHeader *FHdr = (OneHttpHeader*) vF;
420 pHdr->HaveEvaluator = 1;
422 Put(Hdr->HTTPHeaders, SKEY(HeaderName), pHdr, DestroyHttpHeaderHandler);
424 } while (Line != NULL);
426 FreeStrBuf(&HeaderName);
436 * This loop gets called once for every HTTP connection made to WebCit. At
437 * this entry point we have an HTTP socket with a browser allegedly on the
438 * other end, but we have not yet bound to a WebCit session.
440 * The job of this function is to locate the correct session and bind to it,
441 * or create a session if necessary and bind to it, then run the WebCit
442 * transaction loop. Afterwards, we unbind from the session. When this
443 * function returns, the worker thread is then free to handle another
446 void context_loop(ParsedHttpHdrs *Hdr)
449 wcsession *TheSession;
450 struct timeval tx_start;
451 struct timeval tx_finish;
453 gettimeofday(&tx_start, NULL); /* start a stopwatch for performance timing */
456 * Find out what it is that the web browser is asking for
458 isbogus = ReadHTTPRequset(Hdr);
461 isbogus = AnalyseHeaders(Hdr);
464 ((Hdr->HR.Handler != NULL) &&
465 ((Hdr->HR.Handler->Flags & BOGUS) != 0)))
469 Bogus = CreateSession(0, NULL, Hdr, NULL);
473 session_detach_modules(Bogus);
474 http_destroy_modules(Hdr);
475 session_destroy_modules(&Bogus);
479 if ((Hdr->HR.Handler != NULL) &&
480 ((Hdr->HR.Handler->Flags & ISSTATIC) != 0))
483 Static = CreateSession(0, NULL, Hdr, NULL);
485 Hdr->HR.Handler->F();
487 /* How long did this transaction take? */
488 gettimeofday(&tx_finish, NULL);
490 lprintf(9, "SL: Transaction [%s] completed in %ld.%06ld seconds.\n",
491 ChrPtr(Hdr->this_page),
492 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) / 1000000,
493 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) % 1000000
496 session_detach_modules(Static);
497 http_destroy_modules(Hdr);
498 session_destroy_modules(&Static);
502 if (Hdr->HR.got_auth == AUTH_BASIC)
506 TODO HKEY("/static/nocookies.html?force_close_session=yes"));
509 /* dbg_PrintHash(HTTPHeaders, nix, NULL); */
512 /* Begin parsing the request. * /
514 if ((strncmp(ChrPtr(ReqLine), "/sslg", 5) != 0) &&
515 (strncmp(ChrPtr(ReqLine), "/static/", 8) != 0) &&
516 (strncmp(ChrPtr(ReqLine), "/tiny_mce/", 10) != 0) &&
517 (strncmp(ChrPtr(ReqLine), "/wholist_section", 16) != 0) &&
518 (strstr(ChrPtr(ReqLine), "wholist_section") == NULL)) {
520 lprintf(5, "HTTP: %s %s\n", ReqStrs[Hdr.eReqType], ChrPtr(ReqLine));
528 * See if there's an existing session open with the desired ID or user/pass
532 if (TheSession == NULL) {
533 TheSession = FindSession(&SessionList, Hdr, &SessionListMutex);
537 * Create a new session if we have to
539 if (TheSession == NULL) {
540 TheSession = CreateSession(1, &SessionList, Hdr, &SessionListMutex);
542 if (StrLength(Hdr->c_language) > 0) {
543 lprintf(9, "Session cookie requests language '%s'\n", ChrPtr(Hdr->c_language));
544 set_selected_language(ChrPtr(Hdr->c_language));
545 go_selected_language();
550 * A future improvement might be to check the session integrity
551 * at this point before continuing.
555 * Bind to the session and perform the transaction
557 pthread_mutex_lock(&TheSession->SessionMutex); /* bind */
558 pthread_setspecific(MyConKey, (void *)TheSession);
560 TheSession->lastreq = time(NULL); /* log */
561 TheSession->Hdr = Hdr;
563 session_attach_modules(TheSession);
564 session_loop(); /* do transaction */
567 /* How long did this transaction take? */
568 gettimeofday(&tx_finish, NULL);
570 lprintf(9, "Transaction [%s] completed in %ld.%06ld seconds.\n",
571 ChrPtr(Hdr->this_page),
572 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) / 1000000,
573 ((tx_finish.tv_sec*1000000 + tx_finish.tv_usec) - (tx_start.tv_sec*1000000 + tx_start.tv_usec)) % 1000000
576 session_detach_modules(TheSession);
578 TheSession->Hdr = NULL;
579 pthread_mutex_unlock(&TheSession->SessionMutex); /* unbind */
581 http_destroy_modules(Hdr);
584 void tmplput_nonce(StrBuf *Target, WCTemplputParams *TP)
587 StrBufAppendPrintf(Target, "%ld",
588 (WCC != NULL)? WCC->nonce:0);
591 void tmplput_current_user(StrBuf *Target, WCTemplputParams *TP)
593 StrBufAppendTemplate(Target, TP, WC->wc_fullname, 0);
596 void tmplput_current_room(StrBuf *Target, WCTemplputParams *TP)
598 StrBufAppendTemplate(Target, TP, WC->wc_roomname, 0);
601 void Header_HandleContentLength(StrBuf *Line, ParsedHttpHdrs *hdr)
603 hdr->HR.ContentLength = StrToi(Line);
606 void Header_HandleContentType(StrBuf *Line, ParsedHttpHdrs *hdr)
608 hdr->HR.ContentType = Line;
611 void Header_HandleUserAgent(StrBuf *Line, ParsedHttpHdrs *hdr)
613 hdr->HR.user_agent = Line;
615 /* TODO: do this later on session creating
616 if ((WCC->is_mobile < 0) && is_mobile_ua(&buf[12])) {
627 void Header_HandleHost(StrBuf *Line, ParsedHttpHdrs *hdr)
629 if ((follow_xff) && (hdr->HR.http_host != NULL))
632 hdr->HR.http_host = Line;
635 void Header_HandleXFFHost(StrBuf *Line, ParsedHttpHdrs *hdr)
638 hdr->HR.http_host = Line;
642 void Header_HandleXFF(StrBuf *Line, ParsedHttpHdrs *hdr)
644 hdr->HR.browser_host = Line;
646 while (StrBufNum_tokens(hdr->HR.browser_host, ',') > 1) {
647 StrBufRemove_token(hdr->HR.browser_host, 0, ',');
649 StrBufTrim(hdr->HR.browser_host);
652 void Header_HandleIfModSince(StrBuf *Line, ParsedHttpHdrs *hdr)
654 hdr->HR.if_modified_since = httpdate_to_timestamp(Line);
657 void Header_HandleAcceptEncoding(StrBuf *Line, ParsedHttpHdrs *hdr)
662 if (strstr(&ChrPtr(Line)[16], "gzip")) {
666 const char *ReqStrs[eNONE] = {
679 ServerStartModule_CONTEXT
683 HttpReqTypes = NewHash(1, NULL);
684 HttpHeaderHandler = NewHash(1, NULL);
686 v = malloc(sizeof(long));
688 Put(HttpReqTypes, HKEY("GET"), v, NULL);
690 v = malloc(sizeof(long));
692 Put(HttpReqTypes, HKEY("POST"), v, NULL);
694 v = malloc(sizeof(long));
696 Put(HttpReqTypes, HKEY("OPTIONS"), v, NULL);
698 v = malloc(sizeof(long));
700 Put(HttpReqTypes, HKEY("PROPFIND"), v, NULL);
702 v = malloc(sizeof(long));
704 Put(HttpReqTypes, HKEY("PUT"), v, NULL);
706 v = malloc(sizeof(long));
708 Put(HttpReqTypes, HKEY("DELETE"), v, NULL);
710 v = malloc(sizeof(long));
712 Put(HttpReqTypes, HKEY("HEAD"), v, NULL);
714 v = malloc(sizeof(long));
716 Put(HttpReqTypes, HKEY("MOVE"), v, NULL);
718 v = malloc(sizeof(long));
720 Put(HttpReqTypes, HKEY("COPY"), v, NULL);
724 ServerShutdownModule_CONTEXT
727 DeleteHash(&HttpReqTypes);
728 DeleteHash(&HttpHeaderHandler);
731 void RegisterHeaderHandler(const char *Name, long Len, Header_Evaluator F)
734 pHdr = (OneHttpHeader*) malloc(sizeof(OneHttpHeader));
735 memset(pHdr, 0, sizeof(OneHttpHeader));
737 Put(HttpHeaderHandler, Name, Len, pHdr, DestroyHttpHeaderHandler);
745 RegisterHeaderHandler(HKEY("CONTENT-LENGTH"), Header_HandleContentLength);
746 RegisterHeaderHandler(HKEY("CONTENT-TYPE"), Header_HandleContentType);
747 RegisterHeaderHandler(HKEY("USER-AGENT"), Header_HandleUserAgent);
748 RegisterHeaderHandler(HKEY("X-FORWARDED-HOST"), Header_HandleXFFHost);
749 RegisterHeaderHandler(HKEY("HOST"), Header_HandleHost);
750 RegisterHeaderHandler(HKEY("X-FORWARDED-FOR"), Header_HandleXFF);
751 RegisterHeaderHandler(HKEY("ACCEPT-ENCODING"), Header_HandleAcceptEncoding);
752 RegisterHeaderHandler(HKEY("IF-MODIFIED-SINCE"), Header_HandleIfModSince);
754 RegisterNamespace("CURRENT_USER", 0, 1, tmplput_current_user, CTX_NONE);
755 RegisterNamespace("CURRENT_ROOM", 0, 1, tmplput_current_room, CTX_NONE);
756 RegisterNamespace("NONCE", 0, 0, tmplput_nonce, 0);
758 WebcitAddUrlHandler(HKEY("404"), do_404, ANONYMOUS|COOKIEUNNEEDED);
760 * Look for commonly-found probes of malware such as worms, viruses, trojans, and Microsoft Office.
761 * Short-circuit these requests so we don't have to send them through the full processing loop.
763 WebcitAddUrlHandler(HKEY("scripts"), do_404, ANONYMOUS|BOGUS); /* /root.exe /* Worms and trojans and viruses, oh my! */
764 WebcitAddUrlHandler(HKEY("c"), do_404, ANONYMOUS|BOGUS); /* /winnt */
765 WebcitAddUrlHandler(HKEY("MSADC"), do_404, ANONYMOUS|BOGUS);
766 WebcitAddUrlHandler(HKEY("_vti"), do_404, ANONYMOUS|BOGUS); /* Broken Microsoft DAV implementation */
767 WebcitAddUrlHandler(HKEY("MSOffice"), do_404, ANONYMOUS|BOGUS); /* Stoopid MSOffice thinks everyone is IIS */
768 WebcitAddUrlHandler(HKEY("nonexistenshit"), do_404, ANONYMOUS|BOGUS); /* Exploit found in the wild January 2009 */
774 HttpDestroyModule_CONTEXT
775 (ParsedHttpHdrs *httpreq)
777 FreeStrBuf(&httpreq->ReadBuf);
778 FreeStrBuf(&httpreq->PlainArgs);
779 FreeStrBuf(&httpreq->this_page);
780 DeleteHash(&httpreq->HTTPHeaders);