removed some debugs
[citadel.git] / citadel / context.c
index 181d0347c87db600a9862d947130a4511fca7b13..bca317d238c78d8509ccc3b86ddc0bbadfdec263 100644 (file)
-/*
- * Citadel context management stuff.
- * Here's where we (hopefully) have all the code that manipulates contexts.
- *
- * Copyright (c) 1987-2011 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 as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
- *
- * 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.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- */
-
-#include "sysdep.h"
-#include <stdlib.h>
-#include <unistd.h>
-#include <stdio.h>
-#include <fcntl.h>
-#include <ctype.h>
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <sys/wait.h>
-#include <sys/socket.h>
-#include <syslog.h>
-#include <sys/syslog.h>
-/*
-#include <sys/syscall.h>
-*/
-
-#if TIME_WITH_SYS_TIME
-# include <sys/time.h>
-# include <time.h>
-#else
-# if HAVE_SYS_TIME_H
-#  include <sys/time.h>
-# else
-#  include <time.h>
-# endif
-#endif
-
-#include <limits.h>
-#include <sys/resource.h>
-#include <netinet/in.h>
-#include <netinet/tcp.h>
-#include <arpa/inet.h>
-#include <netdb.h>
-#include <sys/un.h>
-#include <string.h>
-#include <pwd.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <grp.h>
-#include <libcitadel.h>
-#include "citadel.h"
-#include "server.h"
-#include "sysdep_decls.h"
-#include "citserver.h"
-#include "support.h"
-#include "config.h"
-#include "database.h"
-#include "housekeeping.h"
-#include "modules/crypto/serv_crypto.h"        /* Needed for init_ssl, client_write_ssl, client_read_ssl, destruct_ssl */
-#include "ecrash.h"
-
-#ifdef HAVE_SYS_SELECT_H
-#include <sys/select.h>
-#endif
-
-#ifndef HAVE_SNPRINTF
-#include "snprintf.h"
-#endif
+//
+// Citadel context management stuff.
+// Here's where we (hopefully) have all the code that manipulates contexts.
+//
+// Copyright (c) 1987-2020 by the citadel.org team
+//
+// This program is open source software.  Use, duplication, or disclosure
+// is subject to the terms of the GNU General Public License, version 3.
+// The program is distributed without any warranty, expressed or implied.
 
 #include "ctdl_module.h"
-#include "threads.h"
+#include "serv_extensions.h"
+#include "citserver.h"
 #include "user_ops.h"
+#include "locate_host.h"
+#include "context.h"
 #include "control.h"
-
-
+#include "config.h"
 
 pthread_key_t MyConKey;                                /* TSD key for MyContext() */
-
-
 CitContext masterCC;
 CitContext *ContextList = NULL;
-
 time_t last_purge = 0;                         /* Last dead session purge */
 int num_sessions = 0;                          /* Current number of sessions */
+int next_pid = 0;
 
 /* Flag for single user mode */
 static int want_single_user = 0;
 
 /* Try to go single user */
 
-int CtdlTrySingleUser(void)
-{
+int CtdlTrySingleUser(void) {
        int can_do = 0;
        
        begin_critical_section(S_SINGLE_USER);
@@ -116,79 +44,82 @@ int CtdlTrySingleUser(void)
        return can_do;
 }
 
-void CtdlEndSingleUser(void)
-{
+
+void CtdlEndSingleUser(void) {
        begin_critical_section(S_SINGLE_USER);
        want_single_user = 0;
        end_critical_section(S_SINGLE_USER);
 }
 
 
-int CtdlWantSingleUser(void)
-{
+int CtdlWantSingleUser(void) {
        return want_single_user;
 }
 
-int CtdlIsSingleUser(void)
-{
-       if (want_single_user)
-       {
+
+int CtdlIsSingleUser(void) {
+       if (want_single_user) {
                /* check for only one context here */
                if (num_sessions == 1)
-                       return TRUE;
+                       return 1;
        }
-       return FALSE;
+       return 0;
 }
 
 
-
-
-
 /*
  * Locate a context by its session number and terminate it if the user is able.
  * User can NOT terminate their current session.
  * User CAN terminate any other session that has them logged in.
  * Aide CAN terminate any session except the current one.
  */
-int CtdlTerminateOtherSession (int session_num)
-{
+int CtdlTerminateOtherSession (int session_num) {
        int ret = 0;
        CitContext *ccptr;
+       int aide;
 
-       if (session_num == CC->cs_pid) {
-               return TERM_NOTALLOWED;
-       }
+       if (session_num == CC->cs_pid) return TERM_NOTALLOWED;
+
+       aide = ( (CC->user.axlevel >= AxAideU) || (CC->internal_pgm) ) ;
 
-       syslog(LOG_DEBUG, "Locating session to kill\n");
+       syslog(LOG_DEBUG, "context: locating session to kill");
        begin_critical_section(S_SESSION_TABLE);
        for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
                if (session_num == ccptr->cs_pid) {
                        ret |= TERM_FOUND;
-                       if ((ccptr->user.usernum == CC->user.usernum)
-                          || (CC->user.axlevel >= AxAideU)) {
+                       if ((ccptr->user.usernum == CC->user.usernum) || aide) {
                                ret |= TERM_ALLOWED;
-                               ccptr->kill_me = KILLME_ADMIN_TERMINATE;
                        }
+                       break;
                }
        }
-       end_critical_section(S_SESSION_TABLE);
+
+       if (((ret & TERM_FOUND) != 0) && ((ret & TERM_ALLOWED) != 0))
+       {
+               if (ccptr->user.usernum == CC->user.usernum)
+                       ccptr->kill_me = KILLME_ADMIN_TERMINATE;
+               else
+                       ccptr->kill_me = KILLME_IDLE;
+               end_critical_section(S_SESSION_TABLE);
+       }
+       else
+               end_critical_section(S_SESSION_TABLE);
+
        return ret;
 }
 
 
-
 /*
  * Check to see if the user who we just sent mail to is logged in.  If yes,
  * bump the 'new mail' counter for their session.  That enables them to
  * receive a new mail notification without having to hit the database.
  */
-void BumpNewMailCounter(long which_user) 
-{
+void BumpNewMailCounter(long which_user) {
        CtdlBumpNewMailCounter(which_user);
 }
 
-void CtdlBumpNewMailCounter(long which_user)
-{
+
+void CtdlBumpNewMailCounter(long which_user) {
        CitContext *ptr;
 
        begin_critical_section(S_SESSION_TABLE);
@@ -209,8 +140,7 @@ void CtdlBumpNewMailCounter(long which_user)
  * The user may not have been logged in when this function was called BUT
  * because of threading the user might be logged in before you test the result.
  */
-int CtdlIsUserLoggedIn (char *user_name)
-{
+int CtdlIsUserLoggedIn(char *user_name) {
        CitContext *cptr;
        int ret = 0;
 
@@ -226,7 +156,6 @@ int CtdlIsUserLoggedIn (char *user_name)
 }
 
 
-
 /*
  * Check to see if a user is currently logged in.
  * Basically same as CtdlIsUserLoggedIn() but uses the user number instead.
@@ -234,8 +163,7 @@ int CtdlIsUserLoggedIn (char *user_name)
  * The user may not have been logged in when this function was called BUT
  * because of threading the user might be logged in before you test the result.
  */
-int CtdlIsUserLoggedInByNum (long usernum)
-{
+int CtdlIsUserLoggedInByNum (long usernum) {
        CitContext *cptr;
        int ret = 0;
 
@@ -250,7 +178,6 @@ int CtdlIsUserLoggedInByNum (long usernum)
 }
 
 
-
 /*
  * Return a pointer to the CitContext structure bound to the thread which
  * called this function.  If there's no such binding (for example, if it's
@@ -264,30 +191,25 @@ CitContext *MyContext(void) {
 }
 
 
-
-
 /*
  * Terminate idle sessions.  This function pounds through the session table
  * comparing the current time to each session's time-of-last-command.  If an
  * idle session is found it is terminated, then the search restarts at the
  * beginning because the pointer to our place in the list becomes invalid.
  */
-void terminate_idle_sessions(void)
-{
+void terminate_idle_sessions(void) {
        CitContext *ccptr;
        time_t now;
-       int session_to_kill;
        int killed = 0;
        int longrunners = 0;
 
        now = time(NULL);
-       session_to_kill = 0;
        begin_critical_section(S_SESSION_TABLE);
        for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
                if (
                        (ccptr != CC)
-                       && (config.c_sleeping > 0)
-                       && (now - (ccptr->lastcmd) > config.c_sleeping)
+                       && (CtdlGetConfigLong("c_sleeping") > 0)
+                       && (now - (ccptr->lastcmd) > CtdlGetConfigLong("c_sleeping"))
                ) {
                        if (!ccptr->dont_term) {
                                ccptr->kill_me = KILLME_IDLE;
@@ -299,18 +221,19 @@ void terminate_idle_sessions(void)
                }
        }
        end_critical_section(S_SESSION_TABLE);
-       if (killed > 0)
-               syslog(LOG_INFO, "Scheduled %d idle sessions for termination\n", killed);
-       if (longrunners > 0)
-               syslog(LOG_INFO, "Didn't terminate %d protected idle sessions", longrunners);
+       if (killed > 0) {
+               syslog(LOG_INFO, "context: scheduled %d idle sessions for termination", killed);
+       }
+       if (longrunners > 0) {
+               syslog(LOG_INFO, "context: did not terminate %d protected idle sessions", longrunners);
+       }
 }
 
 
 /*
  * During shutdown, close the sockets of any sessions still connected.
  */
-void terminate_all_sessions(void)
-{
+void terminate_all_sessions(void) {
        CitContext *ccptr;
        int killed = 0;
 
@@ -318,7 +241,7 @@ void terminate_all_sessions(void)
        for (ccptr = ContextList; ccptr != NULL; ccptr = ccptr->next) {
                if (ccptr->client_socket != -1)
                {
-                       syslog(LOG_INFO, "terminate_all_sessions() is murdering %s", ccptr->curr_user);
+                       syslog(LOG_INFO, "context: terminate_all_sessions() is murdering %s CC[%d]", ccptr->curr_user, ccptr->cs_pid);
                        close(ccptr->client_socket);
                        ccptr->client_socket = -1;
                        killed++;
@@ -326,28 +249,25 @@ void terminate_all_sessions(void)
        }
        end_critical_section(S_SESSION_TABLE);
        if (killed > 0) {
-               syslog(LOG_INFO, "Flushed %d stuck sessions\n", killed);
+               syslog(LOG_INFO, "context: flushed %d stuck sessions", killed);
        }
 }
 
 
-
 /*
  * Terminate a session.
  */
-void RemoveContext (CitContext *con)
-{
+void RemoveContext (CitContext *con) {
        const char *c;
        if (con == NULL) {
-               syslog(LOG_ERR, "WARNING: RemoveContext() called with NULL!");
+               syslog(LOG_ERR, "context: RemoveContext() called with NULL, this should not happen");
                return;
        }
        c = con->ServiceName;
        if (c == NULL) {
                c = "WTF?";
        }
-       syslog(LOG_DEBUG, "RemoveContext(%s) session %d", c, con->cs_pid);
-       cit_backtrace();
+       syslog(LOG_DEBUG, "context: RemoveContext(%s) session %d", c, con->cs_pid);
 
        /* Run any cleanup routines registered by loadable modules.
         * Note: We have to "become_session()" because the cleanup functions
@@ -359,15 +279,14 @@ void RemoveContext (CitContext *con)
        client_close();                         /* If the client is still connected, blow 'em away. */
        become_session(NULL);
 
-       syslog(LOG_NOTICE, "[%3d] Session ended.", con->cs_pid);
+       syslog(LOG_INFO, "context: [%3d]SRV[%s] Session ended.", con->cs_pid, c);
 
        /* 
         * If the client is still connected, blow 'em away. 
         * if the socket is 0 or -1, its already gone or was never there.
         */
-       if (con->client_socket > 0)
-       {
-               syslog(LOG_NOTICE, "Closing socket %d", con->client_socket);
+       if (con->client_socket > 0) {
+               syslog(LOG_INFO, "context: closing socket %d", con->client_socket);
                close(con->client_socket);
        }
 
@@ -376,18 +295,17 @@ void RemoveContext (CitContext *con)
                free(con->ldap_dn);
                con->ldap_dn = NULL;
        }
-
+       FreeStrBuf(&con->StatusMessage);
        FreeStrBuf(&con->MigrateBuf);
        FreeStrBuf(&con->RecvBuf.Buf);
        if (con->cached_msglist) {
                free(con->cached_msglist);
        }
 
-       syslog(LOG_DEBUG, "Done with RemoveContext()");
+       syslog(LOG_DEBUG, "context: done with RemoveContext()");
 }
 
 
-
 /*
  * Initialize a new context and place it in the list.  The session number
  * used to be the PID (which is why it's called cs_pid), but that was when we
@@ -396,11 +314,10 @@ void RemoveContext (CitContext *con)
  */
 CitContext *CreateNewContext(void) {
        CitContext *me;
-       static int next_pid = 0;
 
        me = (CitContext *) malloc(sizeof(CitContext));
        if (me == NULL) {
-               syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
+               syslog(LOG_ERR, "citserver: malloc() failed: %m");
                return NULL;
        }
        memset(me, 0, sizeof(CitContext));
@@ -446,11 +363,10 @@ CitContext *CreateNewContext(void) {
  */
 CitContext *CloneContext(CitContext *CloneMe) {
        CitContext *me;
-       static int next_pid = 0;
 
        me = (CitContext *) malloc(sizeof(CitContext));
        if (me == NULL) {
-               syslog(LOG_ALERT, "citserver: can't allocate memory!!\n");
+               syslog(LOG_ERR, "citserver: malloc() failed: %m");
                return NULL;
        }
        memcpy(me, CloneMe, sizeof(CitContext));
@@ -472,7 +388,10 @@ CitContext *CloneContext(CitContext *CloneMe) {
        me->openid_data = NULL;
        me->ldap_dn = NULL;
        me->session_specific_data = NULL;
+       
+       me->CIT_ICAL = NULL;
 
+       me->cached_msglist = NULL;
        me->download_fp = NULL;
        me->upload_fp = NULL;
        me->client_socket = 0;
@@ -502,8 +421,7 @@ CitContext *CloneContext(CitContext *CloneMe) {
  * This allows worker threads to perform "for each context" operations without
  * having to lock and traverse the live list.
  */
-CitContext *CtdlGetContextArray(int *count)
-{
+CitContext *CtdlGetContextArray(int *count) {
        int nContexts, i;
        CitContext *nptr, *cptr;
        
@@ -524,13 +442,94 @@ CitContext *CtdlGetContextArray(int *count)
 }
 
 
+/*
+ * Back-end function for starting a session
+ */
+void begin_session(CitContext *con) {
+       /* 
+        * Initialize some variables specific to our context.
+        */
+       con->logged_in = 0;
+       con->internal_pgm = 0;
+       con->download_fp = NULL;
+       con->upload_fp = NULL;
+       con->cached_msglist = NULL;
+       con->cached_num_msgs = 0;
+       con->FirstExpressMessage = NULL;
+       time(&con->lastcmd);
+       time(&con->lastidle);
+       strcpy(con->lastcmdname, "    ");
+       strcpy(con->cs_clientname, "(unknown)");
+       strcpy(con->curr_user, NLI);
+       *con->cs_clientinfo = '\0';
+       safestrncpy(con->cs_host, CtdlGetConfigStr("c_fqdn"), sizeof con->cs_host);
+       safestrncpy(con->cs_addr, "", sizeof con->cs_addr);
+       con->cs_UDSclientUID = -1;
+       con->cs_host[sizeof con->cs_host - 1] = 0;
+       if (!CC->is_local_client) {
+               locate_host(con->cs_host, sizeof con->cs_host,
+                       con->cs_addr, sizeof con->cs_addr,
+                       con->client_socket
+               );
+       }
+       else {
+               con->cs_host[0] = 0;
+               con->cs_addr[0] = 0;
+#ifdef HAVE_STRUCT_UCRED
+               {
+                       /* as http://www.wsinnovations.com/softeng/articles/uds.html told us... */
+                       struct ucred credentials;
+                       socklen_t ucred_length = sizeof(struct ucred);
+                       
+                       /*fill in the user data structure */
+                       if(getsockopt(con->client_socket, SOL_SOCKET, SO_PEERCRED, &credentials, &ucred_length)) {
+                               syslog(LOG_ERR, "context: could obtain credentials from unix domain socket");
+                               
+                       }
+                       else {          
+                               /* the process ID of the process on the other side of the socket */
+                               /* credentials.pid; */
+                               
+                               /* the effective UID of the process on the other side of the socket  */
+                               con->cs_UDSclientUID = credentials.uid;
+                               
+                               /* the effective primary GID of the process on the other side of the socket */
+                               /* credentials.gid; */
+                               
+                               /* To get supplemental groups, we will have to look them up in our account
+                                  database, after a reverse lookup on the UID to get the account name.
+                                  We can take this opportunity to check to see if this is a legit account.
+                               */
+                               snprintf(con->cs_clientinfo, sizeof(con->cs_clientinfo),
+                                        "PID: "F_PID_T"; UID: "F_UID_T"; GID: "F_XPID_T" ", 
+                                        credentials.pid,
+                                        credentials.uid,
+                                        credentials.gid);
+                       }
+               }
+#endif
+       }
+       con->cs_flags = 0;
+
+       con->nologin = 0;
+       if (((CtdlGetConfigInt("c_maxsessions") > 0)&&(num_sessions > CtdlGetConfigInt("c_maxsessions"))) || CtdlWantSingleUser()) {
+               con->nologin = 1;
+       }
+
+       syslog(LOG_INFO, "context: session (%s) started from %s (%s) uid=%d",
+               con->ServiceName, con->cs_host, con->cs_addr, con->cs_UDSclientUID
+       );
+
+       /* Run any session startup routines registered by loadable modules */
+       PerformSessionHooks(EVT_START);
+}
+
 
 /*
  * This function fills in a context and its user field correctly
  * Then creates/loads that user
  */
-void CtdlFillSystemContext(CitContext *context, char *name)
-{
+void CtdlFillSystemContext(CitContext *context, char *name) {
        char sysname[SIZ];
        long len;
 
@@ -539,22 +538,21 @@ void CtdlFillSystemContext(CitContext *context, char *name)
        context->cs_pid = 0;
        strcpy (sysname, "SYS_");
        strcat (sysname, name);
-       len = cutuserkey(sysname);
+       len = strlen(sysname);
        memcpy(context->curr_user, sysname, len + 1);
        context->client_socket = (-1);
        context->state = CON_SYS;
        context->ServiceName = name;
 
-       /* internal_create_user has the side effect of loading the user regardless of wether they
+       /* internal_create_user has the side effect of loading the user regardless of whether they
         * already existed or needed to be created
         */
-       internal_create_user (sysname, len, &(context->user), -1) ;
+       internal_create_user(sysname, &(context->user), -1) ;
        
        /* Check to see if the system user needs upgrading */
-       if (context->user.usernum == 0)
-       {       /* old system user with number 0, upgrade it */
+       if (context->user.usernum == 0) {       /* old system user with number 0, upgrade it */
                context->user.usernum = get_new_user_number();
-               syslog(LOG_DEBUG, "Upgrading system user \"%s\" from user number 0 to user number %ld\n", context->user.fullname, context->user.usernum);
+               syslog(LOG_INFO, "context: upgrading system user \"%s\" from user number 0 to user number %ld", context->user.fullname, context->user.usernum);
                /* add user to the database */
                CtdlPutUser(&(context->user));
                cdb_store(CDB_USERSBYNUMBER, &(context->user.usernum), sizeof(long), context->user.fullname, strlen(context->user.fullname)+1);
@@ -565,8 +563,7 @@ void CtdlFillSystemContext(CitContext *context, char *name)
 /*
  * Cleanup any contexts that are left lying around
  */
-void context_cleanup(void)
-{
+void context_cleanup(void) {
        CitContext *ptr = NULL;
        CitContext *rem = NULL;
 
@@ -588,7 +585,7 @@ void context_cleanup(void)
                rem = ptr->next;
                --num_sessions;
 
-               syslog(LOG_DEBUG, "context_cleanup(): Purging session #%d %s\n", ptr->cs_pid, ptr->ServiceName);
+               syslog(LOG_DEBUG, "context: context_cleanup() purging session %d", ptr->cs_pid);
                RemoveContext(ptr);
                free (ptr);
                ptr = rem;
@@ -596,7 +593,6 @@ void context_cleanup(void)
 }
 
 
-
 /*
  * Purge all sessions which have the 'kill_me' flag set.
  * This function has code to prevent it from running more than once every
@@ -648,7 +644,7 @@ void dead_session_purge(int force) {
         * is allocated privately on this thread's stack.
         */
        while (rem != NULL) {
-               syslog(LOG_DEBUG, "dead_session_purge(): purging session %d, reason=%d\n", rem->cs_pid, rem->kill_me);
+               syslog(LOG_DEBUG, "context: dead_session_purge() purging session %d, reason=%d", rem->cs_pid, rem->kill_me);
                RemoveContext(rem);
                ptr = rem;
                rem = rem->next;
@@ -657,9 +653,6 @@ void dead_session_purge(int force) {
 }
 
 
-
-
-
 /*
  * masterCC is the context we use when not attached to a session.  This
  * function initializes it.
@@ -671,15 +664,11 @@ void InitializeMasterCC(void) {
 }
 
 
-
-
-
 /*
  * Set the "async waiting" flag for a session, if applicable
  */
-void set_async_waiting(struct CitContext *ccptr)
-{
-       syslog(LOG_DEBUG, "Setting async_waiting flag for session %d\n", ccptr->cs_pid);
+void set_async_waiting(struct CitContext *ccptr) {
+       syslog(LOG_DEBUG, "context: setting async_waiting flag for session %d", ccptr->cs_pid);
        if (ccptr->is_async) {
                ccptr->async_waiting++;
                if (ccptr->state == CON_IDLE) {
@@ -687,3 +676,11 @@ void set_async_waiting(struct CitContext *ccptr)
                }
        }
 }
+
+
+CTDL_MODULE_INIT(session)
+{
+       if (!threading) {
+       }
+       return "session";
+}