]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/shared/conf-parser.c
Merge pull request #2947 from keszybz/test-nss
[thirdparty/systemd.git] / src / shared / conf-parser.c
1 /***
2 This file is part of systemd.
3
4 Copyright 2010 Lennart Poettering
5
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 ***/
19
20 #include <errno.h>
21 #include <limits.h>
22 #include <stdint.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <sys/types.h>
27
28 #include "alloc-util.h"
29 #include "conf-files.h"
30 #include "conf-parser.h"
31 #include "extract-word.h"
32 #include "fd-util.h"
33 #include "fs-util.h"
34 #include "log.h"
35 #include "macro.h"
36 #include "parse-util.h"
37 #include "path-util.h"
38 #include "process-util.h"
39 #include "signal-util.h"
40 #include "string-util.h"
41 #include "strv.h"
42 #include "syslog-util.h"
43 #include "time-util.h"
44 #include "utf8.h"
45
46 int config_item_table_lookup(
47 const void *table,
48 const char *section,
49 const char *lvalue,
50 ConfigParserCallback *func,
51 int *ltype,
52 void **data,
53 void *userdata) {
54
55 const ConfigTableItem *t;
56
57 assert(table);
58 assert(lvalue);
59 assert(func);
60 assert(ltype);
61 assert(data);
62
63 for (t = table; t->lvalue; t++) {
64
65 if (!streq(lvalue, t->lvalue))
66 continue;
67
68 if (!streq_ptr(section, t->section))
69 continue;
70
71 *func = t->parse;
72 *ltype = t->ltype;
73 *data = t->data;
74 return 1;
75 }
76
77 return 0;
78 }
79
80 int config_item_perf_lookup(
81 const void *table,
82 const char *section,
83 const char *lvalue,
84 ConfigParserCallback *func,
85 int *ltype,
86 void **data,
87 void *userdata) {
88
89 ConfigPerfItemLookup lookup = (ConfigPerfItemLookup) table;
90 const ConfigPerfItem *p;
91
92 assert(table);
93 assert(lvalue);
94 assert(func);
95 assert(ltype);
96 assert(data);
97
98 if (!section)
99 p = lookup(lvalue, strlen(lvalue));
100 else {
101 char *key;
102
103 key = strjoin(section, ".", lvalue, NULL);
104 if (!key)
105 return -ENOMEM;
106
107 p = lookup(key, strlen(key));
108 free(key);
109 }
110
111 if (!p)
112 return 0;
113
114 *func = p->parse;
115 *ltype = p->ltype;
116 *data = (uint8_t*) userdata + p->offset;
117 return 1;
118 }
119
120 /* Run the user supplied parser for an assignment */
121 static int next_assignment(const char *unit,
122 const char *filename,
123 unsigned line,
124 ConfigItemLookup lookup,
125 const void *table,
126 const char *section,
127 unsigned section_line,
128 const char *lvalue,
129 const char *rvalue,
130 bool relaxed,
131 void *userdata) {
132
133 ConfigParserCallback func = NULL;
134 int ltype = 0;
135 void *data = NULL;
136 int r;
137
138 assert(filename);
139 assert(line > 0);
140 assert(lookup);
141 assert(lvalue);
142 assert(rvalue);
143
144 r = lookup(table, section, lvalue, &func, &ltype, &data, userdata);
145 if (r < 0)
146 return r;
147
148 if (r > 0) {
149 if (func)
150 return func(unit, filename, line, section, section_line,
151 lvalue, ltype, rvalue, data, userdata);
152
153 return 0;
154 }
155
156 /* Warn about unknown non-extension fields. */
157 if (!relaxed && !startswith(lvalue, "X-"))
158 log_syntax(unit, LOG_WARNING, filename, line, 0, "Unknown lvalue '%s' in section '%s'", lvalue, section);
159
160 return 0;
161 }
162
163 /* Parse a variable assignment line */
164 static int parse_line(const char* unit,
165 const char *filename,
166 unsigned line,
167 const char *sections,
168 ConfigItemLookup lookup,
169 const void *table,
170 bool relaxed,
171 bool allow_include,
172 char **section,
173 unsigned *section_line,
174 bool *section_ignored,
175 char *l,
176 void *userdata) {
177
178 char *e;
179
180 assert(filename);
181 assert(line > 0);
182 assert(lookup);
183 assert(l);
184
185 l = strstrip(l);
186
187 if (!*l)
188 return 0;
189
190 if (strchr(COMMENTS "\n", *l))
191 return 0;
192
193 if (startswith(l, ".include ")) {
194 _cleanup_free_ char *fn = NULL;
195
196 /* .includes are a bad idea, we only support them here
197 * for historical reasons. They create cyclic include
198 * problems and make it difficult to detect
199 * configuration file changes with an easy
200 * stat(). Better approaches, such as .d/ drop-in
201 * snippets exist.
202 *
203 * Support for them should be eventually removed. */
204
205 if (!allow_include) {
206 log_syntax(unit, LOG_ERR, filename, line, 0, ".include not allowed here. Ignoring.");
207 return 0;
208 }
209
210 fn = file_in_same_dir(filename, strstrip(l+9));
211 if (!fn)
212 return -ENOMEM;
213
214 return config_parse(unit, fn, NULL, sections, lookup, table, relaxed, false, false, userdata);
215 }
216
217 if (*l == '[') {
218 size_t k;
219 char *n;
220
221 k = strlen(l);
222 assert(k > 0);
223
224 if (l[k-1] != ']') {
225 log_syntax(unit, LOG_ERR, filename, line, 0, "Invalid section header '%s'", l);
226 return -EBADMSG;
227 }
228
229 n = strndup(l+1, k-2);
230 if (!n)
231 return -ENOMEM;
232
233 if (sections && !nulstr_contains(sections, n)) {
234
235 if (!relaxed && !startswith(n, "X-"))
236 log_syntax(unit, LOG_WARNING, filename, line, 0, "Unknown section '%s'. Ignoring.", n);
237
238 free(n);
239 *section = mfree(*section);
240 *section_line = 0;
241 *section_ignored = true;
242 } else {
243 free(*section);
244 *section = n;
245 *section_line = line;
246 *section_ignored = false;
247 }
248
249 return 0;
250 }
251
252 if (sections && !*section) {
253
254 if (!relaxed && !*section_ignored)
255 log_syntax(unit, LOG_WARNING, filename, line, 0, "Assignment outside of section. Ignoring.");
256
257 return 0;
258 }
259
260 e = strchr(l, '=');
261 if (!e) {
262 log_syntax(unit, LOG_WARNING, filename, line, 0, "Missing '='.");
263 return -EINVAL;
264 }
265
266 *e = 0;
267 e++;
268
269 return next_assignment(unit,
270 filename,
271 line,
272 lookup,
273 table,
274 *section,
275 *section_line,
276 strstrip(l),
277 strstrip(e),
278 relaxed,
279 userdata);
280 }
281
282 /* Go through the file and parse each line */
283 int config_parse(const char *unit,
284 const char *filename,
285 FILE *f,
286 const char *sections,
287 ConfigItemLookup lookup,
288 const void *table,
289 bool relaxed,
290 bool allow_include,
291 bool warn,
292 void *userdata) {
293
294 _cleanup_free_ char *section = NULL, *continuation = NULL;
295 _cleanup_fclose_ FILE *ours = NULL;
296 unsigned line = 0, section_line = 0;
297 bool section_ignored = false, allow_bom = true;
298 int r;
299
300 assert(filename);
301 assert(lookup);
302
303 if (!f) {
304 f = ours = fopen(filename, "re");
305 if (!f) {
306 /* Only log on request, except for ENOENT,
307 * since we return 0 to the caller. */
308 if (warn || errno == ENOENT)
309 log_full(errno == ENOENT ? LOG_DEBUG : LOG_ERR,
310 "Failed to open configuration file '%s': %m", filename);
311 return errno == ENOENT ? 0 : -errno;
312 }
313 }
314
315 fd_warn_permissions(filename, fileno(f));
316
317 for (;;) {
318 char buf[LINE_MAX], *l, *p, *c = NULL, *e;
319 bool escaped = false;
320
321 if (!fgets(buf, sizeof buf, f)) {
322 if (feof(f))
323 break;
324
325 log_error_errno(errno, "Failed to read configuration file '%s': %m", filename);
326 return -errno;
327 }
328
329 l = buf;
330 if (allow_bom && startswith(l, UTF8_BYTE_ORDER_MARK))
331 l += strlen(UTF8_BYTE_ORDER_MARK);
332 allow_bom = false;
333
334 truncate_nl(l);
335
336 if (continuation) {
337 c = strappend(continuation, l);
338 if (!c) {
339 if (warn)
340 log_oom();
341 return -ENOMEM;
342 }
343
344 continuation = mfree(continuation);
345 p = c;
346 } else
347 p = l;
348
349 for (e = p; *e; e++) {
350 if (escaped)
351 escaped = false;
352 else if (*e == '\\')
353 escaped = true;
354 }
355
356 if (escaped) {
357 *(e-1) = ' ';
358
359 if (c)
360 continuation = c;
361 else {
362 continuation = strdup(l);
363 if (!continuation) {
364 if (warn)
365 log_oom();
366 return -ENOMEM;
367 }
368 }
369
370 continue;
371 }
372
373 r = parse_line(unit,
374 filename,
375 ++line,
376 sections,
377 lookup,
378 table,
379 relaxed,
380 allow_include,
381 &section,
382 &section_line,
383 &section_ignored,
384 p,
385 userdata);
386 free(c);
387
388 if (r < 0) {
389 if (warn)
390 log_warning_errno(r, "Failed to parse file '%s': %m",
391 filename);
392 return r;
393 }
394 }
395
396 return 0;
397 }
398
399 /* Parse each config file in the specified directories. */
400 int config_parse_many(const char *conf_file,
401 const char *conf_file_dirs,
402 const char *sections,
403 ConfigItemLookup lookup,
404 const void *table,
405 bool relaxed,
406 void *userdata) {
407 _cleanup_strv_free_ char **files = NULL;
408 char **fn;
409 int r;
410
411 r = conf_files_list_nulstr(&files, ".conf", NULL, conf_file_dirs);
412 if (r < 0)
413 return r;
414
415 if (conf_file) {
416 r = config_parse(NULL, conf_file, NULL, sections, lookup, table, relaxed, false, true, userdata);
417 if (r < 0)
418 return r;
419 }
420
421 STRV_FOREACH(fn, files) {
422 r = config_parse(NULL, *fn, NULL, sections, lookup, table, relaxed, false, true, userdata);
423 if (r < 0)
424 return r;
425 }
426
427 return 0;
428 }
429
430 #define DEFINE_PARSER(type, vartype, conv_func) \
431 int config_parse_##type( \
432 const char *unit, \
433 const char *filename, \
434 unsigned line, \
435 const char *section, \
436 unsigned section_line, \
437 const char *lvalue, \
438 int ltype, \
439 const char *rvalue, \
440 void *data, \
441 void *userdata) { \
442 \
443 vartype *i = data; \
444 int r; \
445 \
446 assert(filename); \
447 assert(lvalue); \
448 assert(rvalue); \
449 assert(data); \
450 \
451 r = conv_func(rvalue, i); \
452 if (r < 0) \
453 log_syntax(unit, LOG_ERR, filename, line, r, \
454 "Failed to parse %s value, ignoring: %s", \
455 #type, rvalue); \
456 \
457 return 0; \
458 } \
459 struct __useless_struct_to_allow_trailing_semicolon__
460
461 DEFINE_PARSER(int, int, safe_atoi);
462 DEFINE_PARSER(long, long, safe_atoli);
463 DEFINE_PARSER(uint32, uint32_t, safe_atou32);
464 DEFINE_PARSER(uint64, uint64_t, safe_atou64);
465 DEFINE_PARSER(unsigned, unsigned, safe_atou);
466 DEFINE_PARSER(double, double, safe_atod);
467 DEFINE_PARSER(nsec, nsec_t, parse_nsec);
468 DEFINE_PARSER(sec, usec_t, parse_sec);
469 DEFINE_PARSER(mode, mode_t, parse_mode);
470
471 int config_parse_iec_size(const char* unit,
472 const char *filename,
473 unsigned line,
474 const char *section,
475 unsigned section_line,
476 const char *lvalue,
477 int ltype,
478 const char *rvalue,
479 void *data,
480 void *userdata) {
481
482 size_t *sz = data;
483 uint64_t v;
484 int r;
485
486 assert(filename);
487 assert(lvalue);
488 assert(rvalue);
489 assert(data);
490
491 r = parse_size(rvalue, 1024, &v);
492 if (r < 0 || (uint64_t) (size_t) v != v) {
493 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
494 return 0;
495 }
496
497 *sz = (size_t) v;
498 return 0;
499 }
500
501 int config_parse_si_size(const char* unit,
502 const char *filename,
503 unsigned line,
504 const char *section,
505 unsigned section_line,
506 const char *lvalue,
507 int ltype,
508 const char *rvalue,
509 void *data,
510 void *userdata) {
511
512 size_t *sz = data;
513 uint64_t v;
514 int r;
515
516 assert(filename);
517 assert(lvalue);
518 assert(rvalue);
519 assert(data);
520
521 r = parse_size(rvalue, 1000, &v);
522 if (r < 0 || (uint64_t) (size_t) v != v) {
523 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
524 return 0;
525 }
526
527 *sz = (size_t) v;
528 return 0;
529 }
530
531 int config_parse_iec_uint64(const char* unit,
532 const char *filename,
533 unsigned line,
534 const char *section,
535 unsigned section_line,
536 const char *lvalue,
537 int ltype,
538 const char *rvalue,
539 void *data,
540 void *userdata) {
541
542 uint64_t *bytes = data;
543 int r;
544
545 assert(filename);
546 assert(lvalue);
547 assert(rvalue);
548 assert(data);
549
550 r = parse_size(rvalue, 1024, bytes);
551 if (r < 0)
552 log_syntax(unit, LOG_ERR, filename, line, r, "Failed to parse size value, ignoring: %s", rvalue);
553
554 return 0;
555 }
556
557 int config_parse_bool(const char* unit,
558 const char *filename,
559 unsigned line,
560 const char *section,
561 unsigned section_line,
562 const char *lvalue,
563 int ltype,
564 const char *rvalue,
565 void *data,
566 void *userdata) {
567
568 int k;
569 bool *b = data;
570
571 assert(filename);
572 assert(lvalue);
573 assert(rvalue);
574 assert(data);
575
576 k = parse_boolean(rvalue);
577 if (k < 0) {
578 log_syntax(unit, LOG_ERR, filename, line, k, "Failed to parse boolean value, ignoring: %s", rvalue);
579 return 0;
580 }
581
582 *b = !!k;
583 return 0;
584 }
585
586 int config_parse_tristate(
587 const char* unit,
588 const char *filename,
589 unsigned line,
590 const char *section,
591 unsigned section_line,
592 const char *lvalue,
593 int ltype,
594 const char *rvalue,
595 void *data,
596 void *userdata) {
597
598 int k, *t = data;
599
600 assert(filename);
601 assert(lvalue);
602 assert(rvalue);
603 assert(data);
604
605 /* A tristate is pretty much a boolean, except that it can
606 * also take the special value -1, indicating "uninitialized",
607 * much like NULL is for a pointer type. */
608
609 k = parse_boolean(rvalue);
610 if (k < 0) {
611 log_syntax(unit, LOG_ERR, filename, line, k, "Failed to parse boolean value, ignoring: %s", rvalue);
612 return 0;
613 }
614
615 *t = !!k;
616 return 0;
617 }
618
619 int config_parse_string(
620 const char *unit,
621 const char *filename,
622 unsigned line,
623 const char *section,
624 unsigned section_line,
625 const char *lvalue,
626 int ltype,
627 const char *rvalue,
628 void *data,
629 void *userdata) {
630
631 char **s = data, *n;
632
633 assert(filename);
634 assert(lvalue);
635 assert(rvalue);
636 assert(data);
637
638 if (!utf8_is_valid(rvalue)) {
639 log_syntax_invalid_utf8(unit, LOG_ERR, filename, line, rvalue);
640 return 0;
641 }
642
643 if (isempty(rvalue))
644 n = NULL;
645 else {
646 n = strdup(rvalue);
647 if (!n)
648 return log_oom();
649 }
650
651 free(*s);
652 *s = n;
653
654 return 0;
655 }
656
657 int config_parse_path(
658 const char *unit,
659 const char *filename,
660 unsigned line,
661 const char *section,
662 unsigned section_line,
663 const char *lvalue,
664 int ltype,
665 const char *rvalue,
666 void *data,
667 void *userdata) {
668
669 char **s = data, *n;
670
671 assert(filename);
672 assert(lvalue);
673 assert(rvalue);
674 assert(data);
675
676 if (!utf8_is_valid(rvalue)) {
677 log_syntax_invalid_utf8(unit, LOG_ERR, filename, line, rvalue);
678 return 0;
679 }
680
681 if (!path_is_absolute(rvalue)) {
682 log_syntax(unit, LOG_ERR, filename, line, 0, "Not an absolute path, ignoring: %s", rvalue);
683 return 0;
684 }
685
686 n = strdup(rvalue);
687 if (!n)
688 return log_oom();
689
690 path_kill_slashes(n);
691
692 free(*s);
693 *s = n;
694
695 return 0;
696 }
697
698 int config_parse_strv(const char *unit,
699 const char *filename,
700 unsigned line,
701 const char *section,
702 unsigned section_line,
703 const char *lvalue,
704 int ltype,
705 const char *rvalue,
706 void *data,
707 void *userdata) {
708
709 char ***sv = data;
710
711 assert(filename);
712 assert(lvalue);
713 assert(rvalue);
714 assert(data);
715
716 if (isempty(rvalue)) {
717 char **empty;
718
719 /* Empty assignment resets the list. As a special rule
720 * we actually fill in a real empty array here rather
721 * than NULL, since some code wants to know if
722 * something was set at all... */
723 empty = strv_new(NULL, NULL);
724 if (!empty)
725 return log_oom();
726
727 strv_free(*sv);
728 *sv = empty;
729 return 0;
730 }
731
732 for (;;) {
733 char *word = NULL;
734 int r;
735 r = extract_first_word(&rvalue, &word, WHITESPACE, EXTRACT_QUOTES);
736 if (r == 0)
737 break;
738 if (r == -ENOMEM)
739 return log_oom();
740 if (r < 0) {
741 log_syntax(unit, LOG_ERR, filename, line, r, "Invalid syntax, ignoring: %s", rvalue);
742 break;
743 }
744
745 if (!utf8_is_valid(word)) {
746 log_syntax_invalid_utf8(unit, LOG_ERR, filename, line, rvalue);
747 free(word);
748 continue;
749 }
750 r = strv_consume(sv, word);
751 if (r < 0)
752 return log_oom();
753 }
754
755 return 0;
756 }
757
758 int config_parse_log_facility(
759 const char *unit,
760 const char *filename,
761 unsigned line,
762 const char *section,
763 unsigned section_line,
764 const char *lvalue,
765 int ltype,
766 const char *rvalue,
767 void *data,
768 void *userdata) {
769
770
771 int *o = data, x;
772
773 assert(filename);
774 assert(lvalue);
775 assert(rvalue);
776 assert(data);
777
778 x = log_facility_unshifted_from_string(rvalue);
779 if (x < 0) {
780 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse log facility, ignoring: %s", rvalue);
781 return 0;
782 }
783
784 *o = (x << 3) | LOG_PRI(*o);
785
786 return 0;
787 }
788
789 int config_parse_log_level(
790 const char *unit,
791 const char *filename,
792 unsigned line,
793 const char *section,
794 unsigned section_line,
795 const char *lvalue,
796 int ltype,
797 const char *rvalue,
798 void *data,
799 void *userdata) {
800
801
802 int *o = data, x;
803
804 assert(filename);
805 assert(lvalue);
806 assert(rvalue);
807 assert(data);
808
809 x = log_level_from_string(rvalue);
810 if (x < 0) {
811 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse log level, ignoring: %s", rvalue);
812 return 0;
813 }
814
815 *o = (*o & LOG_FACMASK) | x;
816 return 0;
817 }
818
819 int config_parse_signal(
820 const char *unit,
821 const char *filename,
822 unsigned line,
823 const char *section,
824 unsigned section_line,
825 const char *lvalue,
826 int ltype,
827 const char *rvalue,
828 void *data,
829 void *userdata) {
830
831 int *sig = data, r;
832
833 assert(filename);
834 assert(lvalue);
835 assert(rvalue);
836 assert(sig);
837
838 r = signal_from_string_try_harder(rvalue);
839 if (r <= 0) {
840 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse signal name, ignoring: %s", rvalue);
841 return 0;
842 }
843
844 *sig = r;
845 return 0;
846 }
847
848 int config_parse_personality(
849 const char *unit,
850 const char *filename,
851 unsigned line,
852 const char *section,
853 unsigned section_line,
854 const char *lvalue,
855 int ltype,
856 const char *rvalue,
857 void *data,
858 void *userdata) {
859
860 unsigned long *personality = data, p;
861
862 assert(filename);
863 assert(lvalue);
864 assert(rvalue);
865 assert(personality);
866
867 p = personality_from_string(rvalue);
868 if (p == PERSONALITY_INVALID) {
869 log_syntax(unit, LOG_ERR, filename, line, 0, "Failed to parse personality, ignoring: %s", rvalue);
870 return 0;
871 }
872
873 *personality = p;
874 return 0;
875 }