2 * Server functions which perform operations on user objects.
4 * Copyright (c) 1987-2017 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or
7 * modify 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.
17 #include "ctdl_module.h"
18 #include "citserver.h"
21 #include "internet_addressing.h"
27 void cmd_user(char *cmdbuf)
32 extract_token(username, cmdbuf, 0, '|', sizeof username);
34 syslog(LOG_DEBUG, "user_ops: cmd_user(%s)", username);
36 a = CtdlLoginExistingUser(NULL, username);
38 case login_already_logged_in:
39 cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
41 case login_too_many_users:
43 "Too many users are already online "
45 ERROR + MAX_SESSIONS_EXCEEDED,
46 CtdlGetConfigStr("c_nodename"), CtdlGetConfigInt("c_maxsessions"));
49 cprintf("%d Password required for %s\n",
50 MORE_DATA, CC->curr_user);
53 cprintf("%d %s not found.\n", ERROR + NO_SUCH_USER, username);
56 cprintf("%d Internal error\n", ERROR + INTERNAL_ERROR);
61 void cmd_pass(char *buf)
67 memset(password, 0, sizeof(password));
68 len = extract_token(password, buf, 0, '|', sizeof password);
69 a = CtdlTryPassword(password, len);
72 case pass_already_logged_in:
73 cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
76 cprintf("%d You must send a name with USER first.\n",
77 ERROR + USERNAME_REQUIRED);
79 case pass_wrong_password:
80 cprintf("%d Wrong password.\n", ERROR + PASSWORD_REQUIRED);
90 * cmd_newu() - create a new user account and log in as that user
92 void cmd_newu(char *cmdbuf)
98 if (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_NATIVE) {
99 cprintf("%d This system does not use native mode authentication.\n",
104 if (CtdlGetConfigInt("c_disable_newu")) {
105 cprintf("%d Self-service user account creation "
106 "is disabled on this system.\n", ERROR + NOT_HERE);
111 cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
115 cprintf("%d %s: Too many users are already online (maximum is %d)\n",
116 ERROR + MAX_SESSIONS_EXCEEDED,
117 CtdlGetConfigStr("c_nodename"), CtdlGetConfigInt("c_maxsessions"));
120 extract_token(username, cmdbuf, 0, '|', sizeof username);
122 len = cutuserkey(username);
124 if (IsEmptyStr(username)) {
125 cprintf("%d You must supply a user name.\n", ERROR + USERNAME_REQUIRED);
129 if ((!strcasecmp(username, "bbs")) ||
130 (!strcasecmp(username, "new")) ||
131 (!strcasecmp(username, "."))) {
132 cprintf("%d '%s' is an invalid login name.\n", ERROR + ILLEGAL_VALUE, username);
136 a = create_user(username, len, 1);
139 logged_in_response();
140 } else if (a == ERROR + ALREADY_EXISTS) {
141 cprintf("%d '%s' already exists.\n",
142 ERROR + ALREADY_EXISTS, username);
144 } else if (a == ERROR + INTERNAL_ERROR) {
145 cprintf("%d Internal error - user record disappeared?\n",
146 ERROR + INTERNAL_ERROR);
149 cprintf("%d unknown error\n", ERROR + INTERNAL_ERROR);
154 * set password - citadel protocol implementation
156 void cmd_setp(char *new_pw)
158 if (CtdlAccessCheck(ac_logged_in)) {
161 if ( (CC->user.uid != CTDLUID) && (CC->user.uid != (-1)) ) {
162 cprintf("%d Not allowed. Use the 'passwd' command.\n", ERROR + NOT_HERE);
166 cprintf("%d The master prefix password cannot be changed with this command.\n",
171 if (!strcasecmp(new_pw, "GENERATE_RANDOM_PASSWORD")) {
172 char random_password[17];
173 snprintf(random_password, sizeof random_password, "%08lx%08lx", random(), random());
174 CtdlSetPassword(random_password);
175 cprintf("%d %s\n", CIT_OK, random_password);
179 if (IsEmptyStr(new_pw)) {
180 cprintf("%d Password unchanged.\n", CIT_OK);
183 CtdlSetPassword(new_pw);
184 cprintf("%d Password changed.\n", CIT_OK);
190 * cmd_creu() - administratively create a new user account (do not log in to it)
192 void cmd_creu(char *cmdbuf)
200 if (CtdlAccessCheck(ac_aide)) {
204 extract_token(username, cmdbuf, 0, '|', sizeof username);
207 if (IsEmptyStr(username)) {
208 cprintf("%d You must supply a user name.\n", ERROR + USERNAME_REQUIRED);
211 len = cutuserkey(username);
214 extract_token(password, cmdbuf, 1, '|', sizeof password);
216 a = create_user(username, len, 0);
219 if (!IsEmptyStr(password)) {
220 CtdlGetUserLock(&tmp, username);
221 safestrncpy(tmp.password, password, sizeof(tmp.password));
222 CtdlPutUserLock(&tmp);
224 cprintf("%d User '%s' created %s.\n", CIT_OK, username,
225 (!IsEmptyStr(password)) ? "and password set" :
228 } else if (a == ERROR + ALREADY_EXISTS) {
229 cprintf("%d '%s' already exists.\n", ERROR + ALREADY_EXISTS, username);
231 } else if ( (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_NATIVE) && (a == ERROR + NO_SUCH_USER) ) {
232 cprintf("%d User accounts are not created within Citadel in host authentication mode.\n",
233 ERROR + NO_SUCH_USER);
236 cprintf("%d An error occurred creating the user account.\n", ERROR + INTERNAL_ERROR);
242 * get user parameters
244 void cmd_getu(char *cmdbuf)
246 if (CtdlAccessCheck(ac_logged_in))
249 CtdlGetUser(&CC->user, CC->curr_user);
250 cprintf("%d 80|24|%d|\n", CIT_OK, (CC->user.flags & US_USER_SET));
255 * set user parameters
257 void cmd_setu(char *new_parms)
259 if (CtdlAccessCheck(ac_logged_in))
262 if (num_parms(new_parms) < 3) {
263 cprintf("%d Usage error.\n", ERROR + ILLEGAL_VALUE);
266 CtdlLockGetCurrentUser();
267 CC->user.flags = CC->user.flags & (~US_USER_SET);
268 CC->user.flags = CC->user.flags | (extract_int(new_parms, 2) & US_USER_SET);
269 CtdlPutCurrentUserLock();
270 cprintf("%d Ok\n", CIT_OK);
274 * set last read pointer
276 void cmd_slrp(char *new_ptr)
282 if (CtdlAccessCheck(ac_logged_in)) {
286 if (!strncasecmp(new_ptr, "highest", 7)) {
287 newlr = CC->room.QRhighest;
289 newlr = atol(new_ptr);
292 CtdlLockGetCurrentUser();
294 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
295 memcpy(&original_vbuf, &vbuf, sizeof(visit));
296 vbuf.v_lastseen = newlr;
297 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld", newlr);
299 /* Only rewrite the record if it changed */
300 if ( (vbuf.v_lastseen != original_vbuf.v_lastseen)
301 || (strcmp(vbuf.v_seen, original_vbuf.v_seen)) ) {
302 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
305 CtdlPutCurrentUserLock();
306 cprintf("%d %ld\n", CIT_OK, newlr);
310 void cmd_seen(char *argbuf) {
311 long target_msgnum = 0L;
312 int target_setting = 0;
314 if (CtdlAccessCheck(ac_logged_in)) {
318 if (num_parms(argbuf) != 2) {
319 cprintf("%d Invalid parameters\n", ERROR + ILLEGAL_VALUE);
323 target_msgnum = extract_long(argbuf, 0);
324 target_setting = extract_int(argbuf, 1);
326 CtdlSetSeen(&target_msgnum, 1, target_setting,
327 ctdlsetseen_seen, NULL, NULL);
328 cprintf("%d OK\n", CIT_OK);
332 void cmd_gtsn(char *argbuf) {
335 if (CtdlAccessCheck(ac_logged_in)) {
339 /* Learn about the user and room in question */
340 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
342 cprintf("%d ", CIT_OK);
343 client_write(vbuf.v_seen, strlen(vbuf.v_seen));
344 client_write(HKEY("\n"));
348 * INVT and KICK commands
350 void cmd_invt_kick(char *iuser, int op) {
353 * These commands are only allowed by admins, room admins,
354 * and room namespace owners
356 if (is_room_aide()) {
358 } else if ( ((atol(CC->room.QRname) == CC->user.usernum) ) && (CC->user.usernum != 0) ) {
362 cprintf("%d Higher access or room ownership required.\n",
363 ERROR + HIGHER_ACCESS_REQUIRED);
367 if (!strncasecmp(CC->room.QRname, CtdlGetConfigStr("c_baseroom"),
369 cprintf("%d Can't add/remove users from this room.\n",
374 if (CtdlInvtKick(iuser, op) != 0) {
375 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
379 cprintf("%d %s %s %s.\n",
381 ((op == 1) ? "invited to" : "kicked out of"),
386 void cmd_invt(char *iuser) {cmd_invt_kick(iuser, 1);}
387 void cmd_kick(char *iuser) {cmd_invt_kick(iuser, 0);}
391 * forget (Zap) the current room
393 void cmd_forg(char *argbuf)
396 if (CtdlAccessCheck(ac_logged_in)) {
400 if (CtdlForgetThisRoom() == 0) {
401 cprintf("%d Ok\n", CIT_OK);
404 cprintf("%d You may not forget this room.\n", ERROR + NOT_HERE);
409 * Get Next Unregistered User
411 void cmd_gnur(char *argbuf)
413 struct cdbdata *cdbus;
414 struct ctdluser usbuf;
416 if (CtdlAccessCheck(ac_aide)) {
420 if ((CtdlGetConfigInt("MMflags") & MM_VALID) == 0) {
421 cprintf("%d There are no unvalidated users.\n", CIT_OK);
425 /* There are unvalidated users. Traverse the user database,
426 * and return the first user we find that needs validation.
428 cdb_rewind(CDB_USERS);
429 while (cdbus = cdb_next_item(CDB_USERS), cdbus != NULL) {
430 memset(&usbuf, 0, sizeof(struct ctdluser));
431 memcpy(&usbuf, cdbus->ptr,
432 ((cdbus->len > sizeof(struct ctdluser)) ?
433 sizeof(struct ctdluser) : cdbus->len));
435 if ((usbuf.flags & US_NEEDVALID)
436 && (usbuf.axlevel > AxDeleted)) {
437 cprintf("%d %s\n", MORE_DATA, usbuf.fullname);
438 cdb_close_cursor(CDB_USERS);
443 /* If we get to this point, there are no more unvalidated users.
444 * Therefore we clear the "users need validation" flag.
447 begin_critical_section(S_CONTROL);
449 flags = CtdlGetConfigInt("MMflags");
450 flags = flags & (~MM_VALID);
451 CtdlSetConfigInt("MMflags", flags);
452 end_critical_section(S_CONTROL);
453 cprintf("%d *** End of registration.\n", CIT_OK);
460 void cmd_vali(char *v_args)
464 struct ctdluser userbuf;
466 extract_token(user, v_args, 0, '|', sizeof user);
467 newax = extract_int(v_args, 1);
469 if (CtdlAccessCheck(ac_aide) ||
471 (newax < AxDeleted)) {
475 if (CtdlGetUserLock(&userbuf, user) != 0) {
476 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, user);
480 userbuf.axlevel = newax;
481 userbuf.flags = (userbuf.flags & ~US_NEEDVALID);
483 CtdlPutUserLock(&userbuf);
485 /* If the access level was set to zero, delete the user */
487 if (purge_user(user) == 0) {
488 cprintf("%d %s Deleted.\n", CIT_OK, userbuf.fullname);
492 cprintf("%d User '%s' validated.\n", CIT_OK, userbuf.fullname);
496 * List users (searchstring may be empty to list all users)
498 void cmd_list(char *cmdbuf)
500 char searchstring[256];
501 extract_token(searchstring, cmdbuf, 0, '|', sizeof searchstring);
502 striplt(searchstring);
503 cprintf("%d \n", LISTING_FOLLOWS);
504 ForEachUser(ListThisUser, (void *)searchstring );
512 * assorted info we need to check at login
514 void cmd_chek(char *argbuf)
520 if (CtdlAccessCheck(ac_logged_in)) {
524 CtdlGetUser(&CC->user, CC->curr_user); /* no lock is needed here */
525 if ((REGISCALL != 0) && ((CC->user.flags & US_REGIS) == 0))
528 if (CC->user.axlevel >= AxAideU) {
529 if (CtdlGetConfigInt("MMflags") & MM_VALID) {
535 mail = InitialMailCheck();
537 cprintf("%d %d|%d|%d|%s|\n", CIT_OK, mail, regis, vali, CC->cs_inet_email);
542 * check to see if a user exists
544 void cmd_qusr(char *who)
546 struct ctdluser usbuf;
548 if (CtdlGetUser(&usbuf, who) == 0) {
549 cprintf("%d %s\n", CIT_OK, usbuf.fullname);
551 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
557 * Administrative Get User Parameters
559 void cmd_agup(char *cmdbuf)
561 struct ctdluser usbuf;
562 char requested_user[128];
564 if (CtdlAccessCheck(ac_aide)) {
568 extract_token(requested_user, cmdbuf, 0, '|', sizeof requested_user);
569 if (CtdlGetUser(&usbuf, requested_user) != 0) {
570 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
573 cprintf("%d %s|%s|%u|%ld|%ld|%d|%ld|%ld|%d\n",
582 (long)usbuf.lastcall,
589 * Administrative Set User Parameters
591 void cmd_asup(char *cmdbuf)
593 struct ctdluser usbuf;
594 char requested_user[128];
600 if (CtdlAccessCheck(ac_aide))
603 extract_token(requested_user, cmdbuf, 0, '|', sizeof requested_user);
604 if (CtdlGetUserLock(&usbuf, requested_user) != 0) {
605 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
608 np = num_parms(cmdbuf);
610 extract_token(usbuf.password, cmdbuf, 1, '|', sizeof usbuf.password);
612 usbuf.flags = extract_int(cmdbuf, 2);
614 usbuf.timescalled = extract_int(cmdbuf, 3);
616 usbuf.posted = extract_int(cmdbuf, 4);
618 newax = extract_int(cmdbuf, 5);
619 if ((newax >= AxDeleted) && (newax <= AxAideU)) {
620 usbuf.axlevel = newax;
624 usbuf.lastcall = extract_long(cmdbuf, 7);
627 usbuf.USuserpurge = extract_int(cmdbuf, 8);
629 CtdlPutUserLock(&usbuf);
630 if (usbuf.axlevel == AxDeleted) {
631 if (purge_user(requested_user) == 0) {
637 snprintf(notify, SIZ,
638 "User \"%s\" has been deleted by %s.\n",
640 (CC->logged_in ? CC->user.fullname : "an administrator")
642 CtdlAideMessage(notify, "User Deletion Message");
645 cprintf("%d Ok", CIT_OK);
647 cprintf(" (%s deleted)", requested_user);
653 * Citadel protocol command to do the same
655 void cmd_isme(char *argbuf) {
658 if (CtdlAccessCheck(ac_logged_in)) return;
659 extract_token(addr, argbuf, 0, '|', sizeof addr);
661 if (CtdlIsMe(addr, sizeof addr)) {
662 cprintf("%d %s\n", CIT_OK, addr);
665 cprintf("%d Not you.\n", ERROR + ILLEGAL_VALUE);
672 * Set the preferred view for the current user/room combination
674 void cmd_view(char *cmdbuf) {
678 if (CtdlAccessCheck(ac_logged_in)) {
682 requested_view = extract_int(cmdbuf, 0);
684 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
685 vbuf.v_view = requested_view;
686 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
688 cprintf("%d ok\n", CIT_OK);
695 void cmd_renu(char *cmdbuf)
698 char oldname[USERNAME_SIZE];
699 char newname[USERNAME_SIZE];
701 if (CtdlAccessCheck(ac_aide)) {
705 extract_token(oldname, cmdbuf, 0, '|', sizeof oldname);
706 extract_token(newname, cmdbuf, 1, '|', sizeof newname);
708 retcode = rename_user(oldname, newname);
711 cprintf("%d '%s' has been renamed to '%s'.\n", CIT_OK, oldname, newname);
713 case RENAMEUSER_LOGGED_IN:
714 cprintf("%d '%s' is currently logged in and cannot be renamed.\n",
715 ERROR + ALREADY_LOGGED_IN , oldname);
717 case RENAMEUSER_NOT_FOUND:
718 cprintf("%d '%s' does not exist.\n", ERROR + NO_SUCH_USER, oldname);
720 case RENAMEUSER_ALREADY_EXISTS:
721 cprintf("%d A user named '%s' already exists.\n", ERROR + ALREADY_EXISTS, newname);
725 cprintf("%d An unknown error occurred.\n", ERROR);
730 void cmd_quit(char *argbuf)
732 cprintf("%d Goodbye.\n", CIT_OK);
733 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
737 void cmd_lout(char *argbuf)
741 cprintf("%d logged out.\n", CIT_OK);
745 /*****************************************************************************/
746 /* MODULE INITIALIZATION STUFF */
747 /*****************************************************************************/
750 CTDL_MODULE_INIT(serv_user)
753 CtdlRegisterProtoHook(cmd_user, "USER", "Submit username for login");
754 CtdlRegisterProtoHook(cmd_pass, "PASS", "Complete login by submitting a password");
755 CtdlRegisterProtoHook(cmd_quit, "QUIT", "log out and disconnect from server");
756 CtdlRegisterProtoHook(cmd_lout, "LOUT", "log out but do not disconnect from server");
757 CtdlRegisterProtoHook(cmd_creu, "CREU", "Create User");
758 CtdlRegisterProtoHook(cmd_setp, "SETP", "Set the password for an account");
759 CtdlRegisterProtoHook(cmd_getu, "GETU", "Get User parameters");
760 CtdlRegisterProtoHook(cmd_setu, "SETU", "Set User parameters");
761 CtdlRegisterProtoHook(cmd_slrp, "SLRP", "Set Last Read Pointer");
762 CtdlRegisterProtoHook(cmd_invt, "INVT", "Invite a user to a room");
763 CtdlRegisterProtoHook(cmd_kick, "KICK", "Kick a user out of a room");
764 CtdlRegisterProtoHook(cmd_forg, "FORG", "Forget a room");
765 CtdlRegisterProtoHook(cmd_gnur, "GNUR", "Get Next Unregistered User");
766 CtdlRegisterProtoHook(cmd_vali, "VALI", "Validate new users");
767 CtdlRegisterProtoHook(cmd_list, "LIST", "List users");
768 CtdlRegisterProtoHook(cmd_chek, "CHEK", "assorted info we need to check at login");
769 CtdlRegisterProtoHook(cmd_qusr, "QUSR", "check to see if a user exists");
770 CtdlRegisterProtoHook(cmd_agup, "AGUP", "Administratively Get User Parameters");
771 CtdlRegisterProtoHook(cmd_asup, "ASUP", "Administratively Set User Parameters");
772 CtdlRegisterProtoHook(cmd_seen, "SEEN", "Manipulate seen/unread message flags");
773 CtdlRegisterProtoHook(cmd_gtsn, "GTSN", "Fetch seen/unread message flags");
774 CtdlRegisterProtoHook(cmd_view, "VIEW", "Set preferred view for user/room combination");
775 CtdlRegisterProtoHook(cmd_renu, "RENU", "Rename a user");
776 CtdlRegisterProtoHook(cmd_newu, "NEWU", "Log in as a new user");
777 CtdlRegisterProtoHook(cmd_isme, "ISME", "Determine whether an email address belongs to a user");
779 /* return our Subversion id for the Log */