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).
6 * Note, the configuration file parser consists of three parts
8 * 1. The generic lexical scanner in lib/lex.c and lib/lex.h
10 * 2. The generic config scanner in lib/parse_config.c and
12 * These files contain the parser code, some utility
13 * routines, and the common store routines (name, int,
16 * 3. The daemon specific file, which contains the Resource
17 * definitions as well as any specific store routines
18 * for the resource records.
20 * Kern Sibbald, September MM
25 Bacula® - The Network Backup Solution
27 Copyright (C) 2000-2006 Free Software Foundation Europe e.V.
29 The main author of Bacula is Kern Sibbald, with contributions from
30 many others, a complete list can be found in the file AUTHORS.
31 This program is Free Software; you can redistribute it and/or
32 modify it under the terms of version two of the GNU General Public
33 License as published by the Free Software Foundation plus additions
34 that are listed in the file LICENSE.
36 This program is distributed in the hope that it will be useful, but
37 WITHOUT ANY WARRANTY; without even the implied warranty of
38 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
39 General Public License for more details.
41 You should have received a copy of the GNU General Public License
42 along with this program; if not, write to the Free Software
43 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
46 Bacula® is a registered trademark of John Walker.
47 The licensor of Bacula is the Free Software Foundation Europe
48 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
49 Switzerland, email:ftf@fsfeurope.org.
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 int r_first = R_FIRST;
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 int 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 {"scriptsdirectory", store_dir, ITEM(res_client.scripts_directory), 0, 0, 0},
99 {"maximumconcurrentjobs", store_pint, ITEM(res_client.MaxConcurrentJobs), 0, ITEM_DEFAULT, 10},
100 {"messages", store_res, ITEM(res_client.messages), R_MSGS, 0, 0},
101 {"heartbeatinterval", store_time, ITEM(res_client.heartbeat_interval), 0, ITEM_DEFAULT, 0},
102 {"sdconnecttimeout", store_time,ITEM(res_client.SDConnectTimeout), 0, ITEM_DEFAULT, 60 * 30},
103 {"maximumnetworkbuffersize", store_pint, ITEM(res_client.max_network_buffer_size), 0, 0, 0},
104 #ifdef DATA_ENCRYPTION
105 {"pkisignatures", store_bool, ITEM(res_client.pki_sign), 0, ITEM_DEFAULT, 0},
106 {"pkiencryption", store_bool, ITEM(res_client.pki_encrypt), 0, ITEM_DEFAULT, 0},
107 {"pkikeypair", store_dir, ITEM(res_client.pki_keypair_file), 0, 0, 0},
108 {"pkisigner", store_alist_str, ITEM(res_client.pki_signing_key_files), 0, 0, 0},
109 {"pkimasterkey", store_alist_str, ITEM(res_client.pki_master_key_files), 0, 0, 0},
111 {"tlsenable", store_bool, ITEM(res_client.tls_enable), 0, 0, 0},
112 {"tlsrequire", store_bool, ITEM(res_client.tls_require), 0, 0, 0},
113 {"tlscacertificatefile", store_dir, ITEM(res_client.tls_ca_certfile), 0, 0, 0},
114 {"tlscacertificatedir", store_dir, ITEM(res_client.tls_ca_certdir), 0, 0, 0},
115 {"tlscertificate", store_dir, ITEM(res_client.tls_certfile), 0, 0, 0},
116 {"tlskey", store_dir, ITEM(res_client.tls_keyfile), 0, 0, 0},
117 {NULL, NULL, {0}, 0, 0, 0}
120 /* Directors that can use our services */
121 static RES_ITEM dir_items[] = {
122 {"name", store_name, ITEM(res_dir.hdr.name), 0, ITEM_REQUIRED, 0},
123 {"description", store_str, ITEM(res_dir.hdr.desc), 0, 0, 0},
124 {"password", store_password, ITEM(res_dir.password), 0, ITEM_REQUIRED, 0},
125 {"address", store_str, ITEM(res_dir.address), 0, 0, 0},
126 {"monitor", store_bool, ITEM(res_dir.monitor), 0, ITEM_DEFAULT, 0},
127 {"tlsenable", store_bool, ITEM(res_dir.tls_enable), 0, 0, 0},
128 {"tlsrequire", store_bool, ITEM(res_dir.tls_require), 0, 0, 0},
129 {"tlsverifypeer", store_bool, ITEM(res_dir.tls_verify_peer), 0, ITEM_DEFAULT, 1},
130 {"tlscacertificatefile", store_dir, ITEM(res_dir.tls_ca_certfile), 0, 0, 0},
131 {"tlscacertificatedir", store_dir, ITEM(res_dir.tls_ca_certdir), 0, 0, 0},
132 {"tlscertificate", store_dir, ITEM(res_dir.tls_certfile), 0, 0, 0},
133 {"tlskey", store_dir, ITEM(res_dir.tls_keyfile), 0, 0, 0},
134 {"tlsdhfile", store_dir, ITEM(res_dir.tls_dhfile), 0, 0, 0},
135 {"tlsallowedcn", store_alist_str, ITEM(res_dir.tls_allowed_cns), 0, 0, 0},
136 {NULL, NULL, {0}, 0, 0, 0}
139 /* Message resource */
140 extern RES_ITEM msgs_items[];
143 * This is the master resource definition.
144 * It must have one item for each of the resources.
146 RES_TABLE resources[] = {
147 {"director", dir_items, R_DIRECTOR},
148 {"filedaemon", cli_items, R_CLIENT},
149 {"client", cli_items, R_CLIENT}, /* alias for filedaemon */
150 {"messages", msgs_items, R_MSGS},
155 /* Dump contents of resource */
156 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
158 URES *res = (URES *)reshdr;
162 sendit(sock, "No record for %d %s\n", type, res_to_str(type));
165 if (type < 0) { /* no recursion */
171 sendit(sock, "Director: name=%s password=%s\n", reshdr->name,
172 res->res_dir.password);
175 sendit(sock, "Client: name=%s FDport=%d\n", reshdr->name,
176 get_first_port_host_order(res->res_client.FDaddrs));
179 sendit(sock, "Messages: name=%s\n", res->res_msgs.hdr.name);
180 if (res->res_msgs.mail_cmd)
181 sendit(sock, " mailcmd=%s\n", res->res_msgs.mail_cmd);
182 if (res->res_msgs.operator_cmd)
183 sendit(sock, " opcmd=%s\n", res->res_msgs.operator_cmd);
186 sendit(sock, "Unknown resource type %d\n", type);
188 if (recurse && res->res_dir.hdr.next) {
189 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
194 * Free memory of resource.
195 * NB, we don't need to worry about freeing any references
196 * to other resources as they will be freed when that
197 * resource chain is traversed. Mainly we worry about freeing
198 * allocated strings (names).
200 void free_resource(RES *sres, int type)
203 URES *res = (URES *)sres;
209 /* common stuff -- free the resource name */
210 nres = (RES *)res->res_dir.hdr.next;
211 if (res->res_dir.hdr.name) {
212 free(res->res_dir.hdr.name);
214 if (res->res_dir.hdr.desc) {
215 free(res->res_dir.hdr.desc);
219 if (res->res_dir.password) {
220 free(res->res_dir.password);
222 if (res->res_dir.address) {
223 free(res->res_dir.address);
225 if (res->res_dir.tls_ctx) {
226 free_tls_context(res->res_dir.tls_ctx);
228 if (res->res_dir.tls_ca_certfile) {
229 free(res->res_dir.tls_ca_certfile);
231 if (res->res_dir.tls_ca_certdir) {
232 free(res->res_dir.tls_ca_certdir);
234 if (res->res_dir.tls_certfile) {
235 free(res->res_dir.tls_certfile);
237 if (res->res_dir.tls_keyfile) {
238 free(res->res_dir.tls_keyfile);
240 if (res->res_dir.tls_dhfile) {
241 free(res->res_dir.tls_dhfile);
243 if (res->res_dir.tls_allowed_cns) {
244 delete res->res_dir.tls_allowed_cns;
248 if (res->res_client.working_directory) {
249 free(res->res_client.working_directory);
251 if (res->res_client.pid_directory) {
252 free(res->res_client.pid_directory);
254 if (res->res_client.subsys_directory) {
255 free(res->res_client.subsys_directory);
257 if (res->res_client.scripts_directory) {
258 free(res->res_client.scripts_directory);
260 if (res->res_client.FDaddrs) {
261 free_addresses(res->res_client.FDaddrs);
264 if (res->res_client.pki_keypair_file) {
265 free(res->res_client.pki_keypair_file);
267 if (res->res_client.pki_keypair) {
268 crypto_keypair_free(res->res_client.pki_keypair);
271 if (res->res_client.pki_signing_key_files) {
272 delete res->res_client.pki_signing_key_files;
274 if (res->res_client.pki_signers) {
275 X509_KEYPAIR *keypair;
276 foreach_alist(keypair, res->res_client.pki_signers) {
277 crypto_keypair_free(keypair);
279 delete res->res_client.pki_signers;
282 if (res->res_client.pki_master_key_files) {
283 delete res->res_client.pki_master_key_files;
286 if (res->res_client.pki_recipients) {
287 X509_KEYPAIR *keypair;
288 foreach_alist(keypair, res->res_client.pki_recipients) {
289 crypto_keypair_free(keypair);
291 delete res->res_client.pki_recipients;
294 if (res->res_client.tls_ctx) {
295 free_tls_context(res->res_client.tls_ctx);
297 if (res->res_client.tls_ca_certfile) {
298 free(res->res_client.tls_ca_certfile);
300 if (res->res_client.tls_ca_certdir) {
301 free(res->res_client.tls_ca_certdir);
303 if (res->res_client.tls_certfile) {
304 free(res->res_client.tls_certfile);
306 if (res->res_client.tls_keyfile) {
307 free(res->res_client.tls_keyfile);
311 if (res->res_msgs.mail_cmd)
312 free(res->res_msgs.mail_cmd);
313 if (res->res_msgs.operator_cmd)
314 free(res->res_msgs.operator_cmd);
315 free_msgs_res((MSGS *)res); /* free message resource */
319 printf(_("Unknown resource type %d\n"), type);
321 /* Common stuff again -- free the resource, recurse to next one */
326 free_resource(nres, type);
330 /* Save the new resource by chaining it into the head list for
331 * the resource. If this is pass 2, we update any resource
332 * pointers (currently only in the Job resource).
334 void save_resource(int type, RES_ITEM *items, int pass)
337 int rindex = type - r_first;
342 * Ensure that all required items are present
344 for (i=0; items[i].name; i++) {
345 if (items[i].flags & ITEM_REQUIRED) {
346 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
347 Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
348 items[i].name, resources[rindex]);
353 /* During pass 2, we looked up pointers to all the resources
354 * referrenced in the current resource, , now we
355 * must copy their address from the static record to the allocated
360 /* Resources not containing a resource */
364 /* Resources containing another resource */
366 if ((res = (URES *)GetResWithName(R_DIRECTOR, res_all.res_dir.hdr.name)) == NULL) {
367 Emsg1(M_ABORT, 0, _("Cannot find Director resource %s\n"), res_all.res_dir.hdr.name);
369 res->res_dir.tls_allowed_cns = res_all.res_dir.tls_allowed_cns;
372 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_dir.hdr.name)) == NULL) {
373 Emsg1(M_ABORT, 0, _("Cannot find Client resource %s\n"), res_all.res_dir.hdr.name);
375 res->res_client.pki_signing_key_files = res_all.res_client.pki_signing_key_files;
376 res->res_client.pki_master_key_files = res_all.res_client.pki_master_key_files;
378 res->res_client.pki_signers = res_all.res_client.pki_signers;
379 res->res_client.pki_recipients = res_all.res_client.pki_recipients;
381 res->res_client.messages = res_all.res_client.messages;
384 Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
388 /* Note, the resoure name was already saved during pass 1,
389 * so here, we can just release it.
391 if (res_all.res_dir.hdr.name) {
392 free(res_all.res_dir.hdr.name);
393 res_all.res_dir.hdr.name = NULL;
395 if (res_all.res_dir.hdr.desc) {
396 free(res_all.res_dir.hdr.desc);
397 res_all.res_dir.hdr.desc = NULL;
402 /* The following code is only executed on pass 1 */
405 size = sizeof(DIRRES);
408 size = sizeof(CLIENT);
414 printf(_("Unknown resource type %d\n"), type);
421 res = (URES *)malloc(size);
422 memcpy(res, &res_all, size);
423 if (!res_head[rindex]) {
424 res_head[rindex] = (RES *)res; /* store first entry */
427 /* Add new res to end of chain */
428 for (last=next=res_head[rindex]; next; next=next->next) {
430 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
431 Emsg2(M_ERROR_TERM, 0,
432 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
433 resources[rindex].name, res->res_dir.hdr.name);
436 last->next = (RES *)res;
437 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
438 res->res_dir.hdr.name);