1 // Server functions which perform operations on user objects.
3 // Copyright (c) 1987-2023 by the citadel.org team
5 // This program is open source software; you can redistribute it and/or
6 // modify it under the terms of the GNU General Public License, version 3.
13 #include <libcitadel.h>
16 #include "citserver.h"
18 #include "citadel_ldap.h"
19 #include "ctdl_module.h"
22 #include "makeuserkey.h"
23 #include "internet_addressing.h"
25 // These pipes are used to talk to the chkpwd daemon, which is forked during startup
26 int chkpwd_write_pipe[2];
27 int chkpwd_read_pipe[2];
30 // Compare two usernames to see if they are the same user after being keyed for the database
31 // Usage is identical to strcmp()
32 int CtdlUserCmp(char *s1, char *s2) {
33 char k1[USERNAME_SIZE];
34 char k2[USERNAME_SIZE];
38 return(strcmp(k1,k2));
42 // CtdlGetUser() retrieve named user into supplied buffer.
43 // returns 0 on success
44 int CtdlGetUser(struct ctdluser *usbuf, char *name) {
45 char usernamekey[USERNAME_SIZE];
49 memset(usbuf, 0, sizeof(struct ctdluser));
52 makeuserkey(usernamekey, name);
53 if (IsEmptyStr(usernamekey)) {
54 return(1); // empty user name
56 cdbus = cdb_fetch(CDB_USERS, usernamekey, strlen(usernamekey));
58 if (cdbus.ptr == NULL) { // user not found
62 memcpy(usbuf, cdbus.ptr, ((cdbus.len > sizeof(struct ctdluser)) ? sizeof(struct ctdluser) : cdbus.len));
68 int CtdlLockGetCurrentUser(void) {
69 return CtdlGetUser(&CC->user, CC->curr_user);
73 // CtdlGetUserLock() - same as getuser() but locks the record
74 int CtdlGetUserLock(struct ctdluser *usbuf, char *name) {
77 retcode = CtdlGetUser(usbuf, name);
79 begin_critical_section(S_USERS);
85 // CtdlPutUser() - write user buffer into the correct place on disk
86 void CtdlPutUser(struct ctdluser *usbuf) {
87 char usernamekey[USERNAME_SIZE];
88 makeuserkey(usernamekey, usbuf->fullname);
89 usbuf->version = REV_LEVEL;
90 cdb_store(CDB_USERS, usernamekey, strlen(usernamekey), usbuf, sizeof(struct ctdluser));
94 void CtdlPutCurrentUserLock() {
95 CtdlPutUser(&CC->user);
99 // CtdlPutUserLock() - same as putuser() but locks the record
100 void CtdlPutUserLock(struct ctdluser *usbuf) {
102 end_critical_section(S_USERS);
106 // rename_user() - this is tricky because the user's display name is the database key
107 // Returns 0 on success or nonzero if there was an error...
108 int rename_user(char *oldname, char *newname) {
109 int retcode = RENAMEUSER_OK;
110 struct ctdluser usbuf;
112 char oldnamekey[USERNAME_SIZE];
113 char newnamekey[USERNAME_SIZE];
115 // Create the database keys...
116 makeuserkey(oldnamekey, oldname);
117 makeuserkey(newnamekey, newname);
119 // Lock up and get going
120 begin_critical_section(S_USERS);
122 // We cannot rename a user who is currently logged in
123 if (CtdlIsUserLoggedIn(oldname)) {
124 end_critical_section(S_USERS);
125 return RENAMEUSER_LOGGED_IN;
128 if (CtdlGetUser(&usbuf, newname) == 0) {
129 retcode = RENAMEUSER_ALREADY_EXISTS;
133 if (CtdlGetUser(&usbuf, oldname) != 0) {
134 retcode = RENAMEUSER_NOT_FOUND;
136 else { // Sanity checks succeeded. Now rename the user.
137 if (usbuf.usernum == 0) {
138 syslog(LOG_DEBUG, "user_ops: can not rename user \"Citadel\".");
139 retcode = RENAMEUSER_NOT_FOUND;
142 syslog(LOG_DEBUG, "user_ops: renaming <%s> to <%s>", oldname, newname);
143 cdb_delete(CDB_USERS, oldnamekey, strlen(oldnamekey));
144 safestrncpy(usbuf.fullname, newname, sizeof usbuf.fullname);
146 cdb_store(CDB_USERSBYNUMBER, &usbuf.usernum, sizeof(long), usbuf.fullname, strlen(usbuf.fullname)+1 );
147 retcode = RENAMEUSER_OK;
153 end_critical_section(S_USERS);
158 // Convert a username into the format used as a database key prior to version 928
159 // This only gets called by reindex_user_928()
160 void makeuserkey_pre928(char *key, const char *username) {
163 int len = strlen(username);
165 if (len >= USERNAME_SIZE) {
166 syslog(LOG_INFO, "Username too long: %s", username);
167 len = USERNAME_SIZE - 1;
169 for (i=0; i<=len; ++i) {
170 key[i] = tolower(username[i]);
175 // Read a user record using the pre-v928 index format, and write it back using the v928-and-higher index format.
176 // This ONLY gets called during an upgrade from version <928 to version >=928.
177 void reindex_user_928(char *username, void *out_data) {
179 char oldkey[USERNAME_SIZE];
180 char newkey[USERNAME_SIZE];
181 struct cdbdata cdbus;
182 struct ctdluser usbuf;
184 makeuserkey_pre928(oldkey, username);
185 makeuserkey(newkey, username);
187 syslog(LOG_DEBUG, "user_ops: reindex_user_928: %s <%s> --> <%s>", username, oldkey, newkey);
189 // Fetch the user record using the old index format
190 cdbus = cdb_fetch(CDB_USERS, oldkey, strlen(oldkey));
191 if (cdbus.ptr == NULL) {
192 syslog(LOG_INFO, "user_ops: <%s> not found, were they already reindexed?", username);
195 memcpy(&usbuf, cdbus.ptr, ((cdbus.len > sizeof(struct ctdluser)) ? sizeof(struct ctdluser) : cdbus.len));
197 // delete the old record
198 cdb_delete(CDB_USERS, oldkey, strlen(oldkey));
200 // write the new record
201 cdb_store(CDB_USERS, newkey, strlen(newkey), &usbuf, sizeof(struct ctdluser));
205 // Index-generating function used by Ctdl[Get|Set]Relationship
206 int GenerateRelationshipIndex(char *IndexBuf, long RoomID, long RoomGen, long UserID) {
207 struct visit_index TheIndex;
208 TheIndex.iRoomID = RoomID;
209 TheIndex.iRoomGen = RoomGen;
210 TheIndex.iUserID = UserID;
212 memcpy(IndexBuf, &TheIndex, sizeof(TheIndex));
213 return(sizeof(TheIndex));
216 // Back end for CtdlSetRelationship()
217 void put_visit(struct visit *newvisit) {
218 cdb_store(CDB_VISIT, newvisit, (sizeof(long)*3), newvisit, sizeof(struct visit));
222 // Define a relationship between a user and a room
223 void CtdlSetRelationship(struct visit *newvisit, struct ctdluser *rel_user, struct ctdlroom *rel_room) {
224 // We don't use these in Citadel because they're implicit by the
225 // index, but they must be present if the database is exported.
226 newvisit->v_roomnum = rel_room->QRnumber;
227 newvisit->v_roomgen = rel_room->QRgen;
228 newvisit->v_usernum = rel_user->usernum;
235 // Locate a relationship between a user and a room
236 void CtdlGetRelationship(struct visit *vbuf, struct ctdluser *rel_user, struct ctdlroom *rel_room) {
237 struct cdbdata cdbvisit;
239 // Clear out the buffer
240 memset(vbuf, 0, sizeof(struct visit));
242 // Fill out the first three fields; they are also the index
243 vbuf->v_roomnum = rel_room->QRnumber;
244 vbuf->v_roomgen = rel_room->QRgen;
245 vbuf->v_usernum = rel_user->usernum;
247 cdbvisit = cdb_fetch(CDB_VISIT, vbuf, (sizeof(long)*3));
248 if (cdbvisit.ptr != NULL) {
249 memcpy(vbuf, cdbvisit.ptr, ((cdbvisit.len > sizeof(struct visit)) ? sizeof(struct visit) : cdbvisit.len));
252 // If this is the first time the user has seen this room, set the view to be the default for the room.
253 vbuf->v_view = rel_room->QRdefaultview;
256 // Set v_seen if necessary
257 if (vbuf->v_seen[0] == 0) {
258 snprintf(vbuf->v_seen, sizeof vbuf->v_seen, "*:%ld", vbuf->v_lastseen);
263 void CtdlMailboxName(char *buf, size_t n, const struct ctdluser *who, const char *prefix) {
264 snprintf(buf, n, "%010ld.%s", who->usernum, prefix);
268 // Check to see if the specified user has Internet mail permission
269 // (returns nonzero if permission is granted)
270 int CtdlCheckInternetMailPermission(struct ctdluser *who) {
272 // Do not allow twits to send Internet mail
273 if (who->axlevel <= AxProbU) return(0);
276 if (CtdlGetConfigInt("c_restrict") == 0) return(1);
279 if (who->flags & US_INTERNET) return(2);
281 // Admin level access?
282 if (who->axlevel >= AxAideU) return(3);
289 // This is a convenience function which follows the Citadel protocol semantics for most commands.
290 // If the current user does not have the requested access level, it outputs a protocol-friendly error message
291 // and then returns (-1). This allows calling functions to complete an access level check in one line of code.
292 int CtdlAccessCheck(int required_level) {
293 if (CC->internal_pgm) return(0);
294 if (required_level >= ac_internal) {
295 cprintf("%d This is not a user-level command.\n", ERROR + HIGHER_ACCESS_REQUIRED);
299 if ((required_level >= ac_logged_in_or_guest) && (CC->logged_in == 0) && (CtdlGetConfigInt("c_guest_logins") == 0)) {
300 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
304 if ((required_level >= ac_logged_in) && (CC->logged_in == 0)) {
305 cprintf("%d Not logged in.\n", ERROR + NOT_LOGGED_IN);
309 if (CC->user.axlevel >= AxAideU) return(0);
310 if (required_level >= ac_aide) {
311 cprintf("%d This command requires Admin access.\n",
312 ERROR + HIGHER_ACCESS_REQUIRED);
316 if (is_room_aide()) return(0);
317 if (required_level >= ac_room_aide) {
318 cprintf("%d This command requires Admin or Room Admin access.\n",
319 ERROR + HIGHER_ACCESS_REQUIRED);
323 // Do not generate any output if we succeeded -- the calling function will handle that.
328 // Is the user currently logged in an Admin?
330 if (CC->user.axlevel >= AxAideU) {
339 // Is the user currently logged in an Admin *or* the room Admin for this room?
340 int is_room_aide(void) {
341 if (!CC->logged_in) {
345 if ((CC->user.axlevel >= AxAideU) || (CC->room.QRroomaide == CC->user.usernum)) {
354 // CtdlGetUserByNumber() - get user by number, returns 0 if user was found
355 // Note: fetching a user this way requires one additional database operation.
356 int CtdlGetUserByNumber(struct ctdluser *usbuf, long number) {
357 struct cdbdata cdbun;
360 cdbun = cdb_fetch(CDB_USERSBYNUMBER, &number, sizeof(long));
361 if (cdbun.ptr == NULL) {
362 syslog(LOG_INFO, "user_ops: %ld not found", number);
366 syslog(LOG_INFO, "user_ops: %ld maps to %s", number, cdbun.ptr);
367 r = CtdlGetUser(usbuf, cdbun.ptr);
372 // Helper function for rebuild_usersbynumber()
373 void rebuild_ubn_for_user(char *username, void *data) {
376 syslog(LOG_DEBUG, "user_ops: rebuilding usersbynumber index for %s", username);
377 if (CtdlGetUser(&u, username) == 0) {
378 cdb_store(CDB_USERSBYNUMBER, &(u.usernum), sizeof(long), u.fullname, strlen(u.fullname)+1);
383 // Rebuild the users-by-number index
384 void rebuild_usersbynumber(void) {
385 cdb_trunc(CDB_USERSBYNUMBER); // delete the old indices
386 ForEachUser(rebuild_ubn_for_user, NULL); // enumerate the users
390 // getuserbyuid() Get user by system uid (for PAM mode authentication)
391 // Returns 0 if user was found
392 int getuserbyuid(struct ctdluser *usbuf, uid_t number) {
394 struct cdbkeyval cdbus;
395 struct ctdluser *usptr;
396 int return_value = (-1);
398 // Yes, we do this the long way. Someday we might want to try an index.
399 // No, we don't use CtdlForEachUser() because that requires multiple reads for each record
400 cdb_rewind(CDB_USERS);
401 while (cdbus = cdb_next_item(CDB_USERS), cdbus.val.ptr!=NULL) { // always read through to the end
402 usptr = (struct ctdluser *) cdbus.val.ptr;
404 if (usptr->uid == number) {
405 syslog(LOG_DEBUG, "user_ops: found uid=%d username=%s", usptr->uid, usptr->fullname);
406 memcpy(usbuf, usptr, sizeof(struct ctdluser));
407 return_value = 0; // success
411 if (return_value != 0) {
412 syslog(LOG_DEBUG, "user_ops: no user found with uid=%d", number);
414 return(return_value);
418 // Back end for cmd_user() and its ilk
419 int CtdlLoginExistingUser(const char *trythisname) {
423 syslog(LOG_DEBUG, "user_ops: CtdlLoginExistingUser(%s)", trythisname);
425 if ((CC->logged_in)) {
426 return login_already_logged_in;
429 if (trythisname == NULL) return login_not_found;
431 // We handle this a different way now (see below)
432 //if (!strncasecmp(trythisname, "SYS_", 4)) {
433 //syslog(LOG_DEBUG, "user_ops: system user \"%s\" is not allowed to log in.", trythisname);
434 //return login_not_found;
437 // Continue attempting user validation...
438 safestrncpy(username, trythisname, sizeof (username));
439 string_trim(username);
441 if (IsEmptyStr(username)) {
442 return login_not_found;
446 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
448 struct passwd *tempPwdPtr;
451 syslog(LOG_DEBUG, "user_ops: asking host about <%s>", username);
452 #ifdef HAVE_GETPWNAM_R
453 syslog(LOG_DEBUG, "user_ops: calling getpwnam_r()");
454 getpwnam_r(username, &pd, pwdbuffer, sizeof pwdbuffer, &tempPwdPtr);
455 #else // HAVE_GETPWNAM_R
456 syslog(LOG_DEBUG, "user_ops: SHOULD NEVER GET HERE!!!");
458 #endif // HAVE_GETPWNAM_R
459 if (tempPwdPtr == NULL) {
460 syslog(LOG_DEBUG, "user_ops: no such user <%s>", username);
461 return login_not_found;
464 // Locate the associated Citadel account. If not found, make one attempt to create it.
465 found_user = getuserbyuid(&CC->user, pd.pw_uid);
466 if (found_user != 0) {
467 create_user(username, CREATE_USER_DO_NOT_BECOME_USER, pd.pw_uid);
468 found_user = getuserbyuid(&CC->user, pd.pw_uid);
470 syslog(LOG_DEBUG, "user_ops: found it: uid=%ld, gecos=%s here: %d", (long)pd.pw_uid, pd.pw_gecos, found_user);
475 else if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
481 found_user = CtdlTryUserLDAP(username, ldap_dn, sizeof ldap_dn, ldap_cn, sizeof ldap_cn, &ldap_uid);
482 if (found_user != 0) {
483 return login_not_found;
486 found_user = getuserbyuid(&CC->user, ldap_uid);
487 if (found_user != 0) {
488 create_user(ldap_cn, CREATE_USER_DO_NOT_BECOME_USER, ldap_uid);
489 found_user = getuserbyuid(&CC->user, ldap_uid);
492 if (found_user == 0) {
493 if (CC->ldap_dn != NULL) free(CC->ldap_dn);
494 CC->ldap_dn = strdup(ldap_dn);
499 // native auth mode...
501 struct recptypes *valid = NULL;
503 // First, try to log in as if the supplied name is a display name
504 found_user = CtdlGetUser(&CC->user, username);
506 // If that didn't work, try to log in as if the supplied name * is an e-mail address
507 if (found_user != 0) {
508 valid = validate_recipients(username, 0);
510 if (valid->num_local == 1) {
511 found_user = CtdlGetUser(&CC->user, valid->recp_local);
513 free_recipients(valid);
518 // User 0 is a system account and must not be used by a real user
519 if (CC->user.usernum <= 0) {
520 syslog(LOG_DEBUG, "user_ops: system account <%s> is not allowed to log in.", trythisname);
521 return login_not_found;
524 // Did we find something?
525 if (found_user == 0) {
526 if (((CC->nologin)) && (CC->user.axlevel < AxAideU)) {
527 return login_too_many_users;
530 safestrncpy(CC->curr_user, CC->user.fullname, sizeof CC->curr_user);
534 return login_not_found;
538 // session startup code which is common to both cmd_pass() and cmd_newu()
539 void do_login(void) {
541 syslog(LOG_NOTICE, "user_ops: <%s> logged in", CC->curr_user);
543 CtdlGetUserLock(&CC->user, CC->curr_user);
544 CC->previous_login = CC->user.lastcall;
545 time(&CC->user.lastcall);
547 // If this user's name is the name of the system administrator
548 // (as specified in setup), automatically assign access level 6.
549 if ( (!IsEmptyStr(CtdlGetConfigStr("c_sysadm"))) && (!strcasecmp(CC->user.fullname, CtdlGetConfigStr("c_sysadm"))) ) {
550 CC->user.axlevel = AxAideU;
553 // If we're authenticating off the host system, automatically give root the highest level of access.
554 if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
555 if (CC->user.uid == 0) {
556 CC->user.axlevel = AxAideU;
559 CtdlPutUserLock(&CC->user);
561 // If we are using LDAP authentication, extract the user's email addresses from the directory.
562 if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
563 char new_emailaddrs[512];
564 if (CtdlGetConfigInt("c_ldap_sync_email_addrs") > 0) {
565 if (extract_email_addresses_from_ldap(CC->ldap_dn, new_emailaddrs) == 0) {
566 CtdlSetEmailAddressesForUser(CC->user.fullname, new_emailaddrs);
571 // If the user does not have any email addresses assigned, generate one.
572 if (IsEmptyStr(CC->user.emailaddrs)) {
573 AutoGenerateEmailAddressForUser(&CC->user);
576 // Populate the user principal identity, which is consistent and never aliased
577 strcpy(CC->cs_principal_id, "");
578 makeuserkey(CC->cs_principal_id, CC->user.fullname);
579 strcat(CC->cs_principal_id, "@");
580 strcat(CC->cs_principal_id, CtdlGetConfigStr("c_fqdn"));
582 // Populate cs_inet_email and cs_inet_other_emails with valid email addresses from the user record
583 strcpy(CC->cs_inet_email, CC->user.emailaddrs);
584 char *firstsep = strstr(CC->cs_inet_email, "|");
586 strcpy(CC->cs_inet_other_emails, firstsep+1);
590 CC->cs_inet_other_emails[0] = 0;
593 // Create any personal rooms required by the system.
594 // (Technically, MAILROOM should be there already, but just in case...)
595 CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
596 CtdlCreateRoom(SENTITEMS, 4, "", 0, 1, 0, VIEW_MAILBOX);
597 CtdlCreateRoom(USERTRASHROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
598 CtdlCreateRoom(USERDRAFTROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
600 // Run any startup routines registered by loadable modules
601 PerformSessionHooks(EVT_LOGIN);
604 CtdlUserGoto(CtdlGetConfigStr("c_baseroom"), 0, 0, NULL, NULL, NULL, NULL);
608 void logged_in_response(void) {
609 cprintf("%d %s|%d|0|0|%u|%ld|%ld\n",
610 CIT_OK, CC->user.fullname, CC->user.axlevel,
611 CC->user.flags, CC->user.usernum,
617 void CtdlUserLogout(void) {
619 syslog(LOG_DEBUG, "user_ops: CtdlUserLogout() logging out <%s> from session %d", CC->curr_user, CC->cs_pid);
621 // Run any hooks registered by modules...
622 PerformSessionHooks(EVT_LOGOUT);
624 // Clear out some session data. Most likely, the CitContext for this
625 // session is about to get nuked when the session disconnects, but
626 // since it's possible to log in again without reconnecting, we cannot
627 // make that assumption.
630 // Check to see if the user was deleted while logged in and purge them if necessary
631 if ((CC->user.axlevel == AxDeleted) && (CC->user.usernum)) {
632 purge_user(CC->user.fullname);
635 // Clear out the user record in memory so we don't behave like a ghost
636 memset(&CC->user, 0, sizeof(struct ctdluser));
637 CC->curr_user[0] = 0;
638 CC->cs_inet_email[0] = 0;
639 CC->cs_inet_other_emails[0] = 0;
640 CC->cs_inet_fn[0] = 0;
642 // Free any output buffers
647 // Validate a password on the host unix system by talking to the chkpwd daemon
648 static int validpw(uid_t uid, const char *pass) {
652 if (IsEmptyStr(pass)) {
653 syslog(LOG_DEBUG, "user_ops: refusing to chkpwd for uid=%d with empty password", uid);
657 syslog(LOG_DEBUG, "user_ops: validating password for uid=%d using chkpwd...", uid);
659 begin_critical_section(S_CHKPWD);
660 rv = write(chkpwd_write_pipe[1], &uid, sizeof(uid_t));
662 syslog(LOG_ERR, "user_ops: communication with chkpwd broken: %m");
663 end_critical_section(S_CHKPWD);
666 rv = write(chkpwd_write_pipe[1], pass, 256);
668 syslog(LOG_ERR, "user_ops: communication with chkpwd broken: %m");
669 end_critical_section(S_CHKPWD);
672 rv = read(chkpwd_read_pipe[0], buf, 4);
674 syslog(LOG_ERR, "user_ops: ommunication with chkpwd broken: %m");
675 end_critical_section(S_CHKPWD);
678 end_critical_section(S_CHKPWD);
680 if (!strncmp(buf, "PASS", 4)) {
681 syslog(LOG_DEBUG, "user_ops: chkpwd pass");
685 syslog(LOG_DEBUG, "user_ops: chkpwd fail");
690 // Start up the chkpwd daemon so validpw() has something to talk to
691 void start_chkpwd_daemon(void) {
693 struct stat filestats;
696 syslog(LOG_DEBUG, "user_ops: starting chkpwd daemon for host authentication mode");
698 if ((stat(file_chkpwd, &filestats)==-1) || (filestats.st_size==0)) {
699 syslog(LOG_ERR, "user_ops: %s: %m", file_chkpwd);
700 exit(CTDLEXIT_CHKPWD);
702 if (pipe(chkpwd_write_pipe) != 0) {
703 syslog(LOG_ERR, "user_ops: unable to create pipe for chkpwd daemon: %m");
704 exit(CTDLEXIT_CHKPWD);
706 if (pipe(chkpwd_read_pipe) != 0) {
707 syslog(LOG_ERR, "user_ops: unable to create pipe for chkpwd daemon: %m");
708 exit(CTDLEXIT_CHKPWD);
712 if (chkpwd_pid < 0) {
713 syslog(LOG_ERR, "user_ops: unable to fork chkpwd daemon: %m");
714 exit(CTDLEXIT_CHKPWD);
716 if (chkpwd_pid == 0) {
717 dup2(chkpwd_write_pipe[0], 0);
718 dup2(chkpwd_read_pipe[1], 1);
719 for (i=2; i<256; ++i) close(i);
720 execl(file_chkpwd, file_chkpwd, NULL);
721 syslog(LOG_ERR, "user_ops: unable to exec chkpwd daemon: %m");
727 int CtdlTryPassword(const char *password, long len) {
730 if ((CC->logged_in)) {
731 syslog(LOG_WARNING, "user_ops: CtdlTryPassword: already logged in");
732 return pass_already_logged_in;
734 if (!strcmp(CC->curr_user, NLI)) {
735 syslog(LOG_WARNING, "user_ops: CtdlTryPassword: no user selected");
738 if (CtdlGetUser(&CC->user, CC->curr_user)) {
739 syslog(LOG_ERR, "user_ops: CtdlTryPassword: internal error");
740 return pass_internal_error;
742 if (password == NULL) {
743 syslog(LOG_INFO, "user_ops: CtdlTryPassword: NULL password string supplied");
744 return pass_wrong_password;
748 else if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
749 if (validpw(CC->user.uid, password)) {
752 // sooper-seekrit hack: populate the password field in the
753 // citadel database with the password that the user typed,
754 // if it's correct. This allows most sites to convert from
755 // host auth to native auth if they want to. If you think
756 // this is a security hazard, comment it out.
758 CtdlGetUserLock(&CC->user, CC->curr_user);
759 safestrncpy(CC->user.password, password, sizeof CC->user.password);
760 CtdlPutUserLock(&CC->user);
762 // (sooper-seekrit hack ends here)
770 else if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
772 if ((CC->ldap_dn) && (!CtdlTryPasswordLDAP(CC->ldap_dn, password))) {
780 // native auth mode...
784 pw = (char*) malloc(len + 1);
785 memcpy(pw, password, len + 1);
787 strproc(CC->user.password);
788 code = strcasecmp(CC->user.password, pw);
791 strproc(CC->user.password);
792 code = strcasecmp(CC->user.password, pw);
802 syslog(LOG_WARNING, "user_ops: bad password specified for <%s> Service <%s> Port <%ld> Remote <%s / %s>",
809 return pass_wrong_password;
814 // Delete a user record *and* all of its related resources.
815 int purge_user(char pname[]) {
816 struct ctdluser usbuf;
817 char usernamekey[USERNAME_SIZE];
819 makeuserkey(usernamekey, pname);
821 // If the name is empty we can't find them in the DB any way so just return
822 if (IsEmptyStr(pname)) {
823 return(ERROR + NO_SUCH_USER);
826 if (CtdlGetUser(&usbuf, pname) != 0) {
827 syslog(LOG_ERR, "user_ops: cannot purge user <%s> - not found", pname);
828 return(ERROR + NO_SUCH_USER);
831 // Don't delete a user who is currently logged in. Instead, just
832 // set the access level to 0, and let the account get swept up
833 // during the next purge.
834 if (CtdlIsUserLoggedInByNum(usbuf.usernum)) {
835 syslog(LOG_WARNING, "user_ops: <%s> is logged in; not deleting", pname);
836 usbuf.axlevel = AxDeleted;
841 syslog(LOG_NOTICE, "user_ops: deleting <%s>", pname);
843 // Perform any purge functions registered by server extensions
844 PerformUserHooks(&usbuf, EVT_PURGEUSER);
846 // delete any existing user/room relationships
847 // Commenting out since it was assuming the user number was
848 // at the top of the index. Room number is actually first.
849 // Auto-Purge will clean up the records later, so not worth
850 // scanning all the records here.
851 //cdb_delete(CDB_VISIT, &usbuf.usernum, sizeof(long));
853 // delete the users-by-number index record
854 cdb_delete(CDB_USERSBYNUMBER, &usbuf.usernum, sizeof(long));
856 // delete the user entry
857 cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
863 // This is the back end processing that happens when we create a new user account.
864 int internal_create_user(char *username, struct ctdluser *usbuf, uid_t uid) {
865 if (!CtdlGetUser(usbuf, username)) {
866 return(ERROR + ALREADY_EXISTS);
869 // Go ahead and initialize a new user record
870 memset(usbuf, 0, sizeof(struct ctdluser));
871 safestrncpy(usbuf->fullname, username, sizeof usbuf->fullname);
872 strcpy(usbuf->password, "");
875 // These are the default flags on new accounts
876 usbuf->flags = US_LASTOLD | US_DISAPPEAR | US_PAGINATOR | US_FLOORS;
877 usbuf->axlevel = CtdlGetConfigInt("c_initax");
878 usbuf->lastcall = time(NULL);
880 // fetch a new user number
881 usbuf->usernum = get_new_user_number();
883 // add user to the database
885 cdb_store(CDB_USERSBYNUMBER, &usbuf->usernum, sizeof(long), usbuf->fullname, strlen(usbuf->fullname)+1);
887 // If non-native auth, index by uid
888 if ((usbuf->uid > 0) && (usbuf->uid != NATIVE_AUTH_UID)) {
889 StrBuf *claimed_id = NewStrBuf();
890 StrBufPrintf(claimed_id, "uid:%d", usbuf->uid);
891 FreeStrBuf(&claimed_id);
898 // create_user() - back end processing to create a new user
900 // Set 'newusername' to the desired account name.
901 // Set 'become_user' to CREATE_USER_BECOME_USER if this is self-service account creation and we want to
902 // actually log in as the user we just created, otherwise set it to CREATE_USER_DO_NOT_BECOME_USER
903 // Set 'uid' to some uid_t value to associate the account with an external auth user, or (-1) for native auth
904 int create_user(char *username, int become_user, uid_t uid) {
905 struct ctdluser usbuf;
906 struct ctdlroom qrbuf;
907 char mailboxname[ROOMNAMELEN];
912 if ((retval = internal_create_user(username, &usbuf, uid)) != 0) {
916 // Give the user a private mailbox and a configuration room.
917 // Make the latter an invisible system room.
918 CtdlMailboxName(mailboxname, sizeof mailboxname, &usbuf, MAILROOM);
919 CtdlCreateRoom(mailboxname, 5, "", 0, 1, 1, VIEW_MAILBOX);
921 CtdlMailboxName(mailboxname, sizeof mailboxname, &usbuf, USERCONFIGROOM);
922 CtdlCreateRoom(mailboxname, 5, "", 0, 1, 1, VIEW_BBS);
923 if (CtdlGetRoomLock(&qrbuf, mailboxname) == 0) {
924 qrbuf.QRflags2 |= QR2_SYSTEM;
925 CtdlPutRoomLock(&qrbuf);
928 // Perform any create functions registered by server extensions
929 PerformUserHooks(&usbuf, EVT_NEWUSER);
931 // Everything below this line can be bypassed if administratively
932 // creating a user, instead of doing self-service account creation
934 if (become_user == CREATE_USER_BECOME_USER) {
935 // Now become the user we just created
936 memcpy(&CC->user, &usbuf, sizeof(struct ctdluser));
937 safestrncpy(CC->curr_user, username, sizeof CC->curr_user);
940 // Check to make sure we're still who we think we are
941 if (CtdlGetUser(&CC->user, CC->curr_user)) {
942 return(ERROR + INTERNAL_ERROR);
947 "New user account <%s> has been created, from host %s [%s].\n",
952 CtdlAideMessage(buf, "User Creation Notice");
953 syslog(LOG_NOTICE, "user_ops: <%s> created", username);
958 // set password - back end api code
959 void CtdlSetPassword(char *new_pw) {
960 CtdlGetUserLock(&CC->user, CC->curr_user);
961 safestrncpy(CC->user.password, new_pw, sizeof(CC->user.password));
962 CtdlPutUserLock(&CC->user);
963 syslog(LOG_INFO, "user_ops: password changed for <%s>", CC->curr_user);
964 PerformSessionHooks(EVT_SETPASS);
968 // API function for cmd_invt_kick() and anything else that needs to
969 // invite or kick out a user to/from a room.
971 // Set iuser to the name of the user, and op to 1=invite or 0=kick
972 int CtdlInvtKick(char *iuser, int op) {
973 struct ctdluser USscratch;
977 if (CtdlGetUser(&USscratch, iuser) != 0) {
981 CtdlGetRelationship(&vbuf, &USscratch, &CC->room);
983 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
984 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
987 vbuf.v_flags = vbuf.v_flags & ~V_ACCESS;
988 vbuf.v_flags = vbuf.v_flags | V_FORGET | V_LOCKOUT;
990 CtdlSetRelationship(&vbuf, &USscratch, &CC->room);
992 // post a message in Aide> saying what we just did
993 snprintf(bbb, sizeof bbb, "%s has been %s \"%s\" by %s.\n",
995 ((op == 1) ? "invited to" : "kicked out of"),
997 (CC->logged_in ? CC->user.fullname : "an administrator")
999 CtdlAideMessage(bbb,"User Admin Message");
1004 // Forget (Zap) the current room (API call)
1005 // Returns 0 on success
1006 int CtdlForgetThisRoom(void) {
1009 // On some systems, Admins are not allowed to forget rooms
1010 if (is_aide() && (CtdlGetConfigInt("c_aide_zap") == 0)
1011 && ((CC->room.QRflags & QR_MAILBOX) == 0) ) {
1015 CtdlGetUserLock(&CC->user, CC->curr_user);
1016 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
1018 vbuf.v_flags = vbuf.v_flags | V_FORGET;
1019 vbuf.v_flags = vbuf.v_flags & ~V_ACCESS;
1021 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
1022 CtdlPutUserLock(&CC->user);
1024 // Return to the Lobby, so we don't end up in an undefined room
1025 CtdlUserGoto(CtdlGetConfigStr("c_baseroom"), 0, 0, NULL, NULL, NULL, NULL);
1030 // Traverse the user file and perform a callback for each user record.
1031 // (New improved version that runs in two phases so that callbacks can perform writes without having a r/o cursor open)
1032 void ForEachUser(void (*CallBack) (char *, void *out_data), void *in_data) {
1033 struct cdbkeyval cdbus;
1034 struct ctdluser *usptr;
1036 Array *all_users = array_new(USERNAME_SIZE);
1037 if (all_users == NULL) {
1038 syslog(LOG_ERR, "user_ops: alloc failed, ForEachUser() exiting");
1043 // Phase 1 : build an array of all our user account names
1044 cdb_rewind(CDB_USERS);
1045 while (cdbus = cdb_next_item(CDB_USERS), cdbus.val.ptr!=NULL) { // always read through to the end
1046 usptr = (struct ctdluser *) cdbus.val.ptr;
1047 if (strlen(usptr->fullname) > 0) {
1048 array_append(all_users, usptr->fullname);
1052 // Phase 2 : perform the callback for each user while de-allocating the list
1053 for (int i=0; i<array_len(all_users); ++i) {
1054 (*CallBack) (array_get_element_at(all_users, i), in_data);
1057 // Phase 3 : free the array
1058 array_free(all_users);
1062 // Return the number of new messages that have arrived in the user's inbox while they were logged in.
1063 // Resets to zero when called.
1064 int NewMailCount() {
1065 int num_newmsgs = 0;
1066 num_newmsgs = CC->newmail;
1068 return(num_newmsgs);
1072 // Count the number of new mail messages the user has
1073 int InitialMailCheck() {
1074 int num_newmsgs = 0;
1076 char mailboxname[ROOMNAMELEN];
1077 struct ctdlroom mailbox;
1079 long *msglist = NULL;
1082 CtdlMailboxName(mailboxname, sizeof mailboxname, &CC->user, MAILROOM);
1083 if (CtdlGetRoom(&mailbox, mailboxname) != 0) {
1086 CtdlGetRelationship(&vbuf, &CC->user, &mailbox);
1088 num_msgs = CtdlFetchMsgList(mailbox.QRnumber, &msglist);
1090 for (a = 0; a < num_msgs; ++a) {
1091 if (msglist[a] > 0L) {
1092 if (msglist[a] > vbuf.v_lastseen) {
1099 return(num_newmsgs);
1103 // This is an undocumented rescue mode that can be used to rewrite an admin user account that has been corrupted.
1104 // To prevent abuse, it can only run as a one-shot when the server is not otherwise operational.
1105 // Don't use this without asking about it.
1106 void undocumented_rescue_mode(char *rescue_string) {
1107 struct ctdluser usbuf;
1108 memset(&usbuf, 0, sizeof(struct ctdluser));
1109 extract_token(usbuf.fullname, rescue_string, 0, '|', sizeof usbuf.password);
1110 extract_token(usbuf.password, rescue_string, 1, '|', sizeof usbuf.password);
1111 usbuf.usernum = extract_long(rescue_string, 2);
1113 usbuf.lastcall = time(NULL);
1114 CtdlPutUser(&usbuf);