git.sur5r.net Git - bacula/bacula/blob - bacula/src/filed/filed_conf.c

   1 /*
   2  *   Main configuration file parser for Bacula File Daemon (Client)
   3  *    some parts may be split into separate files such as
   4  *    the schedule configuration (sch_config.c).
   5  *
   6  *   Note, the configuration file parser consists of three parts
   7  *
   8  *   1. The generic lexical scanner in lib/lex.c and lib/lex.h
   9  *
  10  *   2. The generic config  scanner in lib/parse_config.c and
  11  *      lib/parse_config.h.
  12  *      These files contain the parser code, some utility
  13  *      routines, and the common store routines (name, int,
  14  *      string).
  15  *
  16  *   3. The daemon specific file, which contains the Resource
  17  *      definitions as well as any specific store routines
  18  *      for the resource records.
  19  *
  20  *     Kern Sibbald, September MM
  21  *
  22  *   Version $Id$
  23  */
  24 /*
  25    Copyright (C) 2000-2005 Kern Sibbald
  26
  27    This program is free software; you can redistribute it and/or
  28    modify it under the terms of the GNU General Public License
  29    version 2 as amended with additional clauses defined in the
  30    file LICENSE in the main source directory.
  31
  32    This program is distributed in the hope that it will be useful,
  33    but WITHOUT ANY WARRANTY; without even the implied warranty of
  34    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  35    the file LICENSE for additional details.
  36
  37  */
  38
  39 #include "bacula.h"
  40 #include "filed.h"
  41
  42 /* Define the first and last resource ID record
  43  * types. Note, these should be unique for each
  44  * daemon though not a requirement.
  45  */
  46 int r_first = R_FIRST;
  47 int r_last  = R_LAST;
  48 static RES *sres_head[R_LAST - R_FIRST + 1];
  49 RES **res_head = sres_head;
  50
  51
  52 /* Forward referenced subroutines */
  53
  54
  55 /* We build the current resource here as we are
  56  * scanning the resource configuration definition,
  57  * then move it to allocated memory when the resource
  58  * scan is complete.
  59  */
  60 #if defined(HAVE_WIN32) && !defined(HAVE_CYGWIN)
  61 extern "C" { // work around visual compiler mangling variables
  62     URES res_all;
  63     int  res_all_size = sizeof(res_all);
  64 }
  65 #else
  66 URES res_all;
  67 int  res_all_size = sizeof(res_all);
  68 #endif
  69
  70 /* Definition of records permitted within each
  71  * resource with the routine to process the record
  72  * information.
  73  */
  74
  75 /* Client or File daemon "Global" resources */
  76 static RES_ITEM cli_items[] = {
  77    {"name",        store_name,  ITEM(res_client.hdr.name), 0, ITEM_REQUIRED, 0},
  78    {"description", store_str,   ITEM(res_client.hdr.desc), 0, 0, 0},
  79    {"fdport",      store_addresses_port,    ITEM(res_client.FDaddrs),  0, ITEM_DEFAULT, 9102},
  80    {"fdaddress",   store_addresses_address, ITEM(res_client.FDaddrs),  0, ITEM_DEFAULT, 9102},
  81    {"fdaddresses", store_addresses,         ITEM(res_client.FDaddrs),  0, ITEM_DEFAULT, 9102},
  82
  83    {"workingdirectory",  store_dir, ITEM(res_client.working_directory), 0, ITEM_REQUIRED, 0},
  84    {"piddirectory",  store_dir,     ITEM(res_client.pid_directory),     0, ITEM_REQUIRED, 0},
  85    {"subsysdirectory",  store_dir,  ITEM(res_client.subsys_directory),  0, 0, 0},
  86    {"scriptsdirectory",  store_dir,  ITEM(res_client.scripts_directory),  0, 0, 0},
  87    {"maximumconcurrentjobs", store_pint,  ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 10},
  88    {"messages",      store_res, ITEM(res_client.messages), R_MSGS, 0, 0},
  89    {"heartbeatinterval", store_time, ITEM(res_client.heartbeat_interval), 0, ITEM_DEFAULT, 0},
  90    {"sdconnecttimeout", store_time,ITEM(res_client.SDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
  91    {"maximumnetworkbuffersize", store_pint, ITEM(res_client.max_network_buffer_size), 0, 0, 0},
  92    {"pkisignatures",         store_yesno,     ITEM(res_client.pki_sign), 1, ITEM_DEFAULT, 0},
  93    {"pkiencryption",         store_yesno,     ITEM(res_client.pki_encrypt), 1, ITEM_DEFAULT, 0},
  94    {"pkikeypair",            store_dir,       ITEM(res_client.pki_keypairfile), 0, 0, 0},
  95    {"pkitrustedsigner",      store_alist_str, ITEM(res_client.pki_trustedkeys), 0, 0, 0},
  96    {"pkimasterkey",          store_alist_str, ITEM(res_client.pki_masterkeys), 0, 0, 0},
  97    {"tlsenable",             store_yesno,     ITEM(res_client.tls_enable),  1, 0, 0},
  98    {"tlsrequire",            store_yesno,     ITEM(res_client.tls_require), 1, 0, 0},
  99    {"tlscacertificatefile",  store_dir,       ITEM(res_client.tls_ca_certfile), 0, 0, 0},
 100    {"tlscacertificatedir",   store_dir,       ITEM(res_client.tls_ca_certdir), 0, 0, 0},
 101    {"tlscertificate",        store_dir,       ITEM(res_client.tls_certfile), 0, 0, 0},
 102    {"tlskey",                store_dir,       ITEM(res_client.tls_keyfile), 0, 0, 0},
 103    {NULL, NULL, NULL, 0, 0, 0}
 104 };
 105
 106 /* Directors that can use our services */
 107 static RES_ITEM dir_items[] = {
 108    {"name",        store_name,     ITEM(res_dir.hdr.name),  0, ITEM_REQUIRED, 0},
 109    {"description", store_str,      ITEM(res_dir.hdr.desc),  0, 0, 0},
 110    {"password",    store_password, ITEM(res_dir.password),  0, ITEM_REQUIRED, 0},
 111    {"address",     store_str,      ITEM(res_dir.address),   0, 0, 0},
 112    {"monitor",     store_yesno,    ITEM(res_dir.monitor),   1, ITEM_DEFAULT, 0},
 113    {"tlsenable",            store_yesno,     ITEM(res_dir.tls_enable), 1, 0, 0},
 114    {"tlsrequire",           store_yesno,     ITEM(res_dir.tls_require), 1, 0, 0},
 115    {"tlsverifypeer",        store_yesno,     ITEM(res_dir.tls_verify_peer), 1, ITEM_DEFAULT, 1},
 116    {"tlscacertificatefile", store_dir,       ITEM(res_dir.tls_ca_certfile), 0, 0, 0},
 117    {"tlscacertificatedir",  store_dir,       ITEM(res_dir.tls_ca_certdir), 0, 0, 0},
 118    {"tlscertificate",       store_dir,       ITEM(res_dir.tls_certfile), 0, 0, 0},
 119    {"tlskey",               store_dir,       ITEM(res_dir.tls_keyfile), 0, 0, 0},
 120    {"tlsdhfile",            store_dir,       ITEM(res_dir.tls_dhfile), 0, 0, 0},
 121    {"tlsallowedcn",         store_alist_str, ITEM(res_dir.tls_allowed_cns), 0, 0, 0},
 122    {NULL, NULL, NULL, 0, 0, 0}
 123 };
 124
 125 /* Message resource */
 126 extern RES_ITEM msgs_items[];
 127
 128 /*
 129  * This is the master resource definition.
 130  * It must have one item for each of the resources.
 131  */
 132 RES_TABLE resources[] = {
 133    {"director",      dir_items,   R_DIRECTOR},
 134    {"filedaemon",    cli_items,   R_CLIENT},
 135    {"client",        cli_items,   R_CLIENT},     /* alias for filedaemon */
 136    {"messages",      msgs_items,  R_MSGS},
 137    {NULL,            NULL,        0}
 138 };
 139
 140
 141 /* Dump contents of resource */
 142 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
 143 {
 144    URES *res = (URES *)reshdr;
 145    int recurse = 1;
 146
 147    if (res == NULL) {
 148       sendit(sock, "No record for %d %s\n", type, res_to_str(type));
 149       return;
 150    }
 151    if (type < 0) {                    /* no recursion */
 152       type = - type;
 153       recurse = 0;
 154    }
 155    switch (type) {
 156       case R_DIRECTOR:
 157          sendit(sock, "Director: name=%s password=%s\n", reshdr->name,
 158                  res->res_dir.password);
 159          break;
 160       case R_CLIENT:
 161          sendit(sock, "Client: name=%s FDport=%d\n", reshdr->name,
 162                  get_first_port_host_order(res->res_client.FDaddrs));
 163          break;
 164       case R_MSGS:
 165          sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
 166          if (res->res_msgs.mail_cmd)
 167             sendit(sock, "      mailcmd=%s\n", res->res_msgs.mail_cmd);
 168          if (res->res_msgs.operator_cmd)
 169             sendit(sock, "      opcmd=%s\n", res->res_msgs.operator_cmd);
 170          break;
 171       default:
 172          sendit(sock, "Unknown resource type %d\n", type);
 173    }
 174    if (recurse && res->res_dir.hdr.next)
 175       dump_resource(type, res->res_dir.hdr.next, sendit, sock);
 176 }
 177
 178 /*
 179  * Free memory of resource.
 180  * NB, we don't need to worry about freeing any references
 181  * to other resources as they will be freed when that
 182  * resource chain is traversed.  Mainly we worry about freeing
 183  * allocated strings (names).
 184  */
 185 void free_resource(RES *sres, int type)
 186 {
 187    RES *nres;
 188    URES *res = (URES *)sres;
 189
 190    if (res == NULL) {
 191       return;
 192    }
 193
 194    /* common stuff -- free the resource name */
 195    nres = (RES *)res->res_dir.hdr.next;
 196    if (res->res_dir.hdr.name) {
 197       free(res->res_dir.hdr.name);
 198    }
 199    if (res->res_dir.hdr.desc) {
 200       free(res->res_dir.hdr.desc);
 201    }
 202    switch (type) {
 203    case R_DIRECTOR:
 204       if (res->res_dir.password) {
 205          free(res->res_dir.password);
 206       }
 207       if (res->res_dir.address) {
 208          free(res->res_dir.address);
 209       }
 210       if (res->res_dir.tls_ctx) {
 211          free_tls_context(res->res_dir.tls_ctx);
 212       }
 213       if (res->res_dir.tls_ca_certfile) {
 214          free(res->res_dir.tls_ca_certfile);
 215       }
 216       if (res->res_dir.tls_ca_certdir) {
 217          free(res->res_dir.tls_ca_certdir);
 218       }
 219       if (res->res_dir.tls_certfile) {
 220          free(res->res_dir.tls_certfile);
 221       }
 222       if (res->res_dir.tls_keyfile) {
 223          free(res->res_dir.tls_keyfile);
 224       }
 225       if (res->res_dir.tls_dhfile) {
 226          free(res->res_dir.tls_dhfile);
 227       }
 228       if (res->res_dir.tls_allowed_cns) {
 229          delete res->res_dir.tls_allowed_cns;
 230       }
 231       break;
 232    case R_CLIENT:
 233       if (res->res_client.working_directory) {
 234          free(res->res_client.working_directory);
 235       }
 236       if (res->res_client.pid_directory) {
 237          free(res->res_client.pid_directory);
 238       }
 239       if (res->res_client.subsys_directory) {
 240          free(res->res_client.subsys_directory);
 241       }
 242       if (res->res_client.scripts_directory) {
 243          free(res->res_client.scripts_directory);
 244       }
 245       if (res->res_client.FDaddrs) {
 246          free_addresses(res->res_client.FDaddrs);
 247       }
 248       if (res->res_client.pki_keypairfile) {
 249          free(res->res_client.pki_keypairfile);
 250       }
 251       if (res->res_client.pki_keypair) {
 252          crypto_keypair_free(res->res_client.pki_keypair);
 253       }
 254       /* Also frees res_client.pki_keypair */
 255       if (res->res_client.pki_trustedkeys) {
 256          delete res->res_client.pki_trustedkeys;
 257       }
 258       if (res->res_client.pki_signers) {
 259          X509_KEYPAIR *keypair;
 260          foreach_alist(keypair, res->res_client.pki_signers) {
 261             crypto_keypair_free(keypair);
 262          }
 263          delete res->res_client.pki_signers;
 264       }
 265       if (res->res_client.pki_masterkeys) {
 266          delete res->res_client.pki_masterkeys;
 267       }
 268       if (res->res_client.pki_readers) {
 269          X509_KEYPAIR *keypair;
 270          foreach_alist(keypair, res->res_client.pki_readers) {
 271             crypto_keypair_free(keypair);
 272          }
 273          delete res->res_client.pki_signers;
 274       }
 275
 276       if (res->res_client.tls_ctx) {
 277          free_tls_context(res->res_client.tls_ctx);
 278       }
 279       if (res->res_client.tls_ca_certfile) {
 280          free(res->res_client.tls_ca_certfile);
 281       }
 282       if (res->res_client.tls_ca_certdir) {
 283          free(res->res_client.tls_ca_certdir);
 284       }
 285       if (res->res_client.tls_certfile) {
 286          free(res->res_client.tls_certfile);
 287       }
 288       if (res->res_client.tls_keyfile) {
 289          free(res->res_client.tls_keyfile);
 290       }
 291       break;
 292    case R_MSGS:
 293       if (res->res_msgs.mail_cmd)
 294          free(res->res_msgs.mail_cmd);
 295       if (res->res_msgs.operator_cmd)
 296          free(res->res_msgs.operator_cmd);
 297       free_msgs_res((MSGS *)res);  /* free message resource */
 298       res = NULL;
 299       break;
 300    default:
 301       printf(_("Unknown resource type %d\n"), type);
 302    }
 303    /* Common stuff again -- free the resource, recurse to next one */
 304    if (res) {
 305       free(res);
 306    }
 307    if (nres) {
 308       free_resource(nres, type);
 309    }
 310 }
 311
 312 /* Save the new resource by chaining it into the head list for
 313  * the resource. If this is pass 2, we update any resource
 314  * pointers (currently only in the Job resource).
 315  */
 316 void save_resource(int type, RES_ITEM *items, int pass)
 317 {
 318    URES *res;
 319    int rindex = type - r_first;
 320    int i, size;
 321    int error = 0;
 322
 323    /*
 324     * Ensure that all required items are present
 325     */
 326    for (i=0; items[i].name; i++) {
 327       if (items[i].flags & ITEM_REQUIRED) {
 328             if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
 329                Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
 330                  items[i].name, resources[rindex]);
 331              }
 332       }
 333    }
 334
 335    /* During pass 2, we looked up pointers to all the resources
 336     * referrenced in the current resource, , now we
 337     * must copy their address from the static record to the allocated
 338     * record.
 339     */
 340    if (pass == 2) {
 341       switch (type) {
 342          /* Resources not containing a resource */
 343          case R_MSGS:
 344             break;
 345
 346          /* Resources containing another resource */
 347          case R_DIRECTOR:
 348             if ((res = (URES *)GetResWithName(R_DIRECTOR, res_all.res_dir.hdr.name)) == NULL) {
 349                Emsg1(M_ABORT, 0, _("Cannot find Director resource %s\n"), res_all.res_dir.hdr.name);
 350             }
 351             res->res_dir.tls_allowed_cns = res_all.res_dir.tls_allowed_cns;
 352             break;
 353          case R_CLIENT:
 354             if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_dir.hdr.name)) == NULL) {
 355                Emsg1(M_ABORT, 0, _("Cannot find Client resource %s\n"), res_all.res_dir.hdr.name);
 356             }
 357             res->res_client.pki_trustedkeys = res_all.res_client.pki_trustedkeys;
 358             res->res_client.pki_signers = res_all.res_client.pki_signers;
 359             res->res_client.messages = res_all.res_client.messages;
 360             break;
 361          default:
 362             Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
 363             error = 1;
 364             break;
 365       }
 366       /* Note, the resoure name was already saved during pass 1,
 367        * so here, we can just release it.
 368        */
 369       if (res_all.res_dir.hdr.name) {
 370          free(res_all.res_dir.hdr.name);
 371          res_all.res_dir.hdr.name = NULL;
 372       }
 373       if (res_all.res_dir.hdr.desc) {
 374          free(res_all.res_dir.hdr.desc);
 375          res_all.res_dir.hdr.desc = NULL;
 376       }
 377       return;
 378    }
 379
 380    /* The following code is only executed on pass 1 */
 381    switch (type) {
 382       case R_DIRECTOR:
 383          size = sizeof(DIRRES);
 384          break;
 385       case R_CLIENT:
 386          size = sizeof(CLIENT);
 387          break;
 388       case R_MSGS:
 389          size = sizeof(MSGS);
 390          break;
 391       default:
 392          printf(_("Unknown resource type %d\n"), type);
 393          error = 1;
 394          size = 1;
 395          break;
 396    }
 397    /* Common */
 398    if (!error) {
 399       res = (URES *)malloc(size);
 400       memcpy(res, &res_all, size);
 401       if (!res_head[rindex]) {
 402          res_head[rindex] = (RES *)res; /* store first entry */
 403       } else {
 404          RES *next;
 405          /* Add new res to end of chain */
 406          for (next=res_head[rindex]; next->next; next=next->next) {
 407             if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
 408                Emsg2(M_ERROR_TERM, 0,
 409                   _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
 410                   resources[rindex].name, res->res_dir.hdr.name);
 411             }
 412          }
 413          next->next = (RES *)res;
 414          Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
 415                res->res_dir.hdr.name);
 416       }
 417    }
 418 }