ncd: modules: add net.ipv6.route()

blog_channels.txt

@@ -126,3 +126,4 @@ ncd_explode 4
 NCDPlaceholderDb 4
 NCDVal 4
 ncd_net_ipv6_addr 4
+ncd_net_ipv6_route 4

generated/blog_channel_ncd_net_ipv6_route.h

@@ -0,0 +1,4 @@
+#ifdef BLOG_CURRENT_CHANNEL
+#undef BLOG_CURRENT_CHANNEL
+#endif
+#define BLOG_CURRENT_CHANNEL BLOG_CHANNEL_ncd_net_ipv6_route

generated/blog_channels_defines.h

@@ -126,4 +126,5 @@
 #define BLOG_CHANNEL_NCDPlaceholderDb 125
 #define BLOG_CHANNEL_NCDVal 126
 #define BLOG_CHANNEL_ncd_net_ipv6_addr 127
-#define BLOG_NUM_CHANNELS 128
+#define BLOG_CHANNEL_ncd_net_ipv6_route 128
+#define BLOG_NUM_CHANNELS 129

generated/blog_channels_list.h

@@ -126,3 +126,4 @@
 {"NCDPlaceholderDb", 4},
 {"NCDVal", 4},
 {"ncd_net_ipv6_addr", 4},
+{"ncd_net_ipv6_route", 4},

ncd/CMakeLists.txt

@@ -150,6 +150,7 @@ add_executable(badvpn-ncd
     modules/reboot.c
     modules/explode.c
     modules/net_ipv6_addr.c
+    modules/net_ipv6_route.c
     ${NCD_ADDITIONAL_SOURCES}
 )
 target_link_libraries(badvpn-ncd system flow flowextra dhcpclient arpprobe ncdvalue ncdval ncdvalcompat ncdvaluegenerator ncdvalueparser ncdconfigparser ncdsugar udevmonitor ncdinterfacemonitor ncdrequest)

ncd/modules/modules.h

@@ -105,6 +105,7 @@ extern const struct NCDModuleGroup ncdmodule_assert;
 extern const struct NCDModuleGroup ncdmodule_reboot;
 extern const struct NCDModuleGroup ncdmodule_explode;
 extern const struct NCDModuleGroup ncdmodule_net_ipv6_addr;
+extern const struct NCDModuleGroup ncdmodule_net_ipv6_route;
 
 static const struct NCDModuleGroup *ncd_modules[] = {
     &ncdmodule_var,
@@ -178,6 +179,7 @@ static const struct NCDModuleGroup *ncd_modules[] = {
     &ncdmodule_reboot,
     &ncdmodule_explode,
     &ncdmodule_net_ipv6_addr,
+    &ncdmodule_net_ipv6_route,
     NULL
 };
 

ncd/modules/net_ipv6_route.c

@@ -0,0 +1,200 @@
+/**
+ * @file net_ipv6_route.c
+ * @author Ambroz Bizjak <ambrop7@gmail.com>
+ * 
+ * @section LICENSE
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the author nor the
+ *    names of its contributors may be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * @section DESCRIPTION
+ * 
+ * IPv6 route module.
+ * 
+ * Synopsis:
+ *     net.ipv6.route(string dest, string dest_prefix, string gateway, string metric, string ifname)
+ *     net.ipv6.route(string cidr_dest, string gateway, string metric, string ifname)
+ * 
+ * Description:
+ *     Adds an IPv6 route to the system's routing table on initiailzation, and
+ *     removes it on deinitialization. The second form takes the destination in
+ *     CIDR notation (address/prefix).
+ *     If 'gateway' is "none", the route will only be associated with an interface.
+ *     If 'gateway' is "blackhole", the route will be a blackhole route (and 'ifname' is unused).
+ *     NOTE: blackhole routes for IPv6 are not yet implemented in Linux;
+ *           adding them via this interface will only work once they
+ *           have been.
+ */
+
+#include <stdlib.h>
+#include <string.h>
+
+#include <ncd/NCDModule.h>
+#include <ncd/NCDIfConfig.h>
+
+#include <generated/blog_channel_ncd_net_ipv6_route.h>
+
+#define ModuleLog(i, ...) NCDModuleInst_Backend_Log((i), BLOG_CURRENT_CHANNEL, __VA_ARGS__)
+
+#define TYPE_NORMAL 1
+#define TYPE_IFONLY 2
+#define TYPE_BLACKHOLE 3
+
+struct instance {
+    NCDModuleInst *i;
+    struct ipv6_ifaddr dest;
+    int type;
+    struct ipv6_addr gateway;
+    int metric;
+    const char *ifname;
+};
+
+static void func_new (void *vo, NCDModuleInst *i)
+{
+    struct instance *o = vo;
+    o->i = i;
+    
+    // read arguments
+    NCDValRef dest_arg;
+    NCDValRef dest_prefix_arg = NCDVal_NewInvalid();
+    NCDValRef gateway_arg;
+    NCDValRef metric_arg;
+    NCDValRef ifname_arg;
+    if (!NCDVal_ListRead(i->args, 4, &dest_arg, &gateway_arg, &metric_arg, &ifname_arg) &&
+        !NCDVal_ListRead(i->args, 5, &dest_arg, &dest_prefix_arg, &gateway_arg, &metric_arg, &ifname_arg)
+    ) {
+        ModuleLog(o->i, BLOG_ERROR, "wrong arity");
+        goto fail0;
+    }
+    if (!NCDVal_IsStringNoNulls(dest_arg) || !NCDVal_IsStringNoNulls(gateway_arg) ||
+        !NCDVal_IsStringNoNulls(metric_arg) || !NCDVal_IsStringNoNulls(ifname_arg) ||
+        (!NCDVal_IsInvalid(dest_prefix_arg) && !NCDVal_IsStringNoNulls(dest_prefix_arg))
+    ) {
+        ModuleLog(o->i, BLOG_ERROR, "wrong type");
+        goto fail0;
+    }
+    
+    // read dest
+    if (NCDVal_IsInvalid(dest_prefix_arg)) {
+        if (!ipaddr6_parse_ipv6_ifaddr(NCDVal_StringValue(dest_arg), &o->dest)) {
+            ModuleLog(o->i, BLOG_ERROR, "wrong CIDR notation dest");
+            goto fail0;
+        }
+    } else {
+        if (!ipaddr6_parse_ipv6_addr(NCDVal_StringValue(dest_arg), &o->dest.addr)) {
+            ModuleLog(o->i, BLOG_ERROR, "wrong dest addr");
+            goto fail0;
+        }
+        if (!ipaddr6_parse_ipv6_prefix(NCDVal_StringValue(dest_prefix_arg), &o->dest.prefix)) {
+            ModuleLog(o->i, BLOG_ERROR, "wrong dest prefix");
+            goto fail0;
+        }
+    }
+    
+    // read gateway and choose type
+    const char *gateway_str = NCDVal_StringValue(gateway_arg);
+    if (!strcmp(gateway_str, "none")) {
+        o->type = TYPE_IFONLY;
+    }
+    else if (!strcmp(gateway_str, "blackhole")) {
+        o->type = TYPE_BLACKHOLE;
+    } else {
+        if (!ipaddr6_parse_ipv6_addr(gateway_str, &o->gateway)) {
+            ModuleLog(o->i, BLOG_ERROR, "wrong gateway");
+            goto fail0;
+        }
+        o->type = TYPE_NORMAL;
+    }
+    
+    // read metric
+    o->metric = atoi(NCDVal_StringValue(metric_arg));
+    
+    // read ifname
+    o->ifname = NCDVal_StringValue(ifname_arg);
+    
+    // add route
+    int res;
+    switch (o->type) {
+        case TYPE_NORMAL:
+            res = NCDIfConfig_add_ipv6_route(o->dest, &o->gateway, o->metric, o->ifname);
+            break;
+        case TYPE_IFONLY:
+            res = NCDIfConfig_add_ipv6_route(o->dest, NULL, o->metric, o->ifname);
+            break;
+        case TYPE_BLACKHOLE:
+            res = NCDIfConfig_add_ipv6_blackhole_route(o->dest, o->metric);
+            break;
+        default: ASSERT(0);
+    }
+    if (!res) {
+        ModuleLog(o->i, BLOG_ERROR, "failed to add route");
+        goto fail0;
+    }
+    
+    // signal up
+    NCDModuleInst_Backend_Up(o->i);
+    return;
+    
+fail0:
+    NCDModuleInst_Backend_SetError(i);
+    NCDModuleInst_Backend_Dead(i);
+}
+
+static void func_die (void *vo)
+{
+    struct instance *o = vo;
+    
+    // remove route
+    int res;
+    switch (o->type) {
+        case TYPE_NORMAL:
+            res = NCDIfConfig_remove_ipv6_route(o->dest, &o->gateway, o->metric, o->ifname);
+            break;
+        case TYPE_IFONLY:
+            res = NCDIfConfig_remove_ipv6_route(o->dest, NULL, o->metric, o->ifname);
+            break;
+        case TYPE_BLACKHOLE:
+            res = NCDIfConfig_remove_ipv6_blackhole_route(o->dest, o->metric);
+            break;
+        default: ASSERT(0);
+    }
+    if (!res) {
+        ModuleLog(o->i, BLOG_ERROR, "failed to remove route");
+    }
+    
+    NCDModuleInst_Backend_Dead(o->i);
+}
+
+static const struct NCDModule modules[] = {
+    {
+        .type = "net.ipv6.route",
+        .func_new2 = func_new,
+        .func_die = func_die,
+        .alloc_size = sizeof(struct instance)
+    }, {
+        .type = NULL
+    }
+};
+
+const struct NCDModuleGroup ncdmodule_net_ipv6_route = {
+    .modules = modules
+};