2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
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
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.
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
23 Bacula® is a registered trademark of John Walker.
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.
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).
33 * Note, the configuration file parser consists of three parts
35 * 1. The generic lexical scanner in lib/lex.c and lib/lex.h
37 * 2. The generic config scanner in lib/parse_config.c and
39 * These files contain the parser code, some utility
40 * routines, and the common store routines (name, int,
43 * 3. The daemon specific file, which contains the Resource
44 * definitions as well as any specific store routines
45 * for the resource records.
47 * Kern Sibbald, September MM
55 /* Define the first and last resource ID record
56 * types. Note, these should be unique for each
57 * daemon though not a requirement.
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;
65 /* Forward referenced subroutines */
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
74 extern "C" { // work around visual compiler mangling variables
80 int32_t res_all_size = sizeof(res_all);
82 /* Definition of records permitted within each
83 * resource with the routine to process the record
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},
95 {"workingdirectory", store_dir, ITEM(res_client.working_directory), 0, ITEM_REQUIRED, 0},
96 {"piddirectory", store_dir, ITEM(res_client.pid_directory), 0, ITEM_REQUIRED, 0},
97 {"subsysdirectory", store_dir, ITEM(res_client.subsys_directory), 0, 0, 0},
98 {"plugindirectory", store_dir, ITEM(res_client.plugin_directory), 0, 0, 0},
99 {"scriptsdirectory", store_dir, ITEM(res_client.scripts_directory), 0, 0, 0},
100 {"maximumconcurrentjobs", store_pint32, ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 20},
101 {"messages", store_res, ITEM(res_client.messages), R_MSGS, 0, 0},
102 {"sdconnecttimeout", store_time,ITEM(res_client.SDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
103 {"heartbeatinterval", store_time, ITEM(res_client.heartbeat_interval), 0, ITEM_DEFAULT, 0},
104 {"maximumnetworkbuffersize", store_pint32, ITEM(res_client.max_network_buffer_size), 0, 0, 0},
105 #ifdef DATA_ENCRYPTION
106 {"pkisignatures", store_bool, ITEM(res_client.pki_sign), 0, ITEM_DEFAULT, 0},
107 {"pkiencryption", store_bool, ITEM(res_client.pki_encrypt), 0, ITEM_DEFAULT, 0},
108 {"pkikeypair", store_dir, ITEM(res_client.pki_keypair_file), 0, 0, 0},
109 {"pkisigner", store_alist_str, ITEM(res_client.pki_signing_key_files), 0, 0, 0},
110 {"pkimasterkey", store_alist_str, ITEM(res_client.pki_master_key_files), 0, 0, 0},
112 {"tlsauthenticate", store_bool, ITEM(res_client.tls_authenticate), 0, 0, 0},
113 {"tlsenable", store_bool, ITEM(res_client.tls_enable), 0, 0, 0},
114 {"tlsrequire", store_bool, ITEM(res_client.tls_require), 0, 0, 0},
115 {"tlscacertificatefile", store_dir, ITEM(res_client.tls_ca_certfile), 0, 0, 0},
116 {"tlscacertificatedir", store_dir, ITEM(res_client.tls_ca_certdir), 0, 0, 0},
117 {"tlscertificate", store_dir, ITEM(res_client.tls_certfile), 0, 0, 0},
118 {"tlskey", store_dir, ITEM(res_client.tls_keyfile), 0, 0, 0},
119 {NULL, NULL, {0}, 0, 0, 0}
122 /* Directors that can use our services */
123 static RES_ITEM dir_items[] = {
124 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
125 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
126 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
127 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
128 {"monitor", store_bool, ITEM(res_dir.monitor), 0, ITEM_DEFAULT, 0},
129 {"tlsauthenticate", store_bool, ITEM(res_dir.tls_authenticate), 0, 0, 0},
130 {"tlsenable", store_bool, ITEM(res_dir.tls_enable), 0, 0, 0},
131 {"tlsrequire", store_bool, ITEM(res_dir.tls_require), 0, 0, 0},
132 {"tlsverifypeer", store_bool, ITEM(res_dir.tls_verify_peer), 0, ITEM_DEFAULT, 1},
133 {"tlscacertificatefile", store_dir, ITEM(res_dir.tls_ca_certfile), 0, 0, 0},
134 {"tlscacertificatedir", store_dir, ITEM(res_dir.tls_ca_certdir), 0, 0, 0},
135 {"tlscertificate", store_dir, ITEM(res_dir.tls_certfile), 0, 0, 0},
136 {"tlskey", store_dir, ITEM(res_dir.tls_keyfile), 0, 0, 0},
137 {"tlsdhfile", store_dir, ITEM(res_dir.tls_dhfile), 0, 0, 0},
138 {"tlsallowedcn", store_alist_str, ITEM(res_dir.tls_allowed_cns), 0, 0, 0},
139 {NULL, NULL, {0}, 0, 0, 0}
142 /* Message resource */
143 extern RES_ITEM msgs_items[];
146 * This is the master resource definition.
147 * It must have one item for each of the resources.
149 RES_TABLE resources[] = {
150 {"director", dir_items, R_DIRECTOR},
151 {"filedaemon", cli_items, R_CLIENT},
152 {"client", cli_items, R_CLIENT}, /* alias for filedaemon */
153 {"messages", msgs_items, R_MSGS},
158 /* Dump contents of resource */
159 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
161 URES *res = (URES *)reshdr;
165 sendit(sock, "No record for %d %s\n", type, res_to_str(type));
168 if (type < 0) { /* no recursion */
174 sendit(sock, "Director: name=%s password=%s\n", reshdr->name,
175 res->res_dir.password);
178 sendit(sock, "Client: name=%s FDport=%d\n", reshdr->name,
179 get_first_port_host_order(res->res_client.FDaddrs));
182 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
183 if (res->res_msgs.mail_cmd)
184 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
185 if (res->res_msgs.operator_cmd)
186 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
189 sendit(sock, "Unknown resource type %d\n", type);
191 if (recurse && res->res_dir.hdr.next) {
192 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
197 * Free memory of resource.
198 * NB, we don't need to worry about freeing any references
199 * to other resources as they will be freed when that
200 * resource chain is traversed. Mainly we worry about freeing
201 * allocated strings (names).
203 void free_resource(RES *sres, int type)
206 URES *res = (URES *)sres;
212 /* common stuff -- free the resource name */
213 nres = (RES *)res->res_dir.hdr.next;
214 if (res->res_dir.hdr.name) {
215 free(res->res_dir.hdr.name);
217 if (res->res_dir.hdr.desc) {
218 free(res->res_dir.hdr.desc);
222 if (res->res_dir.password) {
223 free(res->res_dir.password);
225 if (res->res_dir.address) {
226 free(res->res_dir.address);
228 if (res->res_dir.tls_ctx) {
229 free_tls_context(res->res_dir.tls_ctx);
231 if (res->res_dir.tls_ca_certfile) {
232 free(res->res_dir.tls_ca_certfile);
234 if (res->res_dir.tls_ca_certdir) {
235 free(res->res_dir.tls_ca_certdir);
237 if (res->res_dir.tls_certfile) {
238 free(res->res_dir.tls_certfile);
240 if (res->res_dir.tls_keyfile) {
241 free(res->res_dir.tls_keyfile);
243 if (res->res_dir.tls_dhfile) {
244 free(res->res_dir.tls_dhfile);
246 if (res->res_dir.tls_allowed_cns) {
247 delete res->res_dir.tls_allowed_cns;
251 if (res->res_client.working_directory) {
252 free(res->res_client.working_directory);
254 if (res->res_client.pid_directory) {
255 free(res->res_client.pid_directory);
257 if (res->res_client.subsys_directory) {
258 free(res->res_client.subsys_directory);
260 if (res->res_client.scripts_directory) {
261 free(res->res_client.scripts_directory);
263 if (res->res_client.plugin_directory) {
264 free(res->res_client.plugin_directory);
266 if (res->res_client.FDaddrs) {
267 free_addresses(res->res_client.FDaddrs);
270 if (res->res_client.pki_keypair_file) {
271 free(res->res_client.pki_keypair_file);
273 if (res->res_client.pki_keypair) {
274 crypto_keypair_free(res->res_client.pki_keypair);
277 if (res->res_client.pki_signing_key_files) {
278 delete res->res_client.pki_signing_key_files;
280 if (res->res_client.pki_signers) {
281 X509_KEYPAIR *keypair;
282 foreach_alist(keypair, res->res_client.pki_signers) {
283 crypto_keypair_free(keypair);
285 delete res->res_client.pki_signers;
288 if (res->res_client.pki_master_key_files) {
289 delete res->res_client.pki_master_key_files;
292 if (res->res_client.pki_recipients) {
293 X509_KEYPAIR *keypair;
294 foreach_alist(keypair, res->res_client.pki_recipients) {
295 crypto_keypair_free(keypair);
297 delete res->res_client.pki_recipients;
300 if (res->res_client.tls_ctx) {
301 free_tls_context(res->res_client.tls_ctx);
303 if (res->res_client.tls_ca_certfile) {
304 free(res->res_client.tls_ca_certfile);
306 if (res->res_client.tls_ca_certdir) {
307 free(res->res_client.tls_ca_certdir);
309 if (res->res_client.tls_certfile) {
310 free(res->res_client.tls_certfile);
312 if (res->res_client.tls_keyfile) {
313 free(res->res_client.tls_keyfile);
317 if (res->res_msgs.mail_cmd)
318 free(res->res_msgs.mail_cmd);
319 if (res->res_msgs.operator_cmd)
320 free(res->res_msgs.operator_cmd);
321 free_msgs_res((MSGS *)res); /* free message resource */
325 printf(_("Unknown resource type %d\n"), type);
327 /* Common stuff again -- free the resource, recurse to next one */
332 free_resource(nres, type);
336 /* Save the new resource by chaining it into the head list for
337 * the resource. If this is pass 2, we update any resource
338 * pointers (currently only in the Job resource).
340 void save_resource(int type, RES_ITEM *items, int pass)
343 int rindex = type - r_first;
348 * Ensure that all required items are present
350 for (i=0; items[i].name; i++) {
351 if (items[i].flags & ITEM_REQUIRED) {
352 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
353 Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
354 items[i].name, resources[rindex]);
359 /* During pass 2, we looked up pointers to all the resources
360 * referrenced in the current resource, , now we
361 * must copy their address from the static record to the allocated
366 /* Resources not containing a resource */
370 /* Resources containing another resource */
372 if ((res = (URES *)GetResWithName(R_DIRECTOR, res_all.res_dir.hdr.name)) == NULL) {
373 Emsg1(M_ABORT, 0, _("Cannot find Director resource %s\n"), res_all.res_dir.hdr.name);
375 res->res_dir.tls_allowed_cns = res_all.res_dir.tls_allowed_cns;
378 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_dir.hdr.name)) == NULL) {
379 Emsg1(M_ABORT, 0, _("Cannot find Client resource %s\n"), res_all.res_dir.hdr.name);
381 res->res_client.pki_signing_key_files = res_all.res_client.pki_signing_key_files;
382 res->res_client.pki_master_key_files = res_all.res_client.pki_master_key_files;
384 res->res_client.pki_signers = res_all.res_client.pki_signers;
385 res->res_client.pki_recipients = res_all.res_client.pki_recipients;
387 res->res_client.messages = res_all.res_client.messages;
390 Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
394 /* Note, the resoure name was already saved during pass 1,
395 * so here, we can just release it.
397 if (res_all.res_dir.hdr.name) {
398 free(res_all.res_dir.hdr.name);
399 res_all.res_dir.hdr.name = NULL;
401 if (res_all.res_dir.hdr.desc) {
402 free(res_all.res_dir.hdr.desc);
403 res_all.res_dir.hdr.desc = NULL;
408 /* The following code is only executed on pass 1 */
411 size = sizeof(DIRRES);
414 size = sizeof(CLIENT);
420 printf(_("Unknown resource type %d\n"), type);
427 res = (URES *)malloc(size);
428 memcpy(res, &res_all, size);
429 if (!res_head[rindex]) {
430 res_head[rindex] = (RES *)res; /* store first entry */
433 /* Add new res to end of chain */
434 for (last=next=res_head[rindex]; next; next=next->next) {
436 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
437 Emsg2(M_ERROR_TERM, 0,
438 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
439 resources[rindex].name, res->res_dir.hdr.name);
442 last->next = (RES *)res;
443 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
444 res->res_dir.hdr.name);
449 bool parse_fd_config(CONFIG *config, const char *configfile, int exit_code)
451 config->init(configfile, NULL, exit_code, (void *)&res_all, res_all_size,
452 r_first, r_last, resources, res_head);
453 return config->parse_config();