converted comments to get caught by doxygen
[citadel.git] / webcit / auth.c
1 /*
2  * $Id$
3  */
4 /**
5  *
6  * \defgroup WebcitAuth WebcitAuth; Handles authentication of users to a Citadel server.
7  *
8  */
9
10 /*@{*/
11 #include "webcit.h"
12
13
14
15 /**
16  * \brief  user states
17  * the plain text states of a user. filled in at \ function TODO initialize_ax_defs()
18  * due to NLS
19  */
20 char *axdefs[7]; 
21
22 void initialize_axdefs(void) {
23         axdefs[0] = _("Deleted");       /*!0: an erased user */
24         axdefs[1] = _("New User");      /*!1: a new user */
25         axdefs[2] = _("Problem User");  /*!2: a trouble maker */
26         axdefs[3] = _("Local User");    /*!3: user with normal privileges */
27         axdefs[4] = _("Network User");  /*!4: a user that may access network resources */
28         axdefs[5] = _("Preferred User");/*!5: a moderator */
29         axdefs[6] = _("Aide");          /*!6: chief */
30 }
31
32
33
34
35 /** 
36  * \brief Display the login screen
37  * \param mesg The error message if last attempt failed.
38  */
39 void display_login(char *mesg)
40 {
41         char buf[SIZ];
42
43         output_headers(1, 1, 2, 0, 0, 0);
44         wprintf("<div style=\"position:absolute; top:20px; left:20px; right:20px\">\n");
45
46         if (mesg != NULL) if (strlen(mesg) > 0) {
47                 stresc(buf, mesg, 0, 0);
48                 svprintf("mesg", WCS_STRING, "%s", buf);
49         }
50
51         svprintf("LOGIN_INSTRUCTIONS", WCS_STRING,
52                 _("<ul>"
53                 "<li><b>If you already have an account on %s</b>, "
54                 "enter your user name and password and click &quot;Login.&quot; "
55                 "<li><b>If you are a new user</b>, enter the name and password "
56                 "you wish to use, "
57                 "and click &quot;New User.&quot; "
58                 "<li>Please log off properly when finished. "
59                 "<li>You must use a browser that supports <i>frames</i> and "
60                 "<i>cookies</i>. "
61                 "<li>Also keep in mind that if your browser is "
62                 "configured to block pop-up windows, you will not be able "
63                 "to receive any instant messages.<br />"
64                 "</ul>"),
65                 serv_info.serv_humannode
66         );
67
68         svprintf("USERNAME_BOX", WCS_STRING, "%s", _("User name:"));
69         svprintf("PASSWORD_BOX", WCS_STRING, "%s", _("Password:"));
70         svprintf("LANGUAGE_BOX", WCS_STRING, "%s", _("Language:"));
71         svprintf("LOGIN_BUTTON", WCS_STRING, "%s", _("Login"));
72         svprintf("NEWUSER_BUTTON", WCS_STRING, "%s", _("New User"));
73         svprintf("EXIT_BUTTON", WCS_STRING, "%s", _("Exit"));
74         svprintf("hello", WCS_SERVCMD, "MESG hello");
75         svprintf("BOXTITLE", WCS_STRING, _("%s - powered by Citadel"),
76                 serv_info.serv_humannode);
77         svcallback("DO_LANGUAGE_BOX", offer_languages);
78
79         do_template("login");
80
81         wDumpContent(2);
82 }
83
84
85
86
87 /** \brief Initialize the session
88  * This function needs to get called whenever the session changes from
89  * not-logged-in to logged-in, either by an explicit login by the user or
90  * by a timed-out session automatically re-establishing with a little help
91  * from the browser cookie.  Either way, we need to load access controls and
92  * preferences from the server.
93  * \param user the username
94  * \param pass his password
95  * \param serv_response where to put the response ????
96  */
97 void become_logged_in(char *user, char *pass, char *serv_response)
98 {
99         char buf[SIZ];
100
101         WC->logged_in = 1;
102         extract_token(WC->wc_fullname, &serv_response[4], 0, '|', sizeof WC->wc_fullname);
103         safestrncpy(WC->wc_username, user, sizeof WC->wc_username);
104         safestrncpy(WC->wc_password, pass, sizeof WC->wc_password);
105         WC->axlevel = extract_int(&serv_response[4], 1);
106         if (WC->axlevel >= 6) {
107                 WC->is_aide = 1;
108         }
109
110         load_preferences();
111
112         serv_puts("CHEK");
113         serv_getln(buf, sizeof buf);
114         if (buf[0] == '2') {
115                 WC->new_mail = extract_int(&buf[4], 0);
116                 WC->need_regi = extract_int(&buf[4], 1);
117                 WC->need_vali = extract_int(&buf[4], 2);
118                 extract_token(WC->cs_inet_email, &buf[4], 3, '|', sizeof WC->cs_inet_email);
119         }
120
121         get_preference("current_iconbar", buf, sizeof buf);
122         WC->current_iconbar = atoi(buf);
123
124         get_preference("floordiv_expanded", WC->floordiv_expanded, sizeof WC->floordiv_expanded);
125 }
126
127
128 /** 
129  * \brief Login Checks
130  * the logics to detect invalid passwords not to get on citservers nerves
131  */
132 void do_login(void)
133 {
134         char buf[SIZ];
135
136         if (strlen(bstr("language")) > 0) {
137                 set_selected_language(bstr("language"));
138                 go_selected_language();
139         }
140
141         if (strlen(bstr("exit_action")) > 0) {
142                 do_logout();
143                 return;
144         }
145         if (strlen(bstr("login_action")) > 0) {
146                 serv_printf("USER %s", bstr("name"));
147                 serv_getln(buf, sizeof buf);
148                 if (buf[0] == '3') {
149                         serv_printf("PASS %s", bstr("pass"));
150                         serv_getln(buf, sizeof buf);
151                         if (buf[0] == '2') {
152                                 become_logged_in(bstr("name"),
153                                                  bstr("pass"), buf);
154                         } else {
155                                 display_login(&buf[4]);
156                                 return;
157                         }
158                 } else {
159                         display_login(&buf[4]);
160                         return;
161                 }
162         }
163         if (strlen(bstr("newuser_action")) > 0) {
164                 if (strlen(bstr("pass")) == 0) {
165                         display_login(_("Blank passwords are not allowed."));
166                         return;
167                 }
168                 serv_printf("NEWU %s", bstr("name"));
169                 serv_getln(buf, sizeof buf);
170                 if (buf[0] == '2') {
171                         become_logged_in(bstr("name"), bstr("pass"), buf);
172                         serv_printf("SETP %s", bstr("pass"));
173                         serv_getln(buf, sizeof buf);
174                 } else {
175                         display_login(&buf[4]);
176                         return;
177                 }
178         }
179         if (WC->logged_in) {
180                 if (WC->need_regi) {
181                         display_reg(1);
182                 } else {
183                         do_welcome();
184                 }
185         } else {
186                 display_login(_("Your password was not accepted."));
187         }
188
189 }
190
191 /**
192  * \brief display the user a welcome screen. 
193  * if this is the first time login, and the web based setup is enabled, 
194  * lead the user through the setup routines
195  */
196 void do_welcome(void)
197 {
198         char buf[SIZ];
199 #ifdef XXX_NOT_FINISHED_YET_XXX
200         FILE *fp;
201         int i;
202
203         /**
204          * See if we have to run the first-time setup wizard
205          */
206         if (WC->is_aide) {
207                 if (!setup_wizard) {
208                         sprintf(wizard_filename, "setupwiz.%s.%s",
209                                 ctdlhost, ctdlport);
210                         for (i=0; i<strlen(wizard_filename); ++i) {
211                                 if (    (wizard_filename[i]==' ')
212                                         || (wizard_filename[i] == '/')
213                                 ) {
214                                         wizard_filename[i] = '_';
215                                 }
216                         }
217         
218                         fp = fopen(wizard_filename, "r");
219                         if (fp != NULL) {
220                                 fgets(buf, sizeof buf, fp);
221                                 buf[strlen(buf)-1] = 0;
222                                 fclose(fp);
223                                 if (atoi(buf) == serv_info.serv_rev_level) {
224                                         setup_wizard = 1; /**< already run */
225                                 }
226                         }
227                 }
228
229                 if (!setup_wizard) {
230                         http_redirect("setup_wizard");
231                 }
232         }
233 #endif
234
235         /**
236          * Go to the user's preferred start page
237          */
238         get_preference("startpage", buf, sizeof buf);
239         if (strlen(buf)==0) {
240                 safestrncpy(buf, "dotskip&room=_BASEROOM_", sizeof buf);
241                 set_preference("startpage", buf, 1);
242         }
243         if (buf[0] == '/') {
244                 strcpy(buf, &buf[1]);
245         }
246         http_redirect(buf);
247 }
248
249
250 /**
251  * Disconnect from the Citadel server, and end this WebCit session
252  */
253 void end_webcit_session(void) {
254         char buf[256];
255
256         if (WC->logged_in) {
257                 sprintf(buf, "%d", WC->current_iconbar);
258                 set_preference("current_iconbar", buf, 0);
259                 set_preference("floordiv_expanded", WC->floordiv_expanded, 1);
260         }
261
262         serv_puts("QUIT");
263         WC->killthis = 1;
264         /* close() of citadel socket will be done by do_housekeeping() */
265 }
266
267 /** 
268  * execute the logout
269  */
270 void do_logout(void)
271 {
272         char buf[SIZ];
273
274         safestrncpy(WC->wc_username, "", sizeof WC->wc_username);
275         safestrncpy(WC->wc_password, "", sizeof WC->wc_password);
276         safestrncpy(WC->wc_roomname, "", sizeof WC->wc_roomname);
277         safestrncpy(WC->wc_fullname, "", sizeof WC->wc_fullname);
278
279         /** Calling output_headers() this way causes the cookies to be un-set */
280         output_headers(1, 1, 0, 1, 0, 0);
281
282         wprintf("<center>");
283         serv_puts("MESG goodbye");
284         serv_getln(buf, sizeof buf);
285
286         if (WC->serv_sock >= 0) {
287                 if (buf[0] == '1') {
288                         fmout("CENTER");
289                 } else {
290                         wprintf("Goodbye\n");
291                 }
292         }
293         else {
294                 wprintf(_("This program was unable to connect or stay "
295                         "connected to the Citadel server.  Please report "
296                         "this problem to your system administrator.")
297                 );
298         }
299
300         wprintf("<hr /><a href=\".\">");
301         wprintf(_("Log in again"));
302         wprintf("</A>&nbsp;&nbsp;&nbsp;"
303                 "<a href=\"javascript:window.close();\">");
304         wprintf(_("Close window"));
305         wprintf("</a></center>\n");
306         wDumpContent(2);
307         end_webcit_session();
308 }
309
310
311 /* *
312  * validate new users
313  */
314 void validate(void)
315 {
316         char cmd[SIZ];
317         char user[SIZ];
318         char buf[SIZ];
319         int a;
320
321         output_headers(1, 1, 2, 0, 0, 0);
322         wprintf("<div id=\"banner\">\n"
323                 "<TABLE WIDTH=100%% BORDER=0 BGCOLOR=\"#444455\"><TR><TD>"
324                 "<SPAN CLASS=\"titlebar\">");
325         wprintf(_("Validate new users"));
326         wprintf("</SPAN></TD></TR></TABLE>\n</div>\n<div id=\"content\">\n");
327
328         /** If the user just submitted a validation, process it... */
329         safestrncpy(buf, bstr("user"), sizeof buf);
330         if (strlen(buf) > 0) {
331                 if (strlen(bstr("axlevel")) > 0) {
332                         serv_printf("VALI %s|%s", buf, bstr("axlevel"));
333                         serv_getln(buf, sizeof buf);
334                         if (buf[0] != '2') {
335                                 wprintf("<b>%s</b><br />\n", &buf[4]);
336                         }
337                 }
338         }
339
340         /** Now see if any more users require validation. */
341         serv_puts("GNUR");
342         serv_getln(buf, sizeof buf);
343         if (buf[0] == '2') {
344                 wprintf("<b>");
345                 wprintf(_("No users require validation at this time."));
346                 wprintf("</b><br />\n");
347                 wDumpContent(1);
348                 return;
349         }
350         if (buf[0] != '3') {
351                 wprintf("<b>%s</b><br />\n", &buf[4]);
352                 wDumpContent(1);
353                 return;
354         }
355
356         wprintf("<div class=\"fix_scrollbar_bug\">"
357                 "<table border=0 width=100%% bgcolor=\"#ffffff\"><tr><td>\n");
358         wprintf("<center>");
359
360         safestrncpy(user, &buf[4], sizeof user);
361         serv_printf("GREG %s", user);
362         serv_getln(cmd, sizeof cmd);
363         if (cmd[0] == '1') {
364                 a = 0;
365                 do {
366                         serv_getln(buf, sizeof buf);
367                         ++a;
368                         if (a == 1)
369                                 wprintf("#%s<br /><H1>%s</H1>",
370                                         buf, &cmd[4]);
371                         if (a == 2)
372                                 wprintf("PW: %s<br />\n", buf);
373                         if (a == 3)
374                                 wprintf("%s<br />\n", buf);
375                         if (a == 4)
376                                 wprintf("%s<br />\n", buf);
377                         if (a == 5)
378                                 wprintf("%s, ", buf);
379                         if (a == 6)
380                                 wprintf("%s ", buf);
381                         if (a == 7)
382                                 wprintf("%s<br />\n", buf);
383                         if (a == 8)
384                                 wprintf("%s<br />\n", buf);
385                         if (a == 9)
386                                 wprintf(_("Current access level: %d (%s)\n"),
387                                         atoi(buf), axdefs[atoi(buf)]);
388                 } while (strcmp(buf, "000"));
389         } else {
390                 wprintf("<H1>%s</H1>%s<br />\n", user, &cmd[4]);
391         }
392
393         wprintf("<hr />");
394         wprintf(_("Select access level for this user:"));
395         wprintf("<br />\n");
396         for (a = 0; a <= 6; ++a) {
397                 wprintf("<a href=\"validate&user=");
398                 urlescputs(user);
399                 wprintf("&axlevel=%d\">%s</A>&nbsp;&nbsp;&nbsp;\n",
400                         a, axdefs[a]);
401         }
402         wprintf("<br />\n");
403
404         wprintf("</CENTER>\n");
405         wprintf("</td></tr></table></div>\n");
406         wDumpContent(1);
407 }
408
409
410
411 /** 
412  * \brief Display form for registration.
413  * (Set during_login to 1 if this registration is being performed during
414  * new user login and will require chaining to the proper screen.)
415  * \param during_login are we just in the login phase?
416  */
417 void display_reg(int during_login)
418 {
419         long vcard_msgnum;
420
421         if (goto_config_room() != 0) {
422                 if (during_login) do_welcome();
423                 else display_main_menu();
424                 return;
425         }
426
427         vcard_msgnum = locate_user_vcard(WC->wc_fullname, -1);
428         if (vcard_msgnum < 0L) {
429                 if (during_login) do_welcome();
430                 else display_main_menu();
431                 return;
432         }
433
434         if (during_login) {
435                 do_edit_vcard(vcard_msgnum, "1", "do_welcome");
436         }
437         else {
438                 do_edit_vcard(vcard_msgnum, "1", "display_main_menu");
439         }
440
441 }
442
443
444
445
446 /** 
447  * display form for changing your password
448  */
449 void display_changepw(void)
450 {
451         char buf[SIZ];
452
453         output_headers(1, 1, 2, 0, 0, 0);
454         wprintf("<div id=\"banner\">\n"
455                 "<TABLE WIDTH=100%% BORDER=0 BGCOLOR=\"#444455\"><TR><TD>"
456                 "<SPAN CLASS=\"titlebar\">");
457         wprintf(_("Change your password"));
458         wprintf("</SPAN>"
459                 "</TD></TR></TABLE>\n"
460                 "</div>\n<div id=\"content\">\n"
461         );
462
463         if (strlen(WC->ImportantMessage) > 0) {
464                 do_template("beginbox_nt");
465                 wprintf("<SPAN CLASS=\"errormsg\">"
466                         "%s</SPAN><br />\n", WC->ImportantMessage);
467                 do_template("endbox");
468                 safestrncpy(WC->ImportantMessage, "", sizeof WC->ImportantMessage);
469         }
470
471         wprintf("<div class=\"fix_scrollbar_bug\">"
472                 "<table border=0 width=100%% bgcolor=\"#ffffff\"><tr><td>\n");
473
474         wprintf("<CENTER><br />");
475         serv_puts("MESG changepw");
476         serv_getln(buf, sizeof buf);
477         if (buf[0] == '1') {
478                 fmout("CENTER");
479         }
480
481         wprintf("<form name=\"changepwform\" action=\"changepw\" method=\"post\">\n");
482         wprintf("<CENTER>"
483                 "<table border=\"0\" cellspacing=\"5\" cellpadding=\"5\" "
484                 "BGCOLOR=\"#EEEEEE\">"
485                 "<TR><TD>");
486         wprintf(_("Enter new password:"));
487         wprintf("</TD>\n");
488         wprintf("<TD><INPUT TYPE=\"password\" NAME=\"newpass1\" VALUE=\"\" MAXLENGTH=\"20\"></TD></TR>\n");
489         wprintf("<TR><TD>");
490         wprintf(_("Enter it again to confirm:"));
491         wprintf("</TD>\n");
492         wprintf("<TD><INPUT TYPE=\"password\" NAME=\"newpass2\" VALUE=\"\" MAXLENGTH=\"20\"></TD></TR>\n");
493
494         wprintf("</TABLE><br />\n");
495         wprintf("<INPUT type=\"submit\" name=\"change_action\" value=\"%s\">", _("Change password"));
496         wprintf("&nbsp;");
497         wprintf("<INPUT type=\"submit\" name=\"cancel_action\" value=\"%s\">\n", _("Cancel"));
498         wprintf("</form></center>\n");
499         wprintf("</td></tr></table></div>\n");
500         wDumpContent(1);
501 }
502
503 /**
504  * \brief change password
505  * if passwords match, propagate it to citserver.
506  */
507 void changepw(void)
508 {
509         char buf[SIZ];
510         char newpass1[32], newpass2[32];
511
512         if (strlen(bstr("change_action")) == 0) {
513                 safestrncpy(WC->ImportantMessage, 
514                         _("Cancelled.  Password was not changed."),
515                         sizeof WC->ImportantMessage);
516                 display_main_menu();
517                 return;
518         }
519
520         safestrncpy(newpass1, bstr("newpass1"), sizeof newpass1);
521         safestrncpy(newpass2, bstr("newpass2"), sizeof newpass2);
522
523         if (strcasecmp(newpass1, newpass2)) {
524                 safestrncpy(WC->ImportantMessage, 
525                         _("They don't match.  Password was not changed."),
526                         sizeof WC->ImportantMessage);
527                 display_changepw();
528                 return;
529         }
530
531         if (strlen(newpass1) == 0) {
532                 safestrncpy(WC->ImportantMessage, 
533                         _("Blank passwords are not allowed."),
534                         sizeof WC->ImportantMessage);
535                 display_changepw();
536                 return;
537         }
538
539         serv_printf("SETP %s", newpass1);
540         serv_getln(buf, sizeof buf);
541         sprintf(WC->ImportantMessage, "%s", &buf[4]);
542         if (buf[0] == '2') {
543                 safestrncpy(WC->wc_password, buf, sizeof WC->wc_password);
544                 display_main_menu();
545         }
546         else {
547                 display_changepw();
548         }
549 }
550
551
552
553 /** @} */