postlicyd/config.c

   1 /******************************************************************************/
   2 /*          pfixtools: a collection of postfix related tools                  */
   3 /*          ~~~~~~~~~                                                         */
   4 /*  ________________________________________________________________________  */
   5 /*                                                                            */
   6 /*  Redistribution and use in source and binary forms, with or without        */
   7 /*  modification, are permitted provided that the following conditions        */
   8 /*  are met:                                                                  */
   9 /*                                                                            */
  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     */
  17 /*     permission.                                                            */
  18 /*                                                                            */
  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 /******************************************************************************/
  31
  32 /*
  33  * Copyright © 2008 Florent Bruneau
  34  */
  35
  36 #include "file.h"
  37 #include "config.h"
  38 #include "str.h"
  39
  40 #define config_param_register(Param)
  41
  42 /* Filter to execute on "CONNECT"
  43  */
  44 config_param_register("client_filter");
  45
  46 /* Filter to execute on "MAIL FROM"
  47  */
  48 config_param_register("sender_filter");
  49
  50 /* Filter to execute on "RCPT TO"
  51  */
  52 config_param_register("recipient_filter");
  53
  54 /* Filter to execute on "DATA"
  55  */
  56 config_param_register("data_filter");
  57
  58 /* Filter to execute on "END-OF-DATA"
  59  */
  60 config_param_register("end_of_data_filter");
  61
  62 /* Filter to execute on "ETRN"
  63  */
  64 config_param_register("etrn_filter");
  65
  66 /* Filter to execute on "HELO"
  67  */
  68 config_param_register("helo_filter");
  69 config_param_register("ehlo_filter");
  70
  71 /* Filter to execute on "VRFY"
  72  */
  73 config_param_register("verify_filter");
  74
  75 static inline config_t *config_new(void)
  76 {
  77     config_t *config = p_new(config_t, 1);
  78     return config;
  79 }
  80
  81 static void config_close(config_t *config)
  82 {
  83     for (int i = 0 ; i < SMTP_count ; ++i) {
  84         config->entry_points[i] = -1;
  85     }
  86     array_deep_wipe(config->filters, filter_wipe);
  87     array_deep_wipe(config->params, filter_params_wipe);
  88 }
  89
  90 void config_delete(config_t **config)
  91 {
  92     if (*config) {
  93         config_close(*config);
  94         p_delete(config);
  95     }
  96 }
  97
  98
  99 static bool config_second_pass(config_t *config)
 100 {
 101     bool ok = true;
 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
 107 #       include "qsort.c"
 108     }
 109
 110     foreach (filter_t *filter, config->filters) {
 111         if (!filter_update_references(filter, &config->filters)) {
 112             ok = false;
 113             break;
 114         }
 115     }}
 116     if (!ok) {
 117         return false;
 118     }
 119     if (!filter_check_safety(&config->filters)) {
 120         return false;
 121     }
 122
 123     ok = false;
 124     foreach (filter_param_t *param, config->params) {
 125         switch (param->type) {
 126 #define   CASE(Param, State)                                                   \
 127             case ATK_ ## Param ## _FILTER:                                     \
 128               ok = true;                                                       \
 129               config->entry_points[SMTP_ ## State]                             \
 130                   = filter_find_with_name(&config->filters, param->value);     \
 131               break;
 132           CASE(CLIENT,      CONNECT)
 133           CASE(EHLO,        EHLO)
 134           CASE(HELO,        HELO)
 135           CASE(SENDER,      MAIL)
 136           CASE(RECIPIENT,   RCPT)
 137           CASE(DATA,        DATA)
 138           CASE(END_OF_DATA, END_OF_MESSAGE)
 139           CASE(VERIFY,      VRFY)
 140           CASE(ETRN,        ETRN)
 141 #undef    CASE
 142           default: break;
 143         }
 144     }}
 145     array_deep_wipe(config->params, filter_params_wipe);
 146
 147     if (!ok) {
 148         syslog(LOG_ERR, "no entry point defined");
 149     }
 150
 151     return ok;
 152 }
 153
 154 static bool config_load(config_t *config)
 155 {
 156     filter_t filter;
 157     file_map_t map;
 158     const char *p;
 159     int line = 0;
 160     const char *linep;
 161
 162     char key[BUFSIZ];
 163     char value[BUFSIZ];
 164     ssize_t key_len, value_len;
 165
 166     if (!file_map_open(&map, config->filename, false)) {
 167         return false;
 168     }
 169
 170     config_close(config);
 171     filter_init(&filter);
 172     linep = p = map.map;
 173
 174 #define READ_ERROR(Fmt, ...)                                                   \
 175     do {                                                                       \
 176         syslog(LOG_ERR, "config file %s:%d:%d: " Fmt, config->filename,        \
 177                line + 1, p - linep + 1, ##__VA_ARGS__);                        \
 178         goto error;                                                            \
 179     } while (0)
 180 #define ADD_IN_BUFFER(Buffer, Len, Char)                                       \
 181     do {                                                                       \
 182         if ((Len) >= BUFSIZ - 1) {                                             \
 183             READ_ERROR("unreasonnable long line");                             \
 184         }                                                                      \
 185         (Buffer)[(Len)++] = (Char);                                            \
 186         (Buffer)[(Len)]   = '\0';                                              \
 187     } while (0)
 188 #define READ_NEXT(OnEOF)                                                       \
 189     do {                                                                       \
 190         if (*p == '\n') {                                                      \
 191             ++line;                                                            \
 192             linep = p + 1;                                                     \
 193         }                                                                      \
 194         if (++p >= map.end) {                                                  \
 195             OnEOF;                                                             \
 196         }                                                                      \
 197     } while (0)
 198 #define READ_BLANK(OnEOF)                                                      \
 199     do {                                                                       \
 200         bool in_comment = false;                                               \
 201         while (in_comment || isspace(*p) || *p == '#') {                       \
 202             if (*p == '\n') {                                                  \
 203                 in_comment = false;                                            \
 204             } else if (*p == '#') {                                            \
 205                 in_comment = true;                                             \
 206             }                                                                  \
 207             READ_NEXT(OnEOF);                                                  \
 208         }                                                                      \
 209     } while (0)
 210 #define READ_TOKEN(Name, Buffer, Len)                                          \
 211     do {                                                                       \
 212         (Len) = 0;                                                             \
 213         (Buffer)[0] = '\0';                                                    \
 214         if (!isalpha(*p)) {                                                    \
 215             READ_ERROR("invalid %s, unexpected character '%c'", Name, *p);     \
 216         }                                                                      \
 217         do {                                                                   \
 218             ADD_IN_BUFFER(Buffer, Len, *p);                                    \
 219             READ_NEXT(goto badeof);                                            \
 220         } while (isalnum(*p) || *p == '_');                                    \
 221     } while (0)
 222 #define READ_STRING(Name, Buffer, Len, OnEOF)                                  \
 223     do {                                                                       \
 224         (Len) = 0;                                                             \
 225         (Buffer)[0] = '\0';                                                    \
 226         if (*p == '"') {                                                       \
 227             bool escaped = false;                                              \
 228             while (*p == '"') {                                                \
 229                 READ_NEXT(goto badeof);                                        \
 230                 while (true) {                                                 \
 231                     if (*p == '\n') {                                          \
 232                         READ_ERROR("string must not contain EOL");             \
 233                     } else if (escaped) {                                      \
 234                         ADD_IN_BUFFER(Buffer, Len, *p);                        \
 235                         escaped = false;                                       \
 236                     } else if (*p == '\\') {                                   \
 237                         escaped = true;                                        \
 238                     } else if (*p == '"') {                                    \
 239                         READ_NEXT(goto badeof);                                \
 240                         break;                                                 \
 241                     } else {                                                   \
 242                         ADD_IN_BUFFER(Buffer, Len, *p);                        \
 243                     }                                                          \
 244                     READ_NEXT(goto badeof);                                    \
 245                 }                                                              \
 246                 READ_BLANK(goto badeof);                                       \
 247             }                                                                  \
 248             if (*p != ';') {                                                   \
 249                 READ_ERROR("%s must end with a ';'", Name);                    \
 250             }                                                                  \
 251         } else {                                                               \
 252             bool escaped = false;                                              \
 253             while (*p != ';' && isascii(*p) && (isprint(*p) || isspace(*p))) { \
 254                 if (escaped) {                                                 \
 255                     if (*p == '\r' || *p == '\n') {                            \
 256                         READ_BLANK(goto badeof);                               \
 257                     } else {                                                   \
 258                         ADD_IN_BUFFER(Buffer, Len, '\\');                      \
 259                     }                                                          \
 260                     escaped = false;                                           \
 261                 }                                                              \
 262                 if (*p == '\\') {                                              \
 263                     escaped = true;                                            \
 264                 } else if (*p == '\r' || *p == '\n') {                         \
 265                     READ_ERROR("%s must not contain EOL", Name);               \
 266                 } else {                                                       \
 267                     ADD_IN_BUFFER(Buffer, Len, *p);                            \
 268                 }                                                              \
 269                 READ_NEXT(goto badeof);                                        \
 270             }                                                                  \
 271             if (escaped) {                                                     \
 272                 ADD_IN_BUFFER(Buffer, Len, '\\');                              \
 273             }                                                                  \
 274             while ((Len) > 0 && isspace((Buffer)[(Len) - 1])) {                \
 275                 (Buffer)[--(Len)] = '\0';                                      \
 276             }                                                                  \
 277         }                                                                      \
 278         READ_NEXT(OnEOF);                                                      \
 279     } while(0)
 280
 281
 282 read_section:
 283     if (p >= map.end) {
 284         goto ok;
 285     }
 286
 287     value[0] = key[0] = '\0';
 288     value_len = key_len = 0;
 289
 290     READ_BLANK(goto ok);
 291     READ_TOKEN("section name", key, key_len);
 292     READ_BLANK(goto badeof);
 293     switch (*p) {
 294       case '=':
 295         READ_NEXT(goto badeof);
 296         goto read_param_value;
 297       case '{':
 298         READ_NEXT(goto badeof);
 299         goto read_filter;
 300       default:
 301         READ_ERROR("invalid character '%c', expected '=' or '{'", *p);
 302     }
 303
 304 read_param_value:
 305     READ_BLANK(goto badeof);
 306     READ_STRING("parameter value", value, value_len, ;);
 307     {
 308         filter_param_t param;
 309         param.type  = param_tokenize(key, key_len);
 310         if (param.type != ATK_UNKNOWN) {
 311             param.value     = p_dupstr(value, value_len);
 312             param.value_len = value_len;
 313             array_add(config->params, param);
 314         }
 315     }
 316     goto read_section;
 317
 318 read_filter:
 319     filter_set_name(&filter, key, key_len);
 320     READ_BLANK(goto badeof);
 321     while (*p != '}') {
 322         READ_TOKEN("filter parameter name", key, key_len);
 323         READ_BLANK(goto badeof);
 324         if (*p != '=') {
 325             READ_ERROR("invalid character '%c', expected '='", *p);
 326         }
 327         READ_NEXT(goto badeof);
 328         READ_BLANK(goto badeof);
 329         READ_STRING("filter parameter value", value, value_len, goto badeof);
 330         READ_BLANK(goto badeof);
 331         if (strcmp(key, "type") == 0) {
 332             if (!filter_set_type(&filter, value, value_len)) {
 333                 READ_ERROR("unknow filter type (%s) for filter %s",
 334                            value, filter.name);
 335             }
 336         } else if (key_len > 3 && strncmp(key, "on_", 3) == 0) {
 337             if (!filter_add_hook(&filter, key + 3, key_len - 3,
 338                                  value, value_len)) {
 339                 READ_ERROR("hook %s not supported by filter %s",
 340                            key + 3, filter.name);
 341             }
 342         } else {
 343             /* filter_add_param failure mean unknown type or unsupported type.
 344              * this are non-fatal errors.
 345              */
 346             (void)filter_add_param(&filter, key, key_len, value, value_len);
 347         }
 348     }
 349     READ_NEXT(;);
 350     if (!filter_build(&filter)) {
 351         READ_ERROR("invalid filter %s", filter.name);
 352     }
 353     array_add(config->filters, filter);
 354     filter_init(&filter);
 355     goto read_section;
 356
 357 ok:
 358     if (!config_second_pass(config)) {
 359         goto error;
 360     }
 361     file_map_close(&map);
 362     return true;
 363
 364 badeof:
 365     syslog(LOG_ERR, "Unexpected end of file");
 366
 367 error:
 368     if (filter.name) {
 369         filter_wipe(&filter);
 370     }
 371     file_map_close(&map);
 372     return false;
 373 }
 374
 375 bool config_reload(config_t *config)
 376 {
 377     return config_load(config);
 378 }
 379
 380 config_t *config_read(const char *file)
 381 {
 382     config_t *config = config_new();
 383     config->filename = file;
 384     if (!config_reload(config)) {
 385         p_delete(&config);
 386         return NULL;
 387     }
 388     return config;
 389 }