Removed the remaining code where LDAP was optional.
[citadel.git] / citadel / config.c
1 //
2 // Read and write the citadel.config file
3 //
4 // Copyright (c) 1987-2021 by the citadel.org team
5 //
6 // This program is open source software.  Use, duplication, or disclosure
7 // is subject to the terms of the GNU General Public License, version 3.
8 // The program is distributed without any warranty, expressed or implied.
9
10 #include "sysdep.h"
11 #include <stdlib.h>
12 #include <unistd.h>
13 #include <stdio.h>
14 #include <netdb.h>
15 #include <sys/utsname.h>
16 #include <libcitadel.h>
17 #include <assert.h>
18 #include "config.h"
19 #include "ctdl_module.h"
20
21 long config_msgnum = 0;
22 HashList *ctdlconfig = NULL;    // new configuration
23
24
25 void config_warn_if_port_unset(char *key, int default_port)
26 {
27         int p = CtdlGetConfigInt(key);
28         if ((p < -1) || (p == 0) || (p > UINT16_MAX))
29         {
30                 syslog(LOG_ERR, "config: setting %s is not -1 (disabled) or a valid TCP port - setting to default %d", key, default_port);
31                 CtdlSetConfigInt(key, default_port);
32         }
33 }
34
35
36 void config_warn_if_empty(char *key)
37 {
38         if (IsEmptyStr(CtdlGetConfigStr(key)))
39         {
40                 syslog(LOG_ERR, "config: setting %s is empty, but must not - check your config!", key);
41         }
42 }
43
44
45 void validate_config(void) {
46
47         /*
48          * these shouldn't be empty
49          */
50         config_warn_if_empty("c_fqdn");
51         config_warn_if_empty("c_baseroom");
52         config_warn_if_empty("c_aideroom");
53         config_warn_if_empty("c_twitroom");
54         config_warn_if_empty("c_nodename");
55
56         /*
57          * Sanity check for port bindings
58          */
59         config_warn_if_port_unset("c_smtp_port",        25);
60         config_warn_if_port_unset("c_pop3_port",        110);
61         config_warn_if_port_unset("c_imap_port",        143);
62         config_warn_if_port_unset("c_msa_port",         587);
63         config_warn_if_port_unset("c_port_number",      504);
64         config_warn_if_port_unset("c_smtps_port",       465);
65         config_warn_if_port_unset("c_pop3s_port",       995);
66         config_warn_if_port_unset("c_imaps_port",       993);
67         config_warn_if_port_unset("c_pftcpdict_port",   -1);
68         config_warn_if_port_unset("c_xmpp_c2s_port",    5222);
69         config_warn_if_port_unset("c_xmpp_s2s_port",    5269);
70         config_warn_if_port_unset("c_nntp_port",        119);
71         config_warn_if_port_unset("c_nntps_port",       563);
72
73         if (getpwuid(ctdluid) == NULL) {
74                 syslog(LOG_ERR, "config: uid (%d) does not exist ... citserver will run as root", ctdluid);
75         }
76 }
77
78
79 /*
80  * Put some sane default values into our configuration.  Some will be overridden when we run setup.
81  */
82 void brand_new_installation_set_defaults(void) {
83
84         struct utsname my_utsname;
85         struct hostent *he;
86         char detected_hostname[256];
87
88         /* Determine our host name, in case we need to use it as a default */
89         uname(&my_utsname);
90
91         /* set some sample/default values in place of blanks... */
92         extract_token(detected_hostname, my_utsname.nodename, 0, '.', sizeof detected_hostname);
93         CtdlSetConfigStr("c_nodename", detected_hostname);
94
95         if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
96                 CtdlSetConfigStr("c_fqdn", he->h_name);
97         }
98         else {
99                 CtdlSetConfigStr("c_fqdn", my_utsname.nodename);
100         }
101
102         CtdlSetConfigStr("c_humannode",         "Citadel Server");
103         CtdlSetConfigInt("c_initax",            4);
104         CtdlSetConfigStr("c_moreprompt",        "<more>");
105         CtdlSetConfigStr("c_twitroom",          "Trashcan");
106         CtdlSetConfigStr("c_baseroom",          BASEROOM);
107         CtdlSetConfigStr("c_aideroom",          "Aide");
108         CtdlSetConfigInt("c_sleeping",          900);
109
110         if (CtdlGetConfigInt("c_createax") == 0) {
111                 CtdlSetConfigInt("c_createax", 3);
112         }
113
114         /*
115          * Default port numbers for various services
116          */
117         CtdlSetConfigInt("c_port_number",       504);
118         CtdlSetConfigInt("c_smtp_port",         25);
119         CtdlSetConfigInt("c_pop3_port",         110);
120         CtdlSetConfigInt("c_imap_port",         143);
121         CtdlSetConfigInt("c_msa_port",          587);
122         CtdlSetConfigInt("c_smtps_port",        465);
123         CtdlSetConfigInt("c_pop3s_port",        995);
124         CtdlSetConfigInt("c_imaps_port",        993);
125         CtdlSetConfigInt("c_pftcpdict_port",    -1);
126         CtdlSetConfigInt("c_xmpp_c2s_port",     5222);
127         CtdlSetConfigInt("c_xmpp_s2s_port",     5269);
128         CtdlSetConfigInt("c_nntp_port",         119);
129         CtdlSetConfigInt("c_nntps_port",        563);
130
131         /*
132          * Prevent the "new installation, set defaults" behavior from occurring again
133          */
134         CtdlSetConfigLong("c_config_created_or_migrated", (long)time(NULL));
135 }
136
137
138 /*
139  * Migrate a supplied legacy configuration to the new in-db format.
140  * No individual site should ever have to do this more than once.
141  */
142 void migrate_legacy_config(struct legacy_config *lconfig)
143 {
144         CtdlSetConfigStr(       "c_nodename"            ,       lconfig->c_nodename             );
145         CtdlSetConfigStr(       "c_fqdn"                ,       lconfig->c_fqdn                 );
146         CtdlSetConfigStr(       "c_humannode"           ,       lconfig->c_humannode            );
147         CtdlSetConfigInt(       "c_creataide"           ,       lconfig->c_creataide            );
148         CtdlSetConfigInt(       "c_sleeping"            ,       lconfig->c_sleeping             );
149         CtdlSetConfigInt(       "c_initax"              ,       lconfig->c_initax               );
150         CtdlSetConfigInt(       "c_regiscall"           ,       lconfig->c_regiscall            );
151         CtdlSetConfigInt(       "c_twitdetect"          ,       lconfig->c_twitdetect           );
152         CtdlSetConfigStr(       "c_twitroom"            ,       lconfig->c_twitroom             );
153         CtdlSetConfigStr(       "c_moreprompt"          ,       lconfig->c_moreprompt           );
154         CtdlSetConfigInt(       "c_restrict"            ,       lconfig->c_restrict             );
155         CtdlSetConfigStr(       "c_site_location"       ,       lconfig->c_site_location        );
156         CtdlSetConfigStr(       "c_sysadm"              ,       lconfig->c_sysadm               );
157         CtdlSetConfigInt(       "c_maxsessions"         ,       lconfig->c_maxsessions          );
158         CtdlSetConfigStr(       "c_ip_addr"             ,       lconfig->c_ip_addr              );
159         CtdlSetConfigInt(       "c_port_number"         ,       lconfig->c_port_number          );
160         CtdlSetConfigInt(       "c_ep_mode"             ,       lconfig->c_ep.expire_mode       );
161         CtdlSetConfigInt(       "c_ep_value"            ,       lconfig->c_ep.expire_value      );
162         CtdlSetConfigInt(       "c_userpurge"           ,       lconfig->c_userpurge            );
163         CtdlSetConfigInt(       "c_roompurge"           ,       lconfig->c_roompurge            );
164         CtdlSetConfigStr(       "c_logpages"            ,       lconfig->c_logpages             );
165         CtdlSetConfigInt(       "c_createax"            ,       lconfig->c_createax             );
166         CtdlSetConfigLong(      "c_maxmsglen"           ,       lconfig->c_maxmsglen            );
167         CtdlSetConfigInt(       "c_min_workers"         ,       lconfig->c_min_workers          );
168         CtdlSetConfigInt(       "c_max_workers"         ,       lconfig->c_max_workers          );
169         CtdlSetConfigInt(       "c_pop3_port"           ,       lconfig->c_pop3_port            );
170         CtdlSetConfigInt(       "c_smtp_port"           ,       lconfig->c_smtp_port            );
171         CtdlSetConfigInt(       "c_rfc822_strict_from"  ,       lconfig->c_rfc822_strict_from   );
172         CtdlSetConfigInt(       "c_aide_zap"            ,       lconfig->c_aide_zap             );
173         CtdlSetConfigInt(       "c_imap_port"           ,       lconfig->c_imap_port            );
174         CtdlSetConfigLong(      "c_net_freq"            ,       lconfig->c_net_freq             );
175         CtdlSetConfigInt(       "c_disable_newu"        ,       lconfig->c_disable_newu         );
176         CtdlSetConfigInt(       "c_enable_fulltext"     ,       lconfig->c_enable_fulltext      );
177         CtdlSetConfigStr(       "c_baseroom"            ,       lconfig->c_baseroom             );
178         CtdlSetConfigStr(       "c_aideroom"            ,       lconfig->c_aideroom             );
179         CtdlSetConfigInt(       "c_purge_hour"          ,       lconfig->c_purge_hour           );
180         CtdlSetConfigInt(       "c_mbxep_mode"          ,       lconfig->c_mbxep.expire_mode    );
181         CtdlSetConfigInt(       "c_mbxep_value"         ,       lconfig->c_mbxep.expire_value   );
182         CtdlSetConfigStr(       "c_ldap_host"           ,       lconfig->c_ldap_host            );
183         CtdlSetConfigInt(       "c_ldap_port"           ,       lconfig->c_ldap_port            );
184         CtdlSetConfigStr(       "c_ldap_base_dn"        ,       lconfig->c_ldap_base_dn         );
185         CtdlSetConfigStr(       "c_ldap_bind_dn"        ,       lconfig->c_ldap_bind_dn         );
186         CtdlSetConfigStr(       "c_ldap_bind_pw"        ,       lconfig->c_ldap_bind_pw         );
187         CtdlSetConfigInt(       "c_msa_port"            ,       lconfig->c_msa_port             );
188         CtdlSetConfigInt(       "c_imaps_port"          ,       lconfig->c_imaps_port           );
189         CtdlSetConfigInt(       "c_pop3s_port"          ,       lconfig->c_pop3s_port           );
190         CtdlSetConfigInt(       "c_smtps_port"          ,       lconfig->c_smtps_port           );
191         CtdlSetConfigInt(       "c_auto_cull"           ,       lconfig->c_auto_cull            );
192         CtdlSetConfigInt(       "c_allow_spoofing"      ,       lconfig->c_allow_spoofing       );
193         CtdlSetConfigInt(       "c_journal_email"       ,       lconfig->c_journal_email        );
194         CtdlSetConfigInt(       "c_journal_pubmsgs"     ,       lconfig->c_journal_pubmsgs      );
195         CtdlSetConfigStr(       "c_journal_dest"        ,       lconfig->c_journal_dest         );
196         CtdlSetConfigStr(       "c_default_cal_zone"    ,       lconfig->c_default_cal_zone     );
197         CtdlSetConfigInt(       "c_pftcpdict_port"      ,       lconfig->c_pftcpdict_port       );
198         CtdlSetConfigInt(       "c_auth_mode"           ,       lconfig->c_auth_mode            );
199         CtdlSetConfigInt(       "c_rbl_at_greeting"     ,       lconfig->c_rbl_at_greeting      );
200         CtdlSetConfigStr(       "c_pager_program"       ,       lconfig->c_pager_program        );
201         CtdlSetConfigInt(       "c_imap_keep_from"      ,       lconfig->c_imap_keep_from       );
202         CtdlSetConfigInt(       "c_xmpp_c2s_port"       ,       lconfig->c_xmpp_c2s_port        );
203         CtdlSetConfigInt(       "c_xmpp_s2s_port"       ,       lconfig->c_xmpp_s2s_port        );
204         CtdlSetConfigLong(      "c_pop3_fetch"          ,       lconfig->c_pop3_fetch           );
205         CtdlSetConfigLong(      "c_pop3_fastest"        ,       lconfig->c_pop3_fastest         );
206         CtdlSetConfigInt(       "c_spam_flag_only"      ,       lconfig->c_spam_flag_only       );
207         CtdlSetConfigInt(       "c_guest_logins"        ,       lconfig->c_guest_logins         );
208         CtdlSetConfigInt(       "c_nntp_port"           ,       lconfig->c_nntp_port            );
209         CtdlSetConfigInt(       "c_nntps_port"          ,       lconfig->c_nntps_port           );
210 }
211
212
213 /*
214  * Called during the initialization of Citadel server.
215  * It verifies the system's integrity and reads citadel.config into memory.
216  */
217 void initialize_config_system(void) {
218         FILE *cfp;
219         int rv;
220         struct legacy_config lconfig;   // legacy configuration
221         ctdlconfig = NewHash(1, NULL);  // set up the real config system
222
223         /* Ensure that we are linked to the correct version of libcitadel */
224         if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) {
225                 fprintf(stderr, "You are running libcitadel version %d\n", libcitadel_version_number());
226                 fprintf(stderr, "citserver was compiled against version %d\n", LIBCITADEL_VERSION_NUMBER);
227                 exit(CTDLEXIT_LIBCITADEL);
228         }
229
230         memset(&lconfig, 0, sizeof(struct legacy_config));
231         cfp = fopen(file_citadel_config, "rb");
232         if (cfp != NULL) {
233                 if (CtdlGetConfigLong("c_config_created_or_migrated") > 0) {
234                         fprintf(stderr, "Citadel Server found BOTH legacy and new configurations present.\n");
235                         fprintf(stderr, "Exiting to prevent data corruption.\n");
236                         exit(CTDLEXIT_CONFIG);
237                 }
238                 rv = fread((char *) &lconfig, sizeof(struct legacy_config), 1, cfp);
239                 if (rv != 1)
240                 {
241                         fprintf(stderr, 
242                                 "Warning: Found a legacy config file %s has unexpected size. \n",
243                                 file_citadel_config
244                         );
245                 }
246
247                 migrate_legacy_config(&lconfig);
248
249                 fclose(cfp);
250                 if (unlink(file_citadel_config) != 0) {
251                         fprintf(stderr, "Unable to remove legacy config file %s after migrating it.\n", file_citadel_config);
252                         fprintf(stderr, "Exiting to prevent data corruption.\n");
253                         exit(CTDLEXIT_CONFIG);
254                 }
255
256                 /*
257                  * Prevent migration/initialization from happening again.
258                  */
259                 CtdlSetConfigLong("c_config_created_or_migrated", (long)time(NULL));
260
261         }
262
263         /* New installation?  Set up configuration */
264         if (CtdlGetConfigLong("c_config_created_or_migrated") <= 0) {
265                 brand_new_installation_set_defaults();
266         }
267
268         /* Default maximum message length is 10 megabytes.  This is site
269          * configurable.  Also check to make sure the limit has not been
270          * set below 8192 bytes.
271          */
272         if (CtdlGetConfigLong("c_maxmsglen") <= 0)      CtdlSetConfigLong("c_maxmsglen", 10485760);
273         if (CtdlGetConfigLong("c_maxmsglen") < 8192)    CtdlSetConfigLong("c_maxmsglen", 8192);
274
275         /*
276          * Default lower and upper limits on number of worker threads
277          */
278         if (CtdlGetConfigInt("c_min_workers") < 5)      CtdlSetConfigInt("c_min_workers", 5);   // min
279         if (CtdlGetConfigInt("c_max_workers") == 0)     CtdlSetConfigInt("c_max_workers", 256); // default max
280         if (CtdlGetConfigInt("c_max_workers") < CtdlGetConfigInt("c_min_workers")) {
281                 CtdlSetConfigInt("c_max_workers", CtdlGetConfigInt("c_min_workers"));           // max >= min
282         }
283
284         /* Networking more than once every five minutes just isn't sane */
285         if (CtdlGetConfigLong("c_net_freq") == 0)       CtdlSetConfigLong("c_net_freq", 3600);  // once per hour default
286         if (CtdlGetConfigLong("c_net_freq") < 300)      CtdlSetConfigLong("c_net_freq", 300);   // minimum 5 minutes
287
288         /* Same goes for POP3 */
289         if (CtdlGetConfigLong("c_pop3_fetch") == 0)     CtdlSetConfigLong("c_pop3_fetch", 3600);        // once per hour default
290         if (CtdlGetConfigLong("c_pop3_fetch") < 300)    CtdlSetConfigLong("c_pop3_fetch", 300);         // 5 minutes min
291         if (CtdlGetConfigLong("c_pop3_fastest") == 0)   CtdlSetConfigLong("c_pop3_fastest", 3600);      // once per hour default
292         if (CtdlGetConfigLong("c_pop3_fastest") < 300)  CtdlSetConfigLong("c_pop3_fastest", 300);       // 5 minutes min
293
294         /* LDAP sync frequency */
295         if (CtdlGetConfigLong("c_ldap_sync_freq") == 0) CtdlSetConfigLong("c_ldap_sync_freq", 300);     // every 5 minutes default
296
297         /* "create new user" only works with native authentication mode */
298         if (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_NATIVE) {
299                 CtdlSetConfigInt("c_disable_newu", 1);
300         }
301 }
302
303
304 /*
305  * Called when Citadel server is shutting down.
306  * Clears out the config hash table.
307  */
308 void shutdown_config_system(void) 
309 {
310         DeleteHash(&ctdlconfig);
311 }
312
313
314 /*
315  * Set a system config value.  Simple key/value here.
316  */
317 void CtdlSetConfigStr(char *key, char *value)
318 {
319         int key_len = strlen(key);
320         int value_len = strlen(value);
321
322         /* Save it in memory */
323         Put(ctdlconfig, key, key_len, strdup(value), NULL);
324
325         /* Also write it to the config database */
326
327         int dbv_size = key_len + value_len + 2;
328         char *dbv = malloc(dbv_size);
329         strcpy(dbv, key);
330         strcpy(&dbv[key_len + 1], value);
331         cdb_store(CDB_CONFIG, key, key_len, dbv, dbv_size);
332         free(dbv);
333 }
334
335
336 /*
337  * Set a numeric system config value (long integer)
338  */
339 void CtdlSetConfigLong(char *key, long value)
340 {
341         char longstr[256];
342         sprintf(longstr, "%ld", value);
343         CtdlSetConfigStr(key, longstr);
344 }
345
346
347 /*
348  * Set a numeric system config value (integer)
349  */
350 void CtdlSetConfigInt(char *key, int value)
351 {
352         char intstr[256];
353         sprintf(intstr, "%d", value);
354         CtdlSetConfigStr(key, intstr);
355 }
356
357
358 /*
359  * Delete a system config value.
360  */
361 void CtdlDelConfig(char *key)
362 {
363         int key_len = strlen(key);
364
365         if (IsEmptyStr(key)) return;
366
367         /* Delete from the database. */
368         cdb_delete(CDB_CONFIG, key, key_len);
369
370         /* Delete from the in-memory cache */
371         HashPos *Pos = GetNewHashPos(ctdlconfig, 1);
372         if (GetHashPosFromKey(ctdlconfig, key, key_len, Pos)) {
373                 DeleteEntryFromHash(ctdlconfig, Pos);
374         }
375         DeleteHashPos(&Pos);
376
377         assert(Pos == NULL);    // no memory leaks allowed
378 }
379
380
381 /*
382  * Fetch a system config value.  Caller does *not* own the returned value and may not alter it.
383  */
384 char *CtdlGetConfigStr(char *key)
385 {
386         char *value = NULL;
387         struct cdbdata *cdb;
388         int key_len = strlen(key);
389
390         if (IsEmptyStr(key)) return(NULL);
391
392         /* First look in memory */
393         if (GetHash(ctdlconfig, key, key_len, (void *)&value))
394         {
395                 return value;
396         }
397
398         /* Then look in the database. */
399
400         cdb = cdb_fetch(CDB_CONFIG, key, key_len);
401
402         if (cdb == NULL) {      /* nope, not there either. */
403                 return(NULL);
404         }
405
406         /* Got it.  Save it in memory for the next fetch. */
407         value = strdup(cdb->ptr + key_len + 1);         /* The key was stored there too; skip past it */
408         cdb_free(cdb);
409         Put(ctdlconfig, key, key_len, value, NULL);
410         return value;
411 }
412
413
414 /*
415  * Fetch a system config value - integer
416  */
417 int CtdlGetConfigInt(char *key)
418 {
419         char *s = CtdlGetConfigStr(key);
420         if (s) return atoi(s);
421         return 0;
422 }
423
424
425 /*
426  * Fetch a system config value - long integer
427  */
428 long CtdlGetConfigLong(char *key) {
429         char *s = CtdlGetConfigStr(key);
430         if (s) return atol(s);
431         return 0;
432 }
433
434
435 void CtdlGetSysConfigBackend(long msgnum, void *userdata) {
436         config_msgnum = msgnum;
437 }
438
439
440 /*
441  * This is for fetching longer configuration sets which are stored in the message base.
442  */
443 char *CtdlGetSysConfig(char *sysconfname) {
444         char hold_rm[ROOMNAMELEN];
445         long msgnum = -1;
446         char *conf;
447         struct CtdlMessage *msg;
448         char buf[SIZ];
449         
450         strcpy(hold_rm, CC->room.QRname);
451         if (CtdlGetRoom(&CC->room, SYSCONFIGROOM) != 0) {
452                 CtdlGetRoom(&CC->room, hold_rm);
453                 return NULL;
454         }
455
456         /* The new way: hunt for the message number in the config database */
457         msgnum = CtdlGetConfigLong(sysconfname);
458
459         /* Legacy format: hunt through the local system configuration room for a message with a matching MIME type */
460         if (msgnum <= 0) {
461                 begin_critical_section(S_CONFIG);
462                 config_msgnum = -1;
463                 CtdlForEachMessage(MSGS_LAST, 1, NULL, sysconfname, NULL, CtdlGetSysConfigBackend, NULL);
464                 msgnum = config_msgnum;
465                 end_critical_section(S_CONFIG);
466                 if (msgnum > 0) {
467                         CtdlSetConfigLong(sysconfname, msgnum);         // store it the new way so we don't have to do this again
468                 }
469         }
470
471         if (msgnum <= 0) {
472                 conf = NULL;
473         }
474         else {
475                 msg = CtdlFetchMessage(msgnum, 1);
476                 if (msg != NULL) {
477                         conf = strdup(msg->cm_fields[eMesageText]);
478                         CM_Free(msg);
479                 }
480                 else {
481                         conf = NULL;
482                 }
483         }
484
485         CtdlGetRoom(&CC->room, hold_rm);
486
487         if (conf != NULL) {             // Strip the MIME headers, leaving only the content
488                 do {
489                         extract_token(buf, conf, 0, '\n', sizeof buf);
490                         strcpy(conf, &conf[strlen(buf)+1]);
491                 } while ( (!IsEmptyStr(conf)) && (!IsEmptyStr(buf)) );
492         }
493
494         return(conf);
495 }
496
497
498 /*
499  * This is for storing longer configuration sets which are stored in the message base.
500  */
501 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata) {
502         long old_msgnum = -1;
503         long new_msgnum = -1;
504
505         // Search for the previous copy of this config item, so we can delete it
506         old_msgnum = CtdlGetConfigLong(sysconfname);
507
508         // Go ahead and save it, and write the new msgnum to the config database so we can find it again
509         new_msgnum = CtdlWriteObject(SYSCONFIGROOM, sysconfname, sysconfdata, (strlen(sysconfdata)+1), NULL, 0, 0);
510         if (new_msgnum > 0) {
511                 CtdlSetConfigLong(sysconfname, new_msgnum);
512
513                 // Now delete the old copy
514                 if (old_msgnum > 0) {
515                         CtdlDeleteMessages(SYSCONFIGROOM, &old_msgnum, 1, "");
516                 }
517         }
518 }