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 Copyright (C) 2000-2005 Kern Sibbald
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.
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.
42 /* Define the first and last resource ID record
43 * types. Note, these should be unique for each
44 * daemon though not a requirement.
46 int r_first = R_FIRST;
48 static RES *sres_head[R_LAST - R_FIRST + 1];
49 RES **res_head = sres_head;
52 /* Forward referenced subroutines */
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
60 #if defined(HAVE_WIN32) && !defined(HAVE_CYGWIN)
61 extern "C" { // work around visual compiler mangling variables
63 int res_all_size = sizeof(res_all);
67 int res_all_size = sizeof(res_all);
70 /* Definition of records permitted within each
71 * resource with the routine to process the record
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},
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_bit, ITEM(res_client.pki_sign), 1, ITEM_DEFAULT, 0},
93 {"pkiencryption", store_bit, ITEM(res_client.pki_encrypt), 1, ITEM_DEFAULT, 0},
94 {"pkikeypair", store_dir, ITEM(res_client.pki_keypair_file), 0, 0, 0},
95 {"pkisigner", store_alist_str, ITEM(res_client.pki_signing_key_files), 0, 0, 0},
96 {"pkimasterkey", store_alist_str, ITEM(res_client.pki_master_key_files), 0, 0, 0},
97 {"tlsenable", store_bit, ITEM(res_client.tls_enable), 1, 0, 0},
98 {"tlsrequire", store_bit, 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}
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_bit, ITEM(res_dir.monitor), 1, ITEM_DEFAULT, 0},
113 {"tlsenable", store_bit, ITEM(res_dir.tls_enable), 1, 0, 0},
114 {"tlsrequire", store_bit, ITEM(res_dir.tls_require), 1, 0, 0},
115 {"tlsverifypeer", store_bit, 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}
125 /* Message resource */
126 extern RES_ITEM msgs_items[];
129 * This is the master resource definition.
130 * It must have one item for each of the resources.
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},
141 /* Dump contents of resource */
142 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
144 URES *res = (URES *)reshdr;
148 sendit(sock, "No record for %d %s\n", type, res_to_str(type));
151 if (type < 0) { /* no recursion */
157 sendit(sock, "Director: name=%s password=%s\n", reshdr->name,
158 res->res_dir.password);
161 sendit(sock, "Client: name=%s FDport=%d\n", reshdr->name,
162 get_first_port_host_order(res->res_client.FDaddrs));
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);
172 sendit(sock, "Unknown resource type %d\n", type);
174 if (recurse && res->res_dir.hdr.next)
175 dump_resource(type, res->res_dir.hdr.next, sendit, sock);
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).
185 void free_resource(RES *sres, int type)
188 URES *res = (URES *)sres;
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);
199 if (res->res_dir.hdr.desc) {
200 free(res->res_dir.hdr.desc);
204 if (res->res_dir.password) {
205 free(res->res_dir.password);
207 if (res->res_dir.address) {
208 free(res->res_dir.address);
210 if (res->res_dir.tls_ctx) {
211 free_tls_context(res->res_dir.tls_ctx);
213 if (res->res_dir.tls_ca_certfile) {
214 free(res->res_dir.tls_ca_certfile);
216 if (res->res_dir.tls_ca_certdir) {
217 free(res->res_dir.tls_ca_certdir);
219 if (res->res_dir.tls_certfile) {
220 free(res->res_dir.tls_certfile);
222 if (res->res_dir.tls_keyfile) {
223 free(res->res_dir.tls_keyfile);
225 if (res->res_dir.tls_dhfile) {
226 free(res->res_dir.tls_dhfile);
228 if (res->res_dir.tls_allowed_cns) {
229 delete res->res_dir.tls_allowed_cns;
233 if (res->res_client.working_directory) {
234 free(res->res_client.working_directory);
236 if (res->res_client.pid_directory) {
237 free(res->res_client.pid_directory);
239 if (res->res_client.subsys_directory) {
240 free(res->res_client.subsys_directory);
242 if (res->res_client.scripts_directory) {
243 free(res->res_client.scripts_directory);
245 if (res->res_client.FDaddrs) {
246 free_addresses(res->res_client.FDaddrs);
249 if (res->res_client.pki_keypair_file) {
250 free(res->res_client.pki_keypair_file);
252 if (res->res_client.pki_keypair) {
253 crypto_keypair_free(res->res_client.pki_keypair);
256 if (res->res_client.pki_signing_key_files) {
257 delete res->res_client.pki_signing_key_files;
259 if (res->res_client.pki_signers) {
260 X509_KEYPAIR *keypair;
261 foreach_alist(keypair, res->res_client.pki_signers) {
262 crypto_keypair_free(keypair);
264 delete res->res_client.pki_signers;
267 if (res->res_client.pki_master_key_files) {
268 delete res->res_client.pki_master_key_files;
271 if (res->res_client.pki_recipients) {
272 X509_KEYPAIR *keypair;
273 foreach_alist(keypair, res->res_client.pki_recipients) {
274 crypto_keypair_free(keypair);
276 delete res->res_client.pki_recipients;
279 if (res->res_client.tls_ctx) {
280 free_tls_context(res->res_client.tls_ctx);
282 if (res->res_client.tls_ca_certfile) {
283 free(res->res_client.tls_ca_certfile);
285 if (res->res_client.tls_ca_certdir) {
286 free(res->res_client.tls_ca_certdir);
288 if (res->res_client.tls_certfile) {
289 free(res->res_client.tls_certfile);
291 if (res->res_client.tls_keyfile) {
292 free(res->res_client.tls_keyfile);
296 if (res->res_msgs.mail_cmd)
297 free(res->res_msgs.mail_cmd);
298 if (res->res_msgs.operator_cmd)
299 free(res->res_msgs.operator_cmd);
300 free_msgs_res((MSGS *)res); /* free message resource */
304 printf(_("Unknown resource type %d\n"), type);
306 /* Common stuff again -- free the resource, recurse to next one */
311 free_resource(nres, type);
315 /* Save the new resource by chaining it into the head list for
316 * the resource. If this is pass 2, we update any resource
317 * pointers (currently only in the Job resource).
319 void save_resource(int type, RES_ITEM *items, int pass)
322 int rindex = type - r_first;
327 * Ensure that all required items are present
329 for (i=0; items[i].name; i++) {
330 if (items[i].flags & ITEM_REQUIRED) {
331 if (!bit_is_set(i, res_all.res_dir.hdr.item_present)) {
332 Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
333 items[i].name, resources[rindex]);
338 /* During pass 2, we looked up pointers to all the resources
339 * referrenced in the current resource, , now we
340 * must copy their address from the static record to the allocated
345 /* Resources not containing a resource */
349 /* Resources containing another resource */
351 if ((res = (URES *)GetResWithName(R_DIRECTOR, res_all.res_dir.hdr.name)) == NULL) {
352 Emsg1(M_ABORT, 0, _("Cannot find Director resource %s\n"), res_all.res_dir.hdr.name);
354 res->res_dir.tls_allowed_cns = res_all.res_dir.tls_allowed_cns;
357 if ((res = (URES *)GetResWithName(R_CLIENT, res_all.res_dir.hdr.name)) == NULL) {
358 Emsg1(M_ABORT, 0, _("Cannot find Client resource %s\n"), res_all.res_dir.hdr.name);
360 res->res_client.pki_signing_key_files = res_all.res_client.pki_signing_key_files;
361 res->res_client.pki_master_key_files = res_all.res_client.pki_master_key_files;
363 res->res_client.pki_signers = res_all.res_client.pki_signers;
364 res->res_client.pki_recipients = res_all.res_client.pki_recipients;
366 res->res_client.messages = res_all.res_client.messages;
369 Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
373 /* Note, the resoure name was already saved during pass 1,
374 * so here, we can just release it.
376 if (res_all.res_dir.hdr.name) {
377 free(res_all.res_dir.hdr.name);
378 res_all.res_dir.hdr.name = NULL;
380 if (res_all.res_dir.hdr.desc) {
381 free(res_all.res_dir.hdr.desc);
382 res_all.res_dir.hdr.desc = NULL;
387 /* The following code is only executed on pass 1 */
390 size = sizeof(DIRRES);
393 size = sizeof(CLIENT);
399 printf(_("Unknown resource type %d\n"), type);
406 res = (URES *)malloc(size);
407 memcpy(res, &res_all, size);
408 if (!res_head[rindex]) {
409 res_head[rindex] = (RES *)res; /* store first entry */
412 /* Add new res to end of chain */
413 for (next=res_head[rindex]; next->next; next=next->next) {
414 if (strcmp(next->name, res->res_dir.hdr.name) == 0) {
415 Emsg2(M_ERROR_TERM, 0,
416 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
417 resources[rindex].name, res->res_dir.hdr.name);
420 next->next = (RES *)res;
421 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
422 res->res_dir.hdr.name);