onak-conf.c

   1 /*
   2  * onak-conf.c - Routines related to runtime config.
   3  *
   4  * Copyright 2002,2012 Jonathan McDowell <noodles@earth.li>
   5  *
   6  * This program is free software: you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the Free
   8  * Software Foundation; version 2 of the License.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program.  If not, see <https://www.gnu.org/licenses/>.
  17  */
  18 #include <ctype.h>
  19 #include <stdio.h>
  20 #include <stdlib.h>
  21 #include <string.h>
  22 #include <strings.h>
  23
  24 #include "build-config.h"
  25
  26 #include "cleankey.h"
  27 #include "ll.h"
  28 #include "log.h"
  29 #include "onak-conf.h"
  30
  31 #ifdef DBINIT
  32 extern struct onak_dbctx *DBINIT(struct onak_db_config *dbcfg, bool readonly);
  33 #endif
  34
  35 /*
  36  *      config - Runtime configuration for onak.
  37  *
  38  *      This is the default config; normally overridden with values from the
  39  *      config file.
  40  */
  41 struct onak_config config = {
  42         .maxkeys = 128,
  43         .thissite = NULL,
  44         .adminemail = NULL,
  45         .mta = NULL,
  46         .syncsites = NULL,
  47         .logfile = NULL,
  48
  49         .use_keyd = false,
  50         .sock_dir = NULL,
  51
  52         .backends = NULL,
  53         .backends_dir = NULL,
  54
  55 #ifdef DBINIT
  56         .dbinit = DBINIT,
  57 #else
  58         .dbinit = NULL,
  59 #endif
  60
  61         .clean_policies = ONAK_CLEAN_DROP_V3_KEYS | ONAK_CLEAN_CHECK_SIGHASH,
  62
  63         .bin_dir = NULL,
  64         .mail_dir = NULL,
  65 };
  66
  67 struct onak_db_config *find_db_backend_config(struct ll *backends, char *name)
  68 {
  69         struct ll *cur;
  70
  71         cur = backends;
  72         while (cur != NULL && strcmp(name,
  73                         ((struct onak_db_config *) cur->object)->name)) {
  74                 cur = cur->next;
  75         }
  76
  77         return (cur != NULL) ? (struct onak_db_config *) cur->object : NULL;
  78 }
  79
  80 bool parsebool(char *str, bool fallback)
  81 {
  82         if (!strcasecmp(str, "false") || !strcasecmp(str, "no") ||
  83                         !strcasecmp(str, "0")) {
  84                 return false;
  85         } else if (!strcasecmp(str, "true") || !strcasecmp(str, "yes") ||
  86                         !strcasecmp(str, "1")) {
  87                 return true;
  88         } else {
  89                 logthing(LOGTHING_CRITICAL,
  90                         "Couldn't parse %s as a boolean config variable, "
  91                         "returning fallback of '%s'.",
  92                         str,
  93                         fallback ? "true" : "false");
  94                 return fallback;
  95         }
  96 }
  97
  98 /*
  99  * Parse an old pksd style config line, as used in onak 0.4.6 and earlier.
 100  */
 101 static bool parseoldconfigline(char *line)
 102 {
 103         if (line[0] == '#' || line[0] == 0) {
 104                 /*
 105                  * Comment line, ignore.
 106                  */
 107         } else if (!strncmp("db_dir ", line, 7)) {
 108                 config.backend->location = strdup(&line[7]);
 109         } else if (!strncmp("debug ", line, 6)) {
 110                 /*
 111                  * Not supported yet; ignore for compatibility with
 112                  * pksd.
 113                  */
 114         } else if (!strncmp("default_language ", line, 17)) {
 115                 /*
 116                  * Not supported yet; ignore for compatibility with
 117                  * pksd.
 118                  */
 119         } else if (!strncmp("mail_delivery_client ", line, 21)) {
 120                 config.mta = strdup(&line[21]);
 121         } else if (!strncmp("maintainer_email ", line, 17)) {
 122                 config.adminemail = strdup(&line[17]);
 123         } else if (!strncmp("mail_intro_file ", line, 16)) {
 124                 /*
 125                  * Not supported yet; ignore for compatibility with
 126                  * pksd.
 127                  */
 128         } else if (!strncmp("help_dir ", line, 9)) {
 129                 /*
 130                  * Not supported yet; ignore for compatibility with
 131                  * pksd.
 132                  */
 133         } else if (!strncmp("max_last ", line, 9)) {
 134                 /*
 135                  * Not supported yet; ignore for compatibility with
 136                  * pksd.
 137                  */
 138         } else if (!strncmp("max_reply_keys ", line, 15)) {
 139                 config.maxkeys = atoi(&line[15]);
 140         } else if (!strncmp("pg_dbhost ", line, 10)) {
 141                 config.backend->hostname = strdup(&line[10]);
 142         } else if (!strncmp("pg_dbname ", line, 10)) {
 143                 config.backend->location = strdup(&line[10]);
 144         } else if (!strncmp("pg_dbuser ", line, 10)) {
 145                 config.backend->username = strdup(&line[10]);
 146         } else if (!strncmp("pg_dbpass ", line, 10)) {
 147                 config.backend->password = strdup(&line[10]);
 148         } else if (!strncmp("syncsite ", line, 9)) {
 149                 config.syncsites =
 150                         lladd(config.syncsites, strdup(&line[9]));
 151         } else if (!strncmp("logfile ", line, 8)) {
 152                 config.logfile = strdup(&line[8]);
 153         } else if (!strncmp("loglevel ", line, 9)) {
 154                 setlogthreshold(atoi(&line[9]));
 155         } else if (!strncmp("this_site ", line, 10)) {
 156                 config.thissite = strdup(&line[10]);
 157         } else if (!strncmp("socket_name ", line, 12) ||
 158                         !strncmp("www_port ", line, 9)) {
 159                 /*
 160                  * Not applicable; ignored for compatibility with pksd.
 161                  */
 162         } else if (!strncmp("pks_bin_dir ", line, 12)) {
 163                 config.bin_dir = strdup(&line[12]);
 164         } else if (!strncmp("mail_dir ", line, 9)) {
 165                 config.mail_dir = strdup(&line[9]);
 166         } else if (!strncmp("db_backend ", line, 11)) {
 167                 config.backend->type = strdup(&line[11]);
 168                 config.backend->name = strdup(&line[11]);
 169                 config.db_backend = strdup(&line[11]);
 170         } else if (!strncmp("backends_dir ", line, 13)) {
 171                 config.backends_dir = strdup(&line[13]);
 172         } else if (!strncmp("use_keyd ", line, 9)) {
 173                 config.use_keyd = parsebool(&line[9],
 174                                         config.use_keyd);
 175         } else if (!strncmp("sock_dir ", line, 9)) {
 176                 config.sock_dir = strdup(&line[9]);
 177         } else if (!strncmp("check_sighash ", line, 9)) {
 178                 if (parsebool(&line[9], config.clean_policies &
 179                                         ONAK_CLEAN_CHECK_SIGHASH)) {
 180                         config.clean_policies |=
 181                                 ONAK_CLEAN_CHECK_SIGHASH;
 182                 } else {
 183                         config.clean_policies &=
 184                                 ~ONAK_CLEAN_CHECK_SIGHASH;
 185                 }
 186         } else {
 187                 return false;
 188         }
 189
 190         return true;
 191 }
 192
 193 /*
 194  * Parse a new style .ini config line, supporting [sections] and name=value
 195  * format.
 196  */
 197 static bool parseconfigline(char *line)
 198 {
 199         /* Yes, this means we're not re-entrant. */
 200         static char section[32] = "";
 201         struct onak_db_config *backend;
 202         size_t len;
 203         char *name, *value;
 204
 205         if (line[0] == '#' || line[0] == ';' ||
 206                         line[0] == 0) {
 207                 /*
 208                  * Comment line, ignore.
 209                  */
 210         } else if (line[0] == '[') {
 211                 /* Section name */
 212                 len = strlen(line);
 213                 if (line[len - 1] != ']') {
 214                         logthing(LOGTHING_CRITICAL,
 215                                 "Malformed section header '%s' in "
 216                                 "config file.", line);
 217                         return false;
 218                 }
 219                 if (len > sizeof(section)) {
 220                         logthing(LOGTHING_CRITICAL,
 221                                 "Section header '%s' is too long in "
 222                                 "config file.", line);
 223                         return false;
 224                 }
 225                 line[len - 1] = 0;
 226                 strncpy(section, &line[1], len);
 227         } else if ((value = strchr(line, '=')) != NULL) {
 228                 name = line;
 229                 *value++ = 0;
 230
 231                 /* We can have multiple backend: sections */
 232                 if (!strncmp(section, "backend:", 8)) {
 233                         backend = find_db_backend_config(
 234                                 config.backends, &section[8]);
 235                         if (backend == NULL) {
 236                                 backend = calloc(1,
 237                                         sizeof(struct onak_db_config));
 238                                 backend->name = strdup(&section[8]);
 239                                 config.backends = lladd(config.backends,
 240                                                         backend);
 241                         }
 242
 243                         if (!strcmp(name, "type")) {
 244                                 backend->type = strdup(value);
 245                         } else if (!strcmp(name, "location")) {
 246                                 backend->location = strdup(value);
 247                         } else if (!strcmp(name, "hostname")) {
 248                                 backend->location = strdup(value);
 249                         } else if (!strcmp(name, "username")) {
 250                                 backend->location = strdup(value);
 251                         } else if (!strcmp(name, "password")) {
 252                                 backend->location = strdup(value);
 253                         }
 254
 255 #define MATCH(s, n) !strcmp(section, s) && !strcmp(name, n)
 256                 /* [main] section */
 257                 } else if (MATCH("main", "backend")) {
 258                         config.db_backend = strdup(value);
 259                 } else if (MATCH("main", "backends_dir")) {
 260                         config.backends_dir = strdup(value);
 261                 } else if (MATCH("main", "logfile")) {
 262                         config.logfile = strdup(value);
 263                 } else if (MATCH("main", "loglevel")) {
 264                         setlogthreshold(atoi(value));
 265                 } else if (MATCH("main", "use_keyd")) {
 266                         config.use_keyd = parsebool(value,
 267                                         config.use_keyd);
 268                 } else if (MATCH("main", "sock_dir")) {
 269                         config.sock_dir = strdup(value);
 270                 } else if (MATCH("main", "max_reply_keys")) {
 271                         config.maxkeys = atoi(value);
 272                 /* [mail] section */
 273                 } else if (MATCH("mail", "maintainer_email")) {
 274                         config.adminemail = strdup(value);
 275                 } else if (MATCH("mail", "mail_dir")) {
 276                 config.mail_dir = strdup(value);
 277                 } else if (MATCH("mail", "mta")) {
 278                         config.mta = strdup(value);
 279                 } else if (MATCH("mail", "bin_dir")) {
 280                         config.bin_dir = strdup(value);
 281                 } else if (MATCH("mail", "this_site")) {
 282                         config.thissite = strdup(value);
 283                 } else if (MATCH("mail", "syncsite")) {
 284                         config.syncsites = lladd(config.syncsites,
 285                                 strdup(value));
 286                 /* [verification] section */
 287                 } else if (MATCH("verification", "blacklist")) {
 288                         array_load(&config.blacklist, value);
 289                 } else if (MATCH("verification", "drop_v3")) {
 290                         if (parsebool(value, config.clean_policies &
 291                                         ONAK_CLEAN_DROP_V3_KEYS)) {
 292                                 config.clean_policies |=
 293                                         ONAK_CLEAN_DROP_V3_KEYS;
 294                         } else {
 295                                 config.clean_policies &=
 296                                         ~ONAK_CLEAN_DROP_V3_KEYS;
 297                         }
 298                 } else if (MATCH("verification", "check_sighash")) {
 299                         if (parsebool(value, config.clean_policies &
 300                                         ONAK_CLEAN_CHECK_SIGHASH)) {
 301                                 config.clean_policies |=
 302                                         ONAK_CLEAN_CHECK_SIGHASH;
 303                         } else {
 304                                 config.clean_policies &=
 305                                         ~ONAK_CLEAN_CHECK_SIGHASH;
 306                         }
 307                 } else if (MATCH("verification", "check_packet_size")) {
 308                         if (parsebool(value, config.clean_policies &
 309                                         ONAK_CLEAN_LARGE_PACKETS)) {
 310                                 config.clean_policies |=
 311                                         ONAK_CLEAN_LARGE_PACKETS;
 312                         } else {
 313                                 config.clean_policies &=
 314                                         ~ONAK_CLEAN_LARGE_PACKETS;
 315                         }
 316                 } else {
 317                         return false;
 318                 }
 319         } else {
 320                 return false;
 321         }
 322
 323         return true;
 324 }
 325
 326 void readconfig(const char *configfile) {
 327         FILE *conffile;
 328         char  curline[1024];
 329         int   i;
 330         char *dir, *conf;
 331         size_t len;
 332         struct onak_db_config *backend;
 333         bool oldstyle = false;
 334         bool res;
 335
 336         curline[1023] = 0;
 337
 338         /*
 339          * Try to find a config file to use. If one is explicitly provided,
 340          * use that. Otherwise look in $XDG_CONFIG_HOME, $HOME and finally
 341          * the build in configuration directory. We try an old style onak.conf
 342          * first and then the new style onak.ini if that wasn't found - this
 343          * is to prevent breaking existing installs on upgrade.
 344          */
 345         if (configfile == NULL) {
 346                 conffile = NULL;
 347                 if ((dir = getenv("XDG_CONFIG_HOME")) != NULL) {
 348                         /* dir + / + onak.conf + NUL */
 349                         len = strlen(dir) + 1 + 9 + 1;
 350                         conf = malloc(len);
 351                         snprintf(conf, len, "%s/onak.conf", dir);
 352                         conffile = fopen(conf, "r");
 353                         if (conffile == NULL) {
 354                                 /* Conveniently .ini is shorter than .conf */
 355                                 snprintf(conf, len, "%s/onak.ini", dir);
 356                                 conffile = fopen(conf, "r");
 357                         } else {
 358                                 oldstyle = true;
 359                         }
 360                         free(conf);
 361                 } else if ((dir = getenv("HOME")) != NULL) {
 362                         /* dir + /.config/onak.conf + NUL */
 363                         len = strlen(dir) + 18 + 1;
 364                         conf = malloc(len);
 365                         snprintf(conf, len, "%s/.config/onak.conf", dir);
 366                         conffile = fopen(conf, "r");
 367                         if (conffile == NULL) {
 368                                 /* Conveniently .ini is shorter than .conf */
 369                                 snprintf(conf, len, "%s/onak.ini", dir);
 370                                 conffile = fopen(conf, "r");
 371                         } else {
 372                                 oldstyle = true;
 373                         }
 374                         free(conf);
 375                 }
 376                 if (conffile == NULL) {
 377                         conffile = fopen(CONFIGDIR "/onak.conf", "r");
 378                         if (conffile == NULL) {
 379                                 conffile = fopen(CONFIGDIR "/onak.ini", "r");
 380                         } else {
 381                                 oldstyle = true;
 382                         }
 383                 }
 384         } else {
 385                 /*
 386                  * Explicitly provided config file; if the filename ends .conf
 387                  * assume it's old style.
 388                  */
 389                 len = strlen(configfile);
 390                 if (!strcmp(&configfile[len - 5], ".conf")) {
 391                         oldstyle = true;
 392                 }
 393                 conffile = fopen(configfile, "r");
 394         }
 395
 396         if (oldstyle) {
 397                 logthing(LOGTHING_CRITICAL, "Reading deprecated old-style "
 398                                 "configuration file. This will not be "
 399                                 "supported in the next release.");
 400         }
 401
 402         if (conffile != NULL) {
 403                 if (!fgets(curline, 1023, conffile)) {
 404                         logthing(LOGTHING_CRITICAL,
 405                                 "Problem reading configuration file.");
 406                         fclose(conffile);
 407                         return;
 408                 }
 409
 410                 if (oldstyle) {
 411                         /* Add a single DB configuration */
 412                         backend = calloc(1, sizeof(*backend));
 413                         config.backend = backend;
 414                         config.backends = lladd(NULL, backend);
 415                 }
 416
 417                 while (!feof(conffile)) {
 418                         /* Strip any trailing white space */
 419                         for (i = strlen(curline) - 1;
 420                                         i >= 0 && isspace(curline[i]);
 421                                         i--) {
 422                                 curline[i] = 0;
 423                         }
 424
 425                         /* Strip any leading white space */
 426                         i = 0;
 427                         while (curline[i] != 0 && isspace(curline[i])) {
 428                                 i++;
 429                         }
 430
 431                         if (oldstyle) {
 432                                 res = parseoldconfigline(&curline[i]);
 433                         } else {
 434                                 res = parseconfigline(&curline[i]);
 435                         }
 436                         if (!res) {
 437                                 logthing(LOGTHING_ERROR,
 438                                         "Unknown config line: %s", curline);
 439                         }
 440
 441                         if (!fgets(curline, 1023, conffile) &&
 442                                         !feof(conffile)) {
 443                                 logthing(LOGTHING_CRITICAL,
 444                                         "Problem reading configuration file.");
 445                                 break;
 446                         }
 447                 }
 448                 fclose(conffile);
 449
 450                 if (config.db_backend == NULL) {
 451                         logthing(LOGTHING_CRITICAL,
 452                                 "No database backend configured.");
 453                 } else if (!oldstyle) {
 454                         config.backend = find_db_backend_config(
 455                                 config.backends, config.db_backend);
 456                         if (config.backend == NULL) {
 457                                 logthing(LOGTHING_NOTICE,
 458                                         "Couldn't find configuration for %s "
 459                                         "backend.", config.db_backend);
 460                         }
 461                 }
 462         } else {
 463                 logthing(LOGTHING_NOTICE,
 464                                 "Couldn't open config file; using defaults.");
 465         }
 466 }
 467
 468 void writeconfig(const char *configfile)
 469 {
 470         FILE *conffile;
 471         struct ll *cur;
 472
 473         if (configfile) {
 474                 conffile = fopen(configfile, "w");
 475         } else {
 476                 conffile = stdout;
 477         }
 478
 479 #define WRITE_IF_NOT_NULL(c, s) if (c != NULL) { \
 480         fprintf(conffile, s "=%s\n", c); \
 481 }
 482 #define WRITE_BOOL(c, s) fprintf(conffile, s "=%s\n", s ? "true" : "false");
 483
 484         fprintf(conffile, "[main]\n");
 485         WRITE_IF_NOT_NULL(config.backend->name, "backend");
 486         WRITE_IF_NOT_NULL(config.backends_dir, "backends_dir");
 487         WRITE_IF_NOT_NULL(config.logfile, "logfile");
 488         fprintf(conffile, "loglevel=%d\n", getlogthreshold());
 489         WRITE_BOOL(config.use_keyd, "use_keyd");
 490         WRITE_IF_NOT_NULL(config.sock_dir, "sock_dir");
 491         fprintf(conffile, "max_reply_keys=%d\n", config.maxkeys);
 492         fprintf(conffile, "\n");
 493
 494         fprintf(conffile, "[verification]\n");
 495         WRITE_BOOL(config.clean_policies & ONAK_CLEAN_CHECK_SIGHASH,
 496                         "check_sighash");
 497         fprintf(conffile, "\n");
 498
 499         fprintf(conffile, "[mail]\n");
 500         WRITE_IF_NOT_NULL(config.adminemail, "maintainer_email");
 501         WRITE_IF_NOT_NULL(config.mail_dir, "mail_dir");
 502         WRITE_IF_NOT_NULL(config.mta, "mta");
 503         WRITE_IF_NOT_NULL(config.bin_dir, "bin_dir");
 504         WRITE_IF_NOT_NULL(config.thissite, "this_site");
 505
 506         cur = config.syncsites;
 507         while (cur != NULL) {
 508                 fprintf(conffile, "syncsite=%s\n", (char *) cur->object);
 509                 cur = cur->next;
 510         }
 511
 512         cur = config.backends;
 513         while (cur != NULL) {
 514                 struct onak_db_config *backend =
 515                         (struct onak_db_config *) cur->object;
 516                 fprintf(conffile, "\n[backend:%s]\n", backend->name);
 517                 WRITE_IF_NOT_NULL(backend->type, "type");
 518                 WRITE_IF_NOT_NULL(backend->location, "location");
 519                 WRITE_IF_NOT_NULL(backend->hostname, "hostname");
 520                 WRITE_IF_NOT_NULL(backend->username, "username");
 521                 WRITE_IF_NOT_NULL(backend->password, "password");
 522                 cur = cur->next;
 523         }
 524
 525         if (configfile) {
 526                 fclose(conffile);
 527         }
 528 }
 529
 530 void cleanupdbconfig(void *object)
 531 {
 532         struct onak_db_config *dbconfig = (struct onak_db_config *) object;
 533
 534         if (dbconfig->name != NULL) {
 535                 free(dbconfig->name);
 536                 dbconfig->name = NULL;
 537         }
 538         if (dbconfig->type != NULL) {
 539                 free(dbconfig->type);
 540                 dbconfig->type = NULL;
 541         }
 542         if (dbconfig->location != NULL) {
 543                 free(dbconfig->location);
 544                 dbconfig->location = NULL;
 545         }
 546         if (dbconfig->hostname != NULL) {
 547                 free(dbconfig->hostname);
 548                 dbconfig->hostname = NULL;
 549         }
 550         if (dbconfig->username != NULL) {
 551                 free(dbconfig->username);
 552                 dbconfig->username = NULL;
 553         }
 554         if (dbconfig->password != NULL) {
 555                 free(dbconfig->password);
 556                 dbconfig->password = NULL;
 557         }
 558
 559         free(dbconfig);
 560 }
 561
 562 void cleanupconfig(void) {
 563         /* Free any defined DB backend configuration first */
 564         llfree(config.backends, cleanupdbconfig);
 565         config.backends = NULL;
 566
 567         if (config.thissite != NULL) {
 568                 free(config.thissite);
 569                 config.thissite = NULL;
 570         }
 571         if (config.adminemail != NULL) {
 572                 free(config.adminemail);
 573                 config.adminemail = NULL;
 574         }
 575         if (config.mta != NULL) {
 576                 free(config.mta);
 577                 config.mta = NULL;
 578         }
 579         if (config.syncsites != NULL) {
 580                 llfree(config.syncsites, free);
 581                 config.syncsites = NULL;
 582         }
 583         if (config.logfile != NULL) {
 584                 free(config.logfile);
 585                 config.logfile = NULL;
 586         }
 587         if (config.db_backend != NULL) {
 588                 free(config.db_backend);
 589                 config.db_backend = NULL;
 590         }
 591         if (config.backends_dir != NULL) {
 592                 free(config.backends_dir);
 593                 config.backends_dir = NULL;
 594         }
 595         if (config.sock_dir != NULL) {
 596                 free(config.sock_dir);
 597                 config.sock_dir = NULL;
 598         }
 599         if (config.bin_dir != NULL) {
 600                 free(config.bin_dir);
 601                 config.bin_dir = NULL;
 602         }
 603         if (config.mail_dir != NULL) {
 604                 free(config.mail_dir);
 605                 config.mail_dir = NULL;
 606         }
 607         if (config.blacklist.count != 0) {
 608                 array_free(&config.blacklist);
 609         }
 610 }