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.
18 #include "ctdl_module.h"
19 #include "citserver.h"
22 #include "internet_addressing.h"
28 void cmd_user(char *cmdbuf)
33 extract_token(username, cmdbuf, 0, '|', sizeof username);
35 syslog(LOG_DEBUG, "user_ops: cmd_user(%s)", username);
37 a = CtdlLoginExistingUser(NULL, username);
39 case login_already_logged_in:
40 cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
42 case login_too_many_users:
44 "Too many users are already online "
46 ERROR + MAX_SESSIONS_EXCEEDED,
47 CtdlGetConfigStr("c_nodename"), CtdlGetConfigInt("c_maxsessions"));
50 cprintf("%d Password required for %s\n",
51 MORE_DATA, CC->curr_user);
54 cprintf("%d %s not found.\n", ERROR + NO_SUCH_USER, username);
57 cprintf("%d Internal error\n", ERROR + INTERNAL_ERROR);
62 void cmd_pass(char *buf)
68 memset(password, 0, sizeof(password));
69 len = extract_token(password, buf, 0, '|', sizeof password);
70 a = CtdlTryPassword(password, len);
73 case pass_already_logged_in:
74 cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
77 cprintf("%d You must send a name with USER first.\n",
78 ERROR + USERNAME_REQUIRED);
80 case pass_wrong_password:
81 cprintf("%d Wrong password.\n", ERROR + PASSWORD_REQUIRED);
91 * cmd_newu() - create a new user account and log in as that user
93 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);
123 if (IsEmptyStr(username)) {
124 cprintf("%d You must supply a user name.\n", ERROR + USERNAME_REQUIRED);
128 if ((!strcasecmp(username, "bbs")) ||
129 (!strcasecmp(username, "new")) ||
130 (!strcasecmp(username, "."))) {
131 cprintf("%d '%s' is an invalid login name.\n", ERROR + ILLEGAL_VALUE, username);
135 a = create_user(username, CREATE_USER_BECOME_USER, NATIVE_AUTH_UID);
138 logged_in_response();
139 } else if (a == ERROR + ALREADY_EXISTS) {
140 cprintf("%d '%s' already exists.\n",
141 ERROR + ALREADY_EXISTS, username);
143 } else if (a == ERROR + INTERNAL_ERROR) {
144 cprintf("%d Internal error - user record disappeared?\n",
145 ERROR + INTERNAL_ERROR);
148 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)
199 if (CtdlAccessCheck(ac_aide)) {
203 extract_token(username, cmdbuf, 0, '|', sizeof username);
206 if (IsEmptyStr(username)) {
207 cprintf("%d You must supply a user name.\n", ERROR + USERNAME_REQUIRED);
211 extract_token(password, cmdbuf, 1, '|', sizeof password);
213 a = create_user(username, CREATE_USER_DO_NOT_BECOME_USER, NATIVE_AUTH_UID);
216 if (!IsEmptyStr(password)) {
217 CtdlGetUserLock(&tmp, username);
218 safestrncpy(tmp.password, password, sizeof(tmp.password));
219 CtdlPutUserLock(&tmp);
221 cprintf("%d User '%s' created %s.\n", CIT_OK, username, (!IsEmptyStr(password)) ? "and password set" : "with no password");
223 } else if (a == ERROR + ALREADY_EXISTS) {
224 cprintf("%d '%s' already exists.\n", ERROR + ALREADY_EXISTS, username);
226 } else if ( (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_NATIVE) && (a == ERROR + NO_SUCH_USER) ) {
227 cprintf("%d User accounts are not created within Citadel in host authentication mode.\n", ERROR + NO_SUCH_USER);
230 cprintf("%d An error occurred creating the user account.\n", ERROR + INTERNAL_ERROR);
236 * get user parameters
238 void cmd_getu(char *cmdbuf)
240 if (CtdlAccessCheck(ac_logged_in))
243 CtdlGetUser(&CC->user, CC->curr_user);
244 cprintf("%d 80|24|%d|\n", CIT_OK, (CC->user.flags & US_USER_SET));
249 * set user parameters
251 void cmd_setu(char *new_parms)
253 if (CtdlAccessCheck(ac_logged_in))
256 if (num_parms(new_parms) < 3) {
257 cprintf("%d Usage error.\n", ERROR + ILLEGAL_VALUE);
260 CtdlLockGetCurrentUser();
261 CC->user.flags = CC->user.flags & (~US_USER_SET);
262 CC->user.flags = CC->user.flags | (extract_int(new_parms, 2) & US_USER_SET);
263 CtdlPutCurrentUserLock();
264 cprintf("%d Ok\n", CIT_OK);
269 * set last read pointer
271 void cmd_slrp(char *new_ptr)
277 if (CtdlAccessCheck(ac_logged_in)) {
281 if (!strncasecmp(new_ptr, "highest", 7)) {
282 newlr = CC->room.QRhighest;
284 newlr = atol(new_ptr);
287 CtdlLockGetCurrentUser();
289 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
290 memcpy(&original_vbuf, &vbuf, sizeof(visit));
291 vbuf.v_lastseen = newlr;
292 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld", newlr);
294 /* Only rewrite the record if it changed */
295 if ( (vbuf.v_lastseen != original_vbuf.v_lastseen)
296 || (strcmp(vbuf.v_seen, original_vbuf.v_seen)) ) {
297 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
300 CtdlPutCurrentUserLock();
301 cprintf("%d %ld\n", CIT_OK, newlr);
305 void cmd_seen(char *argbuf) {
306 long target_msgnum = 0L;
307 int target_setting = 0;
309 if (CtdlAccessCheck(ac_logged_in)) {
313 if (num_parms(argbuf) != 2) {
314 cprintf("%d Invalid parameters\n", ERROR + ILLEGAL_VALUE);
318 target_msgnum = extract_long(argbuf, 0);
319 target_setting = extract_int(argbuf, 1);
321 CtdlSetSeen(&target_msgnum, 1, target_setting,
322 ctdlsetseen_seen, NULL, NULL);
323 cprintf("%d OK\n", CIT_OK);
327 void cmd_gtsn(char *argbuf) {
330 if (CtdlAccessCheck(ac_logged_in)) {
334 /* Learn about the user and room in question */
335 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
337 cprintf("%d ", CIT_OK);
338 client_write(vbuf.v_seen, strlen(vbuf.v_seen));
339 client_write(HKEY("\n"));
344 * INVT and KICK commands
346 void cmd_invt_kick(char *iuser, int op) {
349 * These commands are only allowed by admins, room admins,
350 * and room namespace owners
352 if (is_room_aide()) {
354 } else if ( ((atol(CC->room.QRname) == CC->user.usernum) ) && (CC->user.usernum != 0) ) {
358 cprintf("%d Higher access or room ownership required.\n", ERROR + HIGHER_ACCESS_REQUIRED);
362 if (!strncasecmp(CC->room.QRname, CtdlGetConfigStr("c_baseroom"),
364 cprintf("%d Can't add/remove users from this room.\n", ERROR + NOT_HERE);
368 if (CtdlInvtKick(iuser, op) != 0) {
369 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
373 cprintf("%d %s %s %s.\n",
375 ((op == 1) ? "invited to" : "kicked out of"),
381 void cmd_invt(char *iuser) {
382 cmd_invt_kick(iuser, 1);
386 void cmd_kick(char *iuser) {
387 cmd_invt_kick(iuser, 0);
392 * forget (Zap) the current room
394 void cmd_forg(char *argbuf)
397 if (CtdlAccessCheck(ac_logged_in)) {
401 if (CtdlForgetThisRoom() == 0) {
402 cprintf("%d Ok\n", CIT_OK);
405 cprintf("%d You may not forget this room.\n", ERROR + NOT_HERE);
411 * Get Next Unregistered User
413 void cmd_gnur(char *argbuf)
415 struct cdbdata *cdbus;
416 struct ctdluser usbuf;
418 if (CtdlAccessCheck(ac_aide)) {
422 if ((CtdlGetConfigInt("MMflags") & MM_VALID) == 0) {
423 cprintf("%d There are no unvalidated users.\n", CIT_OK);
427 /* There are unvalidated users. Traverse the user database,
428 * and return the first user we find that needs validation.
430 cdb_rewind(CDB_USERS);
431 while (cdbus = cdb_next_item(CDB_USERS), cdbus != NULL) {
432 memset(&usbuf, 0, sizeof(struct ctdluser));
433 memcpy(&usbuf, cdbus->ptr, ((cdbus->len > sizeof(struct ctdluser)) ? sizeof(struct ctdluser) : cdbus->len));
435 if ((usbuf.flags & US_NEEDVALID) && (usbuf.axlevel > AxDeleted)) {
436 cprintf("%d %s\n", MORE_DATA, usbuf.fullname);
437 cdb_close_cursor(CDB_USERS);
442 /* If we get to this point, there are no more unvalidated users.
443 * Therefore we clear the "users need validation" flag.
446 begin_critical_section(S_CONTROL);
448 flags = CtdlGetConfigInt("MMflags");
449 flags = flags & (~MM_VALID);
450 CtdlSetConfigInt("MMflags", flags);
451 end_critical_section(S_CONTROL);
452 cprintf("%d *** End of registration.\n", CIT_OK);
459 void cmd_vali(char *v_args)
463 struct ctdluser userbuf;
465 extract_token(user, v_args, 0, '|', sizeof user);
466 newax = extract_int(v_args, 1);
468 if (CtdlAccessCheck(ac_aide) || (newax > AxAideU) || (newax < AxDeleted)) {
472 if (CtdlGetUserLock(&userbuf, user) != 0) {
473 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, user);
477 userbuf.axlevel = newax;
478 userbuf.flags = (userbuf.flags & ~US_NEEDVALID);
480 CtdlPutUserLock(&userbuf);
482 /* If the access level was set to zero, delete the user */
484 if (purge_user(user) == 0) {
485 cprintf("%d %s Deleted.\n", CIT_OK, userbuf.fullname);
489 cprintf("%d User '%s' validated.\n", CIT_OK, userbuf.fullname);
493 * List users (searchstring may be empty to list all users)
495 void cmd_list(char *cmdbuf)
497 char searchstring[256];
498 extract_token(searchstring, cmdbuf, 0, '|', sizeof searchstring);
499 striplt(searchstring);
500 cprintf("%d \n", LISTING_FOLLOWS);
501 ForEachUser(ListThisUser, (void *)searchstring );
507 * assorted info we need to check at login
509 void cmd_chek(char *argbuf)
515 if (CtdlAccessCheck(ac_logged_in)) {
519 CtdlGetUser(&CC->user, CC->curr_user); // no lock is needed here
520 if ((REGISCALL != 0) && ((CC->user.flags & US_REGIS) == 0)) {
524 if (CC->user.axlevel >= AxAideU) {
525 if (CtdlGetConfigInt("MMflags") & MM_VALID) {
530 mail = InitialMailCheck(); // check for mail
532 cprintf("%d %d|%d|%d|%s|\n", CIT_OK, mail, regis, vali, CC->cs_inet_email);
537 * check to see if a user exists
539 void cmd_qusr(char *who)
541 struct ctdluser usbuf;
543 if (CtdlGetUser(&usbuf, who) == 0) {
544 cprintf("%d %s\n", CIT_OK, usbuf.fullname);
546 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
552 * Administrative Get User Parameters
554 void cmd_agup(char *cmdbuf)
556 struct ctdluser usbuf;
557 char requested_user[128];
559 if (CtdlAccessCheck(ac_aide)) {
563 extract_token(requested_user, cmdbuf, 0, '|', sizeof requested_user);
564 if (CtdlGetUser(&usbuf, requested_user) != 0) {
565 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
568 cprintf("%d %s|%s|%u|%ld|%ld|%d|%ld|%ld|%d\n",
577 (long)usbuf.lastcall,
583 * Administrative Set User Parameters
585 void cmd_asup(char *cmdbuf)
587 struct ctdluser usbuf;
588 char requested_user[128];
594 if (CtdlAccessCheck(ac_aide))
597 extract_token(requested_user, cmdbuf, 0, '|', sizeof requested_user);
598 if (CtdlGetUserLock(&usbuf, requested_user) != 0) {
599 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
602 np = num_parms(cmdbuf);
604 extract_token(usbuf.password, cmdbuf, 1, '|', sizeof usbuf.password);
606 usbuf.flags = extract_int(cmdbuf, 2);
608 usbuf.timescalled = extract_int(cmdbuf, 3);
610 usbuf.posted = extract_int(cmdbuf, 4);
612 newax = extract_int(cmdbuf, 5);
613 if ((newax >= AxDeleted) && (newax <= AxAideU)) {
614 usbuf.axlevel = newax;
618 usbuf.lastcall = extract_long(cmdbuf, 7);
621 usbuf.USuserpurge = extract_int(cmdbuf, 8);
623 CtdlPutUserLock(&usbuf);
624 if (usbuf.axlevel == AxDeleted) {
625 if (purge_user(requested_user) == 0) {
631 snprintf(notify, SIZ,
632 "User \"%s\" has been deleted by %s.\n",
633 usbuf.fullname, (CC->logged_in ? CC->user.fullname : "an administrator")
635 CtdlAideMessage(notify, "User Deletion Message");
638 cprintf("%d Ok", CIT_OK);
640 cprintf(" (%s deleted)", requested_user);
647 * Citadel protocol command to do the same
649 void cmd_isme(char *argbuf) {
652 if (CtdlAccessCheck(ac_logged_in)) return;
653 extract_token(addr, argbuf, 0, '|', sizeof addr);
655 if (CtdlIsMe(addr, sizeof addr)) {
656 cprintf("%d %s\n", CIT_OK, addr);
659 cprintf("%d Not you.\n", ERROR + ILLEGAL_VALUE);
666 * Administrative Get Email Addresses
668 void cmd_agea(char *cmdbuf)
670 struct ctdluser usbuf;
671 char requested_user[128];
675 if (CtdlAccessCheck(ac_aide)) {
679 extract_token(requested_user, cmdbuf, 0, '|', sizeof requested_user);
680 if (CtdlGetUser(&usbuf, requested_user) != 0) {
681 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
684 cprintf("%d internet email addresses for %s\n", LISTING_FOLLOWS, usbuf.fullname);
685 num_e = num_tokens(usbuf.emailaddrs, '|');
686 for (i=0; i<num_e; ++i) {
687 extract_token(e, usbuf.emailaddrs, i, '|', sizeof e);
695 * Administrative Set Email Addresses
697 void cmd_asea(char *cmdbuf)
699 struct ctdluser usbuf;
700 char requested_user[128];
703 char new_emailaddrs[512] = { 0 } ;
706 if (CtdlAccessCheck(ac_aide)) return;
708 extract_token(requested_user, cmdbuf, 0, '|', sizeof requested_user);
709 if (CtdlGetUser(&usbuf, requested_user) != 0) {
710 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
714 cprintf("%d Ok\n", SEND_LISTING);
715 while (client_getln(buf, sizeof buf) >= 0 && strcmp(buf, "000")) {
716 if ( // addresses must be:
717 (!IsEmptyStr(buf)) // non-empty
718 && ((strlen(new_emailaddrs) + strlen(buf) + 2) < sizeof(new_emailaddrs)) // fit in the remaining buffer
719 && (IsDirectory(buf, 0)) // in one of our own domains
720 && ( // not belong to someone else
721 (CtdlDirectoryLookup(whodat, buf, sizeof whodat) != 0)
722 || (!strcasecmp(whodat, requested_user))
725 if (!IsEmptyStr(new_emailaddrs)) {
726 strcat(new_emailaddrs, "|");
728 strcat(new_emailaddrs, buf);
732 if (CtdlGetUserLock(&usbuf, requested_user) != 0) { // We are relying on the fact that the DirectoryIndex functions don't lock.
733 return; // Silently fail here if we can't acquire a lock on the user record.
736 /* Delete all of the existing directory index records for the user (easier this way) */
737 for (i=0; i<num_tokens(usbuf.emailaddrs, '|'); ++i) {
738 extract_token(buf, usbuf.emailaddrs, i, '|', sizeof buf);
739 CtdlDirectoryDelUser(buf, requested_user);
742 strcpy(usbuf.emailaddrs, new_emailaddrs); // make it official.
744 /* Index all of the new email addresses (they've already been sanitized) */
745 for (i=0; i<num_tokens(usbuf.emailaddrs, '|'); ++i) {
746 extract_token(buf, usbuf.emailaddrs, i, '|', sizeof buf);
747 CtdlDirectoryAddUser(buf, requested_user);
750 CtdlPutUserLock(&usbuf);
755 * Set the preferred view for the current user/room combination
757 void cmd_view(char *cmdbuf) {
761 if (CtdlAccessCheck(ac_logged_in)) {
765 requested_view = extract_int(cmdbuf, 0);
767 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
768 vbuf.v_view = requested_view;
769 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
771 cprintf("%d ok\n", CIT_OK);
778 void cmd_renu(char *cmdbuf)
781 char oldname[USERNAME_SIZE];
782 char newname[USERNAME_SIZE];
784 if (CtdlAccessCheck(ac_aide)) {
788 extract_token(oldname, cmdbuf, 0, '|', sizeof oldname);
789 extract_token(newname, cmdbuf, 1, '|', sizeof newname);
791 retcode = rename_user(oldname, newname);
794 cprintf("%d '%s' has been renamed to '%s'.\n", CIT_OK, oldname, newname);
796 case RENAMEUSER_LOGGED_IN:
797 cprintf("%d '%s' is currently logged in and cannot be renamed.\n",
798 ERROR + ALREADY_LOGGED_IN , oldname
801 case RENAMEUSER_NOT_FOUND:
802 cprintf("%d '%s' does not exist.\n", ERROR + NO_SUCH_USER, oldname);
804 case RENAMEUSER_ALREADY_EXISTS:
805 cprintf("%d A user named '%s' already exists.\n", ERROR + ALREADY_EXISTS, newname);
809 cprintf("%d An unknown error occurred.\n", ERROR);
813 void cmd_quit(char *argbuf)
815 cprintf("%d Goodbye.\n", CIT_OK);
816 CC->kill_me = KILLME_CLIENT_LOGGED_OUT;
820 void cmd_lout(char *argbuf)
824 cprintf("%d logged out.\n", CIT_OK);
828 /*****************************************************************************/
829 /* MODULE INITIALIZATION STUFF */
830 /*****************************************************************************/
833 CTDL_MODULE_INIT(serv_user)
836 CtdlRegisterProtoHook(cmd_user, "USER", "Submit username for login");
837 CtdlRegisterProtoHook(cmd_pass, "PASS", "Complete login by submitting a password");
838 CtdlRegisterProtoHook(cmd_quit, "QUIT", "log out and disconnect from server");
839 CtdlRegisterProtoHook(cmd_lout, "LOUT", "log out but do not disconnect from server");
840 CtdlRegisterProtoHook(cmd_creu, "CREU", "Create User");
841 CtdlRegisterProtoHook(cmd_setp, "SETP", "Set the password for an account");
842 CtdlRegisterProtoHook(cmd_getu, "GETU", "Get User parameters");
843 CtdlRegisterProtoHook(cmd_setu, "SETU", "Set User parameters");
844 CtdlRegisterProtoHook(cmd_slrp, "SLRP", "Set Last Read Pointer");
845 CtdlRegisterProtoHook(cmd_invt, "INVT", "Invite a user to a room");
846 CtdlRegisterProtoHook(cmd_kick, "KICK", "Kick a user out of a room");
847 CtdlRegisterProtoHook(cmd_forg, "FORG", "Forget a room");
848 CtdlRegisterProtoHook(cmd_gnur, "GNUR", "Get Next Unregistered User");
849 CtdlRegisterProtoHook(cmd_vali, "VALI", "Validate new users");
850 CtdlRegisterProtoHook(cmd_list, "LIST", "List users");
851 CtdlRegisterProtoHook(cmd_chek, "CHEK", "assorted info we need to check at login");
852 CtdlRegisterProtoHook(cmd_qusr, "QUSR", "check to see if a user exists");
853 CtdlRegisterProtoHook(cmd_agup, "AGUP", "Administratively Get User Parameters");
854 CtdlRegisterProtoHook(cmd_asup, "ASUP", "Administratively Set User Parameters");
855 CtdlRegisterProtoHook(cmd_agea, "AGEA", "Administratively Get Email Addresses");
856 CtdlRegisterProtoHook(cmd_asea, "ASEA", "Administratively Set Email Addresses");
857 CtdlRegisterProtoHook(cmd_seen, "SEEN", "Manipulate seen/unread message flags");
858 CtdlRegisterProtoHook(cmd_gtsn, "GTSN", "Fetch seen/unread message flags");
859 CtdlRegisterProtoHook(cmd_view, "VIEW", "Set preferred view for user/room combination");
860 CtdlRegisterProtoHook(cmd_renu, "RENU", "Rename a user");
861 CtdlRegisterProtoHook(cmd_newu, "NEWU", "Log in as a new user");
862 CtdlRegisterProtoHook(cmd_isme, "ISME", "Determine whether an email address belongs to a user");
864 /* return our Subversion id for the Log */