2 * Main configuration file parser for Bacula User Agent
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, January MM, 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.
53 #include "console_conf.h"
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;
64 /* Forward referenced subroutines */
67 /* We build the current resource here as we are
68 * scanning the resource configuration definition,
69 * then move it to allocated memory when the resource
73 int res_all_size = sizeof(res_all);
75 /* Definition of records permitted within each
76 * resource with the routine to process the record
79 static RES_ITEM dir_items[] = {
80 {"name", store_name, ITEM(dir_res.hdr.name), 0, ITEM_REQUIRED, 0},
81 {"description", store_str, ITEM(dir_res.hdr.desc), 0, 0, 0},
82 {"dirport", store_int, ITEM(dir_res.DIRport), 0, ITEM_DEFAULT, 9101},
83 {"address", store_str, ITEM(dir_res.address), 0, ITEM_REQUIRED, 0},
84 {"password", store_password, ITEM(dir_res.password), 0, 0, 0},
85 {"tlsenable", store_bit, ITEM(dir_res.tls_enable), 1, 0, 0},
86 {"tlsrequire", store_bit, ITEM(dir_res.tls_require), 1, 0, 0},
87 {"tlscacertificatefile", store_dir, ITEM(dir_res.tls_ca_certfile), 0, 0, 0},
88 {"tlscacertificatedir", store_dir, ITEM(dir_res.tls_ca_certdir), 0, 0, 0},
89 {"tlscertificate", store_dir, ITEM(dir_res.tls_certfile), 0, 0, 0},
90 {"tlskey", store_dir, ITEM(dir_res.tls_keyfile), 0, 0, 0},
91 {NULL, NULL, {0}, 0, 0, 0}
94 static RES_ITEM con_items[] = {
95 {"name", store_name, ITEM(con_res.hdr.name), 0, ITEM_REQUIRED, 0},
96 {"description", store_str, ITEM(con_res.hdr.desc), 0, 0, 0},
97 {"password", store_password, ITEM(con_res.password), 0, ITEM_REQUIRED, 0},
98 {"tlsenable", store_bit, ITEM(con_res.tls_enable), 1, 0, 0},
99 {"tlsrequire", store_bit, ITEM(con_res.tls_require), 1, 0, 0},
100 {"tlscacertificatefile", store_dir, ITEM(con_res.tls_ca_certfile), 0, 0, 0},
101 {"tlscacertificatedir", store_dir, ITEM(con_res.tls_ca_certdir), 0, 0, 0},
102 {"tlscertificate", store_dir, ITEM(con_res.tls_certfile), 0, 0, 0},
103 {"tlskey", store_dir, ITEM(con_res.tls_keyfile), 0, 0, 0},
104 {NULL, NULL, {0}, 0, 0, 0}
107 static RES_ITEM con_font_items[] = {
108 {"name", store_name, ITEM(con_font.hdr.name), 0, ITEM_REQUIRED, 0},
109 {"description", store_str, ITEM(con_font.hdr.desc), 0, 0, 0},
110 {"font", store_str, ITEM(con_font.fontface), 0, 0, 0},
111 {NULL, NULL, {0}, 0, 0, 0}
116 * This is the master resource definition.
117 * It must have one item for each of the resources.
119 RES_TABLE resources[] = {
120 {"director", dir_items, R_DIRECTOR},
121 {"console", con_items, R_CONSOLE},
122 {"consolefont", con_font_items, R_CONSOLE_FONT},
127 /* Dump contents of resource */
128 void dump_resource(int type, RES *reshdr, void sendit(void *sock, const char *fmt, ...), void *sock)
130 URES *res = (URES *)reshdr;
134 printf(_("No record for %d %s\n"), type, res_to_str(type));
137 if (type < 0) { /* no recursion */
143 printf(_("Director: name=%s address=%s DIRport=%d\n"), reshdr->name,
144 res->dir_res.address, res->dir_res.DIRport);
147 printf(_("Console: name=%s\n"), reshdr->name);
150 printf(_("ConsoleFont: name=%s font face=%s\n"),
151 reshdr->name, NPRT(res->con_font.fontface));
154 printf(_("Unknown resource type %d\n"), type);
156 if (recurse && res->dir_res.hdr.next) {
157 dump_resource(type, res->dir_res.hdr.next, sendit, sock);
162 * Free memory of resource.
163 * NB, we don't need to worry about freeing any references
164 * to other resources as they will be freed when that
165 * resource chain is traversed. Mainly we worry about freeing
166 * allocated strings (names).
168 void free_resource(RES *sres, int type)
171 URES *res = (URES *)sres;
176 /* common stuff -- free the resource name */
177 nres = (RES *)res->dir_res.hdr.next;
178 if (res->dir_res.hdr.name) {
179 free(res->dir_res.hdr.name);
181 if (res->dir_res.hdr.desc) {
182 free(res->dir_res.hdr.desc);
187 if (res->dir_res.address) {
188 free(res->dir_res.address);
190 if (res->dir_res.tls_ctx) {
191 free_tls_context(res->dir_res.tls_ctx);
193 if (res->dir_res.tls_ca_certfile) {
194 free(res->dir_res.tls_ca_certfile);
196 if (res->dir_res.tls_ca_certdir) {
197 free(res->dir_res.tls_ca_certdir);
199 if (res->dir_res.tls_certfile) {
200 free(res->dir_res.tls_certfile);
202 if (res->dir_res.tls_keyfile) {
203 free(res->dir_res.tls_keyfile);
207 if (res->con_res.password) {
208 free(res->con_res.password);
210 if (res->con_res.tls_ctx) {
211 free_tls_context(res->con_res.tls_ctx);
213 if (res->con_res.tls_ca_certfile) {
214 free(res->con_res.tls_ca_certfile);
216 if (res->con_res.tls_ca_certdir) {
217 free(res->con_res.tls_ca_certdir);
219 if (res->con_res.tls_certfile) {
220 free(res->con_res.tls_certfile);
222 if (res->con_res.tls_keyfile) {
223 free(res->con_res.tls_keyfile);
227 if (res->con_font.fontface) {
228 free(res->con_font.fontface);
232 printf(_("Unknown resource type %d\n"), type);
234 /* Common stuff again -- free the resource, recurse to next one */
237 free_resource(nres, type);
241 /* Save the new resource by chaining it into the head list for
242 * the resource. If this is pass 2, we update any resource
243 * pointers (currently only in the Job resource).
245 void save_resource(int type, RES_ITEM *items, int pass)
248 int rindex = type - r_first;
253 * Ensure that all required items are present
255 for (i=0; items[i].name; i++) {
256 if (items[i].flags & ITEM_REQUIRED) {
257 if (!bit_is_set(i, res_all.dir_res.hdr.item_present)) {
258 Emsg2(M_ABORT, 0, _("%s item is required in %s resource, but not found.\n"),
259 items[i].name, resources[rindex]);
264 /* During pass 2, we looked up pointers to all the resources
265 * referrenced in the current resource, , now we
266 * must copy their address from the static record to the allocated
271 /* Resources not containing a resource */
280 Emsg1(M_ERROR, 0, _("Unknown resource type %d\n"), type);
284 /* Note, the resoure name was already saved during pass 1,
285 * so here, we can just release it.
287 if (res_all.dir_res.hdr.name) {
288 free(res_all.dir_res.hdr.name);
289 res_all.dir_res.hdr.name = NULL;
291 if (res_all.dir_res.hdr.desc) {
292 free(res_all.dir_res.hdr.desc);
293 res_all.dir_res.hdr.desc = NULL;
298 /* The following code is only executed during pass 1 */
301 size = sizeof(DIRRES);
304 size = sizeof(CONFONTRES);
307 size = sizeof(CONRES);
310 printf(_("Unknown resource type %d\n"), type);
316 res = (URES *)malloc(size);
317 memcpy(res, &res_all, size);
318 if (!res_head[rindex]) {
319 res_head[rindex] = (RES *)res; /* store first entry */
322 /* Add new res to end of chain */
323 for (last=next=res_head[rindex]; next; next=next->next) {
325 if (strcmp(next->name, res->dir_res.hdr.name) == 0) {
326 Emsg2(M_ERROR_TERM, 0,
327 _("Attempt to define second %s resource named \"%s\" is not permitted.\n"),
328 resources[rindex].name, res->dir_res.hdr.name);
331 last->next = (RES *)res;
332 Dmsg2(90, "Inserting %s res: %s\n", res_to_str(type),
333 res->dir_res.hdr.name);