1 /*
2  *  OpenVPN -- An application to securely tunnel IP networks
3  *             over a single TCP/UDP port, with support for SSL/TLS-based
4  *             session authentication and key exchange,
5  *             packet encryption, packet authentication, and
6  *             packet compression.
7  *
8  *  Copyright (C) 2002-2018 OpenVPN Inc <sales@openvpn.net>
9  *
10  *  This program is free software; you can redistribute it and/or modify
11  *  it under the terms of the GNU General Public License version 2
12  *  as published by the Free Software Foundation.
13  *
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License along
20  *  with this program; if not, write to the Free Software Foundation, Inc.,
21  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22  */
23 
24 /*
25  * Support routines for adding/deleting network routes.
26  */
27 
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #elif defined(_MSC_VER)
31 #include "config-msvc.h"
32 #endif
33 
34 #include "syshead.h"
35 
36 #include "common.h"
37 #include "error.h"
38 #include "route.h"
39 #include "run_command.h"
40 #include "socket.h"
41 #include "manage.h"
42 #include "win32.h"
43 #include "options.h"
44 #include "networking.h"
45 
46 #include "memdbg.h"
47 
48 #if defined(TARGET_LINUX) || defined(TARGET_ANDROID)
49 #include <linux/rtnetlink.h>            /* RTM_GETROUTE etc. */
50 #endif
51 
52 #if defined(TARGET_NETBSD)
53 #include <net/route.h>			/* RT_ROUNDUP(), RT_ADVANCE() */
54 #endif
55 
56 #ifdef _WIN32
57 #include "openvpn-msg.h"
58 
59 #define METRIC_NOT_USED ((DWORD)-1)
60 static bool add_route_service(const struct route_ipv4 *, const struct tuntap *);
61 
62 static bool del_route_service(const struct route_ipv4 *, const struct tuntap *);
63 
64 static bool add_route_ipv6_service(const struct route_ipv6 *, const struct tuntap *);
65 
66 static bool del_route_ipv6_service(const struct route_ipv6 *, const struct tuntap *);
67 
68 #endif
69 
70 static void delete_route(struct route_ipv4 *r, const struct tuntap *tt, unsigned int flags, const struct route_gateway_info *rgi, const struct env_set *es, openvpn_net_ctx_t *ctx);
71 
72 static void get_bypass_addresses(struct route_bypass *rb, const unsigned int flags);
73 
74 #ifdef ENABLE_DEBUG
75 
76 static void
print_bypass_addresses(const struct route_bypass * rb)77 print_bypass_addresses(const struct route_bypass *rb)
78 {
79     struct gc_arena gc = gc_new();
80     int i;
81     for (i = 0; i < rb->n_bypass; ++i)
82     {
83         msg(D_ROUTE, "ROUTE: bypass_host_route[%d]=%s",
84             i,
85             print_in_addr_t(rb->bypass[i], 0, &gc));
86     }
87     gc_free(&gc);
88 }
89 
90 #endif
91 
92 static bool
add_bypass_address(struct route_bypass * rb,const in_addr_t a)93 add_bypass_address(struct route_bypass *rb, const in_addr_t a)
94 {
95     int i;
96     for (i = 0; i < rb->n_bypass; ++i)
97     {
98         if (a == rb->bypass[i]) /* avoid duplicates */
99         {
100             return true;
101         }
102     }
103     if (rb->n_bypass < N_ROUTE_BYPASS)
104     {
105         rb->bypass[rb->n_bypass++] = a;
106         return true;
107     }
108     else
109     {
110         return false;
111     }
112 }
113 
114 struct route_option_list *
new_route_option_list(struct gc_arena * a)115 new_route_option_list(struct gc_arena *a)
116 {
117     struct route_option_list *ret;
118     ALLOC_OBJ_CLEAR_GC(ret, struct route_option_list, a);
119     ret->gc = a;
120     return ret;
121 }
122 
123 struct route_ipv6_option_list *
new_route_ipv6_option_list(struct gc_arena * a)124 new_route_ipv6_option_list(struct gc_arena *a)
125 {
126     struct route_ipv6_option_list *ret;
127     ALLOC_OBJ_CLEAR_GC(ret, struct route_ipv6_option_list, a);
128     ret->gc = a;
129     return ret;
130 }
131 
132 /*
133  * NOTE: structs are cloned/copied shallow by design.
134  * The routes list from src will stay intact since it is allocated using
135  * the options->gc. The cloned/copied lists will share this common tail
136  * to avoid copying the data around between pulls. Pulled routes use
137  * the c2->gc so they get freed immediately after a reconnect.
138  */
139 struct route_option_list *
clone_route_option_list(const struct route_option_list * src,struct gc_arena * a)140 clone_route_option_list(const struct route_option_list *src, struct gc_arena *a)
141 {
142     struct route_option_list *ret;
143     ALLOC_OBJ_GC(ret, struct route_option_list, a);
144     *ret = *src;
145     return ret;
146 }
147 
148 struct route_ipv6_option_list *
clone_route_ipv6_option_list(const struct route_ipv6_option_list * src,struct gc_arena * a)149 clone_route_ipv6_option_list(const struct route_ipv6_option_list *src, struct gc_arena *a)
150 {
151     struct route_ipv6_option_list *ret;
152     ALLOC_OBJ_GC(ret, struct route_ipv6_option_list, a);
153     *ret = *src;
154     return ret;
155 }
156 
157 void
copy_route_option_list(struct route_option_list * dest,const struct route_option_list * src,struct gc_arena * a)158 copy_route_option_list(struct route_option_list *dest, const struct route_option_list *src, struct gc_arena *a)
159 {
160     *dest = *src;
161     dest->gc = a;
162 }
163 
164 void
copy_route_ipv6_option_list(struct route_ipv6_option_list * dest,const struct route_ipv6_option_list * src,struct gc_arena * a)165 copy_route_ipv6_option_list(struct route_ipv6_option_list *dest,
166                             const struct route_ipv6_option_list *src,
167                             struct gc_arena *a)
168 {
169     *dest = *src;
170     dest->gc = a;
171 }
172 
173 static const char *
route_string(const struct route_ipv4 * r,struct gc_arena * gc)174 route_string(const struct route_ipv4 *r, struct gc_arena *gc)
175 {
176     struct buffer out = alloc_buf_gc(256, gc);
177     buf_printf(&out, "ROUTE network %s netmask %s gateway %s",
178                print_in_addr_t(r->network, 0, gc),
179                print_in_addr_t(r->netmask, 0, gc),
180                print_in_addr_t(r->gateway, 0, gc)
181                );
182     if (r->flags & RT_METRIC_DEFINED)
183     {
184         buf_printf(&out, " metric %d", r->metric);
185     }
186     return BSTR(&out);
187 }
188 
189 static bool
is_route_parm_defined(const char * parm)190 is_route_parm_defined(const char *parm)
191 {
192     if (!parm)
193     {
194         return false;
195     }
196     if (!strcmp(parm, "default"))
197     {
198         return false;
199     }
200     return true;
201 }
202 
203 static void
setenv_route_addr(struct env_set * es,const char * key,const in_addr_t addr,int i)204 setenv_route_addr(struct env_set *es, const char *key, const in_addr_t addr, int i)
205 {
206     struct gc_arena gc = gc_new();
207     struct buffer name = alloc_buf_gc(256, &gc);
208     if (i >= 0)
209     {
210         buf_printf(&name, "route_%s_%d", key, i);
211     }
212     else
213     {
214         buf_printf(&name, "route_%s", key);
215     }
216     setenv_str(es, BSTR(&name), print_in_addr_t(addr, 0, &gc));
217     gc_free(&gc);
218 }
219 
220 static bool
get_special_addr(const struct route_list * rl,const char * string,in_addr_t * out,bool * status)221 get_special_addr(const struct route_list *rl,
222                  const char *string,
223                  in_addr_t *out,
224                  bool *status)
225 {
226     if (status)
227     {
228         *status = true;
229     }
230     if (!strcmp(string, "vpn_gateway"))
231     {
232         if (rl)
233         {
234             if (rl->spec.flags & RTSA_REMOTE_ENDPOINT)
235             {
236                 *out = rl->spec.remote_endpoint;
237             }
238             else
239             {
240                 msg(M_INFO, PACKAGE_NAME " ROUTE: vpn_gateway undefined");
241                 if (status)
242                 {
243                     *status = false;
244                 }
245             }
246         }
247         return true;
248     }
249     else if (!strcmp(string, "net_gateway"))
250     {
251         if (rl)
252         {
253             if (rl->rgi.flags & RGI_ADDR_DEFINED)
254             {
255                 *out = rl->rgi.gateway.addr;
256             }
257             else
258             {
259                 msg(M_INFO, PACKAGE_NAME " ROUTE: net_gateway undefined -- unable to get default gateway from system");
260                 if (status)
261                 {
262                     *status = false;
263                 }
264             }
265         }
266         return true;
267     }
268     else if (!strcmp(string, "remote_host"))
269     {
270         if (rl)
271         {
272             if (rl->spec.flags & RTSA_REMOTE_HOST)
273             {
274                 *out = rl->spec.remote_host;
275             }
276             else
277             {
278                 msg(M_INFO, PACKAGE_NAME " ROUTE: remote_host undefined");
279                 if (status)
280                 {
281                     *status = false;
282                 }
283             }
284         }
285         return true;
286     }
287     return false;
288 }
289 
290 bool
is_special_addr(const char * addr_str)291 is_special_addr(const char *addr_str)
292 {
293     if (addr_str)
294     {
295         return get_special_addr(NULL, addr_str, NULL, NULL);
296     }
297     else
298     {
299         return false;
300     }
301 }
302 
303 static bool
init_route(struct route_ipv4 * r,struct addrinfo ** network_list,const struct route_option * ro,const struct route_list * rl)304 init_route(struct route_ipv4 *r,
305            struct addrinfo **network_list,
306            const struct route_option *ro,
307            const struct route_list *rl)
308 {
309     const in_addr_t default_netmask = IPV4_NETMASK_HOST;
310     bool status;
311     int ret;
312     struct in_addr special;
313 
314     CLEAR(*r);
315     r->option = ro;
316 
317     /* network */
318 
319     if (!is_route_parm_defined(ro->network))
320     {
321         goto fail;
322     }
323 
324 
325     /* get_special_addr replaces specialaddr with a special ip addr
326      * like gw. getaddrinfo is called to convert a a addrinfo struct */
327 
328     if (get_special_addr(rl, ro->network, (in_addr_t *) &special.s_addr, &status))
329     {
330         if (!status)
331         {
332             goto fail;
333         }
334         special.s_addr = htonl(special.s_addr);
335         ret = openvpn_getaddrinfo(0, inet_ntoa(special), NULL, 0, NULL,
336                                   AF_INET, network_list);
337     }
338     else
339     {
340         ret = openvpn_getaddrinfo(GETADDR_RESOLVE | GETADDR_WARN_ON_SIGNAL,
341                                   ro->network, NULL, 0, NULL, AF_INET, network_list);
342     }
343 
344     status = (ret == 0);
345 
346     if (!status)
347     {
348         goto fail;
349     }
350 
351     /* netmask */
352 
353     if (is_route_parm_defined(ro->netmask))
354     {
355         r->netmask = getaddr(
356             GETADDR_HOST_ORDER
357             | GETADDR_WARN_ON_SIGNAL,
358             ro->netmask,
359             0,
360             &status,
361             NULL);
362         if (!status)
363         {
364             goto fail;
365         }
366     }
367     else
368     {
369         r->netmask = default_netmask;
370     }
371 
372     /* gateway */
373 
374     if (is_route_parm_defined(ro->gateway))
375     {
376         if (!get_special_addr(rl, ro->gateway, &r->gateway, &status))
377         {
378             r->gateway = getaddr(
379                 GETADDR_RESOLVE
380                 | GETADDR_HOST_ORDER
381                 | GETADDR_WARN_ON_SIGNAL,
382                 ro->gateway,
383                 0,
384                 &status,
385                 NULL);
386         }
387         if (!status)
388         {
389             goto fail;
390         }
391     }
392     else
393     {
394         if (rl->spec.flags & RTSA_REMOTE_ENDPOINT)
395         {
396             r->gateway = rl->spec.remote_endpoint;
397         }
398         else
399         {
400             msg(M_WARN, PACKAGE_NAME " ROUTE: " PACKAGE_NAME " needs a gateway parameter for a --route option and no default was specified by either --route-gateway or --ifconfig options");
401             goto fail;
402         }
403     }
404 
405     /* metric */
406 
407     r->metric = 0;
408     if (is_route_parm_defined(ro->metric))
409     {
410         r->metric = atoi(ro->metric);
411         if (r->metric < 0)
412         {
413             msg(M_WARN, PACKAGE_NAME " ROUTE: route metric for network %s (%s) must be >= 0",
414                 ro->network,
415                 ro->metric);
416             goto fail;
417         }
418         r->flags |= RT_METRIC_DEFINED;
419     }
420     else if (rl->spec.flags & RTSA_DEFAULT_METRIC)
421     {
422         r->metric = rl->spec.default_metric;
423         r->flags |= RT_METRIC_DEFINED;
424     }
425 
426     r->flags |= RT_DEFINED;
427 
428     return true;
429 
430 fail:
431     msg(M_WARN, PACKAGE_NAME " ROUTE: failed to parse/resolve route for host/network: %s",
432         ro->network);
433     return false;
434 }
435 
436 static bool
init_route_ipv6(struct route_ipv6 * r6,const struct route_ipv6_option * r6o,const struct route_ipv6_list * rl6)437 init_route_ipv6(struct route_ipv6 *r6,
438                 const struct route_ipv6_option *r6o,
439                 const struct route_ipv6_list *rl6 )
440 {
441     CLEAR(*r6);
442 
443     if (!get_ipv6_addr( r6o->prefix, &r6->network, &r6->netbits, M_WARN ))
444     {
445         goto fail;
446     }
447 
448     /* gateway */
449     if (is_route_parm_defined(r6o->gateway))
450     {
451         if (inet_pton( AF_INET6, r6o->gateway, &r6->gateway ) != 1)
452         {
453             msg( M_WARN, PACKAGE_NAME "ROUTE6: cannot parse gateway spec '%s'", r6o->gateway );
454         }
455     }
456     else if (rl6->spec_flags & RTSA_REMOTE_ENDPOINT)
457     {
458         r6->gateway = rl6->remote_endpoint_ipv6;
459     }
460 
461     /* metric */
462 
463     r6->metric = -1;
464     if (is_route_parm_defined(r6o->metric))
465     {
466         r6->metric = atoi(r6o->metric);
467         if (r6->metric < 0)
468         {
469             msg(M_WARN, PACKAGE_NAME " ROUTE: route metric for network %s (%s) must be >= 0",
470                 r6o->prefix,
471                 r6o->metric);
472             goto fail;
473         }
474         r6->flags |= RT_METRIC_DEFINED;
475     }
476     else if (rl6->spec_flags & RTSA_DEFAULT_METRIC)
477     {
478         r6->metric = rl6->default_metric;
479         r6->flags |= RT_METRIC_DEFINED;
480     }
481 
482     r6->flags |= RT_DEFINED;
483 
484     return true;
485 
486 fail:
487     msg(M_WARN, PACKAGE_NAME " ROUTE: failed to parse/resolve route for host/network: %s",
488         r6o->prefix);
489     return false;
490 }
491 
492 void
add_route_to_option_list(struct route_option_list * l,const char * network,const char * netmask,const char * gateway,const char * metric)493 add_route_to_option_list(struct route_option_list *l,
494                          const char *network,
495                          const char *netmask,
496                          const char *gateway,
497                          const char *metric)
498 {
499     struct route_option *ro;
500     ALLOC_OBJ_GC(ro, struct route_option, l->gc);
501     ro->network = network;
502     ro->netmask = netmask;
503     ro->gateway = gateway;
504     ro->metric = metric;
505     ro->next = l->routes;
506     l->routes = ro;
507 
508 }
509 
510 void
add_route_ipv6_to_option_list(struct route_ipv6_option_list * l,const char * prefix,const char * gateway,const char * metric)511 add_route_ipv6_to_option_list(struct route_ipv6_option_list *l,
512                               const char *prefix,
513                               const char *gateway,
514                               const char *metric)
515 {
516     struct route_ipv6_option *ro;
517     ALLOC_OBJ_GC(ro, struct route_ipv6_option, l->gc);
518     ro->prefix = prefix;
519     ro->gateway = gateway;
520     ro->metric = metric;
521     ro->next = l->routes_ipv6;
522     l->routes_ipv6 = ro;
523 }
524 
525 static void
clear_route_list(struct route_list * rl)526 clear_route_list(struct route_list *rl)
527 {
528     gc_free(&rl->gc);
529     CLEAR(*rl);
530 }
531 
532 static void
clear_route_ipv6_list(struct route_ipv6_list * rl6)533 clear_route_ipv6_list(struct route_ipv6_list *rl6)
534 {
535     gc_free(&rl6->gc);
536     CLEAR(*rl6);
537 }
538 
539 void
route_list_add_vpn_gateway(struct route_list * rl,struct env_set * es,const in_addr_t addr)540 route_list_add_vpn_gateway(struct route_list *rl,
541                            struct env_set *es,
542                            const in_addr_t addr)
543 {
544     ASSERT(rl);
545     rl->spec.remote_endpoint = addr;
546     rl->spec.flags |= RTSA_REMOTE_ENDPOINT;
547     setenv_route_addr(es, "vpn_gateway", rl->spec.remote_endpoint, -1);
548 }
549 
550 static void
add_block_local_item(struct route_list * rl,const struct route_gateway_address * gateway,in_addr_t target)551 add_block_local_item(struct route_list *rl,
552                      const struct route_gateway_address *gateway,
553                      in_addr_t target)
554 {
555     const int rgi_needed = (RGI_ADDR_DEFINED|RGI_NETMASK_DEFINED);
556     if ((rl->rgi.flags & rgi_needed) == rgi_needed
557         && rl->rgi.gateway.netmask < 0xFFFFFFFF)
558     {
559         struct route_ipv4 *r1, *r2;
560         unsigned int l2;
561 
562         ALLOC_OBJ_GC(r1, struct route_ipv4, &rl->gc);
563         ALLOC_OBJ_GC(r2, struct route_ipv4, &rl->gc);
564 
565         /* split a route into two smaller blocking routes, and direct them to target */
566         l2 = ((~gateway->netmask)+1)>>1;
567         r1->flags = RT_DEFINED;
568         r1->gateway = target;
569         r1->network = gateway->addr & gateway->netmask;
570         r1->netmask = ~(l2-1);
571         r1->next = rl->routes;
572         rl->routes = r1;
573 
574         *r2 = *r1;
575         r2->network += l2;
576         r2->next = rl->routes;
577         rl->routes = r2;
578     }
579 }
580 
581 static void
add_block_local(struct route_list * rl)582 add_block_local(struct route_list *rl)
583 {
584     const int rgi_needed = (RGI_ADDR_DEFINED|RGI_NETMASK_DEFINED);
585     if ((rl->flags & RG_BLOCK_LOCAL)
586         && (rl->rgi.flags & rgi_needed) == rgi_needed
587         && (rl->spec.flags & RTSA_REMOTE_ENDPOINT)
588         && rl->spec.remote_host_local != TLA_LOCAL)
589     {
590         size_t i;
591 
592 #ifndef TARGET_ANDROID
593         /* add bypass for gateway addr */
594         add_bypass_address(&rl->spec.bypass, rl->rgi.gateway.addr);
595 #endif
596 
597         /* block access to local subnet */
598         add_block_local_item(rl, &rl->rgi.gateway, rl->spec.remote_endpoint);
599 
600         /* process additional subnets on gateway interface */
601         for (i = 0; i < rl->rgi.n_addrs; ++i)
602         {
603             const struct route_gateway_address *gwa = &rl->rgi.addrs[i];
604             /* omit the add/subnet in &rl->rgi which we processed above */
605             if (!((rl->rgi.gateway.addr & rl->rgi.gateway.netmask) == (gwa->addr & gwa->netmask)
606                   && rl->rgi.gateway.netmask == gwa->netmask))
607             {
608                 add_block_local_item(rl, gwa, rl->spec.remote_endpoint);
609             }
610         }
611     }
612 }
613 
614 bool
init_route_list(struct route_list * rl,const struct route_option_list * opt,const char * remote_endpoint,int default_metric,in_addr_t remote_host,struct env_set * es,openvpn_net_ctx_t * ctx)615 init_route_list(struct route_list *rl,
616                 const struct route_option_list *opt,
617                 const char *remote_endpoint,
618                 int default_metric,
619                 in_addr_t remote_host,
620                 struct env_set *es,
621                 openvpn_net_ctx_t *ctx)
622 {
623     struct gc_arena gc = gc_new();
624     bool ret = true;
625 
626     clear_route_list(rl);
627 
628     rl->flags = opt->flags;
629 
630     if (remote_host != IPV4_INVALID_ADDR)
631     {
632         rl->spec.remote_host = remote_host;
633         rl->spec.flags |= RTSA_REMOTE_HOST;
634     }
635 
636     if (default_metric)
637     {
638         rl->spec.default_metric = default_metric;
639         rl->spec.flags |= RTSA_DEFAULT_METRIC;
640     }
641 
642     get_default_gateway(&rl->rgi, ctx);
643     if (rl->rgi.flags & RGI_ADDR_DEFINED)
644     {
645         setenv_route_addr(es, "net_gateway", rl->rgi.gateway.addr, -1);
646 #if defined(ENABLE_DEBUG) && !defined(ENABLE_SMALL)
647         print_default_gateway(D_ROUTE, &rl->rgi, NULL);
648 #endif
649     }
650     else
651     {
652         dmsg(D_ROUTE, "ROUTE: default_gateway=UNDEF");
653     }
654 
655     if (rl->spec.flags & RTSA_REMOTE_HOST)
656     {
657         rl->spec.remote_host_local = test_local_addr(remote_host, &rl->rgi);
658     }
659 
660     if (is_route_parm_defined(remote_endpoint))
661     {
662         bool defined = false;
663         rl->spec.remote_endpoint = getaddr(
664             GETADDR_RESOLVE
665             | GETADDR_HOST_ORDER
666             | GETADDR_WARN_ON_SIGNAL,
667             remote_endpoint,
668             0,
669             &defined,
670             NULL);
671 
672         if (defined)
673         {
674             setenv_route_addr(es, "vpn_gateway", rl->spec.remote_endpoint, -1);
675             rl->spec.flags |= RTSA_REMOTE_ENDPOINT;
676         }
677         else
678         {
679             msg(M_WARN, PACKAGE_NAME " ROUTE: failed to parse/resolve default gateway: %s",
680                 remote_endpoint);
681             ret = false;
682         }
683     }
684 
685     if (rl->flags & RG_ENABLE)
686     {
687         add_block_local(rl);
688         get_bypass_addresses(&rl->spec.bypass, rl->flags);
689 #ifdef ENABLE_DEBUG
690         print_bypass_addresses(&rl->spec.bypass);
691 #endif
692     }
693 
694     /* parse the routes from opt to rl */
695     {
696         struct route_option *ro;
697         for (ro = opt->routes; ro; ro = ro->next)
698         {
699             struct addrinfo *netlist = NULL;
700             struct route_ipv4 r;
701 
702             if (!init_route(&r, &netlist, ro, rl))
703             {
704                 ret = false;
705             }
706             else
707             {
708                 struct addrinfo *curele;
709                 for (curele = netlist; curele; curele = curele->ai_next)
710                 {
711                     struct route_ipv4 *new;
712                     ALLOC_OBJ_GC(new, struct route_ipv4, &rl->gc);
713                     *new = r;
714                     new->network = ntohl(((struct sockaddr_in *)curele->ai_addr)->sin_addr.s_addr);
715                     new->next = rl->routes;
716                     rl->routes = new;
717                 }
718             }
719             if (netlist)
720             {
721                 gc_addspecial(netlist, &gc_freeaddrinfo_callback, &gc);
722             }
723         }
724     }
725 
726     gc_free(&gc);
727     return ret;
728 }
729 
730 /* check whether an IPv6 host address is covered by a given route_ipv6
731  * (not the most beautiful implementation in the world, but portable and
732  * "good enough")
733  */
734 static bool
route_ipv6_match_host(const struct route_ipv6 * r6,const struct in6_addr * host)735 route_ipv6_match_host( const struct route_ipv6 *r6,
736                        const struct in6_addr *host )
737 {
738     unsigned int bits = r6->netbits;
739     int i;
740     unsigned int mask;
741 
742     if (bits>128)
743     {
744         return false;
745     }
746 
747     for (i = 0; bits >= 8; i++, bits -= 8)
748     {
749         if (r6->network.s6_addr[i] != host->s6_addr[i])
750         {
751             return false;
752         }
753     }
754 
755     if (bits == 0)
756     {
757         return true;
758     }
759 
760     mask = 0xff << (8-bits);
761 
762     if ( (r6->network.s6_addr[i] & mask) == (host->s6_addr[i] & mask ))
763     {
764         return true;
765     }
766 
767     return false;
768 }
769 
770 bool
init_route_ipv6_list(struct route_ipv6_list * rl6,const struct route_ipv6_option_list * opt6,const char * remote_endpoint,int default_metric,const struct in6_addr * remote_host_ipv6,struct env_set * es,openvpn_net_ctx_t * ctx)771 init_route_ipv6_list(struct route_ipv6_list *rl6,
772                      const struct route_ipv6_option_list *opt6,
773                      const char *remote_endpoint,
774                      int default_metric,
775                      const struct in6_addr *remote_host_ipv6,
776                      struct env_set *es,
777                      openvpn_net_ctx_t *ctx)
778 {
779     struct gc_arena gc = gc_new();
780     bool ret = true;
781     bool need_remote_ipv6_route;
782 
783     clear_route_ipv6_list(rl6);
784 
785     rl6->flags = opt6->flags;
786 
787     if (remote_host_ipv6)
788     {
789         rl6->remote_host_ipv6 = *remote_host_ipv6;
790         rl6->spec_flags |= RTSA_REMOTE_HOST;
791     }
792 
793     if (default_metric >= 0)
794     {
795         rl6->default_metric = default_metric;
796         rl6->spec_flags |= RTSA_DEFAULT_METRIC;
797     }
798 
799     msg(D_ROUTE, "GDG6: remote_host_ipv6=%s",
800         remote_host_ipv6 ?  print_in6_addr(*remote_host_ipv6, 0, &gc) : "n/a" );
801 
802     get_default_gateway_ipv6(&rl6->rgi6, remote_host_ipv6, ctx);
803     if (rl6->rgi6.flags & RGI_ADDR_DEFINED)
804     {
805         setenv_str(es, "net_gateway_ipv6", print_in6_addr(rl6->rgi6.gateway.addr_ipv6, 0, &gc));
806 #if defined(ENABLE_DEBUG) && !defined(ENABLE_SMALL)
807         print_default_gateway(D_ROUTE, NULL, &rl6->rgi6);
808 #endif
809     }
810     else
811     {
812         dmsg(D_ROUTE, "ROUTE6: default_gateway=UNDEF");
813     }
814 
815     if (is_route_parm_defined( remote_endpoint ))
816     {
817         if (inet_pton( AF_INET6, remote_endpoint,
818                        &rl6->remote_endpoint_ipv6) == 1)
819         {
820             rl6->spec_flags |= RTSA_REMOTE_ENDPOINT;
821         }
822         else
823         {
824             msg(M_WARN, PACKAGE_NAME " ROUTE: failed to parse/resolve VPN endpoint: %s", remote_endpoint);
825             ret = false;
826         }
827     }
828 
829     /* parse the routes from opt6 to rl6
830      * discovering potential overlaps with remote_host_ipv6 in the process
831      */
832     need_remote_ipv6_route = false;
833 
834     {
835         struct route_ipv6_option *ro6;
836         for (ro6 = opt6->routes_ipv6; ro6; ro6 = ro6->next)
837         {
838             struct route_ipv6 *r6;
839             ALLOC_OBJ_GC(r6, struct route_ipv6, &rl6->gc);
840             if (!init_route_ipv6(r6, ro6, rl6))
841             {
842                 ret = false;
843             }
844             else
845             {
846                 r6->next = rl6->routes_ipv6;
847                 rl6->routes_ipv6 = r6;
848 
849 #ifndef TARGET_ANDROID
850                 /* On Android the VPNService protect function call will take of
851                  * avoiding routing loops, so ignore this part and let
852                  * need_remote_ipv6_route always evaluate to false
853                  */
854                 if (remote_host_ipv6
855                     && route_ipv6_match_host( r6, remote_host_ipv6 ) )
856                 {
857                     need_remote_ipv6_route = true;
858                     msg(D_ROUTE, "ROUTE6: %s/%d overlaps IPv6 remote %s, adding host route to VPN endpoint",
859                         print_in6_addr(r6->network, 0, &gc), r6->netbits,
860                         print_in6_addr(*remote_host_ipv6, 0, &gc));
861                 }
862 #endif
863             }
864         }
865     }
866 
867     /* add VPN server host route if needed */
868     if (need_remote_ipv6_route)
869     {
870         if ( (rl6->rgi6.flags & (RGI_ADDR_DEFINED|RGI_IFACE_DEFINED) ) ==
871              (RGI_ADDR_DEFINED|RGI_IFACE_DEFINED) )
872         {
873             struct route_ipv6 *r6;
874             ALLOC_OBJ_CLEAR_GC(r6, struct route_ipv6, &rl6->gc);
875 
876             r6->network = *remote_host_ipv6;
877             r6->netbits = 128;
878             if (!(rl6->rgi6.flags & RGI_ON_LINK) )
879             {
880                 r6->gateway = rl6->rgi6.gateway.addr_ipv6;
881             }
882             r6->metric = 1;
883 #ifdef _WIN32
884             r6->adapter_index = rl6->rgi6.adapter_index;
885 #else
886             r6->iface = rl6->rgi6.iface;
887 #endif
888             r6->flags = RT_DEFINED | RT_METRIC_DEFINED;
889 
890             r6->next = rl6->routes_ipv6;
891             rl6->routes_ipv6 = r6;
892         }
893         else
894         {
895             msg(M_WARN, "ROUTE6: IPv6 route overlaps with IPv6 remote address, but could not determine IPv6 gateway address + interface, expect failure\n" );
896         }
897     }
898 
899     gc_free(&gc);
900     return ret;
901 }
902 
903 static void
add_route3(in_addr_t network,in_addr_t netmask,in_addr_t gateway,const struct tuntap * tt,unsigned int flags,const struct route_gateway_info * rgi,const struct env_set * es,openvpn_net_ctx_t * ctx)904 add_route3(in_addr_t network,
905            in_addr_t netmask,
906            in_addr_t gateway,
907            const struct tuntap *tt,
908            unsigned int flags,
909            const struct route_gateway_info *rgi,
910            const struct env_set *es,
911            openvpn_net_ctx_t *ctx)
912 {
913     struct route_ipv4 r;
914     CLEAR(r);
915     r.flags = RT_DEFINED;
916     r.network = network;
917     r.netmask = netmask;
918     r.gateway = gateway;
919     add_route(&r, tt, flags, rgi, es, ctx);
920 }
921 
922 static void
del_route3(in_addr_t network,in_addr_t netmask,in_addr_t gateway,const struct tuntap * tt,unsigned int flags,const struct route_gateway_info * rgi,const struct env_set * es,openvpn_net_ctx_t * ctx)923 del_route3(in_addr_t network,
924            in_addr_t netmask,
925            in_addr_t gateway,
926            const struct tuntap *tt,
927            unsigned int flags,
928            const struct route_gateway_info *rgi,
929            const struct env_set *es,
930            openvpn_net_ctx_t *ctx)
931 {
932     struct route_ipv4 r;
933     CLEAR(r);
934     r.flags = RT_DEFINED|RT_ADDED;
935     r.network = network;
936     r.netmask = netmask;
937     r.gateway = gateway;
938     delete_route(&r, tt, flags, rgi, es, ctx);
939 }
940 
941 static void
add_bypass_routes(struct route_bypass * rb,in_addr_t gateway,const struct tuntap * tt,unsigned int flags,const struct route_gateway_info * rgi,const struct env_set * es,openvpn_net_ctx_t * ctx)942 add_bypass_routes(struct route_bypass *rb,
943                   in_addr_t gateway,
944                   const struct tuntap *tt,
945                   unsigned int flags,
946                   const struct route_gateway_info *rgi,
947                   const struct env_set *es,
948                   openvpn_net_ctx_t *ctx)
949 {
950     int i;
951     for (i = 0; i < rb->n_bypass; ++i)
952     {
953         if (rb->bypass[i])
954         {
955             add_route3(rb->bypass[i],
956                        IPV4_NETMASK_HOST,
957                        gateway,
958                        tt,
959                        flags | ROUTE_REF_GW,
960                        rgi,
961                        es,
962                        ctx);
963         }
964     }
965 }
966 
967 static void
del_bypass_routes(struct route_bypass * rb,in_addr_t gateway,const struct tuntap * tt,unsigned int flags,const struct route_gateway_info * rgi,const struct env_set * es,openvpn_net_ctx_t * ctx)968 del_bypass_routes(struct route_bypass *rb,
969                   in_addr_t gateway,
970                   const struct tuntap *tt,
971                   unsigned int flags,
972                   const struct route_gateway_info *rgi,
973                   const struct env_set *es,
974                   openvpn_net_ctx_t *ctx)
975 {
976     int i;
977     for (i = 0; i < rb->n_bypass; ++i)
978     {
979         if (rb->bypass[i])
980         {
981             del_route3(rb->bypass[i],
982                        IPV4_NETMASK_HOST,
983                        gateway,
984                        tt,
985                        flags | ROUTE_REF_GW,
986                        rgi,
987                        es,
988                        ctx);
989         }
990     }
991 }
992 
993 static void
redirect_default_route_to_vpn(struct route_list * rl,const struct tuntap * tt,unsigned int flags,const struct env_set * es,openvpn_net_ctx_t * ctx)994 redirect_default_route_to_vpn(struct route_list *rl, const struct tuntap *tt,
995                               unsigned int flags, const struct env_set *es,
996                               openvpn_net_ctx_t *ctx)
997 {
998     const char err[] = "NOTE: unable to redirect IPv4 default gateway --";
999 
1000     if (rl && rl->flags & RG_ENABLE)
1001     {
1002         bool local = rl->flags & RG_LOCAL;
1003 
1004         if (!(rl->spec.flags & RTSA_REMOTE_ENDPOINT) && (rl->flags & RG_REROUTE_GW))
1005         {
1006             msg(M_WARN, "%s VPN gateway parameter (--route-gateway or --ifconfig) is missing", err);
1007         }
1008         /*
1009          * check if a default route is defined, unless:
1010          * - we are connecting to a remote host in our network
1011          * - we are connecting to a non-IPv4 remote host (i.e. we use IPv6)
1012          */
1013         else if (!(rl->rgi.flags & RGI_ADDR_DEFINED) && !local
1014                  && (rl->spec.flags & RTSA_REMOTE_HOST))
1015         {
1016             msg(M_WARN, "%s Cannot read current default gateway from system", err);
1017         }
1018         else
1019         {
1020 #ifndef TARGET_ANDROID
1021             if (rl->flags & RG_AUTO_LOCAL)
1022             {
1023                 const int tla = rl->spec.remote_host_local;
1024                 if (tla == TLA_NONLOCAL)
1025                 {
1026                     dmsg(D_ROUTE, "ROUTE remote_host is NOT LOCAL");
1027                     local = false;
1028                 }
1029                 else if (tla == TLA_LOCAL)
1030                 {
1031                     dmsg(D_ROUTE, "ROUTE remote_host is LOCAL");
1032                     local = true;
1033                 }
1034             }
1035             if (!local)
1036             {
1037                 /* route remote host to original default gateway */
1038                 /* if remote_host is not ipv4 (ie: ipv6), just skip
1039                  * adding this special /32 route */
1040                 if ((rl->spec.flags & RTSA_REMOTE_HOST)
1041                     && rl->spec.remote_host != IPV4_INVALID_ADDR)
1042                 {
1043                     add_route3(rl->spec.remote_host,
1044                                IPV4_NETMASK_HOST,
1045                                rl->rgi.gateway.addr,
1046                                tt,
1047                                flags | ROUTE_REF_GW,
1048                                &rl->rgi,
1049                                es,
1050                                ctx);
1051                     rl->iflags |= RL_DID_LOCAL;
1052                 }
1053                 else
1054                 {
1055                     dmsg(D_ROUTE, "ROUTE remote_host protocol differs from tunneled");
1056                 }
1057             }
1058 #endif /* ifndef TARGET_ANDROID */
1059 
1060             /* route DHCP/DNS server traffic through original default gateway */
1061             add_bypass_routes(&rl->spec.bypass, rl->rgi.gateway.addr, tt, flags,
1062                               &rl->rgi, es, ctx);
1063 
1064             if (rl->flags & RG_REROUTE_GW)
1065             {
1066                 if (rl->flags & RG_DEF1)
1067                 {
1068                     /* add new default route (1st component) */
1069                     add_route3(0x00000000,
1070                                0x80000000,
1071                                rl->spec.remote_endpoint,
1072                                tt,
1073                                flags,
1074                                &rl->rgi,
1075                                es,
1076                                ctx);
1077 
1078                     /* add new default route (2nd component) */
1079                     add_route3(0x80000000,
1080                                0x80000000,
1081                                rl->spec.remote_endpoint,
1082                                tt,
1083                                flags,
1084                                &rl->rgi,
1085                                es,
1086                                ctx);
1087                 }
1088                 else
1089                 {
1090                     /* don't try to remove the def route if it does not exist */
1091                     if (rl->rgi.flags & RGI_ADDR_DEFINED)
1092                     {
1093                         /* delete default route */
1094                         del_route3(0, 0, rl->rgi.gateway.addr, tt,
1095                                    flags | ROUTE_REF_GW, &rl->rgi, es, ctx);
1096                     }
1097 
1098                     /* add new default route */
1099                     add_route3(0,
1100                                0,
1101                                rl->spec.remote_endpoint,
1102                                tt,
1103                                flags,
1104                                &rl->rgi,
1105                                es,
1106                                ctx);
1107                 }
1108             }
1109 
1110             /* set a flag so we can undo later */
1111             rl->iflags |= RL_DID_REDIRECT_DEFAULT_GATEWAY;
1112         }
1113     }
1114 }
1115 
1116 static void
undo_redirect_default_route_to_vpn(struct route_list * rl,const struct tuntap * tt,unsigned int flags,const struct env_set * es,openvpn_net_ctx_t * ctx)1117 undo_redirect_default_route_to_vpn(struct route_list *rl,
1118                                    const struct tuntap *tt, unsigned int flags,
1119                                    const struct env_set *es,
1120                                    openvpn_net_ctx_t *ctx)
1121 {
1122     if (rl && rl->iflags & RL_DID_REDIRECT_DEFAULT_GATEWAY)
1123     {
1124         /* delete remote host route */
1125         if (rl->iflags & RL_DID_LOCAL)
1126         {
1127             del_route3(rl->spec.remote_host,
1128                        IPV4_NETMASK_HOST,
1129                        rl->rgi.gateway.addr,
1130                        tt,
1131                        flags | ROUTE_REF_GW,
1132                        &rl->rgi,
1133                        es,
1134                        ctx);
1135             rl->iflags &= ~RL_DID_LOCAL;
1136         }
1137 
1138         /* delete special DHCP/DNS bypass route */
1139         del_bypass_routes(&rl->spec.bypass, rl->rgi.gateway.addr, tt, flags,
1140                           &rl->rgi, es, ctx);
1141 
1142         if (rl->flags & RG_REROUTE_GW)
1143         {
1144             if (rl->flags & RG_DEF1)
1145             {
1146                 /* delete default route (1st component) */
1147                 del_route3(0x00000000,
1148                            0x80000000,
1149                            rl->spec.remote_endpoint,
1150                            tt,
1151                            flags,
1152                            &rl->rgi,
1153                            es,
1154                            ctx);
1155 
1156                 /* delete default route (2nd component) */
1157                 del_route3(0x80000000,
1158                            0x80000000,
1159                            rl->spec.remote_endpoint,
1160                            tt,
1161                            flags,
1162                            &rl->rgi,
1163                            es,
1164                            ctx);
1165             }
1166             else
1167             {
1168                 /* delete default route */
1169                 del_route3(0,
1170                            0,
1171                            rl->spec.remote_endpoint,
1172                            tt,
1173                            flags,
1174                            &rl->rgi,
1175                            es,
1176                            ctx);
1177                 /* restore original default route if there was any */
1178                 if (rl->rgi.flags & RGI_ADDR_DEFINED)
1179                 {
1180                     add_route3(0, 0, rl->rgi.gateway.addr, tt,
1181                                flags | ROUTE_REF_GW, &rl->rgi, es, ctx);
1182                 }
1183             }
1184         }
1185 
1186         rl->iflags &= ~RL_DID_REDIRECT_DEFAULT_GATEWAY;
1187     }
1188 }
1189 
1190 void
add_routes(struct route_list * rl,struct route_ipv6_list * rl6,const struct tuntap * tt,unsigned int flags,const struct env_set * es,openvpn_net_ctx_t * ctx)1191 add_routes(struct route_list *rl, struct route_ipv6_list *rl6,
1192            const struct tuntap *tt, unsigned int flags,
1193            const struct env_set *es, openvpn_net_ctx_t *ctx)
1194 {
1195     redirect_default_route_to_vpn(rl, tt, flags, es, ctx);
1196     if (rl && !(rl->iflags & RL_ROUTES_ADDED) )
1197     {
1198         struct route_ipv4 *r;
1199 
1200         if (rl->routes && !tt->did_ifconfig_setup)
1201         {
1202             msg(M_INFO, "WARNING: OpenVPN was configured to add an IPv4 "
1203                 "route. However, no IPv4 has been configured for %s, "
1204                 "therefore the route installation may fail or may not work "
1205                 "as expected.", tt->actual_name);
1206         }
1207 
1208 #ifdef ENABLE_MANAGEMENT
1209         if (management && rl->routes)
1210         {
1211             management_set_state(management,
1212                                  OPENVPN_STATE_ADD_ROUTES,
1213                                  NULL,
1214                                  NULL,
1215                                  NULL,
1216                                  NULL,
1217                                  NULL);
1218         }
1219 #endif
1220 
1221         for (r = rl->routes; r; r = r->next)
1222         {
1223             check_subnet_conflict(r->network, r->netmask, "route");
1224             if (flags & ROUTE_DELETE_FIRST)
1225             {
1226                 delete_route(r, tt, flags, &rl->rgi, es, ctx);
1227             }
1228             add_route(r, tt, flags, &rl->rgi, es, ctx);
1229         }
1230         rl->iflags |= RL_ROUTES_ADDED;
1231     }
1232     if (rl6 && !(rl6->iflags & RL_ROUTES_ADDED) )
1233     {
1234         struct route_ipv6 *r;
1235 
1236         if (!tt->did_ifconfig_ipv6_setup)
1237         {
1238             msg(M_INFO, "WARNING: OpenVPN was configured to add an IPv6 "
1239                 "route. However, no IPv6 has been configured for %s, "
1240                 "therefore the route installation may fail or may not work "
1241                 "as expected.", tt->actual_name);
1242         }
1243 
1244         for (r = rl6->routes_ipv6; r; r = r->next)
1245         {
1246             if (flags & ROUTE_DELETE_FIRST)
1247             {
1248                 delete_route_ipv6(r, tt, flags, es, ctx);
1249             }
1250             add_route_ipv6(r, tt, flags, es, ctx);
1251         }
1252         rl6->iflags |= RL_ROUTES_ADDED;
1253     }
1254 }
1255 
1256 void
delete_routes(struct route_list * rl,struct route_ipv6_list * rl6,const struct tuntap * tt,unsigned int flags,const struct env_set * es,openvpn_net_ctx_t * ctx)1257 delete_routes(struct route_list *rl, struct route_ipv6_list *rl6,
1258               const struct tuntap *tt, unsigned int flags,
1259               const struct env_set *es, openvpn_net_ctx_t *ctx)
1260 {
1261     if (rl && rl->iflags & RL_ROUTES_ADDED)
1262     {
1263         struct route_ipv4 *r;
1264         for (r = rl->routes; r; r = r->next)
1265         {
1266             delete_route(r, tt, flags, &rl->rgi, es, ctx);
1267         }
1268         rl->iflags &= ~RL_ROUTES_ADDED;
1269     }
1270 
1271     undo_redirect_default_route_to_vpn(rl, tt, flags, es, ctx);
1272 
1273     if (rl)
1274     {
1275         clear_route_list(rl);
1276     }
1277 
1278     if (rl6 && (rl6->iflags & RL_ROUTES_ADDED) )
1279     {
1280         struct route_ipv6 *r6;
1281         for (r6 = rl6->routes_ipv6; r6; r6 = r6->next)
1282         {
1283             delete_route_ipv6(r6, tt, flags, es, ctx);
1284         }
1285         rl6->iflags &= ~RL_ROUTES_ADDED;
1286     }
1287 
1288     if (rl6)
1289     {
1290         clear_route_ipv6_list(rl6);
1291     }
1292 }
1293 
1294 #ifndef ENABLE_SMALL
1295 
1296 static const char *
show_opt(const char * option)1297 show_opt(const char *option)
1298 {
1299     if (!option)
1300     {
1301         return "default (not set)";
1302     }
1303     else
1304     {
1305         return option;
1306     }
1307 }
1308 
1309 static void
print_route_option(const struct route_option * ro,int level)1310 print_route_option(const struct route_option *ro, int level)
1311 {
1312     msg(level, "  route %s/%s/%s/%s",
1313         show_opt(ro->network),
1314         show_opt(ro->netmask),
1315         show_opt(ro->gateway),
1316         show_opt(ro->metric));
1317 }
1318 
1319 void
print_route_options(const struct route_option_list * rol,int level)1320 print_route_options(const struct route_option_list *rol,
1321                     int level)
1322 {
1323     struct route_option *ro;
1324     if (rol->flags & RG_ENABLE)
1325     {
1326         msg(level, "  [redirect_default_gateway local=%d]",
1327             (rol->flags & RG_LOCAL) != 0);
1328     }
1329     for (ro = rol->routes; ro; ro = ro->next)
1330     {
1331         print_route_option(ro, level);
1332     }
1333 }
1334 
1335 void
print_default_gateway(const int msglevel,const struct route_gateway_info * rgi,const struct route_ipv6_gateway_info * rgi6)1336 print_default_gateway(const int msglevel,
1337                       const struct route_gateway_info *rgi,
1338                       const struct route_ipv6_gateway_info *rgi6)
1339 {
1340     struct gc_arena gc = gc_new();
1341     if (rgi && (rgi->flags & RGI_ADDR_DEFINED))
1342     {
1343         struct buffer out = alloc_buf_gc(256, &gc);
1344         buf_printf(&out, "ROUTE_GATEWAY");
1345         if (rgi->flags & RGI_ON_LINK)
1346         {
1347             buf_printf(&out, " ON_LINK");
1348         }
1349         else
1350         {
1351             buf_printf(&out, " %s", print_in_addr_t(rgi->gateway.addr, 0, &gc));
1352         }
1353         if (rgi->flags & RGI_NETMASK_DEFINED)
1354         {
1355             buf_printf(&out, "/%s", print_in_addr_t(rgi->gateway.netmask, 0, &gc));
1356         }
1357 #ifdef _WIN32
1358         if (rgi->flags & RGI_IFACE_DEFINED)
1359         {
1360             buf_printf(&out, " I=%lu", rgi->adapter_index);
1361         }
1362 #else
1363         if (rgi->flags & RGI_IFACE_DEFINED)
1364         {
1365             buf_printf(&out, " IFACE=%s", rgi->iface);
1366         }
1367 #endif
1368         if (rgi->flags & RGI_HWADDR_DEFINED)
1369         {
1370             buf_printf(&out, " HWADDR=%s", format_hex_ex(rgi->hwaddr, 6, 0, 1, ":", &gc));
1371         }
1372         msg(msglevel, "%s", BSTR(&out));
1373     }
1374 
1375     if (rgi6 && (rgi6->flags & RGI_ADDR_DEFINED))
1376     {
1377         struct buffer out = alloc_buf_gc(256, &gc);
1378         buf_printf(&out, "ROUTE6_GATEWAY");
1379         buf_printf(&out, " %s", print_in6_addr(rgi6->gateway.addr_ipv6, 0, &gc));
1380         if (rgi6->flags & RGI_ON_LINK)
1381         {
1382             buf_printf(&out, " ON_LINK");
1383         }
1384         if (rgi6->flags & RGI_NETMASK_DEFINED)
1385         {
1386             buf_printf(&out, "/%d", rgi6->gateway.netbits_ipv6);
1387         }
1388 #ifdef _WIN32
1389         if (rgi6->flags & RGI_IFACE_DEFINED)
1390         {
1391             buf_printf(&out, " I=%lu", rgi6->adapter_index);
1392         }
1393 #else
1394         if (rgi6->flags & RGI_IFACE_DEFINED)
1395         {
1396             buf_printf(&out, " IFACE=%s", rgi6->iface);
1397         }
1398 #endif
1399         if (rgi6->flags & RGI_HWADDR_DEFINED)
1400         {
1401             buf_printf(&out, " HWADDR=%s", format_hex_ex(rgi6->hwaddr, 6, 0, 1, ":", &gc));
1402         }
1403         msg(msglevel, "%s", BSTR(&out));
1404     }
1405     gc_free(&gc);
1406 }
1407 
1408 #endif /* ifndef ENABLE_SMALL */
1409 
1410 static void
print_route(const struct route_ipv4 * r,int level)1411 print_route(const struct route_ipv4 *r, int level)
1412 {
1413     struct gc_arena gc = gc_new();
1414     if (r->flags & RT_DEFINED)
1415     {
1416         msg(level, "%s", route_string(r, &gc));
1417     }
1418     gc_free(&gc);
1419 }
1420 
1421 void
print_routes(const struct route_list * rl,int level)1422 print_routes(const struct route_list *rl, int level)
1423 {
1424     struct route_ipv4 *r;
1425     for (r = rl->routes; r; r = r->next)
1426     {
1427         print_route(r, level);
1428     }
1429 }
1430 
1431 static void
setenv_route(struct env_set * es,const struct route_ipv4 * r,int i)1432 setenv_route(struct env_set *es, const struct route_ipv4 *r, int i)
1433 {
1434     struct gc_arena gc = gc_new();
1435     if (r->flags & RT_DEFINED)
1436     {
1437         setenv_route_addr(es, "network", r->network, i);
1438         setenv_route_addr(es, "netmask", r->netmask, i);
1439         setenv_route_addr(es, "gateway", r->gateway, i);
1440 
1441         if (r->flags & RT_METRIC_DEFINED)
1442         {
1443             struct buffer name = alloc_buf_gc(256, &gc);
1444             buf_printf(&name, "route_metric_%d", i);
1445             setenv_int(es, BSTR(&name), r->metric);
1446         }
1447     }
1448     gc_free(&gc);
1449 }
1450 
1451 void
setenv_routes(struct env_set * es,const struct route_list * rl)1452 setenv_routes(struct env_set *es, const struct route_list *rl)
1453 {
1454     int i = 1;
1455     struct route_ipv4 *r;
1456     for (r = rl->routes; r; r = r->next)
1457     {
1458         setenv_route(es, r, i++);
1459     }
1460 }
1461 
1462 static void
setenv_route_ipv6(struct env_set * es,const struct route_ipv6 * r6,int i)1463 setenv_route_ipv6(struct env_set *es, const struct route_ipv6 *r6, int i)
1464 {
1465     struct gc_arena gc = gc_new();
1466     if (r6->flags & RT_DEFINED)
1467     {
1468         struct buffer name1 = alloc_buf_gc( 256, &gc );
1469         struct buffer val = alloc_buf_gc( 256, &gc );
1470         struct buffer name2 = alloc_buf_gc( 256, &gc );
1471 
1472         buf_printf( &name1, "route_ipv6_network_%d", i );
1473         buf_printf( &val, "%s/%d", print_in6_addr( r6->network, 0, &gc ),
1474                     r6->netbits );
1475         setenv_str( es, BSTR(&name1), BSTR(&val) );
1476 
1477         buf_printf( &name2, "route_ipv6_gateway_%d", i );
1478         setenv_str( es, BSTR(&name2), print_in6_addr( r6->gateway, 0, &gc ));
1479 
1480         if (r6->flags & RT_METRIC_DEFINED)
1481         {
1482             struct buffer name3 = alloc_buf_gc( 256, &gc );
1483             buf_printf( &name3, "route_ipv6_metric_%d", i) ;
1484             setenv_int( es, BSTR(&name3), r6->metric);
1485         }
1486     }
1487     gc_free(&gc);
1488 }
1489 void
setenv_routes_ipv6(struct env_set * es,const struct route_ipv6_list * rl6)1490 setenv_routes_ipv6(struct env_set *es, const struct route_ipv6_list *rl6)
1491 {
1492     int i = 1;
1493     struct route_ipv6 *r6;
1494     for (r6 = rl6->routes_ipv6; r6; r6 = r6->next)
1495     {
1496         setenv_route_ipv6(es, r6, i++);
1497     }
1498 }
1499 
1500 /*
1501  * local_route() determines whether the gateway of a provided host
1502  * route is on the same interface that owns the default gateway.
1503  * It uses the data structure
1504  * returned by get_default_gateway() (struct route_gateway_info)
1505  * to determine this.  If the route is local, LR_MATCH is returned.
1506  * When adding routes into the kernel, if LR_MATCH is defined for
1507  * a given route, the route should explicitly reference the default
1508  * gateway interface as the route destination.  For example, here
1509  * is an example on Linux that uses LR_MATCH:
1510  *
1511  *   route add -net 10.10.0.1 netmask 255.255.255.255 dev eth0
1512  *
1513  * This capability is needed by the "default-gateway block-local"
1514  * directive, to allow client access to the local subnet to be
1515  * blocked but still allow access to the local default gateway.
1516  */
1517 
1518 /* local_route() return values */
1519 #define LR_NOMATCH 0 /* route is not local */
1520 #define LR_MATCH   1 /* route is local */
1521 #define LR_ERROR   2 /* caller should abort adding route */
1522 
1523 static int
local_route(in_addr_t network,in_addr_t netmask,in_addr_t gateway,const struct route_gateway_info * rgi)1524 local_route(in_addr_t network,
1525             in_addr_t netmask,
1526             in_addr_t gateway,
1527             const struct route_gateway_info *rgi)
1528 {
1529     /* set LR_MATCH on local host routes */
1530     const int rgi_needed = (RGI_ADDR_DEFINED|RGI_NETMASK_DEFINED|RGI_IFACE_DEFINED);
1531     if (rgi
1532         && (rgi->flags & rgi_needed) == rgi_needed
1533         && gateway == rgi->gateway.addr
1534         && netmask == 0xFFFFFFFF)
1535     {
1536         if (((network ^  rgi->gateway.addr) & rgi->gateway.netmask) == 0)
1537         {
1538             return LR_MATCH;
1539         }
1540         else
1541         {
1542             /* examine additional subnets on gateway interface */
1543             size_t i;
1544             for (i = 0; i < rgi->n_addrs; ++i)
1545             {
1546                 const struct route_gateway_address *gwa = &rgi->addrs[i];
1547                 if (((network ^ gwa->addr) & gwa->netmask) == 0)
1548                 {
1549                     return LR_MATCH;
1550                 }
1551             }
1552         }
1553     }
1554     return LR_NOMATCH;
1555 }
1556 
1557 /* Return true if the "on-link" form of the route should be used.  This is when the gateway for a
1558  * a route is specified as an interface rather than an address. */
1559 static inline bool
is_on_link(const int is_local_route,const unsigned int flags,const struct route_gateway_info * rgi)1560 is_on_link(const int is_local_route, const unsigned int flags, const struct route_gateway_info *rgi)
1561 {
1562     return rgi && (is_local_route == LR_MATCH || ((flags & ROUTE_REF_GW) && (rgi->flags & RGI_ON_LINK)));
1563 }
1564 
1565 void
add_route(struct route_ipv4 * r,const struct tuntap * tt,unsigned int flags,const struct route_gateway_info * rgi,const struct env_set * es,openvpn_net_ctx_t * ctx)1566 add_route(struct route_ipv4 *r,
1567           const struct tuntap *tt,
1568           unsigned int flags,
1569           const struct route_gateway_info *rgi,  /* may be NULL */
1570           const struct env_set *es,
1571           openvpn_net_ctx_t *ctx)
1572 {
1573     struct gc_arena gc;
1574     struct argv argv = argv_new();
1575 #if !defined(TARGET_LINUX)
1576     const char *network;
1577 #if !defined(TARGET_AIX)
1578     const char *netmask;
1579 #endif
1580     const char *gateway;
1581 #endif
1582     bool status = false;
1583     int is_local_route;
1584 
1585     if (!(r->flags & RT_DEFINED))
1586     {
1587         return;
1588     }
1589 
1590     gc_init(&gc);
1591 
1592 #if !defined(TARGET_LINUX)
1593     network = print_in_addr_t(r->network, 0, &gc);
1594 #if !defined(TARGET_AIX)
1595     netmask = print_in_addr_t(r->netmask, 0, &gc);
1596 #endif
1597     gateway = print_in_addr_t(r->gateway, 0, &gc);
1598 #endif
1599 
1600     is_local_route = local_route(r->network, r->netmask, r->gateway, rgi);
1601     if (is_local_route == LR_ERROR)
1602     {
1603         goto done;
1604     }
1605 
1606 #if defined(TARGET_LINUX)
1607     const char *iface = NULL;
1608     int metric = -1;
1609 
1610     if (is_on_link(is_local_route, flags, rgi))
1611     {
1612         iface = rgi->iface;
1613     }
1614 
1615     if (r->flags & RT_METRIC_DEFINED)
1616     {
1617         metric = r->metric;
1618     }
1619 
1620     status = true;
1621     if (net_route_v4_add(ctx, &r->network, netmask_to_netbits2(r->netmask),
1622                          &r->gateway, iface, 0, metric) < 0)
1623     {
1624         msg(M_WARN, "ERROR: Linux route add command failed");
1625         status = false;
1626     }
1627 
1628 #elif defined (TARGET_ANDROID)
1629     char out[128];
1630 
1631     if (rgi)
1632     {
1633         openvpn_snprintf(out, sizeof(out), "%s %s %s dev %s", network, netmask, gateway, rgi->iface);
1634     }
1635     else
1636     {
1637         openvpn_snprintf(out, sizeof(out), "%s %s %s", network, netmask, gateway);
1638     }
1639     management_android_control(management, "ROUTE", out);
1640 
1641 #elif defined (_WIN32)
1642     {
1643         DWORD ai = TUN_ADAPTER_INDEX_INVALID;
1644         argv_printf(&argv, "%s%s ADD %s MASK %s %s",
1645                     get_win_sys_path(),
1646                     WIN_ROUTE_PATH_SUFFIX,
1647                     network,
1648                     netmask,
1649                     gateway);
1650         if (r->flags & RT_METRIC_DEFINED)
1651         {
1652             argv_printf_cat(&argv, "METRIC %d", r->metric);
1653         }
1654         if (is_on_link(is_local_route, flags, rgi))
1655         {
1656             ai = rgi->adapter_index;
1657             argv_printf_cat(&argv, "IF %lu", ai);
1658         }
1659 
1660         argv_msg(D_ROUTE, &argv);
1661 
1662         if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_SERVICE)
1663         {
1664             status = add_route_service(r, tt);
1665             msg(D_ROUTE, "Route addition via service %s", status ? "succeeded" : "failed");
1666         }
1667         else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_IPAPI)
1668         {
1669             status = add_route_ipapi(r, tt, ai);
1670             msg(D_ROUTE, "Route addition via IPAPI %s", status ? "succeeded" : "failed");
1671         }
1672         else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_EXE)
1673         {
1674             netcmd_semaphore_lock();
1675             status = openvpn_execve_check(&argv, es, 0, "ERROR: Windows route add command failed");
1676             netcmd_semaphore_release();
1677         }
1678         else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_ADAPTIVE)
1679         {
1680             status = add_route_ipapi(r, tt, ai);
1681             msg(D_ROUTE, "Route addition via IPAPI %s [adaptive]", status ? "succeeded" : "failed");
1682             if (!status)
1683             {
1684                 msg(D_ROUTE, "Route addition fallback to route.exe");
1685                 netcmd_semaphore_lock();
1686                 status = openvpn_execve_check(&argv, es, 0, "ERROR: Windows route add command failed [adaptive]");
1687                 netcmd_semaphore_release();
1688             }
1689         }
1690         else
1691         {
1692             ASSERT(0);
1693         }
1694     }
1695 
1696 #elif defined (TARGET_SOLARIS)
1697 
1698     /* example: route add 192.0.2.32 -netmask 255.255.255.224 somegateway */
1699 
1700     argv_printf(&argv, "%s add",
1701                 ROUTE_PATH);
1702 
1703     argv_printf_cat(&argv, "%s -netmask %s %s",
1704                     network,
1705                     netmask,
1706                     gateway);
1707 
1708     /* Solaris can only distinguish between "metric 0" == "on-link on the
1709      * interface where the IP address given is configured" and "metric > 0"
1710      * == "use gateway specified" (no finer-grained route metrics available)
1711      *
1712      * More recent versions of Solaris can also do "-interface", but that
1713      * would break backwards compatibility with older versions for no gain.
1714      */
1715     if (r->flags & RT_METRIC_DEFINED)
1716     {
1717         argv_printf_cat(&argv, "%d", r->metric);
1718     }
1719 
1720     argv_msg(D_ROUTE, &argv);
1721     status = openvpn_execve_check(&argv, es, 0, "ERROR: Solaris route add command failed");
1722 
1723 #elif defined(TARGET_FREEBSD)
1724 
1725     argv_printf(&argv, "%s add",
1726                 ROUTE_PATH);
1727 
1728 #if 0
1729     if (r->flags & RT_METRIC_DEFINED)
1730     {
1731         argv_printf_cat(&argv, "-rtt %d", r->metric);
1732     }
1733 #endif
1734 
1735     argv_printf_cat(&argv, "-net %s %s %s",
1736                     network,
1737                     gateway,
1738                     netmask);
1739 
1740     /* FIXME -- add on-link support for FreeBSD */
1741 
1742     argv_msg(D_ROUTE, &argv);
1743     status = openvpn_execve_check(&argv, es, 0, "ERROR: FreeBSD route add command failed");
1744 
1745 #elif defined(TARGET_DRAGONFLY)
1746 
1747     argv_printf(&argv, "%s add",
1748                 ROUTE_PATH);
1749 
1750 #if 0
1751     if (r->flags & RT_METRIC_DEFINED)
1752     {
1753         argv_printf_cat(&argv, "-rtt %d", r->metric);
1754     }
1755 #endif
1756 
1757     argv_printf_cat(&argv, "-net %s %s %s",
1758                     network,
1759                     gateway,
1760                     netmask);
1761 
1762     /* FIXME -- add on-link support for Dragonfly */
1763 
1764     argv_msg(D_ROUTE, &argv);
1765     status = openvpn_execve_check(&argv, es, 0, "ERROR: DragonFly route add command failed");
1766 
1767 #elif defined(TARGET_DARWIN)
1768 
1769     argv_printf(&argv, "%s add",
1770                 ROUTE_PATH);
1771 
1772 #if 0
1773     if (r->flags & RT_METRIC_DEFINED)
1774     {
1775         argv_printf_cat(&argv, "-rtt %d", r->metric);
1776     }
1777 #endif
1778 
1779     if (is_on_link(is_local_route, flags, rgi))
1780     {
1781         /* Mac OS X route syntax for ON_LINK:
1782          * route add -cloning -net 10.10.0.1 -netmask 255.255.255.255 -interface en0 */
1783         argv_printf_cat(&argv, "-cloning -net %s -netmask %s -interface %s",
1784                         network,
1785                         netmask,
1786                         rgi->iface);
1787     }
1788     else
1789     {
1790         argv_printf_cat(&argv, "-net %s %s %s",
1791                         network,
1792                         gateway,
1793                         netmask);
1794     }
1795 
1796     argv_msg(D_ROUTE, &argv);
1797     status = openvpn_execve_check(&argv, es, 0, "ERROR: OS X route add command failed");
1798 
1799 #elif defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
1800 
1801     argv_printf(&argv, "%s add",
1802                 ROUTE_PATH);
1803 
1804 #if 0
1805     if (r->flags & RT_METRIC_DEFINED)
1806     {
1807         argv_printf_cat(&argv, "-rtt %d", r->metric);
1808     }
1809 #endif
1810 
1811     argv_printf_cat(&argv, "-net %s %s -netmask %s",
1812                     network,
1813                     gateway,
1814                     netmask);
1815 
1816     /* FIXME -- add on-link support for OpenBSD/NetBSD */
1817 
1818     argv_msg(D_ROUTE, &argv);
1819     status = openvpn_execve_check(&argv, es, 0, "ERROR: OpenBSD/NetBSD route add command failed");
1820 
1821 #elif defined(TARGET_AIX)
1822 
1823     {
1824         int netbits = netmask_to_netbits2(r->netmask);
1825         argv_printf(&argv, "%s add -net %s/%d %s",
1826                     ROUTE_PATH,
1827                     network, netbits, gateway);
1828         argv_msg(D_ROUTE, &argv);
1829         status = openvpn_execve_check(&argv, es, 0, "ERROR: AIX route add command failed");
1830     }
1831 
1832 #else  /* if defined(TARGET_LINUX) */
1833     msg(M_FATAL, "Sorry, but I don't know how to do 'route' commands on this operating system.  Try putting your routes in a --route-up script");
1834 #endif /* if defined(TARGET_LINUX) */
1835 
1836 done:
1837     if (status)
1838     {
1839         r->flags |= RT_ADDED;
1840     }
1841     else
1842     {
1843         r->flags &= ~RT_ADDED;
1844     }
1845     argv_free(&argv);
1846     gc_free(&gc);
1847     /* release resources potentially allocated during route setup */
1848     net_ctx_reset(ctx);
1849 }
1850 
1851 
1852 void
route_ipv6_clear_host_bits(struct route_ipv6 * r6)1853 route_ipv6_clear_host_bits( struct route_ipv6 *r6 )
1854 {
1855     /* clear host bit parts of route
1856      * (needed if routes are specified improperly, or if we need to
1857      * explicitly setup/clear the "connected" network routes on some OSes)
1858      */
1859     int byte = 15;
1860     int bits_to_clear = 128 - r6->netbits;
1861 
1862     while (byte >= 0 && bits_to_clear > 0)
1863     {
1864         if (bits_to_clear >= 8)
1865         {
1866             r6->network.s6_addr[byte--] = 0; bits_to_clear -= 8;
1867         }
1868         else
1869         {
1870             r6->network.s6_addr[byte--] &= (0xff << bits_to_clear); bits_to_clear = 0;
1871         }
1872     }
1873 }
1874 
1875 void
add_route_ipv6(struct route_ipv6 * r6,const struct tuntap * tt,unsigned int flags,const struct env_set * es,openvpn_net_ctx_t * ctx)1876 add_route_ipv6(struct route_ipv6 *r6, const struct tuntap *tt,
1877                unsigned int flags, const struct env_set *es,
1878                openvpn_net_ctx_t *ctx)
1879 {
1880     struct gc_arena gc;
1881     struct argv argv = argv_new();
1882 
1883     const char *network;
1884     const char *gateway;
1885     bool status = false;
1886     const char *device = tt->actual_name;
1887 #if defined(TARGET_LINUX)
1888     int metric;
1889 #endif
1890     bool gateway_needed = false;
1891 
1892     if (!(r6->flags & RT_DEFINED) )
1893     {
1894         return;
1895     }
1896 
1897 #ifndef _WIN32
1898     if (r6->iface != NULL)              /* vpn server special route */
1899     {
1900         device = r6->iface;
1901         if (!IN6_IS_ADDR_UNSPECIFIED(&r6->gateway) )
1902         {
1903             gateway_needed = true;
1904         }
1905     }
1906 #endif
1907 
1908     gc_init(&gc);
1909 
1910     route_ipv6_clear_host_bits(r6);
1911 
1912     network = print_in6_addr( r6->network, 0, &gc);
1913     gateway = print_in6_addr( r6->gateway, 0, &gc);
1914 
1915 #if defined(TARGET_DARWIN)    \
1916     || defined(TARGET_FREEBSD) || defined(TARGET_DRAGONFLY)    \
1917     || defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
1918 
1919     /* the BSD platforms cannot specify gateway and interface independently,
1920      * but for link-local destinations, we MUST specify the interface, so
1921      * we build a combined "$gateway%$interface" gateway string
1922      */
1923     if (r6->iface != NULL && gateway_needed
1924         && IN6_IS_ADDR_LINKLOCAL(&r6->gateway) )        /* fe80::...%intf */
1925     {
1926         int len = strlen(gateway) + 1 + strlen(r6->iface)+1;
1927         char *tmp = gc_malloc( len, true, &gc );
1928         snprintf( tmp, len, "%s%%%s", gateway, r6->iface );
1929         gateway = tmp;
1930     }
1931 #endif
1932 
1933     msg( M_INFO, "add_route_ipv6(%s/%d -> %s metric %d) dev %s",
1934          network, r6->netbits, gateway, r6->metric, device );
1935 
1936     /*
1937      * Filter out routes which are essentially no-ops
1938      * (not currently done for IPv6)
1939      */
1940 
1941     /* On "tun" interface, we never set a gateway if the operating system
1942      * can do "route to interface" - it does not add value, as the target
1943      * dev already fully qualifies the route destination on point-to-point
1944      * interfaces.   OTOH, on "tap" interface, we must always set the
1945      * gateway unless the route is to be an on-link network
1946      */
1947     if (tt->type == DEV_TYPE_TAP
1948         && !( (r6->flags & RT_METRIC_DEFINED) && r6->metric == 0 ) )
1949     {
1950         gateway_needed = true;
1951     }
1952 
1953     if (gateway_needed && IN6_IS_ADDR_UNSPECIFIED(&r6->gateway))
1954     {
1955         msg(M_WARN, "ROUTE6 WARNING: " PACKAGE_NAME " needs a gateway "
1956             "parameter for a --route-ipv6 option and no default was set via "
1957             "--ifconfig-ipv6 or --route-ipv6-gateway option.  Not installing "
1958             "IPv6 route to %s/%d.", network, r6->netbits);
1959         status = false;
1960         goto done;
1961     }
1962 
1963 #if defined(TARGET_LINUX)
1964     metric = -1;
1965     if ((r6->flags & RT_METRIC_DEFINED) && (r6->metric > 0))
1966     {
1967         metric = r6->metric;
1968     }
1969 
1970     status = true;
1971     if (net_route_v6_add(ctx, &r6->network, r6->netbits,
1972                          gateway_needed ? &r6->gateway : NULL, device, 0,
1973                          metric) < 0)
1974     {
1975         msg(M_WARN, "ERROR: Linux IPv6 route can't be added");
1976         status = false;
1977     }
1978 
1979 #elif defined (TARGET_ANDROID)
1980     char out[64];
1981 
1982     openvpn_snprintf(out, sizeof(out), "%s/%d %s", network, r6->netbits, device);
1983 
1984     management_android_control(management, "ROUTE6", out);
1985 
1986 #elif defined (_WIN32)
1987 
1988     if (tt->options.msg_channel)
1989     {
1990         status = add_route_ipv6_service(r6, tt);
1991     }
1992     else
1993     {
1994         DWORD adapter_index;
1995         if (r6->adapter_index)          /* vpn server special route */
1996         {
1997             adapter_index = r6->adapter_index;
1998             gateway_needed = true;
1999         }
2000         else
2001         {
2002             adapter_index = tt->adapter_index;
2003         }
2004 
2005         /* netsh interface ipv6 add route 2001:db8::/32 42 */
2006         argv_printf(&argv, "%s%s interface ipv6 add route %s/%d %lu",
2007                     get_win_sys_path(),
2008                     NETSH_PATH_SUFFIX,
2009                     network,
2010                     r6->netbits,
2011                     adapter_index);
2012 
2013         /* next-hop depends on TUN or TAP mode:
2014          * - in TAP mode, we use the "real" next-hop
2015          * - in TUN mode we use a special-case link-local address that the tapdrvr
2016          *   knows about and will answer ND (neighbor discovery) packets for
2017          */
2018         if (tt->type == DEV_TYPE_TUN && !gateway_needed)
2019         {
2020             argv_printf_cat( &argv, " %s", "fe80::8" );
2021         }
2022         else if (!IN6_IS_ADDR_UNSPECIFIED(&r6->gateway) )
2023         {
2024             argv_printf_cat( &argv, " %s", gateway );
2025         }
2026 
2027 #if 0
2028         if (r6->flags & RT_METRIC_DEFINED)
2029         {
2030             argv_printf_cat(&argv, " METRIC %d", r->metric);
2031         }
2032 #endif
2033 
2034         /* in some versions of Windows, routes are persistent across reboots by
2035          * default, unless "store=active" is set (pointed out by Tony Lim, thanks)
2036          */
2037         argv_printf_cat( &argv, " store=active" );
2038 
2039         argv_msg(D_ROUTE, &argv);
2040 
2041         netcmd_semaphore_lock();
2042         status = openvpn_execve_check(&argv, es, 0, "ERROR: Windows route add ipv6 command failed");
2043         netcmd_semaphore_release();
2044     }
2045 
2046 #elif defined (TARGET_SOLARIS)
2047 
2048     /* example: route add -inet6 2001:db8::/32 somegateway 0 */
2049 
2050     /* for some reason, routes to tun/tap do not work for me unless I set
2051      * "metric 0" - otherwise, the routes will be nicely installed, but
2052      * packets will just disappear somewhere.  So we always use "0" now,
2053      * unless the route points to "gateway on other interface"...
2054      *
2055      * (Note: OpenSolaris can not specify host%interface gateways, so we just
2056      * use the GW addresses - it seems to still work for fe80:: addresses,
2057      * however this is done internally.  NUD maybe?)
2058      */
2059     argv_printf(&argv, "%s add -inet6 %s/%d %s",
2060                 ROUTE_PATH,
2061                 network,
2062                 r6->netbits,
2063                 gateway );
2064 
2065     /* on tun (not tap), not "elsewhere"? -> metric 0 */
2066     if (tt->type == DEV_TYPE_TUN && !r6->iface)
2067     {
2068         argv_printf_cat(&argv, "0");
2069     }
2070 
2071     argv_msg(D_ROUTE, &argv);
2072     status = openvpn_execve_check(&argv, es, 0, "ERROR: Solaris route add -inet6 command failed");
2073 
2074 #elif defined(TARGET_FREEBSD) || defined(TARGET_DRAGONFLY)
2075 
2076     argv_printf(&argv, "%s add -inet6 %s/%d",
2077                 ROUTE_PATH,
2078                 network,
2079                 r6->netbits);
2080 
2081     if (gateway_needed)
2082     {
2083         argv_printf_cat(&argv, "%s", gateway);
2084     }
2085     else
2086     {
2087         argv_printf_cat(&argv, "-iface %s", device);
2088     }
2089 
2090     argv_msg(D_ROUTE, &argv);
2091     status = openvpn_execve_check(&argv, es, 0, "ERROR: *BSD route add -inet6 command failed");
2092 
2093 #elif defined(TARGET_DARWIN)
2094 
2095     argv_printf(&argv, "%s add -inet6 %s -prefixlen %d",
2096                 ROUTE_PATH,
2097                 network, r6->netbits );
2098 
2099     if (gateway_needed)
2100     {
2101         argv_printf_cat(&argv, "%s", gateway);
2102     }
2103     else
2104     {
2105         argv_printf_cat(&argv, "-iface %s", device);
2106     }
2107 
2108     argv_msg(D_ROUTE, &argv);
2109     status = openvpn_execve_check(&argv, es, 0, "ERROR: MacOS X route add -inet6 command failed");
2110 
2111 #elif defined(TARGET_OPENBSD)
2112 
2113     argv_printf(&argv, "%s add -inet6 %s -prefixlen %d %s",
2114                 ROUTE_PATH,
2115                 network, r6->netbits, gateway );
2116 
2117     argv_msg(D_ROUTE, &argv);
2118     status = openvpn_execve_check(&argv, es, 0, "ERROR: OpenBSD route add -inet6 command failed");
2119 
2120 #elif defined(TARGET_NETBSD)
2121 
2122     argv_printf(&argv, "%s add -inet6 %s/%d %s",
2123                 ROUTE_PATH,
2124                 network, r6->netbits, gateway );
2125 
2126     argv_msg(D_ROUTE, &argv);
2127     status = openvpn_execve_check(&argv, es, 0, "ERROR: NetBSD route add -inet6 command failed");
2128 
2129 #elif defined(TARGET_AIX)
2130 
2131     argv_printf(&argv, "%s add -inet6 %s/%d %s",
2132                 ROUTE_PATH,
2133                 network, r6->netbits, gateway);
2134     argv_msg(D_ROUTE, &argv);
2135     status = openvpn_execve_check(&argv, es, 0, "ERROR: AIX route add command failed");
2136 
2137 #else  /* if defined(TARGET_LINUX) */
2138     msg(M_FATAL, "Sorry, but I don't know how to do 'route ipv6' commands on this operating system.  Try putting your routes in a --route-up script");
2139 #endif /* if defined(TARGET_LINUX) */
2140 
2141 done:
2142     if (status)
2143     {
2144         r6->flags |= RT_ADDED;
2145     }
2146     else
2147     {
2148         r6->flags &= ~RT_ADDED;
2149     }
2150     argv_free(&argv);
2151     gc_free(&gc);
2152     /* release resources potentially allocated during route setup */
2153     net_ctx_reset(ctx);
2154 }
2155 
2156 static void
delete_route(struct route_ipv4 * r,const struct tuntap * tt,unsigned int flags,const struct route_gateway_info * rgi,const struct env_set * es,openvpn_net_ctx_t * ctx)2157 delete_route(struct route_ipv4 *r,
2158              const struct tuntap *tt,
2159              unsigned int flags,
2160              const struct route_gateway_info *rgi,
2161              const struct env_set *es,
2162              openvpn_net_ctx_t *ctx)
2163 {
2164     struct gc_arena gc;
2165     struct argv argv = argv_new();
2166 #if !defined(TARGET_LINUX)
2167     const char *network;
2168 #if !defined(TARGET_AIX)
2169     const char *netmask;
2170 #endif
2171 #if !defined(TARGET_ANDROID)
2172     const char *gateway;
2173 #endif
2174 #else  /* if !defined(TARGET_LINUX) */
2175     int metric;
2176 #endif
2177     int is_local_route;
2178 
2179     if ((r->flags & (RT_DEFINED|RT_ADDED)) != (RT_DEFINED|RT_ADDED))
2180     {
2181         return;
2182     }
2183 
2184     gc_init(&gc);
2185 
2186 #if !defined(TARGET_LINUX)
2187     network = print_in_addr_t(r->network, 0, &gc);
2188 #if !defined(TARGET_AIX)
2189     netmask = print_in_addr_t(r->netmask, 0, &gc);
2190 #endif
2191 #if !defined(TARGET_ANDROID)
2192     gateway = print_in_addr_t(r->gateway, 0, &gc);
2193 #endif
2194 #endif
2195 
2196     is_local_route = local_route(r->network, r->netmask, r->gateway, rgi);
2197     if (is_local_route == LR_ERROR)
2198     {
2199         goto done;
2200     }
2201 
2202 #if defined(TARGET_LINUX)
2203     metric = -1;
2204     if (r->flags & RT_METRIC_DEFINED)
2205     {
2206         metric = r->metric;
2207     }
2208 
2209     if (net_route_v4_del(ctx, &r->network, netmask_to_netbits2(r->netmask),
2210                          &r->gateway, NULL, 0, metric) < 0)
2211     {
2212         msg(M_WARN, "ERROR: Linux route delete command failed");
2213     }
2214 #elif defined (_WIN32)
2215 
2216     argv_printf(&argv, "%s%s DELETE %s MASK %s %s",
2217                 get_win_sys_path(),
2218                 WIN_ROUTE_PATH_SUFFIX,
2219                 network,
2220                 netmask,
2221                 gateway);
2222 
2223     argv_msg(D_ROUTE, &argv);
2224 
2225     if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_SERVICE)
2226     {
2227         const bool status = del_route_service(r, tt);
2228         msg(D_ROUTE, "Route deletion via service %s", status ? "succeeded" : "failed");
2229     }
2230     else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_IPAPI)
2231     {
2232         const bool status = del_route_ipapi(r, tt);
2233         msg(D_ROUTE, "Route deletion via IPAPI %s", status ? "succeeded" : "failed");
2234     }
2235     else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_EXE)
2236     {
2237         netcmd_semaphore_lock();
2238         openvpn_execve_check(&argv, es, 0, "ERROR: Windows route delete command failed");
2239         netcmd_semaphore_release();
2240     }
2241     else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_ADAPTIVE)
2242     {
2243         const bool status = del_route_ipapi(r, tt);
2244         msg(D_ROUTE, "Route deletion via IPAPI %s [adaptive]", status ? "succeeded" : "failed");
2245         if (!status)
2246         {
2247             msg(D_ROUTE, "Route deletion fallback to route.exe");
2248             netcmd_semaphore_lock();
2249             openvpn_execve_check(&argv, es, 0, "ERROR: Windows route delete command failed [adaptive]");
2250             netcmd_semaphore_release();
2251         }
2252     }
2253     else
2254     {
2255         ASSERT(0);
2256     }
2257 
2258 #elif defined (TARGET_SOLARIS)
2259 
2260     argv_printf(&argv, "%s delete %s -netmask %s %s",
2261                 ROUTE_PATH,
2262                 network,
2263                 netmask,
2264                 gateway);
2265 
2266     argv_msg(D_ROUTE, &argv);
2267     openvpn_execve_check(&argv, es, 0, "ERROR: Solaris route delete command failed");
2268 
2269 #elif defined(TARGET_FREEBSD)
2270 
2271     argv_printf(&argv, "%s delete -net %s %s %s",
2272                 ROUTE_PATH,
2273                 network,
2274                 gateway,
2275                 netmask);
2276 
2277     argv_msg(D_ROUTE, &argv);
2278     openvpn_execve_check(&argv, es, 0, "ERROR: FreeBSD route delete command failed");
2279 
2280 #elif defined(TARGET_DRAGONFLY)
2281 
2282     argv_printf(&argv, "%s delete -net %s %s %s",
2283                 ROUTE_PATH,
2284                 network,
2285                 gateway,
2286                 netmask);
2287 
2288     argv_msg(D_ROUTE, &argv);
2289     openvpn_execve_check(&argv, es, 0, "ERROR: DragonFly route delete command failed");
2290 
2291 #elif defined(TARGET_DARWIN)
2292 
2293     if (is_on_link(is_local_route, flags, rgi))
2294     {
2295         argv_printf(&argv, "%s delete -cloning -net %s -netmask %s -interface %s",
2296                     ROUTE_PATH,
2297                     network,
2298                     netmask,
2299                     rgi->iface);
2300     }
2301     else
2302     {
2303         argv_printf(&argv, "%s delete -net %s %s %s",
2304                     ROUTE_PATH,
2305                     network,
2306                     gateway,
2307                     netmask);
2308     }
2309 
2310     argv_msg(D_ROUTE, &argv);
2311     openvpn_execve_check(&argv, es, 0, "ERROR: OS X route delete command failed");
2312 
2313 #elif defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
2314 
2315     argv_printf(&argv, "%s delete -net %s %s -netmask %s",
2316                 ROUTE_PATH,
2317                 network,
2318                 gateway,
2319                 netmask);
2320 
2321     argv_msg(D_ROUTE, &argv);
2322     openvpn_execve_check(&argv, es, 0, "ERROR: OpenBSD/NetBSD route delete command failed");
2323 
2324 #elif defined(TARGET_ANDROID)
2325     msg(M_NONFATAL, "Sorry, deleting routes on Android is not possible. The VpnService API allows routes to be set on connect only.");
2326 
2327 #elif defined(TARGET_AIX)
2328 
2329     {
2330         int netbits = netmask_to_netbits2(r->netmask);
2331         argv_printf(&argv, "%s delete -net %s/%d %s",
2332                     ROUTE_PATH,
2333                     network, netbits, gateway);
2334         argv_msg(D_ROUTE, &argv);
2335         openvpn_execve_check(&argv, es, 0, "ERROR: AIX route delete command failed");
2336     }
2337 
2338 #else  /* if defined(TARGET_LINUX) */
2339     msg(M_FATAL, "Sorry, but I don't know how to do 'route' commands on this operating system.  Try putting your routes in a --route-up script");
2340 #endif /* if defined(TARGET_LINUX) */
2341 
2342 done:
2343     r->flags &= ~RT_ADDED;
2344     argv_free(&argv);
2345     gc_free(&gc);
2346     /* release resources potentially allocated during route cleanup */
2347     net_ctx_reset(ctx);
2348 }
2349 
2350 void
delete_route_ipv6(const struct route_ipv6 * r6,const struct tuntap * tt,unsigned int flags,const struct env_set * es,openvpn_net_ctx_t * ctx)2351 delete_route_ipv6(const struct route_ipv6 *r6, const struct tuntap *tt,
2352                   unsigned int flags, const struct env_set *es,
2353                   openvpn_net_ctx_t *ctx)
2354 {
2355     struct gc_arena gc;
2356     struct argv argv = argv_new();
2357     const char *network;
2358 #if !defined(TARGET_LINUX)
2359     const char *gateway;
2360 #else
2361     int metric;
2362 #endif
2363     bool gateway_needed = false;
2364 
2365     if ((r6->flags & (RT_DEFINED|RT_ADDED)) != (RT_DEFINED|RT_ADDED))
2366     {
2367         return;
2368     }
2369 
2370 #ifndef _WIN32
2371     const char *device = tt->actual_name;
2372     if (r6->iface != NULL)              /* vpn server special route */
2373     {
2374         device = r6->iface;
2375         gateway_needed = true;
2376     }
2377 #endif
2378 
2379     gc_init(&gc);
2380 
2381     network = print_in6_addr( r6->network, 0, &gc);
2382 #if !defined(TARGET_LINUX)
2383     gateway = print_in6_addr( r6->gateway, 0, &gc);
2384 #endif
2385 
2386 #if defined(TARGET_DARWIN)    \
2387     || defined(TARGET_FREEBSD) || defined(TARGET_DRAGONFLY)    \
2388     || defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
2389 
2390     /* the BSD platforms cannot specify gateway and interface independently,
2391      * but for link-local destinations, we MUST specify the interface, so
2392      * we build a combined "$gateway%$interface" gateway string
2393      */
2394     if (r6->iface != NULL && gateway_needed
2395         && IN6_IS_ADDR_LINKLOCAL(&r6->gateway) )        /* fe80::...%intf */
2396     {
2397         int len = strlen(gateway) + 1 + strlen(r6->iface)+1;
2398         char *tmp = gc_malloc( len, true, &gc );
2399         snprintf( tmp, len, "%s%%%s", gateway, r6->iface );
2400         gateway = tmp;
2401     }
2402 #endif
2403 
2404     msg( M_INFO, "delete_route_ipv6(%s/%d)", network, r6->netbits );
2405 
2406     /* if we used a gateway on "add route", we also need to specify it on
2407      * delete, otherwise some OSes will refuse to delete the route
2408      */
2409     if (tt->type == DEV_TYPE_TAP
2410         && !( (r6->flags & RT_METRIC_DEFINED) && r6->metric == 0 ) )
2411     {
2412         gateway_needed = true;
2413     }
2414 
2415 #if defined(TARGET_LINUX)
2416     metric = -1;
2417     if ((r6->flags & RT_METRIC_DEFINED) && (r6->metric > 0))
2418     {
2419         metric = r6->metric;
2420     }
2421 
2422     if (net_route_v6_del(ctx, &r6->network, r6->netbits,
2423                          gateway_needed ? &r6->gateway : NULL, device, 0,
2424                          metric) < 0)
2425     {
2426         msg(M_WARN, "ERROR: Linux route v6 delete command failed");
2427     }
2428 
2429 #elif defined (_WIN32)
2430 
2431     if (tt->options.msg_channel)
2432     {
2433         del_route_ipv6_service(r6, tt);
2434     }
2435     else
2436     {
2437         DWORD adapter_index;
2438         if (r6->adapter_index)          /* vpn server special route */
2439         {
2440             adapter_index = r6->adapter_index;
2441             gateway_needed = true;
2442         }
2443         else
2444         {
2445             adapter_index = tt->adapter_index;
2446         }
2447 
2448         /* netsh interface ipv6 delete route 2001:db8::/32 42 */
2449         argv_printf(&argv, "%s%s interface ipv6 delete route %s/%d %lu",
2450                     get_win_sys_path(),
2451                     NETSH_PATH_SUFFIX,
2452                     network,
2453                     r6->netbits,
2454                     adapter_index);
2455 
2456         /* next-hop depends on TUN or TAP mode:
2457          * - in TAP mode, we use the "real" next-hop
2458          * - in TUN mode we use a special-case link-local address that the tapdrvr
2459          *   knows about and will answer ND (neighbor discovery) packets for
2460          * (and "route deletion without specifying next-hop" does not work...)
2461          */
2462         if (tt->type == DEV_TYPE_TUN && !gateway_needed)
2463         {
2464             argv_printf_cat( &argv, " %s", "fe80::8" );
2465         }
2466         else if (!IN6_IS_ADDR_UNSPECIFIED(&r6->gateway) )
2467         {
2468             argv_printf_cat( &argv, " %s", gateway );
2469         }
2470 
2471 #if 0
2472         if (r6->flags & RT_METRIC_DEFINED)
2473         {
2474             argv_printf_cat(&argv, "METRIC %d", r->metric);
2475         }
2476 #endif
2477 
2478         /* Windows XP to 7 "just delete" routes, wherever they came from, but
2479          * in Windows 8(.1?), if you create them with "store=active", this is
2480          * how you should delete them as well (pointed out by Cedric Tabary)
2481          */
2482         argv_printf_cat( &argv, " store=active" );
2483 
2484         argv_msg(D_ROUTE, &argv);
2485 
2486         netcmd_semaphore_lock();
2487         openvpn_execve_check(&argv, es, 0, "ERROR: Windows route delete ipv6 command failed");
2488         netcmd_semaphore_release();
2489     }
2490 
2491 #elif defined (TARGET_SOLARIS)
2492 
2493     /* example: route delete -inet6 2001:db8::/32 somegateway */
2494 
2495     argv_printf(&argv, "%s delete -inet6 %s/%d %s",
2496                 ROUTE_PATH,
2497                 network,
2498                 r6->netbits,
2499                 gateway );
2500 
2501     argv_msg(D_ROUTE, &argv);
2502     openvpn_execve_check(&argv, es, 0, "ERROR: Solaris route delete -inet6 command failed");
2503 
2504 #elif defined(TARGET_FREEBSD) || defined(TARGET_DRAGONFLY)
2505 
2506     argv_printf(&argv, "%s delete -inet6 %s/%d",
2507                 ROUTE_PATH,
2508                 network,
2509                 r6->netbits );
2510 
2511     if (gateway_needed)
2512     {
2513         argv_printf_cat(&argv, "%s", gateway);
2514     }
2515     else
2516     {
2517         argv_printf_cat(&argv, "-iface %s", device);
2518     }
2519 
2520     argv_msg(D_ROUTE, &argv);
2521     openvpn_execve_check(&argv, es, 0, "ERROR: *BSD route delete -inet6 command failed");
2522 
2523 #elif defined(TARGET_DARWIN)
2524 
2525     argv_printf(&argv, "%s delete -inet6 %s -prefixlen %d",
2526                 ROUTE_PATH,
2527                 network, r6->netbits );
2528 
2529     if (gateway_needed)
2530     {
2531         argv_printf_cat(&argv, "%s", gateway);
2532     }
2533     else
2534     {
2535         argv_printf_cat(&argv, "-iface %s", device);
2536     }
2537 
2538     argv_msg(D_ROUTE, &argv);
2539     openvpn_execve_check(&argv, es, 0, "ERROR: MacOS X route delete -inet6 command failed");
2540 
2541 #elif defined(TARGET_OPENBSD)
2542 
2543     argv_printf(&argv, "%s delete -inet6 %s -prefixlen %d %s",
2544                 ROUTE_PATH,
2545                 network, r6->netbits, gateway );
2546 
2547     argv_msg(D_ROUTE, &argv);
2548     openvpn_execve_check(&argv, es, 0, "ERROR: OpenBSD route delete -inet6 command failed");
2549 
2550 #elif defined(TARGET_NETBSD)
2551 
2552     argv_printf(&argv, "%s delete -inet6 %s/%d %s",
2553                 ROUTE_PATH,
2554                 network, r6->netbits, gateway );
2555 
2556     argv_msg(D_ROUTE, &argv);
2557     openvpn_execve_check(&argv, es, 0, "ERROR: NetBSD route delete -inet6 command failed");
2558 
2559 #elif defined(TARGET_AIX)
2560 
2561     argv_printf(&argv, "%s delete -inet6 %s/%d %s",
2562                 ROUTE_PATH,
2563                 network, r6->netbits, gateway);
2564     argv_msg(D_ROUTE, &argv);
2565     openvpn_execve_check(&argv, es, 0, "ERROR: AIX route add command failed");
2566 
2567 #else  /* if defined(TARGET_LINUX) */
2568     msg(M_FATAL, "Sorry, but I don't know how to do 'route ipv6' commands on this operating system.  Try putting your routes in a --route-down script");
2569 #endif /* if defined(TARGET_LINUX) */
2570 
2571     argv_free(&argv);
2572     gc_free(&gc);
2573     /* release resources potentially allocated during route cleanup */
2574     net_ctx_reset(ctx);
2575 }
2576 
2577 /*
2578  * The --redirect-gateway option requires OS-specific code below
2579  * to get the current default gateway.
2580  */
2581 
2582 #if defined(_WIN32)
2583 
2584 static const MIB_IPFORWARDTABLE *
get_windows_routing_table(struct gc_arena * gc)2585 get_windows_routing_table(struct gc_arena *gc)
2586 {
2587     ULONG size = 0;
2588     PMIB_IPFORWARDTABLE rt = NULL;
2589     DWORD status;
2590 
2591     status = GetIpForwardTable(NULL, &size, TRUE);
2592     if (status == ERROR_INSUFFICIENT_BUFFER)
2593     {
2594         rt = (PMIB_IPFORWARDTABLE) gc_malloc(size, false, gc);
2595         status = GetIpForwardTable(rt, &size, TRUE);
2596         if (status != NO_ERROR)
2597         {
2598             msg(D_ROUTE, "NOTE: GetIpForwardTable returned error: %s (code=%u)",
2599                 strerror_win32(status, gc),
2600                 (unsigned int)status);
2601             rt = NULL;
2602         }
2603     }
2604     return rt;
2605 }
2606 
2607 static int
test_route(const IP_ADAPTER_INFO * adapters,const in_addr_t gateway,DWORD * index)2608 test_route(const IP_ADAPTER_INFO *adapters,
2609            const in_addr_t gateway,
2610            DWORD *index)
2611 {
2612     int count = 0;
2613     DWORD i = adapter_index_of_ip(adapters, gateway, &count, NULL);
2614     if (index)
2615     {
2616         *index = i;
2617     }
2618     return count;
2619 }
2620 
2621 static void
test_route_helper(bool * ret,int * count,int * good,int * ambig,const IP_ADAPTER_INFO * adapters,const in_addr_t gateway)2622 test_route_helper(bool *ret,
2623                   int *count,
2624                   int *good,
2625                   int *ambig,
2626                   const IP_ADAPTER_INFO *adapters,
2627                   const in_addr_t gateway)
2628 {
2629     int c;
2630 
2631     ++*count;
2632     c = test_route(adapters, gateway, NULL);
2633     if (c == 0)
2634     {
2635         *ret = false;
2636     }
2637     else
2638     {
2639         ++*good;
2640     }
2641     if (c > 1)
2642     {
2643         ++*ambig;
2644     }
2645 }
2646 
2647 /*
2648  * If we tried to add routes now, would we succeed?
2649  */
2650 bool
test_routes(const struct route_list * rl,const struct tuntap * tt)2651 test_routes(const struct route_list *rl, const struct tuntap *tt)
2652 {
2653     struct gc_arena gc = gc_new();
2654     const IP_ADAPTER_INFO *adapters = get_adapter_info_list(&gc);
2655     bool ret = false;
2656     int count = 0;
2657     int good = 0;
2658     int ambig = 0;
2659     int len = -1;
2660     bool adapter_up = false;
2661 
2662     if (is_adapter_up(tt, adapters))
2663     {
2664         ret = true;
2665         adapter_up = true;
2666 
2667         /* we do this test only if we have IPv4 routes to install, and if
2668          * the tun/tap interface has seen IPv4 ifconfig - because if we
2669          * have no IPv4, the check will always fail, failing tun init
2670          */
2671         if (rl && tt->did_ifconfig_setup)
2672         {
2673             struct route_ipv4 *r;
2674             for (r = rl->routes, len = 0; r; r = r->next, ++len)
2675             {
2676                 test_route_helper(&ret, &count, &good, &ambig, adapters, r->gateway);
2677             }
2678 
2679             if ((rl->flags & RG_ENABLE) && (rl->spec.flags & RTSA_REMOTE_ENDPOINT))
2680             {
2681                 test_route_helper(&ret, &count, &good, &ambig, adapters, rl->spec.remote_endpoint);
2682             }
2683         }
2684     }
2685 
2686     msg(D_ROUTE, "TEST ROUTES: %d/%d succeeded len=%d ret=%d a=%d u/d=%s",
2687         good,
2688         count,
2689         len,
2690         (int)ret,
2691         ambig,
2692         adapter_up ? "up" : "down");
2693 
2694     gc_free(&gc);
2695     return ret;
2696 }
2697 
2698 static const MIB_IPFORWARDROW *
get_default_gateway_row(const MIB_IPFORWARDTABLE * routes)2699 get_default_gateway_row(const MIB_IPFORWARDTABLE *routes)
2700 {
2701     struct gc_arena gc = gc_new();
2702     DWORD lowest_metric = MAXDWORD;
2703     const MIB_IPFORWARDROW *ret = NULL;
2704     int best = -1;
2705 
2706     if (routes)
2707     {
2708         for (DWORD i = 0; i < routes->dwNumEntries; ++i)
2709         {
2710             const MIB_IPFORWARDROW *row = &routes->table[i];
2711             const in_addr_t net = ntohl(row->dwForwardDest);
2712             const in_addr_t mask = ntohl(row->dwForwardMask);
2713             const DWORD index = row->dwForwardIfIndex;
2714             const DWORD metric = row->dwForwardMetric1;
2715 
2716             dmsg(D_ROUTE_DEBUG, "GDGR: route[%lu] %s/%s i=%d m=%d",
2717                  i,
2718                  print_in_addr_t((in_addr_t) net, 0, &gc),
2719                  print_in_addr_t((in_addr_t) mask, 0, &gc),
2720                  (int)index,
2721                  (int)metric);
2722 
2723             if (!net && !mask && metric < lowest_metric)
2724             {
2725                 ret = row;
2726                 lowest_metric = metric;
2727                 best = i;
2728             }
2729         }
2730     }
2731 
2732     dmsg(D_ROUTE_DEBUG, "GDGR: best=%d lm=%u", best, (unsigned int)lowest_metric);
2733 
2734     gc_free(&gc);
2735     return ret;
2736 }
2737 
2738 void
get_default_gateway(struct route_gateway_info * rgi,openvpn_net_ctx_t * ctx)2739 get_default_gateway(struct route_gateway_info *rgi, openvpn_net_ctx_t *ctx)
2740 {
2741     struct gc_arena gc = gc_new();
2742 
2743     const IP_ADAPTER_INFO *adapters = get_adapter_info_list(&gc);
2744     const MIB_IPFORWARDTABLE *routes = get_windows_routing_table(&gc);
2745     const MIB_IPFORWARDROW *row = get_default_gateway_row(routes);
2746     DWORD a_index;
2747     const IP_ADAPTER_INFO *ai;
2748 
2749     CLEAR(*rgi);
2750 
2751     if (row)
2752     {
2753         rgi->gateway.addr = ntohl(row->dwForwardNextHop);
2754         if (rgi->gateway.addr)
2755         {
2756             rgi->flags |= RGI_ADDR_DEFINED;
2757             a_index = adapter_index_of_ip(adapters, rgi->gateway.addr, NULL, &rgi->gateway.netmask);
2758             if (a_index != TUN_ADAPTER_INDEX_INVALID)
2759             {
2760                 rgi->adapter_index = a_index;
2761                 rgi->flags |= (RGI_IFACE_DEFINED|RGI_NETMASK_DEFINED);
2762                 ai = get_adapter(adapters, a_index);
2763                 if (ai)
2764                 {
2765                     memcpy(rgi->hwaddr, ai->Address, 6);
2766                     rgi->flags |= RGI_HWADDR_DEFINED;
2767                 }
2768             }
2769         }
2770     }
2771 
2772     gc_free(&gc);
2773 }
2774 
2775 static DWORD
windows_route_find_if_index(const struct route_ipv4 * r,const struct tuntap * tt)2776 windows_route_find_if_index(const struct route_ipv4 *r, const struct tuntap *tt)
2777 {
2778     struct gc_arena gc = gc_new();
2779     DWORD ret = TUN_ADAPTER_INDEX_INVALID;
2780     int count = 0;
2781     const IP_ADAPTER_INFO *adapters = get_adapter_info_list(&gc);
2782     const IP_ADAPTER_INFO *tun_adapter = get_tun_adapter(tt, adapters);
2783     bool on_tun = false;
2784 
2785     /* first test on tun interface */
2786     if (is_ip_in_adapter_subnet(tun_adapter, r->gateway, NULL))
2787     {
2788         ret = tun_adapter->Index;
2789         count = 1;
2790         on_tun = true;
2791     }
2792     else /* test on other interfaces */
2793     {
2794         count = test_route(adapters, r->gateway, &ret);
2795     }
2796 
2797     if (count == 0)
2798     {
2799         msg(M_WARN, "Warning: route gateway is not reachable on any active network adapters: %s",
2800             print_in_addr_t(r->gateway, 0, &gc));
2801         ret = TUN_ADAPTER_INDEX_INVALID;
2802     }
2803     else if (count > 1)
2804     {
2805         msg(M_WARN, "Warning: route gateway is ambiguous: %s (%d matches)",
2806             print_in_addr_t(r->gateway, 0, &gc),
2807             count);
2808     }
2809 
2810     dmsg(D_ROUTE_DEBUG, "DEBUG: route find if: on_tun=%d count=%d index=%d",
2811          on_tun,
2812          count,
2813          (int)ret);
2814 
2815     gc_free(&gc);
2816     return ret;
2817 }
2818 
2819 /* IPv6 implementation using GetBestRoute2()
2820  *   (TBD: dynamic linking so the binary can still run on XP?)
2821  * https://msdn.microsoft.com/en-us/library/windows/desktop/aa365922(v=vs.85).aspx
2822  * https://msdn.microsoft.com/en-us/library/windows/desktop/aa814411(v=vs.85).aspx
2823  */
2824 void
get_default_gateway_ipv6(struct route_ipv6_gateway_info * rgi6,const struct in6_addr * dest,openvpn_net_ctx_t * ctx)2825 get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6,
2826                          const struct in6_addr *dest, openvpn_net_ctx_t *ctx)
2827 {
2828     struct gc_arena gc = gc_new();
2829     MIB_IPFORWARD_ROW2 BestRoute;
2830     SOCKADDR_INET DestinationAddress, BestSourceAddress;
2831     DWORD BestIfIndex;
2832     DWORD status;
2833     NET_LUID InterfaceLuid;
2834 
2835     CLEAR(*rgi6);
2836     CLEAR(InterfaceLuid);               /* cleared = not used for lookup */
2837     CLEAR(DestinationAddress);
2838 
2839     DestinationAddress.si_family = AF_INET6;
2840     if (dest)
2841     {
2842         DestinationAddress.Ipv6.sin6_addr = *dest;
2843     }
2844 
2845     status = GetBestInterfaceEx( (struct sockaddr *)&DestinationAddress, &BestIfIndex );
2846 
2847     if (status != NO_ERROR)
2848     {
2849         msg(D_ROUTE, "NOTE: GetBestInterfaceEx returned error: %s (code=%u)",
2850             strerror_win32(status, &gc),
2851             (unsigned int)status);
2852         goto done;
2853     }
2854 
2855     msg( D_ROUTE, "GetBestInterfaceEx() returned if=%d", (int) BestIfIndex );
2856 
2857     status = GetBestRoute2( &InterfaceLuid, BestIfIndex, NULL,
2858                             &DestinationAddress, 0,
2859                             &BestRoute, &BestSourceAddress );
2860 
2861     if (status != NO_ERROR)
2862     {
2863         msg(D_ROUTE, "NOTE: GetIpForwardEntry2 returned error: %s (code=%u)",
2864             strerror_win32(status, &gc),
2865             (unsigned int)status);
2866         goto done;
2867     }
2868 
2869     msg( D_ROUTE, "GDG6: II=%lu DP=%s/%d NH=%s",
2870          BestRoute.InterfaceIndex,
2871          print_in6_addr( BestRoute.DestinationPrefix.Prefix.Ipv6.sin6_addr, 0, &gc),
2872          BestRoute.DestinationPrefix.PrefixLength,
2873          print_in6_addr( BestRoute.NextHop.Ipv6.sin6_addr, 0, &gc) );
2874     msg( D_ROUTE, "GDG6: Metric=%d, Loopback=%d, AA=%d, I=%d",
2875          (int) BestRoute.Metric,
2876          (int) BestRoute.Loopback,
2877          (int) BestRoute.AutoconfigureAddress,
2878          (int) BestRoute.Immortal );
2879 
2880     rgi6->gateway.addr_ipv6 = BestRoute.NextHop.Ipv6.sin6_addr;
2881     rgi6->adapter_index     = BestRoute.InterfaceIndex;
2882     rgi6->flags |= RGI_ADDR_DEFINED | RGI_IFACE_DEFINED;
2883 
2884     /* on-link is signalled by receiving an empty (::) NextHop */
2885     if (IN6_IS_ADDR_UNSPECIFIED(&BestRoute.NextHop.Ipv6.sin6_addr) )
2886     {
2887         rgi6->flags |= RGI_ON_LINK;
2888     }
2889 
2890 done:
2891     gc_free(&gc);
2892 }
2893 
2894 bool
add_route_ipapi(const struct route_ipv4 * r,const struct tuntap * tt,DWORD adapter_index)2895 add_route_ipapi(const struct route_ipv4 *r, const struct tuntap *tt, DWORD adapter_index)
2896 {
2897     struct gc_arena gc = gc_new();
2898     bool ret = false;
2899     DWORD status;
2900     const DWORD if_index = (adapter_index == TUN_ADAPTER_INDEX_INVALID) ? windows_route_find_if_index(r, tt) : adapter_index;
2901 
2902     if (if_index != TUN_ADAPTER_INDEX_INVALID)
2903     {
2904         MIB_IPFORWARDROW fr;
2905         CLEAR(fr);
2906         fr.dwForwardDest = htonl(r->network);
2907         fr.dwForwardMask = htonl(r->netmask);
2908         fr.dwForwardPolicy = 0;
2909         fr.dwForwardNextHop = htonl(r->gateway);
2910         fr.dwForwardIfIndex = if_index;
2911         fr.dwForwardType = 4; /* the next hop is not the final dest */
2912         fr.dwForwardProto = 3; /* PROTO_IP_NETMGMT */
2913         fr.dwForwardAge = 0;
2914         fr.dwForwardNextHopAS = 0;
2915         fr.dwForwardMetric1 = (r->flags & RT_METRIC_DEFINED) ? r->metric : 1;
2916         fr.dwForwardMetric2 = METRIC_NOT_USED;
2917         fr.dwForwardMetric3 = METRIC_NOT_USED;
2918         fr.dwForwardMetric4 = METRIC_NOT_USED;
2919         fr.dwForwardMetric5 = METRIC_NOT_USED;
2920 
2921         if ((r->network & r->netmask) != r->network)
2922         {
2923             msg(M_WARN, "Warning: address %s is not a network address in relation to netmask %s",
2924                 print_in_addr_t(r->network, 0, &gc),
2925                 print_in_addr_t(r->netmask, 0, &gc));
2926         }
2927 
2928         status = CreateIpForwardEntry(&fr);
2929 
2930         if (status == NO_ERROR)
2931         {
2932             ret = true;
2933         }
2934         else
2935         {
2936             /* failed, try increasing the metric to work around Vista issue */
2937             const unsigned int forward_metric_limit = 2048; /* iteratively retry higher metrics up to this limit */
2938 
2939             for (; fr.dwForwardMetric1 <= forward_metric_limit; ++fr.dwForwardMetric1)
2940             {
2941                 /* try a different forward type=3 ("the next hop is the final dest") in addition to 4.
2942                  * --redirect-gateway over RRAS seems to need this. */
2943                 for (fr.dwForwardType = 4; fr.dwForwardType >= 3; --fr.dwForwardType)
2944                 {
2945                     status = CreateIpForwardEntry(&fr);
2946                     if (status == NO_ERROR)
2947                     {
2948                         msg(D_ROUTE, "ROUTE: CreateIpForwardEntry succeeded with dwForwardMetric1=%u and dwForwardType=%u",
2949                             (unsigned int)fr.dwForwardMetric1,
2950                             (unsigned int)fr.dwForwardType);
2951                         ret = true;
2952                         goto doublebreak;
2953                     }
2954                     else if (status != ERROR_BAD_ARGUMENTS)
2955                     {
2956                         goto doublebreak;
2957                     }
2958                 }
2959             }
2960 
2961 doublebreak:
2962             if (status != NO_ERROR)
2963             {
2964                 msg(M_WARN, "ROUTE: route addition failed using CreateIpForwardEntry: %s [status=%u if_index=%u]",
2965                     strerror_win32(status, &gc),
2966                     (unsigned int)status,
2967                     (unsigned int)if_index);
2968             }
2969         }
2970     }
2971 
2972     gc_free(&gc);
2973     return ret;
2974 }
2975 
2976 bool
del_route_ipapi(const struct route_ipv4 * r,const struct tuntap * tt)2977 del_route_ipapi(const struct route_ipv4 *r, const struct tuntap *tt)
2978 {
2979     struct gc_arena gc = gc_new();
2980     bool ret = false;
2981     DWORD status;
2982     const DWORD if_index = windows_route_find_if_index(r, tt);
2983 
2984     if (if_index != TUN_ADAPTER_INDEX_INVALID)
2985     {
2986         MIB_IPFORWARDROW fr;
2987         CLEAR(fr);
2988 
2989         fr.dwForwardDest = htonl(r->network);
2990         fr.dwForwardMask = htonl(r->netmask);
2991         fr.dwForwardPolicy = 0;
2992         fr.dwForwardNextHop = htonl(r->gateway);
2993         fr.dwForwardIfIndex = if_index;
2994 
2995         status = DeleteIpForwardEntry(&fr);
2996 
2997         if (status == NO_ERROR)
2998         {
2999             ret = true;
3000         }
3001         else
3002         {
3003             msg(M_WARN, "ROUTE: route deletion failed using DeleteIpForwardEntry: %s",
3004                 strerror_win32(status, &gc));
3005         }
3006     }
3007 
3008     gc_free(&gc);
3009     return ret;
3010 }
3011 
3012 static bool
do_route_service(const bool add,const route_message_t * rt,const size_t size,HANDLE pipe)3013 do_route_service(const bool add, const route_message_t *rt, const size_t size, HANDLE pipe)
3014 {
3015     bool ret = false;
3016     ack_message_t ack;
3017     struct gc_arena gc = gc_new();
3018 
3019     if (!send_msg_iservice(pipe, rt, size, &ack, "ROUTE"))
3020     {
3021         goto out;
3022     }
3023 
3024     if (ack.error_number != NO_ERROR)
3025     {
3026         msg(M_WARN, "ROUTE: route %s failed using service: %s [status=%u if_index=%d]",
3027             (add ? "addition" : "deletion"), strerror_win32(ack.error_number, &gc),
3028             ack.error_number, rt->iface.index);
3029         goto out;
3030     }
3031 
3032     ret = true;
3033 
3034 out:
3035     gc_free(&gc);
3036     return ret;
3037 }
3038 
3039 static bool
do_route_ipv4_service(const bool add,const struct route_ipv4 * r,const struct tuntap * tt)3040 do_route_ipv4_service(const bool add, const struct route_ipv4 *r, const struct tuntap *tt)
3041 {
3042     DWORD if_index = windows_route_find_if_index(r, tt);
3043     if (if_index == ~0)
3044     {
3045         return false;
3046     }
3047 
3048     route_message_t msg = {
3049         .header = {
3050             (add ? msg_add_route : msg_del_route),
3051             sizeof(route_message_t),
3052             0
3053         },
3054         .family = AF_INET,
3055         .prefix.ipv4.s_addr = htonl(r->network),
3056         .gateway.ipv4.s_addr = htonl(r->gateway),
3057         .iface = { .index = if_index, .name = "" },
3058         .metric = (r->flags & RT_METRIC_DEFINED ? r->metric : -1)
3059     };
3060 
3061     netmask_to_netbits(r->network, r->netmask, &msg.prefix_len);
3062     if (msg.prefix_len == -1)
3063     {
3064         msg.prefix_len = 32;
3065     }
3066 
3067     return do_route_service(add, &msg, sizeof(msg), tt->options.msg_channel);
3068 }
3069 
3070 static bool
do_route_ipv6_service(const bool add,const struct route_ipv6 * r,const struct tuntap * tt)3071 do_route_ipv6_service(const bool add, const struct route_ipv6 *r, const struct tuntap *tt)
3072 {
3073     bool status;
3074     route_message_t msg = {
3075         .header = {
3076             (add ? msg_add_route : msg_del_route),
3077             sizeof(route_message_t),
3078             0
3079         },
3080         .family = AF_INET6,
3081         .prefix.ipv6 = r->network,
3082         .prefix_len = r->netbits,
3083         .gateway.ipv6 = r->gateway,
3084         .iface = { .index = tt->adapter_index, .name = "" },
3085         .metric = ( (r->flags & RT_METRIC_DEFINED) ? r->metric : -1)
3086     };
3087 
3088     if (r->adapter_index)               /* vpn server special route */
3089     {
3090         msg.iface.index = r->adapter_index;
3091     }
3092 
3093     /* In TUN mode we use a special link-local address as the next hop.
3094      * The tapdrvr knows about it and will answer neighbor discovery packets.
3095      * (only do this for routes actually using the tun/tap device)
3096      */
3097     if (tt->type == DEV_TYPE_TUN
3098         && msg.iface.index == tt->adapter_index)
3099     {
3100         inet_pton(AF_INET6, "fe80::8", &msg.gateway.ipv6);
3101     }
3102 
3103     if (msg.iface.index == TUN_ADAPTER_INDEX_INVALID)
3104     {
3105         strncpy(msg.iface.name, tt->actual_name, sizeof(msg.iface.name));
3106         msg.iface.name[sizeof(msg.iface.name) - 1] = '\0';
3107     }
3108 
3109     status = do_route_service(add, &msg, sizeof(msg), tt->options.msg_channel);
3110     msg(D_ROUTE, "IPv6 route %s via service %s",
3111         add ? "addition" : "deletion",
3112         status ? "succeeded" : "failed");
3113     return status;
3114 }
3115 
3116 static bool
add_route_service(const struct route_ipv4 * r,const struct tuntap * tt)3117 add_route_service(const struct route_ipv4 *r, const struct tuntap *tt)
3118 {
3119     return do_route_ipv4_service(true, r, tt);
3120 }
3121 
3122 static bool
del_route_service(const struct route_ipv4 * r,const struct tuntap * tt)3123 del_route_service(const struct route_ipv4 *r, const struct tuntap *tt)
3124 {
3125     return do_route_ipv4_service(false, r, tt);
3126 }
3127 
3128 static bool
add_route_ipv6_service(const struct route_ipv6 * r,const struct tuntap * tt)3129 add_route_ipv6_service(const struct route_ipv6 *r, const struct tuntap *tt)
3130 {
3131     return do_route_ipv6_service(true, r, tt);
3132 }
3133 
3134 static bool
del_route_ipv6_service(const struct route_ipv6 * r,const struct tuntap * tt)3135 del_route_ipv6_service(const struct route_ipv6 *r, const struct tuntap *tt)
3136 {
3137     return do_route_ipv6_service(false, r, tt);
3138 }
3139 
3140 static const char *
format_route_entry(const MIB_IPFORWARDROW * r,struct gc_arena * gc)3141 format_route_entry(const MIB_IPFORWARDROW *r, struct gc_arena *gc)
3142 {
3143     struct buffer out = alloc_buf_gc(256, gc);
3144     buf_printf(&out, "%s %s %s p=%d i=%d t=%d pr=%d a=%d h=%d m=%d/%d/%d/%d/%d",
3145                print_in_addr_t(r->dwForwardDest, IA_NET_ORDER, gc),
3146                print_in_addr_t(r->dwForwardMask, IA_NET_ORDER, gc),
3147                print_in_addr_t(r->dwForwardNextHop, IA_NET_ORDER, gc),
3148                (int)r->dwForwardPolicy,
3149                (int)r->dwForwardIfIndex,
3150                (int)r->dwForwardType,
3151                (int)r->dwForwardProto,
3152                (int)r->dwForwardAge,
3153                (int)r->dwForwardNextHopAS,
3154                (int)r->dwForwardMetric1,
3155                (int)r->dwForwardMetric2,
3156                (int)r->dwForwardMetric3,
3157                (int)r->dwForwardMetric4,
3158                (int)r->dwForwardMetric5);
3159     return BSTR(&out);
3160 }
3161 
3162 /*
3163  * Show current routing table
3164  */
3165 void
show_routes(int msglev)3166 show_routes(int msglev)
3167 {
3168     struct gc_arena gc = gc_new();
3169 
3170     const MIB_IPFORWARDTABLE *rt = get_windows_routing_table(&gc);
3171 
3172     msg(msglev, "SYSTEM ROUTING TABLE");
3173     if (rt)
3174     {
3175         for (DWORD i = 0; i < rt->dwNumEntries; ++i)
3176         {
3177             msg(msglev, "%s", format_route_entry(&rt->table[i], &gc));
3178         }
3179     }
3180     gc_free(&gc);
3181 }
3182 
3183 #elif defined(TARGET_ANDROID)
3184 
3185 void
get_default_gateway(struct route_gateway_info * rgi,openvpn_net_ctx_t * ctx)3186 get_default_gateway(struct route_gateway_info *rgi, openvpn_net_ctx_t *ctx)
3187 {
3188     /* Android, set some pseudo GW, addr is in host byte order,
3189      * Determining the default GW on Android 5.0+ is non trivial
3190      * and serves almost no purpose since OpenVPN only uses the
3191      * default GW address to add routes for networks that should
3192      * NOT be routed over the VPN. Using a well known address
3193      * (127.'d'.'g'.'w') for the default GW make detecting
3194      * these routes easier from the controlling app.
3195      */
3196     CLEAR(*rgi);
3197 
3198     rgi->gateway.addr = 127 << 24 | 'd' << 16 | 'g' << 8 | 'w';
3199     rgi->flags = RGI_ADDR_DEFINED | RGI_IFACE_DEFINED;
3200     strcpy(rgi->iface, "android-gw");
3201 
3202     /* Skip scanning/fetching interface from loopback interface we do
3203      * normally on Linux.
3204      * It always fails and "ioctl(SIOCGIFCONF) failed" confuses users
3205      */
3206 
3207 }
3208 
3209 void
get_default_gateway_ipv6(struct route_ipv6_gateway_info * rgi6,const struct in6_addr * dest,openvpn_net_ctx_t * ctx)3210 get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6,
3211                          const struct in6_addr *dest, openvpn_net_ctx_t *ctx)
3212 {
3213     /* Same for ipv6 */
3214 
3215     CLEAR(*rgi6);
3216 
3217     /* Use a fake link-local address */
3218     ASSERT(inet_pton(AF_INET6, "fe80::ad", &rgi6->addrs->addr_ipv6) == 1);
3219     rgi6->addrs->netbits_ipv6 = 64;
3220     rgi6->flags = RGI_ADDR_DEFINED | RGI_IFACE_DEFINED;
3221     strcpy(rgi6->iface, "android-gw");
3222 }
3223 
3224 #elif defined(TARGET_LINUX)
3225 
3226 void
get_default_gateway(struct route_gateway_info * rgi,openvpn_net_ctx_t * ctx)3227 get_default_gateway(struct route_gateway_info *rgi, openvpn_net_ctx_t *ctx)
3228 {
3229     struct gc_arena gc = gc_new();
3230     int sd = -1;
3231     char best_name[IFNAMSIZ];
3232 
3233     CLEAR(*rgi);
3234     CLEAR(best_name);
3235 
3236     /* get default gateway IP addr */
3237     if (net_route_v4_best_gw(ctx, NULL, &rgi->gateway.addr, best_name) == 0)
3238     {
3239         rgi->flags |= RGI_ADDR_DEFINED;
3240         if (!rgi->gateway.addr && best_name[0])
3241         {
3242             rgi->flags |= RGI_ON_LINK;
3243         }
3244     }
3245 
3246     /* scan adapter list */
3247     if (rgi->flags & RGI_ADDR_DEFINED)
3248     {
3249         struct ifreq *ifr, *ifend;
3250         in_addr_t addr, netmask;
3251         struct ifreq ifreq;
3252         struct ifconf ifc;
3253         struct ifreq ifs[20]; /* Maximum number of interfaces to scan */
3254 
3255         if ((sd = socket(AF_INET, SOCK_DGRAM, 0)) < 0)
3256         {
3257             msg(M_WARN, "GDG: socket() failed");
3258             goto done;
3259         }
3260         ifc.ifc_len = sizeof(ifs);
3261         ifc.ifc_req = ifs;
3262         if (ioctl(sd, SIOCGIFCONF, &ifc) < 0)
3263         {
3264             msg(M_WARN, "GDG: ioctl(SIOCGIFCONF) failed");
3265             goto done;
3266         }
3267 
3268         /* scan through interface list */
3269         ifend = ifs + (ifc.ifc_len / sizeof(struct ifreq));
3270         for (ifr = ifc.ifc_req; ifr < ifend; ifr++)
3271         {
3272             if (ifr->ifr_addr.sa_family == AF_INET)
3273             {
3274                 /* get interface addr */
3275                 addr = ntohl(((struct sockaddr_in *) &ifr->ifr_addr)->sin_addr.s_addr);
3276 
3277                 /* get interface name */
3278                 strncpynt(ifreq.ifr_name, ifr->ifr_name, sizeof(ifreq.ifr_name));
3279 
3280                 /* check that the interface is up */
3281                 if (ioctl(sd, SIOCGIFFLAGS, &ifreq) < 0)
3282                 {
3283                     continue;
3284                 }
3285                 if (!(ifreq.ifr_flags & IFF_UP))
3286                 {
3287                     continue;
3288                 }
3289 
3290                 if (rgi->flags & RGI_ON_LINK)
3291                 {
3292                     /* check that interface name of current interface
3293                     * matches interface name of best default route */
3294                     if (strcmp(ifreq.ifr_name, best_name))
3295                     {
3296                         continue;
3297                     }
3298 #if 0
3299                     /* if point-to-point link, use remote addr as route gateway */
3300                     if ((ifreq.ifr_flags & IFF_POINTOPOINT) && ioctl(sd, SIOCGIFDSTADDR, &ifreq) >= 0)
3301                     {
3302                         rgi->gateway.addr = ntohl(((struct sockaddr_in *) &ifreq.ifr_addr)->sin_addr.s_addr);
3303                         if (rgi->gateway.addr)
3304                         {
3305                             rgi->flags &= ~RGI_ON_LINK;
3306                         }
3307                     }
3308 #endif
3309                 }
3310                 else
3311                 {
3312                     /* get interface netmask */
3313                     if (ioctl(sd, SIOCGIFNETMASK, &ifreq) < 0)
3314                     {
3315                         continue;
3316                     }
3317                     netmask = ntohl(((struct sockaddr_in *) &ifreq.ifr_addr)->sin_addr.s_addr);
3318 
3319                     /* check that interface matches default route */
3320                     if (((rgi->gateway.addr ^ addr) & netmask) != 0)
3321                     {
3322                         continue;
3323                     }
3324 
3325                     /* save netmask */
3326                     rgi->gateway.netmask = netmask;
3327                     rgi->flags |= RGI_NETMASK_DEFINED;
3328                 }
3329 
3330                 /* save iface name */
3331                 strncpynt(rgi->iface, ifreq.ifr_name, sizeof(rgi->iface));
3332                 rgi->flags |= RGI_IFACE_DEFINED;
3333 
3334                 /* now get the hardware address. */
3335                 memset(&ifreq.ifr_hwaddr, 0, sizeof(struct sockaddr));
3336                 if (ioctl(sd, SIOCGIFHWADDR, &ifreq) < 0)
3337                 {
3338                     msg(M_WARN, "GDG: SIOCGIFHWADDR(%s) failed", ifreq.ifr_name);
3339                     goto done;
3340                 }
3341                 memcpy(rgi->hwaddr, &ifreq.ifr_hwaddr.sa_data, 6);
3342                 rgi->flags |= RGI_HWADDR_DEFINED;
3343 
3344                 break;
3345             }
3346         }
3347     }
3348 
3349 done:
3350     if (sd >= 0)
3351     {
3352         close(sd);
3353     }
3354     gc_free(&gc);
3355 }
3356 
3357 /* IPv6 implementation using netlink
3358  * http://www.linuxjournal.com/article/7356
3359  * netlink(3), netlink(7), rtnetlink(7)
3360  * http://www.virtualbox.org/svn/vbox/trunk/src/VBox/NetworkServices/NAT/rtmon_linux.c
3361  */
3362 struct rtreq {
3363     struct nlmsghdr nh;
3364     struct rtmsg rtm;
3365     char attrbuf[512];
3366 };
3367 
3368 void
get_default_gateway_ipv6(struct route_ipv6_gateway_info * rgi6,const struct in6_addr * dest,openvpn_net_ctx_t * ctx)3369 get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6,
3370                          const struct in6_addr *dest, openvpn_net_ctx_t *ctx)
3371 {
3372     int flags;
3373 
3374     CLEAR(*rgi6);
3375 
3376     if (net_route_v6_best_gw(ctx, dest, &rgi6->gateway.addr_ipv6,
3377                              rgi6->iface) == 0)
3378     {
3379         if (!IN6_IS_ADDR_UNSPECIFIED(rgi6->gateway.addr_ipv6.s6_addr))
3380         {
3381             rgi6->flags |= RGI_ADDR_DEFINED;
3382         }
3383 
3384         if (strlen(rgi6->iface) > 0)
3385         {
3386             rgi6->flags |= RGI_IFACE_DEFINED;
3387         }
3388     }
3389 
3390     /* if we have an interface but no gateway, the destination is on-link */
3391     flags = rgi6->flags & (RGI_IFACE_DEFINED | RGI_ADDR_DEFINED);
3392     if (flags == RGI_IFACE_DEFINED)
3393     {
3394         rgi6->flags |= (RGI_ADDR_DEFINED | RGI_ON_LINK);
3395         if (dest)
3396         {
3397             rgi6->gateway.addr_ipv6 = *dest;
3398         }
3399     }
3400 }
3401 
3402 #elif defined(TARGET_DARWIN) || defined(TARGET_SOLARIS)    \
3403     || defined(TARGET_FREEBSD) || defined(TARGET_DRAGONFLY)    \
3404     || defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
3405 
3406 #include <sys/types.h>
3407 #include <sys/socket.h>
3408 #include <netinet/in.h>
3409 #include <net/route.h>
3410 #include <net/if_dl.h>
3411 
3412 struct rtmsg {
3413     struct rt_msghdr m_rtm;
3414     char m_space[512];
3415 };
3416 
3417 /* the route socket code is identical for all 4 supported BSDs and for
3418  * MacOS X (Darwin), with one crucial difference: when going from
3419  * 32 bit to 64 bit, FreeBSD/OpenBSD increased the structure size but kept
3420  * source code compatibility by keeping the use of "long", while
3421  * MacOS X decided to keep binary compatibility by *changing* the API
3422  * to use "uint32_t", thus 32 bit on all OS X variants
3423  *
3424  * NetBSD does the MacOS way of "fixed number of bits, no matter if
3425  * 32 or 64 bit OS", but chose uint64_t.  For maximum portability, we
3426  * just use the OS RT_ROUNDUP() macro, which is guaranteed to be correct.
3427  *
3428  * We used to have a large amount of duplicate code here which really
3429  * differed only in this (long) vs. (uint32_t) - IMHO, worse than
3430  * having a combined block for all BSDs with this single #ifdef inside
3431  */
3432 
3433 #if defined(TARGET_DARWIN)
3434 #define ROUNDUP(a) \
3435     ((a) > 0 ? (1 + (((a) - 1) | (sizeof(uint32_t) - 1))) : sizeof(uint32_t))
3436 #elif defined(TARGET_NETBSD)
3437 #define ROUNDUP(a) RT_ROUNDUP(a)
3438 #else
3439 #define ROUNDUP(a) \
3440     ((a) > 0 ? (1 + (((a) - 1) | (sizeof(long) - 1))) : sizeof(long))
3441 #endif
3442 
3443 #if defined(TARGET_SOLARIS)
3444 #define NEXTADDR(w, u) \
3445     if (rtm_addrs & (w)) { \
3446         l = sizeof(u); memmove(cp, &(u), l); cp += ROUNDUP(l); \
3447     }
3448 
3449 #define ADVANCE(x, n) (x += ROUNDUP(sizeof(struct sockaddr_in)))
3450 #else  /* if defined(TARGET_SOLARIS) */
3451 #define NEXTADDR(w, u) \
3452     if (rtm_addrs & (w)) { \
3453         l = ((struct sockaddr *)&(u))->sa_len; memmove(cp, &(u), l); cp += ROUNDUP(l); \
3454     }
3455 
3456 #define ADVANCE(x, n) (x += ROUNDUP((n)->sa_len))
3457 #endif
3458 
3459 #define max(a,b) ((a) > (b) ? (a) : (b))
3460 
3461 void
get_default_gateway(struct route_gateway_info * rgi,openvpn_net_ctx_t * ctx)3462 get_default_gateway(struct route_gateway_info *rgi, openvpn_net_ctx_t *ctx)
3463 {
3464     struct gc_arena gc = gc_new();
3465     struct rtmsg m_rtmsg;
3466     int sockfd = -1;
3467     int seq, l, pid, rtm_addrs;
3468     unsigned int i;
3469     struct sockaddr so_dst, so_mask;
3470     char *cp = m_rtmsg.m_space;
3471     struct sockaddr *gate = NULL, *ifp = NULL, *sa;
3472     struct  rt_msghdr *rtm_aux;
3473 
3474 #define rtm m_rtmsg.m_rtm
3475 
3476     CLEAR(*rgi);
3477 
3478     /* setup data to send to routing socket */
3479     pid = getpid();
3480     seq = 0;
3481     rtm_addrs = RTA_DST | RTA_NETMASK | RTA_IFP;
3482 
3483     bzero(&m_rtmsg, sizeof(m_rtmsg));
3484     bzero(&so_dst, sizeof(so_dst));
3485     bzero(&so_mask, sizeof(so_mask));
3486     bzero(&rtm, sizeof(struct rt_msghdr));
3487 
3488     rtm.rtm_type = RTM_GET;
3489     rtm.rtm_flags = RTF_UP | RTF_GATEWAY;
3490     rtm.rtm_version = RTM_VERSION;
3491     rtm.rtm_seq = ++seq;
3492 #ifdef TARGET_OPENBSD
3493     rtm.rtm_tableid = getrtable();
3494 #endif
3495     rtm.rtm_addrs = rtm_addrs;
3496 
3497     so_dst.sa_family = AF_INET;
3498     so_mask.sa_family = AF_INET;
3499 
3500 #ifndef TARGET_SOLARIS
3501     so_dst.sa_len = sizeof(struct sockaddr_in);
3502     so_mask.sa_len = sizeof(struct sockaddr_in);
3503 #endif
3504 
3505     NEXTADDR(RTA_DST, so_dst);
3506     NEXTADDR(RTA_NETMASK, so_mask);
3507 
3508     rtm.rtm_msglen = l = cp - (char *)&m_rtmsg;
3509 
3510     /* transact with routing socket */
3511     sockfd = socket(PF_ROUTE, SOCK_RAW, 0);
3512     if (sockfd < 0)
3513     {
3514         msg(M_WARN, "GDG: socket #1 failed");
3515         goto done;
3516     }
3517     if (write(sockfd, (char *)&m_rtmsg, l) < 0)
3518     {
3519         msg(M_WARN, "GDG: problem writing to routing socket");
3520         goto done;
3521     }
3522     do
3523     {
3524         l = read(sockfd, (char *)&m_rtmsg, sizeof(m_rtmsg));
3525     } while (l > 0 && (rtm.rtm_seq != seq || rtm.rtm_pid != pid));
3526     close(sockfd);
3527     sockfd = -1;
3528 
3529     /* extract return data from routing socket */
3530     rtm_aux = &rtm;
3531     cp = ((char *)(rtm_aux + 1));
3532     if (rtm_aux->rtm_addrs)
3533     {
3534         for (i = 1; i; i <<= 1)
3535         {
3536             if (i & rtm_aux->rtm_addrs)
3537             {
3538                 sa = (struct sockaddr *)cp;
3539                 if (i == RTA_GATEWAY)
3540                 {
3541                     gate = sa;
3542                 }
3543                 else if (i == RTA_IFP)
3544                 {
3545                     ifp = sa;
3546                 }
3547                 ADVANCE(cp, sa);
3548             }
3549         }
3550     }
3551     else
3552     {
3553         goto done;
3554     }
3555 
3556     /* get gateway addr and interface name */
3557     if (gate != NULL)
3558     {
3559         /* get default gateway addr */
3560         rgi->gateway.addr = ntohl(((struct sockaddr_in *)gate)->sin_addr.s_addr);
3561         if (rgi->gateway.addr)
3562         {
3563             rgi->flags |= RGI_ADDR_DEFINED;
3564         }
3565 
3566         if (ifp)
3567         {
3568             /* get interface name */
3569             const struct sockaddr_dl *adl = (struct sockaddr_dl *) ifp;
3570             if (adl->sdl_nlen && adl->sdl_nlen < sizeof(rgi->iface))
3571             {
3572                 memcpy(rgi->iface, adl->sdl_data, adl->sdl_nlen);
3573                 rgi->iface[adl->sdl_nlen] = '\0';
3574                 rgi->flags |= RGI_IFACE_DEFINED;
3575             }
3576         }
3577     }
3578 
3579     /* get netmask of interface that owns default gateway */
3580     if (rgi->flags & RGI_IFACE_DEFINED)
3581     {
3582         struct ifreq ifr;
3583 
3584         sockfd = socket(AF_INET, SOCK_DGRAM, 0);
3585         if (sockfd < 0)
3586         {
3587             msg(M_WARN, "GDG: socket #2 failed");
3588             goto done;
3589         }
3590 
3591         CLEAR(ifr);
3592         ifr.ifr_addr.sa_family = AF_INET;
3593         strncpynt(ifr.ifr_name, rgi->iface, IFNAMSIZ);
3594 
3595         if (ioctl(sockfd, SIOCGIFNETMASK, (char *)&ifr) < 0)
3596         {
3597             msg(M_WARN, "GDG: ioctl #1 failed");
3598             goto done;
3599         }
3600         close(sockfd);
3601         sockfd = -1;
3602 
3603         rgi->gateway.netmask = ntohl(((struct sockaddr_in *)&ifr.ifr_addr)->sin_addr.s_addr);
3604         rgi->flags |= RGI_NETMASK_DEFINED;
3605     }
3606 
3607     /* try to read MAC addr associated with interface that owns default gateway */
3608     if (rgi->flags & RGI_IFACE_DEFINED)
3609     {
3610         struct ifconf ifc;
3611         struct ifreq *ifr;
3612         const int bufsize = 4096;
3613         char *buffer;
3614 
3615         buffer = (char *) gc_malloc(bufsize, true, &gc);
3616         sockfd = socket(AF_INET, SOCK_DGRAM, 0);
3617         if (sockfd < 0)
3618         {
3619             msg(M_WARN, "GDG: socket #3 failed");
3620             goto done;
3621         }
3622 
3623         ifc.ifc_len = bufsize;
3624         ifc.ifc_buf = buffer;
3625 
3626         if (ioctl(sockfd, SIOCGIFCONF, (char *)&ifc) < 0)
3627         {
3628             msg(M_WARN, "GDG: ioctl #2 failed");
3629             goto done;
3630         }
3631         close(sockfd);
3632         sockfd = -1;
3633 
3634         for (cp = buffer; cp <= buffer + ifc.ifc_len - sizeof(struct ifreq); )
3635         {
3636             ifr = (struct ifreq *)cp;
3637 #if defined(TARGET_SOLARIS)
3638             const size_t len = sizeof(ifr->ifr_name) + sizeof(ifr->ifr_addr);
3639 #else
3640             const size_t len = sizeof(ifr->ifr_name) + max(sizeof(ifr->ifr_addr), ifr->ifr_addr.sa_len);
3641 #endif
3642 
3643             if (!ifr->ifr_addr.sa_family)
3644             {
3645                 break;
3646             }
3647             if (!strncmp(ifr->ifr_name, rgi->iface, IFNAMSIZ))
3648             {
3649                 if (ifr->ifr_addr.sa_family == AF_LINK)
3650                 {
3651                     struct sockaddr_dl *sdl = (struct sockaddr_dl *)&ifr->ifr_addr;
3652                     memcpy(rgi->hwaddr, LLADDR(sdl), 6);
3653                     rgi->flags |= RGI_HWADDR_DEFINED;
3654                 }
3655             }
3656             cp += len;
3657         }
3658     }
3659 
3660 done:
3661     if (sockfd >= 0)
3662     {
3663         close(sockfd);
3664     }
3665     gc_free(&gc);
3666 }
3667 
3668 /* BSD implementation using routing socket (as does IPv4)
3669  * (the code duplication is somewhat unavoidable if we want this to
3670  * work on OpenSolaris as well.  *sigh*)
3671  */
3672 
3673 /* Solaris has no length field - this is ugly, but less #ifdef in total
3674  */
3675 #if defined(TARGET_SOLARIS)
3676 #undef ADVANCE
3677 #define ADVANCE(x, n) (x += ROUNDUP(sizeof(struct sockaddr_in6)))
3678 #endif
3679 
3680 void
get_default_gateway_ipv6(struct route_ipv6_gateway_info * rgi6,const struct in6_addr * dest,openvpn_net_ctx_t * ctx)3681 get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6,
3682                          const struct in6_addr *dest, openvpn_net_ctx_t *ctx)
3683 {
3684 
3685     struct rtmsg m_rtmsg;
3686     int sockfd = -1;
3687     int seq, l, pid, rtm_addrs;
3688     unsigned int i;
3689     struct sockaddr_in6 so_dst, so_mask;
3690     char *cp = m_rtmsg.m_space;
3691     struct sockaddr *gate = NULL, *ifp = NULL, *sa;
3692     struct rt_msghdr *rtm_aux;
3693 
3694     CLEAR(*rgi6);
3695 
3696     /* setup data to send to routing socket */
3697     pid = getpid();
3698     seq = 0;
3699     rtm_addrs = RTA_DST | RTA_NETMASK | RTA_IFP;
3700 
3701     bzero(&m_rtmsg, sizeof(m_rtmsg));
3702     bzero(&so_dst, sizeof(so_dst));
3703     bzero(&so_mask, sizeof(so_mask));
3704     bzero(&rtm, sizeof(struct rt_msghdr));
3705 
3706     rtm.rtm_type = RTM_GET;
3707     rtm.rtm_flags = RTF_UP;
3708     rtm.rtm_version = RTM_VERSION;
3709     rtm.rtm_seq = ++seq;
3710 #ifdef TARGET_OPENBSD
3711     rtm.rtm_tableid = getrtable();
3712 #endif
3713 
3714     so_dst.sin6_family = AF_INET6;
3715     so_mask.sin6_family = AF_INET6;
3716 
3717     if (dest != NULL                    /* specific host? */
3718         && !IN6_IS_ADDR_UNSPECIFIED(dest) )
3719     {
3720         so_dst.sin6_addr = *dest;
3721         /* :: needs /0 "netmask", host route wants "no netmask */
3722         rtm_addrs &= ~RTA_NETMASK;
3723     }
3724 
3725     rtm.rtm_addrs = rtm_addrs;
3726 
3727 #ifndef TARGET_SOLARIS
3728     so_dst.sin6_len = sizeof(struct sockaddr_in6);
3729     so_mask.sin6_len = sizeof(struct sockaddr_in6);
3730 #endif
3731 
3732     NEXTADDR(RTA_DST, so_dst);
3733     NEXTADDR(RTA_NETMASK, so_mask);
3734 
3735     rtm.rtm_msglen = l = cp - (char *)&m_rtmsg;
3736 
3737     /* transact with routing socket */
3738     sockfd = socket(PF_ROUTE, SOCK_RAW, 0);
3739     if (sockfd < 0)
3740     {
3741         msg(M_WARN, "GDG6: socket #1 failed");
3742         goto done;
3743     }
3744     if (write(sockfd, (char *)&m_rtmsg, l) < 0)
3745     {
3746         msg(M_WARN|M_ERRNO, "GDG6: problem writing to routing socket");
3747         goto done;
3748     }
3749 
3750     do
3751     {
3752         l = read(sockfd, (char *)&m_rtmsg, sizeof(m_rtmsg));
3753     }
3754     while (l > 0 && (rtm.rtm_seq != seq || rtm.rtm_pid != pid));
3755 
3756     close(sockfd);
3757     sockfd = -1;
3758 
3759     /* extract return data from routing socket */
3760     rtm_aux = &rtm;
3761     cp = ((char *)(rtm_aux + 1));
3762     if (rtm_aux->rtm_addrs)
3763     {
3764         for (i = 1; i; i <<= 1)
3765         {
3766             if (i & rtm_aux->rtm_addrs)
3767             {
3768                 sa = (struct sockaddr *)cp;
3769                 if (i == RTA_GATEWAY)
3770                 {
3771                     gate = sa;
3772                 }
3773                 else if (i == RTA_IFP)
3774                 {
3775                     ifp = sa;
3776                 }
3777                 ADVANCE(cp, sa);
3778             }
3779         }
3780     }
3781     else
3782     {
3783         goto done;
3784     }
3785 
3786     /* get gateway addr and interface name */
3787     if (gate != NULL)
3788     {
3789         struct sockaddr_in6 *s6 = (struct sockaddr_in6 *)gate;
3790         struct in6_addr gw = s6->sin6_addr;
3791 
3792 #ifndef TARGET_SOLARIS
3793         /* You do not really want to know... from FreeBSD's route.c
3794          * (KAME encodes the 16 bit scope_id in s6_addr[2] + [3],
3795          * but for a correct link-local address these must be :0000: )
3796          */
3797         if (gate->sa_len == sizeof(struct sockaddr_in6)
3798             && IN6_IS_ADDR_LINKLOCAL(&gw) )
3799         {
3800             gw.s6_addr[2] = gw.s6_addr[3] = 0;
3801         }
3802 
3803         if (gate->sa_len != sizeof(struct sockaddr_in6)
3804             || IN6_IS_ADDR_UNSPECIFIED(&gw) )
3805         {
3806             rgi6->flags |= RGI_ON_LINK;
3807         }
3808         else
3809 #endif
3810 
3811         rgi6->gateway.addr_ipv6 = gw;
3812         rgi6->flags |= RGI_ADDR_DEFINED;
3813 
3814         if (ifp)
3815         {
3816             /* get interface name */
3817             const struct sockaddr_dl *adl = (struct sockaddr_dl *) ifp;
3818             if (adl->sdl_nlen && adl->sdl_nlen < sizeof(rgi6->iface))
3819             {
3820                 memcpy(rgi6->iface, adl->sdl_data, adl->sdl_nlen);
3821                 rgi6->flags |= RGI_IFACE_DEFINED;
3822             }
3823         }
3824     }
3825 
3826 done:
3827     if (sockfd >= 0)
3828     {
3829         close(sockfd);
3830     }
3831 }
3832 
3833 #undef max
3834 
3835 #else  /* if defined(_WIN32) */
3836 
3837 /*
3838  * This is a platform-specific method that returns data about
3839  * the current default gateway.  Return data is placed into
3840  * a struct route_gateway_info object provided by caller.  The
3841  * implementation should CLEAR the structure before adding
3842  * data to it.
3843  *
3844  * Data returned includes:
3845  * 1. default gateway address (rgi->gateway.addr)
3846  * 2. netmask of interface that owns default gateway
3847  *    (rgi->gateway.netmask)
3848  * 3. hardware address (i.e. MAC address) of interface that owns
3849  *    default gateway (rgi->hwaddr)
3850  * 4. interface name (or adapter index on Windows) that owns default
3851  *    gateway (rgi->iface or rgi->adapter_index)
3852  * 5. an array of additional address/netmask pairs defined by
3853  *    interface that owns default gateway (rgi->addrs with length
3854  *    given in rgi->n_addrs)
3855  *
3856  * The flags RGI_x_DEFINED may be used to indicate which of the data
3857  * members were successfully returned (set in rgi->flags).  All of
3858  * the data members are optional, however certain OpenVPN functionality
3859  * may be disabled by missing items.
3860  */
3861 void
get_default_gateway(struct route_gateway_info * rgi,openvpn_net_ctx_t * ctx)3862 get_default_gateway(struct route_gateway_info *rgi, openvpn_net_ctx_t *ctx)
3863 {
3864     CLEAR(*rgi);
3865 }
3866 void
get_default_gateway_ipv6(struct route_ipv6_gateway_info * rgi6,const struct in6_addr * dest,openvpn_net_ctx_t * ctx)3867 get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6,
3868                          const struct in6_addr *dest, openvpn_net_ctx_t *ctx)
3869 {
3870     msg(D_ROUTE, "no support for get_default_gateway_ipv6() on this system");
3871     CLEAR(*rgi6);
3872 }
3873 
3874 #endif /* if defined(_WIN32) */
3875 
3876 bool
netmask_to_netbits(const in_addr_t network,const in_addr_t netmask,int * netbits)3877 netmask_to_netbits(const in_addr_t network, const in_addr_t netmask, int *netbits)
3878 {
3879     int i;
3880     const int addrlen = sizeof(in_addr_t) * 8;
3881 
3882     if ((network & netmask) == network)
3883     {
3884         for (i = 0; i <= addrlen; ++i)
3885         {
3886             in_addr_t mask = netbits_to_netmask(i);
3887             if (mask == netmask)
3888             {
3889                 if (i == addrlen)
3890                 {
3891                     *netbits = -1;
3892                 }
3893                 else
3894                 {
3895                     *netbits = i;
3896                 }
3897                 return true;
3898             }
3899         }
3900     }
3901     return false;
3902 }
3903 
3904 /* similar to netmask_to_netbits(), but don't mess with base address
3905  * etc., just convert to netbits - non-mappable masks are returned as "-1"
3906  */
3907 int
netmask_to_netbits2(in_addr_t netmask)3908 netmask_to_netbits2(in_addr_t netmask)
3909 {
3910     int i;
3911     const int addrlen = sizeof(in_addr_t) * 8;
3912 
3913     for (i = 0; i <= addrlen; ++i)
3914     {
3915         in_addr_t mask = netbits_to_netmask(i);
3916         if (mask == netmask)
3917         {
3918             return i;
3919         }
3920     }
3921     return -1;
3922 }
3923 
3924 
3925 /*
3926  * get_bypass_addresses() is used by the redirect-gateway bypass-x
3927  * functions to build a route bypass to selected DHCP/DNS servers,
3928  * so that outgoing packets to these servers don't end up in the tunnel.
3929  */
3930 
3931 #if defined(_WIN32)
3932 
3933 static void
add_host_route_if_nonlocal(struct route_bypass * rb,const in_addr_t addr)3934 add_host_route_if_nonlocal(struct route_bypass *rb, const in_addr_t addr)
3935 {
3936     if (test_local_addr(addr, NULL) == TLA_NONLOCAL && addr != 0 && addr != IPV4_NETMASK_HOST)
3937     {
3938         add_bypass_address(rb, addr);
3939     }
3940 }
3941 
3942 static void
add_host_route_array(struct route_bypass * rb,const IP_ADDR_STRING * iplist)3943 add_host_route_array(struct route_bypass *rb, const IP_ADDR_STRING *iplist)
3944 {
3945     while (iplist)
3946     {
3947         bool succeed = false;
3948         const in_addr_t ip = getaddr(GETADDR_HOST_ORDER, iplist->IpAddress.String, 0, &succeed, NULL);
3949         if (succeed)
3950         {
3951             add_host_route_if_nonlocal(rb, ip);
3952         }
3953         iplist = iplist->Next;
3954     }
3955 }
3956 
3957 static void
get_bypass_addresses(struct route_bypass * rb,const unsigned int flags)3958 get_bypass_addresses(struct route_bypass *rb, const unsigned int flags)
3959 {
3960     struct gc_arena gc = gc_new();
3961     /*bool ret_bool = false;*/
3962 
3963     /* get full routing table */
3964     const MIB_IPFORWARDTABLE *routes = get_windows_routing_table(&gc);
3965 
3966     /* get the route which represents the default gateway */
3967     const MIB_IPFORWARDROW *row = get_default_gateway_row(routes);
3968 
3969     if (row)
3970     {
3971         /* get the adapter which the default gateway is associated with */
3972         const IP_ADAPTER_INFO *dgi = get_adapter_info(row->dwForwardIfIndex, &gc);
3973 
3974         /* get extra adapter info, such as DNS addresses */
3975         const IP_PER_ADAPTER_INFO *pai = get_per_adapter_info(row->dwForwardIfIndex, &gc);
3976 
3977         /* Bypass DHCP server address */
3978         if ((flags & RG_BYPASS_DHCP) && dgi && dgi->DhcpEnabled)
3979         {
3980             add_host_route_array(rb, &dgi->DhcpServer);
3981         }
3982 
3983         /* Bypass DNS server addresses */
3984         if ((flags & RG_BYPASS_DNS) && pai)
3985         {
3986             add_host_route_array(rb, &pai->DnsServerList);
3987         }
3988     }
3989 
3990     gc_free(&gc);
3991 }
3992 
3993 #else  /* if defined(_WIN32) */
3994 
3995 static void
get_bypass_addresses(struct route_bypass * rb,const unsigned int flags)3996 get_bypass_addresses(struct route_bypass *rb, const unsigned int flags)   /* PLATFORM-SPECIFIC */
3997 {
3998 }
3999 
4000 #endif /* if defined(_WIN32) */
4001 
4002 /*
4003  * Test if addr is reachable via a local interface (return ILA_LOCAL),
4004  * or if it needs to be routed via the default gateway (return
4005  * ILA_NONLOCAL).  If the target platform doesn't implement this
4006  * function, return ILA_NOT_IMPLEMENTED.
4007  *
4008  * Used by redirect-gateway autolocal feature
4009  */
4010 
4011 #if defined(_WIN32)
4012 
4013 int
test_local_addr(const in_addr_t addr,const struct route_gateway_info * rgi)4014 test_local_addr(const in_addr_t addr, const struct route_gateway_info *rgi)
4015 {
4016     struct gc_arena gc = gc_new();
4017     const in_addr_t nonlocal_netmask = 0x80000000L; /* routes with netmask <= to this are considered non-local */
4018     int ret = TLA_NONLOCAL;
4019 
4020     /* get full routing table */
4021     const MIB_IPFORWARDTABLE *rt = get_windows_routing_table(&gc);
4022     if (rt)
4023     {
4024         for (DWORD i = 0; i < rt->dwNumEntries; ++i)
4025         {
4026             const MIB_IPFORWARDROW *row = &rt->table[i];
4027             const in_addr_t net = ntohl(row->dwForwardDest);
4028             const in_addr_t mask = ntohl(row->dwForwardMask);
4029             if (mask > nonlocal_netmask && (addr & mask) == net)
4030             {
4031                 ret = TLA_LOCAL;
4032                 break;
4033             }
4034         }
4035     }
4036 
4037     gc_free(&gc);
4038     return ret;
4039 }
4040 
4041 #else  /* if defined(_WIN32) */
4042 
4043 int
test_local_addr(const in_addr_t addr,const struct route_gateway_info * rgi)4044 test_local_addr(const in_addr_t addr, const struct route_gateway_info *rgi)  /* PLATFORM-SPECIFIC */
4045 {
4046     if (rgi)
4047     {
4048         if (local_route(addr, 0xFFFFFFFF, rgi->gateway.addr, rgi))
4049         {
4050             return TLA_LOCAL;
4051         }
4052         else
4053         {
4054             return TLA_NONLOCAL;
4055         }
4056     }
4057     return TLA_NOT_IMPLEMENTED;
4058 }
4059 
4060 #endif /* if defined(_WIN32) */
4061