1 // Read and write the system configuration database
3 // Copyright (c) 1987-2024 by the citadel.org team
5 // This program is open source software. Use, duplication, or disclosure
6 // is subject to the terms of the GNU General Public License, version 3.
13 #include <sys/utsname.h>
14 #include <libcitadel.h>
17 #include "ctdl_module.h"
19 long config_msgnum = 0;
20 HashList *ctdlconfig = NULL; // new configuration
23 void config_warn_if_port_unset(char *key, int default_port) {
24 int p = CtdlGetConfigInt(key);
25 if ((p < -1) || (p == 0) || (p > UINT16_MAX)) {
26 syslog(LOG_ERR, "config: setting %s is not -1 (disabled) or a valid TCP port - setting to default %d", key, default_port);
27 CtdlSetConfigInt(key, default_port);
32 void config_warn_if_empty(char *key) {
33 if (IsEmptyStr(CtdlGetConfigStr(key))) {
34 syslog(LOG_ERR, "config: setting %s is empty, but must not - check your config!", key);
39 void validate_config(void) {
41 // these shouldn't be empty
42 config_warn_if_empty("c_fqdn");
43 config_warn_if_empty("c_baseroom");
44 config_warn_if_empty("c_aideroom");
45 config_warn_if_empty("c_twitroom");
46 config_warn_if_empty("c_nodename");
48 // Sanity check for port bindings
49 config_warn_if_port_unset("c_smtp_port", 25);
50 config_warn_if_port_unset("c_pop3_port", 110);
51 config_warn_if_port_unset("c_imap_port", 143);
52 config_warn_if_port_unset("c_msa_port", 587);
53 config_warn_if_port_unset("c_port_number", 504);
54 config_warn_if_port_unset("c_smtps_port", 465);
55 config_warn_if_port_unset("c_pop3s_port", 995);
56 config_warn_if_port_unset("c_imaps_port", 993);
57 config_warn_if_port_unset("c_pftcpdict_port", -1);
58 config_warn_if_port_unset("c_xmpp_c2s_port", 5222);
59 config_warn_if_port_unset("c_xmpp_s2s_port", 5269);
60 config_warn_if_port_unset("c_nntp_port", 119);
61 config_warn_if_port_unset("c_nntps_port", 563);
63 if (getpwuid(ctdluid) == NULL) {
64 syslog(LOG_ERR, "config: uid (%d) does not exist ... citserver will run as root", ctdluid);
69 // The "host key" is a 100-byte random string that is used to do some persistent hashing.
70 // It must remain consistent throughout the lifetime of this Citadel installation
71 void generate_host_key(void) {
72 syslog(LOG_INFO, "config: generating a host key");
78 host_key[len] = random() % 0x7F;
79 } while (!isalnum(host_key[len]));
82 CtdlSetConfigStr("host_key", host_key);
86 // Put some sane default values into our configuration. Some will be overridden when we run setup.
87 void brand_new_installation_set_defaults(void) {
89 struct utsname my_utsname;
91 char detected_hostname[256];
93 // Determine our host name, in case we need to use it as a default
96 // set some sample/default values in place of blanks...
97 extract_token(detected_hostname, my_utsname.nodename, 0, '.', sizeof detected_hostname);
98 CtdlSetConfigStr("c_nodename", detected_hostname);
100 if ((he = gethostbyname(my_utsname.nodename)) != NULL) {
101 CtdlSetConfigStr("c_fqdn", he->h_name);
104 CtdlSetConfigStr("c_fqdn", my_utsname.nodename);
107 CtdlSetConfigStr("c_humannode", "Citadel Server");
108 CtdlSetConfigInt("c_initax", 4);
109 CtdlSetConfigStr("c_moreprompt", "<more>");
110 CtdlSetConfigStr("c_twitroom", "Trashcan");
111 CtdlSetConfigStr("c_baseroom", BASEROOM);
112 CtdlSetConfigStr("c_aideroom", "Aide");
113 CtdlSetConfigInt("c_sleeping", 900);
115 if (CtdlGetConfigInt("c_createax") == 0) {
116 CtdlSetConfigInt("c_createax", 3);
119 // Default port numbers for various services
120 CtdlSetConfigInt("c_port_number", 504);
121 CtdlSetConfigInt("c_smtp_port", 25);
122 CtdlSetConfigInt("c_pop3_port", 110);
123 CtdlSetConfigInt("c_imap_port", 143);
124 CtdlSetConfigInt("c_msa_port", 587);
125 CtdlSetConfigInt("c_smtps_port", 465);
126 CtdlSetConfigInt("c_pop3s_port", 995);
127 CtdlSetConfigInt("c_imaps_port", 993);
128 CtdlSetConfigInt("c_pftcpdict_port", -1);
129 CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
130 CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
131 CtdlSetConfigInt("c_nntp_port", 119);
132 CtdlSetConfigInt("c_nntps_port", 563);
134 // Prevent the "new installation, set defaults" behavior from occurring again
135 CtdlSetConfigLong("c_config_created_or_migrated", (long)time(NULL));
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 void migrate_legacy_config(struct legacy_config *lconfig) {
142 CtdlSetConfigStr( "c_nodename" , lconfig->c_nodename );
143 CtdlSetConfigStr( "c_fqdn" , lconfig->c_fqdn );
144 CtdlSetConfigStr( "c_humannode" , lconfig->c_humannode );
145 CtdlSetConfigInt( "c_creataide" , lconfig->c_creataide );
146 CtdlSetConfigInt( "c_sleeping" , lconfig->c_sleeping );
147 CtdlSetConfigInt( "c_initax" , lconfig->c_initax );
148 CtdlSetConfigInt( "c_regiscall" , lconfig->c_regiscall );
149 CtdlSetConfigInt( "c_twitdetect" , lconfig->c_twitdetect );
150 CtdlSetConfigStr( "c_twitroom" , lconfig->c_twitroom );
151 CtdlSetConfigStr( "c_moreprompt" , lconfig->c_moreprompt );
152 CtdlSetConfigInt( "c_restrict" , lconfig->c_restrict );
153 CtdlSetConfigStr( "c_site_location" , lconfig->c_site_location );
154 CtdlSetConfigStr( "c_sysadm" , lconfig->c_sysadm );
155 CtdlSetConfigInt( "c_maxsessions" , lconfig->c_maxsessions );
156 CtdlSetConfigStr( "c_ip_addr" , lconfig->c_ip_addr );
157 CtdlSetConfigInt( "c_port_number" , lconfig->c_port_number );
158 CtdlSetConfigInt( "c_ep_mode" , lconfig->c_ep.expire_mode );
159 CtdlSetConfigInt( "c_ep_value" , lconfig->c_ep.expire_value );
160 CtdlSetConfigInt( "c_userpurge" , lconfig->c_userpurge );
161 CtdlSetConfigInt( "c_roompurge" , lconfig->c_roompurge );
162 CtdlSetConfigStr( "c_logpages" , lconfig->c_logpages );
163 CtdlSetConfigInt( "c_createax" , lconfig->c_createax );
164 CtdlSetConfigLong( "c_maxmsglen" , lconfig->c_maxmsglen );
165 CtdlSetConfigInt( "c_min_workers" , lconfig->c_min_workers );
166 CtdlSetConfigInt( "c_max_workers" , lconfig->c_max_workers );
167 CtdlSetConfigInt( "c_pop3_port" , lconfig->c_pop3_port );
168 CtdlSetConfigInt( "c_smtp_port" , lconfig->c_smtp_port );
169 CtdlSetConfigInt( "c_rfc822_strict_from" , lconfig->c_rfc822_strict_from );
170 CtdlSetConfigInt( "c_aide_zap" , lconfig->c_aide_zap );
171 CtdlSetConfigInt( "c_imap_port" , lconfig->c_imap_port );
172 CtdlSetConfigLong( "c_net_freq" , lconfig->c_net_freq );
173 CtdlSetConfigInt( "c_disable_newu" , lconfig->c_disable_newu );
174 CtdlSetConfigInt( "c_enable_fulltext" , lconfig->c_enable_fulltext );
175 CtdlSetConfigStr( "c_baseroom" , lconfig->c_baseroom );
176 CtdlSetConfigStr( "c_aideroom" , lconfig->c_aideroom );
177 CtdlSetConfigInt( "c_purge_hour" , lconfig->c_purge_hour );
178 CtdlSetConfigInt( "c_mbxep_mode" , lconfig->c_mbxep.expire_mode );
179 CtdlSetConfigInt( "c_mbxep_value" , lconfig->c_mbxep.expire_value );
180 CtdlSetConfigStr( "c_ldap_host" , lconfig->c_ldap_host );
181 CtdlSetConfigInt( "c_ldap_port" , lconfig->c_ldap_port );
182 CtdlSetConfigStr( "c_ldap_base_dn" , lconfig->c_ldap_base_dn );
183 CtdlSetConfigStr( "c_ldap_bind_dn" , lconfig->c_ldap_bind_dn );
184 CtdlSetConfigStr( "c_ldap_bind_pw" , lconfig->c_ldap_bind_pw );
185 CtdlSetConfigInt( "c_msa_port" , lconfig->c_msa_port );
186 CtdlSetConfigInt( "c_imaps_port" , lconfig->c_imaps_port );
187 CtdlSetConfigInt( "c_pop3s_port" , lconfig->c_pop3s_port );
188 CtdlSetConfigInt( "c_smtps_port" , lconfig->c_smtps_port );
189 CtdlSetConfigInt( "c_allow_spoofing" , lconfig->c_allow_spoofing );
190 CtdlSetConfigInt( "c_journal_email" , lconfig->c_journal_email );
191 CtdlSetConfigInt( "c_journal_pubmsgs" , lconfig->c_journal_pubmsgs );
192 CtdlSetConfigStr( "c_journal_dest" , lconfig->c_journal_dest );
193 CtdlSetConfigStr( "c_default_cal_zone" , lconfig->c_default_cal_zone );
194 CtdlSetConfigInt( "c_pftcpdict_port" , lconfig->c_pftcpdict_port );
195 CtdlSetConfigInt( "c_auth_mode" , lconfig->c_auth_mode );
196 CtdlSetConfigInt( "c_rbl_at_greeting" , lconfig->c_rbl_at_greeting );
197 CtdlSetConfigStr( "c_pager_program" , lconfig->c_pager_program );
198 CtdlSetConfigInt( "c_imap_keep_from" , lconfig->c_imap_keep_from );
199 CtdlSetConfigInt( "c_xmpp_c2s_port" , lconfig->c_xmpp_c2s_port );
200 CtdlSetConfigInt( "c_xmpp_s2s_port" , lconfig->c_xmpp_s2s_port );
201 CtdlSetConfigLong( "c_pop3_fetch" , lconfig->c_pop3_fetch );
202 CtdlSetConfigLong( "c_pop3_fastest" , lconfig->c_pop3_fastest );
203 CtdlSetConfigInt( "c_spam_flag_only" , lconfig->c_spam_flag_only );
204 CtdlSetConfigInt( "c_guest_logins" , lconfig->c_guest_logins );
205 CtdlSetConfigInt( "c_nntp_port" , lconfig->c_nntp_port );
206 CtdlSetConfigInt( "c_nntps_port" , lconfig->c_nntps_port );
210 // Called during the initialization of Citadel server.
211 // It verifies the system's integrity and reads citadel.config into memory.
212 void initialize_config_system(void) {
215 struct legacy_config lconfig; // legacy configuration
216 ctdlconfig = NewHash(1, NULL); // set up the real config system
218 // Ensure that we are linked to the correct version of libcitadel
219 if (libcitadel_version_number() < LIBCITADEL_VERSION_NUMBER) {
220 fprintf(stderr, "You are running libcitadel version %d\n", libcitadel_version_number());
221 fprintf(stderr, "citserver was compiled against version %d\n", LIBCITADEL_VERSION_NUMBER);
222 exit(CTDLEXIT_LIBCITADEL);
225 memset(&lconfig, 0, sizeof(struct legacy_config));
226 cfp = fopen(file_citadel_config, "rb");
228 if (CtdlGetConfigLong("c_config_created_or_migrated") > 0) {
229 fprintf(stderr, "Citadel Server found BOTH legacy and new configurations present.\n");
230 fprintf(stderr, "Exiting to prevent data corruption.\n");
231 exit(CTDLEXIT_CONFIG);
233 rv = fread((char *) &lconfig, sizeof(struct legacy_config), 1, cfp);
236 "Warning: Found a legacy config file %s has unexpected size. \n",
241 migrate_legacy_config(&lconfig);
244 if (unlink(file_citadel_config) != 0) {
245 fprintf(stderr, "Unable to remove legacy config file %s after migrating it.\n", file_citadel_config);
246 fprintf(stderr, "Exiting to prevent data corruption.\n");
247 exit(CTDLEXIT_CONFIG);
250 // Prevent migration/initialization from happening again.
251 CtdlSetConfigLong("c_config_created_or_migrated", (long)time(NULL));
255 // New installation? Set up configuration
256 if (CtdlGetConfigLong("c_config_created_or_migrated") <= 0) {
257 brand_new_installation_set_defaults();
260 // Default maximum message length is 10 megabytes. This is site
261 // configurable. Also check to make sure the limit has not been
262 // set below 8192 bytes.
263 if (CtdlGetConfigLong("c_maxmsglen") <= 0) CtdlSetConfigLong("c_maxmsglen", 10485760);
264 if (CtdlGetConfigLong("c_maxmsglen") < 8192) CtdlSetConfigLong("c_maxmsglen", 8192);
266 // Default lower and upper limits on number of worker threads
267 if (CtdlGetConfigInt("c_min_workers") < 5) CtdlSetConfigInt("c_min_workers", 5); // min
268 if (CtdlGetConfigInt("c_max_workers") == 0) CtdlSetConfigInt("c_max_workers", 256); // default max
269 if (CtdlGetConfigInt("c_max_workers") < CtdlGetConfigInt("c_min_workers")) {
270 CtdlSetConfigInt("c_max_workers", CtdlGetConfigInt("c_min_workers")); // max >= min
273 // Networking more than once every five minutes just isn't sane
274 if (CtdlGetConfigLong("c_net_freq") == 0) CtdlSetConfigLong("c_net_freq", 3600); // once per hour default
275 if (CtdlGetConfigLong("c_net_freq") < 300) CtdlSetConfigLong("c_net_freq", 300); // minimum 5 minutes
277 // Same goes for POP3
278 if (CtdlGetConfigLong("c_pop3_fetch") == 0) CtdlSetConfigLong("c_pop3_fetch", 3600); // once per hour default
279 if (CtdlGetConfigLong("c_pop3_fetch") < 300) CtdlSetConfigLong("c_pop3_fetch", 300); // 5 minutes min
280 if (CtdlGetConfigLong("c_pop3_fastest") == 0) CtdlSetConfigLong("c_pop3_fastest", 3600); // once per hour default
281 if (CtdlGetConfigLong("c_pop3_fastest") < 300) CtdlSetConfigLong("c_pop3_fastest", 300); // 5 minutes min
283 // LDAP sync frequency
284 if (CtdlGetConfigLong("c_ldap_sync_freq") == 0) CtdlSetConfigLong("c_ldap_sync_freq", 300); // every 5 minutes default
286 // "create new user" only works with native authentication mode
287 if (CtdlGetConfigInt("c_auth_mode") != AUTHMODE_NATIVE) {
288 CtdlSetConfigInt("c_disable_newu", 1);
291 // If we do not have a host key, generate one now, and save it.
292 if (IsEmptyStr(CtdlGetConfigStr("host_key"))) {
298 // Called when Citadel server is shutting down.
299 // Clears out the config hash table.
300 void shutdown_config_system(void) {
301 DeleteHash(&ctdlconfig);
305 // Set a system config value. Simple key/value here.
306 void CtdlSetConfigStr(char *key, char *value) {
307 int key_len = strlen(key);
308 int value_len = strlen(value);
311 Put(ctdlconfig, key, key_len, strdup(value), NULL);
313 // Also write it to the config database
315 int dbv_size = key_len + value_len + 2;
316 char *dbv = malloc(dbv_size);
318 strcpy(&dbv[key_len + 1], value);
319 cdb_store(CDB_CONFIG, key, key_len, dbv, dbv_size);
324 // Set a numeric system config value (long integer)
325 void CtdlSetConfigLong(char *key, long value) {
327 sprintf(longstr, "%ld", value);
328 CtdlSetConfigStr(key, longstr);
332 // Set a numeric system config value (integer)
333 void CtdlSetConfigInt(char *key, int value) {
335 sprintf(intstr, "%d", value);
336 CtdlSetConfigStr(key, intstr);
340 // Delete a system config value.
341 void CtdlDelConfig(char *key) {
342 int key_len = strlen(key);
344 if (IsEmptyStr(key)) return;
346 // Delete from the database.
347 cdb_delete(CDB_CONFIG, key, key_len);
349 // Delete from the in-memory cache
350 HashPos *Pos = GetNewHashPos(ctdlconfig, 1);
351 if (GetHashPosFromKey(ctdlconfig, key, key_len, Pos)) {
352 DeleteEntryFromHash(ctdlconfig, Pos);
356 assert(Pos == NULL); // no memory leaks allowed
360 // Fetch a system config value. Caller does *not* own the returned value and may not alter it.
361 char *CtdlGetConfigStr(char *key) {
364 int key_len = strlen(key);
366 if (IsEmptyStr(key)) return(NULL);
368 // First look in memory
369 if (GetHash(ctdlconfig, key, key_len, (void *)&value)) {
373 // Then look in the database.
374 cdb = cdb_fetch(CDB_CONFIG, key, key_len);
375 if (cdb.ptr == NULL) { // nope, not there either.
379 // Got it. Save it in memory for the next fetch.
380 value = strdup(cdb.ptr + key_len + 1); // The key was stored there too; skip past it
381 Put(ctdlconfig, key, key_len, value, NULL);
386 // Fetch a system config value - integer
387 int CtdlGetConfigInt(char *key) {
388 char *s = CtdlGetConfigStr(key);
389 if (s) return atoi(s);
394 // Fetch a system config value - long integer
395 long CtdlGetConfigLong(char *key) {
396 char *s = CtdlGetConfigStr(key);
397 if (s) return atol(s);
402 void CtdlGetSysConfigBackend(long msgnum, void *userdata) {
403 config_msgnum = msgnum;
407 // This is for fetching longer configuration sets which are stored in the message base.
408 char *CtdlGetSysConfig(char *sysconfname) {
409 char hold_rm[ROOMNAMELEN];
412 struct CtdlMessage *msg;
415 strcpy(hold_rm, CC->room.QRname);
416 if (CtdlGetRoom(&CC->room, SYSCONFIGROOM) != 0) {
417 CtdlGetRoom(&CC->room, hold_rm);
421 // The new way: hunt for the message number in the config database
422 msgnum = CtdlGetConfigLong(sysconfname);
424 // Legacy format: hunt through the local system configuration room for a message with a matching MIME type
426 begin_critical_section(S_CONFIG);
428 CtdlForEachMessage(MSGS_LAST, 1, NULL, sysconfname, NULL, CtdlGetSysConfigBackend, NULL);
429 msgnum = config_msgnum;
430 end_critical_section(S_CONFIG);
432 CtdlSetConfigLong(sysconfname, msgnum); // store it the new way so we don't have to do this again
440 msg = CtdlFetchMessage(msgnum, 1);
442 conf = strdup(msg->cm_fields[eMesageText]);
450 CtdlGetRoom(&CC->room, hold_rm);
452 if (conf != NULL) { // Strip the MIME headers, leaving only the content
454 extract_token(buf, conf, 0, '\n', sizeof buf);
455 strcpy(conf, &conf[strlen(buf)+1]);
456 } while ( (!IsEmptyStr(conf)) && (!IsEmptyStr(buf)) );
463 // This is for storing longer configuration sets which are stored in the message base.
464 void CtdlPutSysConfig(char *sysconfname, char *sysconfdata) {
465 long old_msgnum = -1;
466 long new_msgnum = -1;
468 // Search for the previous copy of this config item, so we can delete it
469 old_msgnum = CtdlGetConfigLong(sysconfname);
471 // Go ahead and save it, and write the new msgnum to the config database so we can find it again
472 new_msgnum = CtdlWriteObject(SYSCONFIGROOM, sysconfname, sysconfdata, (strlen(sysconfdata)+1), NULL, 0, 0);
473 if (new_msgnum > 0) {
474 CtdlSetConfigLong(sysconfname, new_msgnum);
476 // Now delete the old copy
477 if (old_msgnum > 0) {
478 CtdlDeleteMessages(SYSCONFIGROOM, &old_msgnum, 1, "");