Merge pull request #1236 from ilario/lime-proto-wan-vlan3

lime-proto-wan add support for VLAN on WAN

Author: ilario

packages/lime-docs/files/www/docs/lime-example.txt

@@ -307,9 +307,12 @@ config net wirelessclientbackbone
 
 ## configure the ethernet port eth1.5 as WAN with static ipv4 and ipv6 addresses 
 
-config net port5                                        # Do not put any "." in the section name
+config net lm_hwd_openwrt_wan                           # Do not put any "." in the section name. Specifying lm_hwd_openwrt_wan will overwrite the configuration automatically generated by lime-hwd-openwrt-wan
+    option autogenerated 'false'                        # This tells lime-hwd-openwrt-wan to not destroy and rewrite this section
     option linux_name 'eth1.5'                          # Put here the actual name of the interface
 #   list protocols 'wan'                                # Use 'wan' instead of 'static' to get Internet connectivity via DHCP
+                                                        # If a VLAN is needed on the WAN interface for connecting to the gateway, it can be specified with wan:ID, like "wan:20" or "wan:20:8021q"
+
     list protocols 'static'                             # Set up a static IP (both IPv4 and IPv6 supported)
     option static_ipv4 '192.168.1.2/24'
     option static_gateway_ipv4 '192.168.1.1'            # In static protocol, specifying an IP for the gateway is optional. Skip this line if no default route should be added on this interface.

packages/lime-proto-wan/files/usr/lib/lua/lime/proto/wan.lua

@@ -8,6 +8,8 @@
 --! SPDX-License-Identifier: AGPL-3.0-only
 
 local libuci = require("uci")
+local network = require("lime.network")
+local utils = require("lime.utils")
 
 wan = {}
 
@@ -25,7 +27,27 @@ end
 
 function wan.setup_interface(ifname, args)
 	local uci = libuci:cursor()
-	uci:set("network", "wan", "device", ifname)
+	local vlanId = tostring(args[2] or "0")
+
+	if vlanId ~= "0" then
+		local vlanProto = args[3] or "8021q"
+		local nameSuffix = args[4] or "_wan"
+
+		local owrtDeviceName = network.sanitizeIfaceName(ifname.."_dev")
+
+		--! Do not use . as separator as this will make netifd create an 802.1q interface anyway
+		--! and sanitize ifname because it can contain dots as well (i.e. switch ports)
+		local linuxName = ifname:gsub("[^%w-]", "-")..network.protoVlanSeparator..vlanId
+
+		network.createDevice(owrtDeviceName, ifname, linuxName, vlanProto, { vid=vlanId })
+
+		utils.log("lime.proto.wan.setup_interface(%s with VLAN ID %s, ...)", ifname, vlanId)
+		uci:set("network", "wan", "device", linuxName)
+	else
+		utils.log("lime.proto.wan.setup_interface(%s, ...)", ifname)
+		uci:set("network", "wan", "device", ifname)
+	end
+
 	uci:save("network")
 
 	--! Accepting link local traffic also on WAN should not cause hazards.

packages/lime-system/files/usr/lib/lua/lime/network.lua

@@ -405,6 +405,28 @@ function network.sanitizeIfaceName(ifName)
 	return network.limeIfNamePrefix..ifName:gsub("[^%w_]", "_")
 end
 
+function network.createDevice(owrtDeviceName, baseIfname, linuxName, devType, args)
+	--! baseIfname can be a linux interface name like eth0 or an openwrt
+	--! interface name like @lan of the base interface;
+	--! linuxName is the linux name of the new interface;
+	--! args optional additional arguments for device like
+	--! { macaddr="aa:aa:aa:aa:aa:aa", mode="vepa" };
+
+	args = args or {}
+
+	local uci = config.get_uci_cursor()
+
+	uci:set("network", owrtDeviceName, "device")
+	uci:set("network", owrtDeviceName, "type", devType)
+	uci:set("network", owrtDeviceName, "name", linuxName)
+	uci:set("network", owrtDeviceName, "ifname", baseIfname)
+	for k,v in pairs(args) do
+		uci:set("network", owrtDeviceName, k, v)
+	end
+
+	uci:save("network")
+end
+
 --! Creates a network Interface with static protocol
 --! ipAddr can be IPv4 or IPv6
 --! the function can be called twice to set both IPv4 and IPv6
@@ -449,7 +471,7 @@ function network.createVlanIface(linuxBaseIfname, vid, openwrtNameSuffix, vlanPr
 	--! because only alphanumeric and underscores are allowed
 	local owrtInterfaceName = network.sanitizeIfaceName(linuxBaseIfname)
 	local owrtDeviceName = owrtInterfaceName
-	local linux802adIfName = linuxBaseIfname
+	local linuxVlanIfName = linuxBaseIfname
 
 	local uci = config.get_uci_cursor()
 
@@ -467,14 +489,9 @@ function network.createVlanIface(linuxBaseIfname, vid, openwrtNameSuffix, vlanPr
 
 		--! Do not use . as separator as this will make netifd create an 802.1q interface anyway
 		--! and sanitize linuxBaseIfName because it can contain dots as well (i.e. switch ports)
-		linux802adIfName = linux802adIfName:gsub("[^%w-]", "-")..network.protoVlanSeparator..vlanId
-		
-		uci:set("network", owrtDeviceName, "device")
-		uci:set("network", owrtDeviceName, "type", vlanProtocol)
-		uci:set("network", owrtDeviceName, "name", linux802adIfName)
-		--! This is ifname also on current OpenWrt
-		uci:set("network", owrtDeviceName, "ifname", linuxBaseIfname)
-		uci:set("network", owrtDeviceName, "vid", vlanId)
+		linuxVlanIfName = linuxVlanIfName:gsub("[^%w-]", "-")..network.protoVlanSeparator..vlanId
+
+		network.createDevice(owrtDeviceName, linuxBaseIfname, linuxVlanIfName, vlanProtocol, { vid=vlanId })
 	end
 
 	uci:set("network", owrtInterfaceName, "interface")
@@ -488,13 +505,13 @@ function network.createVlanIface(linuxBaseIfname, vid, openwrtNameSuffix, vlanPr
 	--! In case of wifi interface not using vlan (vid == 0) avoid to set
 	--! ifname in network because it is already set in wireless, because
 	--! setting ifname on both places cause a netifd race condition
-	if vid ~= 0 or not linux802adIfName:match("^wlan") then
-		uci:set("network", owrtInterfaceName, "device", linux802adIfName)
+	if vid ~= 0 or not linuxVlanIfName:match("^wlan") then
+		uci:set("network", owrtInterfaceName, "device", linuxVlanIfName)
 	end
 
 	uci:save("network")
 
-	return owrtInterfaceName, linux802adIfName, owrtDeviceName
+	return owrtInterfaceName, linuxVlanIfName, owrtDeviceName
 end
 
 function network.createMacvlanIface(baseIfname, linuxName, argsDev, argsIf)
@@ -511,25 +528,14 @@ function network.createMacvlanIface(baseIfname, linuxName, argsDev, argsIf)
 	--! lime.proto which want to use macvlan so this function should depend
 	--! on its own on kmod-macvlan as needed.
 
-	argsDev = argsDev or {}
 	argsIf = argsIf or {}
 
-	local owrtDeviceName = network.limeIfNamePrefix..baseIfname.."_"..linuxName.."_dev"
-	local owrtInterfaceName = network.limeIfNamePrefix..baseIfname.."_"..linuxName.."_if"
-	--! sanitize uci sections name
-	owrtDeviceName = owrtDeviceName:gsub("[^%w_]", "_")
-	owrtInterfaceName = owrtInterfaceName:gsub("[^%w_]", "_")
+	local owrtDeviceName = network.sanitizeIfaceName(baseIfname.."_"..linuxName.."_dev")
+	local owrtInterfaceName = network.sanitizeIfaceName(baseIfname.."_"..linuxName.."_if")
 
-	local uci = config.get_uci_cursor()
+	network.createDevice(owrtDeviceName, baseIfname, linuxName, "macvlan", argsDev)
 
-	uci:set("network", owrtDeviceName, "device")
-	uci:set("network", owrtDeviceName, "type", "macvlan")
-	uci:set("network", owrtDeviceName, "name", linuxName)
-	--! This is ifname also on current OpenWrt
-	uci:set("network", owrtDeviceName, "ifname", baseIfname)
-	for k,v in pairs(argsDev) do
-		uci:set("network", owrtDeviceName, k, v)
-	end
+	local uci = config.get_uci_cursor()
 
 	uci:set("network", owrtInterfaceName, "interface")
 	uci:set("network", owrtInterfaceName, "proto", "none")