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     for (int i = 0 ; i < SMTP_count ; ++i) {
  79         config->entry_points[i] = -1;
  80     }
  81     return config;
  82 }
  83
  84 void config_delete(config_t **config)
  85 {
  86     if (*config) {
  87         array_deep_wipe((*config)->filters, filter_wipe);
  88         array_deep_wipe((*config)->params, filter_params_wipe);
  89         p_delete(config);
  90     }
  91 }
  92
  93
  94 static bool config_second_pass(config_t *config)
  95 {
  96     bool ok = true;
  97     if (config->filters.len > 0) {
  98 #       define QSORT_TYPE filter_t
  99 #       define QSORT_BASE config->filters.data
 100 #       define QSORT_NELT config->filters.len
 101 #       define QSORT_LT(a,b) strcmp(a->name, b->name) < 0
 102 #       include "qsort.c"
 103     }
 104
 105     foreach (filter_t *filter, config->filters) {
 106         if (!filter_update_references(filter, &config->filters)) {
 107             ok = false;
 108             break;
 109         }
 110     }}
 111     if (!ok) {
 112         return false;
 113     }
 114
 115     ok = false;
 116     foreach (filter_param_t *param, config->params) {
 117         switch (param->type) {
 118 #define   CASE(Param, State)                                                   \
 119             case ATK_ ## Param ## _FILTER:                                     \
 120               ok = true;                                                       \
 121               config->entry_points[SMTP_ ## State]                             \
 122                   = filter_find_with_name(&config->filters, param->value);     \
 123               break;
 124           CASE(CLIENT,      CONNECT)
 125           CASE(EHLO,        EHLO)
 126           CASE(HELO,        HELO)
 127           CASE(SENDER,      MAIL)
 128           CASE(RECIPIENT,   RCPT)
 129           CASE(DATA,        DATA)
 130           CASE(END_OF_DATA, END_OF_MESSAGE)
 131           CASE(VERIFY,      VRFY)
 132           CASE(ETRN,        ETRN)
 133 #undef    CASE
 134           default: break;
 135         }
 136     }}
 137     array_deep_wipe(config->params, filter_params_wipe);
 138
 139     if (!ok) {
 140         syslog(LOG_ERR, "no entry point defined");
 141     }
 142
 143     return ok;
 144 }
 145
 146 config_t *config_read(const char *file)
 147 {
 148     config_t *config;
 149     filter_t filter;
 150     file_map_t map;
 151     const char *p;
 152     int line = 0;
 153     const char *linep;
 154
 155     char key[BUFSIZ];
 156     char value[BUFSIZ];
 157     ssize_t key_len, value_len;
 158
 159     if (!file_map_open(&map, file, false)) {
 160         return false;
 161     }
 162
 163     config = config_new();
 164     filter_init(&filter);
 165     linep = p = map.map;
 166
 167 #define READ_ERROR(Fmt, ...)                                                   \
 168     do {                                                                       \
 169         syslog(LOG_ERR, "config file %s:%d:%d: " Fmt, file, line + 1,          \
 170                p - linep + 1, ##__VA_ARGS__);                                  \
 171         goto error;                                                            \
 172     } while (0)
 173 #define ADD_IN_BUFFER(Buffer, Len, Char)                                       \
 174     do {                                                                       \
 175         if ((Len) >= BUFSIZ - 1) {                                             \
 176             READ_ERROR("unreasonnable long line");                             \
 177         }                                                                      \
 178         (Buffer)[(Len)++] = (Char);                                            \
 179         (Buffer)[(Len)]   = '\0';                                              \
 180     } while (0)
 181 #define READ_NEXT(OnEOF)                                                       \
 182     do {                                                                       \
 183         if (*p == '\n') {                                                      \
 184             ++line;                                                            \
 185             linep = p + 1;                                                     \
 186         }                                                                      \
 187         if (++p >= map.end) {                                                  \
 188             OnEOF;                                                             \
 189         }                                                                      \
 190     } while (0)
 191 #define READ_BLANK(OnEOF)                                                      \
 192     do {                                                                       \
 193         bool in_comment = false;                                               \
 194         while (in_comment || isspace(*p) || *p == '#') {                       \
 195             if (*p == '\n') {                                                  \
 196                 in_comment = false;                                            \
 197             } else if (*p == '#') {                                            \
 198                 in_comment = true;                                             \
 199             }                                                                  \
 200             READ_NEXT(OnEOF);                                                  \
 201         }                                                                      \
 202     } while (0)
 203 #define READ_TOKEN(Name, Buffer, Len)                                          \
 204     do {                                                                       \
 205         (Len) = 0;                                                             \
 206         (Buffer)[0] = '\0';                                                    \
 207         if (!isalpha(*p)) {                                                    \
 208             READ_ERROR("invalid %s, unexpected character '%c'", Name, *p);     \
 209         }                                                                      \
 210         do {                                                                   \
 211             ADD_IN_BUFFER(Buffer, Len, *p);                                    \
 212             READ_NEXT(goto badeof);                                            \
 213         } while (isalnum(*p) || *p == '_');                                    \
 214     } while (0)
 215 #define READ_STRING(Name, Buffer, Len, OnEOF)                                  \
 216     do {                                                                       \
 217         (Len) = 0;                                                             \
 218         (Buffer)[0] = '\0';                                                    \
 219         if (*p == '"') {                                                       \
 220             bool escaped = false;                                              \
 221             while (*p == '"') {                                                \
 222                 READ_NEXT(goto badeof);                                        \
 223                 while (true) {                                                 \
 224                     if (*p == '\n') {                                          \
 225                         READ_ERROR("string must not contain EOL");             \
 226                     } else if (escaped) {                                      \
 227                         ADD_IN_BUFFER(Buffer, Len, *p);                        \
 228                         escaped = false;                                       \
 229                     } else if (*p == '\\') {                                   \
 230                         escaped = true;                                        \
 231                     } else if (*p == '"') {                                    \
 232                         READ_NEXT(goto badeof);                                \
 233                         break;                                                 \
 234                     } else {                                                   \
 235                         ADD_IN_BUFFER(Buffer, Len, *p);                        \
 236                     }                                                          \
 237                     READ_NEXT(goto badeof);                                    \
 238                 }                                                              \
 239                 READ_BLANK(goto badeof);                                       \
 240             }                                                                  \
 241             if (*p != ';') {                                                   \
 242                 READ_ERROR("%s must end with a ';'", Name);                    \
 243             }                                                                  \
 244         } else {                                                               \
 245             bool escaped = false;                                              \
 246             while (*p != ';' && isascii(*p) && (isprint(*p) || isspace(*p))) { \
 247                 if (escaped) {                                                 \
 248                     if (*p == '\r' || *p == '\n') {                            \
 249                         READ_BLANK(goto badeof);                               \
 250                     } else {                                                   \
 251                         ADD_IN_BUFFER(Buffer, Len, '\\');                      \
 252                     }                                                          \
 253                     escaped = false;                                           \
 254                 }                                                              \
 255                 if (*p == '\\') {                                              \
 256                     escaped = true;                                            \
 257                 } else if (*p == '\r' || *p == '\n') {                         \
 258                     READ_ERROR("%s must not contain EOL", Name);               \
 259                 } else {                                                       \
 260                     ADD_IN_BUFFER(Buffer, Len, *p);                            \
 261                 }                                                              \
 262                 READ_NEXT(goto badeof);                                        \
 263             }                                                                  \
 264             if (escaped) {                                                     \
 265                 ADD_IN_BUFFER(Buffer, Len, '\\');                              \
 266             }                                                                  \
 267         }                                                                      \
 268         READ_NEXT(OnEOF);                                                      \
 269     } while(0)
 270
 271
 272 read_section:
 273     if (p >= map.end) {
 274         goto ok;
 275     }
 276
 277     value[0] = key[0] = '\0';
 278     value_len = key_len = 0;
 279
 280     READ_BLANK(goto ok);
 281     READ_TOKEN("section name", key, key_len);
 282     READ_BLANK(goto badeof);
 283     switch (*p) {
 284       case '=':
 285         READ_NEXT(goto badeof);
 286         goto read_param_value;
 287       case '{':
 288         READ_NEXT(goto badeof);
 289         goto read_filter;
 290       default:
 291         READ_ERROR("invalid character '%c', expected '=' or '{'", *p);
 292     }
 293
 294 read_param_value:
 295     READ_BLANK(goto badeof);
 296     READ_STRING("parameter value", value, value_len, ;);
 297     {
 298         filter_param_t param;
 299         param.type  = param_tokenize(key, key_len);
 300         if (param.type != ATK_UNKNOWN) {
 301             param.value = m_strdup(value);
 302             array_add(config->params, param);
 303         }
 304     }
 305     goto read_section;
 306
 307 read_filter:
 308     filter_set_name(&filter, key, key_len);
 309     READ_BLANK(goto badeof);
 310     while (*p != '}') {
 311         READ_TOKEN("filter parameter name", key, key_len);
 312         READ_BLANK(goto badeof);
 313         if (*p != '=') {
 314             READ_ERROR("invalid character '%c', expected '='", *p);
 315         }
 316         READ_NEXT(goto badeof);
 317         READ_BLANK(goto badeof);
 318         READ_STRING("filter parameter value", value, value_len, goto badeof);
 319         READ_BLANK(goto badeof);
 320         if (strcmp(key, "type") == 0) {
 321             if (!filter_set_type(&filter, value, value_len)) {
 322                 READ_ERROR("unknow filter type (%s) for filter %s",
 323                            value, filter.name);
 324             }
 325         } else if (key_len > 3 && strncmp(key, "on_", 3) == 0) {
 326             if (!filter_add_hook(&filter, key + 3, key_len - 3,
 327                                  value, value_len)) {
 328                 READ_ERROR("hook %s not supported by filter %s",
 329                            key + 3, filter.name);
 330             }
 331         } else {
 332             /* filter_add_param failure mean unknown type or unsupported type.
 333              * this are non-fatal errors.
 334              */
 335             (void)filter_add_param(&filter, key, key_len, value, value_len);
 336         }
 337     }
 338     READ_NEXT(;);
 339     if (!filter_build(&filter)) {
 340         READ_ERROR("invalid filter %s", filter.name);
 341     }
 342     array_add(config->filters, filter);
 343     filter_init(&filter);
 344     goto read_section;
 345
 346 ok:
 347     if (!config_second_pass(config)) {
 348         goto error;
 349     }
 350     file_map_close(&map);
 351     return config;
 352
 353 badeof:
 354     syslog(LOG_ERR, "Unexpected end of file");
 355
 356 error:
 357     if (filter.name) {
 358         filter_wipe(&filter);
 359     }
 360     config_delete(&config);
 361     file_map_close(&map);
 362     return NULL;
 363 }