2 * These functions handle authentication of users to a Citadel server.
4 * Copyright (c) 1996-2021 by the citadel.org team
6 * This program is open source software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 #include "webserver.h"
19 extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
22 * Access level definitions. This is initialized from a function rather than a
23 * static array so that the strings may be localized.
27 void initialize_axdefs(void) {
30 axdefs[0] = _("Deleted");
33 axdefs[1] = _("New User");
36 axdefs[2] = _("Problem User");
38 /* user with normal privileges */
39 axdefs[3] = _("Local User");
41 /* a user that may access network resources */
42 axdefs[4] = _("Network User");
45 axdefs[5] = _("Preferred User");
48 axdefs[6] = _("Admin");
54 * Display the login screen
55 * mesg = the error message if last attempt failed.
57 void display_login(void)
60 output_headers(1, 0, 0, 0, 1, 0);
69 /* Initialize the session
71 * This function needs to get called whenever the session changes from
72 * not-logged-in to logged-in, either by an explicit login by the user or
73 * by a timed-out session automatically re-establishing with a little help
74 * from the browser cookie. Either way, we need to load access controls and
75 * preferences from the server.
79 * serv_response The parameters returned from a Citadel USER or NEWU command
81 void become_logged_in(const StrBuf *user, const StrBuf *pass, StrBuf *serv_response)
89 if (WCC->wc_fullname == NULL)
90 WCC->wc_fullname = NewStrBufPlain(NULL, StrLength(serv_response));
91 StrBufExtract_token(WCC->wc_fullname, serv_response, 0, '|');
92 StrBufCutLeft(WCC->wc_fullname, 4 );
94 if (WCC->wc_username == NULL)
95 WCC->wc_username = NewStrBufDup(user);
97 FlushStrBuf(WCC->wc_username);
98 StrBufAppendBuf(WCC->wc_username, user, 0);
101 if (WCC->wc_password == NULL)
102 WCC->wc_password = NewStrBufDup(pass);
104 FlushStrBuf(WCC->wc_password);
105 StrBufAppendBuf(WCC->wc_password, pass, 0);
108 WCC->axlevel = StrBufExtract_int(serv_response, 1, '|');
109 if (WCC->axlevel >= 6) {
117 StrBuf_ServGetln(Buf);
118 if (GetServerStatus(Buf, NULL) == 2) {
121 pch = ChrPtr(Buf) + 4;
122 /*WCC->new_mail =*/ StrBufExtractNext_long(Buf, &pch, '|');
123 WCC->need_regi = StrBufExtractNext_long(Buf, &pch, '|');
124 WCC->need_vali = StrBufExtractNext_long(Buf, &pch, '|');
125 if (WCC->cs_inet_email == NULL)
126 WCC->cs_inet_email = NewStrBuf();
127 StrBufExtract_NextToken(WCC->cs_inet_email, Buf, &pch, '|');
129 get_preference("floordiv_expanded", &FloorDiv);
130 WCC->floordiv_expanded = FloorDiv;
137 * modal/ajax version of 'login' (username and password)
139 void ajax_login_username_password(void) {
140 StrBuf *Buf = NewStrBuf();
142 serv_printf("USER %s", bstr("name"));
143 StrBuf_ServGetln(Buf);
144 if (GetServerStatus(Buf, NULL) == 3) {
145 serv_printf("PASS %s", bstr("pass"));
146 StrBuf_ServGetln(Buf);
147 if (GetServerStatus(Buf, NULL) == 2) {
148 become_logged_in(sbstr("name"), sbstr("pass"), Buf);
152 /* The client is expecting to read back a citadel protocol response */
153 wc_printf("%s", ChrPtr(Buf));
160 * modal/ajax version of 'new user' (username and password)
162 void ajax_login_newuser(void) {
163 StrBuf *NBuf = NewStrBuf();
164 StrBuf *SBuf = NewStrBuf();
166 serv_printf("NEWU %s", bstr("name"));
167 StrBuf_ServGetln(NBuf);
168 if (GetServerStatus(NBuf, NULL) == 2) {
169 become_logged_in(sbstr("name"), sbstr("pass"), NBuf);
170 serv_printf("SETP %s", bstr("pass"));
171 StrBuf_ServGetln(SBuf);
174 /* The client is expecting to read back a citadel protocol response */
175 wc_printf("%s", ChrPtr(NBuf));
183 * Try to create an account manually after an OpenID was verified
185 void openid_manual_create(void)
189 /* Did the user change his mind? Pack up and go home. */
190 if (havebstr("exit_action")) {
192 output_headers(1, 0, 0, 0, 1, 0);
193 do_template("authpopup_finished");
199 /* Ok, let's give this a try. Can we create the new user? */
202 serv_printf("OIDC %s", bstr("name"));
203 StrBuf_ServGetln(Buf);
204 if (GetServerStatus(Buf, NULL) == 2) {
208 serv_puts("SETP GENERATE_RANDOM_PASSWORD");
209 StrBuf_ServGetln(gpass);
210 StrBufCutLeft(gpass, 4);
211 become_logged_in(sbstr("name"), gpass, Buf);
216 /* Did we manage to log in? If so, continue with the normal flow... */
220 output_headers(1, 0, 0, 0, 1, 0);
221 do_template("authpopup_finished");
225 /* Still no good! Go back to teh dialog to select a username */
227 putbstr("__claimed_id", NewStrBufDup(sbstr("openid_url")));
229 if (StrLength(Buf) > 0)
230 putbstr("__username", NewStrBufDup(Buf));
232 output_headers(1, 0, 0, 0, 1, 0);
233 wc_printf("<html><body>");
234 do_template("openid_manual_create");
235 wc_printf("</body></html>");
243 * Perform authentication using OpenID
244 * assemble the checkid_setup request and then redirect to the user's identity provider
246 void do_openid_login(void)
250 snprintf(buf, sizeof buf,
251 "OIDS %s|%s/finalize_openid_login|%s",
258 serv_getln(buf, sizeof buf);
260 syslog(LOG_DEBUG, "OpenID server contacted; redirecting to %s\n", &buf[4]);
261 http_redirect(&buf[4]);
266 output_headers(1, 0, 0, 0, 1, 0);
267 wc_printf("<html><body>");
269 wc_printf("</body></html>");
275 * Complete the authentication using OpenID
276 * This function handles the positive or negative assertion from the user's Identity Provider
278 void finalize_openid_login(void)
283 StrBuf *result = NULL;
284 StrBuf *username = NULL;
285 StrBuf *password = NULL;
286 StrBuf *logged_in_response = NULL;
287 StrBuf *claimed_id = NULL;
289 if (havebstr("openid.mode")) {
290 if (!strcasecmp(bstr("openid.mode"), "id_res")) {
293 StrBuf_ServGetln(Buf);
294 if (GetServerStatus(Buf, NULL) == 8) {
302 Cursor = GetNewHashPos (WCC->Hdr->urlstrings, 0);
303 while (GetNextHashPos(WCC->Hdr->urlstrings, Cursor, &HKLen, &HKey, &U)) {
305 if (!strncasecmp(u->url_key, "openid.", 7)) {
306 serv_printf("%s|%s", &u->url_key[7], ChrPtr(u->url_data));
313 while (len = StrBuf_ServGetln(Buf),
315 ((len != 3) || strcmp(ChrPtr(Buf), "000") )))
317 if (linecount == 0) result = NewStrBufDup(Buf);
318 if (!strcasecmp(ChrPtr(result), "authenticate")) {
319 if (linecount == 1) {
320 username = NewStrBufDup(Buf);
322 else if (linecount == 2) {
323 password = NewStrBufDup(Buf);
325 else if (linecount == 3) {
326 logged_in_response = NewStrBufDup(Buf);
329 else if (!strcasecmp(ChrPtr(result), "verify_only")) {
330 if (linecount == 1) {
331 claimed_id = NewStrBufDup(Buf);
333 if (linecount == 2) {
334 username = NewStrBufDup(Buf);
345 * Is this an attempt to associate a new OpenID with an account that is already logged in?
347 if ( (WCC->logged_in) && (havebstr("attach_existing")) ) {
351 /* If this operation logged us in, either by connecting with an existing account or by
352 * auto-creating one using Simple Registration Extension, we're already on our way.
354 else if (!strcasecmp(ChrPtr(result), "authenticate")) {
355 become_logged_in(username, password, logged_in_response);
357 /* Did we manage to log in? If so, continue with the normal flow... */
360 output_headers(1, 0, 0, 0, 1, 0);
361 do_template("authpopup_finished");
365 output_headers(1, 0, 0, 0, 1, 0);
366 wc_printf("<html><body>");
367 wc_printf(_("An error has occurred."));
368 wc_printf("</body></html>");
373 /* The specified OpenID was verified but the desired user name was either not specified via SRE
374 * or conflicts with an existing user. Either way the user will need to specify a new name.
376 else if (!strcasecmp(ChrPtr(result), "verify_only")) {
377 putbstr("__claimed_id", claimed_id);
379 if (StrLength(username) > 0) {
380 putbstr("__username", username);
384 output_headers(1, 0, 0, 0, 1, 0);
385 wc_printf("<html><body>");
386 do_template("openid_manual_create");
387 wc_printf("</body></html>");
391 /* Something went VERY wrong if we get to this point */
393 syslog(LOG_DEBUG, "finalize_openid_login() failed to do anything. This is a code problem.\n");
395 output_headers(1, 0, 0, 0, 1, 0);
396 wc_printf("<html><body>");
397 wc_printf(_("An error has occurred."));
398 wc_printf("</body></html>");
403 FreeStrBuf(&username);
404 FreeStrBuf(&password);
405 FreeStrBuf(&claimed_id);
406 FreeStrBuf(&logged_in_response);
411 * Display a welcome screen to the user.
413 void do_welcome(void) {
416 * Go to the user's preferred start page
418 if (!get_preference("startpage", &Buf)) {
420 StrBufPrintf(Buf, "dotskip?room=_BASEROOM_");
421 set_preference("startpage", Buf, 1);
423 if (ChrPtr(Buf)[0] == '/') {
424 StrBufCutLeft(Buf, 1);
426 if (StrLength(Buf) == 0) {
427 StrBufAppendBufPlain(Buf, "dotgoto?room=_BASEROOM_", -1, 0);
429 syslog(LOG_DEBUG, "Redirecting to user's start page: %s\n", ChrPtr(Buf));
430 http_redirect(ChrPtr(Buf));
435 * Disconnect from the Citadel server, and end this WebCit session
437 void end_webcit_session(void) {
440 /* close() of citadel socket will be done by do_housekeeping() */
445 * Log out the session with the Citadel server
452 FlushStrBuf(WCC->wc_username);
453 FlushStrBuf(WCC->wc_password);
454 FlushStrBuf(WCC->wc_fullname);
458 serv_getln(buf, sizeof buf);
461 FlushStrBuf(WCC->CurRoom.name);
463 /* Calling output_headers() this way causes the cookies to be un-set */
464 output_headers(1, 1, 0, 1, 0, 0);
465 do_template("logout");
466 if ((WCC->serv_info != NULL) && WCC->serv_info->serv_supports_guest) {
467 display_default_landing_page();
472 end_webcit_session();
477 * Special page for monitoring scripts etc
481 output_headers(0, 0, 0, 0, 0, 0);
483 hprintf("Content-type: text/plain\r\n"
484 "Server: " PACKAGE_STRING "\r\n"
485 "Connection: close\r\n"
489 wc_printf("Connection to Citadel server in %s : %s\r\n", ctdl_dir,
490 (WC->connected ? "SUCCESS" : "FAIL")
507 output_headers(1, 1, 1, 0, 0, 0);
509 do_template("box_begin_1");
510 StrBufAppendBufPlain(WC->WBuf, _("Validate new users"), -1, 0);
511 do_template("box_begin_2");
513 /* If the user just submitted a validation, process it... */
514 safestrncpy(buf, bstr("user"), sizeof buf);
515 if (!IsEmptyStr(buf)) {
516 if (havebstr("axlevel")) {
517 serv_printf("VALI %s|%s", buf, bstr("axlevel"));
518 serv_getln(buf, sizeof buf);
520 wc_printf("<b>%s</b><br>\n", &buf[4]);
525 /* Now see if any more users require validation. */
527 serv_getln(buf, sizeof buf);
530 wc_printf(_("No users require validation at this time."));
531 wc_printf("</b><br>\n");
536 wc_printf("<b>%s</b><br>\n", &buf[4]);
541 wc_printf("<table class=\"auth_validate\"><tr><td>\n");
542 wc_printf("<div id=\"validate\">");
544 safestrncpy(user, &buf[4], sizeof user);
545 serv_printf("GREG %s", user);
546 serv_getln(cmd, sizeof cmd);
550 serv_getln(buf, sizeof buf);
553 wc_printf("#%s<br><H1>%s</H1>",
562 while (!IsEmptyStr(pch))
566 else if (isalpha(*pch))
580 pch = _("very weak");
593 wc_printf("PW: %s<br>\n", pch);
596 wc_printf("%s<br>\n", buf);
598 wc_printf("%s<br>\n", buf);
600 wc_printf("%s, ", buf);
602 wc_printf("%s ", buf);
604 wc_printf("%s<br>\n", buf);
606 wc_printf("%s<br>\n", buf);
608 wc_printf(_("Current access level: %d (%s)\n"),
609 atoi(buf), axdefs[atoi(buf)]);
610 } while (strcmp(buf, "000"));
612 wc_printf("<H1>%s</H1>%s<br>\n", user, &cmd[4]);
616 wc_printf(_("Select access level for this user:"));
618 for (a = 0; a <= 6; ++a) {
619 wc_printf("<a href=\"validate?nonce=%d?user=", WC->nonce);
621 wc_printf("&axlevel=%d\">%s</A> \n",
626 wc_printf("</div>\n");
627 wc_printf("</td></tr></table>\n");
628 do_template("box_end");
634 * Display form for registration.
636 * (Set during_login to 1 if this registration is being performed during
637 * new user login and will require chaining to the proper screen.)
639 void display_reg(int during_login)
643 message_summary *VCMsg = NULL;
644 wc_mime_attachment *VCAtt = NULL;
648 memset(&Room, 0, sizeof(folder));
649 if (goto_config_room(Buf, &Room) != 0) {
650 syslog(LOG_WARNING, "display_reg() exiting because goto_config_room() failed\n");
664 vcard_msgnum = locate_user_vcard_in_this_room(&VCMsg, &VCAtt);
665 if (vcard_msgnum < 0L) {
666 syslog(LOG_WARNING, "display_reg() exiting because locate_user_vcard_in_this_room() failed\n");
677 do_edit_vcard(vcard_msgnum, "1", VCMsg, VCAtt, "pop", USERCONFIGROOM);
681 ReturnTo = NewStrBufPlain(HKEY("display_main_menu?go="));
682 StrBufAppendBuf(ReturnTo, WC->CurRoom.name, 0);
683 do_edit_vcard(vcard_msgnum, "1", VCMsg, VCAtt, ChrPtr(ReturnTo), USERCONFIGROOM);
684 FreeStrBuf(&ReturnTo);
691 * if passwords match, propagate it to citserver.
696 char newpass1[32], newpass2[32];
698 if (!havebstr("change_action")) {
699 AppendImportantMessage(_("Cancelled. Password was not changed."), -1);
704 safestrncpy(newpass1, bstr("newpass1"), sizeof newpass1);
705 safestrncpy(newpass2, bstr("newpass2"), sizeof newpass2);
707 if (strcasecmp(newpass1, newpass2)) {
708 AppendImportantMessage(_("They don't match. Password was not changed."), -1);
709 do_template("menu_change_pw");
713 if (IsEmptyStr(newpass1)) {
714 AppendImportantMessage(_("Blank passwords are not allowed."), -1);
715 do_template("menu_change_pw");
720 serv_printf("SETP %s", newpass1);
721 StrBuf_ServGetln(Line);
722 if (GetServerStatusMsg(Line, NULL, 1, 0) == 2) {
723 if (WC->wc_password == NULL)
724 WC->wc_password = NewStrBufPlain(
726 StrLength(Line) - 4);
728 FlushStrBuf(WC->wc_password);
729 StrBufAppendBufPlain(WC->wc_password,
731 StrLength(Line) - 4, 0);
736 do_template("menu_change_pw");
742 int ConditionalHaveAccessCreateRoom(StrBuf *Target, WCTemplputParams *TP)
748 StrBuf_ServGetln(Buf);
750 if (GetServerStatus(Buf, NULL) == 2) {
751 StrBufCutLeft(Buf, 4);
752 AppendImportantMessage(SKEY(Buf));
761 int ConditionalAide(StrBuf *Target, WCTemplputParams *TP)
764 return (WCC != NULL) ? ((WCC->logged_in == 0)||(WC->is_aide == 0)) : 0;
768 int ConditionalIsLoggedIn(StrBuf *Target, WCTemplputParams *TP)
771 return (WCC != NULL) ? (WCC->logged_in == 0) : 0;
777 * toggle the session over to a different language
779 void switch_language(void) {
780 set_selected_language(bstr("lang"));
785 void _display_reg(void) {
790 void Header_HandleAuth(StrBuf *Line, ParsedHttpHdrs *hdr)
792 if (hdr->HR.got_auth == NO_AUTH) /* don't override cookie auth... */
794 if (strncasecmp(ChrPtr(Line), "Basic", 5) == 0) {
795 StrBufCutLeft(Line, 6);
796 StrBufDecodeBase64(Line);
797 hdr->HR.plainauth = Line;
798 hdr->HR.got_auth = AUTH_BASIC;
801 syslog(LOG_WARNING, "Authentication scheme not supported! [%s]\n", ChrPtr(Line));
806 void CheckAuthBasic(ParsedHttpHdrs *hdr)
809 todo: enable this if we can have other sessions than authenticated ones.
810 if (hdr->DontNeedAuth)
813 StrBufAppendBufPlain(hdr->HR.plainauth, HKEY(":"), 0);
814 StrBufAppendBuf(hdr->HR.plainauth, hdr->HR.user_agent, 0);
818 void GetAuthBasic(ParsedHttpHdrs *hdr)
820 const char *Pos = NULL;
821 if (hdr->c_username == NULL)
822 hdr->c_username = NewStrBufPlain(HKEY(DEFAULT_HTTPAUTH_USER));
823 if (hdr->c_password == NULL)
824 hdr->c_password = NewStrBufPlain(HKEY(DEFAULT_HTTPAUTH_PASS));
825 StrBufExtract_NextToken(hdr->c_username, hdr->HR.plainauth, &Pos, ':');
826 StrBufExtract_NextToken(hdr->c_password, hdr->HR.plainauth, &Pos, ':');
830 void Header_HandleCookie(StrBuf *Line, ParsedHttpHdrs *hdr)
834 todo: enable this if we can have other sessions than authenticated ones.
835 if (hdr->DontNeedAuth)
838 pch = strstr(ChrPtr(Line), "webcit=");
843 hdr->HR.RawCookie = Line;
844 StrBufCutLeft(hdr->HR.RawCookie, (pch - ChrPtr(hdr->HR.RawCookie)) + 7);
845 StrBufDecodeHex(hdr->HR.RawCookie);
847 cookie_to_stuff(Line, &hdr->HR.desired_session,
853 hdr->HR.got_auth = AUTH_COOKIE;
859 (ParsedHttpHdrs *httpreq)
861 httpreq->c_username = NewStrBufPlain(HKEY(DEFAULT_HTTPAUTH_USER));
862 httpreq->c_password = NewStrBufPlain(HKEY(DEFAULT_HTTPAUTH_PASS));
863 httpreq->c_roomname = NewStrBuf();
864 httpreq->c_language = NewStrBuf();
869 HttpDetachModule_AUTH
870 (ParsedHttpHdrs *httpreq)
872 FLUSHStrBuf(httpreq->c_username);
873 FLUSHStrBuf(httpreq->c_password);
874 FLUSHStrBuf(httpreq->c_roomname);
875 FLUSHStrBuf(httpreq->c_language);
880 HttpDestroyModule_AUTH
881 (ParsedHttpHdrs *httpreq)
883 FreeStrBuf(&httpreq->c_username);
884 FreeStrBuf(&httpreq->c_password);
885 FreeStrBuf(&httpreq->c_roomname);
886 FreeStrBuf(&httpreq->c_language);
895 RegisterHeaderHandler(HKEY("COOKIE"), Header_HandleCookie);
896 RegisterHeaderHandler(HKEY("AUTHORIZATION"), Header_HandleAuth);
898 /* no url pattern at all? Show login. */
899 WebcitAddUrlHandler(HKEY(""), "", 0, do_welcome, ANONYMOUS|COOKIEUNNEEDED);
901 WebcitAddUrlHandler(HKEY("do_welcome"), "", 0, do_welcome, ANONYMOUS|COOKIEUNNEEDED);
902 WebcitAddUrlHandler(HKEY("openid_login"), "", 0, do_openid_login, ANONYMOUS);
903 WebcitAddUrlHandler(HKEY("finalize_openid_login"), "", 0, finalize_openid_login, ANONYMOUS);
904 WebcitAddUrlHandler(HKEY("openid_manual_create"), "", 0, openid_manual_create, ANONYMOUS);
905 WebcitAddUrlHandler(HKEY("validate"), "", 0, validate, 0);
906 WebcitAddUrlHandler(HKEY("do_welcome"), "", 0, do_welcome, 0);
907 WebcitAddUrlHandler(HKEY("display_reg"), "", 0, _display_reg, 0);
908 WebcitAddUrlHandler(HKEY("changepw"), "", 0, changepw, 0);
909 WebcitAddUrlHandler(HKEY("termquit"), "", 0, do_logout, 0);
910 WebcitAddUrlHandler(HKEY("do_logout"), "", 0, do_logout, ANONYMOUS|COOKIEUNNEEDED|FORCE_SESSIONCLOSE);
911 WebcitAddUrlHandler(HKEY("monitor"), "", 0, monitor, ANONYMOUS|COOKIEUNNEEDED|FORCE_SESSIONCLOSE);
912 WebcitAddUrlHandler(HKEY("ajax_login_username_password"), "", 0, ajax_login_username_password, AJAX|ANONYMOUS);
913 WebcitAddUrlHandler(HKEY("ajax_login_newuser"), "", 0, ajax_login_newuser, AJAX|ANONYMOUS);
914 WebcitAddUrlHandler(HKEY("switch_language"), "", 0, switch_language, ANONYMOUS);
915 RegisterConditional("COND:AIDE", 2, ConditionalAide, CTX_NONE);
916 RegisterConditional("COND:LOGGEDIN", 2, ConditionalIsLoggedIn, CTX_NONE);
917 RegisterConditional("COND:MAY_CREATE_ROOM", 2, ConditionalHaveAccessCreateRoom, CTX_NONE);
923 SessionDestroyModule_AUTH
926 FreeStrBuf(&sess->wc_username);
927 FreeStrBuf(&sess->wc_fullname);
928 FreeStrBuf(&sess->wc_password);
929 FreeStrBuf(&sess->httpauth_pass);
930 FreeStrBuf(&sess->cs_inet_email);