postlicyd/rbl.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 © 2007 Pierre Habouzit
  34  * Copyright © 2008 Florent Bruneau
  35  */
  36
  37 #include <arpa/inet.h>
  38 #include <netinet/in.h>
  39 #include <sys/mman.h>
  40
  41 #include "common.h"
  42 #include "rbl.h"
  43 #include "str.h"
  44 #include "file.h"
  45 #include "array.h"
  46
  47 #define IPv4_BITS        5
  48 #define IPv4_PREFIX(ip)  ((uint32_t)(ip) >> IPv4_BITS)
  49 #define IPv4_SUFFIX(ip)  ((uint32_t)(ip) & ((1 << IPv4_BITS) - 1))
  50 #define NODE(db, i)      ((db)->tree + (i))
  51 #ifndef DEBUG
  52 #define DEBUG(...)
  53 #endif
  54
  55 /* Implementation */
  56
  57 enum {
  58     BALANCED    = 0,
  59     LEFT_HEAVY  = 1,
  60     RIGHT_HEAVY = 2,
  61 };
  62
  63 struct rbldb_t {
  64     A(uint16_t) ips[1 << 16];
  65 };
  66 ARRAY(rbldb_t)
  67
  68 static int get_o(const char *s, const char **out)
  69 {
  70     int res = 0;
  71
  72     if (*s < '0' || *s > '9')
  73         return -1;
  74
  75     res = *s++ - '0';
  76     if (*s < '0' || *s > '9')
  77         goto ok;
  78
  79     res = res * 10 + *s++ - '0';
  80     if (*s < '0' || *s > '9')
  81         goto ok;
  82
  83     res = res * 10 + *s++ - '0';
  84     if (!(*s < '0' || *s > '9') || res < 100)
  85         return -1;
  86
  87   ok:
  88     *out = s;
  89     return res;
  90 }
  91
  92 static int parse_ipv4(const char *s, const char **out, uint32_t *ip)
  93 {
  94     int o;
  95
  96     o = get_o(s, &s);
  97     if ((o & ~0xff) || *s++ != '.')
  98         return -1;
  99     *ip = o << 24;
 100
 101     o = get_o(s, &s);
 102     if ((o & ~0xff) || *s++ != '.')
 103         return -1;
 104     *ip |= o << 16;
 105
 106     o = get_o(s, &s);
 107     if ((o & ~0xff) || *s++ != '.')
 108         return -1;
 109     *ip |= o << 8;
 110
 111     o = get_o(s, &s);
 112     if (o & ~0xff)
 113         return -1;
 114     *ip |= o;
 115
 116     *out = s;
 117     return 0;
 118 }
 119
 120 rbldb_t *rbldb_create(const char *file, bool lock)
 121 {
 122     rbldb_t *db;
 123     file_map_t map;
 124     const char *p, *end;
 125     uint32_t ips = 0;
 126
 127     if (!file_map_open(&map, file, false)) {
 128         return NULL;
 129     }
 130
 131     p   = map.map;
 132     end = map.end;
 133     while (end > p && end[-1] != '\n') {
 134         --end;
 135     }
 136     if (end != map.end) {
 137         warn("file %s miss a final \\n, ignoring last line",
 138              file);
 139     }
 140
 141     db = p_new(rbldb_t, 1);
 142     while (p < end) {
 143         uint32_t ip;
 144
 145         while (*p == ' ' || *p == '\t' || *p == '\r')
 146             p++;
 147
 148         if (parse_ipv4(p, &p, &ip) < 0) {
 149             p = (char *)memchr(p, '\n', end - p) + 1;
 150         } else {
 151             array_add(db->ips[ip >> 16], ip & 0xffff);
 152             ++ips;
 153         }
 154     }
 155     file_map_close(&map);
 156
 157     /* Lookup may perform serveral I/O, so avoid swap.
 158      */
 159     for (int i = 0 ; i < 1 << 16 ; ++i) {
 160         array_adjust(db->ips[i]);
 161         if (lock && !array_lock(db->ips[i])) {
 162             UNIXERR("mlock");
 163         }
 164         if (db->ips[i].len) {
 165 #       define QSORT_TYPE uint16_t
 166 #       define QSORT_BASE db->ips[i].data
 167 #       define QSORT_NELT db->ips[i].len
 168 #       define QSORT_LT(a,b) *a < *b
 169 #       include "qsort.c"
 170         }
 171     }
 172
 173     info("rbl %s loaded, %d IPs", file, ips);
 174     return db;
 175 }
 176
 177 static void rbldb_wipe(rbldb_t *db)
 178 {
 179     for (int i = 0 ; i < 1 << 16 ; ++i) {
 180         array_wipe(db->ips[i]);
 181     }
 182 }
 183
 184 void rbldb_delete(rbldb_t **db)
 185 {
 186     if (*db) {
 187         rbldb_wipe(*db);
 188         p_delete(&(*db));
 189     }
 190 }
 191
 192 uint32_t rbldb_stats(const rbldb_t *rbl)
 193 {
 194     uint32_t ips = 0;
 195     for (int i = 0 ; i < 1 << 16 ; ++i) {
 196         ips += array_len(rbl->ips[i]);
 197     }
 198     printf("memory overhead of rbldb: %u\n", sizeof(rbldb_t));
 199     return ips;
 200 }
 201
 202 bool rbldb_ipv4_lookup(const rbldb_t *db, uint32_t ip)
 203 {
 204     const uint16_t hip = ip >> 16;
 205     const uint16_t lip = ip & 0xffff;
 206     int l = 0, r = db->ips[hip].len;
 207
 208     while (l < r) {
 209         int i = (r + l) / 2;
 210
 211         if (array_elt(db->ips[hip], i) == lip)
 212             return true;
 213
 214         if (lip < array_elt(db->ips[hip], i)) {
 215             r = i;
 216         } else {
 217             l = i + 1;
 218         }
 219     }
 220     return false;
 221 }
 222
 223
 224 /* postlicyd filter declaration */
 225
 226 #include "filter.h"
 227
 228 typedef struct rbl_filter_t {
 229     PA(rbldb_t) rbls;
 230     A(int)      weights;
 231
 232     int32_t     hard_threshold;
 233     int32_t     soft_threshold;
 234 } rbl_filter_t;
 235
 236 static rbl_filter_t *rbl_filter_new(void)
 237 {
 238     return p_new(rbl_filter_t, 1);
 239 }
 240
 241 static void rbl_filter_delete(rbl_filter_t **rbl)
 242 {
 243     if (*rbl) {
 244         array_deep_wipe((*rbl)->rbls, rbldb_delete);
 245         array_wipe((*rbl)->weights);
 246         p_delete(rbl);
 247     }
 248 }
 249
 250
 251 static bool rbl_filter_constructor(filter_t *filter)
 252 {
 253     rbl_filter_t *data = rbl_filter_new();
 254
 255 #define PARSE_CHECK(Expr, Str, ...)                                            \
 256     if (!(Expr)) {                                                             \
 257         err(Str, ##__VA_ARGS__);                                               \
 258         rbl_filter_delete(&data);                                              \
 259         return false;                                                          \
 260     }
 261
 262     data->hard_threshold = 1;
 263     data->soft_threshold = 1;
 264     foreach (filter_param_t *param, filter->params) {
 265         switch (param->type) {
 266           /* file parameter is:
 267            *  [no]lock:weight:filename
 268            *  valid options are:
 269            *    - lock:   memlock the database in memory.
 270            *    - nolock: don't memlock the database in memory [default].
 271            *    - \d+:    a number describing the weight to give to the match
 272            *              the given list [mandatory]
 273            *  the file pointed by filename MUST be a valid ip list issued from
 274            *  the rsync (or equivalent) service of a (r)bl.
 275            */
 276           case ATK_FILE: {
 277             bool lock = false;
 278             int  weight = 0;
 279             rbldb_t *rbl = NULL;
 280             const char *current = param->value;
 281             const char *p = m_strchrnul(param->value, ':');
 282             char *next = NULL;
 283             for (int i = 0 ; i < 3 ; ++i) {
 284                 PARSE_CHECK(i == 2 || *p,
 285                             "file parameter must contains a locking state "
 286                             "and a weight option");
 287                 switch (i) {
 288                   case 0:
 289                     if ((p - current) == 4 && strncmp(current, "lock", 4) == 0) {
 290                         lock = true;
 291                     } else if ((p - current) == 6
 292                                && strncmp(current, "nolock", 6) == 0) {
 293                         lock = false;
 294                     } else {
 295                         PARSE_CHECK(false, "illegal locking state %.*s",
 296                                     p - current, current);
 297                     }
 298                     break;
 299
 300                   case 1:
 301                     weight = strtol(current, &next, 10);
 302                     PARSE_CHECK(next == p && weight >= 0 && weight <= 1024,
 303                                 "illegal weight value %.*s",
 304                                 (p - current), current);
 305                     break;
 306
 307                   case 2:
 308                     rbl = rbldb_create(current, lock);
 309                     PARSE_CHECK(rbl != NULL,
 310                                 "cannot load rbl db from %s", current);
 311                     array_add(data->rbls, rbl);
 312                     array_add(data->weights, weight);
 313                     break;
 314                 }
 315                 if (i != 2) {
 316                     current = p + 1;
 317                     p = m_strchrnul(current, ':');
 318                 }
 319             }
 320           } break;
 321
 322           /* hard_threshold parameter is an integer.
 323            *  If the matching score is greater or equal than this threshold,
 324            *  the hook "hard_match" is called.
 325            * hard_threshold = 1 means, that all matches are hard matches.
 326            * default is 1;
 327            */
 328           FILTER_PARAM_PARSE_INT(HARD_THRESHOLD, data->hard_threshold);
 329
 330           /* soft_threshold parameter is an integer.
 331            *  if the matching score is greater or equal than this threshold
 332            *  and smaller or equal than the hard_threshold, the hook "soft_match"
 333            *  is called.
 334            * default is 1;
 335            */
 336           FILTER_PARAM_PARSE_INT(SOFT_THRESHOLD, data->soft_threshold);
 337
 338           default: break;
 339         }
 340     }}
 341
 342     PARSE_CHECK(data->rbls.len,
 343                 "no file parameter in the filter %s", filter->name);
 344     filter->data = data;
 345     return true;
 346 }
 347
 348 static void rbl_filter_destructor(filter_t *filter)
 349 {
 350     rbl_filter_t *data = filter->data;
 351     rbl_filter_delete(&data);
 352     filter->data = data;
 353 }
 354
 355 static filter_result_t rbl_filter(const filter_t *filter, const query_t *query)
 356 {
 357     uint32_t ip;
 358     int32_t sum = 0;
 359     const char *end = NULL;
 360     const rbl_filter_t *data = filter->data;
 361
 362     if (parse_ipv4(query->client_address, &end, &ip) != 0) {
 363         warn("invalid client address: %s, expected ipv4",
 364              query->client_address);
 365         return HTK_ERROR;
 366     }
 367     for (uint32_t i = 0 ; i < data->rbls.len ; ++i) {
 368         const rbldb_t *rbl = array_elt(data->rbls, i);
 369         int weight   = array_elt(data->weights, i);
 370         if (rbldb_ipv4_lookup(rbl, ip)) {
 371             sum += weight;
 372         }
 373     }
 374     if (sum >= data->hard_threshold) {
 375         return HTK_HARD_MATCH;
 376     } else if (sum >= data->soft_threshold) {
 377         return HTK_SOFT_MATCH;
 378     } else {
 379         return HTK_FAIL;
 380     }
 381 }
 382
 383 static int rbl_init(void)
 384 {
 385     filter_type_t type =  filter_register("iplist", rbl_filter_constructor,
 386                                           rbl_filter_destructor, rbl_filter);
 387     /* Hooks.
 388      */
 389     (void)filter_hook_register(type, "abort");
 390     (void)filter_hook_register(type, "error");
 391     (void)filter_hook_register(type, "fail");
 392     (void)filter_hook_register(type, "hard_match");
 393     (void)filter_hook_register(type, "soft_match");
 394
 395     /* Parameters.
 396      */
 397     (void)filter_param_register(type, "file");
 398     (void)filter_param_register(type, "hard_threshold");
 399     (void)filter_param_register(type, "soft_threshold");
 400     return 0;
 401 }
 402 module_init(rbl_init);