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