4 * Server functions which perform operations on user objects.
17 #include <sys/types.h>
19 #ifdef HAVE_SYS_STAT_H
23 #if TIME_WITH_SYS_TIME
24 # include <sys/time.h>
28 # include <sys/time.h>
36 #include <libcitadel.h>
42 #include "sysdep_decls.h"
49 #include "citserver.h"
50 #include "citadel_dirs.h"
54 /* These pipes are used to talk to the chkpwd daemon, which is forked during startup */
55 int chkpwd_write_pipe[2];
56 int chkpwd_read_pipe[2];
59 * makeuserkey() - convert a username into the format used as a database key
60 * (it's just the username converted into lower case)
62 INLINE void makeuserkey(char *key, char *username) {
65 len = strlen(username);
66 if (len >= USERNAME_SIZE)
68 CtdlLogPrintf (CTDL_EMERG, "Username to long: %s", username);
70 len = USERNAME_SIZE - 1;
71 username[USERNAME_SIZE - 1]='\0';
73 for (i=0; i<=len; ++i) {
74 key[i] = tolower(username[i]);
80 * getuser() - retrieve named user into supplied buffer.
81 * returns 0 on success
83 int getuser(struct ctdluser *usbuf, char name[])
86 char usernamekey[USERNAME_SIZE];
87 struct cdbdata *cdbus;
90 memset(usbuf, 0, sizeof(struct ctdluser));
93 makeuserkey(usernamekey, name);
94 cdbus = cdb_fetch(CDB_USERS, usernamekey, strlen(usernamekey));
96 if (cdbus == NULL) { /* user not found */
100 memcpy(usbuf, cdbus->ptr,
101 ((cdbus->len > sizeof(struct ctdluser)) ?
102 sizeof(struct ctdluser) : cdbus->len));
111 * lgetuser() - same as getuser() but locks the record
113 int lgetuser(struct ctdluser *usbuf, char *name)
117 retcode = getuser(usbuf, name);
119 begin_critical_section(S_USERS);
126 * putuser() - write user buffer into the correct place on disk
128 void putuser(struct ctdluser *usbuf)
130 char usernamekey[USERNAME_SIZE];
132 makeuserkey(usernamekey, usbuf->fullname);
134 usbuf->version = REV_LEVEL;
136 usernamekey, strlen(usernamekey),
137 usbuf, sizeof(struct ctdluser));
143 * lputuser() - same as putuser() but locks the record
145 void lputuser(struct ctdluser *usbuf)
148 end_critical_section(S_USERS);
153 * rename_user() - this is tricky because the user's display name is the database key
155 * Returns 0 on success or nonzero if there was an error...
158 int rename_user(char *oldname, char *newname) {
159 struct CitContext *cptr;
160 int retcode = RENAMEUSER_OK;
161 struct ctdluser usbuf;
163 char oldnamekey[USERNAME_SIZE];
164 char newnamekey[USERNAME_SIZE];
166 /* We cannot rename a user who is currently logged in */
167 for (cptr = ContextList; cptr != NULL; cptr = cptr->next) {
168 if (!strcasecmp(cptr->user.fullname, oldname)) {
169 return(RENAMEUSER_LOGGED_IN);
173 /* Create the database keys... */
174 makeuserkey(oldnamekey, oldname);
175 makeuserkey(newnamekey, newname);
177 /* Lock up and get going */
178 begin_critical_section(S_USERS);
180 if (getuser(&usbuf, newname) == 0) {
181 retcode = RENAMEUSER_ALREADY_EXISTS;
185 if (getuser(&usbuf, oldname) != 0) {
186 retcode = RENAMEUSER_NOT_FOUND;
189 else { /* Sanity checks succeeded. Now rename the user. */
190 if (usbuf.usernum == 0)
192 CtdlLogPrintf (CTDL_DEBUG, "Can not rename user \"Citadel\".\n");
193 retcode = RENAMEUSER_NOT_FOUND;
195 CtdlLogPrintf(CTDL_DEBUG, "Renaming <%s> to <%s>\n", oldname, newname);
196 cdb_delete(CDB_USERS, oldnamekey, strlen(oldnamekey));
197 safestrncpy(usbuf.fullname, newname, sizeof usbuf.fullname);
199 cdb_store(CDB_USERSBYNUMBER, &usbuf.usernum, sizeof(long),
200 usbuf.fullname, strlen(usbuf.fullname)+1 );
202 retcode = RENAMEUSER_OK;
208 end_critical_section(S_USERS);
215 * Index-generating function used by Ctdl[Get|Set]Relationship
217 int GenerateRelationshipIndex(char *IndexBuf,
229 TheIndex.iRoomID = RoomID;
230 TheIndex.iRoomGen = RoomGen;
231 TheIndex.iUserID = UserID;
233 memcpy(IndexBuf, &TheIndex, sizeof(TheIndex));
234 return (sizeof(TheIndex));
240 * Back end for CtdlSetRelationship()
242 void put_visit(struct visit *newvisit)
247 memset (IndexBuf, 0, sizeof (IndexBuf));
248 /* Generate an index */
249 IndexLen = GenerateRelationshipIndex(IndexBuf,
252 newvisit->v_usernum);
254 /* Store the record */
255 cdb_store(CDB_VISIT, IndexBuf, IndexLen,
256 newvisit, sizeof(struct visit)
264 * Define a relationship between a user and a room
266 void CtdlSetRelationship(struct visit *newvisit,
267 struct ctdluser *rel_user,
268 struct ctdlroom *rel_room)
272 /* We don't use these in Citadel because they're implicit by the
273 * index, but they must be present if the database is exported.
275 newvisit->v_roomnum = rel_room->QRnumber;
276 newvisit->v_roomgen = rel_room->QRgen;
277 newvisit->v_usernum = rel_user->usernum;
283 * Locate a relationship between a user and a room
285 void CtdlGetRelationship(struct visit *vbuf,
286 struct ctdluser *rel_user,
287 struct ctdlroom *rel_room)
292 struct cdbdata *cdbvisit;
294 /* Generate an index */
295 IndexLen = GenerateRelationshipIndex(IndexBuf,
300 /* Clear out the buffer */
301 memset(vbuf, 0, sizeof(struct visit));
303 cdbvisit = cdb_fetch(CDB_VISIT, IndexBuf, IndexLen);
304 if (cdbvisit != NULL) {
305 memcpy(vbuf, cdbvisit->ptr,
306 ((cdbvisit->len > sizeof(struct visit)) ?
307 sizeof(struct visit) : cdbvisit->len));
311 /* If this is the first time the user has seen this room,
312 * set the view to be the default for the room.
314 vbuf->v_view = rel_room->QRdefaultview;
317 /* Set v_seen if necessary */
318 if (vbuf->v_seen[0] == 0) {
319 snprintf(vbuf->v_seen, sizeof vbuf->v_seen, "*:%ld", vbuf->v_lastseen);
324 void MailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix)
326 snprintf(buf, n, "%010ld.%s", who->usernum, prefix);
331 * Is the user currently logged in an Aide?
335 if (CC->user.axlevel >= 6)
343 * Is the user currently logged in an Aide *or* the room aide for this room?
345 int is_room_aide(void)
348 if (!CC->logged_in) {
352 if ((CC->user.axlevel >= 6)
353 || (CC->room.QRroomaide == CC->user.usernum)) {
361 * getuserbynumber() - get user by number
362 * returns 0 if user was found
364 * Note: fetching a user this way requires one additional database operation.
366 int getuserbynumber(struct ctdluser *usbuf, long number)
368 struct cdbdata *cdbun;
371 cdbun = cdb_fetch(CDB_USERSBYNUMBER, &number, sizeof(long));
373 CtdlLogPrintf(CTDL_INFO, "User %ld not found\n", number);
377 CtdlLogPrintf(CTDL_INFO, "User %ld maps to %s\n", number, cdbun->ptr);
378 r = getuser(usbuf, cdbun->ptr);
386 * Helper function for rebuild_usersbynumber()
388 void rebuild_ubn_for_user(struct ctdluser *usbuf, void *data) {
391 struct ubnlist *next;
392 char username[USERNAME_SIZE];
396 static struct ubnlist *u = NULL;
397 struct ubnlist *ptr = NULL;
399 /* Lazy programming here. Call this function as a ForEachUser backend
400 * in order to queue up the room names, or call it with a null user
401 * to make it do the processing.
404 ptr = (struct ubnlist *) malloc(sizeof (struct ubnlist));
405 if (ptr == NULL) return;
407 ptr->usernum = usbuf->usernum;
408 safestrncpy(ptr->username, usbuf->fullname, sizeof ptr->username);
415 CtdlLogPrintf(CTDL_DEBUG, "Rebuilding usersbynumber index %10ld : %s\n",
416 u->usernum, u->username);
417 cdb_store(CDB_USERSBYNUMBER, &u->usernum, sizeof(long), u->username, strlen(u->username)+1);
428 * Rebuild the users-by-number index
430 void rebuild_usersbynumber(void) {
431 cdb_trunc(CDB_USERSBYNUMBER); /* delete the old indices */
432 ForEachUser(rebuild_ubn_for_user, NULL); /* enumerate the users */
433 rebuild_ubn_for_user(NULL, NULL); /* and index them */
439 * getuserbyuid() - get user by system uid (for PAM mode authentication)
440 * returns 0 if user was found
442 * WARNING: don't use this function unless you absolutely have to. It does
443 * a sequential search and therefore is computationally expensive.
445 int getuserbyuid(struct ctdluser *usbuf, uid_t number)
447 struct cdbdata *cdbus;
449 cdb_rewind(CDB_USERS);
451 while (cdbus = cdb_next_item(CDB_USERS), cdbus != NULL) {
452 memset(usbuf, 0, sizeof(struct ctdluser));
453 memcpy(usbuf, cdbus->ptr,
454 ((cdbus->len > sizeof(struct ctdluser)) ?
455 sizeof(struct ctdluser) : cdbus->len));
457 if (usbuf->uid == number) {
458 cdb_close_cursor(CDB_USERS);
466 * Back end for cmd_user() and its ilk
468 * NOTE: "authname" should only be used if we are attempting to use the "master user" feature
470 int CtdlLoginExistingUser(char *authname, char *trythisname)
475 CtdlLogPrintf(9, "CtdlLoginExistingUser(%s, %s)\n", authname, trythisname);
477 if ((CC->logged_in)) {
478 return login_already_logged_in;
481 if (trythisname == NULL) return login_not_found;
483 if (!strncasecmp(trythisname, "SYS_", 4))
485 CtdlLogPrintf(CTDL_DEBUG, "System user \"%s\" is not allowed to log in.\n", trythisname);
486 return login_not_found;
489 /* If a "master user" is defined, handle its authentication if specified */
491 if (strlen(config.c_master_user) > 0) if (strlen(config.c_master_pass) > 0) if (authname) {
492 if (!strcasecmp(authname, config.c_master_user)) {
497 /* Continue attempting user validation... */
498 safestrncpy(username, trythisname, USERNAME_SIZE);
501 if (IsEmptyStr(username)) {
502 return login_not_found;
505 if (config.c_auth_mode == AUTHMODE_HOST) {
510 struct passwd *tempPwdPtr;
513 CtdlLogPrintf(CTDL_DEBUG, "asking host about <%s>\n", username);
514 #ifdef HAVE_GETPWNAM_R
515 #ifdef SOLARIS_GETPWUID
516 CtdlLogPrintf(CTDL_DEBUG, "Calling getpwnam_r()\n");
517 tempPwdPtr = getpwnam_r(username, &pd, pwdbuffer, sizeof pwdbuffer);
518 #else // SOLARIS_GETPWUID
519 CtdlLogPrintf(CTDL_DEBUG, "Calling getpwnam_r()\n");
520 getpwnam_r(username, &pd, pwdbuffer, sizeof pwdbuffer, &tempPwdPtr);
521 #endif // SOLARIS_GETPWUID
522 #else // HAVE_GETPWNAM_R
523 CtdlLogPrintf(CTDL_DEBUG, "SHOULD NEVER GET HERE!!!\n");
525 #endif // HAVE_GETPWNAM_R
526 if (tempPwdPtr == NULL) {
527 CtdlLogPrintf(CTDL_DEBUG, "no such user <%s>\n", username);
528 return login_not_found;
531 /* Locate the associated Citadel account.
532 * If not found, make one attempt to create it.
534 found_user = getuserbyuid(&CC->user, pd.pw_uid);
535 CtdlLogPrintf(CTDL_DEBUG, "found it: uid=%ld, gecos=%s here: %d\n",
536 (long)pd.pw_uid, pd.pw_gecos, found_user);
537 if (found_user != 0) {
538 create_user(username, 0);
539 found_user = getuserbyuid(&CC->user, pd.pw_uid);
545 /* native auth mode */
547 struct recptypes *valid = NULL;
549 /* First, try to log in as if the supplied name is a display name */
550 found_user = getuser(&CC->user, username);
552 /* If that didn't work, try to log in as if the supplied name
553 * is an e-mail address
555 if (found_user != 0) {
556 valid = validate_recipients(username, NULL, 0);
558 if (valid->num_local == 1) {
559 found_user = getuser(&CC->user, valid->recp_local);
561 free_recipients(valid);
566 /* Did we find something? */
567 if (found_user == 0) {
568 if (((CC->nologin)) && (CC->user.axlevel < 6)) {
569 return login_too_many_users;
571 safestrncpy(CC->curr_user, CC->user.fullname,
572 sizeof CC->curr_user);
576 return login_not_found;
584 void cmd_user(char *cmdbuf)
589 extract_token(username, cmdbuf, 0, '|', sizeof username);
592 a = CtdlLoginExistingUser(NULL, username);
594 case login_already_logged_in:
595 cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
597 case login_too_many_users:
599 "Too many users are already online "
601 ERROR + MAX_SESSIONS_EXCEEDED,
602 config.c_nodename, config.c_maxsessions);
605 cprintf("%d Password required for %s\n",
606 MORE_DATA, CC->curr_user);
608 case login_not_found:
609 cprintf("%d %s not found.\n", ERROR + NO_SUCH_USER, username);
612 cprintf("%d Internal error\n", ERROR + INTERNAL_ERROR);
619 * session startup code which is common to both cmd_pass() and cmd_newu()
624 CtdlLogPrintf(CTDL_NOTICE, "<%s> logged in\n", CC->curr_user);
626 lgetuser(&CC->user, CC->curr_user);
627 ++(CC->user.timescalled);
628 CC->previous_login = CC->user.lastcall;
629 time(&CC->user.lastcall);
631 /* If this user's name is the name of the system administrator
632 * (as specified in setup), automatically assign access level 6.
634 if (!strcasecmp(CC->user.fullname, config.c_sysadm)) {
635 CC->user.axlevel = 6;
638 /* If we're authenticating off the host system, automatically give
639 * root the highest level of access.
641 if (config.c_auth_mode == AUTHMODE_HOST) {
642 if (CC->user.uid == 0) {
643 CC->user.axlevel = 6;
650 * Populate CC->cs_inet_email with a default address. This will be
651 * overwritten with the user's directory address, if one exists, when
652 * the vCard module's login hook runs.
654 snprintf(CC->cs_inet_email, sizeof CC->cs_inet_email, "%s@%s",
655 CC->user.fullname, config.c_fqdn);
656 convert_spaces_to_underscores(CC->cs_inet_email);
658 /* Create any personal rooms required by the system.
659 * (Technically, MAILROOM should be there already, but just in case...)
661 create_room(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
662 create_room(SENTITEMS, 4, "", 0, 1, 0, VIEW_MAILBOX);
663 create_room(USERTRASHROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
665 /* Run any startup routines registered by loadable modules */
666 PerformSessionHooks(EVT_LOGIN);
668 /* Enter the lobby */
669 usergoto(config.c_baseroom, 0, 0, NULL, NULL);
673 void logged_in_response(void)
675 cprintf("%d %s|%d|%ld|%ld|%u|%ld|%ld\n",
676 CIT_OK, CC->user.fullname, CC->user.axlevel,
677 CC->user.timescalled, CC->user.posted,
678 CC->user.flags, CC->user.usernum,
685 * misc things to be taken care of when a user is logged out
689 struct CitContext *CCC = CC; /* CachedCitContext - performance boost */
691 * If there is a download in progress, abort it.
693 if (CCC->download_fp != NULL) {
694 fclose(CCC->download_fp);
695 CCC->download_fp = NULL;
699 * If there is an upload in progress, abort it.
701 if (CCC->upload_fp != NULL) {
706 * If we were talking to a network node, we're not anymore...
708 if (!IsEmptyStr(CCC->net_node)) {
709 network_talking_to(CCC->net_node, NTT_REMOVE);
712 /* Run any hooks registered by modules... */
713 PerformSessionHooks(EVT_LOGOUT);
716 * Clear out some session data. Most likely, the CitContext for this
717 * session is about to get nuked when the session disconnects, but
718 * since it's possible to log in again without reconnecting, we cannot
719 * make that assumption.
721 strcpy(CCC->fake_username, "");
722 strcpy(CCC->fake_hostname, "");
723 strcpy(CCC->fake_roomname, "");
726 /* Check to see if the user was deleted whilst logged in and purge them if necessary */
727 if ((CCC->user.axlevel == 0) && (CCC->user.usernum))
728 purge_user(CCC->user.fullname);
730 /* Free any output buffers */
735 * Validate a password on the host unix system by talking to the chkpwd daemon
737 static int validpw(uid_t uid, const char *pass)
741 if (IsEmptyStr(pass)) {
742 CtdlLogPrintf(CTDL_DEBUG, "refusing to check empty password for uid=%d using chkpwd...\n", uid);
746 CtdlLogPrintf(CTDL_DEBUG, "Validating password for uid=%d using chkpwd...\n", uid);
748 begin_critical_section(S_CHKPWD);
749 write(chkpwd_write_pipe[1], &uid, sizeof(uid_t));
750 write(chkpwd_write_pipe[1], pass, 256);
751 read(chkpwd_read_pipe[0], buf, 4);
752 end_critical_section(S_CHKPWD);
754 if (!strncmp(buf, "PASS", 4)) {
755 CtdlLogPrintf(CTDL_DEBUG, "...pass\n");
759 CtdlLogPrintf(CTDL_DEBUG, "...fail\n");
764 * Start up the chkpwd daemon so validpw() has something to talk to
766 void start_chkpwd_daemon(void) {
768 struct stat filestats;
771 CtdlLogPrintf(CTDL_DEBUG, "Starting chkpwd daemon for host authentication mode\n");
773 if ((stat(file_chkpwd, &filestats)==-1) ||
774 (filestats.st_size==0)){
775 printf("didn't find chkpwd daemon in %s: %s\n", file_chkpwd, strerror(errno));
778 if (pipe(chkpwd_write_pipe) != 0) {
779 CtdlLogPrintf(CTDL_EMERG, "Unable to create pipe for chkpwd daemon: %s\n", strerror(errno));
782 if (pipe(chkpwd_read_pipe) != 0) {
783 CtdlLogPrintf(CTDL_EMERG, "Unable to create pipe for chkpwd daemon: %s\n", strerror(errno));
788 if (chkpwd_pid < 0) {
789 CtdlLogPrintf(CTDL_EMERG, "Unable to fork chkpwd daemon: %s\n", strerror(errno));
792 if (chkpwd_pid == 0) {
793 CtdlLogPrintf(CTDL_DEBUG, "Now calling dup2() write\n");
794 dup2(chkpwd_write_pipe[0], 0);
795 CtdlLogPrintf(CTDL_DEBUG, "Now calling dup2() write\n");
796 dup2(chkpwd_read_pipe[1], 1);
797 CtdlLogPrintf(CTDL_DEBUG, "Now closing stuff\n");
798 for (i=2; i<256; ++i) close(i);
799 CtdlLogPrintf(CTDL_DEBUG, "Now calling execl(%s)\n", file_chkpwd);
800 execl(file_chkpwd, file_chkpwd, NULL);
801 CtdlLogPrintf(CTDL_EMERG, "Unable to exec chkpwd daemon: %s\n", strerror(errno));
808 int CtdlTryPassword(char *password)
812 if ((CC->logged_in)) {
813 CtdlLogPrintf(CTDL_WARNING, "CtdlTryPassword: already logged in\n");
814 return pass_already_logged_in;
816 if (!strcmp(CC->curr_user, NLI)) {
817 CtdlLogPrintf(CTDL_WARNING, "CtdlTryPassword: no user selected\n");
820 if (getuser(&CC->user, CC->curr_user)) {
821 CtdlLogPrintf(CTDL_ERR, "CtdlTryPassword: internal error\n");
822 return pass_internal_error;
824 if (password == NULL) {
825 CtdlLogPrintf(CTDL_INFO, "CtdlTryPassword: NULL password string supplied\n");
826 return pass_wrong_password;
831 code = strcmp(password, config.c_master_pass);
834 else if (config.c_auth_mode == AUTHMODE_HOST) {
838 if (validpw(CC->user.uid, password)) {
842 * sooper-seekrit hack: populate the password field in the
843 * citadel database with the password that the user typed,
844 * if it's correct. This allows most sites to convert from
845 * host auth to native auth if they want to. If you think
846 * this is a security hazard, comment it out.
849 lgetuser(&CC->user, CC->curr_user);
850 safestrncpy(CC->user.password, password, sizeof CC->user.password);
854 * (sooper-seekrit hack ends here)
865 /* native auth mode */
868 strproc(CC->user.password);
869 code = strcasecmp(CC->user.password, password);
871 strproc(CC->user.password);
872 code = strcasecmp(CC->user.password, password);
879 CtdlLogPrintf(CTDL_WARNING, "Bad password specified for <%s>\n", CC->curr_user);
880 return pass_wrong_password;
885 void cmd_pass(char *buf)
890 extract_token(password, buf, 0, '|', sizeof password);
891 a = CtdlTryPassword(password);
894 case pass_already_logged_in:
895 cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
898 cprintf("%d You must send a name with USER first.\n",
899 ERROR + USERNAME_REQUIRED);
901 case pass_wrong_password:
902 cprintf("%d Wrong password.\n", ERROR + PASSWORD_REQUIRED);
905 logged_in_response();
913 * Delete a user record *and* all of its related resources.
915 int purge_user(char pname[])
918 struct ctdluser usbuf;
919 char usernamekey[USERNAME_SIZE];
920 struct CitContext *ccptr;
921 int user_is_logged_in = 0;
923 makeuserkey(usernamekey, pname);
925 /* If the name is empty we can't find them in the DB any way so just return */
926 if (IsEmptyStr(pname))
927 return (ERROR + NO_SUCH_USER);
929 if (getuser(&usbuf, pname) != 0) {
930 CtdlLogPrintf(CTDL_ERR, "Cannot purge user <%s> - not found\n", pname);
931 return (ERROR + NO_SUCH_USER);
933 /* Don't delete a user who is currently logged in. Instead, just
934 * set the access level to 0, and let the account get swept up
935 * during the next purge.
937 user_is_logged_in = 0;
938 begin_critical_section(S_SESSION_TABLE);
939 for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
940 if (ccptr->user.usernum == usbuf.usernum) {
941 user_is_logged_in = 1;
944 end_critical_section(S_SESSION_TABLE);
945 if (user_is_logged_in == 1) {
946 CtdlLogPrintf(CTDL_WARNING, "User <%s> is logged in; not deleting.\n", pname);
951 CtdlLogPrintf(CTDL_NOTICE, "Deleting user <%s>\n", pname);
953 /* Perform any purge functions registered by server extensions */
954 PerformUserHooks(&usbuf, EVT_PURGEUSER);
956 /* delete any existing user/room relationships */
957 cdb_delete(CDB_VISIT, &usbuf.usernum, sizeof(long));
959 /* delete the users-by-number index record */
960 cdb_delete(CDB_USERSBYNUMBER, &usbuf.usernum, sizeof(long));
962 /* delete the userlog entry */
963 cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
965 /* remove the user's bio file */
973 /* remove the user's picture */
985 int internal_create_user (char *username, struct ctdluser *usbuf, uid_t uid)
987 if (!getuser(usbuf, username)) {
988 return (ERROR + ALREADY_EXISTS);
991 /* Go ahead and initialize a new user record */
992 memset(usbuf, 0, sizeof(struct ctdluser));
993 safestrncpy(usbuf->fullname, username, sizeof usbuf->fullname);
994 strcpy(usbuf->password, "");
997 /* These are the default flags on new accounts */
998 usbuf->flags = US_LASTOLD | US_DISAPPEAR | US_PAGINATOR | US_FLOORS;
1000 usbuf->timescalled = 0;
1002 usbuf->axlevel = config.c_initax;
1003 usbuf->USscreenwidth = 80;
1004 usbuf->USscreenheight = 24;
1005 usbuf->lastcall = time(NULL);
1007 /* fetch a new user number */
1008 usbuf->usernum = get_new_user_number();
1010 /* add user to the database */
1012 cdb_store(CDB_USERSBYNUMBER, &usbuf->usernum, sizeof(long), usbuf->fullname, strlen(usbuf->fullname)+1);
1020 * create_user() - back end processing to create a new user
1022 * Set 'newusername' to the desired account name.
1023 * Set 'become_user' to nonzero if this is self-service account creation and we want
1024 * to actually log in as the user we just created, otherwise set it to 0.
1026 int create_user(char *newusername, int become_user)
1028 struct ctdluser usbuf;
1029 struct ctdlroom qrbuf;
1031 char mailboxname[ROOMNAMELEN];
1037 safestrncpy(username, newusername, sizeof username);
1041 if (config.c_auth_mode == AUTHMODE_HOST) {
1043 /* host auth mode */
1046 struct passwd *tempPwdPtr;
1047 char pwdbuffer[256];
1049 #ifdef HAVE_GETPWNAM_R
1050 #ifdef SOLARIS_GETPWUID
1051 tempPwdPtr = getpwnam_r(username, &pd, pwdbuffer, sizeof(pwdbuffer));
1052 #else // SOLARIS_GETPWUID
1053 getpwnam_r(username, &pd, pwdbuffer, sizeof pwdbuffer, &tempPwdPtr);
1054 #endif // SOLARIS_GETPWUID
1055 #else // HAVE_GETPWNAM_R
1057 #endif // HAVE_GETPWNAM_R
1058 if (tempPwdPtr != NULL) {
1059 extract_token(username, pd.pw_gecos, 0, ',', sizeof username);
1061 if (IsEmptyStr (username))
1063 safestrncpy(username, pd.pw_name, sizeof username);
1067 return (ERROR + NO_SUCH_USER);
1071 if ((retval = internal_create_user(username, &usbuf, uid)) != 0)
1075 * Give the user a private mailbox and a configuration room.
1076 * Make the latter an invisible system room.
1078 MailboxName(mailboxname, sizeof mailboxname, &usbuf, MAILROOM);
1079 create_room(mailboxname, 5, "", 0, 1, 1, VIEW_MAILBOX);
1081 MailboxName(mailboxname, sizeof mailboxname, &usbuf, USERCONFIGROOM);
1082 create_room(mailboxname, 5, "", 0, 1, 1, VIEW_BBS);
1083 if (lgetroom(&qrbuf, mailboxname) == 0) {
1084 qrbuf.QRflags2 |= QR2_SYSTEM;
1088 /* Perform any create functions registered by server extensions */
1089 PerformUserHooks(&usbuf, EVT_NEWUSER);
1091 /* Everything below this line can be bypassed if administratively
1092 * creating a user, instead of doing self-service account creation
1096 /* Now become the user we just created */
1097 memcpy(&CC->user, &usbuf, sizeof(struct ctdluser));
1098 safestrncpy(CC->curr_user, username, sizeof CC->curr_user);
1101 /* Check to make sure we're still who we think we are */
1102 if (getuser(&CC->user, CC->curr_user)) {
1103 return (ERROR + INTERNAL_ERROR);
1108 "New user account <%s> has been created, from host %s [%s].\n",
1113 aide_message(buf, "User Creation Notice");
1114 CtdlLogPrintf(CTDL_NOTICE, "New user <%s> created\n", username);
1121 * cmd_newu() - create a new user account and log in as that user
1123 void cmd_newu(char *cmdbuf)
1128 if (config.c_auth_mode != AUTHMODE_NATIVE) {
1129 cprintf("%d This system does not use native mode authentication.\n",
1134 if (config.c_disable_newu) {
1135 cprintf("%d Self-service user account creation "
1136 "is disabled on this system.\n", ERROR + NOT_HERE);
1140 if (CC->logged_in) {
1141 cprintf("%d Already logged in.\n", ERROR + ALREADY_LOGGED_IN);
1145 cprintf("%d %s: Too many users are already online (maximum is %d)\n",
1146 ERROR + MAX_SESSIONS_EXCEEDED,
1147 config.c_nodename, config.c_maxsessions);
1149 extract_token(username, cmdbuf, 0, '|', sizeof username);
1153 if (IsEmptyStr(username)) {
1154 cprintf("%d You must supply a user name.\n", ERROR + USERNAME_REQUIRED);
1158 if ((!strcasecmp(username, "bbs")) ||
1159 (!strcasecmp(username, "new")) ||
1160 (!strcasecmp(username, "."))) {
1161 cprintf("%d '%s' is an invalid login name.\n", ERROR + ILLEGAL_VALUE, username);
1165 a = create_user(username, 1);
1168 logged_in_response();
1169 } else if (a == ERROR + ALREADY_EXISTS) {
1170 cprintf("%d '%s' already exists.\n",
1171 ERROR + ALREADY_EXISTS, username);
1173 } else if (a == ERROR + INTERNAL_ERROR) {
1174 cprintf("%d Internal error - user record disappeared?\n",
1175 ERROR + INTERNAL_ERROR);
1178 cprintf("%d unknown error\n", ERROR + INTERNAL_ERROR);
1184 * set password - back end api code
1186 void CtdlSetPassword(char *new_pw)
1188 lgetuser(&CC->user, CC->curr_user);
1189 safestrncpy(CC->user.password, new_pw, sizeof(CC->user.password));
1190 lputuser(&CC->user);
1191 CtdlLogPrintf(CTDL_INFO, "Password changed for user <%s>\n", CC->curr_user);
1192 PerformSessionHooks(EVT_SETPASS);
1197 * set password - citadel protocol implementation
1199 void cmd_setp(char *new_pw)
1201 int generate_random_password = 0;
1203 if (CtdlAccessCheck(ac_logged_in)) {
1206 if ( (CC->user.uid != CTDLUID) && (CC->user.uid != (-1)) ) {
1207 cprintf("%d Not allowed. Use the 'passwd' command.\n", ERROR + NOT_HERE);
1210 if (CC->is_master) {
1211 cprintf("%d The master prefix password cannot be changed with this command.\n",
1216 if (!strcasecmp(new_pw, "GENERATE_RANDOM_PASSWORD")) {
1217 char random_password[17];
1218 generate_random_password = 1;
1219 snprintf(random_password, sizeof random_password, "%08lx%08lx", random(), random());
1220 CtdlSetPassword(random_password);
1221 cprintf("%d %s\n", CIT_OK, random_password);
1225 if (IsEmptyStr(new_pw)) {
1226 cprintf("%d Password unchanged.\n", CIT_OK);
1229 CtdlSetPassword(new_pw);
1230 cprintf("%d Password changed.\n", CIT_OK);
1236 * cmd_creu() - administratively create a new user account (do not log in to it)
1238 void cmd_creu(char *cmdbuf)
1243 struct ctdluser tmp;
1245 if (CtdlAccessCheck(ac_aide)) {
1249 extract_token(username, cmdbuf, 0, '|', sizeof username);
1250 extract_token(password, cmdbuf, 1, '|', sizeof password);
1256 if (IsEmptyStr(username)) {
1257 cprintf("%d You must supply a user name.\n", ERROR + USERNAME_REQUIRED);
1261 a = create_user(username, 0);
1264 if (!IsEmptyStr(password)) {
1265 lgetuser(&tmp, username);
1266 safestrncpy(tmp.password, password, sizeof(tmp.password));
1269 cprintf("%d User '%s' created %s.\n", CIT_OK, username,
1270 (!IsEmptyStr(password)) ? "and password set" :
1271 "with no password");
1273 } else if (a == ERROR + ALREADY_EXISTS) {
1274 cprintf("%d '%s' already exists.\n", ERROR + ALREADY_EXISTS, username);
1276 } else if ( (config.c_auth_mode != AUTHMODE_NATIVE) && (a == ERROR + NO_SUCH_USER) ) {
1277 cprintf("%d User accounts are not created within Citadel in host authentication mode.\n",
1278 ERROR + NO_SUCH_USER);
1281 cprintf("%d An error occurred creating the user account.\n", ERROR + INTERNAL_ERROR);
1288 * get user parameters
1293 if (CtdlAccessCheck(ac_logged_in))
1296 getuser(&CC->user, CC->curr_user);
1297 cprintf("%d %d|%d|%d|\n",
1299 CC->user.USscreenwidth,
1300 CC->user.USscreenheight,
1301 (CC->user.flags & US_USER_SET)
1306 * set user parameters
1308 void cmd_setu(char *new_parms)
1310 if (CtdlAccessCheck(ac_logged_in))
1313 if (num_parms(new_parms) < 3) {
1314 cprintf("%d Usage error.\n", ERROR + ILLEGAL_VALUE);
1317 lgetuser(&CC->user, CC->curr_user);
1318 CC->user.USscreenwidth = extract_int(new_parms, 0);
1319 CC->user.USscreenheight = extract_int(new_parms, 1);
1320 CC->user.flags = CC->user.flags & (~US_USER_SET);
1321 CC->user.flags = CC->user.flags |
1322 (extract_int(new_parms, 2) & US_USER_SET);
1324 lputuser(&CC->user);
1325 cprintf("%d Ok\n", CIT_OK);
1329 * set last read pointer
1331 void cmd_slrp(char *new_ptr)
1335 struct visit original_vbuf;
1337 if (CtdlAccessCheck(ac_logged_in)) {
1341 if (!strncasecmp(new_ptr, "highest", 7)) {
1342 newlr = CC->room.QRhighest;
1344 newlr = atol(new_ptr);
1347 lgetuser(&CC->user, CC->curr_user);
1349 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
1350 memcpy(&original_vbuf, &vbuf, sizeof(struct visit));
1351 vbuf.v_lastseen = newlr;
1352 snprintf(vbuf.v_seen, sizeof vbuf.v_seen, "*:%ld", newlr);
1354 /* Only rewrite the record if it changed */
1355 if ( (vbuf.v_lastseen != original_vbuf.v_lastseen)
1356 || (strcmp(vbuf.v_seen, original_vbuf.v_seen)) ) {
1357 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
1360 lputuser(&CC->user);
1361 cprintf("%d %ld\n", CIT_OK, newlr);
1365 void cmd_seen(char *argbuf) {
1366 long target_msgnum = 0L;
1367 int target_setting = 0;
1369 if (CtdlAccessCheck(ac_logged_in)) {
1373 if (num_parms(argbuf) != 2) {
1374 cprintf("%d Invalid parameters\n", ERROR + ILLEGAL_VALUE);
1378 target_msgnum = extract_long(argbuf, 0);
1379 target_setting = extract_int(argbuf, 1);
1381 CtdlSetSeen(&target_msgnum, 1, target_setting,
1382 ctdlsetseen_seen, NULL, NULL);
1383 cprintf("%d OK\n", CIT_OK);
1387 void cmd_gtsn(char *argbuf) {
1390 if (CtdlAccessCheck(ac_logged_in)) {
1394 CtdlGetSeen(buf, ctdlsetseen_seen);
1395 cprintf("%d %s\n", CIT_OK, buf);
1400 * API function for cmd_invt_kick() and anything else that needs to
1401 * invite or kick out a user to/from a room.
1403 * Set iuser to the name of the user, and op to 1=invite or 0=kick
1405 int CtdlInvtKick(char *iuser, int op) {
1406 struct ctdluser USscratch;
1410 if (getuser(&USscratch, iuser) != 0) {
1414 CtdlGetRelationship(&vbuf, &USscratch, &CC->room);
1416 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
1417 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
1420 vbuf.v_flags = vbuf.v_flags & ~V_ACCESS;
1421 vbuf.v_flags = vbuf.v_flags | V_FORGET | V_LOCKOUT;
1423 CtdlSetRelationship(&vbuf, &USscratch, &CC->room);
1425 /* post a message in Aide> saying what we just did */
1426 snprintf(bbb, sizeof bbb, "%s has been %s \"%s\" by %s.\n",
1428 ((op == 1) ? "invited to" : "kicked out of"),
1431 aide_message(bbb,"User Admin Message");
1438 * INVT and KICK commands
1440 void cmd_invt_kick(char *iuser, int op) {
1443 * These commands are only allowed by aides, room aides,
1444 * and room namespace owners
1447 || (atol(CC->room.QRname) == CC->user.usernum) ) {
1448 /* access granted */
1451 cprintf("%d Higher access or room ownership required.\n",
1452 ERROR + HIGHER_ACCESS_REQUIRED);
1456 if (!strncasecmp(CC->room.QRname, config.c_baseroom,
1458 cprintf("%d Can't add/remove users from this room.\n",
1463 if (CtdlInvtKick(iuser, op) != 0) {
1464 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
1468 cprintf("%d %s %s %s.\n",
1470 ((op == 1) ? "invited to" : "kicked out of"),
1477 * Forget (Zap) the current room (API call)
1478 * Returns 0 on success
1480 int CtdlForgetThisRoom(void) {
1483 /* On some systems, Aides are not allowed to forget rooms */
1484 if (is_aide() && (config.c_aide_zap == 0)
1485 && ((CC->room.QRflags & QR_MAILBOX) == 0) ) {
1489 lgetuser(&CC->user, CC->curr_user);
1490 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
1492 vbuf.v_flags = vbuf.v_flags | V_FORGET;
1493 vbuf.v_flags = vbuf.v_flags & ~V_ACCESS;
1495 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
1496 lputuser(&CC->user);
1498 /* Return to the Lobby, so we don't end up in an undefined room */
1499 usergoto(config.c_baseroom, 0, 0, NULL, NULL);
1506 * forget (Zap) the current room
1511 if (CtdlAccessCheck(ac_logged_in)) {
1515 if (CtdlForgetThisRoom() == 0) {
1516 cprintf("%d Ok\n", CIT_OK);
1519 cprintf("%d You may not forget this room.\n", ERROR + NOT_HERE);
1524 * Get Next Unregistered User
1528 struct cdbdata *cdbus;
1529 struct ctdluser usbuf;
1531 if (CtdlAccessCheck(ac_aide)) {
1535 if ((CitControl.MMflags & MM_VALID) == 0) {
1536 cprintf("%d There are no unvalidated users.\n", CIT_OK);
1540 /* There are unvalidated users. Traverse the user database,
1541 * and return the first user we find that needs validation.
1543 cdb_rewind(CDB_USERS);
1544 while (cdbus = cdb_next_item(CDB_USERS), cdbus != NULL) {
1545 memset(&usbuf, 0, sizeof(struct ctdluser));
1546 memcpy(&usbuf, cdbus->ptr,
1547 ((cdbus->len > sizeof(struct ctdluser)) ?
1548 sizeof(struct ctdluser) : cdbus->len));
1550 if ((usbuf.flags & US_NEEDVALID)
1551 && (usbuf.axlevel > 0)) {
1552 cprintf("%d %s\n", MORE_DATA, usbuf.fullname);
1553 cdb_close_cursor(CDB_USERS);
1558 /* If we get to this point, there are no more unvalidated users.
1559 * Therefore we clear the "users need validation" flag.
1562 begin_critical_section(S_CONTROL);
1564 CitControl.MMflags = CitControl.MMflags & (~MM_VALID);
1566 end_critical_section(S_CONTROL);
1567 cprintf("%d *** End of registration.\n", CIT_OK);
1576 void cmd_vali(char *v_args)
1580 struct ctdluser userbuf;
1582 extract_token(user, v_args, 0, '|', sizeof user);
1583 newax = extract_int(v_args, 1);
1585 if (CtdlAccessCheck(ac_aide)) {
1589 if (lgetuser(&userbuf, user) != 0) {
1590 cprintf("%d '%s' not found.\n", ERROR + NO_SUCH_USER, user);
1594 userbuf.axlevel = newax;
1595 userbuf.flags = (userbuf.flags & ~US_NEEDVALID);
1599 /* If the access level was set to zero, delete the user */
1601 if (purge_user(user) == 0) {
1602 cprintf("%d %s Deleted.\n", CIT_OK, userbuf.fullname);
1606 cprintf("%d User '%s' validated.\n", CIT_OK, userbuf.fullname);
1612 * Traverse the user file...
1614 void ForEachUser(void (*CallBack) (struct ctdluser * EachUser, void *out_data),
1617 struct ctdluser usbuf;
1618 struct cdbdata *cdbus;
1620 cdb_rewind(CDB_USERS);
1622 while (cdbus = cdb_next_item(CDB_USERS), cdbus != NULL) {
1623 memset(&usbuf, 0, sizeof(struct ctdluser));
1624 memcpy(&usbuf, cdbus->ptr,
1625 ((cdbus->len > sizeof(struct ctdluser)) ?
1626 sizeof(struct ctdluser) : cdbus->len));
1628 (*CallBack) (&usbuf, in_data);
1634 * List one user (this works with cmd_list)
1636 void ListThisUser(struct ctdluser *usbuf, void *data)
1640 searchstring = (char *)data;
1641 if (bmstrcasestr(usbuf->fullname, searchstring) == NULL) {
1645 if (usbuf->axlevel > 0) {
1646 if ((CC->user.axlevel >= 6)
1647 || ((usbuf->flags & US_UNLISTED) == 0)
1648 || ((CC->internal_pgm))) {
1649 cprintf("%s|%d|%ld|%ld|%ld|%ld||\n",
1653 (long)usbuf->lastcall,
1661 * List users (searchstring may be empty to list all users)
1663 void cmd_list(char *cmdbuf)
1665 char searchstring[256];
1666 extract_token(searchstring, cmdbuf, 0, '|', sizeof searchstring);
1667 striplt(searchstring);
1668 cprintf("%d \n", LISTING_FOLLOWS);
1669 ForEachUser(ListThisUser, (void *)searchstring );
1677 * assorted info we need to check at login
1685 if (CtdlAccessCheck(ac_logged_in)) {
1689 getuser(&CC->user, CC->curr_user); /* no lock is needed here */
1690 if ((REGISCALL != 0) && ((CC->user.flags & US_REGIS) == 0))
1693 if (CC->user.axlevel >= 6) {
1695 if (CitControl.MMflags & MM_VALID)
1699 /* check for mail */
1700 mail = InitialMailCheck();
1702 cprintf("%d %d|%d|%d|%s|\n", CIT_OK, mail, regis, vali, CC->cs_inet_email);
1707 * check to see if a user exists
1709 void cmd_qusr(char *who)
1711 struct ctdluser usbuf;
1713 if (getuser(&usbuf, who) == 0) {
1714 cprintf("%d %s\n", CIT_OK, usbuf.fullname);
1716 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
1722 * Administrative Get User Parameters
1724 void cmd_agup(char *cmdbuf)
1726 struct ctdluser usbuf;
1727 char requested_user[128];
1729 if (CtdlAccessCheck(ac_aide)) {
1733 extract_token(requested_user, cmdbuf, 0, '|', sizeof requested_user);
1734 if (getuser(&usbuf, requested_user) != 0) {
1735 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
1738 cprintf("%d %s|%s|%u|%ld|%ld|%d|%ld|%ld|%d\n",
1745 (int) usbuf.axlevel,
1747 (long)usbuf.lastcall,
1754 * Administrative Set User Parameters
1756 void cmd_asup(char *cmdbuf)
1758 struct ctdluser usbuf;
1759 char requested_user[128];
1765 if (CtdlAccessCheck(ac_aide))
1768 extract_token(requested_user, cmdbuf, 0, '|', sizeof requested_user);
1769 if (lgetuser(&usbuf, requested_user) != 0) {
1770 cprintf("%d No such user.\n", ERROR + NO_SUCH_USER);
1773 np = num_parms(cmdbuf);
1775 extract_token(usbuf.password, cmdbuf, 1, '|', sizeof usbuf.password);
1777 usbuf.flags = extract_int(cmdbuf, 2);
1779 usbuf.timescalled = extract_int(cmdbuf, 3);
1781 usbuf.posted = extract_int(cmdbuf, 4);
1783 newax = extract_int(cmdbuf, 5);
1784 if ((newax >= 0) && (newax <= 6)) {
1785 usbuf.axlevel = extract_int(cmdbuf, 5);
1789 usbuf.lastcall = extract_long(cmdbuf, 7);
1792 usbuf.USuserpurge = extract_int(cmdbuf, 8);
1795 if (usbuf.axlevel == 0) {
1796 if (purge_user(requested_user) == 0) {
1802 snprintf(notify, SIZ,
1803 "User \"%s\" has been deleted by %s.\n",
1804 usbuf.fullname, CC->user.fullname);
1805 aide_message(notify, "User Deletion Message");
1808 cprintf("%d Ok", CIT_OK);
1810 cprintf(" (%s deleted)", requested_user);
1817 * Check to see if the user who we just sent mail to is logged in. If yes,
1818 * bump the 'new mail' counter for their session. That enables them to
1819 * receive a new mail notification without having to hit the database.
1821 void BumpNewMailCounter(long which_user) {
1822 struct CitContext *ptr;
1824 begin_critical_section(S_SESSION_TABLE);
1826 for (ptr = ContextList; ptr != NULL; ptr = ptr->next) {
1827 if (ptr->user.usernum == which_user) {
1832 end_critical_section(S_SESSION_TABLE);
1837 * Count the number of new mail messages the user has
1841 int num_newmsgs = 0;
1843 num_newmsgs = CC->newmail;
1846 return (num_newmsgs);
1851 * Count the number of new mail messages the user has
1853 int InitialMailCheck()
1855 int num_newmsgs = 0;
1857 char mailboxname[ROOMNAMELEN];
1858 struct ctdlroom mailbox;
1860 struct cdbdata *cdbfr;
1861 long *msglist = NULL;
1864 MailboxName(mailboxname, sizeof mailboxname, &CC->user, MAILROOM);
1865 if (getroom(&mailbox, mailboxname) != 0)
1867 CtdlGetRelationship(&vbuf, &CC->user, &mailbox);
1869 cdbfr = cdb_fetch(CDB_MSGLISTS, &mailbox.QRnumber, sizeof(long));
1871 if (cdbfr != NULL) {
1872 msglist = malloc(cdbfr->len);
1873 memcpy(msglist, cdbfr->ptr, cdbfr->len);
1874 num_msgs = cdbfr->len / sizeof(long);
1878 for (a = 0; a < num_msgs; ++a) {
1879 if (msglist[a] > 0L) {
1880 if (msglist[a] > vbuf.v_lastseen) {
1885 if (msglist != NULL)
1888 return (num_newmsgs);
1894 * Set the preferred view for the current user/room combination
1896 void cmd_view(char *cmdbuf) {
1900 if (CtdlAccessCheck(ac_logged_in)) {
1904 requested_view = extract_int(cmdbuf, 0);
1906 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
1907 vbuf.v_view = requested_view;
1908 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
1910 cprintf("%d ok\n", CIT_OK);
1917 void cmd_renu(char *cmdbuf)
1920 char oldname[USERNAME_SIZE];
1921 char newname[USERNAME_SIZE];
1923 if (CtdlAccessCheck(ac_aide)) {
1927 extract_token(oldname, cmdbuf, 0, '|', sizeof oldname);
1928 extract_token(newname, cmdbuf, 1, '|', sizeof newname);
1930 retcode = rename_user(oldname, newname);
1933 cprintf("%d '%s' has been renamed to '%s'.\n", CIT_OK, oldname, newname);
1935 case RENAMEUSER_LOGGED_IN:
1936 cprintf("%d '%s' is currently logged in and cannot be renamed.\n",
1937 ERROR + ALREADY_LOGGED_IN , oldname);
1939 case RENAMEUSER_NOT_FOUND:
1940 cprintf("%d '%s' does not exist.\n", ERROR + NO_SUCH_USER, oldname);
1942 case RENAMEUSER_ALREADY_EXISTS:
1943 cprintf("%d A user named '%s' already exists.\n", ERROR + ALREADY_EXISTS, newname);
1947 cprintf("%d An unknown error occurred.\n", ERROR);