@@ -367,6 +367,14 @@ routing.
Like ``--redirect-gateway``, but omit actually changing the default gateway.
Useful when pushing private subnets.
+--route-table id
+ Specify a default table id for use with --route.
+ By default, OpenVPN installs routes in the main routing
+ table of the operating system, but with this option,
+ a user defined routing table can be used instead.
+
+ (Supported on Linux only, on other platforms this is a no-op).
+
--route args
Add route to routing table after connection is established. Multiple
routes can be specified. Routes will be automatically torn down in
@@ -379,6 +387,7 @@ routing.
route network/IP netmask
route network/IP netmask gateway
route network/IP netmask gateway metric
+ route network/IP netmask gateway metric table-id
This option is intended as a convenience proxy for the ``route``\(8)
shell command, while at the same time providing portable semantics
@@ -394,6 +403,9 @@ routing.
``metric``
default taken from ``--route-metric`` if set, otherwise :code:`0`.
+ ``table-id`` (Supported on Linux only, on other platforms this is a no-op).
+ default taken from ``--route-table`` if set, otherwise :code:`0`.
+
The default can be specified by leaving an option blank or setting it to
:code:`default`.
@@ -444,12 +456,14 @@ routing.
Valid syntax:
::
- route-ipv6 ipv6addr/bits [gateway] [metric]
+ route-ipv6 ipv6addr/bits [gateway] [metric] [table-id]
The gateway parameter is only used for IPv6 routes across *tap* devices,
and if missing, the ``ipv6remote`` field from ``--ifconfig-ipv6`` or
``--route-ipv6-gateway`` is used.
+ (table-id supported on Linux only, on other platforms this is a no-op).
+
--route-gateway arg
Specify a default *gateway* for use with ``--route``.
@@ -120,6 +120,7 @@ helper_add_route(const in_addr_t network, const in_addr_t netmask, struct option
print_in_addr_t(network, 0, &o->gc),
print_in_addr_t(netmask, 0, &o->gc),
NULL,
+ NULL,
NULL);
}
@@ -1504,6 +1504,7 @@ do_init_route_list(const struct options *options,
const char *gw = NULL;
int dev = dev_type_enum(options->dev, options->dev_type);
int metric = 0;
+ uint32_t table_id = 0; /* unspec table */
/* if DCO is enabled we have both regular routes and iroutes in the system
* routing table, and normal routes must have a higher metric for that to
@@ -1522,6 +1523,10 @@ do_init_route_list(const struct options *options,
{
gw = options->route_default_gateway;
}
+ if (options->route_default_table_id)
+ {
+ table_id = options->route_default_table_id;
+ }
if (options->route_default_metric)
{
metric = options->route_default_metric;
@@ -1530,6 +1535,7 @@ do_init_route_list(const struct options *options,
if (init_route_list(route_list,
options->routes,
gw,
+ table_id,
metric,
link_socket_current_remote(link_socket_info),
es,
@@ -1549,6 +1555,7 @@ do_init_route_ipv6_list(const struct options *options,
{
const char *gw = NULL;
int metric = -1; /* no metric set */
+ uint32_t table_id = 0; /* unspec table */
/* see explanation in do_init_route_list() */
if (dco_enabled(options))
@@ -1567,6 +1574,11 @@ do_init_route_ipv6_list(const struct options *options,
metric = options->route_default_metric;
}
+ if (options->route_default_table_id)
+ {
+ table_id = options->route_default_table_id;
+ }
+
/* redirect (IPv6) gateway to VPN? if yes, add a few more specifics
*/
if (options->routes_ipv6->flags & RG_REROUTE_GW)
@@ -1578,7 +1590,7 @@ do_init_route_ipv6_list(const struct options *options,
{
add_route_ipv6_to_option_list( options->routes_ipv6,
string_alloc(opt_list[i], options->routes_ipv6->gc),
- NULL, NULL );
+ NULL, NULL, NULL );
}
}
@@ -1586,6 +1598,7 @@ do_init_route_ipv6_list(const struct options *options,
options->routes_ipv6,
gw,
metric,
+ table_id,
link_socket_current_remote_ipv6(link_socket_info),
es,
ctx))
@@ -6956,7 +6956,15 @@ add_option(struct options *options,
cnol_check_alloc(options);
add_client_nat_to_option_list(options->client_nat, p[1], p[2], p[3], p[4], msglevel);
}
- else if (streq(p[0], "route") && p[1] && !p[5])
+ else if (streq(p[0], "route-table") && p[1] && !p[2])
+ {
+#ifndef ENABLE_SITNL
+ msg(M_WARN, "NOTE: --route-table specified, but not supported on this platform");
+#endif
+ VERIFY_PERMISSION(OPT_P_ROUTE);
+ options->route_default_table_id = positive_atoi(p[1]);
+ }
+ else if (streq(p[0], "route") && p[1] && !p[6])
{
VERIFY_PERMISSION(OPT_P_ROUTE);
rol_check_alloc(options);
@@ -6978,9 +6986,22 @@ add_option(struct options *options,
goto err;
}
}
- add_route_to_option_list(options->routes, p[1], p[2], p[3], p[4]);
+ /* at the moment the routing table id is supported only by Linux/SITNL */
+#ifndef ENABLE_SITNL
+ if (p[5])
+ {
+ static bool route_table_warned = false;
+
+ if (!route_table_warned)
+ {
+ msg(M_WARN, "NOTE: table specified for --route, but not supported on this platform");
+ route_table_warned = true;
+ }
+ }
+#endif
+ add_route_to_option_list(options->routes, p[1], p[2], p[3], p[4], p[5]);
}
- else if (streq(p[0], "route-ipv6") && p[1] && !p[4])
+ else if (streq(p[0], "route-ipv6") && p[1] && !p[5])
{
VERIFY_PERMISSION(OPT_P_ROUTE);
rol6_check_alloc(options);
@@ -6998,7 +7019,22 @@ add_option(struct options *options,
}
/* p[3] is metric, if present */
}
- add_route_ipv6_to_option_list(options->routes_ipv6, p[1], p[2], p[3]);
+
+ /* at the moment the routing table id is supported only by Linux/SITNL */
+#ifndef ENABLE_SITNL
+ if (p[5])
+ {
+ static bool route6_table_warned = false;
+
+ if (!route6_table_warned)
+ {
+ msg(M_WARN, "NOTE: table specified for --route-ipv6, but not supported on this platform");
+ route6_table_warned = true;
+ }
+ }
+#endif
+
+ add_route_ipv6_to_option_list(options->routes_ipv6, p[1], p[2], p[3], p[4]);
}
else if (streq(p[0], "max-routes") && !p[2])
{
@@ -411,6 +411,7 @@ struct options
const char *route_predown_script;
const char *route_default_gateway;
const char *route_ipv6_default_gateway;
+ uint32_t route_default_table_id;
int route_default_metric;
bool route_noexec;
int route_delay;
@@ -325,7 +325,6 @@ init_route(struct route_ipv4 *r,
CLEAR(*r);
r->option = ro;
-
/* network */
if (!is_route_parm_defined(ro->network))
@@ -437,6 +436,27 @@ init_route(struct route_ipv4 *r,
r->flags |= RT_DEFINED;
+ /* routing table id */
+
+ r->table_id = 0;
+ if (ro->table_id)
+ {
+ r->table_id = atoi(ro->table_id);
+ if (r->table_id < 0)
+ {
+ msg(M_WARN, PACKAGE_NAME "ROUTE: routing table id for network %s (%s) must be >= 0",
+ ro->network,
+ ro->table_id);
+ goto fail;
+ }
+ r->flags |= RT_TABLE_DEFINED;
+ }
+ else if (rl->spec.flags & RTSA_DEFAULT_TABLE_ID)
+ {
+ r->table_id = rl->spec.table_id;
+ r->flags |= RT_TABLE_DEFINED;
+ }
+
return true;
fail:
@@ -493,6 +513,27 @@ init_route_ipv6(struct route_ipv6 *r6,
r6->flags |= RT_DEFINED;
+ /* routing table id */
+
+ r6->table_id = 0;
+ if (r6o->table_id)
+ {
+ r6->table_id = atoi(r6o->table_id);
+ if (r6->table_id < 0)
+ {
+ msg(M_WARN, PACKAGE_NAME "ROUTE: routing table id for network %s (%s) must be >= 0",
+ r6o->prefix,
+ r6o->table_id);
+ goto fail;
+ }
+ r6->flags |= RT_TABLE_DEFINED;
+ }
+ else if (rl6->spec_flags & RTSA_DEFAULT_TABLE_ID)
+ {
+ r6->table_id = rl6->default_route_table_id;
+ r6->flags |= RT_TABLE_DEFINED;
+ }
+
return true;
fail:
@@ -506,7 +547,8 @@ add_route_to_option_list(struct route_option_list *l,
const char *network,
const char *netmask,
const char *gateway,
- const char *metric)
+ const char *metric,
+ const char *table_id)
{
struct route_option *ro;
ALLOC_OBJ_GC(ro, struct route_option, l->gc);
@@ -514,6 +556,7 @@ add_route_to_option_list(struct route_option_list *l,
ro->netmask = netmask;
ro->gateway = gateway;
ro->metric = metric;
+ ro->table_id = table_id;
ro->next = l->routes;
l->routes = ro;
@@ -523,13 +566,15 @@ void
add_route_ipv6_to_option_list(struct route_ipv6_option_list *l,
const char *prefix,
const char *gateway,
- const char *metric)
+ const char *metric,
+ const char *table_id)
{
struct route_ipv6_option *ro;
ALLOC_OBJ_GC(ro, struct route_ipv6_option, l->gc);
ro->prefix = prefix;
ro->gateway = gateway;
ro->metric = metric;
+ ro->table_id = table_id;
ro->next = l->routes_ipv6;
l->routes_ipv6 = ro;
}
@@ -628,6 +673,7 @@ init_route_list(struct route_list *rl,
const struct route_option_list *opt,
const char *remote_endpoint,
int default_metric,
+ uint32_t table_id,
in_addr_t remote_host,
struct env_set *es,
openvpn_net_ctx_t *ctx)
@@ -651,6 +697,12 @@ init_route_list(struct route_list *rl,
rl->spec.flags |= RTSA_DEFAULT_METRIC;
}
+ if (table_id)
+ {
+ rl->spec.table_id = table_id;
+ rl->spec.flags |= RTSA_DEFAULT_TABLE_ID;
+ }
+
get_default_gateway(&rl->rgi, ctx);
if (rl->rgi.flags & RGI_ADDR_DEFINED)
{
@@ -784,6 +836,7 @@ init_route_ipv6_list(struct route_ipv6_list *rl6,
const struct route_ipv6_option_list *opt6,
const char *remote_endpoint,
int default_metric,
+ uint32_t table_id,
const struct in6_addr *remote_host_ipv6,
struct env_set *es,
openvpn_net_ctx_t *ctx)
@@ -808,6 +861,12 @@ init_route_ipv6_list(struct route_ipv6_list *rl6,
rl6->spec_flags |= RTSA_DEFAULT_METRIC;
}
+ if (table_id)
+ {
+ rl6->default_route_table_id = table_id;
+ rl6->spec_flags |= RTSA_DEFAULT_TABLE_ID;
+ }
+
msg(D_ROUTE, "GDG6: remote_host_ipv6=%s",
remote_host_ipv6 ? print_in6_addr(*remote_host_ipv6, 0, &gc) : "n/a" );
@@ -1598,9 +1657,15 @@ add_route(struct route_ipv4 *r,
metric = r->metric;
}
+ uint32_t table_id = 0;
+ if (r->flags & RT_TABLE_DEFINED)
+ {
+ table_id = r->table_id;
+ }
+
status = RTA_SUCCESS;
int ret = net_route_v4_add(ctx, &r->network, netmask_to_netbits2(r->netmask),
- &r->gateway, iface, 0, metric);
+ &r->gateway, iface, table_id, metric);
if (ret == -EEXIST)
{
msg(D_ROUTE, "NOTE: Linux route add command failed because route exists");
@@ -1978,10 +2043,16 @@ add_route_ipv6(struct route_ipv6 *r6, const struct tuntap *tt,
metric = r6->metric;
}
+ uint32_t table_id = 0;
+ if ((r6->flags & RT_TABLE_DEFINED) && (r6->table_id > 0))
+ {
+ table_id = r6->table_id;
+ }
+
status = RTA_SUCCESS;
int ret = net_route_v6_add(ctx, &r6->network, r6->netbits,
gateway_needed ? &r6->gateway : NULL,
- device, 0, metric);
+ device, table_id, metric);
if (ret == -EEXIST)
{
msg(D_ROUTE, "NOTE: Linux route add command failed because route exists");
@@ -2186,8 +2257,14 @@ delete_route(struct route_ipv4 *r,
metric = r->metric;
}
+ uint32_t table_id = 0;
+ if (r->flags & RT_TABLE_DEFINED)
+ {
+ table_id = r->table_id;
+ }
+
if (net_route_v4_del(ctx, &r->network, netmask_to_netbits2(r->netmask),
- &r->gateway, NULL, 0, metric) < 0)
+ &r->gateway, NULL, table_id, metric) < 0)
{
msg(M_WARN, "ERROR: Linux route delete command failed");
}
@@ -2361,7 +2438,7 @@ delete_route_ipv6(const struct route_ipv6 *r6, const struct tuntap *tt,
{
gateway_needed = true;
}
-#endif
+#endif /* ifndef _WIN32 */
struct gc_arena gc = gc_new();
struct argv argv = argv_new();
@@ -2398,8 +2475,16 @@ delete_route_ipv6(const struct route_ipv6 *r6, const struct tuntap *tt,
metric = r6->metric;
}
+ uint32_t table_id = 0;
+ if (r6->flags & RT_TABLE_DEFINED)
+ {
+ table_id = r6->table_id;
+ }
+
+
+
if (net_route_v6_del(ctx, &r6->network, r6->netbits,
- gateway_needed ? &r6->gateway : NULL, device, 0,
+ gateway_needed ? &r6->gateway : NULL, device, table_id,
metric) < 0)
{
msg(M_WARN, "ERROR: Linux route v6 delete command failed");
@@ -63,12 +63,14 @@ struct route_special_addr
#define RTSA_REMOTE_ENDPOINT (1<<0)
#define RTSA_REMOTE_HOST (1<<1)
#define RTSA_DEFAULT_METRIC (1<<2)
+#define RTSA_DEFAULT_TABLE_ID (1<<3)
unsigned int flags;
in_addr_t remote_endpoint;
in_addr_t remote_host;
int remote_host_local; /* TLA_x value */
struct route_bypass bypass;
+ uint32_t table_id;
int default_metric;
};
@@ -77,6 +79,7 @@ struct route_option {
const char *network;
const char *netmask;
const char *gateway;
+ const char *table_id;
const char *metric;
};
@@ -92,6 +95,7 @@ struct route_option {
struct route_option_list {
unsigned int flags; /* RG_x flags */
+
struct route_option *routes;
struct gc_arena *gc;
};
@@ -101,6 +105,7 @@ struct route_ipv6_option {
const char *prefix; /* e.g. "2001:db8:1::/64" */
const char *gateway; /* e.g. "2001:db8:0::2" */
const char *metric; /* e.g. "5" */
+ const char *table_id;
};
struct route_ipv6_option_list {
@@ -113,12 +118,14 @@ struct route_ipv4 {
#define RT_DEFINED (1<<0)
#define RT_ADDED (1<<1)
#define RT_METRIC_DEFINED (1<<2)
+#define RT_TABLE_DEFINED (1<<3)
struct route_ipv4 *next;
unsigned int flags;
const struct route_option *option;
in_addr_t network;
in_addr_t netmask;
in_addr_t gateway;
+ uint32_t table_id;
int metric;
};
@@ -129,6 +136,7 @@ struct route_ipv6 {
unsigned int netbits;
struct in6_addr gateway;
int metric;
+ uint32_t table_id;
/* gateway interface */
#ifdef _WIN32
DWORD adapter_index; /* interface or ~0 if undefined */
@@ -223,6 +231,7 @@ struct route_ipv6_list {
struct in6_addr remote_endpoint_ipv6; /* inside tun */
struct in6_addr remote_host_ipv6; /* --remote address */
int default_metric;
+ uint32_t default_route_table_id;
struct route_ipv6_gateway_info rgi6;
unsigned int flags; /* RG_x flags, see route_option_list */
@@ -271,17 +280,20 @@ void add_route_to_option_list(struct route_option_list *l,
const char *network,
const char *netmask,
const char *gateway,
- const char *metric);
+ const char *metric,
+ const char *table_id);
void add_route_ipv6_to_option_list(struct route_ipv6_option_list *l,
const char *prefix,
const char *gateway,
- const char *metric);
+ const char *metric,
+ const char *table_id);
bool init_route_list(struct route_list *rl,
const struct route_option_list *opt,
const char *remote_endpoint,
int default_metric,
+ uint32_t table_id,
in_addr_t remote_host,
struct env_set *es,
openvpn_net_ctx_t *ctx);
@@ -290,6 +302,7 @@ bool init_route_ipv6_list(struct route_ipv6_list *rl6,
const struct route_ipv6_option_list *opt6,
const char *remote_endpoint,
int default_metric,
+ uint32_t table_id,
const struct in6_addr *remote_host,
struct env_set *es,
openvpn_net_ctx_t *ctx);
Add the ability for users to specify a custom routing table where routes should be installed in. As of now routes are always installed in the main routing table of the operating system, however, with the new --route-table option it is possibile to specify the ID of the default routing table to be used by --route(-ipv6). The --route(-ipv6) directives have been extended with an additional argument (5th for --route) (4th for --route-ipv6) so that each of them can possibly use an independent routing table. Please note: this feature is currently supported only by Linux/SITNL. Support for other platforms should be added in related backends. Signed-off-by: Gianmarco De Gregori <gianmarco@mandelbit.com> --- doc/man-sections/vpn-network-options.rst | 16 +++- src/openvpn/helper.c | 1 + src/openvpn/init.c | 15 +++- src/openvpn/options.c | 44 +++++++++- src/openvpn/options.h | 1 + src/openvpn/route.c | 101 +++++++++++++++++++++-- src/openvpn/route.h | 17 +++- 7 files changed, 179 insertions(+), 16 deletions(-)