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
40 #define config_param_register(Param)
42 /* Filter to execute on "CONNECT"
44 config_param_register("client_filter");
46 /* Filter to execute on "MAIL FROM"
48 config_param_register("sender_filter");
50 /* Filter to execute on "RCPT TO"
52 config_param_register("recipient_filter");
54 /* Filter to execute on "DATA"
56 config_param_register("data_filter");
58 /* Filter to execute on "END-OF-DATA"
60 config_param_register("end_of_data_filter");
62 /* Filter to execute on "ETRN"
64 config_param_register("etrn_filter");
66 /* Filter to execute on "HELO"
68 config_param_register("helo_filter");
69 config_param_register("ehlo_filter");
71 /* Filter to execute on "VRFY"
73 config_param_register("verify_filter");
75 static inline config_t *config_new(void)
77 config_t *config = p_new(config_t, 1);
81 static void config_close(config_t *config)
83 for (int i = 0 ; i < SMTP_count ; ++i) {
84 config->entry_points[i] = -1;
86 array_deep_wipe(config->filters, filter_wipe);
87 array_deep_wipe(config->params, filter_params_wipe);
90 void config_delete(config_t **config)
93 config_close(*config);
99 static bool config_second_pass(config_t *config)
102 if (config->filters.len > 0) {
103 # define QSORT_TYPE filter_t
104 # define QSORT_BASE config->filters.data
105 # define QSORT_NELT config->filters.len
106 # define QSORT_LT(a,b) strcmp(a->name, b->name) < 0
110 foreach (filter_t *filter, config->filters) {
111 if (!filter_update_references(filter, &config->filters)) {
119 if (!filter_check_safety(&config->filters)) {
124 foreach (filter_param_t *param, config->params) {
125 switch (param->type) {
126 #define CASE(Param, State) \
127 case ATK_ ## Param ## _FILTER: \
129 config->entry_points[SMTP_ ## State] \
130 = filter_find_with_name(&config->filters, param->value); \
132 CASE(CLIENT, CONNECT)
136 CASE(RECIPIENT, RCPT)
138 CASE(END_OF_DATA, END_OF_MESSAGE)
145 array_deep_wipe(config->params, filter_params_wipe);
148 syslog(LOG_ERR, "no entry point defined");
154 static bool config_load(config_t *config)
161 bool in_section = false;
162 bool end_of_section = false;
166 ssize_t key_len, value_len;
168 if (!file_map_open(&map, config->filename, false)) {
172 config_close(config);
173 filter_init(&filter);
176 #define READ_LOG(Lev, Fmt, ...) \
177 syslog(LOG_ ## Lev, "config file %s:%d:%d: " Fmt, config->filename, \
178 line + 1, p - linep + 1, ##__VA_ARGS__)
179 #define READ_ERROR(Fmt, ...) \
181 READ_LOG(ERR, Fmt, ##__VA_ARGS__); \
184 #define ADD_IN_BUFFER(Buffer, Len, Char) \
186 if ((Len) >= BUFSIZ - 1) { \
187 READ_ERROR("unreasonnable long line"); \
189 (Buffer)[(Len)++] = (Char); \
190 (Buffer)[(Len)] = '\0'; \
198 if (++p >= map.end) { \
199 if (!end_of_section) { \
210 bool in_comment = false; \
211 while (in_comment || isspace(*p) || *p == '#') { \
213 in_comment = false; \
214 } else if (*p == '#') { \
220 #define READ_TOKEN(Name, Buffer, Len) \
223 (Buffer)[0] = '\0'; \
224 if (!isalpha(*p)) { \
225 READ_ERROR("invalid %s, unexpected character '%c'", Name, *p); \
228 ADD_IN_BUFFER(Buffer, Len, *p); \
230 } while (isalnum(*p) || *p == '_'); \
232 #define READ_STRING(Name, Buffer, Len, Ignore) \
235 (Buffer)[0] = '\0'; \
237 bool escaped = false; \
238 while (*p == '"') { \
242 READ_ERROR("string must not contain EOL"); \
243 } else if (escaped) { \
244 ADD_IN_BUFFER(Buffer, Len, *p); \
246 } else if (*p == '\\') { \
248 } else if (*p == '"') { \
252 ADD_IN_BUFFER(Buffer, Len, *p); \
259 READ_ERROR("%s must end with a ';'", Name); \
262 bool escaped = false; \
263 while (*p != ';' && isascii(*p) && (isprint(*p) || isspace(*p))) { \
265 if (*p == '\r' || *p == '\n') { \
268 ADD_IN_BUFFER(Buffer, Len, '\\'); \
274 } else if (*p == '\r' || *p == '\n') { \
275 READ_ERROR("%s must not contain EOL", Name); \
277 ADD_IN_BUFFER(Buffer, Len, *p); \
282 ADD_IN_BUFFER(Buffer, Len, '\\'); \
284 while ((Len) > 0 && isspace((Buffer)[(Len) - 1])) { \
285 (Buffer)[--(Len)] = '\0'; \
288 end_of_section = Ignore; \
298 value[0] = key[0] = '\0';
299 value_len = key_len = 0;
301 in_section = end_of_section = false;
304 READ_TOKEN("section name", key, key_len);
309 goto read_param_value;
314 READ_ERROR("invalid character '%c', expected '=' or '{'", *p);
319 READ_STRING("parameter value", value, value_len, true);
321 filter_param_t param;
322 param.type = param_tokenize(key, key_len);
323 if (param.type != ATK_UNKNOWN) {
324 param.value = p_dupstr(value, value_len);
325 param.value_len = value_len;
326 array_add(config->params, param);
328 READ_LOG(INFO, "unknown parameter %.*s", key_len, key);
334 filter_set_name(&filter, key, key_len);
337 READ_TOKEN("filter parameter name", key, key_len);
340 READ_ERROR("invalid character '%c', expected '='", *p);
344 READ_STRING("filter parameter value", value, value_len, false);
346 if (strcmp(key, "type") == 0) {
347 if (!filter_set_type(&filter, value, value_len)) {
348 READ_ERROR("unknow filter type (%s) for filter %s",
351 } else if (key_len > 3 && strncmp(key, "on_", 3) == 0) {
352 if (!filter_add_hook(&filter, key + 3, key_len - 3,
354 READ_ERROR("hook %s not supported by filter %s",
355 key + 3, filter.name);
358 /* filter_add_param failure mean unknown type or unsupported type.
359 * this are non-fatal errors.
361 (void)filter_add_param(&filter, key, key_len, value, value_len);
364 end_of_section = true;
366 if (!filter_build(&filter)) {
367 READ_ERROR("invalid filter %s", filter.name);
369 array_add(config->filters, filter);
370 filter_init(&filter);
374 if (!config_second_pass(config)) {
377 file_map_close(&map);
381 syslog(LOG_ERR, "Unexpected end of file");
385 filter_wipe(&filter);
387 file_map_close(&map);
391 bool config_reload(config_t *config)
393 return config_load(config);
396 config_t *config_read(const char *file)
398 config_t *config = config_new();
399 config->filename = file;
400 if (!config_reload(config)) {