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

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