-/*
- * Server functions which perform operations on user objects.
- *
- * Copyright (c) 1987-2019 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.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- */
+// Server functions which perform operations on user objects.
+//
+// Copyright (c) 1987-2021 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.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
#include <stdlib.h>
#include <unistd.h>
int chkpwd_write_pipe[2];
int chkpwd_read_pipe[2];
+
/*
- * Trim a string down to the maximum username size and return the new length
+ * 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.)
*/
-long cutusername(char *username) {
- long len;
- len = strlen(username);
- if (len >= USERNAME_SIZE)
- {
- syslog(LOG_INFO, "Username too long: %s", username);
- len = USERNAME_SIZE - 1;
- username[len]='\0';
+void makeuserkey(char *key, const char *username) {
+ int i;
+ int keylen = 0;
+
+ if (IsEmptyStr(username)) {
+ key[0] = 0;
+ return;
}
- return len;
+
+ 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;
}
/*
- * makeuserkey() - convert a username into the format used as a database key
- * (it's just the username converted into lower case)
+ * Compare two usernames to see if they are the same user after being keyed for the database
+ * Usage is identical to strcmp()
*/
-void makeuserkey(char *key, const char *username, long len) {
- int i;
+int CtdlUserCmp(char *s1, char *s2) {
+ char k1[USERNAME_SIZE];
+ char k2[USERNAME_SIZE];
- 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]);
- }
+ makeuserkey(k1, s1);
+ makeuserkey(k2, s2);
+ return(strcmp(k1,k2));
}
{
char usernamekey[USERNAME_SIZE];
struct cdbdata *cdbus;
- long len = cutusername(name);
if (usbuf != NULL) {
memset(usbuf, 0, sizeof(struct ctdluser));
}
- makeuserkey(usernamekey, name, len);
+ makeuserkey(usernamekey, name);
+ if (IsEmptyStr(usernamekey)) {
+ return(1); // empty user name
+ }
cdbus = cdb_fetch(CDB_USERS, usernamekey, strlen(usernamekey));
- if (cdbus == NULL) { /* user not found */
+ if (cdbus == NULL) { // user not found
return(1);
}
if (usbuf != NULL) {
}
-int CtdlLockGetCurrentUser(void)
-{
+int CtdlLockGetCurrentUser(void) {
CitContext *CCC = CC;
return CtdlGetUser(&CCC->user, CCC->curr_user);
}
-/*
- * CtdlGetUserLock() - same as getuser() but locks the record
- */
-int CtdlGetUserLock(struct ctdluser *usbuf, char *name)
-{
+// CtdlGetUserLock() - same as getuser() but locks the record
+int CtdlGetUserLock(struct ctdluser *usbuf, char *name) {
int retcode;
retcode = CtdlGetUser(usbuf, name);
}
-/*
- * CtdlPutUser() - write user buffer into the correct place on disk
- */
-void CtdlPutUser(struct ctdluser *usbuf)
-{
+// CtdlPutUser() - write user buffer into the correct place on disk
+void CtdlPutUser(struct ctdluser *usbuf) {
char usernamekey[USERNAME_SIZE];
-
- makeuserkey(usernamekey, usbuf->fullname, cutusername(usbuf->fullname));
+ makeuserkey(usernamekey, usbuf->fullname);
usbuf->version = REV_LEVEL;
cdb_store(CDB_USERS, usernamekey, strlen(usernamekey), usbuf, sizeof(struct ctdluser));
}
-void CtdlPutCurrentUserLock()
-{
+void CtdlPutCurrentUserLock() {
CtdlPutUser(&CC->user);
}
-/*
- * CtdlPutUserLock() - same as putuser() but locks the record
- */
-void CtdlPutUserLock(struct ctdluser *usbuf)
-{
+// CtdlPutUserLock() - same as putuser() but locks the record
+void CtdlPutUserLock(struct ctdluser *usbuf) {
CtdlPutUser(usbuf);
end_critical_section(S_USERS);
}
-/*
- * rename_user() - this is tricky because the user's display name is the database key
- *
- * Returns 0 on success or nonzero if there was an error...
- *
- */
+// rename_user() - this is tricky because the user's display name is the database key
+// Returns 0 on success or nonzero if there was an error...
int rename_user(char *oldname, char *newname) {
int retcode = RENAMEUSER_OK;
struct ctdluser usbuf;
char oldnamekey[USERNAME_SIZE];
char newnamekey[USERNAME_SIZE];
- /* Create the database keys... */
- makeuserkey(oldnamekey, oldname, cutusername(oldname));
- makeuserkey(newnamekey, newname, cutusername(newname));
+ // Create the database keys...
+ makeuserkey(oldnamekey, oldname);
+ makeuserkey(newnamekey, newname);
- /* Lock up and get going */
+ // Lock up and get going
begin_critical_section(S_USERS);
- /* We cannot rename a user who is currently logged in */
+ // We cannot rename a user who is currently logged in
if (CtdlIsUserLoggedIn(oldname)) {
end_critical_section(S_USERS);
return RENAMEUSER_LOGGED_IN;
if (CtdlGetUser(&usbuf, oldname) != 0) {
retcode = RENAMEUSER_NOT_FOUND;
}
-
- else { /* Sanity checks succeeded. Now rename the user. */
- if (usbuf.usernum == 0)
- {
+ else { // Sanity checks succeeded. Now rename the user.
+ if (usbuf.usernum == 0) {
syslog(LOG_DEBUG, "user_ops: can not rename user \"Citadel\".");
retcode = RENAMEUSER_NOT_FOUND;
- } else {
+ }
+ else {
syslog(LOG_DEBUG, "user_ops: renaming <%s> to <%s>", oldname, newname);
cdb_delete(CDB_USERS, oldnamekey, strlen(oldnamekey));
safestrncpy(usbuf.fullname, newname, sizeof usbuf.fullname);
}
-/*
- * Index-generating function used by Ctdl[Get|Set]Relationship
- */
+// 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
int GenerateRelationshipIndex(char *IndexBuf,
long RoomID,
long RoomGen,
- long UserID)
-{
-
+ long UserID
+) {
struct {
long iRoomID;
long iRoomGen;
}
-/*
- * Back end for CtdlSetRelationship()
- */
-void put_visit(visit *newvisit)
-{
+// Back end for CtdlSetRelationship()
+void put_visit(visit *newvisit) {
char IndexBuf[32];
int IndexLen = 0;
memset (IndexBuf, 0, sizeof (IndexBuf));
- /* Generate an index */
+ // Generate an index
IndexLen = GenerateRelationshipIndex(IndexBuf, newvisit->v_roomnum, newvisit->v_roomgen, newvisit->v_usernum);
- /* Store the record */
+ // Store the record
cdb_store(CDB_VISIT, IndexBuf, IndexLen,
newvisit, sizeof(visit)
);
}
-/*
- * Define a relationship between a user and a 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.
- */
+// Define a relationship between a user and a 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.
newvisit->v_roomnum = rel_room->QRnumber;
newvisit->v_roomgen = rel_room->QRgen;
newvisit->v_usernum = rel_user->usernum;
/*
* 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;
/*
* Is the user currently logged in an Admin?
*/
-int is_aide(void)
-{
+int is_aide(void) {
if (CC->user.axlevel >= AxAideU)
return(1);
else
/*
* Is the user currently logged in an Admin *or* the room Admin for this room?
*/
-int is_room_aide(void)
-{
+int is_room_aide(void) {
if (!CC->logged_in) {
return(0);
*
* Note: fetching a user this way requires one additional database operation.
*/
-int CtdlGetUserByNumber(struct ctdluser *usbuf, long number)
-{
+int CtdlGetUserByNumber(struct ctdluser *usbuf, long number) {
struct cdbdata *cdbun;
int r;
* Returns 0 if user was found
* This now uses an extauth index.
*/
-int getuserbyuid(struct ctdluser *usbuf, uid_t number)
-{
+int getuserbyuid(struct ctdluser *usbuf, uid_t number) {
struct cdbdata *cdbextauth;
long usernum = 0;
StrBuf *claimed_id;
/*
* Back end for cmd_user() and its ilk
*/
-int CtdlLoginExistingUser(const char *trythisname)
-{
+int CtdlLoginExistingUser(const char *trythisname) {
char username[SIZ];
int found_user;
}
-#ifdef HAVE_LDAP
else if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
/* LDAP auth mode */
}
}
-#endif
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);
}
-/*
- * session startup code which is common to both cmd_pass() and cmd_newu()
- */
-void do_login(void)
-{
+// session startup code which is common to both cmd_pass() and cmd_newu()
+void do_login(void) {
CC->logged_in = 1;
syslog(LOG_NOTICE, "user_ops: <%s> logged in", CC->curr_user);
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 this user's name is the name of the system administrator
+ // (as specified in setup), automatically assign access level 6.
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 (CC->user.uid == 0) {
CC->user.axlevel = AxAideU;
}
CtdlPutUserLock(&CC->user);
- /* If we are using LDAP authentication, extract the user's email addresses from the directory. */
-#ifdef HAVE_LDAP
+ // If we are using LDAP authentication, extract the user's email addresses from the directory.
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) {
}
}
}
-#endif
- /* If the user does not have any email addresses assigned, generate one. */
+ // If the user does not have any email addresses assigned, generate one.
if (IsEmptyStr(CC->user.emailaddrs)) {
AutoGenerateEmailAddressForUser(&CC->user);
}
- /*
- * Populate cs_inet_email and cs_inet_other_emails with valid email addresses from the user record
- */
+ // 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(CC->cs_inet_email, CC->user.emailaddrs);
char *firstsep = strstr(CC->cs_inet_email, "|");
if (firstsep) {
CC->cs_inet_other_emails[0] = 0;
}
- /* Create any personal rooms required by the system.
- * (Technically, MAILROOM should be there already, but just in case...)
- */
+ // Create any personal rooms required by the system.
+ // (Technically, MAILROOM should be there already, but just in case...)
CtdlCreateRoom(MAILROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
CtdlCreateRoom(SENTITEMS, 4, "", 0, 1, 0, VIEW_MAILBOX);
CtdlCreateRoom(USERTRASHROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
CtdlCreateRoom(USERDRAFTROOM, 4, "", 0, 1, 0, VIEW_MAILBOX);
- /* Run any startup routines registered by loadable modules */
+ // Run any startup routines registered by loadable modules
PerformSessionHooks(EVT_LOGIN);
- /* Enter the lobby */
+ // Enter the lobby
CtdlUserGoto(CtdlGetConfigStr("c_baseroom"), 0, 0, NULL, NULL, NULL, NULL);
}
-void logged_in_response(void)
-{
+void logged_in_response(void) {
cprintf("%d %s|%d|%ld|%ld|%u|%ld|%ld\n",
CIT_OK, CC->user.fullname, CC->user.axlevel,
CC->user.timescalled, CC->user.posted,
}
-void CtdlUserLogout(void)
-{
+void CtdlUserLogout(void) {
CitContext *CCC = MyContext();
syslog(LOG_DEBUG, "user_ops: CtdlUserLogout() logging out <%s> from session %d", CCC->curr_user, CCC->cs_pid);
- /* Run any hooks registered by modules... */
+ // Run any hooks registered by modules...
PerformSessionHooks(EVT_LOGOUT);
- /*
- * Clear out some session data. Most likely, the CitContext for this
- * session is about to get nuked when the session disconnects, but
- * since it's possible to log in again without reconnecting, we cannot
- * make that assumption.
- */
+ // Clear out some session data. Most likely, the CitContext for this
+ // session is about to get nuked when the session disconnects, but
+ // since it's possible to log in again without reconnecting, we cannot
+ // make that assumption.
CCC->logged_in = 0;
- /* Check to see if the user was deleted while 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 */
+ // 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->cs_inet_email[0] = 0;
CCC->cs_inet_other_emails[0] = 0;
CCC->cs_inet_fn[0] = 0;
- /* Free any output buffers */
+ // Free any output buffers
unbuffer_output();
}
}
}
-#ifdef HAVE_LDAP
else if ((CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP) || (CtdlGetConfigInt("c_auth_mode") == AUTHMODE_LDAP_AD)) {
/* LDAP auth mode */
code = (-1);
}
}
-#endif
else {
struct ctdluser usbuf;
char usernamekey[USERNAME_SIZE];
- makeuserkey(usernamekey, pname, cutusername(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)) {
*/
void ForEachUser(void (*CallBack) (char *, void *out_data), void *in_data)
{
+ struct cdbdata *cdbus;
+ struct ctdluser *usptr;
+
struct feu {
+ struct feu *next;
char username[USERNAME_SIZE];
- int version;
};
-
- struct cdbdata *cdbus;
- struct ctdluser *usptr;
- int i = 0;
- struct feu *usernames = NULL;
- int num_users = 0;
- int num_users_alloc = 0;
+ struct feu *ufirst = NULL;
+ struct feu *ulast = NULL;
+ struct feu *f = NULL;
cdb_rewind(CDB_USERS);
- // Phase 1 : load list of usernames
+ // Phase 1 : build a linked list of all our user account names
while (cdbus = cdb_next_item(CDB_USERS), cdbus != NULL) {
usptr = (struct ctdluser *) cdbus->ptr;
if (strlen(usptr->fullname) > 0) {
- ++num_users;
- if (num_users > num_users_alloc) {
- num_users_alloc = ((num_users_alloc == 0) ? 1 : (num_users_alloc * 2));
- usernames = realloc(usernames, num_users_alloc * sizeof(struct feu));
+ f = malloc(sizeof(struct feu));
+ f->next = NULL;
+ strncpy(f->username, usptr->fullname, USERNAME_SIZE);
+
+ if (ufirst == NULL) {
+ ufirst = f;
+ ulast = f;
+ }
+ else {
+ ulast->next = f;
+ ulast = f;
}
- strcpy(usernames[num_users-1].username, usptr->fullname);
- usernames[num_users-1].version = usptr->version;
}
}
- // Phase 2 : perform the callback for each username
- for (i=0; i<num_users; ++i) {
- //if (usernames[i].version < 927) {
- // FIXME This is where we will do the reindexing stuff
- //}
- (*CallBack) (usernames[i].username, in_data);
+ // 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);
}
-
- free(usernames);
}
projects / citadel.git / blobdiff