net/ipv4/netfilter/ip_conntrack_proto_gre.c

   1 /*
   2  * ip_conntrack_proto_gre.c - Version 2.0
   3  *
   4  * Connection tracking protocol helper module for GRE.
   5  *
   6  * GRE is a generic encapsulation protocol, which is generally not very
   7  * suited for NAT, as it has no protocol-specific part as port numbers.
   8  *
   9  * It has an optional key field, which may help us distinguishing two
  10  * connections between the same two hosts.
  11  *
  12  * GRE is defined in RFC 1701 and RFC 1702, as well as RFC 2784
  13  *
  14  * PPTP is built on top of a modified version of GRE, and has a mandatory
  15  * field called "CallID", which serves us for the same purpose as the key
  16  * field in plain GRE.
  17  *
  18  * Documentation about PPTP can be found in RFC 2637
  19  *
  20  * (C) 2000-2004 by Harald Welte <laforge@gnumonks.org>
  21  *
  22  * Development of this code funded by Astaro AG (http://www.astaro.com/)
  23  *
  24  */
  25
  26 #include <linux/config.h>
  27 #include <linux/module.h>
  28 #include <linux/types.h>
  29 #include <linux/timer.h>
  30 #include <linux/netfilter.h>
  31 #include <linux/ip.h>
  32 #include <linux/in.h>
  33 #include <linux/list.h>
  34
  35 #include <linux/netfilter_ipv4/lockhelp.h>
  36
  37 DECLARE_RWLOCK(ip_ct_gre_lock);
  38 #define ASSERT_READ_LOCK(x) MUST_BE_READ_LOCKED(&ip_ct_gre_lock)
  39 #define ASSERT_WRITE_LOCK(x) MUST_BE_WRITE_LOCKED(&ip_ct_gre_lock)
  40
  41 #include <linux/netfilter_ipv4/listhelp.h>
  42 #include <linux/netfilter_ipv4/ip_conntrack_protocol.h>
  43 #include <linux/netfilter_ipv4/ip_conntrack_helper.h>
  44 #include <linux/netfilter_ipv4/ip_conntrack_core.h>
  45
  46 #include <linux/netfilter_ipv4/ip_conntrack_proto_gre.h>
  47 #include <linux/netfilter_ipv4/ip_conntrack_pptp.h>
  48
  49 MODULE_LICENSE("GPL");
  50 MODULE_AUTHOR("Harald Welte <laforge@gnumonks.org>");
  51 MODULE_DESCRIPTION("netfilter connection tracking protocol helper for GRE");
  52
  53 /* shamelessly stolen from ip_conntrack_proto_udp.c */
  54 #define GRE_TIMEOUT             (30*HZ)
  55 #define GRE_STREAM_TIMEOUT      (180*HZ)
  56
  57 #if 0
  58 #define DEBUGP(format, args...) printk(KERN_DEBUG "%s:%s: " format, __FILE__, __FUNCTION__, ## args)
  59 #define DUMP_TUPLE_GRE(x) printk("%u.%u.%u.%u:0x%x -> %u.%u.%u.%u:0x%x\n", \
  60                         NIPQUAD((x)->src.ip), ntohl((x)->src.u.gre.key), \
  61                         NIPQUAD((x)->dst.ip), ntohl((x)->dst.u.gre.key))
  62 #else
  63 #define DEBUGP(x, args...)
  64 #define DUMP_TUPLE_GRE(x)
  65 #endif
  66
  67 /* GRE KEYMAP HANDLING FUNCTIONS */
  68 static LIST_HEAD(gre_keymap_list);
  69
  70 static inline int gre_key_cmpfn(const struct ip_ct_gre_keymap *km,
  71                                 const struct ip_conntrack_tuple *t)
  72 {
  73         return ((km->tuple.src.ip == t->src.ip) &&
  74                 (km->tuple.dst.ip == t->dst.ip) &&
  75                 (km->tuple.dst.protonum == t->dst.protonum) &&
  76                 (km->tuple.dst.u.all == t->dst.u.all));
  77 }
  78
  79 /* look up the source key for a given tuple */
  80 static u_int32_t gre_keymap_lookup(struct ip_conntrack_tuple *t)
  81 {
  82         struct ip_ct_gre_keymap *km;
  83         u_int32_t key;
  84
  85         READ_LOCK(&ip_ct_gre_lock);
  86         km = LIST_FIND(&gre_keymap_list, gre_key_cmpfn,
  87                         struct ip_ct_gre_keymap *, t);
  88         if (!km) {
  89                 READ_UNLOCK(&ip_ct_gre_lock);
  90                 return 0;
  91         }
  92
  93         key = km->tuple.src.u.gre.key;
  94         READ_UNLOCK(&ip_ct_gre_lock);
  95
  96         return key;
  97 }
  98
  99 /* add a single keymap entry, associate with specified expect */
 100 int ip_ct_gre_keymap_add(struct ip_conntrack_expect *exp,
 101                          struct ip_conntrack_tuple *t, int reply)
 102 {
 103         struct ip_ct_gre_keymap *km;
 104
 105         km = kmalloc(sizeof(*km), GFP_ATOMIC);
 106         if (!km)
 107                 return -1;
 108
 109         /* initializing list head should be sufficient */
 110         memset(km, 0, sizeof(*km));
 111
 112         memcpy(&km->tuple, t, sizeof(*t));
 113
 114         if (!reply)
 115                 exp->proto.gre.keymap_orig = km;
 116         else
 117                 exp->proto.gre.keymap_reply = km;
 118
 119         DEBUGP("adding new entry %p: ", km);
 120         DUMP_TUPLE_GRE(&km->tuple);
 121
 122         WRITE_LOCK(&ip_ct_gre_lock);
 123         list_append(&gre_keymap_list, km);
 124         WRITE_UNLOCK(&ip_ct_gre_lock);
 125
 126         return 0;
 127 }
 128
 129 /* change the tuple of a keymap entry (used by nat helper) */
 130 void ip_ct_gre_keymap_change(struct ip_ct_gre_keymap *km,
 131                              struct ip_conntrack_tuple *t)
 132 {
 133         DEBUGP("changing entry %p to: ", km);
 134         DUMP_TUPLE_GRE(t);
 135
 136         WRITE_LOCK(&ip_ct_gre_lock);
 137         memcpy(&km->tuple, t, sizeof(km->tuple));
 138         WRITE_UNLOCK(&ip_ct_gre_lock);
 139 }
 140
 141 /* destroy the keymap entries associated with specified expect */
 142 void ip_ct_gre_keymap_destroy(struct ip_conntrack_expect *exp)
 143 {
 144         DEBUGP("entering for exp %p\n", exp);
 145         WRITE_LOCK(&ip_ct_gre_lock);
 146         if (exp->proto.gre.keymap_orig) {
 147                 DEBUGP("removing %p from list\n", exp->proto.gre.keymap_orig);
 148                 list_del(&exp->proto.gre.keymap_orig->list);
 149                 kfree(exp->proto.gre.keymap_orig);
 150                 exp->proto.gre.keymap_orig = NULL;
 151         }
 152         if (exp->proto.gre.keymap_reply) {
 153                 DEBUGP("removing %p from list\n", exp->proto.gre.keymap_reply);
 154                 list_del(&exp->proto.gre.keymap_reply->list);
 155                 kfree(exp->proto.gre.keymap_reply);
 156                 exp->proto.gre.keymap_reply = NULL;
 157         }
 158         WRITE_UNLOCK(&ip_ct_gre_lock);
 159 }
 160
 161
 162 /* PUBLIC CONNTRACK PROTO HELPER FUNCTIONS */
 163
 164 /* invert gre part of tuple */
 165 static int gre_invert_tuple(struct ip_conntrack_tuple *tuple,
 166                             const struct ip_conntrack_tuple *orig)
 167 {
 168         tuple->dst.u.gre.key = orig->src.u.gre.key;
 169         tuple->src.u.gre.key = orig->dst.u.gre.key;
 170
 171         return 1;
 172 }
 173
 174 /* gre hdr info to tuple */
 175 static int gre_pkt_to_tuple(const struct sk_buff *skb,
 176                            unsigned int dataoff,
 177                            struct ip_conntrack_tuple *tuple)
 178 {
 179         struct gre_hdr _grehdr, *grehdr;
 180         struct gre_hdr_pptp _pgrehdr, *pgrehdr;
 181         u_int32_t srckey;
 182
 183         grehdr = skb_header_pointer(skb, dataoff, sizeof(_grehdr), &_grehdr);
 184         pgrehdr = skb_header_pointer(skb, dataoff, sizeof(_pgrehdr), &_pgrehdr);
 185
 186         if (!grehdr || !pgrehdr)
 187                 return 0;
 188
 189         switch (grehdr->version) {
 190                 case GRE_VERSION_1701:
 191                         if (!grehdr->key) {
 192                                 DEBUGP("Can't track GRE without key\n");
 193                                 return 0;
 194                         }
 195                         tuple->dst.u.gre.key = *(gre_key(grehdr));
 196                         break;
 197
 198                 case GRE_VERSION_PPTP:
 199                         if (ntohs(grehdr->protocol) != GRE_PROTOCOL_PPTP) {
 200                                 DEBUGP("GRE_VERSION_PPTP but unknown proto\n");
 201                                 return 0;
 202                         }
 203                         tuple->dst.u.gre.key = htonl(ntohs(pgrehdr->call_id));
 204                         break;
 205
 206                 default:
 207                         printk(KERN_WARNING "unknown GRE version %hu\n",
 208                                 grehdr->version);
 209                         return 0;
 210         }
 211
 212         srckey = gre_keymap_lookup(tuple);
 213
 214 #if 0
 215         DEBUGP("found src key %x for tuple ", ntohl(srckey));
 216         DUMP_TUPLE_GRE(tuple);
 217 #endif
 218         tuple->src.u.gre.key = srckey;
 219
 220         return 1;
 221 }
 222
 223 /* print gre part of tuple */
 224 static unsigned int gre_print_tuple(char *buffer,
 225                                     const struct ip_conntrack_tuple *tuple)
 226 {
 227         return sprintf(buffer, "srckey=0x%x dstkey=0x%x ",
 228                        ntohl(tuple->src.u.gre.key),
 229                        ntohl(tuple->dst.u.gre.key));
 230 }
 231
 232 /* print private data for conntrack */
 233 static unsigned int gre_print_conntrack(char *buffer,
 234                                         const struct ip_conntrack *ct)
 235 {
 236         return sprintf(buffer, "timeout=%u, stream_timeout=%u ",
 237                        (ct->proto.gre.timeout / HZ),
 238                        (ct->proto.gre.stream_timeout / HZ));
 239 }
 240
 241 /* Returns verdict for packet, and may modify conntrack */
 242 static int gre_packet(struct ip_conntrack *ct,
 243                       const struct sk_buff *skb,
 244                       enum ip_conntrack_info conntrackinfo)
 245 {
 246         /* If we've seen traffic both ways, this is a GRE connection.
 247          * Extend timeout. */
 248         if (ct->status & IPS_SEEN_REPLY) {
 249                 ip_ct_refresh_acct(ct, conntrackinfo, skb,
 250                                    ct->proto.gre.stream_timeout);
 251                 /* Also, more likely to be important, and not a probe. */
 252                 set_bit(IPS_ASSURED_BIT, &ct->status);
 253         } else
 254                 ip_ct_refresh_acct(ct, conntrackinfo, skb,
 255                                    ct->proto.gre.timeout);
 256
 257         return NF_ACCEPT;
 258 }
 259
 260 /* Called when a new connection for this protocol found. */
 261 static int gre_new(struct ip_conntrack *ct,
 262                    const struct sk_buff *skb)
 263 {
 264         DEBUGP(": ");
 265         DUMP_TUPLE_GRE(&ct->tuplehash[IP_CT_DIR_ORIGINAL].tuple);
 266
 267         /* initialize to sane value.  Ideally a conntrack helper
 268          * (e.g. in case of pptp) is increasing them */
 269         ct->proto.gre.stream_timeout = GRE_STREAM_TIMEOUT;
 270         ct->proto.gre.timeout = GRE_TIMEOUT;
 271
 272         return 1;
 273 }
 274
 275 /* Called when a conntrack entry has already been removed from the hashes
 276  * and is about to be deleted from memory */
 277 static void gre_destroy(struct ip_conntrack *ct)
 278 {
 279         struct ip_conntrack_expect *master = ct->master;
 280
 281         DEBUGP(" entering\n");
 282
 283         if (!master) {
 284                 DEBUGP("no master exp for ct %p\n", ct);
 285                 return;
 286         }
 287
 288         ip_ct_gre_keymap_destroy(master);
 289 }
 290
 291 /* protocol helper struct */
 292 static struct ip_conntrack_protocol gre = {
 293         .proto           = IPPROTO_GRE,
 294         .name            = "gre",
 295         .pkt_to_tuple    = gre_pkt_to_tuple,
 296         .invert_tuple    = gre_invert_tuple,
 297         .print_tuple     = gre_print_tuple,
 298         .print_conntrack = gre_print_conntrack,
 299         .packet          = gre_packet,
 300         .new             = gre_new,
 301         .destroy         = gre_destroy,
 302         .exp_matches_pkt = NULL,
 303         .me              = THIS_MODULE
 304 };
 305
 306 /* ip_conntrack_proto_gre initialization */
 307 static int __init init(void)
 308 {
 309         int retcode;
 310
 311         if ((retcode = ip_conntrack_protocol_register(&gre))) {
 312                 printk(KERN_ERR "Unable to register conntrack protocol "
 313                        "helper for gre: %d\n", retcode);
 314                 return -EIO;
 315         }
 316
 317         return 0;
 318 }
 319
 320 static void __exit fini(void)
 321 {
 322         struct list_head *pos, *n;
 323
 324         /* delete all keymap entries */
 325         WRITE_LOCK(&ip_ct_gre_lock);
 326         list_for_each_safe(pos, n, &gre_keymap_list) {
 327                 DEBUGP("deleting keymap %p at module unload time\n", pos);
 328                 list_del(pos);
 329                 kfree(pos);
 330         }
 331         WRITE_UNLOCK(&ip_ct_gre_lock);
 332
 333         ip_conntrack_protocol_unregister(&gre);
 334 }
 335
 336 EXPORT_SYMBOL(ip_ct_gre_keymap_add);
 337 EXPORT_SYMBOL(ip_ct_gre_keymap_change);
 338 EXPORT_SYMBOL(ip_ct_gre_keymap_destroy);
 339
 340 module_init(init);
 341 module_exit(fini);