netlink.c

   1 /* User-kernel network link */
   2
   3 /* See RFCs 791, 792, 1123 and 1812 */
   4
   5 /* The netlink device is actually a router.  Tunnels are unnumbered
   6    point-to-point lines (RFC1812 section 2.2.7); the router has a
   7    single address (the 'router-id'). */
   8
   9 /* This is where we currently have the anti-spoofing paranoia - before
  10    sending a packet to the kernel we check that the tunnel it came
  11    over could reasonably have produced it. */
  12
  13
  14 /* Points to note from RFC1812 (which may require changes in this
  15    file):
  16
  17 3.3.4 Maximum Transmission Unit - MTU
  18
  19    The MTU of each logical interface MUST be configurable within the
  20    range of legal MTUs for the interface.
  21
  22    Many Link Layer protocols define a maximum frame size that may be
  23    sent.  In such cases, a router MUST NOT allow an MTU to be set which
  24    would allow sending of frames larger than those allowed by the Link
  25    Layer protocol.  However, a router SHOULD be willing to receive a
  26    packet as large as the maximum frame size even if that is larger than
  27    the MTU.
  28
  29 4.2.1  A router SHOULD count datagrams discarded.
  30
  31 4.2.2.1 Source route options - we probably should implement processing
  32 of source routes, even though mostly the security policy will prevent
  33 their use.
  34
  35 5.3.13.4 Source Route Options
  36
  37    A router MUST implement support for source route options in forwarded
  38    packets.  A router MAY implement a configuration option that, when
  39    enabled, causes all source-routed packets to be discarded.  However,
  40    such an option MUST NOT be enabled by default.
  41
  42 5.3.13.5 Record Route Option
  43
  44    Routers MUST support the Record Route option in forwarded packets.
  45
  46    A router MAY provide a configuration option that, if enabled, will
  47    cause the router to ignore (i.e., pass through unchanged) Record
  48    Route options in forwarded packets.  If provided, such an option MUST
  49    default to enabling the record-route.  This option should not affect
  50    the processing of Record Route options in datagrams received by the
  51    router itself (in particular, Record Route options in ICMP echo
  52    requests will still be processed according to Section [4.3.3.6]).
  53
  54 5.3.13.6 Timestamp Option
  55
  56    Routers MUST support the timestamp option in forwarded packets.  A
  57    timestamp value MUST follow the rules given [INTRO:2].
  58
  59    If the flags field = 3 (timestamp and prespecified address), the
  60    router MUST add its timestamp if the next prespecified address
  61    matches any of the router's IP addresses.  It is not necessary that
  62    the prespecified address be either the address of the interface on
  63    which the packet arrived or the address of the interface over which
  64    it will be sent.
  65
  66
  67 4.2.2.7 Fragmentation: RFC 791 Section 3.2
  68
  69    Fragmentation, as described in [INTERNET:1], MUST be supported by a
  70    router.
  71
  72 4.2.2.8 Reassembly: RFC 791 Section 3.2
  73
  74    As specified in the corresponding section of [INTRO:2], a router MUST
  75    support reassembly of datagrams that it delivers to itself.
  76
  77 4.2.2.9 Time to Live: RFC 791 Section 3.2
  78
  79    Note in particular that a router MUST NOT check the TTL of a packet
  80    except when forwarding it.
  81
  82    A router MUST NOT discard a datagram just because it was received
  83    with TTL equal to zero or one; if it is to the router and otherwise
  84    valid, the router MUST attempt to receive it.
  85
  86    On messages the router originates, the IP layer MUST provide a means
  87    for the transport layer to set the TTL field of every datagram that
  88    is sent.  When a fixed TTL value is used, it MUST be configurable.
  89
  90
  91 8.1 The Simple Network Management Protocol - SNMP
  92 8.1.1 SNMP Protocol Elements
  93
  94    Routers MUST be manageable by SNMP [MGT:3].  The SNMP MUST operate
  95    using UDP/IP as its transport and network protocols.
  96
  97
  98 */
  99
 100 #include <string.h>
 101 #include <assert.h>
 102 #include <limits.h>
 103 #include "secnet.h"
 104 #include "util.h"
 105 #include "ipaddr.h"
 106 #include "netlink.h"
 107 #include "process.h"
 108
 109 #define ICMP_TYPE_ECHO_REPLY             0
 110
 111 #define ICMP_TYPE_UNREACHABLE            3
 112 #define ICMP_CODE_NET_UNREACHABLE        0
 113 #define ICMP_CODE_PROTOCOL_UNREACHABLE   2
 114 #define ICMP_CODE_FRAGMENTATION_REQUIRED 4
 115 #define ICMP_CODE_NET_PROHIBITED        13
 116
 117 #define ICMP_TYPE_ECHO_REQUEST           8
 118
 119 #define ICMP_TYPE_TIME_EXCEEDED         11
 120 #define ICMP_CODE_TTL_EXCEEDED           0
 121
 122 /* Generic IP checksum routine */
 123 static inline uint16_t ip_csum(uint8_t *iph,int32_t count)
 124 {
 125     register uint32_t sum=0;
 126
 127     while (count>1) {
 128         sum+=ntohs(*(uint16_t *)iph);
 129         iph+=2;
 130         count-=2;
 131     }
 132     if(count>0)
 133         sum+=*(uint8_t *)iph;
 134     while (sum>>16)
 135         sum=(sum&0xffff)+(sum>>16);
 136     return htons(~sum);
 137 }
 138
 139 #ifdef i386
 140 /*
 141  *      This is a version of ip_compute_csum() optimized for IP headers,
 142  *      which always checksum on 4 octet boundaries.
 143  *
 144  *      By Jorge Cwik <jorge@laser.satlink.net>, adapted for linux by
 145  *      Arnt Gulbrandsen.
 146  */
 147 static inline uint16_t ip_fast_csum(uint8_t *iph, int32_t ihl) {
 148     uint32_t sum;
 149
 150     __asm__ __volatile__(
 151             "movl (%1), %0      ;\n"
 152             "subl $4, %2        ;\n"
 153             "jbe 2f             ;\n"
 154             "addl 4(%1), %0     ;\n"
 155             "adcl 8(%1), %0     ;\n"
 156             "adcl 12(%1), %0    ;\n"
 157 "1:         adcl 16(%1), %0     ;\n"
 158             "lea 4(%1), %1      ;\n"
 159             "decl %2            ;\n"
 160             "jne 1b             ;\n"
 161             "adcl $0, %0        ;\n"
 162             "movl %0, %2        ;\n"
 163             "shrl $16, %0       ;\n"
 164             "addw %w2, %w0      ;\n"
 165             "adcl $0, %0        ;\n"
 166             "notl %0            ;\n"
 167 "2:                             ;\n"
 168         /* Since the input registers which are loaded with iph and ipl
 169            are modified, we must also specify them as outputs, or gcc
 170            will assume they contain their original values. */
 171         : "=r" (sum), "=r" (iph), "=r" (ihl)
 172         : "1" (iph), "2" (ihl)
 173         : "memory");
 174     return sum;
 175 }
 176 #else
 177 static inline uint16_t ip_fast_csum(uint8_t *iph, int32_t ihl)
 178 {
 179     assert(ihl < INT_MAX/4);
 180     return ip_csum(iph,ihl*4);
 181 }
 182 #endif
 183
 184 struct iphdr {
 185 #if defined (WORDS_BIGENDIAN)
 186     uint8_t    version:4,
 187                ihl:4;
 188 #else
 189     uint8_t    ihl:4,
 190                version:4;
 191 #endif
 192     uint8_t    tos;
 193     uint16_t   tot_len;
 194     uint16_t   id;
 195     uint16_t   frag_off;
 196     uint8_t    ttl;
 197     uint8_t    protocol;
 198     uint16_t   check;
 199     uint32_t   saddr;
 200     uint32_t   daddr;
 201     /* The options start here. */
 202 };
 203
 204 struct icmphdr {
 205     struct iphdr iph;
 206     uint8_t type;
 207     uint8_t code;
 208     uint16_t check;
 209     union {
 210         uint32_t unused;
 211         struct {
 212             uint8_t pointer;
 213             uint8_t unused1;
 214             uint16_t unused2;
 215         } pprob;
 216         uint32_t gwaddr;
 217         struct {
 218             uint16_t id;
 219             uint16_t seq;
 220         } echo;
 221     } d;
 222 };
 223
 224 static void netlink_packet_deliver(struct netlink *st,
 225                                    struct netlink_client *client,
 226                                    struct buffer_if *buf);
 227
 228 /* XXX RFC1812 4.3.2.5:
 229    All other ICMP error messages (Destination Unreachable,
 230    Redirect, Time Exceeded, and Parameter Problem) SHOULD have their
 231    precedence value set to 6 (INTERNETWORK CONTROL) or 7 (NETWORK
 232    CONTROL).  The IP Precedence value for these error messages MAY be
 233    settable.
 234    */
 235 static struct icmphdr *netlink_icmp_tmpl(struct netlink *st,
 236                                          uint32_t dest,uint16_t len)
 237 {
 238     struct icmphdr *h;
 239
 240     BUF_ALLOC(&st->icmp,"netlink_icmp_tmpl");
 241     buffer_init(&st->icmp,calculate_max_start_pad());
 242     h=buf_append(&st->icmp,sizeof(*h));
 243
 244     h->iph.version=4;
 245     h->iph.ihl=5;
 246     h->iph.tos=0;
 247     h->iph.tot_len=htons(len+(h->iph.ihl*4)+8);
 248     h->iph.id=0;
 249     h->iph.frag_off=0;
 250     h->iph.ttl=255; /* XXX should be configurable */
 251     h->iph.protocol=1;
 252     h->iph.saddr=htonl(st->secnet_address);
 253     h->iph.daddr=htonl(dest);
 254     h->iph.check=0;
 255     h->iph.check=ip_fast_csum((uint8_t *)&h->iph,h->iph.ihl);
 256     h->check=0;
 257     h->d.unused=0;
 258
 259     return h;
 260 }
 261
 262 /* Fill in the ICMP checksum field correctly */
 263 static void netlink_icmp_csum(struct icmphdr *h)
 264 {
 265     int32_t len;
 266
 267     len=ntohs(h->iph.tot_len)-(4*h->iph.ihl);
 268     h->check=0;
 269     h->check=ip_csum(&h->type,len);
 270 }
 271
 272 /* RFC1122:
 273  *       An ICMP error message MUST NOT be sent as the result of
 274  *       receiving:
 275  *
 276  *       *    an ICMP error message, or
 277  *
 278  *       *    a datagram destined to an IP broadcast or IP multicast
 279  *            address, or
 280  *
 281  *       *    a datagram sent as a link-layer broadcast, or
 282  *
 283  *       *    a non-initial fragment, or
 284  *
 285  *       *    a datagram whose source address does not define a single
 286  *            host -- e.g., a zero address, a loopback address, a
 287  *            broadcast address, a multicast address, or a Class E
 288  *            address.
 289  */
 290 static bool_t netlink_icmp_may_reply(struct buffer_if *buf)
 291 {
 292     struct iphdr *iph;
 293     struct icmphdr *icmph;
 294     uint32_t source;
 295
 296     if (buf->size < (int)sizeof(struct icmphdr)) return False;
 297     iph=(struct iphdr *)buf->start;
 298     icmph=(struct icmphdr *)buf->start;
 299     if (iph->protocol==1) {
 300         switch(icmph->type) {
 301         case 3: /* Destination unreachable */
 302         case 11: /* Time Exceeded */
 303         case 12: /* Parameter Problem */
 304             return False;
 305         }
 306     }
 307     /* How do we spot broadcast destination addresses? */
 308     if (ntohs(iph->frag_off)&0x1fff) return False; /* Non-initial fragment */
 309     source=ntohl(iph->saddr);
 310     if (source==0) return False;
 311     if ((source&0xff000000)==0x7f000000) return False;
 312     /* How do we spot broadcast source addresses? */
 313     if ((source&0xf0000000)==0xe0000000) return False; /* Multicast */
 314     if ((source&0xf0000000)==0xf0000000) return False; /* Class E */
 315     return True;
 316 }
 317
 318 /* How much of the original IP packet do we include in its ICMP
 319    response? The header plus up to 64 bits. */
 320
 321 /* XXX TODO RFC1812:
 322 4.3.2.3 Original Message Header
 323
 324    Historically, every ICMP error message has included the Internet
 325    header and at least the first 8 data bytes of the datagram that
 326    triggered the error.  This is no longer adequate, due to the use of
 327    IP-in-IP tunneling and other technologies.  Therefore, the ICMP
 328    datagram SHOULD contain as much of the original datagram as possible
 329    without the length of the ICMP datagram exceeding 576 bytes.  The
 330    returned IP header (and user data) MUST be identical to that which
 331    was received, except that the router is not required to undo any
 332    modifications to the IP header that are normally performed in
 333    forwarding that were performed before the error was detected (e.g.,
 334    decrementing the TTL, or updating options).  Note that the
 335    requirements of Section [4.3.3.5] supersede this requirement in some
 336    cases (i.e., for a Parameter Problem message, if the problem is in a
 337    modified field, the router must undo the modification).  See Section
 338    [4.3.3.5]).
 339    */
 340 static uint16_t netlink_icmp_reply_len(struct buffer_if *buf)
 341 {
 342     if (buf->size < (int)sizeof(struct iphdr)) return 0;
 343     struct iphdr *iph=(struct iphdr *)buf->start;
 344     uint16_t hlen,plen;
 345
 346     hlen=iph->ihl*4;
 347     /* We include the first 8 bytes of the packet data, provided they exist */
 348     hlen+=8;
 349     plen=ntohs(iph->tot_len);
 350     return (hlen>plen?plen:hlen);
 351 }
 352
 353 /* client indicates where the packet we're constructing a response to
 354    comes from. NULL indicates the host. */
 355 static void netlink_icmp_simple(struct netlink *st, struct buffer_if *buf,
 356                                 struct netlink_client *client,
 357                                 uint8_t type, uint8_t code)
 358 {
 359     struct icmphdr *h;
 360     uint16_t len;
 361
 362     if (netlink_icmp_may_reply(buf)) {
 363         struct iphdr *iph=(struct iphdr *)buf->start;
 364         len=netlink_icmp_reply_len(buf);
 365         h=netlink_icmp_tmpl(st,ntohl(iph->saddr),len);
 366         h->type=type; h->code=code;
 367         memcpy(buf_append(&st->icmp,len),buf->start,len);
 368         netlink_icmp_csum(h);
 369         netlink_packet_deliver(st,NULL,&st->icmp);
 370         BUF_ASSERT_FREE(&st->icmp);
 371     }
 372 }
 373
 374 /*
 375  * RFC1122: 3.1.2.2 MUST silently discard any IP frame that fails the
 376  * checksum.
 377  * RFC1812: 4.2.2.5 MUST discard messages containing invalid checksums.
 378  *
 379  * Is the datagram acceptable?
 380  *
 381  * 1. Length at least the size of an ip header
 382  * 2. Version of 4
 383  * 3. Checksums correctly.
 384  * 4. Doesn't have a bogus length
 385  */
 386 static bool_t netlink_check(struct netlink *st, struct buffer_if *buf,
 387                             char *errmsgbuf, int errmsgbuflen)
 388 {
 389 #define BAD(...) do{                                    \
 390         snprintf(errmsgbuf,errmsgbuflen,__VA_ARGS__);   \
 391         return False;                                   \
 392     }while(0)
 393
 394     if (buf->size < (int)sizeof(struct iphdr)) BAD("len %"PRIu32"",buf->size);
 395     struct iphdr *iph=(struct iphdr *)buf->start;
 396     int32_t len;
 397
 398     if (iph->ihl < 5) BAD("ihl %u",iph->ihl);
 399     if (iph->version != 4) BAD("version %u",iph->version);
 400     if (buf->size < iph->ihl*4) BAD("size %"PRId32"<%u*4",buf->size,iph->ihl);
 401     if (ip_fast_csum((uint8_t *)iph, iph->ihl)!=0) BAD("csum");
 402     len=ntohs(iph->tot_len);
 403     /* There should be no padding */
 404     if (buf->size!=len) BAD("len %"PRId32"!=%"PRId32,buf->size,len);
 405     if (len<(iph->ihl<<2)) BAD("len %"PRId32"<(%u<<2)",len,iph->ihl);
 406     /* XXX check that there's no source route specified */
 407     return True;
 408
 409 #undef BAD
 410 }
 411
 412 /* Deliver a packet. "client" is the _origin_ of the packet, not its
 413    destination, and is NULL for packets from the host and packets
 414    generated internally in secnet.  */
 415 static void netlink_packet_deliver(struct netlink *st,
 416                                    struct netlink_client *client,
 417                                    struct buffer_if *buf)
 418 {
 419     if (buf->size < (int)sizeof(struct iphdr)) {
 420         Message(M_ERR,"%s: trying to deliver a too-short packet"
 421                 " from %s!\n",st->name, client?client->name:"(local)");
 422         BUF_FREE(buf);
 423         return;
 424     }
 425
 426     struct iphdr *iph=(struct iphdr *)buf->start;
 427     uint32_t dest=ntohl(iph->daddr);
 428     uint32_t source=ntohl(iph->saddr);
 429     uint32_t best_quality;
 430     bool_t allow_route=False;
 431     bool_t found_allowed=False;
 432     int best_match;
 433     int i;
 434
 435     BUF_ASSERT_USED(buf);
 436
 437     if (dest==st->secnet_address) {
 438         Message(M_ERR,"%s: trying to deliver a packet to myself!\n",st->name);
 439         BUF_FREE(buf);
 440         return;
 441     }
 442
 443     /* Packets from the host (client==NULL) may always be routed.  Packets
 444        from clients with the allow_route option will also be routed. */
 445     if (!client || (client && (client->options & OPT_ALLOWROUTE)))
 446         allow_route=True;
 447
 448     /* If !allow_route, we check the routing table anyway, and if
 449        there's a suitable route with OPT_ALLOWROUTE set we use it.  If
 450        there's a suitable route, but none with OPT_ALLOWROUTE set then
 451        we generate ICMP 'communication with destination network
 452        administratively prohibited'. */
 453
 454     best_quality=0;
 455     best_match=-1;
 456     for (i=0; i<st->n_clients; i++) {
 457         if (st->routes[i]->up &&
 458             ipset_contains_addr(st->routes[i]->networks,dest)) {
 459             /* It's an available route to the correct destination. But is
 460                it better than the one we already have? */
 461
 462             /* If we have already found an allowed route then we don't
 463                bother looking at routes we're not allowed to use.  If
 464                we don't yet have an allowed route we'll consider any.  */
 465             if (!allow_route && found_allowed) {
 466                 if (!(st->routes[i]->options&OPT_ALLOWROUTE)) continue;
 467             }
 468
 469             if (st->routes[i]->link_quality>best_quality
 470                 || best_quality==0) {
 471                 best_quality=st->routes[i]->link_quality;
 472                 best_match=i;
 473                 if (st->routes[i]->options&OPT_ALLOWROUTE)
 474                     found_allowed=True;
 475                 /* If quality isn't perfect we may wish to
 476                    consider kicking the tunnel with a 0-length
 477                    packet to prompt it to perform a key setup.
 478                    Then it'll eventually decide it's up or
 479                    down. */
 480                 /* If quality is perfect and we're allowed to use the
 481                    route we don't need to search any more. */
 482                 if (best_quality>=MAXIMUM_LINK_QUALITY &&
 483                     (allow_route || found_allowed)) break;
 484             }
 485         }
 486     }
 487     if (best_match==-1) {
 488         /* The packet's not going down a tunnel.  It might (ought to)
 489            be for the host.   */
 490         if (ipset_contains_addr(st->networks,dest)) {
 491             st->deliver_to_host(st->dst,buf);
 492             st->outcount++;
 493             BUF_ASSERT_FREE(buf);
 494         } else {
 495             string_t s,d;
 496             s=ipaddr_to_string(source);
 497             d=ipaddr_to_string(dest);
 498             Message(M_DEBUG,"%s: don't know where to deliver packet "
 499                     "(s=%s, d=%s)\n", st->name, s, d);
 500             free(s); free(d);
 501             netlink_icmp_simple(st,buf,client,ICMP_TYPE_UNREACHABLE,
 502                                 ICMP_CODE_NET_UNREACHABLE);
 503             BUF_FREE(buf);
 504         }
 505     } else {
 506         if (!allow_route &&
 507             !(st->routes[best_match]->options&OPT_ALLOWROUTE)) {
 508             string_t s,d;
 509             s=ipaddr_to_string(source);
 510             d=ipaddr_to_string(dest);
 511             /* We have a usable route but aren't allowed to use it.
 512                Generate ICMP destination unreachable: communication
 513                with destination network administratively prohibited */
 514             Message(M_NOTICE,"%s: denied forwarding for packet (s=%s, d=%s)\n",
 515                     st->name,s,d);
 516             free(s); free(d);
 517
 518             netlink_icmp_simple(st,buf,client,ICMP_TYPE_UNREACHABLE,
 519                                 ICMP_CODE_NET_PROHIBITED);
 520             BUF_FREE(buf);
 521         } else {
 522             if (best_quality>0) {
 523                 /* XXX Fragment if required */
 524                 st->routes[best_match]->deliver(
 525                     st->routes[best_match]->dst, buf);
 526                 st->routes[best_match]->outcount++;
 527                 BUF_ASSERT_FREE(buf);
 528             } else {
 529                 /* Generate ICMP destination unreachable */
 530                 netlink_icmp_simple(st,buf,client,ICMP_TYPE_UNREACHABLE,
 531                                     ICMP_CODE_NET_UNREACHABLE); /* client==NULL */
 532                 BUF_FREE(buf);
 533             }
 534         }
 535     }
 536     BUF_ASSERT_FREE(buf);
 537 }
 538
 539 static void netlink_packet_forward(struct netlink *st,
 540                                    struct netlink_client *client,
 541                                    struct buffer_if *buf)
 542 {
 543     if (buf->size < (int)sizeof(struct iphdr)) return;
 544     struct iphdr *iph=(struct iphdr *)buf->start;
 545
 546     BUF_ASSERT_USED(buf);
 547
 548     /* Packet has already been checked */
 549     if (iph->ttl<=1) {
 550         /* Generate ICMP time exceeded */
 551         netlink_icmp_simple(st,buf,client,ICMP_TYPE_TIME_EXCEEDED,
 552                             ICMP_CODE_TTL_EXCEEDED);
 553         BUF_FREE(buf);
 554         return;
 555     }
 556     iph->ttl--;
 557     iph->check=0;
 558     iph->check=ip_fast_csum((uint8_t *)iph,iph->ihl);
 559
 560     netlink_packet_deliver(st,client,buf);
 561     BUF_ASSERT_FREE(buf);
 562 }
 563
 564 /* Deal with packets addressed explicitly to us */
 565 static void netlink_packet_local(struct netlink *st,
 566                                  struct netlink_client *client,
 567                                  struct buffer_if *buf)
 568 {
 569     struct icmphdr *h;
 570
 571     st->localcount++;
 572
 573     if (buf->size < (int)sizeof(struct icmphdr)) {
 574         Message(M_WARNING,"%s: short packet addressed to secnet; "
 575                 "ignoring it\n",st->name);
 576         BUF_FREE(buf);
 577         return;
 578     }
 579     h=(struct icmphdr *)buf->start;
 580
 581     if ((ntohs(h->iph.frag_off)&0xbfff)!=0) {
 582         Message(M_WARNING,"%s: fragmented packet addressed to secnet; "
 583                 "ignoring it\n",st->name);
 584         BUF_FREE(buf);
 585         return;
 586     }
 587
 588     if (h->iph.protocol==1) {
 589         /* It's ICMP */
 590         if (h->type==ICMP_TYPE_ECHO_REQUEST && h->code==0) {
 591             /* ICMP echo-request. Special case: we re-use the buffer
 592                to construct the reply. */
 593             h->type=ICMP_TYPE_ECHO_REPLY;
 594             h->iph.daddr=h->iph.saddr;
 595             h->iph.saddr=htonl(st->secnet_address);
 596             h->iph.ttl=255;
 597             h->iph.check=0;
 598             h->iph.check=ip_fast_csum((uint8_t *)h,h->iph.ihl);
 599             netlink_icmp_csum(h);
 600             netlink_packet_deliver(st,NULL,buf);
 601             return;
 602         }
 603         Message(M_WARNING,"%s: unknown incoming ICMP\n",st->name);
 604     } else {
 605         /* Send ICMP protocol unreachable */
 606         netlink_icmp_simple(st,buf,client,ICMP_TYPE_UNREACHABLE,
 607                             ICMP_CODE_PROTOCOL_UNREACHABLE);
 608         BUF_FREE(buf);
 609         return;
 610     }
 611
 612     BUF_FREE(buf);
 613 }
 614
 615 /* If cid==NULL packet is from host, otherwise cid specifies which tunnel
 616    it came from. */
 617 static void netlink_incoming(struct netlink *st, struct netlink_client *client,
 618                              struct buffer_if *buf)
 619 {
 620     uint32_t source,dest;
 621     struct iphdr *iph;
 622     char errmsgbuf[50];
 623     const char *sourcedesc=client?client->name:"host";
 624
 625     BUF_ASSERT_USED(buf);
 626
 627     if (!netlink_check(st,buf,errmsgbuf,sizeof(errmsgbuf))) {
 628         Message(M_WARNING,"%s: bad IP packet from %s: %s\n",
 629                 st->name,sourcedesc,
 630                 errmsgbuf);
 631         BUF_FREE(buf);
 632         return;
 633     }
 634     assert(buf->size >= (int)sizeof(struct icmphdr));
 635     iph=(struct iphdr *)buf->start;
 636
 637     source=ntohl(iph->saddr);
 638     dest=ntohl(iph->daddr);
 639
 640     /* Check source. If we don't like the source, there's no point
 641        generating ICMP because we won't know how to get it to the
 642        source of the packet. */
 643     if (client) {
 644         /* Check that the packet source is appropriate for the tunnel
 645            it came down */
 646         if (!ipset_contains_addr(client->networks,source)) {
 647             string_t s,d;
 648             s=ipaddr_to_string(source);
 649             d=ipaddr_to_string(dest);
 650             Message(M_WARNING,"%s: packet from tunnel %s with bad "
 651                     "source address (s=%s,d=%s)\n",st->name,client->name,s,d);
 652             free(s); free(d);
 653             BUF_FREE(buf);
 654             return;
 655         }
 656     } else {
 657         /* Check that the packet originates in our configured local
 658            network, and hasn't been forwarded from elsewhere or
 659            generated with the wrong source address */
 660         if (!ipset_contains_addr(st->networks,source)) {
 661             string_t s,d;
 662             s=ipaddr_to_string(source);
 663             d=ipaddr_to_string(dest);
 664             Message(M_WARNING,"%s: outgoing packet with bad source address "
 665                     "(s=%s,d=%s)\n",st->name,s,d);
 666             free(s); free(d);
 667             BUF_FREE(buf);
 668             return;
 669         }
 670     }
 671
 672     /* If this is a point-to-point device we don't examine the
 673        destination address at all; we blindly send it down our
 674        one-and-only registered tunnel, or to the host, depending on
 675        where it came from.  It's up to external software to check
 676        address validity and generate ICMP, etc. */
 677     if (st->ptp) {
 678         if (client) {
 679             st->deliver_to_host(st->dst,buf);
 680         } else {
 681             st->clients->deliver(st->clients->dst,buf);
 682         }
 683         BUF_ASSERT_FREE(buf);
 684         return;
 685     }
 686
 687     /* st->secnet_address needs checking before matching destination
 688        addresses */
 689     if (dest==st->secnet_address) {
 690         netlink_packet_local(st,client,buf);
 691         BUF_ASSERT_FREE(buf);
 692         return;
 693     }
 694     netlink_packet_forward(st,client,buf);
 695     BUF_ASSERT_FREE(buf);
 696 }
 697
 698 static void netlink_inst_incoming(void *sst, struct buffer_if *buf)
 699 {
 700     struct netlink_client *c=sst;
 701     struct netlink *st=c->nst;
 702
 703     netlink_incoming(st,c,buf);
 704 }
 705
 706 static void netlink_dev_incoming(void *sst, struct buffer_if *buf)
 707 {
 708     struct netlink *st=sst;
 709
 710     netlink_incoming(st,NULL,buf);
 711 }
 712
 713 static void netlink_set_quality(void *sst, uint32_t quality)
 714 {
 715     struct netlink_client *c=sst;
 716     struct netlink *st=c->nst;
 717
 718     c->link_quality=quality;
 719     c->up=(c->link_quality==LINK_QUALITY_DOWN)?False:True;
 720     if (c->options&OPT_SOFTROUTE) {
 721         st->set_routes(st->dst,c);
 722     }
 723 }
 724
 725 static void netlink_output_subnets(struct netlink *st, uint32_t loglevel,
 726                                    struct subnet_list *snets)
 727 {
 728     int32_t i;
 729     string_t net;
 730
 731     for (i=0; i<snets->entries; i++) {
 732         net=subnet_to_string(snets->list[i]);
 733         Message(loglevel,"%s ",net);
 734         free(net);
 735     }
 736 }
 737
 738 static void netlink_dump_routes(struct netlink *st, bool_t requested)
 739 {
 740     int i;
 741     string_t net;
 742     uint32_t c=M_INFO;
 743
 744     if (requested) c=M_WARNING;
 745     if (st->ptp) {
 746         net=ipaddr_to_string(st->secnet_address);
 747         Message(c,"%s: point-to-point (remote end is %s); routes:\n",
 748                 st->name, net);
 749         free(net);
 750         netlink_output_subnets(st,c,st->clients->subnets);
 751         Message(c,"\n");
 752     } else {
 753         Message(c,"%s: routing table:\n",st->name);
 754         for (i=0; i<st->n_clients; i++) {
 755             netlink_output_subnets(st,c,st->routes[i]->subnets);
 756             Message(c,"-> tunnel %s (%s,mtu %d,%s routes,%s,"
 757                     "quality %d,use %d,pri %lu)\n",
 758                     st->routes[i]->name,
 759                     st->routes[i]->up?"up":"down",
 760                     st->routes[i]->mtu,
 761                     st->routes[i]->options&OPT_SOFTROUTE?"soft":"hard",
 762                     st->routes[i]->options&OPT_ALLOWROUTE?"free":"restricted",
 763                     st->routes[i]->link_quality,
 764                     st->routes[i]->outcount,
 765                     (unsigned long)st->routes[i]->priority);
 766         }
 767         net=ipaddr_to_string(st->secnet_address);
 768         Message(c,"%s/32 -> netlink \"%s\" (use %d)\n",
 769                 net,st->name,st->localcount);
 770         free(net);
 771         for (i=0; i<st->subnets->entries; i++) {
 772             net=subnet_to_string(st->subnets->list[i]);
 773             Message(c,"%s ",net);
 774             free(net);
 775         }
 776         if (i>0)
 777             Message(c,"-> host (use %d)\n",st->outcount);
 778     }
 779 }
 780
 781 /* ap is a pointer to a member of the routes array */
 782 static int netlink_compare_client_priority(const void *ap, const void *bp)
 783 {
 784     const struct netlink_client *const*a=ap;
 785     const struct netlink_client *const*b=bp;
 786
 787     if ((*a)->priority==(*b)->priority) return 0;
 788     if ((*a)->priority<(*b)->priority) return 1;
 789     return -1;
 790 }
 791
 792 static void netlink_phase_hook(void *sst, uint32_t new_phase)
 793 {
 794     struct netlink *st=sst;
 795     struct netlink_client *c;
 796     int32_t i;
 797
 798     /* All the networks serviced by the various tunnels should now
 799      * have been registered.  We build a routing table by sorting the
 800      * clients by priority.  */
 801     st->routes=safe_malloc_ary(sizeof(*st->routes),st->n_clients,
 802                                "netlink_phase_hook");
 803     /* Fill the table */
 804     i=0;
 805     for (c=st->clients; c; c=c->next) {
 806         assert(i<INT_MAX);
 807         st->routes[i++]=c;
 808     }
 809     /* Sort the table in descending order of priority */
 810     qsort(st->routes,st->n_clients,sizeof(*st->routes),
 811           netlink_compare_client_priority);
 812
 813     netlink_dump_routes(st,False);
 814 }
 815
 816 static void netlink_signal_handler(void *sst, int signum)
 817 {
 818     struct netlink *st=sst;
 819     Message(M_INFO,"%s: route dump requested by SIGUSR1\n",st->name);
 820     netlink_dump_routes(st,True);
 821 }
 822
 823 static void netlink_inst_set_mtu(void *sst, int32_t new_mtu)
 824 {
 825     struct netlink_client *c=sst;
 826
 827     c->mtu=new_mtu;
 828 }
 829
 830 static void netlink_inst_reg(void *sst, netlink_deliver_fn *deliver,
 831                              void *dst)
 832 {
 833     struct netlink_client *c=sst;
 834
 835     c->deliver=deliver;
 836     c->dst=dst;
 837 }
 838
 839 static struct flagstr netlink_option_table[]={
 840     { "soft", OPT_SOFTROUTE },
 841     { "allow-route", OPT_ALLOWROUTE },
 842     { NULL, 0}
 843 };
 844 /* This is the routine that gets called when the closure that's
 845    returned by an invocation of a netlink device closure (eg. tun,
 846    userv-ipif) is invoked.  It's used to create routes and pass in
 847    information about them; the closure it returns is used by site
 848    code.  */
 849 static closure_t *netlink_inst_create(struct netlink *st,
 850                                       struct cloc loc, dict_t *dict)
 851 {
 852     struct netlink_client *c;
 853     string_t name;
 854     struct ipset *networks;
 855     uint32_t options,priority;
 856     int32_t mtu;
 857     list_t *l;
 858
 859     name=dict_read_string(dict, "name", True, st->name, loc);
 860
 861     l=dict_lookup(dict,"routes");
 862     if (!l)
 863         cfgfatal(loc,st->name,"required parameter \"routes\" not found\n");
 864     networks=string_list_to_ipset(l,loc,st->name,"routes");
 865     options=string_list_to_word(dict_lookup(dict,"options"),
 866                                 netlink_option_table,st->name);
 867
 868     priority=dict_read_number(dict,"priority",False,st->name,loc,0);
 869     mtu=dict_read_number(dict,"mtu",False,st->name,loc,0);
 870
 871     if ((options&OPT_SOFTROUTE) && !st->set_routes) {
 872         cfgfatal(loc,st->name,"this netlink device does not support "
 873                  "soft routes.\n");
 874         return NULL;
 875     }
 876
 877     if (options&OPT_SOFTROUTE) {
 878         /* XXX for now we assume that soft routes require root privilege;
 879            this may not always be true. The device driver can tell us. */
 880         require_root_privileges=True;
 881         require_root_privileges_explanation="netlink: soft routes";
 882         if (st->ptp) {
 883             cfgfatal(loc,st->name,"point-to-point netlinks do not support "
 884                      "soft routes.\n");
 885             return NULL;
 886         }
 887     }
 888
 889     /* Check that nets are a subset of st->remote_networks;
 890        refuse to register if they are not. */
 891     if (!ipset_is_subset(st->remote_networks,networks)) {
 892         cfgfatal(loc,st->name,"routes are not allowed\n");
 893         return NULL;
 894     }
 895
 896     c=safe_malloc(sizeof(*c),"netlink_inst_create");
 897     c->cl.description=name;
 898     c->cl.type=CL_NETLINK;
 899     c->cl.apply=NULL;
 900     c->cl.interface=&c->ops;
 901     c->ops.st=c;
 902     c->ops.reg=netlink_inst_reg;
 903     c->ops.deliver=netlink_inst_incoming;
 904     c->ops.set_quality=netlink_set_quality;
 905     c->ops.set_mtu=netlink_inst_set_mtu;
 906     c->nst=st;
 907
 908     c->networks=networks;
 909     c->subnets=ipset_to_subnet_list(networks);
 910     c->priority=priority;
 911     c->deliver=NULL;
 912     c->dst=NULL;
 913     c->name=name;
 914     c->link_quality=LINK_QUALITY_UNUSED;
 915     c->mtu=mtu?mtu:st->mtu;
 916     c->options=options;
 917     c->outcount=0;
 918     c->up=False;
 919     c->kup=False;
 920     c->next=st->clients;
 921     st->clients=c;
 922     assert(st->n_clients < INT_MAX);
 923     st->n_clients++;
 924
 925     return &c->cl;
 926 }
 927
 928 static list_t *netlink_inst_apply(closure_t *self, struct cloc loc,
 929                                   dict_t *context, list_t *args)
 930 {
 931     struct netlink *st=self->interface;
 932
 933     dict_t *dict;
 934     item_t *item;
 935     closure_t *cl;
 936
 937     item=list_elem(args,0);
 938     if (!item || item->type!=t_dict) {
 939         cfgfatal(loc,st->name,"must have a dictionary argument\n");
 940     }
 941     dict=item->data.dict;
 942
 943     cl=netlink_inst_create(st,loc,dict);
 944
 945     return new_closure(cl);
 946 }
 947
 948 netlink_deliver_fn *netlink_init(struct netlink *st,
 949                                  void *dst, struct cloc loc,
 950                                  dict_t *dict, cstring_t description,
 951                                  netlink_route_fn *set_routes,
 952                                  netlink_deliver_fn *to_host)
 953 {
 954     item_t *sa, *ptpa;
 955     list_t *l;
 956
 957     st->dst=dst;
 958     st->cl.description=description;
 959     st->cl.type=CL_PURE;
 960     st->cl.apply=netlink_inst_apply;
 961     st->cl.interface=st;
 962     st->clients=NULL;
 963     st->routes=NULL;
 964     st->n_clients=0;
 965     st->set_routes=set_routes;
 966     st->deliver_to_host=to_host;
 967
 968     st->name=dict_read_string(dict,"name",False,description,loc);
 969     if (!st->name) st->name=description;
 970     l=dict_lookup(dict,"networks");
 971     if (l)
 972         st->networks=string_list_to_ipset(l,loc,st->name,"networks");
 973     else {
 974         struct ipset *empty;
 975         empty=ipset_new();
 976         st->networks=ipset_complement(empty);
 977         ipset_free(empty);
 978     }
 979     l=dict_lookup(dict,"remote-networks");
 980     if (l) {
 981         st->remote_networks=string_list_to_ipset(l,loc,st->name,
 982                                                  "remote-networks");
 983     } else {
 984         struct ipset *empty;
 985         empty=ipset_new();
 986         st->remote_networks=ipset_complement(empty);
 987         ipset_free(empty);
 988     }
 989
 990     sa=dict_find_item(dict,"secnet-address",False,"netlink",loc);
 991     ptpa=dict_find_item(dict,"ptp-address",False,"netlink",loc);
 992     if (sa && ptpa) {
 993         cfgfatal(loc,st->name,"you may not specify secnet-address and "
 994                  "ptp-address in the same netlink device\n");
 995     }
 996     if (!(sa || ptpa)) {
 997         cfgfatal(loc,st->name,"you must specify secnet-address or "
 998                  "ptp-address for this netlink device\n");
 999     }
1000     if (sa) {
1001         st->secnet_address=string_item_to_ipaddr(sa,"netlink");
1002         st->ptp=False;
1003     } else {
1004         st->secnet_address=string_item_to_ipaddr(ptpa,"netlink");
1005         st->ptp=True;
1006     }
1007     /* To be strictly correct we could subtract secnet_address from
1008        networks here.  It shouldn't make any practical difference,
1009        though, and will make the route dump look complicated... */
1010     st->subnets=ipset_to_subnet_list(st->networks);
1011     st->mtu=dict_read_number(dict, "mtu", False, "netlink", loc, DEFAULT_MTU);
1012     buffer_new(&st->icmp,ICMP_BUFSIZE);
1013     st->outcount=0;
1014     st->localcount=0;
1015
1016     add_hook(PHASE_SETUP,netlink_phase_hook,st);
1017     request_signal_notification(SIGUSR1, netlink_signal_handler, st);
1018
1019     /* If we're point-to-point then we return a CL_NETLINK directly,
1020        rather than a CL_NETLINK_OLD or pure closure (depending on
1021        compatibility).  This CL_NETLINK is for our one and only
1022        client.  Our cl.apply function is NULL. */
1023     if (st->ptp) {
1024         closure_t *cl;
1025         cl=netlink_inst_create(st,loc,dict);
1026         st->cl=*cl;
1027     }
1028     return netlink_dev_incoming;
1029 }
1030
1031 /* No connection to the kernel at all... */
1032
1033 struct null {
1034     struct netlink nl;
1035 };
1036
1037 static bool_t null_set_route(void *sst, struct netlink_client *routes)
1038 {
1039     struct null *st=sst;
1040
1041     if (routes->up!=routes->kup) {
1042         Message(M_INFO,"%s: setting routes for tunnel %s to state %s\n",
1043                 st->nl.name,routes->name,
1044                 routes->up?"up":"down");
1045         routes->kup=routes->up;
1046         return True;
1047     }
1048     return False;
1049 }
1050
1051 static void null_deliver(void *sst, struct buffer_if *buf)
1052 {
1053     return;
1054 }
1055
1056 static list_t *null_apply(closure_t *self, struct cloc loc, dict_t *context,
1057                           list_t *args)
1058 {
1059     struct null *st;
1060     item_t *item;
1061     dict_t *dict;
1062
1063     st=safe_malloc(sizeof(*st),"null_apply");
1064
1065     item=list_elem(args,0);
1066     if (!item || item->type!=t_dict)
1067         cfgfatal(loc,"null-netlink","parameter must be a dictionary\n");
1068
1069     dict=item->data.dict;
1070
1071     netlink_init(&st->nl,st,loc,dict,"null-netlink",null_set_route,
1072                  null_deliver);
1073
1074     return new_closure(&st->nl.cl);
1075 }
1076
1077 void netlink_module(dict_t *dict)
1078 {
1079     add_closure(dict,"null-netlink",null_apply);
1080 }