1 /******************************************************************************/
2 /* pfixtools: a collection of postfix related tools */
4 /* ________________________________________________________________________ */
6 /* Redistribution and use in source and binary forms, with or without */
7 /* modification, are permitted provided that the following conditions */
10 /* 1. Redistributions of source code must retain the above copyright */
11 /* notice, this list of conditions and the following disclaimer. */
12 /* 2. Redistributions in binary form must reproduce the above copyright */
13 /* notice, this list of conditions and the following disclaimer in the */
14 /* documentation and/or other materials provided with the distribution. */
15 /* 3. The names of its contributors may not be used to endorse or promote */
16 /* products derived from this software without specific prior written */
19 /* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND */
20 /* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE */
21 /* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR */
22 /* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS */
23 /* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR */
24 /* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF */
25 /* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS */
26 /* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN */
27 /* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) */
28 /* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF */
29 /* THE POSSIBILITY OF SUCH DAMAGE. */
30 /******************************************************************************/
33 * Copyright © 2008 Florent Bruneau
39 #include "resources.h"
41 #define config_param_register(Param)
43 /* Filter to execute on "CONNECT"
45 config_param_register("client_filter");
47 /* Filter to execute on "MAIL FROM"
49 config_param_register("sender_filter");
51 /* Filter to execute on "RCPT TO"
53 config_param_register("recipient_filter");
55 /* Filter to execute on "DATA"
57 config_param_register("data_filter");
59 /* Filter to execute on "END-OF-DATA"
61 config_param_register("end_of_data_filter");
63 /* Filter to execute on "ETRN"
65 config_param_register("etrn_filter");
67 /* Filter to execute on "HELO"
69 config_param_register("helo_filter");
70 config_param_register("ehlo_filter");
72 /* Filter to execute on "VRFY"
74 config_param_register("verify_filter");
77 /* Where to bind the server.
79 config_param_register("port");
82 static config_t *global_config = NULL;
84 static inline config_t *config_new(void)
86 config_t *config = p_new(config_t, 1);
87 global_config = config;
91 static void config_close(config_t *config)
93 for (int i = 0 ; i < SMTP_count ; ++i) {
94 config->entry_points[i] = -1;
96 array_deep_wipe(config->filters, filter_wipe);
97 array_deep_wipe(config->params, filter_params_wipe);
100 void config_delete(config_t **config)
103 config_close(*config);
105 global_config = NULL;
109 static void config_exit()
112 config_delete(&global_config);
115 module_exit(config_exit);
118 static bool config_parse(config_t *config)
125 bool in_section = false;
126 bool end_of_section = false;
130 int key_len, value_len;
132 if (!file_map_open(&map, config->filename, false)) {
136 filter_init(&filter);
139 #define READ_LOG(Lev, Fmt, ...) \
140 __log(LOG_ ## Lev, "config file %s:%d:%d: " Fmt, config->filename, \
141 line + 1, (int)(p - linep + 1), ##__VA_ARGS__)
142 #define READ_ERROR(Fmt, ...) \
144 READ_LOG(ERR, Fmt, ##__VA_ARGS__); \
147 #define ADD_IN_BUFFER(Buffer, Len, Char) \
149 if ((Len) >= BUFSIZ - 1) { \
150 READ_ERROR("unreasonnable long line"); \
152 (Buffer)[(Len)++] = (Char); \
153 (Buffer)[(Len)] = '\0'; \
161 if (++p >= map.end) { \
162 if (!end_of_section) { \
173 bool in_comment = false; \
174 while (in_comment || isspace(*p) || *p == '#') { \
176 in_comment = false; \
177 } else if (*p == '#') { \
183 #define READ_TOKEN(Name, Buffer, Len) \
186 (Buffer)[0] = '\0'; \
187 if (!isalpha(*p)) { \
188 READ_ERROR("invalid %s, unexpected character '%c'", Name, *p); \
191 ADD_IN_BUFFER(Buffer, Len, *p); \
193 } while (isalnum(*p) || *p == '_'); \
195 #define READ_STRING(Name, Buffer, Len, Ignore) \
198 (Buffer)[0] = '\0'; \
200 bool escaped = false; \
201 while (*p == '"') { \
205 READ_ERROR("string must not contain EOL"); \
206 } else if (escaped) { \
207 ADD_IN_BUFFER(Buffer, Len, *p); \
209 } else if (*p == '\\') { \
211 } else if (*p == '"') { \
215 ADD_IN_BUFFER(Buffer, Len, *p); \
222 READ_ERROR("%s must end with a ';'", Name); \
225 bool escaped = false; \
226 while (*p != ';' && isascii(*p) && (isprint(*p) || isspace(*p))) { \
228 if (*p == '\r' || *p == '\n') { \
231 ADD_IN_BUFFER(Buffer, Len, '\\'); \
237 } else if (*p == '\r' || *p == '\n') { \
238 READ_ERROR("%s must not contain EOL", Name); \
240 ADD_IN_BUFFER(Buffer, Len, *p); \
245 ADD_IN_BUFFER(Buffer, Len, '\\'); \
247 while ((Len) > 0 && isspace((Buffer)[(Len) - 1])) { \
248 (Buffer)[--(Len)] = '\0'; \
251 end_of_section = Ignore; \
261 value[0] = key[0] = '\0';
262 value_len = key_len = 0;
264 in_section = end_of_section = false;
267 READ_TOKEN("section name", key, key_len);
272 goto read_param_value;
277 READ_ERROR("invalid character '%c', expected '=' or '{'", *p);
282 READ_STRING("parameter value", value, value_len, true);
284 filter_param_t param;
285 param.type = param_tokenize(key, key_len);
286 if (param.type != ATK_UNKNOWN) {
287 param.value = p_dupstr(value, value_len);
288 param.value_len = value_len;
289 array_add(config->params, param);
291 READ_LOG(INFO, "unknown parameter %.*s", key_len, key);
297 filter_set_name(&filter, key, key_len);
300 READ_TOKEN("filter parameter name", key, key_len);
303 READ_ERROR("invalid character '%c', expected '='", *p);
307 READ_STRING("filter parameter value", value, value_len, false);
309 if (strcmp(key, "type") == 0) {
310 if (!filter_set_type(&filter, value, value_len)) {
311 READ_ERROR("unknow filter type (%s) for filter %s",
314 } else if (key_len > 3 && strncmp(key, "on_", 3) == 0) {
315 if (!filter_add_hook(&filter, key + 3, key_len - 3,
317 READ_ERROR("hook %s not supported by filter %s",
318 key + 3, filter.name);
321 /* filter_add_param failure mean unknown type or unsupported type.
322 * this are non-fatal errors.
324 (void)filter_add_param(&filter, key, key_len, value, value_len);
327 end_of_section = true;
329 array_add(config->filters, filter);
330 filter_init(&filter);
334 file_map_close(&map);
338 err("Unexpected end of file");
342 filter_wipe(&filter);
344 file_map_close(&map);
348 static bool config_build_structure(config_t *config)
351 if (config->filters.len > 0) {
352 # define QSORT_TYPE filter_t
353 # define QSORT_BASE config->filters.data
354 # define QSORT_NELT config->filters.len
355 # define QSORT_LT(a,b) strcmp(a->name, b->name) < 0
359 foreach (filter_t *filter, config->filters) {
360 if (!filter_update_references(filter, &config->filters)) {
368 if (!filter_check_safety(&config->filters)) {
373 #define PARSE_CHECK(Expr, Fmt, ...) \
375 err(Fmt, ##__VA_ARGS__); \
378 foreach (filter_param_t *param, config->params) {
379 switch (param->type) {
380 #define CASE(Param, State) \
381 case ATK_ ## Param ## _FILTER: \
383 config->entry_points[SMTP_ ## State] \
384 = filter_find_with_name(&config->filters, param->value); \
385 PARSE_CHECK(config->entry_points[SMTP_ ## State] >= 0, \
386 "invalid filter name %s", param->value); \
388 CASE(CLIENT, CONNECT)
392 CASE(RECIPIENT, RCPT)
394 CASE(END_OF_DATA, END_OF_MESSAGE)
398 FILTER_PARAM_PARSE_INT(PORT, config->port);
402 array_deep_wipe(config->params, filter_params_wipe);
405 err("no entry point defined");
410 static bool config_build_filters(config_t *config)
412 foreach (filter_t *filter, config->filters) {
413 if (!filter_build(filter)) {
421 static bool config_load(config_t *config) {
422 config_close(config);
424 if (!config_parse(config)) {
425 err("Invalid configuration: cannot parse configuration file \"%s\"", config->filename);
428 if (!config_build_structure(config)) {
429 err("Invalid configuration: inconsistent filter structure");
432 if (!config_build_filters(config)) {
433 err("Invalid configuration: invalid filter");
437 resource_garbage_collect();
441 bool config_reload(config_t *config)
443 return config_load(config);
446 config_t *config_read(const char *file)
448 config_t *config = config_new();
449 config->filename = file;
450 if (!config_reload(config)) {
451 config_delete(&config);
457 bool config_check(const char *file)
459 config_t *config = config_new();
460 config->filename = file;
462 bool ret = config_parse(config) && config_build_structure(config);
464 config_delete(&config);