net/netfilter/nf_conntrack_helper.c

   1 /* Helper handling for netfilter. */
   2
   3 /* (C) 1999-2001 Paul `Rusty' Russell
   4  * (C) 2002-2006 Netfilter Core Team <coreteam@netfilter.org>
   5  * (C) 2003,2004 USAGI/WIDE Project <http://www.linux-ipv6.org>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11
  12 #include <linux/types.h>
  13 #include <linux/netfilter.h>
  14 #include <linux/module.h>
  15 #include <linux/skbuff.h>
  16 #include <linux/vmalloc.h>
  17 #include <linux/stddef.h>
  18 #include <linux/random.h>
  19 #include <linux/err.h>
  20 #include <linux/kernel.h>
  21 #include <linux/netdevice.h>
  22 #include <linux/rculist.h>
  23 #include <linux/rtnetlink.h>
  24
  25 #include <net/netfilter/nf_conntrack.h>
  26 #include <net/netfilter/nf_conntrack_l3proto.h>
  27 #include <net/netfilter/nf_conntrack_l4proto.h>
  28 #include <net/netfilter/nf_conntrack_helper.h>
  29 #include <net/netfilter/nf_conntrack_core.h>
  30 #include <net/netfilter/nf_conntrack_extend.h>
  31
  32 static DEFINE_MUTEX(nf_ct_helper_mutex);
  33 static struct hlist_head *nf_ct_helper_hash __read_mostly;
  34 static unsigned int nf_ct_helper_hsize __read_mostly;
  35 static unsigned int nf_ct_helper_count __read_mostly;
  36
  37 static bool nf_ct_auto_assign_helper __read_mostly = true;
  38 module_param_named(nf_conntrack_helper, nf_ct_auto_assign_helper, bool, 0644);
  39 MODULE_PARM_DESC(nf_conntrack_helper,
  40                  "Enable automatic conntrack helper assignment (default 1)");
  41
  42 #ifdef CONFIG_SYSCTL
  43 static struct ctl_table helper_sysctl_table[] = {
  44         {
  45                 .procname       = "nf_conntrack_helper",
  46                 .data           = &init_net.ct.sysctl_auto_assign_helper,
  47                 .maxlen         = sizeof(unsigned int),
  48                 .mode           = 0644,
  49                 .proc_handler   = proc_dointvec,
  50         },
  51         {}
  52 };
  53
  54 static int nf_conntrack_helper_init_sysctl(struct net *net)
  55 {
  56         struct ctl_table *table;
  57
  58         table = kmemdup(helper_sysctl_table, sizeof(helper_sysctl_table),
  59                         GFP_KERNEL);
  60         if (!table)
  61                 goto out;
  62
  63         table[0].data = &net->ct.sysctl_auto_assign_helper;
  64
  65         net->ct.helper_sysctl_header =
  66                 register_net_sysctl(net, "net/netfilter", table);
  67
  68         if (!net->ct.helper_sysctl_header) {
  69                 pr_err("nf_conntrack_helper: can't register to sysctl.\n");
  70                 goto out_register;
  71         }
  72         return 0;
  73
  74 out_register:
  75         kfree(table);
  76 out:
  77         return -ENOMEM;
  78 }
  79
  80 static void nf_conntrack_helper_fini_sysctl(struct net *net)
  81 {
  82         struct ctl_table *table;
  83
  84         table = net->ct.helper_sysctl_header->ctl_table_arg;
  85         unregister_net_sysctl_table(net->ct.helper_sysctl_header);
  86         kfree(table);
  87 }
  88 #else
  89 static int nf_conntrack_helper_init_sysctl(struct net *net)
  90 {
  91         return 0;
  92 }
  93
  94 static void nf_conntrack_helper_fini_sysctl(struct net *net)
  95 {
  96 }
  97 #endif /* CONFIG_SYSCTL */
  98
  99 /* Stupid hash, but collision free for the default registrations of the
 100  * helpers currently in the kernel. */
 101 static unsigned int helper_hash(const struct nf_conntrack_tuple *tuple)
 102 {
 103         return (((tuple->src.l3num << 8) | tuple->dst.protonum) ^
 104                 (__force __u16)tuple->src.u.all) % nf_ct_helper_hsize;
 105 }
 106
 107 static struct nf_conntrack_helper *
 108 __nf_ct_helper_find(const struct nf_conntrack_tuple *tuple)
 109 {
 110         struct nf_conntrack_helper *helper;
 111         struct nf_conntrack_tuple_mask mask = { .src.u.all = htons(0xFFFF) };
 112         struct hlist_node *n;
 113         unsigned int h;
 114
 115         if (!nf_ct_helper_count)
 116                 return NULL;
 117
 118         h = helper_hash(tuple);
 119         hlist_for_each_entry_rcu(helper, n, &nf_ct_helper_hash[h], hnode) {
 120                 if (nf_ct_tuple_src_mask_cmp(tuple, &helper->tuple, &mask))
 121                         return helper;
 122         }
 123         return NULL;
 124 }
 125
 126 struct nf_conntrack_helper *
 127 __nf_conntrack_helper_find(const char *name, u16 l3num, u8 protonum)
 128 {
 129         struct nf_conntrack_helper *h;
 130         struct hlist_node *n;
 131         unsigned int i;
 132
 133         for (i = 0; i < nf_ct_helper_hsize; i++) {
 134                 hlist_for_each_entry_rcu(h, n, &nf_ct_helper_hash[i], hnode) {
 135                         if (!strcmp(h->name, name) &&
 136                             h->tuple.src.l3num == l3num &&
 137                             h->tuple.dst.protonum == protonum)
 138                                 return h;
 139                 }
 140         }
 141         return NULL;
 142 }
 143 EXPORT_SYMBOL_GPL(__nf_conntrack_helper_find);
 144
 145 struct nf_conntrack_helper *
 146 nf_conntrack_helper_try_module_get(const char *name, u16 l3num, u8 protonum)
 147 {
 148         struct nf_conntrack_helper *h;
 149
 150         h = __nf_conntrack_helper_find(name, l3num, protonum);
 151 #ifdef CONFIG_MODULES
 152         if (h == NULL) {
 153                 if (request_module("nfct-helper-%s", name) == 0)
 154                         h = __nf_conntrack_helper_find(name, l3num, protonum);
 155         }
 156 #endif
 157         if (h != NULL && !try_module_get(h->me))
 158                 h = NULL;
 159
 160         return h;
 161 }
 162 EXPORT_SYMBOL_GPL(nf_conntrack_helper_try_module_get);
 163
 164 struct nf_conn_help *
 165 nf_ct_helper_ext_add(struct nf_conn *ct,
 166                      struct nf_conntrack_helper *helper, gfp_t gfp)
 167 {
 168         struct nf_conn_help *help;
 169
 170         help = nf_ct_ext_add_length(ct, NF_CT_EXT_HELPER,
 171                                     helper->data_len, gfp);
 172         if (help)
 173                 INIT_HLIST_HEAD(&help->expectations);
 174         else
 175                 pr_debug("failed to add helper extension area");
 176         return help;
 177 }
 178 EXPORT_SYMBOL_GPL(nf_ct_helper_ext_add);
 179
 180 int __nf_ct_try_assign_helper(struct nf_conn *ct, struct nf_conn *tmpl,
 181                               gfp_t flags)
 182 {
 183         struct nf_conntrack_helper *helper = NULL;
 184         struct nf_conn_help *help;
 185         struct net *net = nf_ct_net(ct);
 186         int ret = 0;
 187
 188         /* We already got a helper explicitly attached. The function
 189          * nf_conntrack_alter_reply - in case NAT is in use - asks for looking
 190          * the helper up again. Since now the user is in full control of
 191          * making consistent helper configurations, skip this automatic
 192          * re-lookup, otherwise we'll lose the helper.
 193          */
 194         if (test_bit(IPS_HELPER_BIT, &ct->status))
 195                 return 0;
 196
 197         if (tmpl != NULL) {
 198                 help = nfct_help(tmpl);
 199                 if (help != NULL) {
 200                         helper = help->helper;
 201                         set_bit(IPS_HELPER_BIT, &ct->status);
 202                 }
 203         }
 204
 205         help = nfct_help(ct);
 206         if (net->ct.sysctl_auto_assign_helper && helper == NULL) {
 207                 helper = __nf_ct_helper_find(&ct->tuplehash[IP_CT_DIR_REPLY].tuple);
 208                 if (unlikely(!net->ct.auto_assign_helper_warned && helper)) {
 209                         pr_info("nf_conntrack: automatic helper "
 210                                 "assignment is deprecated and it will "
 211                                 "be removed soon. Use the iptables CT target "
 212                                 "to attach helpers instead.\n");
 213                         net->ct.auto_assign_helper_warned = true;
 214                 }
 215         }
 216
 217         if (helper == NULL) {
 218                 if (help)
 219                         RCU_INIT_POINTER(help->helper, NULL);
 220                 goto out;
 221         }
 222
 223         if (help == NULL) {
 224                 help = nf_ct_helper_ext_add(ct, helper, flags);
 225                 if (help == NULL) {
 226                         ret = -ENOMEM;
 227                         goto out;
 228                 }
 229         } else {
 230                 memset(help->data, 0, helper->data_len);
 231         }
 232
 233         rcu_assign_pointer(help->helper, helper);
 234 out:
 235         return ret;
 236 }
 237 EXPORT_SYMBOL_GPL(__nf_ct_try_assign_helper);
 238
 239 static inline int unhelp(struct nf_conntrack_tuple_hash *i,
 240                          const struct nf_conntrack_helper *me)
 241 {
 242         struct nf_conn *ct = nf_ct_tuplehash_to_ctrack(i);
 243         struct nf_conn_help *help = nfct_help(ct);
 244
 245         if (help && rcu_dereference_protected(
 246                         help->helper,
 247                         lockdep_is_held(&nf_conntrack_lock)
 248                         ) == me) {
 249                 nf_conntrack_event(IPCT_HELPER, ct);
 250                 RCU_INIT_POINTER(help->helper, NULL);
 251         }
 252         return 0;
 253 }
 254
 255 void nf_ct_helper_destroy(struct nf_conn *ct)
 256 {
 257         struct nf_conn_help *help = nfct_help(ct);
 258         struct nf_conntrack_helper *helper;
 259
 260         if (help) {
 261                 rcu_read_lock();
 262                 helper = rcu_dereference(help->helper);
 263                 if (helper && helper->destroy)
 264                         helper->destroy(ct);
 265                 rcu_read_unlock();
 266         }
 267 }
 268
 269 static LIST_HEAD(nf_ct_helper_expectfn_list);
 270
 271 void nf_ct_helper_expectfn_register(struct nf_ct_helper_expectfn *n)
 272 {
 273         spin_lock_bh(&nf_conntrack_lock);
 274         list_add_rcu(&n->head, &nf_ct_helper_expectfn_list);
 275         spin_unlock_bh(&nf_conntrack_lock);
 276 }
 277 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_register);
 278
 279 void nf_ct_helper_expectfn_unregister(struct nf_ct_helper_expectfn *n)
 280 {
 281         spin_lock_bh(&nf_conntrack_lock);
 282         list_del_rcu(&n->head);
 283         spin_unlock_bh(&nf_conntrack_lock);
 284 }
 285 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_unregister);
 286
 287 struct nf_ct_helper_expectfn *
 288 nf_ct_helper_expectfn_find_by_name(const char *name)
 289 {
 290         struct nf_ct_helper_expectfn *cur;
 291         bool found = false;
 292
 293         rcu_read_lock();
 294         list_for_each_entry_rcu(cur, &nf_ct_helper_expectfn_list, head) {
 295                 if (!strcmp(cur->name, name)) {
 296                         found = true;
 297                         break;
 298                 }
 299         }
 300         rcu_read_unlock();
 301         return found ? cur : NULL;
 302 }
 303 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_name);
 304
 305 struct nf_ct_helper_expectfn *
 306 nf_ct_helper_expectfn_find_by_symbol(const void *symbol)
 307 {
 308         struct nf_ct_helper_expectfn *cur;
 309         bool found = false;
 310
 311         rcu_read_lock();
 312         list_for_each_entry_rcu(cur, &nf_ct_helper_expectfn_list, head) {
 313                 if (cur->expectfn == symbol) {
 314                         found = true;
 315                         break;
 316                 }
 317         }
 318         rcu_read_unlock();
 319         return found ? cur : NULL;
 320 }
 321 EXPORT_SYMBOL_GPL(nf_ct_helper_expectfn_find_by_symbol);
 322
 323 int nf_conntrack_helper_register(struct nf_conntrack_helper *me)
 324 {
 325         unsigned int h = helper_hash(&me->tuple);
 326
 327         BUG_ON(me->expect_policy == NULL);
 328         BUG_ON(me->expect_class_max >= NF_CT_MAX_EXPECT_CLASSES);
 329         BUG_ON(strlen(me->name) > NF_CT_HELPER_NAME_LEN - 1);
 330
 331         mutex_lock(&nf_ct_helper_mutex);
 332         hlist_add_head_rcu(&me->hnode, &nf_ct_helper_hash[h]);
 333         nf_ct_helper_count++;
 334         mutex_unlock(&nf_ct_helper_mutex);
 335
 336         return 0;
 337 }
 338 EXPORT_SYMBOL_GPL(nf_conntrack_helper_register);
 339
 340 static void __nf_conntrack_helper_unregister(struct nf_conntrack_helper *me,
 341                                              struct net *net)
 342 {
 343         struct nf_conntrack_tuple_hash *h;
 344         struct nf_conntrack_expect *exp;
 345         const struct hlist_node *n, *next;
 346         const struct hlist_nulls_node *nn;
 347         unsigned int i;
 348
 349         /* Get rid of expectations */
 350         for (i = 0; i < nf_ct_expect_hsize; i++) {
 351                 hlist_for_each_entry_safe(exp, n, next,
 352                                           &net->ct.expect_hash[i], hnode) {
 353                         struct nf_conn_help *help = nfct_help(exp->master);
 354                         if ((rcu_dereference_protected(
 355                                         help->helper,
 356                                         lockdep_is_held(&nf_conntrack_lock)
 357                                         ) == me || exp->helper == me) &&
 358                             del_timer(&exp->timeout)) {
 359                                 nf_ct_unlink_expect(exp);
 360                                 nf_ct_expect_put(exp);
 361                         }
 362                 }
 363         }
 364
 365         /* Get rid of expecteds, set helpers to NULL. */
 366         hlist_nulls_for_each_entry(h, nn, &net->ct.unconfirmed, hnnode)
 367                 unhelp(h, me);
 368         for (i = 0; i < net->ct.htable_size; i++) {
 369                 hlist_nulls_for_each_entry(h, nn, &net->ct.hash[i], hnnode)
 370                         unhelp(h, me);
 371         }
 372 }
 373
 374 void nf_conntrack_helper_unregister(struct nf_conntrack_helper *me)
 375 {
 376         struct net *net;
 377
 378         mutex_lock(&nf_ct_helper_mutex);
 379         hlist_del_rcu(&me->hnode);
 380         nf_ct_helper_count--;
 381         mutex_unlock(&nf_ct_helper_mutex);
 382
 383         /* Make sure every nothing is still using the helper unless its a
 384          * connection in the hash.
 385          */
 386         synchronize_rcu();
 387
 388         rtnl_lock();
 389         spin_lock_bh(&nf_conntrack_lock);
 390         for_each_net(net)
 391                 __nf_conntrack_helper_unregister(me, net);
 392         spin_unlock_bh(&nf_conntrack_lock);
 393         rtnl_unlock();
 394 }
 395 EXPORT_SYMBOL_GPL(nf_conntrack_helper_unregister);
 396
 397 static struct nf_ct_ext_type helper_extend __read_mostly = {
 398         .len    = sizeof(struct nf_conn_help),
 399         .align  = __alignof__(struct nf_conn_help),
 400         .id     = NF_CT_EXT_HELPER,
 401 };
 402
 403 int nf_conntrack_helper_init(struct net *net)
 404 {
 405         int err;
 406
 407         net->ct.auto_assign_helper_warned = false;
 408         net->ct.sysctl_auto_assign_helper = nf_ct_auto_assign_helper;
 409
 410         if (net_eq(net, &init_net)) {
 411                 nf_ct_helper_hsize = 1; /* gets rounded up to use one page */
 412                 nf_ct_helper_hash =
 413                         nf_ct_alloc_hashtable(&nf_ct_helper_hsize, 0);
 414                 if (!nf_ct_helper_hash)
 415                         return -ENOMEM;
 416
 417                 err = nf_ct_extend_register(&helper_extend);
 418                 if (err < 0)
 419                         goto err1;
 420         }
 421
 422         err = nf_conntrack_helper_init_sysctl(net);
 423         if (err < 0)
 424                 goto out_sysctl;
 425
 426         return 0;
 427
 428 out_sysctl:
 429         if (net_eq(net, &init_net))
 430                 nf_ct_extend_unregister(&helper_extend);
 431 err1:
 432         nf_ct_free_hashtable(nf_ct_helper_hash, nf_ct_helper_hsize);
 433         return err;
 434 }
 435
 436 void nf_conntrack_helper_fini(struct net *net)
 437 {
 438         nf_conntrack_helper_fini_sysctl(net);
 439         if (net_eq(net, &init_net)) {
 440                 nf_ct_extend_unregister(&helper_extend);
 441                 nf_ct_free_hashtable(nf_ct_helper_hash, nf_ct_helper_hsize);
 442         }
 443 }