chiark / gitweb /
55eef5c8da38ce6139dc60e9e3d6d746f5919050
[secnet.git] / 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 #ifdef NETLINK_DEBUG
110 #define MDEBUG(...) Message(M_DEBUG, __VA_ARGS__)
111 #else /* !NETLINK_DEBUG */
112 #define MDEBUG(...) ((void)0)
113 #endif /* !NETLINK_DEBUG */
114
115 #define ICMP_TYPE_ECHO_REPLY             0
116
117 #define ICMP_TYPE_UNREACHABLE            3
118 #define ICMP_CODE_NET_UNREACHABLE        0
119 #define ICMP_CODE_PROTOCOL_UNREACHABLE   2
120 #define ICMP_CODE_FRAGMENTATION_REQUIRED 4
121 #define ICMP_CODE_NET_PROHIBITED        13
122
123 #define ICMP_TYPE_ECHO_REQUEST           8
124
125 #define ICMP_TYPE_TIME_EXCEEDED         11
126 #define ICMP_CODE_TTL_EXCEEDED           0
127
128 /* Generic IP checksum routine */
129 static inline uint16_t ip_csum(const uint8_t *iph,int32_t count)
130 {
131     register uint32_t sum=0;
132
133     while (count>1) {
134         sum+=ntohs(*(uint16_t *)iph);
135         iph+=2;
136         count-=2;
137     }
138     if(count>0)
139         sum+=*(uint8_t *)iph;
140     while (sum>>16)
141         sum=(sum&0xffff)+(sum>>16);
142     return htons(~sum);
143 }
144
145 #ifdef i386
146 /*
147  *      This is a version of ip_compute_csum() optimized for IP headers,
148  *      which always checksum on 4 octet boundaries.
149  *
150  *      By Jorge Cwik <jorge@laser.satlink.net>, adapted for linux by
151  *      Arnt Gulbrandsen.
152  */
153 static inline uint16_t ip_fast_csum(const uint8_t *iph, int32_t ihl) {
154     uint32_t sum;
155
156     __asm__ __volatile__(
157             "movl (%1), %0      ;\n"
158             "subl $4, %2        ;\n"
159             "jbe 2f             ;\n"
160             "addl 4(%1), %0     ;\n"
161             "adcl 8(%1), %0     ;\n"
162             "adcl 12(%1), %0    ;\n"
163 "1:         adcl 16(%1), %0     ;\n"
164             "lea 4(%1), %1      ;\n"
165             "decl %2            ;\n"
166             "jne 1b             ;\n"
167             "adcl $0, %0        ;\n"
168             "movl %0, %2        ;\n"
169             "shrl $16, %0       ;\n"
170             "addw %w2, %w0      ;\n"
171             "adcl $0, %0        ;\n"
172             "notl %0            ;\n"
173 "2:                             ;\n"
174         /* Since the input registers which are loaded with iph and ipl
175            are modified, we must also specify them as outputs, or gcc
176            will assume they contain their original values. */
177         : "=r" (sum), "=r" (iph), "=r" (ihl)
178         : "1" (iph), "2" (ihl)
179         : "memory");
180     return sum;
181 }
182 #else
183 static inline uint16_t ip_fast_csum(uint8_t *iph, int32_t ihl)
184 {
185     assert(ihl < INT_MAX/4);
186     return ip_csum(iph,ihl*4);
187 }
188 #endif
189
190 struct iphdr {
191 #if defined (WORDS_BIGENDIAN)
192     uint8_t    version:4,
193                ihl:4;
194 #else
195     uint8_t    ihl:4,
196                version:4;
197 #endif
198     uint8_t    tos;
199     uint16_t   tot_len;
200     uint16_t   id;
201     uint16_t   frag;
202 #define IPHDR_FRAG_OFF  ((uint16_t)0x1fff)
203 #define IPHDR_FRAG_MORE ((uint16_t)0x2000)
204 #define IPHDR_FRAG_DONT ((uint16_t)0x4000)
205 /*                 reserved        0x8000 */
206     uint8_t    ttl;
207     uint8_t    protocol;
208     uint16_t   check;
209     uint32_t   saddr;
210     uint32_t   daddr;
211     /* The options start here. */
212 };
213
214 struct icmphdr {
215     struct iphdr iph;
216     uint8_t type;
217     uint8_t code;
218     uint16_t check;
219     union icmpinfofield {
220         uint32_t unused;
221         struct {
222             uint8_t pointer;
223             uint8_t unused1;
224             uint16_t unused2;
225         } pprob;
226         uint32_t gwaddr;
227         struct {
228             uint16_t id;
229             uint16_t seq;
230         } echo;
231         struct {
232             uint16_t unused;
233             uint16_t mtu;
234         } fragneeded;
235     } d;
236 };
237
238 static const union icmpinfofield icmp_noinfo;
239     
240 static void netlink_packet_deliver(struct netlink *st,
241                                    struct netlink_client *client,
242                                    struct buffer_if *buf);
243
244 /* XXX RFC1812 4.3.2.5:
245    All other ICMP error messages (Destination Unreachable,
246    Redirect, Time Exceeded, and Parameter Problem) SHOULD have their
247    precedence value set to 6 (INTERNETWORK CONTROL) or 7 (NETWORK
248    CONTROL).  The IP Precedence value for these error messages MAY be
249    settable.
250    */
251 static struct icmphdr *netlink_icmp_tmpl(struct netlink *st,
252                                          uint32_t dest,uint16_t len)
253 {
254     struct icmphdr *h;
255
256     BUF_ALLOC(&st->icmp,"netlink_icmp_tmpl");
257     buffer_init(&st->icmp,calculate_max_start_pad());
258     h=buf_append(&st->icmp,sizeof(*h));
259
260     h->iph.version=4;
261     h->iph.ihl=5;
262     h->iph.tos=0;
263     h->iph.tot_len=htons(len+(h->iph.ihl*4)+8);
264     h->iph.id=0;
265     h->iph.frag=0;
266     h->iph.ttl=255; /* XXX should be configurable */
267     h->iph.protocol=1;
268     h->iph.saddr=htonl(st->secnet_address);
269     h->iph.daddr=htonl(dest);
270     h->iph.check=0;
271     h->iph.check=ip_fast_csum((uint8_t *)&h->iph,h->iph.ihl);
272     h->check=0;
273     h->d.unused=0;
274
275     return h;
276 }
277
278 /* Fill in the ICMP checksum field correctly */
279 static void netlink_icmp_csum(struct icmphdr *h)
280 {
281     int32_t len;
282
283     len=ntohs(h->iph.tot_len)-(4*h->iph.ihl);
284     h->check=0;
285     h->check=ip_csum(&h->type,len);
286 }
287
288 /* RFC1122:
289  *       An ICMP error message MUST NOT be sent as the result of
290  *       receiving:
291  *
292  *       *    an ICMP error message, or
293  *
294  *       *    a datagram destined to an IP broadcast or IP multicast
295  *            address, or
296  *
297  *       *    a datagram sent as a link-layer broadcast, or
298  *
299  *       *    a non-initial fragment, or
300  *
301  *       *    a datagram whose source address does not define a single
302  *            host -- e.g., a zero address, a loopback address, a
303  *            broadcast address, a multicast address, or a Class E
304  *            address.
305  */
306 static bool_t netlink_icmp_may_reply(struct buffer_if *buf)
307 {
308     struct iphdr *iph;
309     struct icmphdr *icmph;
310     uint32_t source;
311
312     if (buf->size < (int)sizeof(struct icmphdr)) return False;
313     iph=(struct iphdr *)buf->start;
314     icmph=(struct icmphdr *)buf->start;
315     if (iph->protocol==1) {
316         switch(icmph->type) {
317             /* Based on http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml#icmp-parameters-types
318              * as retrieved Thu, 20 Mar 2014 00:16:44 +0000.
319              * Deprecated, reserved, unassigned and experimental
320              * options are treated as not safe to reply to.
321              */
322         case 0: /* Echo Reply */
323         case 8: /* Echo */
324         case 13: /* Timestamp */
325         case 14: /* Timestamp Reply */
326             return True;
327         default:
328             return False;
329         }
330     }
331     /* How do we spot broadcast destination addresses? */
332     if (ntohs(iph->frag)&IPHDR_FRAG_OFF) return False;
333     source=ntohl(iph->saddr);
334     if (source==0) return False;
335     if ((source&0xff000000)==0x7f000000) return False;
336     /* How do we spot broadcast source addresses? */
337     if ((source&0xf0000000)==0xe0000000) return False; /* Multicast */
338     if ((source&0xf0000000)==0xf0000000) return False; /* Class E */
339     return True;
340 }
341
342 /* How much of the original IP packet do we include in its ICMP
343    response? The header plus up to 64 bits. */
344
345 /* XXX TODO RFC1812:
346 4.3.2.3 Original Message Header
347
348    Historically, every ICMP error message has included the Internet
349    header and at least the first 8 data bytes of the datagram that
350    triggered the error.  This is no longer adequate, due to the use of
351    IP-in-IP tunneling and other technologies.  Therefore, the ICMP
352    datagram SHOULD contain as much of the original datagram as possible
353    without the length of the ICMP datagram exceeding 576 bytes.  The
354    returned IP header (and user data) MUST be identical to that which
355    was received, except that the router is not required to undo any
356    modifications to the IP header that are normally performed in
357    forwarding that were performed before the error was detected (e.g.,
358    decrementing the TTL, or updating options).  Note that the
359    requirements of Section [4.3.3.5] supersede this requirement in some
360    cases (i.e., for a Parameter Problem message, if the problem is in a
361    modified field, the router must undo the modification).  See Section
362    [4.3.3.5]).
363    */
364 static uint16_t netlink_icmp_reply_len(struct buffer_if *buf)
365 {
366     if (buf->size < (int)sizeof(struct iphdr)) return 0;
367     struct iphdr *iph=(struct iphdr *)buf->start;
368     uint16_t hlen,plen;
369
370     hlen=iph->ihl*4;
371     /* We include the first 8 bytes of the packet data, provided they exist */
372     hlen+=8;
373     plen=ntohs(iph->tot_len);
374     return (hlen>plen?plen:hlen);
375 }
376
377 /* client indicates where the packet we're constructing a response to
378    comes from. NULL indicates the host. */
379 static void netlink_icmp_simple(struct netlink *st, struct buffer_if *buf,
380                                 uint8_t type, uint8_t code,
381                                 union icmpinfofield info)
382 {
383     struct icmphdr *h;
384     uint16_t len;
385
386     if (netlink_icmp_may_reply(buf)) {
387         struct iphdr *iph=(struct iphdr *)buf->start;
388         len=netlink_icmp_reply_len(buf);
389         h=netlink_icmp_tmpl(st,ntohl(iph->saddr),len);
390         h->type=type; h->code=code; h->d=info;
391         memcpy(buf_append(&st->icmp,len),buf->start,len);
392         netlink_icmp_csum(h);
393         netlink_packet_deliver(st,NULL,&st->icmp);
394         BUF_ASSERT_FREE(&st->icmp);
395     }
396 }
397
398 /*
399  * RFC1122: 3.1.2.2 MUST silently discard any IP frame that fails the
400  * checksum.
401  * RFC1812: 4.2.2.5 MUST discard messages containing invalid checksums.
402  *
403  * Is the datagram acceptable?
404  *
405  * 1. Length at least the size of an ip header
406  * 2. Version of 4
407  * 3. Checksums correctly.
408  * 4. Doesn't have a bogus length
409  */
410 static bool_t netlink_check(struct netlink *st, struct buffer_if *buf,
411                             char *errmsgbuf, int errmsgbuflen)
412 {
413 #define BAD(...) do{                                    \
414         snprintf(errmsgbuf,errmsgbuflen,__VA_ARGS__);   \
415         return False;                                   \
416     }while(0)
417
418     if (buf->size < (int)sizeof(struct iphdr)) BAD("len %"PRIu32"",buf->size);
419     struct iphdr *iph=(struct iphdr *)buf->start;
420     int32_t len;
421
422     if (iph->ihl < 5) BAD("ihl %u",iph->ihl);
423     if (iph->version != 4) BAD("version %u",iph->version);
424     if (buf->size < iph->ihl*4) BAD("size %"PRId32"<%u*4",buf->size,iph->ihl);
425     if (ip_fast_csum((uint8_t *)iph, iph->ihl)!=0) BAD("csum");
426     len=ntohs(iph->tot_len);
427     /* There should be no padding */
428     if (buf->size!=len) BAD("len %"PRId32"!=%"PRId32,buf->size,len);
429     if (len<(iph->ihl<<2)) BAD("len %"PRId32"<(%u<<2)",len,iph->ihl);
430     /* XXX check that there's no source route specified */
431     return True;
432
433 #undef BAD
434 }
435
436 static const char *fragment_filter_header(uint8_t *base, long *hlp)
437 {
438     const int fixedhl = sizeof(struct iphdr);
439     long hl = *hlp;
440     const uint8_t *ipend = base + hl;
441     uint8_t *op = base + fixedhl;
442     const uint8_t *ip = op;
443
444     while (ip < ipend) {
445         uint8_t opt = ip[0];
446         int remain = ipend - ip;
447         if (opt == 0x00) /* End of Options List */ break;
448         if (opt == 0x01) /* No Operation */ continue;
449         if (remain < 2) return "IPv4 options truncated at length";
450         int optlen = ip[1];
451         if (remain < optlen) return "IPv4 options truncated in option";
452         if (opt & 0x80) /* copy */ {
453             memmove(op, ip, optlen);
454             op += optlen;
455         }
456         ip += optlen;
457     }
458     while ((hl = (op - base)) & 0x3)
459         *op++ = 0x00 /* End of Option List */;
460     ((struct iphdr*)base)->ihl = hl >> 2;
461     *hlp = hl;
462
463     return 0;
464 }
465
466 /* Fragment or send ICMP Fragmentation Needed */
467 static void netlink_maybe_fragment(struct netlink *st,
468                                    netlink_deliver_fn *deliver,
469                                    void *deliver_dst,
470                                    const char *delivery_name,
471                                    int32_t mtu,
472                                    uint32_t source, uint32_t dest,
473                                    struct buffer_if *buf)
474 {
475     struct iphdr *iph=(struct iphdr*)buf->start;
476     long hl = iph->ihl*4;
477     const char *ssource = ipaddr_to_string(source);
478
479     if (buf->size <= mtu) {
480         deliver(deliver_dst, buf);
481         return;
482     }
483
484     MDEBUG("%s: fragmenting %s->%s org.size=%"PRId32"\n",
485            st->name, ssource, delivery_name, buf->size);
486
487 #define BADFRAG(m, ...)                                 \
488         Message(M_WARNING,                              \
489                 "%s: fragmenting packet from source %s" \
490                 " for transmission via %s: " m "\n",    \
491                 st->name, ssource, delivery_name,       \
492                 ## __VA_ARGS__);
493
494     unsigned orig_frag = ntohs(iph->frag);
495
496     if (orig_frag&IPHDR_FRAG_DONT) {
497         union icmpinfofield info =
498             { .fragneeded = { .unused = 0, .mtu = htons(mtu) } };
499         netlink_icmp_simple(st,buf,
500                             ICMP_TYPE_UNREACHABLE,
501                             ICMP_CODE_FRAGMENTATION_REQUIRED,
502                             info);
503         BUF_FREE(buf);
504         return;
505     }
506     if (mtu < hl + 8) {
507         BADFRAG("mtu %"PRId32" too small", mtu);
508         BUF_FREE(buf);
509         return;
510     }
511
512     /* we (ab)use the icmp buffer to stash the original packet */
513     struct buffer_if *orig = &st->icmp;
514     BUF_ALLOC(orig,"netlink_client_deliver fragment orig");
515     buffer_copy(orig,buf);
516     BUF_FREE(buf);
517
518     const uint8_t *startindata = orig->start + hl;
519     const uint8_t *indata =      startindata;
520     const uint8_t *endindata =   orig->start + orig->size;
521     _Bool filtered = 0;
522
523     for (;;) {
524         /* compute our fragment offset */
525         long dataoffset = indata - startindata
526             + (orig_frag & IPHDR_FRAG_OFF)*8;
527         assert(!(dataoffset & 7));
528         if (dataoffset > IPHDR_FRAG_OFF*8) {
529             BADFRAG("ultimate fragment offset out of range");
530             break;
531         }
532
533         BUF_ALLOC(buf,"netlink_client_deliver fragment frag");
534         buffer_init(buf,calculate_max_start_pad());
535
536         /* copy header (possibly filtered); will adjust in a bit */
537         struct iphdr *fragh = buf_append(buf, hl);
538         memcpy(fragh, orig->start, hl);
539
540         /* decide how much payload to copy and copy it */
541         long avail = mtu - hl;
542         long remain = endindata - indata;
543         long use = avail < remain ? (avail & ~(long)7) : remain;
544         memcpy(buf_append(buf, use), indata, use);
545         indata += use;
546
547         _Bool last_frag = indata >= endindata;
548
549         /* adjust the header */
550         fragh->tot_len = htons(buf->size);
551         fragh->frag =
552             htons((orig_frag & ~IPHDR_FRAG_OFF) |
553                   (last_frag ? 0 : IPHDR_FRAG_MORE) |
554                   (dataoffset >> 3));
555         fragh->check = 0;
556         fragh->check = ip_fast_csum((const void*)fragh, fragh->ihl);
557
558         /* actually send it */
559         deliver(deliver_dst, buf);
560         if (last_frag)
561             break;
562
563         /* after copying the header for the first frag,
564          * we filter the header for the remaining frags */
565         if (!filtered++) {
566             const char *bad = fragment_filter_header(orig->start, &hl);
567             if (bad) { BADFRAG("%s", bad); break; }
568         }
569     }
570
571     BUF_FREE(orig);
572
573 #undef BADFRAG
574 }
575
576 /* Deliver a packet _to_ client; used after we have decided
577  * what to do with it (and just to check that the client has
578  * actually registered a delivery function with us). */
579 static void netlink_client_deliver(struct netlink *st,
580                                    struct netlink_client *client,
581                                    uint32_t source, uint32_t dest,
582                                    struct buffer_if *buf)
583 {
584     if (!client->deliver) {
585         string_t s,d;
586         s=ipaddr_to_string(source);
587         d=ipaddr_to_string(dest);
588         Message(M_ERR,"%s: dropping %s->%s, client not registered\n",
589                 st->name,s,d);
590         free(s); free(d);
591         BUF_FREE(buf);
592         return;
593     }
594     netlink_maybe_fragment(st, client->deliver,client->dst,client->name,
595                            client->mtu, source,dest,buf);
596     client->outcount++;
597 }
598
599 /* Deliver a packet to the host; used after we have decided that that
600  * is what to do with it. */
601 static void netlink_host_deliver(struct netlink *st,
602                                  uint32_t source, uint32_t dest,
603                                  struct buffer_if *buf)
604 {
605     netlink_maybe_fragment(st, st->deliver_to_host,st->dst,"(host)",
606                            st->mtu, source,dest,buf);
607     st->outcount++;
608 }
609
610 /* Deliver a packet. "client" is the _origin_ of the packet, not its
611    destination, and is NULL for packets from the host and packets
612    generated internally in secnet.  */
613 static void netlink_packet_deliver(struct netlink *st,
614                                    struct netlink_client *client,
615                                    struct buffer_if *buf)
616 {
617     if (buf->size < (int)sizeof(struct iphdr)) {
618         Message(M_ERR,"%s: trying to deliver a too-short packet"
619                 " from %s!\n",st->name, client?client->name:"(local)");
620         BUF_FREE(buf);
621         return;
622     }
623
624     struct iphdr *iph=(struct iphdr *)buf->start;
625     uint32_t dest=ntohl(iph->daddr);
626     uint32_t source=ntohl(iph->saddr);
627     uint32_t best_quality;
628     bool_t allow_route=False;
629     bool_t found_allowed=False;
630     int best_match;
631     int i;
632
633     BUF_ASSERT_USED(buf);
634
635     if (dest==st->secnet_address) {
636         Message(M_ERR,"%s: trying to deliver a packet to myself!\n",st->name);
637         BUF_FREE(buf);
638         return;
639     }
640     
641     /* Packets from the host (client==NULL) may always be routed.  Packets
642        from clients with the allow_route option will also be routed. */
643     if (!client || (client && (client->options & OPT_ALLOWROUTE)))
644         allow_route=True;
645
646     /* If !allow_route, we check the routing table anyway, and if
647        there's a suitable route with OPT_ALLOWROUTE set we use it.  If
648        there's a suitable route, but none with OPT_ALLOWROUTE set then
649        we generate ICMP 'communication with destination network
650        administratively prohibited'. */
651
652     best_quality=0;
653     best_match=-1;
654     for (i=0; i<st->n_clients; i++) {
655         if (st->routes[i]->up &&
656             ipset_contains_addr(st->routes[i]->networks,dest)) {
657             /* It's an available route to the correct destination. But is
658                it better than the one we already have? */
659
660             /* If we have already found an allowed route then we don't
661                bother looking at routes we're not allowed to use.  If
662                we don't yet have an allowed route we'll consider any.  */
663             if (!allow_route && found_allowed) {
664                 if (!(st->routes[i]->options&OPT_ALLOWROUTE)) continue;
665             }
666             
667             if (st->routes[i]->link_quality>best_quality
668                 || best_quality==0) {
669                 best_quality=st->routes[i]->link_quality;
670                 best_match=i;
671                 if (st->routes[i]->options&OPT_ALLOWROUTE)
672                     found_allowed=True;
673                 /* If quality isn't perfect we may wish to
674                    consider kicking the tunnel with a 0-length
675                    packet to prompt it to perform a key setup.
676                    Then it'll eventually decide it's up or
677                    down. */
678                 /* If quality is perfect and we're allowed to use the
679                    route we don't need to search any more. */
680                 if (best_quality>=MAXIMUM_LINK_QUALITY && 
681                     (allow_route || found_allowed)) break;
682             }
683         }
684     }
685     if (best_match==-1) {
686         /* The packet's not going down a tunnel.  It might (ought to)
687            be for the host.   */
688         if (ipset_contains_addr(st->networks,dest)) {
689             netlink_host_deliver(st,source,dest,buf);
690             BUF_ASSERT_FREE(buf);
691         } else {
692             string_t s,d;
693             s=ipaddr_to_string(source);
694             d=ipaddr_to_string(dest);
695             Message(M_DEBUG,"%s: don't know where to deliver packet "
696                     "(s=%s, d=%s)\n", st->name, s, d);
697             free(s); free(d);
698             netlink_icmp_simple(st,buf,ICMP_TYPE_UNREACHABLE,
699                                 ICMP_CODE_NET_UNREACHABLE, icmp_noinfo);
700             BUF_FREE(buf);
701         }
702     } else {
703         if (!allow_route &&
704             !(st->routes[best_match]->options&OPT_ALLOWROUTE)) {
705             string_t s,d;
706             s=ipaddr_to_string(source);
707             d=ipaddr_to_string(dest);
708             /* We have a usable route but aren't allowed to use it.
709                Generate ICMP destination unreachable: communication
710                with destination network administratively prohibited */
711             Message(M_NOTICE,"%s: denied forwarding for packet (s=%s, d=%s)\n",
712                     st->name,s,d);
713             free(s); free(d);
714                     
715             netlink_icmp_simple(st,buf,ICMP_TYPE_UNREACHABLE,
716                                 ICMP_CODE_NET_PROHIBITED, icmp_noinfo);
717             BUF_FREE(buf);
718         } else {
719             if (best_quality>0) {
720                 netlink_client_deliver(st,st->routes[best_match],
721                                        source,dest,buf);
722                 BUF_ASSERT_FREE(buf);
723             } else {
724                 /* Generate ICMP destination unreachable */
725                 netlink_icmp_simple(st,buf,
726                                     ICMP_TYPE_UNREACHABLE,
727                                     ICMP_CODE_NET_UNREACHABLE,
728                                     icmp_noinfo);
729                 BUF_FREE(buf);
730             }
731         }
732     }
733     BUF_ASSERT_FREE(buf);
734 }
735
736 static void netlink_packet_forward(struct netlink *st, 
737                                    struct netlink_client *client,
738                                    struct buffer_if *buf)
739 {
740     if (buf->size < (int)sizeof(struct iphdr)) return;
741     struct iphdr *iph=(struct iphdr *)buf->start;
742     
743     BUF_ASSERT_USED(buf);
744
745     /* Packet has already been checked */
746     if (iph->ttl<=1) {
747         /* Generate ICMP time exceeded */
748         netlink_icmp_simple(st,buf,ICMP_TYPE_TIME_EXCEEDED,
749                             ICMP_CODE_TTL_EXCEEDED,icmp_noinfo);
750         BUF_FREE(buf);
751         return;
752     }
753     iph->ttl--;
754     iph->check=0;
755     iph->check=ip_fast_csum((uint8_t *)iph,iph->ihl);
756
757     netlink_packet_deliver(st,client,buf);
758     BUF_ASSERT_FREE(buf);
759 }
760
761 /* Deal with packets addressed explicitly to us */
762 static void netlink_packet_local(struct netlink *st,
763                                  struct netlink_client *client,
764                                  struct buffer_if *buf)
765 {
766     struct icmphdr *h;
767
768     st->localcount++;
769
770     if (buf->size < (int)sizeof(struct icmphdr)) {
771         Message(M_WARNING,"%s: short packet addressed to secnet; "
772                 "ignoring it\n",st->name);
773         BUF_FREE(buf);
774         return;
775     }
776     h=(struct icmphdr *)buf->start;
777
778     if ((ntohs(h->iph.frag)&(IPHDR_FRAG_OFF|IPHDR_FRAG_MORE))!=0) {
779         Message(M_WARNING,"%s: fragmented packet addressed to secnet; "
780                 "ignoring it\n",st->name);
781         BUF_FREE(buf);
782         return;
783     }
784
785     if (h->iph.protocol==1) {
786         /* It's ICMP */
787         if (h->type==ICMP_TYPE_ECHO_REQUEST && h->code==0) {
788             /* ICMP echo-request. Special case: we re-use the buffer
789                to construct the reply. */
790             h->type=ICMP_TYPE_ECHO_REPLY;
791             h->iph.daddr=h->iph.saddr;
792             h->iph.saddr=htonl(st->secnet_address);
793             h->iph.ttl=255;
794             h->iph.check=0;
795             h->iph.check=ip_fast_csum((uint8_t *)h,h->iph.ihl);
796             netlink_icmp_csum(h);
797             netlink_packet_deliver(st,NULL,buf);
798             return;
799         }
800         Message(M_WARNING,"%s: unknown incoming ICMP\n",st->name);
801     } else {
802         /* Send ICMP protocol unreachable */
803         netlink_icmp_simple(st,buf,ICMP_TYPE_UNREACHABLE,
804                             ICMP_CODE_PROTOCOL_UNREACHABLE,icmp_noinfo);
805         BUF_FREE(buf);
806         return;
807     }
808
809     BUF_FREE(buf);
810 }
811
812 /* If cid==NULL packet is from host, otherwise cid specifies which tunnel 
813    it came from. */
814 static void netlink_incoming(struct netlink *st, struct netlink_client *client,
815                              struct buffer_if *buf)
816 {
817     uint32_t source,dest;
818     struct iphdr *iph;
819     char errmsgbuf[50];
820     const char *sourcedesc=client?client->name:"host";
821
822     BUF_ASSERT_USED(buf);
823
824     if (!netlink_check(st,buf,errmsgbuf,sizeof(errmsgbuf))) {
825         Message(M_WARNING,"%s: bad IP packet from %s: %s\n",
826                 st->name,sourcedesc,
827                 errmsgbuf);
828         BUF_FREE(buf);
829         return;
830     }
831     assert(buf->size >= (int)sizeof(struct icmphdr));
832     iph=(struct iphdr *)buf->start;
833
834     source=ntohl(iph->saddr);
835     dest=ntohl(iph->daddr);
836
837     /* Check source. If we don't like the source, there's no point
838        generating ICMP because we won't know how to get it to the
839        source of the packet. */
840     if (client) {
841         /* Check that the packet source is appropriate for the tunnel
842            it came down */
843         if (!ipset_contains_addr(client->networks,source)) {
844             string_t s,d;
845             s=ipaddr_to_string(source);
846             d=ipaddr_to_string(dest);
847             Message(M_WARNING,"%s: packet from tunnel %s with bad "
848                     "source address (s=%s,d=%s)\n",st->name,client->name,s,d);
849             free(s); free(d);
850             BUF_FREE(buf);
851             return;
852         }
853     } else {
854         /* Check that the packet originates in our configured local
855            network, and hasn't been forwarded from elsewhere or
856            generated with the wrong source address */
857         if (!ipset_contains_addr(st->networks,source)) {
858             string_t s,d;
859             s=ipaddr_to_string(source);
860             d=ipaddr_to_string(dest);
861             Message(M_WARNING,"%s: outgoing packet with bad source address "
862                     "(s=%s,d=%s)\n",st->name,s,d);
863             free(s); free(d);
864             BUF_FREE(buf);
865             return;
866         }
867     }
868
869     /* If this is a point-to-point device we don't examine the
870        destination address at all; we blindly send it down our
871        one-and-only registered tunnel, or to the host, depending on
872        where it came from.  It's up to external software to check
873        address validity and generate ICMP, etc. */
874     if (st->ptp) {
875         if (client) {
876             netlink_host_deliver(st,source,dest,buf);
877         } else {
878             netlink_client_deliver(st,st->clients,source,dest,buf);
879         }
880         BUF_ASSERT_FREE(buf);
881         return;
882     }
883
884     /* st->secnet_address needs checking before matching destination
885        addresses */
886     if (dest==st->secnet_address) {
887         netlink_packet_local(st,client,buf);
888         BUF_ASSERT_FREE(buf);
889         return;
890     }
891     netlink_packet_forward(st,client,buf);
892     BUF_ASSERT_FREE(buf);
893 }
894
895 static void netlink_inst_incoming(void *sst, struct buffer_if *buf)
896 {
897     struct netlink_client *c=sst;
898     struct netlink *st=c->nst;
899
900     netlink_incoming(st,c,buf);
901 }
902
903 static void netlink_dev_incoming(void *sst, struct buffer_if *buf)
904 {
905     struct netlink *st=sst;
906
907     netlink_incoming(st,NULL,buf);
908 }
909
910 static void netlink_set_quality(void *sst, uint32_t quality)
911 {
912     struct netlink_client *c=sst;
913     struct netlink *st=c->nst;
914
915     c->link_quality=quality;
916     c->up=(c->link_quality==LINK_QUALITY_DOWN)?False:True;
917     if (c->options&OPT_SOFTROUTE) {
918         st->set_routes(st->dst,c);
919     }
920 }
921
922 static void netlink_output_subnets(struct netlink *st, uint32_t loglevel,
923                                    struct subnet_list *snets)
924 {
925     int32_t i;
926     string_t net;
927
928     for (i=0; i<snets->entries; i++) {
929         net=subnet_to_string(snets->list[i]);
930         Message(loglevel,"%s ",net);
931         free(net);
932     }
933 }
934
935 static void netlink_dump_routes(struct netlink *st, bool_t requested)
936 {
937     int i;
938     string_t net;
939     uint32_t c=M_INFO;
940
941     if (requested) c=M_WARNING;
942     if (st->ptp) {
943         net=ipaddr_to_string(st->secnet_address);
944         Message(c,"%s: point-to-point (remote end is %s); routes: ",
945                 st->name, net);
946         free(net);
947         netlink_output_subnets(st,c,st->clients->subnets);
948         Message(c,"\n");
949     } else {
950         Message(c,"%s: routing table:\n",st->name);
951         for (i=0; i<st->n_clients; i++) {
952             netlink_output_subnets(st,c,st->routes[i]->subnets);
953             Message(c,"-> tunnel %s (%s,mtu %d,%s routes,%s,"
954                     "quality %d,use %d,pri %lu)\n",
955                     st->routes[i]->name,
956                     st->routes[i]->up?"up":"down",
957                     st->routes[i]->mtu,
958                     st->routes[i]->options&OPT_SOFTROUTE?"soft":"hard",
959                     st->routes[i]->options&OPT_ALLOWROUTE?"free":"restricted",
960                     st->routes[i]->link_quality,
961                     st->routes[i]->outcount,
962                     (unsigned long)st->routes[i]->priority);
963         }
964         net=ipaddr_to_string(st->secnet_address);
965         Message(c,"%s/32 -> netlink \"%s\" (use %d)\n",
966                 net,st->name,st->localcount);
967         free(net);
968         for (i=0; i<st->subnets->entries; i++) {
969             net=subnet_to_string(st->subnets->list[i]);
970             Message(c,"%s ",net);
971             free(net);
972         }
973         if (i>0)
974             Message(c,"-> host (use %d)\n",st->outcount);
975     }
976 }
977
978 /* ap is a pointer to a member of the routes array */
979 static int netlink_compare_client_priority(const void *ap, const void *bp)
980 {
981     const struct netlink_client *const*a=ap;
982     const struct netlink_client *const*b=bp;
983
984     if ((*a)->priority==(*b)->priority) return 0;
985     if ((*a)->priority<(*b)->priority) return 1;
986     return -1;
987 }
988
989 static void netlink_phase_hook(void *sst, uint32_t new_phase)
990 {
991     struct netlink *st=sst;
992     struct netlink_client *c;
993     int32_t i;
994
995     /* All the networks serviced by the various tunnels should now
996      * have been registered.  We build a routing table by sorting the
997      * clients by priority.  */
998     st->routes=safe_malloc_ary(sizeof(*st->routes),st->n_clients,
999                                "netlink_phase_hook");
1000     /* Fill the table */
1001     i=0;
1002     for (c=st->clients; c; c=c->next) {
1003         assert(i<INT_MAX);
1004         st->routes[i++]=c;
1005     }
1006     /* Sort the table in descending order of priority */
1007     qsort(st->routes,st->n_clients,sizeof(*st->routes),
1008           netlink_compare_client_priority);
1009
1010     netlink_dump_routes(st,False);
1011 }
1012
1013 static void netlink_signal_handler(void *sst, int signum)
1014 {
1015     struct netlink *st=sst;
1016     Message(M_INFO,"%s: route dump requested by SIGUSR1\n",st->name);
1017     netlink_dump_routes(st,True);
1018 }
1019
1020 static void netlink_inst_set_mtu(void *sst, int32_t new_mtu)
1021 {
1022     struct netlink_client *c=sst;
1023
1024     c->mtu=new_mtu;
1025 }
1026
1027 static void netlink_inst_reg(void *sst, netlink_deliver_fn *deliver, 
1028                              void *dst)
1029 {
1030     struct netlink_client *c=sst;
1031
1032     c->deliver=deliver;
1033     c->dst=dst;
1034 }
1035
1036 static struct flagstr netlink_option_table[]={
1037     { "soft", OPT_SOFTROUTE },
1038     { "allow-route", OPT_ALLOWROUTE },
1039     { NULL, 0}
1040 };
1041 /* This is the routine that gets called when the closure that's
1042    returned by an invocation of a netlink device closure (eg. tun,
1043    userv-ipif) is invoked.  It's used to create routes and pass in
1044    information about them; the closure it returns is used by site
1045    code.  */
1046 static closure_t *netlink_inst_create(struct netlink *st,
1047                                       struct cloc loc, dict_t *dict)
1048 {
1049     struct netlink_client *c;
1050     string_t name;
1051     struct ipset *networks;
1052     uint32_t options,priority;
1053     int32_t mtu;
1054     list_t *l;
1055
1056     name=dict_read_string(dict, "name", True, st->name, loc);
1057
1058     l=dict_lookup(dict,"routes");
1059     if (!l)
1060         cfgfatal(loc,st->name,"required parameter \"routes\" not found\n");
1061     networks=string_list_to_ipset(l,loc,st->name,"routes");
1062     options=string_list_to_word(dict_lookup(dict,"options"),
1063                                 netlink_option_table,st->name);
1064
1065     priority=dict_read_number(dict,"priority",False,st->name,loc,0);
1066     mtu=dict_read_number(dict,"mtu",False,st->name,loc,0);
1067
1068     if ((options&OPT_SOFTROUTE) && !st->set_routes) {
1069         cfgfatal(loc,st->name,"this netlink device does not support "
1070                  "soft routes.\n");
1071         return NULL;
1072     }
1073
1074     if (options&OPT_SOFTROUTE) {
1075         /* XXX for now we assume that soft routes require root privilege;
1076            this may not always be true. The device driver can tell us. */
1077         require_root_privileges=True;
1078         require_root_privileges_explanation="netlink: soft routes";
1079         if (st->ptp) {
1080             cfgfatal(loc,st->name,"point-to-point netlinks do not support "
1081                      "soft routes.\n");
1082             return NULL;
1083         }
1084     }
1085
1086     /* Check that nets are a subset of st->remote_networks;
1087        refuse to register if they are not. */
1088     if (!ipset_is_subset(st->remote_networks,networks)) {
1089         cfgfatal(loc,st->name,"routes are not allowed\n");
1090         return NULL;
1091     }
1092
1093     c=safe_malloc(sizeof(*c),"netlink_inst_create");
1094     c->cl.description=name;
1095     c->cl.type=CL_NETLINK;
1096     c->cl.apply=NULL;
1097     c->cl.interface=&c->ops;
1098     c->ops.st=c;
1099     c->ops.reg=netlink_inst_reg;
1100     c->ops.deliver=netlink_inst_incoming;
1101     c->ops.set_quality=netlink_set_quality;
1102     c->ops.set_mtu=netlink_inst_set_mtu;
1103     c->nst=st;
1104
1105     c->networks=networks;
1106     c->subnets=ipset_to_subnet_list(networks);
1107     c->priority=priority;
1108     c->deliver=NULL;
1109     c->dst=NULL;
1110     c->name=name;
1111     c->link_quality=LINK_QUALITY_UNUSED;
1112     c->mtu=mtu?mtu:st->mtu;
1113     c->options=options;
1114     c->outcount=0;
1115     c->up=False;
1116     c->kup=False;
1117     c->next=st->clients;
1118     st->clients=c;
1119     assert(st->n_clients < INT_MAX);
1120     st->n_clients++;
1121
1122     return &c->cl;
1123 }
1124
1125 static list_t *netlink_inst_apply(closure_t *self, struct cloc loc,
1126                                   dict_t *context, list_t *args)
1127 {
1128     struct netlink *st=self->interface;
1129
1130     dict_t *dict;
1131     item_t *item;
1132     closure_t *cl;
1133
1134     item=list_elem(args,0);
1135     if (!item || item->type!=t_dict) {
1136         cfgfatal(loc,st->name,"must have a dictionary argument\n");
1137     }
1138     dict=item->data.dict;
1139
1140     cl=netlink_inst_create(st,loc,dict);
1141
1142     return new_closure(cl);
1143 }
1144
1145 netlink_deliver_fn *netlink_init(struct netlink *st,
1146                                  void *dst, struct cloc loc,
1147                                  dict_t *dict, cstring_t description,
1148                                  netlink_route_fn *set_routes,
1149                                  netlink_deliver_fn *to_host)
1150 {
1151     item_t *sa, *ptpa;
1152     list_t *l;
1153
1154     st->dst=dst;
1155     st->cl.description=description;
1156     st->cl.type=CL_PURE;
1157     st->cl.apply=netlink_inst_apply;
1158     st->cl.interface=st;
1159     st->clients=NULL;
1160     st->routes=NULL;
1161     st->n_clients=0;
1162     st->set_routes=set_routes;
1163     st->deliver_to_host=to_host;
1164
1165     st->name=dict_read_string(dict,"name",False,description,loc);
1166     if (!st->name) st->name=description;
1167     l=dict_lookup(dict,"networks");
1168     if (l) 
1169         st->networks=string_list_to_ipset(l,loc,st->name,"networks");
1170     else {
1171         struct ipset *empty;
1172         empty=ipset_new();
1173         st->networks=ipset_complement(empty);
1174         ipset_free(empty);
1175     }
1176     l=dict_lookup(dict,"remote-networks");
1177     if (l) {
1178         st->remote_networks=string_list_to_ipset(l,loc,st->name,
1179                                                  "remote-networks");
1180     } else {
1181         struct ipset *empty;
1182         empty=ipset_new();
1183         st->remote_networks=ipset_complement(empty);
1184         ipset_free(empty);
1185     }
1186
1187     sa=dict_find_item(dict,"secnet-address",False,"netlink",loc);
1188     ptpa=dict_find_item(dict,"ptp-address",False,"netlink",loc);
1189     if (sa && ptpa) {
1190         cfgfatal(loc,st->name,"you may not specify secnet-address and "
1191                  "ptp-address in the same netlink device\n");
1192     }
1193     if (!(sa || ptpa)) {
1194         cfgfatal(loc,st->name,"you must specify secnet-address or "
1195                  "ptp-address for this netlink device\n");
1196     }
1197     if (sa) {
1198         st->secnet_address=string_item_to_ipaddr(sa,"netlink");
1199         st->ptp=False;
1200     } else {
1201         st->secnet_address=string_item_to_ipaddr(ptpa,"netlink");
1202         st->ptp=True;
1203     }
1204     /* To be strictly correct we could subtract secnet_address from
1205        networks here.  It shouldn't make any practical difference,
1206        though, and will make the route dump look complicated... */
1207     st->subnets=ipset_to_subnet_list(st->networks);
1208     st->mtu=dict_read_number(dict, "mtu", False, "netlink", loc, DEFAULT_MTU);
1209     buffer_new(&st->icmp,MAX(ICMP_BUFSIZE,st->mtu));
1210     st->outcount=0;
1211     st->localcount=0;
1212
1213     add_hook(PHASE_SETUP,netlink_phase_hook,st);
1214     request_signal_notification(SIGUSR1, netlink_signal_handler, st);
1215
1216     /* If we're point-to-point then we return a CL_NETLINK directly,
1217        rather than a CL_NETLINK_OLD or pure closure (depending on
1218        compatibility).  This CL_NETLINK is for our one and only
1219        client.  Our cl.apply function is NULL. */
1220     if (st->ptp) {
1221         closure_t *cl;
1222         cl=netlink_inst_create(st,loc,dict);
1223         st->cl=*cl;
1224     }
1225     return netlink_dev_incoming;
1226 }
1227
1228 /* No connection to the kernel at all... */
1229
1230 struct null {
1231     struct netlink nl;
1232 };
1233
1234 static bool_t null_set_route(void *sst, struct netlink_client *routes)
1235 {
1236     struct null *st=sst;
1237
1238     if (routes->up!=routes->kup) {
1239         Message(M_INFO,"%s: setting routes for tunnel %s to state %s\n",
1240                 st->nl.name,routes->name,
1241                 routes->up?"up":"down");
1242         routes->kup=routes->up;
1243         return True;
1244     }
1245     return False;
1246 }
1247             
1248 static void null_deliver(void *sst, struct buffer_if *buf)
1249 {
1250     return;
1251 }
1252
1253 static list_t *null_apply(closure_t *self, struct cloc loc, dict_t *context,
1254                           list_t *args)
1255 {
1256     struct null *st;
1257     item_t *item;
1258     dict_t *dict;
1259
1260     st=safe_malloc(sizeof(*st),"null_apply");
1261
1262     item=list_elem(args,0);
1263     if (!item || item->type!=t_dict)
1264         cfgfatal(loc,"null-netlink","parameter must be a dictionary\n");
1265     
1266     dict=item->data.dict;
1267
1268     netlink_init(&st->nl,st,loc,dict,"null-netlink",null_set_route,
1269                  null_deliver);
1270
1271     return new_closure(&st->nl.cl);
1272 }
1273
1274 void netlink_module(dict_t *dict)
1275 {
1276     add_closure(dict,"null-netlink",null_apply);
1277 }