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