datapath/nx_act_snat.c

   1 #ifdef SUPPORT_SNAT
   2 /*
   3  * Distributed under the terms of the GNU GPL version 2.
   4  * Copyright (c) 2008 Nicira Networks
   5  */
   6
   7 #include <linux/netdevice.h>
   8 #include <linux/netfilter.h>
   9 #include <linux/netfilter_ipv4.h>
  10 #include <linux/in.h>
  11 #include <net/ip.h>
  12 #include <linux/icmp.h>
  13 #include <linux/if_ether.h>
  14 #include <net/arp.h>
  15 #include <net/route.h>
  16
  17 #include "forward.h"
  18 #include "dp_act.h"
  19 #include "nx_act_snat.h"
  20
  21
  22 /* We need these fake structures to make netfilter happy --
  23  * lots of places assume that skb->dst != NULL, which isn't
  24  * all that unreasonable.
  25  *
  26  * Currently, we fill in the PMTU entry because netfilter
  27  * refragmentation needs it, and the rt_flags entry because
  28  * ipt_REJECT needs it.  Future netfilter modules might
  29  * require us to fill additional fields. */
  30 static struct net_device __fake_net_device = {
  31         .hard_header_len        = ETH_HLEN
  32 };
  33
  34 static struct rtable __fake_rtable = {
  35         .u = {
  36                 .dst = {
  37                         .__refcnt          = ATOMIC_INIT(1),
  38                         .dev                    = &__fake_net_device,
  39                         .path              = &__fake_rtable.u.dst,
  40                         .metrics                = {[RTAX_MTU - 1] = 1500},
  41                         .flags            = DST_NOXFRM,
  42                 }
  43         },
  44         .rt_flags   = 0,
  45 };
  46
  47 /* Define ARP for IP since the Linux headers don't do it cleanly. */
  48 struct ip_arphdr {
  49         uint16_t ar_hrd;
  50         uint16_t ar_pro;
  51         uint8_t ar_hln;
  52         uint8_t ar_pln;
  53         uint16_t ar_op;
  54         uint8_t ar_sha[ETH_ALEN];
  55         uint32_t ar_sip;
  56         uint8_t ar_tha[ETH_ALEN];
  57         uint32_t ar_tip;
  58 } __attribute__((packed));
  59 OFP_ASSERT(sizeof(struct ip_arphdr) == 28);
  60
  61
  62 /* Push the Ethernet header back on and tranmit the packet. */
  63 static int
  64 dp_xmit_skb_push(struct sk_buff *skb)
  65 {
  66         skb_push(skb, ETH_HLEN);
  67         return dp_xmit_skb(skb);
  68 }
  69
  70 /* Perform maintainence related to a SNAT'd interface.  Currently, this only
  71  * checks whether MAC->IP bindings have expired.
  72  *
  73  * Called with the RCU read lock */
  74 void
  75 snat_maint(struct net_bridge_port *p)
  76 {
  77         struct snat_conf *sc;
  78         struct snat_mapping *m, *n;
  79         unsigned long flags;
  80         unsigned long timeout;
  81
  82         spin_lock_irqsave(&p->lock, flags);
  83         sc = p->snat;
  84         if (!sc)
  85                 goto done;
  86
  87         timeout = sc->mac_timeout * HZ;
  88
  89         list_for_each_entry_safe (m, n, &sc->mappings, node) {
  90                 if (time_after(jiffies, m->used + timeout)) {
  91                         list_del(&m->node);
  92                         kfree(m);
  93                 }
  94         }
  95
  96 done:
  97         spin_unlock_irqrestore(&p->lock, flags);
  98 }
  99
 100 /* When the packet is bound for a local interface, strip off the fake
 101  * routing table.
 102  */
 103 void snat_local_in(struct sk_buff *skb)
 104 {
 105         if (skb->dst == (struct dst_entry *)&__fake_rtable) {
 106                 dst_release(skb->dst);
 107                 skb->dst = NULL;
 108         }
 109 }
 110
 111 /* Check whether destination IP's address is in the IP->MAC mappings.
 112  * If it is, then overwrite the destination MAC with the value from the
 113  * cache.
 114  *
 115  * Returns -1 if there is a problem, otherwise 0. */
 116 static int
 117 dnat_mac(struct net_bridge_port *p, struct sk_buff *skb)
 118 {
 119         struct snat_conf *sc = p->snat;
 120         struct iphdr *iph = ip_hdr(skb);
 121         struct ethhdr *eh = eth_hdr(skb);
 122         struct snat_mapping *m;
 123
 124         if (skb->protocol != htons(ETH_P_IP))
 125                 return 0;
 126
 127         list_for_each_entry (m, &sc->mappings, node) {
 128                 if (m->ip_addr == iph->daddr){
 129                         /* Found it! */
 130                         if (!make_writable(&skb)) {
 131                                 if (net_ratelimit())
 132                                         printk("make_writable failed\n");
 133                                 return -EINVAL;
 134                         }
 135                         m->used = jiffies;
 136                         memcpy(eh->h_dest, m->hw_addr, ETH_ALEN);
 137                         break;
 138                 }
 139         }
 140
 141         return 0;
 142 }
 143
 144 static int
 145 __snat_this_address(struct snat_conf *sc, u32 ip_addr)
 146 {
 147         if (sc) {
 148                 u32 h_ip_addr = ntohl(ip_addr);
 149                 return (h_ip_addr >= sc->ip_addr_start &&
 150                         h_ip_addr <= sc->ip_addr_end);
 151         }
 152         return 0;
 153 }
 154
 155 static int
 156 snat_this_address(struct net_bridge_port *p, u32 ip_addr)
 157 {
 158         unsigned long int flags;
 159         int retval;
 160
 161         spin_lock_irqsave(&p->lock, flags);
 162         retval = __snat_this_address(p->snat, ip_addr);
 163         spin_unlock_irqrestore(&p->lock, flags);
 164
 165         return retval;
 166 }
 167
 168 static int
 169 snat_pre_route_finish(struct sk_buff *skb)
 170 {
 171         struct net_bridge_port *p = skb->dev->br_port;
 172         struct snat_conf *sc;
 173         struct iphdr *iph = ip_hdr(skb);
 174         unsigned long flags;
 175
 176         skb->dst = (struct dst_entry *)&__fake_rtable;
 177         dst_hold(skb->dst);
 178
 179         /* Don't process packets that were not translated due to NAT */
 180         spin_lock_irqsave(&p->lock, flags);
 181         sc = p->snat;
 182         if (__snat_this_address(sc, iph->daddr)) {
 183                 spin_unlock_irqrestore(&p->lock, flags);
 184                 return -1;
 185         }
 186
 187         /* If SNAT is configured for this input device, check the IP->MAC
 188          * mappings to see if we should update the destination MAC. */
 189         if (sc)
 190                 dnat_mac(skb->dev->br_port, skb);
 191
 192         spin_unlock_irqrestore(&p->lock, flags);
 193
 194         return 0;
 195 }
 196
 197 /* Checks whether 'skb' is an ARP request for an SNAT'd interface.  If
 198  * so, it will generate a response.
 199  *
 200  * Returns 0 if the packet was not handled.  Otherwise, -1 is returned
 201  * and the caller is responsible for freeing 'skb'. */
 202 static int
 203 handle_arp_snat(struct sk_buff *skb)
 204 {
 205         struct net_bridge_port *p = skb->dev->br_port;
 206         struct ip_arphdr *ah;
 207
 208         if (!pskb_may_pull(skb, sizeof *ah))
 209                 return 0;
 210
 211         ah = (struct ip_arphdr *)arp_hdr(skb);
 212         if ((ah->ar_op != htons(ARPOP_REQUEST))
 213                         || ah->ar_hln != ETH_ALEN
 214                         || ah->ar_pro != htons(ETH_P_IP)
 215                         || ah->ar_pln != 4)
 216                 return 0;
 217
 218         /* We're only interested in addresses we rewrite. */
 219         if (!snat_this_address(p, ah->ar_tip)) {
 220                 return 0;
 221         }
 222
 223         arp_send(ARPOP_REPLY, ETH_P_ARP, ah->ar_sip, skb->dev, ah->ar_tip,
 224                          ah->ar_sha, p->dp->netdev->dev_addr, ah->ar_sha);
 225
 226         return -1;
 227 }
 228
 229 /* Checks whether 'skb' is a ping request for an SNAT'd interface.  If
 230  * so, it will generate a response.
 231  *
 232  * Returns 0 if the packet was not handled.  Otherwise, -1 is returned
 233  * and the caller is responsible for freeing 'skb'. */
 234 static int
 235 handle_icmp_snat(struct sk_buff *skb)
 236 {
 237         struct net_bridge_port *p = skb->dev->br_port;
 238         struct ethhdr *eh;
 239         struct iphdr *iph;
 240         struct icmphdr *icmph;
 241         uint8_t tmp_eth[ETH_ALEN];
 242         uint32_t tmp_ip;
 243         struct sk_buff *nskb;
 244
 245         /* We're only interested in addresses we rewrite. */
 246         iph = ip_hdr(skb);
 247         if (!snat_this_address(p, iph->daddr)) {
 248                 return 0;
 249         }
 250
 251         /* Drop fragments and packets not long enough to hold the ICMP
 252          * header. */
 253         if ((ntohs(iph->frag_off) & IP_OFFSET) != 0 ||
 254             !pskb_may_pull(skb, skb_transport_offset(skb) + 4))
 255                 return 0;
 256
 257         /* We only respond to echo requests to our address.  Continue
 258          * processing replies and other ICMP messages since they may be
 259          * intended for NAT'd hosts. */
 260         icmph = icmp_hdr(skb);
 261         if (icmph->type != ICMP_ECHO)
 262                 return 0;
 263
 264         /* Send an echo reply in response */
 265         nskb = skb_copy(skb, GFP_ATOMIC);
 266         if (!nskb) {
 267                 if (net_ratelimit())
 268                         printk("skb copy failed for icmp reply\n");
 269                 return -1;
 270         }
 271
 272         /* Update Ethernet header. */
 273         eh = eth_hdr(nskb);
 274         memcpy(tmp_eth, eh->h_dest, ETH_ALEN);
 275         memcpy(eh->h_dest, eh->h_source, ETH_ALEN);
 276         memcpy(eh->h_source, tmp_eth, ETH_ALEN);
 277
 278         /* Update IP header.
 279          * This is kind of busted, at least in that it doesn't check that the
 280          * echoed IP options make sense. */
 281         iph = ip_hdr(nskb);
 282         iph->id = 0;
 283         iph->frag_off = 0;
 284         iph->ttl = IPDEFTTL;
 285         iph->check = 0;
 286         tmp_ip = iph->daddr;
 287         iph->daddr = iph->saddr;
 288         iph->saddr = tmp_ip;
 289         iph->check = ip_fast_csum(iph, iph->ihl);
 290
 291         /* Update ICMP header. */
 292         icmph = icmp_hdr(nskb);
 293         icmph->type = ICMP_ECHOREPLY;
 294         icmph->checksum = 0;
 295         icmph->checksum = ip_compute_csum(icmph,
 296                                           nskb->tail - nskb->transport_header);
 297
 298         dp_xmit_skb_push(nskb);
 299
 300         return -1;
 301 }
 302
 303 /* Check if any SNAT maintenance needs to be done on 'skb' before it's
 304  * checked against the datapath's tables.  This includes DNAT
 305  * modification based on prior SNAT action and responding to ARP and
 306  * echo requests for the SNAT interface.
 307  *
 308  * Returns 0 if 'skb' should continue to be processed by the caller.
 309  * Returns -1 if the packet was handled, and the caller should free
 310  * 'skb'.
 311  */
 312 int
 313 snat_pre_route(struct sk_buff *skb)
 314 {
 315         struct iphdr *iph;
 316         int len;
 317
 318         WARN_ON_ONCE(skb_network_offset(skb));
 319         if (skb->protocol == htons(ETH_P_ARP))
 320                 return handle_arp_snat(skb);
 321         else if (skb->protocol != htons(ETH_P_IP))
 322                 return 0;
 323
 324         if (!pskb_may_pull(skb, sizeof *iph))
 325                 goto ipv4_error;
 326
 327         iph = ip_hdr(skb);
 328         if (iph->ihl < 5 || iph->version != 4)
 329                 goto ipv4_error;
 330
 331         if (!pskb_may_pull(skb, ip_hdrlen(skb)))
 332                 goto ipv4_error;
 333         skb_set_transport_header(skb, ip_hdrlen(skb));
 334
 335         /* Check if we need to echo reply for this address */
 336         iph = ip_hdr(skb);
 337         if ((iph->protocol == IPPROTO_ICMP) && (handle_icmp_snat(skb)))
 338                 return -1;
 339
 340         iph = ip_hdr(skb);
 341         if (unlikely(ip_fast_csum(iph, iph->ihl)))
 342                 goto ipv4_error;
 343
 344         len = ntohs(iph->tot_len);
 345         if ((skb->len < len) || len < (iph->ihl*4))
 346                 goto ipv4_error;
 347
 348         if (pskb_trim_rcsum(skb, len))
 349                 goto ipv4_error;
 350
 351         return NF_HOOK(PF_INET, NF_INET_PRE_ROUTING, skb, skb->dev, NULL,
 352                         snat_pre_route_finish);
 353
 354 ipv4_error:
 355         return -1;
 356 }
 357
 358
 359 static int
 360 snat_skb_finish(struct sk_buff *skb)
 361 {
 362         NF_HOOK(PF_INET, NF_INET_POST_ROUTING, skb, NULL, skb->dev,
 363                         dp_xmit_skb_push);
 364
 365         return 0;
 366 }
 367
 368 /* Update the MAC->IP mappings for the private side of the SNAT'd
 369  * interface. */
 370 static void
 371 update_mapping(struct net_bridge_port *p, const struct sk_buff *skb)
 372 {
 373         unsigned long flags;
 374         struct snat_conf *sc;
 375         const struct iphdr *iph = ip_hdr(skb);
 376         const struct ethhdr *eh = eth_hdr(skb);
 377         struct snat_mapping *m;
 378
 379         spin_lock_irqsave(&p->lock, flags);
 380         sc = p->snat;
 381         if (!sc)
 382                 goto done;
 383
 384         list_for_each_entry (m, &sc->mappings, node) {
 385                 if (m->ip_addr == iph->saddr){
 386                         memcpy(m->hw_addr, eh->h_source, ETH_ALEN);
 387                         m->used = jiffies;
 388                         goto done;
 389                 }
 390         }
 391
 392         m = kmalloc(sizeof *m, GFP_ATOMIC);
 393         if (!m)
 394                 goto done;
 395         m->ip_addr = iph->saddr;
 396         memcpy(m->hw_addr, eh->h_source, ETH_ALEN);
 397         m->used = jiffies;
 398
 399         list_add(&m->node, &sc->mappings);
 400
 401 done:
 402         spin_unlock_irqrestore(&p->lock, flags);
 403 }
 404
 405 /* Perform SNAT modification on 'skb' and send out 'out_port'.  If the
 406  * port was not configured for SNAT, it will be sent through the interface
 407  * unmodified.  'skb' is not consumed, so caller will need to free it.
 408  */
 409 void
 410 snat_skb(struct datapath *dp, const struct sk_buff *skb, int out_port)
 411 {
 412         struct net_bridge_port *p = dp->ports[out_port];
 413         struct sk_buff *nskb;
 414
 415         if (!p)
 416                 return;
 417
 418         /* FIXME: Expensive.  Just need to skb_clone() here?
 419          * (However, the skb_copy() does linearize and ensure that the headers
 420          * are accessible.) */
 421         nskb = skb_copy(skb, GFP_ATOMIC);
 422         if (!nskb)
 423                 return;
 424
 425         nskb->dev = p->dev;
 426
 427         /* We only SNAT IP, so just send it on its way if not */
 428         if (skb->protocol != htons(ETH_P_IP)) {
 429                 dp_xmit_skb(nskb);
 430                 return;
 431         }
 432
 433         /* Set the source MAC to the OF interface */
 434         memcpy(eth_hdr(nskb)->h_source, dp->netdev->dev_addr, ETH_ALEN);
 435
 436         update_mapping(p, skb);
 437
 438         /* Take the Ethernet header back off for netfilter hooks. */
 439         skb_pull(nskb, ETH_HLEN);
 440
 441         NF_HOOK(PF_INET, NF_INET_FORWARD, nskb, skb->dev, nskb->dev,
 442                         snat_skb_finish);
 443 }
 444
 445 /* Remove SNAT configuration on port 'p'.
 446  *
 447  * NB: The caller must hold the port's spinlock. */
 448 int
 449 snat_free_conf(struct net_bridge_port *p)
 450 {
 451         struct snat_conf *sc = p->snat;
 452
 453         if (!sc)
 454                 return -EINVAL;
 455
 456         /* Free existing mapping entries */
 457         while (!list_empty(&sc->mappings)) {
 458                 struct snat_mapping *m = list_entry(sc->mappings.next,
 459                                 struct snat_mapping, node);
 460                 list_del(&m->node);
 461                 kfree(m);
 462         }
 463
 464         kfree(p->snat);
 465         p->snat = NULL;
 466
 467         return 0;
 468 }
 469
 470 /* Remove SNAT configuration from an interface. */
 471 static int
 472 snat_del_port(struct datapath *dp, uint16_t port)
 473 {
 474         unsigned long flags;
 475         struct net_bridge_port *p = dp->ports[port];
 476
 477         if (!p) {
 478                 if (net_ratelimit())
 479                         printk("Attempt to remove snat on non-existent port: %d\n", port);
 480                 return -EINVAL;
 481         }
 482
 483         spin_lock_irqsave(&p->lock, flags);
 484         if (snat_free_conf(p)) {
 485                 /* SNAT not configured on this port */
 486                 spin_unlock_irqrestore(&p->lock, flags);
 487                 if (net_ratelimit())
 488                         printk("Attempt to remove snat on non-snat port: %d\n", port);
 489                 return -EINVAL;
 490         }
 491
 492         spin_unlock_irqrestore(&p->lock, flags);
 493
 494         return 0;
 495 }
 496
 497 /* Add SNAT configuration to an interface.  */
 498 static int
 499 snat_add_port(struct datapath *dp, uint16_t port,
 500                 uint32_t ip_addr_start, uint32_t ip_addr_end,
 501                 uint16_t mac_timeout)
 502 {
 503         unsigned long flags;
 504         struct net_bridge_port *p = dp->ports[port];
 505         struct snat_conf *sc;
 506
 507
 508         if (mac_timeout == 0)
 509                 mac_timeout = MAC_TIMEOUT_DEFAULT;
 510
 511         if (!p) {
 512                 if (net_ratelimit())
 513                         printk("Attempt to add snat on non-existent port: %d\n", port);
 514                 return -EINVAL;
 515         }
 516
 517         /* If SNAT is already configured on the port, check whether the same
 518          * IP addresses are used.  If so, just update the mac timeout
 519          * configuration. Otherwise, drop all SNAT configuration and
 520          * reconfigure it. */
 521         spin_lock_irqsave(&p->lock, flags);
 522         if (p->snat) {
 523                 if ((p->snat->ip_addr_start == ip_addr_start)
 524                                 && (p->snat->ip_addr_end == ip_addr_end)) {
 525                         p->snat->mac_timeout = mac_timeout;
 526                         spin_unlock_irqrestore(&p->lock, flags);
 527                         return 0;
 528                 }
 529
 530                 /* Free the existing configuration and mappings. */
 531                 snat_free_conf(p);
 532         }
 533
 534         sc = kzalloc(sizeof *sc, GFP_ATOMIC);
 535         if (!sc) {
 536                 spin_unlock_irqrestore(&p->lock, flags);
 537                 return -ENOMEM;
 538         }
 539
 540         sc->ip_addr_start = ip_addr_start;
 541         sc->ip_addr_end = ip_addr_end;
 542         sc->mac_timeout = mac_timeout;
 543         INIT_LIST_HEAD(&sc->mappings);
 544
 545         p->snat = sc;
 546         spin_unlock_irqrestore(&p->lock, flags);
 547
 548         return 0;
 549 }
 550
 551 /* Handle a SNAT configuration message.
 552  *
 553  * Returns 0 if no problems are found.  Otherwise, a negative errno. */
 554 int
 555 snat_mod_config(struct datapath *dp, const struct nx_act_config *nac)
 556 {
 557         int n_entries = (ntohs(nac->header.header.length) - sizeof *nac)
 558                         / sizeof (struct nx_snat_config);
 559         int ret = 0;
 560         int i;
 561
 562         for (i=0; i<n_entries; i++) {
 563                 const struct nx_snat_config *sc = &nac->snat[i];
 564                 uint16_t port = ntohs(sc->port);
 565                 int r = 0;
 566
 567                 if (sc->command == NXSC_ADD)
 568                         r = snat_add_port(dp, port,
 569                                         ntohl(sc->ip_addr_start), ntohl(sc->ip_addr_end),
 570                                         ntohs(sc->mac_timeout));
 571                 else
 572                         r = snat_del_port(dp, port);
 573
 574                 if (r)
 575                         ret = r;
 576         }
 577
 578         return ret;
 579 }
 580 #endif