src/mod-blacklist.c

   1 /* Blacklist module for srvx 1.x
   2  * Copyright 2007 Michael Poole <mdpoole@troilus.org>
   3  *
   4  * This file is part of srvx.
   5  *
   6  * srvx is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with srvx; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.
  19  */
  20
  21 #include "conf.h"
  22 #include "gline.h"
  23 #include "modcmd.h"
  24 #include "proto.h"
  25 #include "sar.h"
  26
  27 const char *blacklist_module_deps[] = { NULL };
  28
  29 struct dnsbl_zone {
  30     struct string_list reasons;
  31     const char *description;
  32     const char *reason;
  33     unsigned int duration;
  34     unsigned int mask;
  35     unsigned int debug : 1;
  36     char zone[1];
  37 };
  38
  39 struct dnsbl_data {
  40     char client_ip[IRC_NTOP_MAX_SIZE];
  41     char zone_name[1];
  42 };
  43
  44 static struct log_type *bl_log;
  45 static dict_t blacklist_zones; /* contains struct dnsbl_zone */
  46 static dict_t blacklist_hosts; /* maps IPs or hostnames to reasons from blacklist_reasons */
  47 static dict_t blacklist_reasons; /* maps strings to themselves (poor man's data sharing) */
  48
  49 static struct {
  50     struct userNode *debug_bot;
  51     struct chanNode *debug_channel;
  52     unsigned long gline_duration;
  53 } conf;
  54
  55 #if defined(GCC_VARMACROS)
  56 # define blacklist_debug(ARGS...) do { if (conf.debug_bot && conf.debug_channel) send_channel_notice(conf.debug_channel, conf.debug_bot, ARGS); } while (0)
  57 #elif defined(C99_VARMACROS)
  58 # define blacklist_debug(...) do { if (conf.debug_bot && conf.debug_channel) send_channel_notice(conf.debug_channel, conf.debug_bot, __VA_ARGS__); } while (0)
  59 #endif
  60
  61 static void
  62 do_expandos(char *output, unsigned int out_len, const char *input, ...)
  63 {
  64     va_list args;
  65     const char *key;
  66     const char *datum;
  67     char *found;
  68     unsigned int klen;
  69     unsigned int dlen;
  70     unsigned int rlen;
  71
  72     safestrncpy(output, input, out_len);
  73     va_start(args, input);
  74     while ((key = va_arg(args, const char*)) != NULL) {
  75         datum = va_arg(args, const char *);
  76         klen = strlen(key);
  77         dlen = strlen(datum);
  78         for (found = output; (found = strstr(output, key)) != NULL; found += dlen) {
  79             rlen = strlen(found + klen);
  80             if ((dlen > klen) && ((unsigned)(found + dlen + rlen - output) > out_len))
  81                 rlen = output + out_len - found - dlen;
  82             memmove(found + dlen, found + klen, rlen);
  83             memcpy(found, datum, dlen + 1);
  84         }
  85     }
  86     va_end(args);
  87 }
  88
  89 static void
  90 dnsbl_hit(struct sar_request *req, struct dns_header *hdr, struct dns_rr *rr, unsigned char *raw, unsigned int raw_size)
  91 {
  92     struct dnsbl_data *data;
  93     struct dnsbl_zone *zone;
  94     const char *message;
  95     char *txt;
  96     unsigned int mask;
  97     unsigned int pos;
  98     unsigned int len;
  99     unsigned int ii;
 100     char reason[MAXLEN];
 101     char target[IRC_NTOP_MAX_SIZE + 2];
 102
 103     /* Get the DNSBL zone (to make sure it has not disappeared in a rehash). */
 104     data = (struct dnsbl_data*)(req + 1);
 105     zone = dict_find(blacklist_zones, data->zone_name, NULL);
 106     if (!zone)
 107         return;
 108
 109     /* Scan the results. */
 110     for (mask = 0, ii = 0, txt = NULL; ii < hdr->ancount; ++ii) {
 111         pos = rr[ii].rd_start;
 112         switch (rr[ii].type) {
 113         case REQ_TYPE_A:
 114             if (rr[ii].rdlength != 4)
 115                 break;
 116             if (pos + 3 < raw_size)
 117                 mask |= (1 << raw[pos + 3]);
 118             break;
 119         case REQ_TYPE_TXT:
 120             len = raw[pos];
 121             txt = malloc(len + 1);
 122             memcpy(txt, raw + pos + 1, len);
 123             txt[len] = '\0';
 124             break;
 125         }
 126     }
 127
 128     /* Do we care about one of the masks we found? */
 129     if (mask & zone->mask) {
 130         /* See if a per-result message was provided. */
 131         for (ii = 0, message = NULL; mask && (ii < zone->reasons.used); ++ii, mask >>= 1) {
 132             if (0 == (mask & 1))
 133                 continue;
 134             if (NULL != (message = zone->reasons.list[ii]))
 135                 break;
 136         }
 137
 138         /* If not, use a standard fallback. */
 139         if (message == NULL) {
 140             message = zone->reason;
 141             if (message == NULL)
 142                 message = "client is blacklisted";
 143         }
 144
 145         /* Expand elements of the message as necessary. */
 146         do_expandos(reason, sizeof(reason), message, "%txt%", (txt ? txt : "(no-txt)"), "%ip%", data->client_ip, NULL);
 147
 148         if (zone->debug) {
 149             blacklist_debug("DNSBL match: [%s] %s (%s)", zone->zone, data->client_ip, reason);
 150         } else {
 151             /* Now generate the G-line. */
 152             target[0] = '*';
 153             target[1] = '@';
 154             strcpy(target + 2, data->client_ip);
 155             gline_add(self->name, target, zone->duration, reason, now, now, 1);
 156         }
 157     }
 158     free(txt);
 159 }
 160
 161 static int
 162 blacklist_check_user(struct userNode *user)
 163 {
 164     static const char *hexdigits = "0123456789abcdef";
 165     dict_iterator_t it;
 166     const char *reason;
 167     const char *host;
 168     unsigned int dnsbl_len;
 169     unsigned int ii;
 170     char ip[IRC_NTOP_MAX_SIZE];
 171     char dnsbl_target[128];
 172
 173     /* Users added during burst should not be checked. */
 174     if (user->uplink->burst)
 175         return 0;
 176
 177     /* Users with bogus IPs are probably service bots. */
 178     if (!irc_in_addr_is_valid(user->ip))
 179         return 0;
 180
 181     /* Check local file-based blacklist. */
 182     irc_ntop(ip, sizeof(ip), &user->ip);
 183     reason = dict_find(blacklist_hosts, host = ip, NULL);
 184     if (reason == NULL) {
 185         reason = dict_find(blacklist_hosts, host = user->hostname, NULL);
 186     }
 187     if (reason != NULL) {
 188         char *target;
 189         target = alloca(strlen(host) + 3);
 190         target[0] = '*';
 191         target[1] = '@';
 192         strcpy(target + 2, host);
 193         gline_add(self->name, target, conf.gline_duration, reason, now, now, 1);
 194     }
 195
 196     /* Figure out the base part of a DNS blacklist hostname. */
 197     if (irc_in_addr_is_ipv4(user->ip)) {
 198         dnsbl_len = snprintf(dnsbl_target, sizeof(dnsbl_target), "%d.%d.%d.%d.", user->ip.in6_8[15], user->ip.in6_8[14], user->ip.in6_8[13], user->ip.in6_8[12]);
 199     } else if (irc_in_addr_is_ipv6(user->ip)) {
 200         for (ii = 0; ii < 16; ++ii) {
 201             dnsbl_target[ii * 4 + 0] = hexdigits[user->ip.in6_8[15 - ii] & 15];
 202             dnsbl_target[ii * 4 + 1] = '.';
 203             dnsbl_target[ii * 4 + 2] = hexdigits[user->ip.in6_8[15 - ii] >> 4];
 204             dnsbl_target[ii * 4 + 3] = '.';
 205         }
 206         dnsbl_len = 48;
 207     } else {
 208         return 0;
 209     }
 210
 211     /* Start a lookup for the appropriate hostname in each DNSBL. */
 212     for (it = dict_first(blacklist_zones); it; it = iter_next(it)) {
 213         struct dnsbl_data *data;
 214         struct sar_request *req;
 215         const char *zone;
 216
 217         zone = iter_key(it);
 218         safestrncpy(dnsbl_target + dnsbl_len, zone, sizeof(dnsbl_target) - dnsbl_len);
 219         req = sar_request_simple(sizeof(*data) + strlen(zone), dnsbl_hit, NULL, dnsbl_target, REQ_QTYPE_ALL, NULL);
 220         if (req) {
 221             data = (struct dnsbl_data*)(req + 1);
 222             strcpy(data->client_ip, ip);
 223             strcpy(data->zone_name, zone);
 224         }
 225     }
 226     return 0;
 227 }
 228
 229 static void
 230 blacklist_load_file(const char *filename, const char *default_reason)
 231 {
 232     FILE *file;
 233     const char *reason;
 234     char *mapped_reason;
 235     char *sep;
 236     size_t len;
 237     char linebuf[MAXLEN];
 238
 239     if (!filename)
 240         return;
 241     if (!default_reason)
 242         default_reason = "client is blacklisted";
 243     file = fopen(filename, "r");
 244     if (!file) {
 245         log_module(bl_log, LOG_ERROR, "Unable to open %s for reading: %s", filename, strerror(errno));
 246         return;
 247     }
 248     log_module(bl_log, LOG_DEBUG, "Loading blacklist from %s.", filename);
 249     while (fgets(linebuf, sizeof(linebuf), file)) {
 250         /* Trim whitespace from end of line. */
 251         len = strlen(linebuf);
 252         while (isspace(linebuf[len-1]))
 253             linebuf[--len] = '\0';
 254
 255         /* Figure out which reason string we should use. */
 256         reason = default_reason;
 257         sep = strchr(linebuf, ' ');
 258         if (sep) {
 259             *sep++ = '\0';
 260             while (isspace(*sep))
 261                 sep++;
 262             if (*sep != '\0')
 263                 reason = sep;
 264         }
 265
 266         /* See if the reason string is already known. */
 267         mapped_reason = dict_find(blacklist_reasons, reason, NULL);
 268         if (!mapped_reason) {
 269             mapped_reason = strdup(reason);
 270             dict_insert(blacklist_reasons, mapped_reason, (char*)mapped_reason);
 271         }
 272
 273         /* Store the blacklist entry. */
 274         dict_insert(blacklist_hosts, strdup(linebuf), mapped_reason);
 275     }
 276     fclose(file);
 277 }
 278
 279 static void
 280 dnsbl_zone_free(void *pointer)
 281 {
 282     struct dnsbl_zone *zone;
 283     zone = pointer;
 284     free(zone->reasons.list);
 285     free(zone);
 286 }
 287
 288 static void
 289 blacklist_conf_read(void)
 290 {
 291     dict_t node;
 292     dict_t subnode;
 293     const char *str1;
 294     const char *str2;
 295
 296     dict_delete(blacklist_zones);
 297     blacklist_zones = dict_new();
 298     dict_set_free_data(blacklist_zones, dnsbl_zone_free);
 299
 300     dict_delete(blacklist_hosts);
 301     blacklist_hosts = dict_new();
 302     dict_set_free_keys(blacklist_hosts, free);
 303
 304     dict_delete(blacklist_reasons);
 305     blacklist_reasons = dict_new();
 306     dict_set_free_keys(blacklist_reasons, free);
 307
 308     node = conf_get_data("modules/blacklist", RECDB_OBJECT);
 309     if (node == NULL)
 310         return;
 311
 312     str1 = database_get_data(node, "debug_bot", RECDB_QSTRING);
 313     if (str1)
 314         conf.debug_bot = GetUserH(str1);
 315
 316     str1 = database_get_data(node, "debug_channel", RECDB_QSTRING);
 317     if (conf.debug_bot && str1) {
 318         str2 = database_get_data(node, "debug_channel_modes", RECDB_QSTRING);
 319         if (!str2)
 320             str2 = "+tinms";
 321         conf.debug_channel = AddChannel(str1, now, str2, NULL);
 322         AddChannelUser(conf.debug_bot, conf.debug_channel)->modes |= MODE_CHANOP;
 323     } else {
 324         conf.debug_channel = NULL;
 325     }
 326
 327     str1 = database_get_data(node, "file", RECDB_QSTRING);
 328     str2 = database_get_data(node, "file_reason", RECDB_QSTRING);
 329     blacklist_load_file(str1, str2);
 330
 331     str1 = database_get_data(node, "gline_duration", RECDB_QSTRING);
 332     if (str1 == NULL)
 333         str1 = "1h";
 334     conf.gline_duration = ParseInterval(str1);
 335
 336     subnode = database_get_data(node, "dnsbl", RECDB_OBJECT);
 337     if (subnode) {
 338         static const char *reason_prefix = "reason_";
 339         static const unsigned int max_id = 255;
 340         struct dnsbl_zone *zone;
 341         dict_iterator_t it;
 342         dict_iterator_t it2;
 343         dict_t dnsbl;
 344         unsigned int id;
 345
 346         for (it = dict_first(subnode); it; it = iter_next(it)) {
 347             dnsbl = GET_RECORD_OBJECT((struct record_data*)iter_data(it));
 348             if (!dnsbl)
 349                 continue;
 350
 351             zone = malloc(sizeof(*zone) + strlen(iter_key(it)));
 352             strcpy(zone->zone, iter_key(it));
 353             zone->description = database_get_data(dnsbl, "description", RECDB_QSTRING);
 354             zone->reason = database_get_data(dnsbl, "reason", RECDB_QSTRING);
 355             str1 = database_get_data(dnsbl, "duration", RECDB_QSTRING);
 356             zone->duration = str1 ? ParseInterval(str1) : 3600;
 357             str1 = database_get_data(dnsbl, "mask", RECDB_QSTRING);
 358             zone->mask = str1 ? strtoul(str1, NULL, 0) : ~0u;
 359             str1 = database_get_data(dnsbl, "debug", RECDB_QSTRING);
 360             zone->debug = str1 ? enabled_string(str1) : 0;
 361             zone->reasons.used = 0;
 362             zone->reasons.size = 0;
 363             zone->reasons.list = NULL;
 364             dict_insert(blacklist_zones, zone->zone, zone);
 365
 366             for (it2 = dict_first(dnsbl); it2; it2 = iter_next(it2)) {
 367                 str1 = GET_RECORD_QSTRING((struct record_data*)(iter_data(it2)));
 368                 if (!str1 || memcmp(iter_key(it2), reason_prefix, strlen(reason_prefix)))
 369                     continue;
 370                 id = strtoul(iter_key(it2) + strlen(reason_prefix), NULL, 0);
 371                 if (id > max_id) {
 372                     log_module(bl_log, LOG_ERROR, "Invalid code for DNSBL %s %s -- only %d responses supported.", iter_key(it), iter_key(it2), max_id);
 373                     continue;
 374                 }
 375                 if (zone->reasons.size < id + 1) {
 376                     zone->reasons.size = id + 1;
 377                     zone->reasons.list = realloc(zone->reasons.list, zone->reasons.size * sizeof(zone->reasons.list[0]));
 378                 }
 379                 zone->reasons.list[id] = (char*)str1;
 380                 if (zone->reasons.used < id + 1)
 381                     zone->reasons.used = id + 1;
 382             }
 383         }
 384     }
 385 }
 386
 387 static void
 388 blacklist_cleanup(void)
 389 {
 390     dict_delete(blacklist_zones);
 391     dict_delete(blacklist_hosts);
 392     dict_delete(blacklist_reasons);
 393 }
 394
 395 int
 396 blacklist_init(void)
 397 {
 398     bl_log = log_register_type("blacklist", "file:blacklist.log");
 399     conf_register_reload(blacklist_conf_read);
 400     reg_new_user_func(blacklist_check_user);
 401     reg_exit_func(blacklist_cleanup);
 402     return 1;
 403 }
 404
 405 int
 406 blacklist_finalize(void)
 407 {
 408     return 1;
 409 }