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