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 © 2007 Pierre Habouzit
34 * Copyright © 2008 Florent Bruneau
37 #include <arpa/inet.h>
38 #include <netinet/in.h>
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))
64 A(uint16_t) ips[1 << 16];
68 static int get_o(const char *s, const char **out)
72 if (*s < '0' || *s > '9')
76 if (*s < '0' || *s > '9')
79 res = res * 10 + *s++ - '0';
80 if (*s < '0' || *s > '9')
83 res = res * 10 + *s++ - '0';
84 if (!(*s < '0' || *s > '9') || res < 100)
92 static int parse_ipv4(const char *s, const char **out, uint32_t *ip)
97 if ((o & ~0xff) || *s++ != '.')
102 if ((o & ~0xff) || *s++ != '.')
107 if ((o & ~0xff) || *s++ != '.')
120 rbldb_t *rbldb_create(const char *file, bool lock)
127 if (!file_map_open(&map, file, false)) {
133 while (end > p && end[-1] != '\n') {
136 if (end != map.end) {
137 warn("file %s miss a final \\n, ignoring last line",
141 db = p_new(rbldb_t, 1);
145 while (*p == ' ' || *p == '\t' || *p == '\r')
148 if (parse_ipv4(p, &p, &ip) < 0) {
149 p = (char *)memchr(p, '\n', end - p) + 1;
151 array_add(db->ips[ip >> 16], ip & 0xffff);
155 file_map_close(&map);
157 /* Lookup may perform serveral I/O, so avoid swap.
159 for (int i = 0 ; i < 1 << 16 ; ++i) {
160 array_adjust(db->ips[i]);
161 if (lock && !array_lock(db->ips[i])) {
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
173 info("rbl %s loaded, %d IPs", file, ips);
177 static void rbldb_wipe(rbldb_t *db)
179 for (int i = 0 ; i < 1 << 16 ; ++i) {
180 array_wipe(db->ips[i]);
184 void rbldb_delete(rbldb_t **db)
192 uint32_t rbldb_stats(const rbldb_t *rbl)
195 for (int i = 0 ; i < 1 << 16 ; ++i) {
196 ips += array_len(rbl->ips[i]);
198 printf("memory overhead of rbldb: %u\n", sizeof(rbldb_t));
202 bool rbldb_ipv4_lookup(const rbldb_t *db, uint32_t ip)
204 const uint16_t hip = ip >> 16;
205 const uint16_t lip = ip & 0xffff;
206 int l = 0, r = db->ips[hip].len;
211 if (array_elt(db->ips[hip], i) == lip)
214 if (lip < array_elt(db->ips[hip], i)) {
224 /* postlicyd filter declaration */
228 typedef struct rbl_filter_t {
232 int32_t hard_threshold;
233 int32_t soft_threshold;
236 static rbl_filter_t *rbl_filter_new(void)
238 return p_new(rbl_filter_t, 1);
241 static void rbl_filter_delete(rbl_filter_t **rbl)
244 array_deep_wipe((*rbl)->rbls, rbldb_delete);
245 array_wipe((*rbl)->weights);
251 static bool rbl_filter_constructor(filter_t *filter)
253 rbl_filter_t *data = rbl_filter_new();
255 #define PARSE_CHECK(Expr, Str, ...) \
257 err(Str, ##__VA_ARGS__); \
258 rbl_filter_delete(&data); \
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
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.
280 const char *current = param->value;
281 const char *p = m_strchrnul(param->value, ':');
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");
289 if ((p - current) == 4 && strncmp(current, "lock", 4) == 0) {
291 } else if ((p - current) == 6
292 && strncmp(current, "nolock", 6) == 0) {
295 PARSE_CHECK(false, "illegal locking state %.*s",
296 p - current, current);
301 weight = strtol(current, &next, 10);
302 PARSE_CHECK(next == p && weight >= 0 && weight <= 1024,
303 "illegal weight value %.*s",
304 (p - current), current);
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);
317 p = m_strchrnul(current, ':');
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.
328 FILTER_PARAM_PARSE_INT(HARD_THRESHOLD, data->hard_threshold);
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"
336 FILTER_PARAM_PARSE_INT(SOFT_THRESHOLD, data->soft_threshold);
342 PARSE_CHECK(data->rbls.len,
343 "no file parameter in the filter %s", filter->name);
348 static void rbl_filter_destructor(filter_t *filter)
350 rbl_filter_t *data = filter->data;
351 rbl_filter_delete(&data);
355 static filter_result_t rbl_filter(const filter_t *filter, const query_t *query)
359 const char *end = NULL;
360 const rbl_filter_t *data = filter->data;
362 if (parse_ipv4(query->client_address, &end, &ip) != 0) {
363 warn("invalid client address: %s, expected ipv4",
364 query->client_address);
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)) {
374 if (sum >= data->hard_threshold) {
375 return HTK_HARD_MATCH;
376 } else if (sum >= data->soft_threshold) {
377 return HTK_SOFT_MATCH;
383 static int rbl_init(void)
385 filter_type_t type = filter_register("iplist", rbl_filter_constructor,
386 rbl_filter_destructor, rbl_filter);
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");
397 (void)filter_param_register(type, "file");
398 (void)filter_param_register(type, "hard_threshold");
399 (void)filter_param_register(type, "soft_threshold");
402 module_init(rbl_init);