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 (int 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 unsigned 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 unsigned 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 for (int i = 0; i < rgi->n_addrs; ++i)
1456 {
1457 const struct route_gateway_address *gwa = &rgi->addrs[i];
1458 if (((network ^ gwa->addr) & gwa->netmask) == 0)
1459 {
1460 return LR_MATCH;
1461 }
1462 }
1463 }
1464 }
1465 return LR_NOMATCH;
1466}
1467
1468/* Return true if the "on-link" form of the route should be used. This is when the gateway for
1469 * a route is specified as an interface rather than an address. */
1470#if defined(TARGET_LINUX) || defined(_WIN32) || defined(TARGET_DARWIN)
1471static inline bool
1472is_on_link(const int is_local_route, const unsigned int flags, const struct route_gateway_info *rgi)
1473{
1474 return rgi
1475 && (is_local_route == LR_MATCH
1476 || ((flags & ROUTE_REF_GW) && (rgi->flags & RGI_ON_LINK)));
1477}
1478#endif
1479
1480bool
1481add_route(struct route_ipv4 *r, const struct tuntap *tt, unsigned int flags,
1482 const struct route_gateway_info *rgi, /* may be NULL */
1483 const struct env_set *es, openvpn_net_ctx_t *ctx)
1484{
1485 int status = 0;
1486 int is_local_route;
1487
1488 if (!(r->flags & RT_DEFINED))
1489 {
1490 return true; /* no error */
1491 }
1492
1493 struct argv argv = argv_new();
1494 struct gc_arena gc = gc_new();
1495
1496#if !defined(TARGET_LINUX)
1497 const char *network = print_in_addr_t(r->network, 0, &gc);
1498#if !defined(TARGET_AIX)
1499 const char *netmask = print_in_addr_t(r->netmask, 0, &gc);
1500#endif
1501 const char *gateway = print_in_addr_t(r->gateway, 0, &gc);
1502#endif
1503
1504 is_local_route = local_route(r->network, r->netmask, r->gateway, rgi);
1505 if (is_local_route == LR_ERROR)
1506 {
1507 goto done;
1508 }
1509
1510#if defined(TARGET_LINUX)
1511 const char *iface = NULL;
1512 int metric = -1;
1513
1514 if (is_on_link(is_local_route, flags, rgi))
1515 {
1516 iface = rgi->iface;
1517 }
1518
1519 if (r->flags & RT_METRIC_DEFINED)
1520 {
1521 metric = r->metric;
1522 }
1523
1524
1526 int ret = net_route_v4_add(ctx, &r->network, netmask_to_netbits2(r->netmask), &r->gateway,
1527 iface, r->table_id, metric);
1528 if (ret == -EEXIST)
1529 {
1530 msg(D_ROUTE, "NOTE: Linux route add command failed because route exists");
1532 }
1533 else if (ret < 0)
1534 {
1535 msg(M_WARN, "ERROR: Linux route add command failed");
1536 status = RTA_ERROR;
1537 }
1538
1539#elif defined(TARGET_ANDROID)
1540 char out[128];
1541
1542 if (rgi)
1543 {
1544 snprintf(out, sizeof(out), "%s %s %s dev %s", network, netmask, gateway, rgi->iface);
1545 }
1546 else
1547 {
1548 snprintf(out, sizeof(out), "%s %s %s", network, netmask, gateway);
1549 }
1550 bool ret = management_android_control(management, "ROUTE", out);
1551 status = ret ? RTA_SUCCESS : RTA_ERROR;
1552
1553#elif defined(_WIN32)
1554 {
1555 DWORD ai = TUN_ADAPTER_INDEX_INVALID;
1556 argv_printf(&argv, "%s%s ADD %s MASK %s %s", get_win_sys_path(), WIN_ROUTE_PATH_SUFFIX,
1557 network, netmask, gateway);
1558 if (r->flags & RT_METRIC_DEFINED)
1559 {
1560 argv_printf_cat(&argv, "METRIC %d", r->metric);
1561 }
1562 if (is_on_link(is_local_route, flags, rgi))
1563 {
1564 ai = rgi->adapter_index;
1565 argv_printf_cat(&argv, "IF %lu", ai);
1566 }
1567
1569
1570 const char *method = "service";
1571 if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_SERVICE)
1572 {
1573 status = add_route_service(r, tt);
1574 }
1575 else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_IPAPI)
1576 {
1577 status = add_route_ipapi(r, tt, ai);
1578 method = "ipapi";
1579 }
1580 else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_EXE)
1581 {
1583 bool ret =
1584 openvpn_execve_check(&argv, es, 0, "ERROR: Windows route add command failed");
1585 status = ret ? RTA_SUCCESS : RTA_ERROR;
1587 method = "route.exe";
1588 }
1589 else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_ADAPTIVE)
1590 {
1591 status = add_route_ipapi(r, tt, ai);
1592 method = "ipapi [adaptive]";
1593 if (status == RTA_ERROR)
1594 {
1595 msg(D_ROUTE, "Route addition fallback to route.exe");
1597 bool ret = openvpn_execve_check(
1598 &argv, es, 0, "ERROR: Windows route add command failed [adaptive]");
1599 status = ret ? RTA_SUCCESS : RTA_ERROR;
1601 method = "route.exe";
1602 }
1603 }
1604 else
1605 {
1606 ASSERT(0);
1607 }
1608 if (status != RTA_ERROR) /* error is logged upstream */
1609 {
1610 msg(D_ROUTE, "Route addition via %s %s", method,
1611 (status == RTA_SUCCESS) ? "succeeded" : "failed because route exists");
1612 }
1613 }
1614
1615#elif defined(TARGET_SOLARIS)
1616
1617 /* example: route add 192.0.2.32 -netmask 255.255.255.224 somegateway */
1618
1619 argv_printf(&argv, "%s add", ROUTE_PATH);
1620
1621 argv_printf_cat(&argv, "%s -netmask %s %s", network, netmask, gateway);
1622
1623 /* Solaris can only distinguish between "metric 0" == "on-link on the
1624 * interface where the IP address given is configured" and "metric > 0"
1625 * == "use gateway specified" (no finer-grained route metrics available)
1626 *
1627 * More recent versions of Solaris can also do "-interface", but that
1628 * would break backwards compatibility with older versions for no gain.
1629 */
1630 if (r->flags & RT_METRIC_DEFINED)
1631 {
1632 argv_printf_cat(&argv, "%d", r->metric);
1633 }
1634
1636 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: Solaris route add command failed");
1637 status = ret ? RTA_SUCCESS : RTA_ERROR;
1638
1639#elif defined(TARGET_FREEBSD)
1640
1641 argv_printf(&argv, "%s add", ROUTE_PATH);
1642
1643#if 0
1644 if (r->flags & RT_METRIC_DEFINED)
1645 {
1646 argv_printf_cat(&argv, "-rtt %d", r->metric);
1647 }
1648#endif
1649
1650 argv_printf_cat(&argv, "-net %s %s %s", network, gateway, netmask);
1651
1652 /* FIXME -- add on-link support for FreeBSD */
1653
1655 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: FreeBSD route add command failed");
1656 status = ret ? RTA_SUCCESS : RTA_ERROR;
1657
1658#elif defined(TARGET_DRAGONFLY)
1659
1660 argv_printf(&argv, "%s add", ROUTE_PATH);
1661
1662#if 0
1663 if (r->flags & RT_METRIC_DEFINED)
1664 {
1665 argv_printf_cat(&argv, "-rtt %d", r->metric);
1666 }
1667#endif
1668
1669 argv_printf_cat(&argv, "-net %s %s %s", network, gateway, netmask);
1670
1671 /* FIXME -- add on-link support for Dragonfly */
1672
1674 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: DragonFly route add command failed");
1675 status = ret ? RTA_SUCCESS : RTA_ERROR;
1676
1677#elif defined(TARGET_DARWIN)
1678
1679 argv_printf(&argv, "%s add", ROUTE_PATH);
1680
1681#if 0
1682 if (r->flags & RT_METRIC_DEFINED)
1683 {
1684 argv_printf_cat(&argv, "-rtt %d", r->metric);
1685 }
1686#endif
1687
1688 if (is_on_link(is_local_route, flags, rgi))
1689 {
1690 /* Mac OS X route syntax for ON_LINK:
1691 * route add -cloning -net 10.10.0.1 -netmask 255.255.255.255 -interface en0 */
1692 argv_printf_cat(&argv, "-cloning -net %s -netmask %s -interface %s", network, netmask,
1693 rgi->iface);
1694 }
1695 else
1696 {
1697 argv_printf_cat(&argv, "-net %s %s %s", network, gateway, netmask);
1698 }
1699
1701 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: OS X route add command failed");
1702 status = ret ? RTA_SUCCESS : RTA_ERROR;
1703
1704#elif defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
1705
1706 argv_printf(&argv, "%s add", ROUTE_PATH);
1707
1708#if 0
1709 if (r->flags & RT_METRIC_DEFINED)
1710 {
1711 argv_printf_cat(&argv, "-rtt %d", r->metric);
1712 }
1713#endif
1714
1715 argv_printf_cat(&argv, "-net %s %s -netmask %s", network, gateway, netmask);
1716
1717 /* FIXME -- add on-link support for OpenBSD/NetBSD */
1718
1720 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: OpenBSD/NetBSD route add command failed");
1721 status = ret ? RTA_SUCCESS : RTA_ERROR;
1722
1723#elif defined(TARGET_AIX)
1724
1725 {
1726 int netbits = netmask_to_netbits2(r->netmask);
1727 argv_printf(&argv, "%s add -net %s/%d %s", ROUTE_PATH, network, netbits, gateway);
1729 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: AIX route add command failed");
1730 status = ret ? RTA_SUCCESS : RTA_ERROR;
1731 }
1732
1733#elif defined(TARGET_HAIKU)
1734
1735 /* ex: route add /dev/net/ipro1000/0 0.0.0.0 gw 192.168.1.1 netmask 128.0.0.0 */
1736 argv_printf(&argv, "%s add %s inet %s gw %s netmask %s", ROUTE_PATH, rgi->iface, network,
1737 gateway, netmask);
1739 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: Haiku inet route add command failed");
1740 status = ret ? RTA_SUCCESS : RTA_ERROR;
1741
1742#else /* if defined(TARGET_LINUX) */
1743 msg(M_FATAL,
1744 "Sorry, but I don't know how to do 'route' commands on this operating system. Try putting your routes in a --route-up script");
1745#endif /* if defined(TARGET_LINUX) */
1746
1747done:
1748 if (status == RTA_SUCCESS)
1749 {
1750 r->flags |= RT_ADDED;
1751 }
1752 else
1753 {
1754 r->flags &= ~RT_ADDED;
1755 }
1756 argv_free(&argv);
1757 gc_free(&gc);
1758 /* release resources potentially allocated during route setup */
1759 net_ctx_reset(ctx);
1760
1761 return (status != RTA_ERROR);
1762}
1763
1764void
1766{
1767 /* clear host bit parts of route
1768 * (needed if routes are specified improperly, or if we need to
1769 * explicitly setup/clear the "connected" network routes on some OSes)
1770 */
1771 int byte = 15;
1772 int bits_to_clear = 128 - r6->netbits;
1773
1774 while (byte >= 0 && bits_to_clear > 0)
1775 {
1776 if (bits_to_clear >= 8)
1777 {
1778 r6->network.s6_addr[byte--] = 0;
1779 bits_to_clear -= 8;
1780 }
1781 else
1782 {
1783 r6->network.s6_addr[byte--] &= (0xff << bits_to_clear);
1784 bits_to_clear = 0;
1785 }
1786 }
1787}
1788
1789bool
1790add_route_ipv6(struct route_ipv6 *r6, const struct tuntap *tt, unsigned int flags,
1791 const struct env_set *es, openvpn_net_ctx_t *ctx)
1792{
1793 int status = 0;
1794 bool gateway_needed = false;
1795
1796 if (!(r6->flags & RT_DEFINED))
1797 {
1798 return true; /* no error */
1799 }
1800
1801 struct argv argv = argv_new();
1802 struct gc_arena gc = gc_new();
1803
1804#ifndef _WIN32
1805 const char *device = tt->actual_name;
1806 if (r6->iface != NULL) /* vpn server special route */
1807 {
1808 device = r6->iface;
1809 if (!IN6_IS_ADDR_UNSPECIFIED(&r6->gateway))
1810 {
1811 gateway_needed = true;
1812 }
1813 }
1814#endif
1815
1817 const char *network = print_in6_addr(r6->network, 0, &gc);
1818 const char *gateway = print_in6_addr(r6->gateway, 0, &gc);
1819
1820#if defined(TARGET_DARWIN) || defined(TARGET_FREEBSD) || defined(TARGET_DRAGONFLY) \
1821 || defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
1822
1823 /* the BSD platforms cannot specify gateway and interface independently,
1824 * but for link-local destinations, we MUST specify the interface, so
1825 * we build a combined "$gateway%$interface" gateway string
1826 */
1827 if (r6->iface != NULL && gateway_needed
1828 && IN6_IS_ADDR_LINKLOCAL(&r6->gateway)) /* fe80::...%intf */
1829 {
1830 size_t len = strlen(gateway) + 1 + strlen(r6->iface) + 1;
1831 char *tmp = gc_malloc(len, true, &gc);
1832 snprintf(tmp, len, "%s%%%s", gateway, r6->iface);
1833 gateway = tmp;
1834 }
1835#endif
1836
1837#ifndef _WIN32
1838 msg(D_ROUTE, "add_route_ipv6(%s/%d -> %s metric %d) dev %s", network, r6->netbits, gateway,
1839 r6->metric, device);
1840#else
1841 msg(D_ROUTE, "add_route_ipv6(%s/%d -> %s metric %d) IF %lu", network, r6->netbits, gateway,
1842 r6->metric, r6->adapter_index ? r6->adapter_index : tt->adapter_index);
1843#endif
1844
1845 /*
1846 * Filter out routes which are essentially no-ops
1847 * (not currently done for IPv6)
1848 */
1849
1850 /* On "tun" interface, we never set a gateway if the operating system
1851 * can do "route to interface" - it does not add value, as the target
1852 * dev already fully qualifies the route destination on point-to-point
1853 * interfaces. OTOH, on "tap" interface, we must always set the
1854 * gateway unless the route is to be an on-link network
1855 */
1856 if (tt->type == DEV_TYPE_TAP && !((r6->flags & RT_METRIC_DEFINED) && r6->metric == 0))
1857 {
1858 gateway_needed = true;
1859 }
1860
1861 if (gateway_needed && IN6_IS_ADDR_UNSPECIFIED(&r6->gateway))
1862 {
1863 msg(M_WARN,
1864 "ROUTE6 WARNING: " PACKAGE_NAME " needs a gateway "
1865 "parameter for a --route-ipv6 option and no default was set via "
1866 "--ifconfig-ipv6 or --route-ipv6-gateway option. Not installing "
1867 "IPv6 route to %s/%d.",
1868 network, r6->netbits);
1869 status = 0;
1870 goto done;
1871 }
1872
1873#if defined(TARGET_LINUX)
1874 int metric = -1;
1875 if ((r6->flags & RT_METRIC_DEFINED) && (r6->metric > 0))
1876 {
1877 metric = r6->metric;
1878 }
1879
1881 int ret = net_route_v6_add(ctx, &r6->network, r6->netbits, gateway_needed ? &r6->gateway : NULL,
1882 device, r6->table_id, metric);
1883 if (ret == -EEXIST)
1884 {
1885 msg(D_ROUTE, "NOTE: Linux route add command failed because route exists");
1887 }
1888 else if (ret < 0)
1889 {
1890 msg(M_WARN, "ERROR: Linux route add command failed");
1891 status = RTA_ERROR;
1892 }
1893
1894#elif defined(TARGET_ANDROID)
1895 char out[64];
1896
1897 snprintf(out, sizeof(out), "%s/%d %s", network, r6->netbits, device);
1898
1899 status = management_android_control(management, "ROUTE6", out);
1900
1901#elif defined(_WIN32)
1902
1903 if (tt->options.msg_channel)
1904 {
1906 }
1907 else
1908 {
1909 status = route_ipv6_ipapi(true, r6, tt);
1910 }
1911#elif defined(TARGET_SOLARIS)
1912
1913 /* example: route add -inet6 2001:db8::/32 somegateway 0 */
1914
1915 /* for some reason, routes to tun/tap do not work for me unless I set
1916 * "metric 0" - otherwise, the routes will be nicely installed, but
1917 * packets will just disappear somewhere. So we always use "0" now,
1918 * unless the route points to "gateway on other interface"...
1919 *
1920 * (Note: OpenSolaris can not specify host%interface gateways, so we just
1921 * use the GW addresses - it seems to still work for fe80:: addresses,
1922 * however this is done internally. NUD maybe?)
1923 */
1924 argv_printf(&argv, "%s add -inet6 %s/%d %s", ROUTE_PATH, network, r6->netbits, gateway);
1925
1926 /* on tun (not tap), not "elsewhere"? -> metric 0 */
1927 if (tt->type == DEV_TYPE_TUN && !r6->iface)
1928 {
1929 argv_printf_cat(&argv, "0");
1930 }
1931
1933 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: Solaris route add -inet6 command failed");
1934 status = ret ? RTA_SUCCESS : RTA_ERROR;
1935
1936#elif defined(TARGET_FREEBSD) || defined(TARGET_DRAGONFLY)
1937
1938 argv_printf(&argv, "%s add -inet6 %s/%d", ROUTE_PATH, network, r6->netbits);
1939
1940 if (gateway_needed)
1941 {
1942 argv_printf_cat(&argv, "%s", gateway);
1943 }
1944 else
1945 {
1946 argv_printf_cat(&argv, "-iface %s", device);
1947 }
1948
1950 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: *BSD route add -inet6 command failed");
1951 status = ret ? RTA_SUCCESS : RTA_ERROR;
1952
1953#elif defined(TARGET_DARWIN)
1954
1955 argv_printf(&argv, "%s add -inet6 %s -prefixlen %d", ROUTE_PATH, network, r6->netbits);
1956
1957 if (gateway_needed)
1958 {
1959 argv_printf_cat(&argv, "%s", gateway);
1960 }
1961 else
1962 {
1963 argv_printf_cat(&argv, "-iface %s", device);
1964 }
1965
1967 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: MacOS X route add -inet6 command failed");
1968 status = ret ? RTA_SUCCESS : RTA_ERROR;
1969
1970#elif defined(TARGET_OPENBSD)
1971
1972 argv_printf(&argv, "%s add -inet6 %s -prefixlen %d %s", ROUTE_PATH, network, r6->netbits,
1973 gateway);
1974
1976 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: OpenBSD route add -inet6 command failed");
1977 status = ret ? RTA_SUCCESS : RTA_ERROR;
1978
1979#elif defined(TARGET_NETBSD)
1980
1981 argv_printf(&argv, "%s add -inet6 %s/%d %s", ROUTE_PATH, network, r6->netbits, gateway);
1982
1984 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: NetBSD route add -inet6 command failed");
1985 status = ret ? RTA_SUCCESS : RTA_ERROR;
1986
1987#elif defined(TARGET_AIX)
1988
1989 argv_printf(&argv, "%s add -inet6 %s/%d %s", ROUTE_PATH, network, r6->netbits, gateway);
1991 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: AIX route add command failed");
1992 status = ret ? RTA_SUCCESS : RTA_ERROR;
1993
1994#elif defined(TARGET_HAIKU)
1995
1996 /* ex: route add /dev/net/ipro1000/0 inet6 :: gw beef::cafe prefixlen 64 */
1997 argv_printf(&argv, "%s add %s inet6 %s gw %s prefixlen %d", ROUTE_PATH, r6->iface, network,
1998 gateway, r6->netbits);
2000 bool ret = openvpn_execve_check(&argv, es, 0, "ERROR: Haiku inet6 route add command failed");
2001 status = ret ? RTA_SUCCESS : RTA_ERROR;
2002
2003#else /* if defined(TARGET_LINUX) */
2004 msg(M_FATAL,
2005 "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");
2006#endif /* if defined(TARGET_LINUX) */
2007
2008done:
2009 if (status == RTA_SUCCESS)
2010 {
2011 r6->flags |= RT_ADDED;
2012 }
2013 else
2014 {
2015 r6->flags &= ~RT_ADDED;
2016 }
2017 argv_free(&argv);
2018 gc_free(&gc);
2019 /* release resources potentially allocated during route setup */
2020 net_ctx_reset(ctx);
2021
2022 return (status != RTA_ERROR);
2023}
2024
2025static void
2026delete_route(struct route_ipv4 *r, const struct tuntap *tt, unsigned int flags,
2027 const struct route_gateway_info *rgi, const struct env_set *es, openvpn_net_ctx_t *ctx)
2028{
2029#if !defined(TARGET_LINUX)
2030 const char *network;
2031#if !defined(TARGET_AIX)
2032 const char *netmask;
2033#endif
2034 const char *gateway;
2035#else /* if !defined(TARGET_LINUX) */
2036 int metric;
2037#endif
2038 int is_local_route;
2039
2040 if ((r->flags & (RT_DEFINED | RT_ADDED)) != (RT_DEFINED | RT_ADDED))
2041 {
2042 return;
2043 }
2044
2045 struct gc_arena gc = gc_new();
2046 struct argv argv = argv_new();
2047
2048#if !defined(TARGET_LINUX)
2049 network = print_in_addr_t(r->network, 0, &gc);
2050#if !defined(TARGET_AIX)
2051 netmask = print_in_addr_t(r->netmask, 0, &gc);
2052#endif
2053 gateway = print_in_addr_t(r->gateway, 0, &gc);
2054#endif
2055
2056 is_local_route = local_route(r->network, r->netmask, r->gateway, rgi);
2057 if (is_local_route == LR_ERROR)
2058 {
2059 goto done;
2060 }
2061
2062#if defined(TARGET_LINUX)
2063 metric = -1;
2064 if (r->flags & RT_METRIC_DEFINED)
2065 {
2066 metric = r->metric;
2067 }
2068
2069 if (net_route_v4_del(ctx, &r->network, netmask_to_netbits2(r->netmask), &r->gateway, NULL,
2070 r->table_id, metric)
2071 < 0)
2072 {
2073 msg(M_WARN, "ERROR: Linux route delete command failed");
2074 }
2075#elif defined(_WIN32)
2076
2077 argv_printf(&argv, "%s%s DELETE %s MASK %s %s", get_win_sys_path(), WIN_ROUTE_PATH_SUFFIX,
2078 network, netmask, gateway);
2079
2081
2082 if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_SERVICE)
2083 {
2084 const bool status = del_route_service(r, tt);
2085 msg(D_ROUTE, "Route deletion via service %s", status ? "succeeded" : "failed");
2086 }
2087 else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_IPAPI)
2088 {
2089 const bool status = del_route_ipapi(r, tt);
2090 msg(D_ROUTE, "Route deletion via IPAPI %s", status ? "succeeded" : "failed");
2091 }
2092 else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_EXE)
2093 {
2095 openvpn_execve_check(&argv, es, 0, "ERROR: Windows route delete command failed");
2097 }
2098 else if ((flags & ROUTE_METHOD_MASK) == ROUTE_METHOD_ADAPTIVE)
2099 {
2100 const bool status = del_route_ipapi(r, tt);
2101 msg(D_ROUTE, "Route deletion via IPAPI %s [adaptive]", status ? "succeeded" : "failed");
2102 if (!status)
2103 {
2104 msg(D_ROUTE, "Route deletion fallback to route.exe");
2107 "ERROR: Windows route delete command failed [adaptive]");
2109 }
2110 }
2111 else
2112 {
2113 ASSERT(0);
2114 }
2115
2116#elif defined(TARGET_SOLARIS)
2117
2118 argv_printf(&argv, "%s delete %s -netmask %s %s", ROUTE_PATH, network, netmask, gateway);
2119
2121 openvpn_execve_check(&argv, es, 0, "ERROR: Solaris route delete command failed");
2122
2123#elif defined(TARGET_FREEBSD)
2124
2125 argv_printf(&argv, "%s delete -net %s %s %s", ROUTE_PATH, network, gateway, netmask);
2126
2128 openvpn_execve_check(&argv, es, 0, "ERROR: FreeBSD route delete command failed");
2129
2130#elif defined(TARGET_DRAGONFLY)
2131
2132 argv_printf(&argv, "%s delete -net %s %s %s", ROUTE_PATH, network, gateway, netmask);
2133
2135 openvpn_execve_check(&argv, es, 0, "ERROR: DragonFly route delete command failed");
2136
2137#elif defined(TARGET_DARWIN)
2138
2139 if (is_on_link(is_local_route, flags, rgi))
2140 {
2141 argv_printf(&argv, "%s delete -cloning -net %s -netmask %s -interface %s", ROUTE_PATH,
2142 network, netmask, rgi->iface);
2143 }
2144 else
2145 {
2146 argv_printf(&argv, "%s delete -net %s %s %s", ROUTE_PATH, network, gateway, netmask);
2147 }
2148
2150 openvpn_execve_check(&argv, es, 0, "ERROR: OS X route delete command failed");
2151
2152#elif defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
2153
2154 argv_printf(&argv, "%s delete -net %s %s -netmask %s", ROUTE_PATH, network, gateway, netmask);
2155
2157 openvpn_execve_check(&argv, es, 0, "ERROR: OpenBSD/NetBSD route delete command failed");
2158
2159#elif defined(TARGET_ANDROID)
2160 /* Avoids the unused variables warnings that all other platforms use
2161 * by adding them to the error message. */
2162 msg(D_ROUTE_DEBUG, "Deleting routes on Android is not possible/not "
2163 "needed. The VpnService API allows routes to be set "
2164 "on connect only and will clean up automatically. "
2165 "Tried to delete route %s netmask %s gateway %s",
2166 network, netmask, gateway);
2167#elif defined(TARGET_AIX)
2168
2169 {
2170 int netbits = netmask_to_netbits2(r->netmask);
2171 argv_printf(&argv, "%s delete -net %s/%d %s", ROUTE_PATH, network, netbits, gateway);
2173 openvpn_execve_check(&argv, es, 0, "ERROR: AIX route delete command failed");
2174 }
2175
2176#elif defined(TARGET_HAIKU)
2177
2178 /* ex: route delete /dev/net/ipro1000/0 inet 192.168.0.0 gw 192.168.1.1 netmask 255.255.0.0 */
2179 argv_printf(&argv, "%s delete %s inet %s gw %s netmask %s", ROUTE_PATH, rgi->iface, network,
2180 gateway, netmask);
2182 openvpn_execve_check(&argv, es, 0, "ERROR: Haiku inet route delete command failed");
2183
2184#else /* if defined(TARGET_LINUX) */
2185 msg(M_FATAL,
2186 "Sorry, but I don't know how to do 'route' commands on this operating system. Try putting your routes in a --route-up script");
2187#endif /* if defined(TARGET_LINUX) */
2188
2189done:
2190 r->flags &= ~RT_ADDED;
2191 argv_free(&argv);
2192 gc_free(&gc);
2193 /* release resources potentially allocated during route cleanup */
2194 net_ctx_reset(ctx);
2195}
2196
2197void
2198delete_route_ipv6(const struct route_ipv6 *r6, const struct tuntap *tt, const struct env_set *es,
2199 openvpn_net_ctx_t *ctx)
2200{
2201 const char *network;
2202
2203 if ((r6->flags & (RT_DEFINED | RT_ADDED)) != (RT_DEFINED | RT_ADDED))
2204 {
2205 return;
2206 }
2207
2208#if !defined(_WIN32)
2209#if !defined(TARGET_LINUX)
2210 const char *gateway;
2211#endif
2212#if !defined(TARGET_SOLARIS)
2213 bool gateway_needed = false;
2214 const char *device = tt->actual_name;
2215 if (r6->iface != NULL) /* vpn server special route */
2216 {
2217 device = r6->iface;
2218 gateway_needed = true;
2219 }
2220 (void)device; /* unused on some platforms */
2221
2222 /* if we used a gateway on "add route", we also need to specify it on
2223 * delete, otherwise some OSes will refuse to delete the route
2224 */
2225 if (tt->type == DEV_TYPE_TAP && !((r6->flags & RT_METRIC_DEFINED) && r6->metric == 0))
2226 {
2227 gateway_needed = true;
2228 }
2229#endif
2230#endif
2231
2232 struct gc_arena gc = gc_new();
2233 struct argv argv = argv_new();
2234
2235 network = print_in6_addr(r6->network, 0, &gc);
2236#if !defined(TARGET_LINUX) && !defined(_WIN32)
2237 gateway = print_in6_addr(r6->gateway, 0, &gc);
2238#endif
2239
2240#if defined(TARGET_DARWIN) || defined(TARGET_FREEBSD) || defined(TARGET_DRAGONFLY) \
2241 || defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
2242
2243 /* the BSD platforms cannot specify gateway and interface independently,
2244 * but for link-local destinations, we MUST specify the interface, so
2245 * we build a combined "$gateway%$interface" gateway string
2246 */
2247 if (r6->iface != NULL && gateway_needed
2248 && IN6_IS_ADDR_LINKLOCAL(&r6->gateway)) /* fe80::...%intf */
2249 {
2250 size_t len = strlen(gateway) + 1 + strlen(r6->iface) + 1;
2251 char *tmp = gc_malloc(len, true, &gc);
2252 snprintf(tmp, len, "%s%%%s", gateway, r6->iface);
2253 gateway = tmp;
2254 }
2255#endif
2256
2257 msg(D_ROUTE, "delete_route_ipv6(%s/%d)", network, r6->netbits);
2258
2259#if defined(TARGET_LINUX)
2260 int metric = -1;
2261 if ((r6->flags & RT_METRIC_DEFINED) && (r6->metric > 0))
2262 {
2263 metric = r6->metric;
2264 }
2265
2266 if (net_route_v6_del(ctx, &r6->network, r6->netbits, gateway_needed ? &r6->gateway : NULL,
2267 device, r6->table_id, metric)
2268 < 0)
2269 {
2270 msg(M_WARN, "ERROR: Linux route v6 delete command failed");
2271 }
2272
2273#elif defined(_WIN32)
2274
2275 if (tt->options.msg_channel)
2276 {
2278 }
2279 else
2280 {
2281 route_ipv6_ipapi(false, r6, tt);
2282 }
2283#elif defined(TARGET_SOLARIS)
2284
2285 /* example: route delete -inet6 2001:db8::/32 somegateway */
2286
2287 argv_printf(&argv, "%s delete -inet6 %s/%d %s", ROUTE_PATH, network, r6->netbits, gateway);
2288
2290 openvpn_execve_check(&argv, es, 0, "ERROR: Solaris route delete -inet6 command failed");
2291
2292#elif defined(TARGET_FREEBSD) || defined(TARGET_DRAGONFLY)
2293
2294 argv_printf(&argv, "%s delete -inet6 %s/%d", ROUTE_PATH, network, r6->netbits);
2295
2296 if (gateway_needed)
2297 {
2298 argv_printf_cat(&argv, "%s", gateway);
2299 }
2300 else
2301 {
2302 argv_printf_cat(&argv, "-iface %s", device);
2303 }
2304
2306 openvpn_execve_check(&argv, es, 0, "ERROR: *BSD route delete -inet6 command failed");
2307
2308#elif defined(TARGET_DARWIN)
2309
2310 argv_printf(&argv, "%s delete -inet6 %s -prefixlen %d", ROUTE_PATH, network, r6->netbits);
2311
2312 if (gateway_needed)
2313 {
2314 argv_printf_cat(&argv, "%s", gateway);
2315 }
2316 else
2317 {
2318 argv_printf_cat(&argv, "-iface %s", device);
2319 }
2320
2322 openvpn_execve_check(&argv, es, 0, "ERROR: MacOS X route delete -inet6 command failed");
2323
2324#elif defined(TARGET_OPENBSD)
2325
2326 argv_printf(&argv, "%s delete -inet6 %s -prefixlen %d %s", ROUTE_PATH, network, r6->netbits,
2327 gateway);
2328
2330 openvpn_execve_check(&argv, es, 0, "ERROR: OpenBSD route delete -inet6 command failed");
2331
2332#elif defined(TARGET_NETBSD)
2333
2334 argv_printf(&argv, "%s delete -inet6 %s/%d %s", ROUTE_PATH, network, r6->netbits, gateway);
2335
2337 openvpn_execve_check(&argv, es, 0, "ERROR: NetBSD route delete -inet6 command failed");
2338
2339#elif defined(TARGET_AIX)
2340
2341 argv_printf(&argv, "%s delete -inet6 %s/%d %s", ROUTE_PATH, network, r6->netbits, gateway);
2343 openvpn_execve_check(&argv, es, 0, "ERROR: AIX route add command failed");
2344
2345#elif defined(TARGET_ANDROID)
2346 msg(D_ROUTE_DEBUG, "Deleting routes on Android is not possible/not "
2347 "needed. The VpnService API allows routes to be set "
2348 "on connect only and will clean up automatically. "
2349 "Tried to delete %s gateway %s",
2350 network,
2351 gateway_needed ? gateway : "(not needed)");
2352#elif defined(TARGET_HAIKU)
2353
2354 /* ex: route delete /dev/net/ipro1000/0 inet6 :: gw beef::cafe prefixlen 64 */
2355 argv_printf(&argv, "%s delete %s inet6 %s gw %s prefixlen %d", ROUTE_PATH, r6->iface, network,
2356 gateway, r6->netbits);
2358 openvpn_execve_check(&argv, es, 0, "ERROR: Haiku inet6 route delete command failed");
2359
2360#else /* if defined(TARGET_LINUX) */
2361 msg(M_FATAL,
2362 "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");
2363#endif /* if defined(TARGET_LINUX) */
2364
2365 argv_free(&argv);
2366 gc_free(&gc);
2367 /* release resources potentially allocated during route cleanup */
2368 net_ctx_reset(ctx);
2369}
2370
2371/*
2372 * The --redirect-gateway option requires OS-specific code below
2373 * to get the current default gateway.
2374 */
2375
2376#if defined(_WIN32)
2377
2378static const MIB_IPFORWARDTABLE *
2380{
2381 ULONG size = 0;
2382 PMIB_IPFORWARDTABLE rt = NULL;
2383 DWORD status;
2384
2385 status = GetIpForwardTable(NULL, &size, TRUE);
2386 if (status == ERROR_INSUFFICIENT_BUFFER)
2387 {
2388 rt = (PMIB_IPFORWARDTABLE)gc_malloc(size, false, gc);
2389 status = GetIpForwardTable(rt, &size, TRUE);
2390 if (status != NO_ERROR)
2391 {
2392 msg(D_ROUTE, "NOTE: GetIpForwardTable returned error: %s (code=%u)",
2393 strerror_win32(status, gc), (unsigned int)status);
2394 rt = NULL;
2395 }
2396 }
2397 return rt;
2398}
2399
2400static int
2401test_route(const IP_ADAPTER_INFO *adapters, const in_addr_t gateway, DWORD *index)
2402{
2403 int count = 0;
2404 DWORD i = adapter_index_of_ip(adapters, gateway, &count, NULL);
2405 if (index)
2406 {
2407 *index = i;
2408 }
2409 return count;
2410}
2411
2412static void
2413test_route_helper(bool *ret, int *count, int *good, int *ambig, const IP_ADAPTER_INFO *adapters,
2414 const in_addr_t gateway)
2415{
2416 int c;
2417
2418 ++*count;
2419 c = test_route(adapters, gateway, NULL);
2420 if (c == 0)
2421 {
2422 *ret = false;
2423 }
2424 else
2425 {
2426 ++*good;
2427 }
2428 if (c > 1)
2429 {
2430 ++*ambig;
2431 }
2432}
2433
2434/*
2435 * If we tried to add routes now, would we succeed?
2436 */
2437bool
2438test_routes(const struct route_list *rl, const struct tuntap *tt)
2439{
2440 struct gc_arena gc = gc_new();
2441 const IP_ADAPTER_INFO *adapters = get_adapter_info_list(&gc);
2442 bool ret = false;
2443 int count = 0;
2444 int good = 0;
2445 int ambig = 0;
2446 int len = -1;
2447 bool adapter_up = false;
2448
2449 if (is_adapter_up(tt, adapters))
2450 {
2451 ret = true;
2452 adapter_up = true;
2453
2454 /* we do this test only if we have IPv4 routes to install, and if
2455 * the tun/tap interface has seen IPv4 ifconfig - because if we
2456 * have no IPv4, the check will always fail, failing tun init
2457 */
2458 if (rl && tt->did_ifconfig_setup)
2459 {
2460 struct route_ipv4 *r;
2461 for (r = rl->routes, len = 0; r; r = r->next, ++len)
2462 {
2463 test_route_helper(&ret, &count, &good, &ambig, adapters, r->gateway);
2464 }
2465
2466 if ((rl->flags & RG_ENABLE) && (rl->spec.flags & RTSA_REMOTE_ENDPOINT))
2467 {
2468 test_route_helper(&ret, &count, &good, &ambig, adapters, rl->spec.remote_endpoint);
2469 }
2470 }
2471 }
2472
2473 msg(D_ROUTE, "TEST ROUTES: %d/%d succeeded len=%d ret=%d a=%d u/d=%s", good, count, len,
2474 (int)ret, ambig, adapter_up ? "up" : "down");
2475
2476 gc_free(&gc);
2477 return ret;
2478}
2479
2480static const MIB_IPFORWARDROW *
2481get_default_gateway_row(const MIB_IPFORWARDTABLE *routes)
2482{
2483 struct gc_arena gc = gc_new();
2484 DWORD lowest_metric = MAXDWORD;
2485 const MIB_IPFORWARDROW *ret = NULL;
2486 int best = -1;
2487
2488 if (routes)
2489 {
2490 for (DWORD i = 0; i < routes->dwNumEntries; ++i)
2491 {
2492 const MIB_IPFORWARDROW *row = &routes->table[i];
2493 const in_addr_t net = ntohl(row->dwForwardDest);
2494 const in_addr_t mask = ntohl(row->dwForwardMask);
2495 const DWORD index = row->dwForwardIfIndex;
2496 const DWORD metric = row->dwForwardMetric1;
2497
2498 dmsg(D_ROUTE_DEBUG, "GDGR: route[%lu] %s/%s i=%d m=%d", i,
2499 print_in_addr_t((in_addr_t)net, 0, &gc), print_in_addr_t((in_addr_t)mask, 0, &gc),
2500 (int)index, (int)metric);
2501
2502 if (!net && !mask && metric < lowest_metric)
2503 {
2504 ret = row;
2505 lowest_metric = metric;
2506 best = i;
2507 }
2508 }
2509 }
2510
2511 dmsg(D_ROUTE_DEBUG, "GDGR: best=%d lm=%u", best, (unsigned int)lowest_metric);
2512
2513 gc_free(&gc);
2514 return ret;
2515}
2516
2528static DWORD
2529get_best_route(struct gc_arena *gc, SOCKADDR_INET *dest, MIB_IPFORWARD_ROW2 *best_route)
2530{
2531 DWORD best_if_index;
2532 DWORD status;
2533
2534 CLEAR(*best_route);
2535
2536 /* get the best interface index to reach dest */
2537 status = GetBestInterfaceEx((struct sockaddr *)dest, &best_if_index);
2538 if (status != NO_ERROR)
2539 {
2540 msg(D_ROUTE, "NOTE: GetBestInterfaceEx returned error: %s (code=%u)",
2541 strerror_win32(status, gc), (unsigned int)status);
2542 goto done;
2543 }
2544
2545 msg(D_ROUTE_DEBUG, "GetBestInterfaceEx() returned if=%d", (int)best_if_index);
2546
2547 /* get the routing information (such as NextHop) for the destination and interface */
2548 NET_LUID luid;
2549 CLEAR(luid);
2550 SOCKADDR_INET best_src;
2551 CLEAR(best_src);
2552 status = GetBestRoute2(&luid, best_if_index, NULL, dest, 0, best_route, &best_src);
2553 if (status != NO_ERROR)
2554 {
2555 msg(D_ROUTE, "NOTE: GetIpForwardEntry2 returned error: %s (code=%u)",
2556 strerror_win32(status, gc), (unsigned int)status);
2557 goto done;
2558 }
2559
2560done:
2561 return status;
2562}
2563
2564void
2566{
2567 CLEAR(*rgi);
2568
2569 struct gc_arena gc = gc_new();
2570
2571 /* convert in_addr_t into SOCKADDR_INET */
2572 SOCKADDR_INET sa;
2573 CLEAR(sa);
2574 sa.si_family = AF_INET;
2575 sa.Ipv4.sin_addr.s_addr = htonl(dest);
2576
2577 /* get the best route to the destination */
2578 MIB_IPFORWARD_ROW2 best_route;
2579 CLEAR(best_route);
2580 DWORD status = get_best_route(&gc, &sa, &best_route);
2581 if (status != NO_ERROR)
2582 {
2583 goto done;
2584 }
2585
2587 rgi->gateway.addr = ntohl(best_route.NextHop.Ipv4.sin_addr.S_un.S_addr);
2588 rgi->adapter_index = best_route.InterfaceIndex;
2589
2590 if (rgi->gateway.addr == INADDR_ANY)
2591 {
2592 rgi->flags |= RGI_ON_LINK;
2593 }
2594
2595 /* get netmask and MAC address */
2596 const IP_ADAPTER_INFO *adapters = get_adapter_info_list(&gc);
2597 const IP_ADAPTER_INFO *ai = get_adapter(adapters, rgi->adapter_index);
2598 if (ai)
2599 {
2600 memcpy(rgi->hwaddr, ai->Address, 6);
2601 rgi->flags |= RGI_HWADDR_DEFINED;
2602
2603 /* get netmask for non-onlink routes */
2604 in_addr_t nm = inet_addr(ai->IpAddressList.IpMask.String);
2605 if (!(rgi->flags & RGI_ON_LINK) && (nm != INADDR_NONE))
2606 {
2607 rgi->gateway.netmask = ntohl(nm);
2608 rgi->flags |= RGI_NETMASK_DEFINED;
2609 }
2610 }
2611
2612done:
2613 gc_free(&gc);
2614}
2615
2616static DWORD
2617windows_route_find_if_index(const struct route_ipv4 *r, const struct tuntap *tt)
2618{
2619 struct gc_arena gc = gc_new();
2620 DWORD ret = TUN_ADAPTER_INDEX_INVALID;
2621 int count = 0;
2622 const IP_ADAPTER_INFO *adapters = get_adapter_info_list(&gc);
2623 const IP_ADAPTER_INFO *tun_adapter = get_tun_adapter(tt, adapters);
2624 bool on_tun = false;
2625
2626 /* first test on tun interface */
2627 if (is_ip_in_adapter_subnet(tun_adapter, r->gateway, NULL))
2628 {
2629 ret = tun_adapter->Index;
2630 count = 1;
2631 on_tun = true;
2632 }
2633 else /* test on other interfaces */
2634 {
2635 count = test_route(adapters, r->gateway, &ret);
2636 }
2637
2638 if (count == 0)
2639 {
2640 msg(M_WARN, "Warning: route gateway is not reachable on any active network adapters: %s",
2641 print_in_addr_t(r->gateway, 0, &gc));
2643 }
2644 else if (count > 1)
2645 {
2646 msg(M_WARN, "Warning: route gateway is ambiguous: %s (%d matches)",
2647 print_in_addr_t(r->gateway, 0, &gc), count);
2648 }
2649
2650 dmsg(D_ROUTE_DEBUG, "DEBUG: route find if: on_tun=%d count=%d index=%d", on_tun, count,
2651 (int)ret);
2652
2653 gc_free(&gc);
2654 return ret;
2655}
2656
2657/* IPv6 implementation using GetBestRoute2()
2658 * (TBD: dynamic linking so the binary can still run on XP?)
2659 * https://msdn.microsoft.com/en-us/library/windows/desktop/aa365922(v=vs.85).aspx
2660 * https://msdn.microsoft.com/en-us/library/windows/desktop/aa814411(v=vs.85).aspx
2661 */
2662void
2663get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6, const struct in6_addr *dest,
2664 openvpn_net_ctx_t *ctx)
2665{
2666 struct gc_arena gc = gc_new();
2667 CLEAR(*rgi6);
2668
2669 SOCKADDR_INET DestinationAddress;
2670 CLEAR(DestinationAddress);
2671 DestinationAddress.si_family = AF_INET6;
2672 if (dest)
2673 {
2674 DestinationAddress.Ipv6.sin6_addr = *dest;
2675 }
2676
2677 MIB_IPFORWARD_ROW2 BestRoute;
2678 CLEAR(BestRoute);
2679 DWORD status = get_best_route(&gc, &DestinationAddress, &BestRoute);
2680
2681 if (status != NO_ERROR)
2682 {
2683 goto done;
2684 }
2685
2686 msg(D_ROUTE, "GDG6: II=%lu DP=%s/%d NH=%s", BestRoute.InterfaceIndex,
2687 print_in6_addr(BestRoute.DestinationPrefix.Prefix.Ipv6.sin6_addr, 0, &gc),
2688 BestRoute.DestinationPrefix.PrefixLength,
2689 print_in6_addr(BestRoute.NextHop.Ipv6.sin6_addr, 0, &gc));
2690 msg(D_ROUTE, "GDG6: Metric=%d, Loopback=%d, AA=%d, I=%d", (int)BestRoute.Metric,
2691 (int)BestRoute.Loopback, (int)BestRoute.AutoconfigureAddress, (int)BestRoute.Immortal);
2692
2693 rgi6->gateway.addr_ipv6 = BestRoute.NextHop.Ipv6.sin6_addr;
2694 rgi6->adapter_index = BestRoute.InterfaceIndex;
2696
2697 /* on-link is signalled by receiving an empty (::) NextHop */
2698 if (IN6_IS_ADDR_UNSPECIFIED(&BestRoute.NextHop.Ipv6.sin6_addr))
2699 {
2700 rgi6->flags |= RGI_ON_LINK;
2701 }
2702
2703done:
2704 gc_free(&gc);
2705}
2706
2707/* Returns RTA_SUCCESS on success, RTA_EEXIST if route exists, RTA_ERROR on error */
2708static int
2709add_route_ipapi(const struct route_ipv4 *r, const struct tuntap *tt, DWORD adapter_index)
2710{
2711 struct gc_arena gc = gc_new();
2712 int ret = RTA_ERROR;
2713 DWORD status;
2714 const DWORD if_index = (adapter_index == TUN_ADAPTER_INDEX_INVALID)
2716 : adapter_index;
2717
2718 if (if_index != TUN_ADAPTER_INDEX_INVALID)
2719 {
2720 MIB_IPFORWARDROW fr;
2721 CLEAR(fr);
2722 fr.dwForwardDest = htonl(r->network);
2723 fr.dwForwardMask = htonl(r->netmask);
2724 fr.dwForwardPolicy = 0;
2725 fr.dwForwardNextHop = htonl(r->gateway);
2726 fr.dwForwardIfIndex = if_index;
2727 fr.dwForwardType = 4; /* the next hop is not the final dest */
2728 fr.dwForwardProto = 3; /* PROTO_IP_NETMGMT */
2729 fr.dwForwardAge = 0;
2730 fr.dwForwardNextHopAS = 0;
2731 fr.dwForwardMetric1 = (r->flags & RT_METRIC_DEFINED) ? r->metric : 1;
2732 fr.dwForwardMetric2 = METRIC_NOT_USED;
2733 fr.dwForwardMetric3 = METRIC_NOT_USED;
2734 fr.dwForwardMetric4 = METRIC_NOT_USED;
2735 fr.dwForwardMetric5 = METRIC_NOT_USED;
2736
2737 if ((r->network & r->netmask) != r->network)
2738 {
2739 msg(M_WARN, "Warning: address %s is not a network address in relation to netmask %s",
2740 print_in_addr_t(r->network, 0, &gc), print_in_addr_t(r->netmask, 0, &gc));
2741 }
2742
2743 status = CreateIpForwardEntry(&fr);
2744
2745 if (status == NO_ERROR)
2746 {
2747 ret = RTA_SUCCESS;
2748 }
2749 else if (status == ERROR_OBJECT_ALREADY_EXISTS)
2750 {
2751 ret = RTA_EEXIST;
2752 }
2753 else
2754 {
2755 /* failed, try increasing the metric to work around Vista issue */
2756 const unsigned int forward_metric_limit =
2757 2048; /* iteratively retry higher metrics up to this limit */
2758
2759 for (; fr.dwForwardMetric1 <= forward_metric_limit; ++fr.dwForwardMetric1)
2760 {
2761 /* try a different forward type=3 ("the next hop is the final dest") in addition
2762 * to 4.
2763 * --redirect-gateway over RRAS seems to need this. */
2764 for (fr.dwForwardType = 4; fr.dwForwardType >= 3; --fr.dwForwardType)
2765 {
2766 status = CreateIpForwardEntry(&fr);
2767 if (status == NO_ERROR)
2768 {
2769 msg(D_ROUTE,
2770 "ROUTE: CreateIpForwardEntry succeeded with dwForwardMetric1=%u and dwForwardType=%u",
2771 (unsigned int)fr.dwForwardMetric1, (unsigned int)fr.dwForwardType);
2772 ret = RTA_SUCCESS;
2773 goto doublebreak;
2774 }
2775 else if (status != ERROR_BAD_ARGUMENTS)
2776 {
2777 goto doublebreak;
2778 }
2779 }
2780 }
2781
2782doublebreak:
2783 if (status != NO_ERROR)
2784 {
2785 if (status == ERROR_OBJECT_ALREADY_EXISTS)
2786 {
2787 ret = RTA_EEXIST;
2788 }
2789 else
2790 {
2791 msg(M_WARN,
2792 "ERROR: route addition failed using CreateIpForwardEntry: "
2793 "%s [status=%u if_index=%u]",
2794 strerror_win32(status, &gc), (unsigned int)status, (unsigned int)if_index);
2795 }
2796 }
2797 }
2798 }
2799
2800 gc_free(&gc);
2801 return ret;
2802}
2803
2804static bool
2805del_route_ipapi(const struct route_ipv4 *r, const struct tuntap *tt)
2806{
2807 struct gc_arena gc = gc_new();
2808 bool ret = false;
2809 DWORD status;
2810 const DWORD if_index = windows_route_find_if_index(r, tt);
2811
2812 if (if_index != TUN_ADAPTER_INDEX_INVALID)
2813 {
2814 MIB_IPFORWARDROW fr;
2815 CLEAR(fr);
2816
2817 fr.dwForwardDest = htonl(r->network);
2818 fr.dwForwardMask = htonl(r->netmask);
2819 fr.dwForwardPolicy = 0;
2820 fr.dwForwardNextHop = htonl(r->gateway);
2821 fr.dwForwardIfIndex = if_index;
2822
2823 status = DeleteIpForwardEntry(&fr);
2824
2825 if (status == NO_ERROR)
2826 {
2827 ret = true;
2828 }
2829 else
2830 {
2831 msg(M_WARN, "ERROR: route deletion failed using DeleteIpForwardEntry: %s",
2833 }
2834 }
2835
2836 gc_free(&gc);
2837 return ret;
2838}
2839
2840/* Returns RTA_SUCCESS on success, RTA_EEXIST if route exists, RTA_ERROR on error */
2841static int
2842do_route_service(const bool add, const route_message_t *rt, const DWORD size, HANDLE pipe)
2843{
2844 int ret = RTA_ERROR;
2845 ack_message_t ack;
2846 struct gc_arena gc = gc_new();
2847
2848 if (!send_msg_iservice(pipe, rt, size, &ack, "ROUTE"))
2849 {
2850 goto out;
2851 }
2852
2853 if (ack.error_number != NO_ERROR)
2854 {
2855 ret = (ack.error_number == ERROR_OBJECT_ALREADY_EXISTS) ? RTA_EEXIST : RTA_ERROR;
2856 if (ret == RTA_ERROR)
2857 {
2858 msg(M_WARN, "ERROR: route %s failed using service: %s [status=%u if_index=%d]",
2859 (add ? "addition" : "deletion"), strerror_win32(ack.error_number, &gc),
2860 ack.error_number, rt->iface.index);
2861 }
2862 goto out;
2863 }
2864
2865 ret = RTA_SUCCESS;
2866
2867out:
2868 gc_free(&gc);
2869 return ret;
2870}
2871
2872#if defined(__GNUC__) || defined(__clang__)
2873#pragma GCC diagnostic push
2874#pragma GCC diagnostic ignored "-Wsign-compare"
2875#endif
2876
2877/* Returns RTA_SUCCESS on success, RTA_EEXIST if route exists, RTA_ERROR on error */
2878static int
2879do_route_ipv4_service(const bool add, const struct route_ipv4 *r, const struct tuntap *tt)
2880{
2881 DWORD if_index = windows_route_find_if_index(r, tt);
2882 if (if_index == ~0)
2883 {
2884 return RTA_ERROR;
2885 }
2886
2888 sizeof(route_message_t), 0 },
2889 .family = AF_INET,
2890 .prefix.ipv4.s_addr = htonl(r->network),
2891 .gateway.ipv4.s_addr = htonl(r->gateway),
2892 .iface = { .index = if_index, .name = "" },
2893 .metric = (r->flags & RT_METRIC_DEFINED ? r->metric : -1) };
2894
2895 netmask_to_netbits(r->network, r->netmask, &msg.prefix_len);
2896 if (msg.prefix_len == -1)
2897 {
2898 msg.prefix_len = 32;
2899 }
2900
2901 return do_route_service(add, &msg, sizeof(msg), tt->options.msg_channel);
2902}
2903
2904/* Add or delete an ipv6 route
2905 * Returns RTA_SUCCESS on success, RTA_EEXIST if route exists, RTA_ERROR on error
2906 */
2907static int
2908route_ipv6_ipapi(const bool add, const struct route_ipv6 *r, const struct tuntap *tt)
2909{
2910 DWORD err;
2911 int ret = RTA_ERROR;
2912 PMIB_IPFORWARD_ROW2 fwd_row;
2913 struct gc_arena gc = gc_new();
2914
2915 fwd_row = gc_malloc(sizeof(*fwd_row), true, &gc);
2916
2917 fwd_row->ValidLifetime = 0xffffffff;
2918 fwd_row->PreferredLifetime = 0xffffffff;
2919 fwd_row->Protocol = MIB_IPPROTO_NETMGMT;
2920 fwd_row->Metric = ((r->flags & RT_METRIC_DEFINED) ? r->metric : -1);
2921 fwd_row->DestinationPrefix.Prefix.si_family = AF_INET6;
2922 fwd_row->DestinationPrefix.Prefix.Ipv6.sin6_addr = r->network;
2923 fwd_row->DestinationPrefix.PrefixLength = (UINT8)r->netbits;
2924 fwd_row->NextHop.si_family = AF_INET6;
2925 fwd_row->NextHop.Ipv6.sin6_addr = r->gateway;
2926 fwd_row->InterfaceIndex = r->adapter_index ? r->adapter_index : tt->adapter_index;
2927
2928 /* In TUN mode we use a special link-local address as the next hop.
2929 * The tapdrvr knows about it and will answer neighbor discovery packets.
2930 * (only do this for routes actually using the tun/tap device)
2931 */
2932 if (tt->type == DEV_TYPE_TUN && !r->adapter_index)
2933 {
2934 inet_pton(AF_INET6, "fe80::8", &fwd_row->NextHop.Ipv6.sin6_addr);
2935 }
2936
2937 /* Use LUID if interface index not available */
2938 if (fwd_row->InterfaceIndex == TUN_ADAPTER_INDEX_INVALID && strlen(tt->actual_name))
2939 {
2940 NET_LUID luid;
2941 err = ConvertInterfaceAliasToLuid(wide_string(tt->actual_name, &gc), &luid);
2942 if (err != NO_ERROR)
2943 {
2944 goto out;
2945 }
2946 fwd_row->InterfaceLuid = luid;
2947 fwd_row->InterfaceIndex = 0;
2948 }
2949
2950 if (add)
2951 {
2952 err = CreateIpForwardEntry2(fwd_row);
2953 }
2954 else
2955 {
2956 err = DeleteIpForwardEntry2(fwd_row);
2957 }
2958
2959out:
2960 if (err != NO_ERROR)
2961 {
2962 ret = (err == ERROR_OBJECT_ALREADY_EXISTS) ? RTA_EEXIST : RTA_ERROR;
2963 if (ret == RTA_ERROR)
2964 {
2965 msg(M_WARN, "ERROR: route %s failed using ipapi: %s [status=%lu if_index=%lu]",
2966 (add ? "addition" : "deletion"), strerror_win32(err, &gc), err,
2967 fwd_row->InterfaceIndex);
2968 }
2969 else if (add)
2970 {
2971 msg(D_ROUTE, "IPv6 route addition using ipapi failed because route exists");
2972 }
2973 }
2974 else
2975 {
2976 msg(D_ROUTE, "IPv6 route %s using ipapi", add ? "added" : "deleted");
2977 ret = RTA_SUCCESS;
2978 }
2979 gc_free(&gc);
2980 return ret;
2981}
2982
2983/* Returns RTA_SUCCESS on success, RTA_EEXIST if route exists, RTA_ERROR on error */
2984static int
2985do_route_ipv6_service(const bool add, const struct route_ipv6 *r, const struct tuntap *tt)
2986{
2987 int status;
2989 sizeof(route_message_t), 0 },
2990 .family = AF_INET6,
2991 .prefix.ipv6 = r->network,
2992 .prefix_len = r->netbits,
2993 .gateway.ipv6 = r->gateway,
2994 .iface = { .index = tt->adapter_index, .name = "" },
2995 .metric = ((r->flags & RT_METRIC_DEFINED) ? r->metric : -1) };
2996
2997 if (r->adapter_index) /* vpn server special route */
2998 {
2999 msg.iface.index = r->adapter_index;
3000 }
3001
3002 /* In TUN mode we use a special link-local address as the next hop.
3003 * The tapdrvr knows about it and will answer neighbor discovery packets.
3004 * (only do this for routes actually using the tun/tap device)
3005 */
3006 if (tt->type == DEV_TYPE_TUN && msg.iface.index == tt->adapter_index)
3007 {
3008 inet_pton(AF_INET6, "fe80::8", &msg.gateway.ipv6);
3009 }
3010
3011 if (msg.iface.index == TUN_ADAPTER_INDEX_INVALID)
3012 {
3013 strncpy(msg.iface.name, tt->actual_name, sizeof(msg.iface.name));
3014 msg.iface.name[sizeof(msg.iface.name) - 1] = '\0';
3015 }
3016
3017 status = do_route_service(add, &msg, sizeof(msg), tt->options.msg_channel);
3018 if (status != RTA_ERROR)
3019 {
3020 msg(D_ROUTE, "IPv6 route %s via service %s", add ? "addition" : "deletion",
3021 (status == RTA_SUCCESS) ? "succeeded" : "failed because route exists");
3022 }
3023 return status;
3024}
3025
3026#if defined(__GNUC__) || defined(__clang__)
3027#pragma GCC diagnostic pop
3028#endif
3029
3030/* Returns RTA_SUCCESS on success, RTA_EEXIST if route exists, RTA_ERROR on error */
3031static int
3032add_route_service(const struct route_ipv4 *r, const struct tuntap *tt)
3033{
3034 return do_route_ipv4_service(true, r, tt);
3035}
3036
3037static bool
3038del_route_service(const struct route_ipv4 *r, const struct tuntap *tt)
3039{
3040 return do_route_ipv4_service(false, r, tt);
3041}
3042
3043/* Returns RTA_SUCCESS on success, RTA_EEXIST if route exists, RTA_ERROR on error */
3044static int
3045add_route_ipv6_service(const struct route_ipv6 *r, const struct tuntap *tt)
3046{
3047 return do_route_ipv6_service(true, r, tt);
3048}
3049
3050static bool
3051del_route_ipv6_service(const struct route_ipv6 *r, const struct tuntap *tt)
3052{
3053 return do_route_ipv6_service(false, r, tt);
3054}
3055
3056static const char *
3057format_route_entry(const MIB_IPFORWARDROW *r, struct gc_arena *gc)
3058{
3059 struct buffer out = alloc_buf_gc(256, gc);
3060 buf_printf(&out, "%s %s %s p=%d i=%d t=%d pr=%d a=%d h=%d m=%d/%d/%d/%d/%d",
3061 print_in_addr_t(r->dwForwardDest, IA_NET_ORDER, gc),
3062 print_in_addr_t(r->dwForwardMask, IA_NET_ORDER, gc),
3063 print_in_addr_t(r->dwForwardNextHop, IA_NET_ORDER, gc), (int)r->dwForwardPolicy,
3064 (int)r->dwForwardIfIndex, (int)r->dwForwardType, (int)r->dwForwardProto,
3065 (int)r->dwForwardAge, (int)r->dwForwardNextHopAS, (int)r->dwForwardMetric1,
3066 (int)r->dwForwardMetric2, (int)r->dwForwardMetric3, (int)r->dwForwardMetric4,
3067 (int)r->dwForwardMetric5);
3068 return BSTR(&out);
3069}
3070
3071/*
3072 * Show current routing table
3073 */
3074void
3076{
3077 struct gc_arena gc = gc_new();
3078
3079 const MIB_IPFORWARDTABLE *rt = get_windows_routing_table(&gc);
3080
3081 msg(msglevel, "SYSTEM ROUTING TABLE");
3082 if (rt)
3083 {
3084 for (DWORD i = 0; i < rt->dwNumEntries; ++i)
3085 {
3086 msg(msglevel, "%s", format_route_entry(&rt->table[i], &gc));
3087 }
3088 }
3089 gc_free(&gc);
3090}
3091
3092#elif defined(TARGET_ANDROID)
3093
3094void
3096{
3097 /* Android, set some pseudo GW, addr is in host byte order,
3098 * Determining the default GW on Android 5.0+ is non trivial
3099 * and serves almost no purpose since OpenVPN only uses the
3100 * default GW address to add routes for networks that should
3101 * NOT be routed over the VPN. Using a well known address
3102 * (127.'d'.'g'.'w') for the default GW make detecting
3103 * these routes easier from the controlling app.
3104 */
3105 CLEAR(*rgi);
3106
3107 rgi->gateway.addr = 127 << 24 | 'd' << 16 | 'g' << 8 | 'w';
3109 strcpy(rgi->iface, "android-gw");
3110
3111 /* Skip scanning/fetching interface from loopback interface we do
3112 * normally on Linux.
3113 * It always fails and "ioctl(SIOCGIFCONF) failed" confuses users
3114 */
3115}
3116
3117void
3118get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6, const struct in6_addr *dest,
3119 openvpn_net_ctx_t *ctx)
3120{
3121 /* Same for ipv6 */
3122
3123 CLEAR(*rgi6);
3124
3125 /* Use a fake link-local address */
3126 ASSERT(inet_pton(AF_INET6, "fe80::ad", &rgi6->addrs->addr_ipv6) == 1);
3127 rgi6->addrs->netbits_ipv6 = 64;
3129 strcpy(rgi6->iface, "android-gw");
3130}
3131
3132#elif defined(TARGET_LINUX)
3133
3134void
3136{
3137 struct gc_arena gc = gc_new();
3138 int sd = -1;
3139 char best_name[IFNAMSIZ];
3140
3141 CLEAR(*rgi);
3142 CLEAR(best_name);
3143
3144 /* find best route to 'dest', get gateway IP addr + interface */
3145 if (net_route_v4_best_gw(ctx, &dest, &rgi->gateway.addr, best_name) == 0)
3146 {
3147 rgi->flags |= RGI_ADDR_DEFINED;
3148 if (!rgi->gateway.addr && best_name[0])
3149 {
3150 rgi->flags |= RGI_ON_LINK;
3151 }
3152 }
3153
3154 /* scan adapter list */
3155 if (rgi->flags & RGI_ADDR_DEFINED)
3156 {
3157 struct ifreq *ifr, *ifend;
3158 in_addr_t addr, netmask;
3159 struct ifreq ifreq;
3160 struct ifconf ifc;
3161 struct ifreq ifs[20]; /* Maximum number of interfaces to scan */
3162
3163 if ((sd = socket(AF_INET, SOCK_DGRAM, 0)) < 0)
3164 {
3165 msg(M_WARN, "GDG: socket() failed");
3166 goto done;
3167 }
3168 ifc.ifc_len = sizeof(ifs);
3169 ifc.ifc_req = ifs;
3170 if (ioctl(sd, SIOCGIFCONF, &ifc) < 0)
3171 {
3172 msg(M_WARN, "GDG: ioctl(SIOCGIFCONF) failed");
3173 goto done;
3174 }
3175
3176 /* scan through interface list */
3177 ifend = ifs + (ifc.ifc_len / sizeof(struct ifreq));
3178 for (ifr = ifc.ifc_req; ifr < ifend; ifr++)
3179 {
3180 if (ifr->ifr_addr.sa_family == AF_INET)
3181 {
3182 /* get interface addr */
3183 addr = ntohl(((struct sockaddr_in *)&ifr->ifr_addr)->sin_addr.s_addr);
3184
3185 /* get interface name */
3186 strncpynt(ifreq.ifr_name, ifr->ifr_name, sizeof(ifreq.ifr_name));
3187
3188 /* check that the interface is up */
3189 if (ioctl(sd, SIOCGIFFLAGS, &ifreq) < 0)
3190 {
3191 continue;
3192 }
3193 if (!(ifreq.ifr_flags & IFF_UP))
3194 {
3195 continue;
3196 }
3197
3198 if (rgi->flags & RGI_ON_LINK)
3199 {
3200 /* check that interface name of current interface
3201 * matches interface name of best default route */
3202 if (strcmp(ifreq.ifr_name, best_name))
3203 {
3204 continue;
3205 }
3206#if 0
3207 /* if point-to-point link, use remote addr as route gateway */
3208 if ((ifreq.ifr_flags & IFF_POINTOPOINT) && ioctl(sd, SIOCGIFDSTADDR, &ifreq) >= 0)
3209 {
3210 rgi->gateway.addr = ntohl(((struct sockaddr_in *) &ifreq.ifr_addr)->sin_addr.s_addr);
3211 if (rgi->gateway.addr)
3212 {
3213 rgi->flags &= ~RGI_ON_LINK;
3214 }
3215 }
3216#endif
3217 }
3218 else
3219 {
3220 /* get interface netmask */
3221 if (ioctl(sd, SIOCGIFNETMASK, &ifreq) < 0)
3222 {
3223 continue;
3224 }
3225 netmask = ntohl(((struct sockaddr_in *)&ifreq.ifr_addr)->sin_addr.s_addr);
3226
3227 /* check that interface matches default route */
3228 if (((rgi->gateway.addr ^ addr) & netmask) != 0)
3229 {
3230 continue;
3231 }
3232
3233 /* save netmask */
3234 rgi->gateway.netmask = netmask;
3235 rgi->flags |= RGI_NETMASK_DEFINED;
3236 }
3237
3238 /* save iface name */
3239 strncpynt(rgi->iface, ifreq.ifr_name, sizeof(rgi->iface));
3240 rgi->flags |= RGI_IFACE_DEFINED;
3241
3242 /* now get the hardware address. */
3243 memset(&ifreq.ifr_hwaddr, 0, sizeof(struct sockaddr));
3244 if (ioctl(sd, SIOCGIFHWADDR, &ifreq) < 0)
3245 {
3246 msg(M_WARN, "GDG: SIOCGIFHWADDR(%s) failed", ifreq.ifr_name);
3247 goto done;
3248 }
3249 memcpy(rgi->hwaddr, &ifreq.ifr_hwaddr.sa_data, 6);
3250 rgi->flags |= RGI_HWADDR_DEFINED;
3251
3252 break;
3253 }
3254 }
3255 }
3256
3257done:
3258 if (sd >= 0)
3259 {
3260 close(sd);
3261 }
3262 gc_free(&gc);
3263}
3264
3265/* IPv6 implementation using netlink
3266 * https://www.linuxjournal.com/article/7356 - "Kernel Korner - Why and How to Use Netlink Socket"
3267 * netlink(3), netlink(7), rtnetlink(7)
3268 * https://www.virtualbox.org/svn/vbox/trunk/src/VBox/NetworkServices/NAT/
3269 */
3270struct rtreq
3271{
3272 struct nlmsghdr nh;
3273 struct rtmsg rtm;
3274 char attrbuf[512];
3275};
3276
3277void
3278get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6, const struct in6_addr *dest,
3279 openvpn_net_ctx_t *ctx)
3280{
3281 int flags;
3282
3283 CLEAR(*rgi6);
3284
3285 if (net_route_v6_best_gw(ctx, dest, &rgi6->gateway.addr_ipv6, rgi6->iface) == 0)
3286 {
3287 if (!IN6_IS_ADDR_UNSPECIFIED(&rgi6->gateway.addr_ipv6))
3288 {
3289 rgi6->flags |= RGI_ADDR_DEFINED;
3290 }
3291
3292 if (strlen(rgi6->iface) > 0)
3293 {
3294 rgi6->flags |= RGI_IFACE_DEFINED;
3295 }
3296 }
3297
3298 /* if we have an interface but no gateway, the destination is on-link */
3299 flags = rgi6->flags & (RGI_IFACE_DEFINED | RGI_ADDR_DEFINED);
3300 if (flags == RGI_IFACE_DEFINED)
3301 {
3302 rgi6->flags |= (RGI_ADDR_DEFINED | RGI_ON_LINK);
3303 if (dest)
3304 {
3305 rgi6->gateway.addr_ipv6 = *dest;
3306 }
3307 }
3308}
3309
3310#elif defined(TARGET_DARWIN) || defined(TARGET_SOLARIS) || defined(TARGET_FREEBSD) \
3311 || defined(TARGET_DRAGONFLY) || defined(TARGET_OPENBSD) || defined(TARGET_NETBSD)
3312
3313#include <sys/types.h>
3314#include <sys/socket.h>
3315#include <netinet/in.h>
3316#include <net/route.h>
3317#include <net/if_dl.h>
3318#if !defined(TARGET_SOLARIS)
3319#include <ifaddrs.h>
3320#endif
3321
3322struct rtmsg
3323{
3324 struct rt_msghdr m_rtm;
3325 char m_space[512];
3326};
3327
3328/* the route socket code is identical for all 4 supported BSDs and for
3329 * MacOS X (Darwin), with one crucial difference: when going from
3330 * 32 bit to 64 bit, FreeBSD/OpenBSD increased the structure size but kept
3331 * source code compatibility by keeping the use of "long", while
3332 * MacOS X decided to keep binary compatibility by *changing* the API
3333 * to use "uint32_t", thus 32 bit on all OS X variants
3334 *
3335 * NetBSD does the MacOS way of "fixed number of bits, no matter if
3336 * 32 or 64 bit OS", but chose uint64_t. For maximum portability, we
3337 * just use the OS RT_ROUNDUP() macro, which is guaranteed to be correct.
3338 *
3339 * We used to have a large amount of duplicate code here which really
3340 * differed only in this (long) vs. (uint32_t) - IMHO, worse than
3341 * having a combined block for all BSDs with this single #ifdef inside
3342 */
3343
3344#if defined(TARGET_DARWIN)
3345#define ROUNDUP(a) ((a) > 0 ? (1 + (((a) - 1) | (sizeof(uint32_t) - 1))) : sizeof(uint32_t))
3346#elif defined(TARGET_NETBSD)
3347#define ROUNDUP(a) RT_ROUNDUP(a)
3348#else
3349#define ROUNDUP(a) ((a) > 0 ? (1 + (((a) - 1) | (sizeof(long) - 1))) : sizeof(long))
3350#endif
3351
3352#if defined(TARGET_SOLARIS)
3353#define NEXTADDR(w, u) \
3354 if (rtm_addrs & (w)) \
3355 { \
3356 size_t l = sizeof(u); \
3357 memmove(cp, &(u), l); \
3358 cp += ROUNDUP(l); \
3359 }
3360
3361#define ADVANCE(x, n) (x += ROUNDUP(sizeof(struct sockaddr_in)))
3362#else /* if defined(TARGET_SOLARIS) */
3363#define NEXTADDR(w, u) \
3364 if (rtm_addrs & (w)) \
3365 { \
3366 size_t l = ((struct sockaddr *)&(u))->sa_len; \
3367 memmove(cp, &(u), l); \
3368 cp += ROUNDUP(l); \
3369 }
3370
3371#define ADVANCE(x, n) (x += ROUNDUP((n)->sa_len))
3372#endif
3373
3374#define max(a, b) ((a) > (b) ? (a) : (b))
3375
3376void
3378{
3379 struct gc_arena gc = gc_new();
3380 struct rtmsg m_rtmsg;
3381 int sockfd = -1;
3382 int rtm_addrs;
3383 struct sockaddr so_dst, so_mask;
3384 char *cp = m_rtmsg.m_space;
3385 struct sockaddr *gate = NULL, *ifp = NULL, *sa;
3386 struct rt_msghdr *rtm_aux;
3387
3388#define rtm m_rtmsg.m_rtm
3389
3390 CLEAR(*rgi);
3391
3392 /* setup data to send to routing socket */
3393 const int pid = getpid();
3394 int seq = 0;
3395#ifdef TARGET_OPENBSD
3396 rtm_addrs = RTA_DST | RTA_NETMASK; /* Kernel refuses RTA_IFP */
3397#else
3398 rtm_addrs = RTA_DST | RTA_NETMASK | RTA_IFP;
3399#endif
3400
3401 bzero(&m_rtmsg, sizeof(m_rtmsg));
3402 bzero(&so_dst, sizeof(so_dst));
3403 bzero(&so_mask, sizeof(so_mask));
3404 bzero(&rtm, sizeof(struct rt_msghdr));
3405
3406 rtm.rtm_type = RTM_GET;
3407 rtm.rtm_flags = RTF_UP | RTF_GATEWAY;
3408 rtm.rtm_version = RTM_VERSION;
3409 rtm.rtm_seq = ++seq;
3410#ifdef TARGET_OPENBSD
3411 rtm.rtm_tableid = (u_short)getrtable();
3412#endif
3413 rtm.rtm_addrs = rtm_addrs;
3414
3415 so_dst.sa_family = AF_INET;
3416 so_mask.sa_family = AF_INET;
3417
3418#ifndef TARGET_SOLARIS
3419 so_dst.sa_len = sizeof(struct sockaddr_in);
3420 so_mask.sa_len = sizeof(struct sockaddr_in);
3421#endif
3422
3423 NEXTADDR(RTA_DST, so_dst);
3424 NEXTADDR(RTA_NETMASK, so_mask);
3425
3426 /* sizeof(struct rt_msghdr) + padding */
3427 rtm.rtm_msglen = (u_short)(cp - (char *)&m_rtmsg);
3428
3429 /* transact with routing socket */
3430 sockfd = socket(PF_ROUTE, SOCK_RAW, 0);
3431 if (sockfd < 0)
3432 {
3433 msg(M_WARN, "GDG: socket #1 failed");
3434 goto done;
3435 }
3436 if (write(sockfd, (char *)&m_rtmsg, rtm.rtm_msglen) < 0)
3437 {
3438 msg(M_WARN | M_ERRNO, "GDG: problem writing to routing socket");
3439 goto done;
3440 }
3441 ssize_t ret;
3442 do
3443 {
3444 ret = read(sockfd, (char *)&m_rtmsg, sizeof(m_rtmsg));
3445 } while (ret > 0 && (rtm.rtm_seq != seq || rtm.rtm_pid != pid));
3446 close(sockfd);
3447 sockfd = -1;
3448
3449 /* extract return data from routing socket */
3450 rtm_aux = &rtm;
3451 cp = (char *)(rtm_aux + 1);
3452 if (rtm_aux->rtm_addrs)
3453 {
3454 for (unsigned int i = 1; i; i <<= 1)
3455 {
3456 if (i & rtm_aux->rtm_addrs)
3457 {
3458 sa = (struct sockaddr *)cp;
3459 if (i == RTA_GATEWAY)
3460 {
3461 gate = sa;
3462 }
3463 else if (i == RTA_IFP)
3464 {
3465 ifp = sa;
3466 }
3467 ADVANCE(cp, sa);
3468 }
3469 }
3470 }
3471 else
3472 {
3473 goto done;
3474 }
3475
3476 /* get gateway addr and interface name */
3477 if (gate != NULL)
3478 {
3479 /* get default gateway addr */
3480 rgi->gateway.addr = ntohl(((struct sockaddr_in *)gate)->sin_addr.s_addr);
3481 if (rgi->gateway.addr)
3482 {
3483 rgi->flags |= RGI_ADDR_DEFINED;
3484 }
3485
3486 if (ifp)
3487 {
3488 /* get interface name */
3489 const struct sockaddr_dl *adl = (struct sockaddr_dl *)ifp;
3490 if (adl->sdl_nlen && adl->sdl_nlen < sizeof(rgi->iface))
3491 {
3492 memcpy(rgi->iface, adl->sdl_data, adl->sdl_nlen);
3493 rgi->iface[adl->sdl_nlen] = '\0';
3494 rgi->flags |= RGI_IFACE_DEFINED;
3495 }
3496 }
3497 }
3498
3499 /* get netmask of interface that owns default gateway */
3500 if (rgi->flags & RGI_IFACE_DEFINED)
3501 {
3502 struct ifreq ifr;
3503
3504 sockfd = socket(AF_INET, SOCK_DGRAM, 0);
3505 if (sockfd < 0)
3506 {
3507 msg(M_WARN, "GDG: socket #2 failed");
3508 goto done;
3509 }
3510
3511 CLEAR(ifr);
3512 ifr.ifr_addr.sa_family = AF_INET;
3513 strncpynt(ifr.ifr_name, rgi->iface, IFNAMSIZ);
3514
3515 if (ioctl(sockfd, SIOCGIFNETMASK, (char *)&ifr) < 0)
3516 {
3517 msg(M_WARN, "GDG: ioctl #1 failed");
3518 goto done;
3519 }
3520 close(sockfd);
3521 sockfd = -1;
3522
3523 rgi->gateway.netmask = ntohl(((struct sockaddr_in *)&ifr.ifr_addr)->sin_addr.s_addr);
3524 rgi->flags |= RGI_NETMASK_DEFINED;
3525 }
3526
3527 /* try to read MAC addr associated with interface that owns default gateway */
3528 if (rgi->flags & RGI_IFACE_DEFINED)
3529 {
3530#if defined(TARGET_SOLARIS)
3531 /* OpenSolaris has getifaddrs(3), but it does not return AF_LINK */
3532 sockfd = socket(AF_INET, SOCK_DGRAM, 0);
3533 if (sockfd < 0)
3534 {
3535 msg(M_WARN, "GDG: socket #3 failed");
3536 goto done;
3537 }
3538
3539 struct ifreq ifreq = { 0 };
3540
3541 /* now get the hardware address. */
3542 strncpynt(ifreq.ifr_name, rgi->iface, sizeof(ifreq.ifr_name));
3543 if (ioctl(sockfd, SIOCGIFHWADDR, &ifreq) < 0)
3544 {
3545 msg(M_WARN, "GDG: SIOCGIFHWADDR(%s) failed", ifreq.ifr_name);
3546 }
3547 else
3548 {
3549 memcpy(rgi->hwaddr, &ifreq.ifr_addr.sa_data, 6);
3550 rgi->flags |= RGI_HWADDR_DEFINED;
3551 }
3552#else /* if defined(TARGET_SOLARIS) */
3553 struct ifaddrs *ifap, *ifa;
3554
3555 if (getifaddrs(&ifap) != 0)
3556 {
3557 msg(M_WARN | M_ERRNO, "GDG: getifaddrs() failed");
3558 goto done;
3559 }
3560
3561 for (ifa = ifap; ifa; ifa = ifa->ifa_next)
3562 {
3563 if (ifa->ifa_addr != NULL && ifa->ifa_addr->sa_family == AF_LINK
3564 && !strncmp(ifa->ifa_name, rgi->iface, IFNAMSIZ))
3565 {
3566 struct sockaddr_dl *sdl = (struct sockaddr_dl *)ifa->ifa_addr;
3567 memcpy(rgi->hwaddr, LLADDR(sdl), 6);
3568 rgi->flags |= RGI_HWADDR_DEFINED;
3569 }
3570 }
3571
3572 freeifaddrs(ifap);
3573#endif /* if defined(TARGET_SOLARIS) */
3574 }
3575
3576done:
3577 if (sockfd >= 0)
3578 {
3579 close(sockfd);
3580 }
3581 gc_free(&gc);
3582}
3583
3584/* BSD implementation using routing socket (as does IPv4)
3585 * (the code duplication is somewhat unavoidable if we want this to
3586 * work on OpenSolaris as well. *sigh*)
3587 */
3588
3589/* Solaris has no length field - this is ugly, but less #ifdef in total
3590 */
3591#if defined(TARGET_SOLARIS)
3592#undef ADVANCE
3593#define ADVANCE(x, n) (x += ROUNDUP(sizeof(struct sockaddr_in6)))
3594#endif
3595
3596void
3597get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6, const struct in6_addr *dest,
3598 openvpn_net_ctx_t *ctx)
3599{
3600 struct rtmsg m_rtmsg;
3601 int sockfd = -1;
3602 int rtm_addrs;
3603 struct sockaddr_in6 so_dst, so_mask;
3604 char *cp = m_rtmsg.m_space;
3605 struct sockaddr *gate = NULL, *ifp = NULL, *sa;
3606 struct rt_msghdr *rtm_aux;
3607
3608 CLEAR(*rgi6);
3609
3610 /* setup data to send to routing socket */
3611 const int pid = getpid();
3612 int seq = 0;
3613#ifdef TARGET_OPENBSD
3614 rtm_addrs = RTA_DST | RTA_NETMASK; /* Kernel refuses RTA_IFP */
3615#else
3616 rtm_addrs = RTA_DST | RTA_NETMASK | RTA_IFP;
3617#endif
3618
3619 bzero(&m_rtmsg, sizeof(m_rtmsg));
3620 bzero(&so_dst, sizeof(so_dst));
3621 bzero(&so_mask, sizeof(so_mask));
3622 bzero(&rtm, sizeof(struct rt_msghdr));
3623
3624 rtm.rtm_type = RTM_GET;
3625 rtm.rtm_flags = RTF_UP;
3626 rtm.rtm_version = RTM_VERSION;
3627 rtm.rtm_seq = ++seq;
3628#ifdef TARGET_OPENBSD
3629 rtm.rtm_tableid = (u_short)getrtable();
3630#endif
3631
3632 so_dst.sin6_family = AF_INET6;
3633 so_mask.sin6_family = AF_INET6;
3634
3635 if (dest != NULL /* specific host? */
3636 && !IN6_IS_ADDR_UNSPECIFIED(dest))
3637 {
3638 so_dst.sin6_addr = *dest;
3639 /* :: needs /0 "netmask", host route wants "no netmask */
3640 rtm_addrs &= ~RTA_NETMASK;
3641 }
3642
3643 rtm.rtm_addrs = rtm_addrs;
3644
3645#ifndef TARGET_SOLARIS
3646 so_dst.sin6_len = sizeof(struct sockaddr_in6);
3647 so_mask.sin6_len = sizeof(struct sockaddr_in6);
3648#endif
3649
3650 NEXTADDR(RTA_DST, so_dst);
3651 NEXTADDR(RTA_NETMASK, so_mask);
3652
3653 /* sizeof(struct rt_msghdr) + padding */
3654 rtm.rtm_msglen = (u_short)(cp - (char *)&m_rtmsg);
3655
3656 /* transact with routing socket */
3657 sockfd = socket(PF_ROUTE, SOCK_RAW, 0);
3658 if (sockfd < 0)
3659 {
3660 msg(M_WARN, "GDG6: socket #1 failed");
3661 goto done;
3662 }
3663 if (write(sockfd, (char *)&m_rtmsg, rtm.rtm_msglen) < 0)
3664 {
3665 msg(M_WARN | M_ERRNO, "GDG6: problem writing to routing socket");
3666 goto done;
3667 }
3668 ssize_t ret;
3669 do
3670 {
3671 ret = read(sockfd, (char *)&m_rtmsg, sizeof(m_rtmsg));
3672 } while (ret > 0 && (rtm.rtm_seq != seq || rtm.rtm_pid != pid));
3673
3674 close(sockfd);
3675 sockfd = -1;
3676
3677 /* extract return data from routing socket */
3678 rtm_aux = &rtm;
3679 cp = (char *)(rtm_aux + 1);
3680 if (rtm_aux->rtm_addrs)
3681 {
3682 for (unsigned int i = 1; i; i <<= 1)
3683 {
3684 if (i & rtm_aux->rtm_addrs)
3685 {
3686 sa = (struct sockaddr *)cp;
3687 if (i == RTA_GATEWAY)
3688 {
3689 gate = sa;
3690 }
3691 else if (i == RTA_IFP)
3692 {
3693 ifp = sa;
3694 }
3695 ADVANCE(cp, sa);
3696 }
3697 }
3698 }
3699 else
3700 {
3701 goto done;
3702 }
3703
3704 /* get gateway addr and interface name */
3705 if (gate != NULL)
3706 {
3707 struct sockaddr_in6 *s6 = (struct sockaddr_in6 *)gate;
3708 struct in6_addr gw = s6->sin6_addr;
3709
3710#ifndef TARGET_SOLARIS
3711 /* You do not really want to know... from FreeBSD's route.c
3712 * (KAME encodes the 16 bit scope_id in s6_addr[2] + [3],
3713 * but for a correct link-local address these must be :0000: )
3714 */
3715 if (gate->sa_len == sizeof(struct sockaddr_in6) && IN6_IS_ADDR_LINKLOCAL(&gw))
3716 {
3717 gw.s6_addr[2] = gw.s6_addr[3] = 0;
3718 }
3719
3720 if (gate->sa_len != sizeof(struct sockaddr_in6) || IN6_IS_ADDR_UNSPECIFIED(&gw))
3721 {
3722 rgi6->flags |= RGI_ON_LINK;
3723 }
3724 else
3725#endif
3726 {
3727 rgi6->gateway.addr_ipv6 = gw;
3728 }
3729 rgi6->flags |= RGI_ADDR_DEFINED;
3730
3731 if (ifp)
3732 {
3733 /* get interface name */
3734 const struct sockaddr_dl *adl = (struct sockaddr_dl *)ifp;
3735 if (adl->sdl_nlen && adl->sdl_nlen < sizeof(rgi6->iface))
3736 {
3737 memcpy(rgi6->iface, adl->sdl_data, adl->sdl_nlen);
3738 rgi6->flags |= RGI_IFACE_DEFINED;
3739 }
3740 }
3741 }
3742
3743done:
3744 if (sockfd >= 0)
3745 {
3746 close(sockfd);
3747 }
3748}
3749
3750#undef max
3751
3752#elif defined(TARGET_HAIKU)
3753
3754void
3756{
3757 CLEAR(*rgi);
3758
3759 int sockfd = socket(AF_INET, SOCK_DGRAM, 0);
3760 if (sockfd < 0)
3761 {
3762 msg(M_ERRNO, "%s: Error opening socket for AF_INET", __func__);
3763 return;
3764 }
3765
3766 struct ifconf config;
3767 config.ifc_len = sizeof(config.ifc_value);
3768 if (ioctl(sockfd, SIOCGRTSIZE, &config, sizeof(struct ifconf)) < 0)
3769 {
3770 msg(M_ERRNO, "%s: Error getting routing table size", __func__);
3771 return;
3772 }
3773
3774 uint32 size = (uint32)config.ifc_value;
3775 if (size == 0)
3776 {
3777 return;
3778 }
3779
3780 void *buffer = malloc(size);
3782
3783 config.ifc_len = size;
3784 config.ifc_buf = buffer;
3785 if (ioctl(sockfd, SIOCGRTTABLE, &config, sizeof(struct ifconf)) < 0)
3786 {
3787 free(buffer);
3788 return;
3789 }
3790
3791 struct ifreq *interface = (struct ifreq *)buffer;
3792 struct ifreq *end = (struct ifreq *)((uint8 *)buffer + size);
3793
3794 while (interface < end)
3795 {
3796 struct route_entry route = interface->ifr_route;
3797 if ((route.flags & RTF_GATEWAY) != 0 && (route.flags & RTF_DEFAULT) != 0)
3798 {
3799 rgi->gateway.addr = ntohl(((struct sockaddr_in *)route.gateway)->sin_addr.s_addr);
3801 strncpy(rgi->iface, interface->ifr_name, sizeof(rgi->iface));
3802 }
3803
3804 int32 address_size = 0;
3805 if (route.destination != NULL)
3806 {
3807 address_size += route.destination->sa_len;
3808 }
3809 if (route.mask != NULL)
3810 {
3811 address_size += route.mask->sa_len;
3812 }
3813 if (route.gateway != NULL)
3814 {
3815 address_size += route.gateway->sa_len;
3816 }
3817
3818 interface = (struct ifreq *)((addr_t)interface + IF_NAMESIZE + sizeof(struct route_entry)
3819 + address_size);
3820 }
3821 free(buffer);
3822}
3823
3824void
3825get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6, const struct in6_addr *dest,
3826 openvpn_net_ctx_t *ctx)
3827{
3828 /* TODO: Same for ipv6 with AF_INET6 */
3829 CLEAR(*rgi6);
3830}
3831
3832#else /* if defined(_WIN32) */
3833
3834/*
3835 * This is a platform-specific method that returns data about
3836 * the current default gateway. Return data is placed into
3837 * a struct route_gateway_info object provided by caller. The
3838 * implementation should CLEAR the structure before adding
3839 * data to it.
3840 *
3841 * Data returned includes:
3842 * 1. default gateway address (rgi->gateway.addr)
3843 * 2. netmask of interface that owns default gateway
3844 * (rgi->gateway.netmask)
3845 * 3. hardware address (i.e. MAC address) of interface that owns
3846 * default gateway (rgi->hwaddr)
3847 * 4. interface name (or adapter index on Windows) that owns default
3848 * gateway (rgi->iface or rgi->adapter_index)
3849 * 5. an array of additional address/netmask pairs defined by
3850 * interface that owns default gateway (rgi->addrs with length
3851 * given in rgi->n_addrs)
3852 *
3853 * The flags RGI_x_DEFINED may be used to indicate which of the data
3854 * members were successfully returned (set in rgi->flags). All of
3855 * the data members are optional, however certain OpenVPN functionality
3856 * may be disabled by missing items.
3857 */
3858void
3860{
3861 CLEAR(*rgi);
3862}
3863void
3864get_default_gateway_ipv6(struct route_ipv6_gateway_info *rgi6, const struct in6_addr *dest,
3865 openvpn_net_ctx_t *ctx)
3866{
3867 msg(D_ROUTE, "no support for get_default_gateway_ipv6() on this system");
3868 CLEAR(*rgi6);
3869}
3870
3871#endif /* if defined(_WIN32) */
3872
3873bool
3874netmask_to_netbits(const in_addr_t network, const in_addr_t netmask, int *netbits)
3875{
3876 int i;
3877 const int addrlen = sizeof(in_addr_t) * 8;
3878
3879 if ((network & netmask) == network)
3880 {
3881 for (i = 0; i <= addrlen; ++i)
3882 {
3883 in_addr_t mask = netbits_to_netmask(i);
3884 if (mask == netmask)
3885 {
3886 if (i == addrlen)
3887 {
3888 *netbits = -1;
3889 }
3890 else
3891 {
3892 *netbits = i;
3893 }
3894 return true;
3895 }
3896 }
3897 }
3898 return false;
3899}
3900
3901/* similar to netmask_to_netbits(), but don't mess with base address
3902 * etc., just convert to netbits - non-mappable masks are returned as "-1"
3903 */
3904int
3906{
3907 int i;
3908 const int addrlen = sizeof(in_addr_t) * 8;
3909
3910 for (i = 0; i <= addrlen; ++i)
3911 {
3912 in_addr_t mask = netbits_to_netmask(i);
3913 if (mask == netmask)
3914 {
3915 return i;
3916 }
3917 }
3918 return -1;
3919}
3920
3921
3922/*
3923 * get_bypass_addresses() is used by the redirect-gateway bypass-x
3924 * functions to build a route bypass to selected DHCP/DNS servers,
3925 * so that outgoing packets to these servers don't end up in the tunnel.
3926 */
3927
3928#if defined(_WIN32)
3929
3930static void
3932{
3933 if (test_local_addr(addr, NULL) == TLA_NONLOCAL && addr != 0 && addr != IPV4_NETMASK_HOST)
3934 {
3935 add_bypass_address(rb, addr);
3936 }
3937}
3938
3939static void
3940add_host_route_array(struct route_bypass *rb, const IP_ADDR_STRING *iplist)
3941{
3942 while (iplist)
3943 {
3944 bool succeed = false;
3945 const in_addr_t ip =
3946 getaddr(GETADDR_HOST_ORDER, iplist->IpAddress.String, 0, &succeed, NULL);
3947 if (succeed)
3948 {
3950 }
3951 iplist = iplist->Next;
3952 }
3953}
3954
3955static void
3956get_bypass_addresses(struct route_bypass *rb, const unsigned int flags)
3957{
3958 struct gc_arena gc = gc_new();
3959 /*bool ret_bool = false;*/
3960
3961 /* get full routing table */
3962 const MIB_IPFORWARDTABLE *routes = get_windows_routing_table(&gc);
3963
3964 /* get the route which represents the default gateway */
3965 const MIB_IPFORWARDROW *row = get_default_gateway_row(routes);
3966
3967 if (row)
3968 {
3969 /* get the adapter which the default gateway is associated with */
3970 const IP_ADAPTER_INFO *dgi = get_adapter_info(row->dwForwardIfIndex, &gc);
3971
3972 /* get extra adapter info, such as DNS addresses */
3973 const IP_PER_ADAPTER_INFO *pai = get_per_adapter_info(row->dwForwardIfIndex, &gc);
3974
3975 /* Bypass DHCP server address */
3976 if ((flags & RG_BYPASS_DHCP) && dgi && dgi->DhcpEnabled)
3977 {
3978 add_host_route_array(rb, &dgi->DhcpServer);
3979 }
3980
3981 /* Bypass DNS server addresses */
3982 if ((flags & RG_BYPASS_DNS) && pai)
3983 {
3984 add_host_route_array(rb, &pai->DnsServerList);
3985 }
3986 }
3987
3988 gc_free(&gc);
3989}
3990
3991#else /* if defined(_WIN32) */
3992
3993static void
3994get_bypass_addresses(struct route_bypass *rb, const unsigned int flags) /* PLATFORM-SPECIFIC */
3995{
3996}
3997
3998#endif /* if defined(_WIN32) */
3999
4000/*
4001 * Test if addr is reachable via a local interface (return ILA_LOCAL),
4002 * or if it needs to be routed via the default gateway (return
4003 * ILA_NONLOCAL). If the target platform doesn't implement this
4004 * function, return ILA_NOT_IMPLEMENTED.
4005 *
4006 * Used by redirect-gateway autolocal feature
4007 */
4008
4009#if defined(_WIN32)
4010
4011int
4012test_local_addr(const in_addr_t addr, const struct route_gateway_info *rgi)
4013{
4014 struct gc_arena gc = gc_new();
4015 const in_addr_t nonlocal_netmask =
4016 0x80000000L; /* routes with netmask <= to this are considered non-local */
4017 int ret = TLA_NONLOCAL;
4018
4019 /* get full routing table */
4020 const MIB_IPFORWARDTABLE *rt = get_windows_routing_table(&gc);
4021 if (rt)
4022 {
4023 for (DWORD i = 0; i < rt->dwNumEntries; ++i)
4024 {
4025 const MIB_IPFORWARDROW *row = &rt->table[i];
4026 const in_addr_t net = ntohl(row->dwForwardDest);
4027 const in_addr_t mask = ntohl(row->dwForwardMask);
4028 if (mask > nonlocal_netmask && (addr & mask) == net)
4029 {
4030 ret = TLA_LOCAL;
4031 break;
4032 }
4033 }
4034 }
4035
4036 gc_free(&gc);
4037 return ret;
4038}
4039
4040#else /* if defined(_WIN32) */
4041
4042int
4043test_local_addr(const in_addr_t addr, const struct route_gateway_info *rgi) /* PLATFORM-SPECIFIC */
4044{
4045 if (rgi)
4046 {
4047 if (local_route(addr, 0xFFFFFFFF, rgi->gateway.addr, rgi))
4048 {
4049 return TLA_LOCAL;
4050 }
4051 else
4052 {
4053 return TLA_NONLOCAL;
4054 }
4055 }
4056 return TLA_NOT_IMPLEMENTED;
4057}
4058
4059#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:341
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:488
void gc_addspecial(void *addr, void(*free_function)(void *), struct gc_arena *a)
Definition buffer.c:443
#define BSTR(buf)
Definition buffer.h:129
#define ALLOC_OBJ_CLEAR_GC(dptr, type, gc)
Definition buffer.h:1125
#define ALLOC_OBJ_GC(dptr, type, gc)
Definition buffer.h:1120
static void strncpynt(char *dest, const char *src, size_t maxlen)
Definition buffer.h:362
static void check_malloc_return(void *p)
Definition buffer.h:1131
static void gc_free(struct gc_arena *a)
Definition buffer.h:1049
static void gc_freeaddrinfo_callback(void *addr)
Definition buffer.h:216
static struct gc_arena gc_new(void)
Definition buffer.h:1041
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:2795
#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:786
#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:3931
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:2413
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:2805
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:3940
int netmask_to_netbits2(in_addr_t netmask)
Definition route.c:3905
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:2438
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:2663
static const MIB_IPFORWARDTABLE * get_windows_routing_table(struct gc_arena *gc)
Definition route.c:2379
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:2529
static int do_route_service(const bool add, const route_message_t *rt, const DWORD size, HANDLE pipe)
Definition route.c:2842
static const char * format_route_entry(const MIB_IPFORWARDROW *r, struct gc_arena *gc)
Definition route.c:3057
static int add_route_service(const struct route_ipv4 *, const struct tuntap *)
Definition route.c:3032
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:2026
static bool del_route_ipv6_service(const struct route_ipv6 *, const struct tuntap *)
Definition route.c:3051
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:1481
static int test_route(const IP_ADAPTER_INFO *adapters, const in_addr_t gateway, DWORD *index)
Definition route.c:2401
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:1790
#define RTA_ERROR
Definition route.c:101
static bool del_route_service(const struct route_ipv4 *, const struct tuntap *)
Definition route.c:3038
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:3045
static bool is_on_link(const int is_local_route, const unsigned int flags, const struct route_gateway_info *rgi)
Definition route.c:1472
static const MIB_IPFORWARDROW * get_default_gateway_row(const MIB_IPFORWARDTABLE *routes)
Definition route.c:2481
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:2565
static int route_ipv6_ipapi(bool add, const struct route_ipv6 *, const struct tuntap *)
Definition route.c:2908
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:4012
#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:2709
#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:2198
#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:2985
void route_ipv6_clear_host_bits(struct route_ipv6 *r6)
Definition route.c:1765
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:3075
bool netmask_to_netbits(const in_addr_t network, const in_addr_t netmask, int *netbits)
Definition route.c:3874
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:2617
static int do_route_ipv4_service(const bool add, const struct route_ipv4 *r, const struct tuntap *tt)
Definition route.c:2879
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:3956
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:222
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:195
#define IPV4_INVALID_ADDR
Definition socket.h:375
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:4318
bool is_adapter_up(const struct tuntap *tt, const IP_ADAPTER_INFO *list)
Definition tun.c:4331
const IP_ADAPTER_INFO * get_adapter_info(DWORD index, struct gc_arena *gc)
Definition tun.c:4233
const IP_PER_ADAPTER_INFO * get_per_adapter_info(const DWORD index, struct gc_arena *gc)
Definition tun.c:4131
bool is_ip_in_adapter_subnet(const IP_ADAPTER_INFO *ai, const in_addr_t ip, in_addr_t *highest_netmask)
Definition tun.c:4375
const IP_ADAPTER_INFO * get_adapter_info_list(struct gc_arena *gc)
Definition tun.c:4106
const IP_ADAPTER_INFO * get_adapter(const IP_ADAPTER_INFO *ai, DWORD index)
Definition tun.c:4214
DWORD adapter_index_of_ip(const IP_ADAPTER_INFO *list, const in_addr_t ip, int *count, in_addr_t *netmask)
Definition tun.c:4409
#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:1108
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:1422
#define WIN_ROUTE_PATH_SUFFIX
Definition win32.h:40