/*
* Server functions which perform operations on user objects.
*
- * Copyright (c) 1987-2017 by the citadel.org team
+ * Copyright (c) 1987-2020 by the citadel.org team
*
* This program is open source software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License, version 3.
int chkpwd_read_pipe[2];
+/*
+ * makeuserkey() - convert a username into the format used as a database key
+ * "key" must be a buffer of at least USERNAME_SIZE
+ * (Key format is the username with all non-alphanumeric characters removed, and converted to lower case.)
+ */
+void makeuserkey(char *key, const char *username) {
+ int i;
+ int keylen = 0;
+
+ if (IsEmptyStr(username)) {
+ key[0] = 0;
+ return;
+ }
+
+ int len = strlen(username);
+ for (i=0; ((i<=len) && (i<USERNAME_SIZE-1)); ++i) {
+ if (isalnum((username[i]))) {
+ key[keylen++] = tolower(username[i]);
+ }
+ }
+ key[keylen++] = 0;
+}
+
+
+/*
+ * Compare two usernames to see if they are the same user after being keyed for the database
+ * Usage is identical to strcmp()
+ */
+int CtdlUserCmp(char *s1, char *s2) {
+ char k1[USERNAME_SIZE];
+ char k2[USERNAME_SIZE];
+
+ makeuserkey(k1, s1);
+ makeuserkey(k2, s2);
+ return(strcmp(k1,k2));
+}
+
+
/*
* CtdlGetUser() retrieve named user into supplied buffer.
* returns 0 on success
{
char usernamekey[USERNAME_SIZE];
struct cdbdata *cdbus;
- long len = cutuserkey(name);
if (usbuf != NULL) {
memset(usbuf, 0, sizeof(struct ctdluser));
}
- makeuserkey(usernamekey, name, len);
+ makeuserkey(usernamekey, name);
cdbus = cdb_fetch(CDB_USERS, usernamekey, strlen(usernamekey));
if (cdbus == NULL) { /* user not found */
{
char usernamekey[USERNAME_SIZE];
- makeuserkey(usernamekey, usbuf->fullname, cutuserkey(usbuf->fullname));
+ makeuserkey(usernamekey, usbuf->fullname);
usbuf->version = REV_LEVEL;
cdb_store(CDB_USERS, usernamekey, strlen(usernamekey), usbuf, sizeof(struct ctdluser));
}
char newnamekey[USERNAME_SIZE];
/* Create the database keys... */
- makeuserkey(oldnamekey, oldname, cutuserkey(oldname));
- makeuserkey(newnamekey, newname, cutuserkey(newname));
+ makeuserkey(oldnamekey, oldname);
+ makeuserkey(newnamekey, newname);
/* Lock up and get going */
begin_critical_section(S_USERS);
if (CtdlGetUser(&usbuf, oldname) != 0) {
retcode = RENAMEUSER_NOT_FOUND;
}
-
else { /* Sanity checks succeeded. Now rename the user. */
- if (usbuf.usernum == 0)
- {
+ if (usbuf.usernum == 0) {
syslog(LOG_DEBUG, "user_ops: can not rename user \"Citadel\".");
retcode = RENAMEUSER_NOT_FOUND;
} else {
}
+/*
+ * Convert a username into the format used as a database key prior to version 928
+ * This only gets called by reindex_user_928()
+ */
+void makeuserkey_pre928(char *key, const char *username) {
+ int i;
+
+ int len = strlen(username);
+
+ if (len >= USERNAME_SIZE) {
+ syslog(LOG_INFO, "Username too long: %s", username);
+ len = USERNAME_SIZE - 1;
+ }
+ for (i=0; i<=len; ++i) {
+ key[i] = tolower(username[i]);
+ }
+}
+
+
+/*
+ * Read a user record using the pre-v928 index format, and write it back using the v928-and-higher index format.
+ * This ONLY gets called during an upgrade from version <928 to version >=928.
+ */
+void reindex_user_928(char *username, void *out_data) {
+
+ char oldkey[USERNAME_SIZE];
+ char newkey[USERNAME_SIZE];
+ struct cdbdata *cdbus;
+ struct ctdluser usbuf;
+
+ makeuserkey_pre928(oldkey, username);
+ makeuserkey(newkey, username);
+
+ syslog(LOG_DEBUG, "user_ops: reindex_user_928: %s <%s> --> <%s>", username, oldkey, newkey);
+
+ // Fetch the user record using the old index format
+ cdbus = cdb_fetch(CDB_USERS, oldkey, strlen(oldkey));
+ if (cdbus == NULL) {
+ syslog(LOG_INFO, "user_ops: <%s> not found, were they already reindexed?", username);
+ return;
+ }
+ memcpy(&usbuf, cdbus->ptr, ((cdbus->len > sizeof(struct ctdluser)) ? sizeof(struct ctdluser) : cdbus->len));
+ cdb_free(cdbus);
+
+ // delete the old record
+ cdb_delete(CDB_USERS, oldkey, strlen(oldkey));
+
+ // write the new record
+ cdb_store(CDB_USERS, newkey, strlen(newkey), &usbuf, sizeof(struct ctdluser));
+}
+
+
/*
* Index-generating function used by Ctdl[Get|Set]Relationship
*/
long RoomGen,
long UserID)
{
-
struct {
long iRoomID;
long iRoomGen;
/*
* Define a relationship between a user and a room
*/
-void CtdlSetRelationship(visit *newvisit,
- struct ctdluser *rel_user,
- struct ctdlroom *rel_room)
-{
+void CtdlSetRelationship(visit *newvisit, struct ctdluser *rel_user, struct ctdlroom *rel_room) {
/* We don't use these in Citadel because they're implicit by the
* index, but they must be present if the database is exported.
*/
/*
* Locate a relationship between a user and a room
*/
-void CtdlGetRelationship(visit *vbuf,
- struct ctdluser *rel_user,
- struct ctdlroom *rel_room)
-{
+void CtdlGetRelationship(visit *vbuf, struct ctdluser *rel_user, struct ctdlroom *rel_room) {
char IndexBuf[32];
int IndexLen;
struct cdbdata *cdbvisit;
/*
* Helper function for rebuild_usersbynumber()
*/
-void rebuild_ubn_for_user(struct ctdluser *usbuf, void *data) {
-
- struct ubnlist {
- struct ubnlist *next;
- char username[USERNAME_SIZE];
- long usernum;
- };
+void rebuild_ubn_for_user(char *username, void *data) {
+ struct ctdluser u;
- static struct ubnlist *u = NULL;
- struct ubnlist *ptr = NULL;
-
- /* Lazy programming here. Call this function as a ForEachUser backend
- * in order to queue up the room names, or call it with a null user
- * to make it do the processing.
- */
- if (usbuf != NULL) {
- ptr = (struct ubnlist *) malloc(sizeof (struct ubnlist));
- if (ptr == NULL) return;
-
- ptr->usernum = usbuf->usernum;
- safestrncpy(ptr->username, usbuf->fullname, sizeof ptr->username);
- ptr->next = u;
- u = ptr;
- return;
- }
-
- while (u != NULL) {
- syslog(LOG_DEBUG, "user_ops: rebuilding usersbynumber index %10ld : %s", u->usernum, u->username);
- cdb_store(CDB_USERSBYNUMBER, &u->usernum, sizeof(long), u->username, strlen(u->username)+1);
- ptr = u;
- u = u->next;
- free(ptr);
+ syslog(LOG_DEBUG, "user_ops: rebuilding usersbynumber index for %s", username);
+ if (CtdlGetUser(&u, username) == 0) {
+ cdb_store(CDB_USERSBYNUMBER, &(u.usernum), sizeof(long), u.fullname, strlen(u.fullname)+1);
}
}
void rebuild_usersbynumber(void) {
cdb_trunc(CDB_USERSBYNUMBER); /* delete the old indices */
ForEachUser(rebuild_ubn_for_user, NULL); /* enumerate the users */
- rebuild_ubn_for_user(NULL, NULL); /* and index them */
}
/*
* Back end for cmd_user() and its ilk
- *
- * NOTE: "authname" should only be used if we are attempting to use the "master user" feature
*/
-int CtdlLoginExistingUser(char *authname, const char *trythisname)
+int CtdlLoginExistingUser(const char *trythisname)
{
char username[SIZ];
int found_user;
- syslog(LOG_DEBUG, "user_ops: CtdlLoginExistingUser(%s, %s)", authname, trythisname);
+ syslog(LOG_DEBUG, "user_ops: CtdlLoginExistingUser(%s)", trythisname);
if ((CC->logged_in)) {
return login_already_logged_in;
return login_not_found;
}
- /* If a "master user" is defined, handle its authentication if specified */
- CC->is_master = 0;
- if ( (!IsEmptyStr(CtdlGetConfigStr("c_master_user"))) &&
- (!IsEmptyStr(CtdlGetConfigStr("c_master_pass"))) &&
- (authname != NULL) &&
- (!strcasecmp(authname, CtdlGetConfigStr("c_master_user"))) )
- {
- CC->is_master = 1;
- }
-
/* Continue attempting user validation... */
safestrncpy(username, trythisname, sizeof (username));
striplt(username);
return login_not_found;
}
- /* Locate the associated Citadel account.
- * If not found, make one attempt to create it.
- */
+ /* Locate the associated Citadel account. If not found, make one attempt to create it. */
found_user = getuserbyuid(&CC->user, pd.pw_uid);
if (found_user != 0) {
create_user(username, CREATE_USER_DO_NOT_BECOME_USER, pd.pw_uid);
else {
/* native auth mode */
- recptypes *valid = NULL;
+ struct recptypes *valid = NULL;
/* First, try to log in as if the supplied name is a display name */
found_user = CtdlGetUser(&CC->user, username);
*/
void do_login(void)
{
- struct CitContext *CCC = CC;
+ CC->logged_in = 1;
+ syslog(LOG_NOTICE, "user_ops: <%s> logged in", CC->curr_user);
- CCC->logged_in = 1;
- syslog(LOG_NOTICE, "user_ops: <%s> logged in", CCC->curr_user);
-
- CtdlGetUserLock(&CCC->user, CCC->curr_user);
- ++(CCC->user.timescalled);
- CCC->previous_login = CCC->user.lastcall;
- time(&CCC->user.lastcall);
+ CtdlGetUserLock(&CC->user, CC->curr_user);
+ ++(CC->user.timescalled);
+ CC->previous_login = CC->user.lastcall;
+ time(&CC->user.lastcall);
/* If this user's name is the name of the system administrator
* (as specified in setup), automatically assign access level 6.
*/
- if (!strcasecmp(CCC->user.fullname, CtdlGetConfigStr("c_sysadm"))) {
- CCC->user.axlevel = AxAideU;
+ if ( (!IsEmptyStr(CtdlGetConfigStr("c_sysadm"))) && (!strcasecmp(CC->user.fullname, CtdlGetConfigStr("c_sysadm"))) ) {
+ CC->user.axlevel = AxAideU;
}
- /* If we're authenticating off the host system, automatically give
- * root the highest level of access.
- */
+ /* If we're authenticating off the host system, automatically give root the highest level of access. */
if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
- if (CCC->user.uid == 0) {
- CCC->user.axlevel = AxAideU;
+ if (CC->user.uid == 0) {
+ CC->user.axlevel = AxAideU;
}
}
- CtdlPutUserLock(&CCC->user);
+ CtdlPutUserLock(&CC->user);
- /*
- * If we are using LDAP authentication, extract the user's email addresses from the directory.
- */
+ /* If we are using LDAP authentication, extract the user's email addresses from the directory. */
#ifdef HAVE_LDAP
if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
char new_emailaddrs[512];
if (CtdlGetConfigInt("c_ldap_sync_email_addrs") > 0) {
- if (extract_email_addresses_from_ldap(CCC->ldap_dn, new_emailaddrs) == 0) {
- CtdlSetEmailAddressesForUser(CCC->user.fullname, new_emailaddrs);
+ if (extract_email_addresses_from_ldap(CC->ldap_dn, new_emailaddrs) == 0) {
+ CtdlSetEmailAddressesForUser(CC->user.fullname, new_emailaddrs);
}
}
}
#endif
- /*
- * No email address for user? Make one up. (commented out because it appears to break things)
- if (IsEmptyStr(CCC->user.emailaddrs)) {
- sprintf(CCC->user.emailaddrs, "cit%ld@%s", CCC->user.usernum, CtdlGetConfigStr("c_fqdn"));
+ /* If the user does not have any email addresses assigned, generate one. */
+ if (IsEmptyStr(CC->user.emailaddrs)) {
+ AutoGenerateEmailAddressForUser(&CC->user);
}
- */
-
+
+ /* Populate the user principal identity, which is consistent and never aliased */
+ strcpy(CC->cs_principal_id, "");
+ makeuserkey(CC->cs_principal_id, CC->user.fullname);
+ strcat(CC->cs_principal_id, "@");
+ strcat(CC->cs_principal_id, CtdlGetConfigStr("c_fqdn"));
/*
* Populate cs_inet_email and cs_inet_other_emails with valid email addresses from the user record
*/
- strcpy(CCC->cs_inet_email, CCC->user.emailaddrs);
- char *firstsep = strstr(CCC->cs_inet_email, "|");
+ strcpy(CC->cs_inet_email, CC->user.emailaddrs);
+ char *firstsep = strstr(CC->cs_inet_email, "|");
if (firstsep) {
- strcpy(CCC->cs_inet_other_emails, firstsep+1);
+ strcpy(CC->cs_inet_other_emails, firstsep+1);
*firstsep = 0;
}
else {
- CCC->cs_inet_other_emails[0] = 0;
+ CC->cs_inet_other_emails[0] = 0;
}
/* Create any personal rooms required by the system.
* since it's possible to log in again without reconnecting, we cannot
* make that assumption.
*/
- strcpy(CCC->fake_username, "");
- strcpy(CCC->fake_hostname, "");
- strcpy(CCC->fake_roomname, "");
CCC->logged_in = 0;
- /* Check to see if the user was deleted whilst logged in and purge them if necessary */
+ /* Check to see if the user was deleted while logged in and purge them if necessary */
if ((CCC->user.axlevel == AxDeleted) && (CCC->user.usernum)) {
purge_user(CCC->user.fullname);
}
/* Clear out the user record in memory so we don't behave like a ghost */
memset(&CCC->user, 0, sizeof(struct ctdluser));
CCC->curr_user[0] = 0;
- CCC->is_master = 0;
CCC->cs_inet_email[0] = 0;
CCC->cs_inet_other_emails[0] = 0;
CCC->cs_inet_fn[0] = 0;
- CCC->fake_username[0] = 0;
- CCC->fake_hostname[0] = 0;
- CCC->fake_roomname[0] = 0;
/* Free any output buffers */
unbuffer_output();
return pass_wrong_password;
}
- if (CCC->is_master) {
- code = strcmp(password, CtdlGetConfigStr("c_master_pass"));
- }
-
else if (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_HOST) {
/* host auth mode */
struct ctdluser usbuf;
char usernamekey[USERNAME_SIZE];
- makeuserkey(usernamekey, pname, cutuserkey(pname));
+ makeuserkey(usernamekey, pname);
/* If the name is empty we can't find them in the DB any way so just return */
- if (IsEmptyStr(pname))
+ if (IsEmptyStr(pname)) {
return(ERROR + NO_SUCH_USER);
+ }
if (CtdlGetUser(&usbuf, pname) != 0) {
syslog(LOG_ERR, "user_ops: cannot purge user <%s> - not found", pname);
/*
- * Traverse the user file...
+ * Traverse the user file and perform a callback for each user record.
+ * (New improved version that runs in two phases so that callbacks can perform writes without having a r/o cursor open)
*/
-void ForEachUser(void (*CallBack) (struct ctdluser * EachUser, void *out_data),
- void *in_data)
+void ForEachUser(void (*CallBack) (char *, void *out_data), void *in_data)
{
- struct ctdluser usbuf;
struct cdbdata *cdbus;
+ struct ctdluser *usptr;
+
+ struct feu {
+ struct feu *next;
+ char username[USERNAME_SIZE];
+ };
+ struct feu *ufirst = NULL;
+ struct feu *ulast = NULL;
+ struct feu *f = NULL;
cdb_rewind(CDB_USERS);
+ // Phase 1 : build a linked list of all our user account names
while (cdbus = cdb_next_item(CDB_USERS), cdbus != NULL) {
- memset(&usbuf, 0, sizeof(struct ctdluser));
- memcpy(&usbuf, cdbus->ptr,
- ((cdbus->len > sizeof(struct ctdluser)) ?
- sizeof(struct ctdluser) : cdbus->len));
- cdb_free(cdbus);
- (*CallBack) (&usbuf, in_data);
- }
-}
-
+ usptr = (struct ctdluser *) cdbus->ptr;
-/*
- * List one user (this works with cmd_list)
- */
-void ListThisUser(struct ctdluser *usbuf, void *data)
-{
- char *searchstring;
+ if (strlen(usptr->fullname) > 0) {
+ f = malloc(sizeof(struct feu));
+ f->next = NULL;
+ strncpy(f->username, usptr->fullname, USERNAME_SIZE);
- searchstring = (char *)data;
- if (bmstrcasestr(usbuf->fullname, searchstring) == NULL) {
- return;
+ if (ufirst == NULL) {
+ ufirst = f;
+ ulast = f;
+ }
+ else {
+ ulast->next = f;
+ ulast = f;
+ }
+ }
}
- if (usbuf->axlevel > AxDeleted) {
- if ((CC->user.axlevel >= AxAideU)
- || ((usbuf->flags & US_UNLISTED) == 0)
- || ((CC->internal_pgm))) {
- cprintf("%s|%d|%ld|%ld|%ld|%ld||\n",
- usbuf->fullname,
- usbuf->axlevel,
- usbuf->usernum,
- (long)usbuf->lastcall,
- usbuf->timescalled,
- usbuf->posted);
- }
+ // Phase 2 : perform the callback for each user while de-allocating the list
+ while (ufirst != NULL) {
+ (*CallBack) (ufirst->username, in_data);
+ f = ufirst;
+ ufirst = ufirst->next;
+ free(f);
}
}
projects / citadel.git / blobdiff