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 = (struct ip_arphdr *)arp_hdr(skb);
 207
 208         if (!pskb_may_pull(skb, sizeof *ah))
 209                 return 0;
 210
 211         if ((ah->ar_op != htons(ARPOP_REQUEST))
 212                         || ah->ar_hln != ETH_ALEN
 213                         || ah->ar_pro != htons(ETH_P_IP)
 214                         || ah->ar_pln != 4)
 215                 return 0;
 216
 217         /* We're only interested in addresses we rewrite. */
 218         if (!snat_this_address(p, ah->ar_tip)) {
 219                 return 0;
 220         }
 221
 222         arp_send(ARPOP_REPLY, ETH_P_ARP, ah->ar_sip, skb->dev, ah->ar_tip,
 223                          ah->ar_sha, p->dp->netdev->dev_addr, ah->ar_sha);
 224
 225         return -1;
 226 }
 227
 228 /* Checks whether 'skb' is a ping request for an SNAT'd interface.  If
 229  * so, it will generate a response.
 230  *
 231  * Returns 0 if the packet was not handled.  Otherwise, -1 is returned
 232  * and the caller is responsible for freeing 'skb'. */
 233 static int
 234 handle_icmp_snat(struct sk_buff *skb)
 235 {
 236         struct net_bridge_port *p = skb->dev->br_port;
 237         struct ethhdr *eh;
 238         struct iphdr *iph;
 239         struct icmphdr *icmph;
 240         uint8_t tmp_eth[ETH_ALEN];
 241         uint32_t tmp_ip;
 242         struct sk_buff *nskb;
 243
 244         /* We're only interested in addresses we rewrite. */
 245         iph = ip_hdr(skb);
 246         if (!snat_this_address(p, iph->daddr)) {
 247                 return 0;
 248         }
 249
 250         /* Drop fragments and packets not long enough to hold the ICMP
 251          * header. */
 252         if ((ntohs(iph->frag_off) & IP_OFFSET) != 0 ||
 253             !pskb_may_pull(skb, skb_transport_offset(skb) + 4))
 254                 return 0;
 255
 256         /* We only respond to echo requests to our address.  Continue
 257          * processing replies and other ICMP messages since they may be
 258          * intended for NAT'd hosts. */
 259         icmph = icmp_hdr(skb);
 260         if (icmph->type != ICMP_ECHO)
 261                 return 0;
 262
 263         /* Send an echo reply in response */
 264         nskb = skb_copy(skb, GFP_ATOMIC);
 265         if (!nskb) {
 266                 if (net_ratelimit())
 267                         printk("skb copy failed for icmp reply\n");
 268                 return -1;
 269         }
 270
 271         /* Update Ethernet header. */
 272         eh = eth_hdr(nskb);
 273         memcpy(tmp_eth, eh->h_dest, ETH_ALEN);
 274         memcpy(eh->h_dest, eh->h_source, ETH_ALEN);
 275         memcpy(eh->h_source, tmp_eth, ETH_ALEN);
 276
 277         /* Update IP header.
 278          * This is kind of busted, at least in that it doesn't check that the
 279          * echoed IP options make sense. */
 280         iph = ip_hdr(nskb);
 281         iph->id = 0;
 282         iph->frag_off = 0;
 283         iph->ttl = IPDEFTTL;
 284         iph->check = 0;
 285         tmp_ip = iph->daddr;
 286         iph->daddr = iph->saddr;
 287         iph->saddr = tmp_ip;
 288         iph->check = ip_fast_csum(iph, iph->ihl);
 289
 290         /* Update ICMP header. */
 291         icmph = icmp_hdr(nskb);
 292         icmph->type = ICMP_ECHOREPLY;
 293         icmph->checksum = 0;
 294         icmph->checksum = ip_compute_csum(icmph,
 295                                           nskb->tail - nskb->transport_header);
 296
 297         dp_xmit_skb_push(nskb);
 298
 299         return -1;
 300 }
 301
 302 /* Check if any SNAT maintenance needs to be done on 'skb' before it's
 303  * checked against the datapath's tables.  This includes DNAT
 304  * modification based on prior SNAT action and responding to ARP and
 305  * echo requests for the SNAT interface.
 306  *
 307  * Returns 0 if 'skb' should continue to be processed by the caller.
 308  * Returns -1 if the packet was handled, and the caller should free
 309  * 'skb'.
 310  */
 311 int
 312 snat_pre_route(struct sk_buff *skb)
 313 {
 314         struct iphdr *iph;
 315         int len;
 316
 317         WARN_ON_ONCE(skb_network_offset(skb));
 318         if (skb->protocol == htons(ETH_P_ARP))
 319                 return handle_arp_snat(skb);
 320         else if (skb->protocol != htons(ETH_P_IP))
 321                 return 0;
 322
 323         if (!pskb_may_pull(skb, sizeof *iph))
 324                 goto ipv4_error;
 325
 326         iph = ip_hdr(skb);
 327         if (iph->ihl < 5 || iph->version != 4)
 328                 goto ipv4_error;
 329
 330         if (!pskb_may_pull(skb, ip_hdrlen(skb)))
 331                 goto ipv4_error;
 332         skb_set_transport_header(skb, ip_hdrlen(skb));
 333
 334         /* Check if we need to echo reply for this address */
 335         iph = ip_hdr(skb);
 336         if ((iph->protocol == IPPROTO_ICMP) && (handle_icmp_snat(skb)))
 337                 return -1;
 338
 339         iph = ip_hdr(skb);
 340         if (unlikely(ip_fast_csum(iph, iph->ihl)))
 341                 goto ipv4_error;
 342
 343         len = ntohs(iph->tot_len);
 344         if ((skb->len < len) || len < (iph->ihl*4))
 345                 goto ipv4_error;
 346
 347         if (pskb_trim_rcsum(skb, len))
 348                 goto ipv4_error;
 349
 350         return NF_HOOK(PF_INET, NF_INET_PRE_ROUTING, skb, skb->dev, NULL,
 351                         snat_pre_route_finish);
 352
 353 ipv4_error:
 354         return -1;
 355 }
 356
 357
 358 static int
 359 snat_skb_finish(struct sk_buff *skb)
 360 {
 361         NF_HOOK(PF_INET, NF_INET_POST_ROUTING, skb, NULL, skb->dev,
 362                         dp_xmit_skb_push);
 363
 364         return 0;
 365 }
 366
 367 /* Update the MAC->IP mappings for the private side of the SNAT'd
 368  * interface. */
 369 static void
 370 update_mapping(struct net_bridge_port *p, const struct sk_buff *skb)
 371 {
 372         unsigned long flags;
 373         struct snat_conf *sc;
 374         const struct iphdr *iph = ip_hdr(skb);
 375         const struct ethhdr *eh = eth_hdr(skb);
 376         struct snat_mapping *m;
 377
 378         spin_lock_irqsave(&p->lock, flags);
 379         sc = p->snat;
 380         if (!sc)
 381                 goto done;
 382
 383         list_for_each_entry (m, &sc->mappings, node) {
 384                 if (m->ip_addr == iph->saddr){
 385                         memcpy(m->hw_addr, eh->h_source, ETH_ALEN);
 386                         m->used = jiffies;
 387                         goto done;
 388                 }
 389         }
 390
 391         m = kmalloc(sizeof *m, GFP_ATOMIC);
 392         if (!m)
 393                 goto done;
 394         m->ip_addr = iph->saddr;
 395         memcpy(m->hw_addr, eh->h_source, ETH_ALEN);
 396         m->used = jiffies;
 397
 398         list_add(&m->node, &sc->mappings);
 399
 400 done:
 401         spin_unlock_irqrestore(&p->lock, flags);
 402 }
 403
 404 /* Perform SNAT modification on 'skb' and send out 'out_port'.  If the
 405  * port was not configured for SNAT, it will be sent through the interface
 406  * unmodified.  'skb' is not consumed, so caller will need to free it.
 407  */
 408 void
 409 snat_skb(struct datapath *dp, const struct sk_buff *skb, int out_port)
 410 {
 411         struct net_bridge_port *p = dp->ports[out_port];
 412         struct sk_buff *nskb;
 413
 414         if (!p)
 415                 return;
 416
 417         /* FIXME: Expensive.  Just need to skb_clone() here?
 418          * (However, the skb_copy() does linearize and ensure that the headers
 419          * are accessible.) */
 420         nskb = skb_copy(skb, GFP_ATOMIC);
 421         if (!nskb)
 422                 return;
 423
 424         nskb->dev = p->dev;
 425
 426         /* We only SNAT IP, so just send it on its way if not */
 427         if (skb->protocol != htons(ETH_P_IP)) {
 428                 dp_xmit_skb(nskb);
 429                 return;
 430         }
 431
 432         /* Set the source MAC to the OF interface */
 433         memcpy(eth_hdr(nskb)->h_source, dp->netdev->dev_addr, ETH_ALEN);
 434
 435         update_mapping(p, skb);
 436
 437         /* Take the Ethernet header back off for netfilter hooks. */
 438         skb_pull(nskb, ETH_HLEN);
 439
 440         NF_HOOK(PF_INET, NF_INET_FORWARD, nskb, skb->dev, nskb->dev,
 441                         snat_skb_finish);
 442 }
 443
 444 /* Remove SNAT configuration on port 'p'.
 445  *
 446  * NB: The caller must hold the port's spinlock. */
 447 int
 448 snat_free_conf(struct net_bridge_port *p)
 449 {
 450         struct snat_conf *sc = p->snat;
 451
 452         if (!sc)
 453                 return -EINVAL;
 454
 455         /* Free existing mapping entries */
 456         while (!list_empty(&sc->mappings)) {
 457                 struct snat_mapping *m = list_entry(sc->mappings.next,
 458                                 struct snat_mapping, node);
 459                 list_del(&m->node);
 460                 kfree(m);
 461         }
 462
 463         kfree(p->snat);
 464         p->snat = NULL;
 465
 466         return 0;
 467 }
 468
 469 /* Remove SNAT configuration from an interface. */
 470 static int
 471 snat_del_port(struct datapath *dp, uint16_t port)
 472 {
 473         unsigned long flags;
 474         struct net_bridge_port *p = dp->ports[port];
 475
 476         if (!p) {
 477                 if (net_ratelimit())
 478                         printk("Attempt to remove snat on non-existent port: %d\n", port);
 479                 return -EINVAL;
 480         }
 481
 482         spin_lock_irqsave(&p->lock, flags);
 483         if (snat_free_conf(p)) {
 484                 /* SNAT not configured on this port */
 485                 spin_unlock_irqrestore(&p->lock, flags);
 486                 if (net_ratelimit())
 487                         printk("Attempt to remove snat on non-snat port: %d\n", port);
 488                 return -EINVAL;
 489         }
 490
 491         spin_unlock_irqrestore(&p->lock, flags);
 492
 493         return 0;
 494 }
 495
 496 /* Add SNAT configuration to an interface.  */
 497 static int
 498 snat_add_port(struct datapath *dp, uint16_t port,
 499                 uint32_t ip_addr_start, uint32_t ip_addr_end,
 500                 uint16_t mac_timeout)
 501 {
 502         unsigned long flags;
 503         struct net_bridge_port *p = dp->ports[port];
 504         struct snat_conf *sc;
 505
 506
 507         if (mac_timeout == 0)
 508                 mac_timeout = MAC_TIMEOUT_DEFAULT;
 509
 510         if (!p) {
 511                 if (net_ratelimit())
 512                         printk("Attempt to add snat on non-existent port: %d\n", port);
 513                 return -EINVAL;
 514         }
 515
 516         /* If SNAT is already configured on the port, check whether the same
 517          * IP addresses are used.  If so, just update the mac timeout
 518          * configuration. Otherwise, drop all SNAT configuration and
 519          * reconfigure it. */
 520         spin_lock_irqsave(&p->lock, flags);
 521         if (p->snat) {
 522                 if ((p->snat->ip_addr_start == ip_addr_start)
 523                                 && (p->snat->ip_addr_end == ip_addr_end)) {
 524                         p->snat->mac_timeout = mac_timeout;
 525                         spin_unlock_irqrestore(&p->lock, flags);
 526                         return 0;
 527                 }
 528
 529                 /* Free the existing configuration and mappings. */
 530                 snat_free_conf(p);
 531         }
 532
 533         sc = kzalloc(sizeof *sc, GFP_ATOMIC);
 534         if (!sc) {
 535                 spin_unlock_irqrestore(&p->lock, flags);
 536                 return -ENOMEM;
 537         }
 538
 539         sc->ip_addr_start = ip_addr_start;
 540         sc->ip_addr_end = ip_addr_end;
 541         sc->mac_timeout = mac_timeout;
 542         INIT_LIST_HEAD(&sc->mappings);
 543
 544         p->snat = sc;
 545         spin_unlock_irqrestore(&p->lock, flags);
 546
 547         return 0;
 548 }
 549
 550 /* Handle a SNAT configuration message.
 551  *
 552  * Returns 0 if no problems are found.  Otherwise, a negative errno. */
 553 int
 554 snat_mod_config(struct datapath *dp, const struct nx_act_config *nac)
 555 {
 556         int n_entries = (ntohs(nac->header.header.length) - sizeof *nac)
 557                         / sizeof (struct nx_snat_config);
 558         int ret = 0;
 559         int i;
 560
 561         for (i=0; i<n_entries; i++) {
 562                 const struct nx_snat_config *sc = &nac->snat[i];
 563                 uint16_t port = ntohs(sc->port);
 564                 int r = 0;
 565
 566                 if (sc->command == NXSC_ADD)
 567                         r = snat_add_port(dp, port,
 568                                         ntohl(sc->ip_addr_start), ntohl(sc->ip_addr_end),
 569                                         ntohs(sc->mac_timeout));
 570                 else
 571                         r = snat_del_port(dp, port);
 572
 573                 if (r)
 574                         ret = r;
 575         }
 576
 577         return ret;
 578 }
 579 #endif