gluon-setup-mode: allow network-triggered activation

.gitignore

@@ -3,6 +3,7 @@
 /output
 /site
 /tmp
+/tools
 /packages
 .bash_history
 .subversion

Makefile

@@ -194,13 +194,18 @@ container: FORCE
 	@scripts/container.sh
 
 
+tools:
+	mkdir -p tools
+	gcc -o tools/enter-network-config-mode package/gluon-setup-mode/src/send-network-request.c
+
 all: config
 	+@
 	$(GLUON_ENV) $(LUA) scripts/clean_output.lua
 	$(OPENWRTMAKE)
 	$(GLUON_ENV) $(LUA) scripts/copy_output.lua
 
 clean download: config
+	rm -rf tools
 	+@$(OPENWRTMAKE) $@
 
 dirclean: FORCE

docs/features/configmode.rst

@@ -22,6 +22,27 @@ If you have access to the console of the node, there is the
 ``gluon-enter-setup-mode`` command, which reboots a node into Config Mode.
 
 
+Network-Activated Config Mode
+-----------------------------
+
+Some models lack a physical button for activating Config Mode. In this case,
+Gluon supports Network-Activated Config Mode. A Linux-utility for activation
+can be built by invoking ``make tools``.
+
+To enter Config Mode on a device supporting this method, start the
+``enter-network-config-mode`` application in the ``tools`` subdirectory. Start
+this tool with the name of the network-interface connected to the target
+device as argument. Connect to the LAN-Port (or WAN port if the device has
+only a signle interface) and power-cycle the device.
+
+Make sure your computer and the target device are directly connected without
+an intermediate switch.
+
+This feature is supported for the following list of devices
+
+* ZyXEL NWA55AXE
+
+
 Port Configuration
 ------------------
 

package/gluon-autoupdater/files/lib/gluon/autoupdater/lib.sh

@@ -14,3 +14,11 @@ start_enabled() {
 		/etc/init.d/"$1" start
 	fi
 }
+
+flag_invocation() {
+	if [ "$1" -eq "0" ]; then
+		rm -f /lib/gluon/autoupdater/upgrade-invocation
+	else
+		echo "$1" > /lib/gluon/autoupdater/upgrade-invocation
+	fi
+}

package/gluon-autoupdater/files/lib/preinit/99_autoupdater_invocation

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+. /lib/gluon/autoupdater/lib.sh
+
+
+autoupdater_invocation_remove() {
+#	flag_invocation 0
+}
+
+boot_hook_add preinit_main autoupdater_invocation_remove

package/gluon-autoupdater/files/lib/upgrade/keep.d/gluon-autoupdater

@@ -0,0 +1 @@
+/lib/gluon/autoupdater/upgrade-invocation

package/gluon-autoupdater/files/usr/lib/autoupdater/abort.d/90gluon-autoupdater

@@ -2,6 +2,7 @@
 
 . /lib/gluon/autoupdater/lib.sh
 
+flag_invocation 0
 
 start_enabled cron
 start_enabled urngd

package/gluon-autoupdater/files/usr/lib/autoupdater/download.d/10gluon-autoupdater

@@ -2,6 +2,7 @@
 
 . /lib/gluon/autoupdater/lib.sh
 
+flag_invocation 1
 
 stop cron
 stop urngd

package/gluon-setup-mode/Makefile

@@ -35,6 +35,9 @@ init_links := \
 define Package/gluon-setup-mode/install
 	$(Gluon/Build/Install)
 
+	$(INSTALL_DIR) $(1)/lib/gluon/setup-mode
+	$(INSTALL_BIN) $(PKG_BUILD_DIR)/wait-network-request $(1)/lib/gluon/setup-mode
+
 	$(LN) S20network $(1)/lib/gluon/setup-mode/rc.d/K90network
 
 	for link in $(init_links); do \

package/gluon-setup-mode/files/lib/preinit/89_network_setup_mode

@@ -0,0 +1,55 @@
+#!/bin/sh
+
+. /lib/functions.sh
+
+device_supports_networked_setup_mode() {
+	local is_networked="$(lua -e 'print(require("gluon.setup-mode").supports_networked_activation())')"
+
+	if [ "${is_networked}" = "true" ]; then
+		return 0
+	fi
+
+	return 1
+}
+
+should_activate_networked() {
+	local setup_ifnames="$(lua -e 'print(require("gluon.sysconfig").setup_ifname)')"
+	local should_start=1
+
+	if ! device_supports_networked_setup_mode; then
+		return 1
+	fi
+
+	for iface in $setup_ifnames
+	do
+		ip link set dev "${iface}" up
+	done
+
+	# shellcheck disable=SC2086
+	if /lib/gluon/setup-mode/wait-network-request ${setup_ifnames}; then
+		should_start=0
+	fi
+
+	for iface in $setup_ifnames
+	do
+		ip link set dev "${iface}" down
+	done
+
+	return $should_start
+}
+
+network_setup_mode_enable() {
+	local enabled="$(uci -q get 'gluon-setup-mode.@setup_mode[0].enabled')"
+	local configured="$(uci -q get 'gluon-setup-mode.@setup_mode[0].configured')"
+
+	if [ "$enabled" = 1 ] || [ "$configured" != 1 ]; then
+		return 0
+	fi
+
+	if should_activate_networked; then
+		uci -q set 'gluon-setup-mode.@setup_mode[0].enabled=1'
+	fi
+	return 0
+}
+
+boot_hook_add preinit_main network_setup_mode_enable

package/gluon-setup-mode/files/lib/preinit/90_setup_mode

@@ -1,6 +1,5 @@
 #!/bin/sh
 
-
 setup_mode_enable() {
 	local enabled="$(uci -q get 'gluon-setup-mode.@setup_mode[0].enabled')"
 	local configured="$(uci -q get 'gluon-setup-mode.@setup_mode[0].configured')"

package/gluon-setup-mode/luasrc/usr/lib/lua/gluon/setup-mode.lua

@@ -11,4 +11,12 @@ function M.get_status_led()
 	end
 end
 
+function M.supports_networked_activation()
+	if platform.match('ramips', 'mt7621', {
+		'zyxel,nwa55axe',
+	}) then
+		return true
+	end
+end
+
 return M

package/gluon-setup-mode/src/.gitignore

@@ -0,0 +1,2 @@
+enter-setup-mode
+check-setup-mode

package/gluon-setup-mode/src/Makefile

@@ -0,0 +1,16 @@
+CC:=gcc
+CFLAGS:=
+LDFLAGS:=
+
+all: wait-network-request send-network-request
+
+wait-network-request:
+	$(CC) $(CFLAGS) $(LDFLAGS) -o wait-network-request wait-network-request.c
+
+send-network-request:
+	$(CC) $(CFLAGS) $(LDFLAGS) -o send-network-request send-network-request.c
+
+clean:
+	rm -rf send-network-request wait-network-request
+
+.PHONY: clean all

package/gluon-setup-mode/src/gluon-remote-setup-mode.h

@@ -0,0 +1,18 @@
+#pragma once
+
+/* Seconds*/
+#define REMOTE_SETUP_MODE_RX_TIMEOUT						5
+#define REMOTE_SETUP_MODE_TX_INTERVAL						1
+
+#define REMOTE_SETUP_MODE_MAC_LEN						6
+#define REMOTE_SETUP_MODE_DST_MAC_OFFSET					0
+#define REMOTE_SETUP_MODE_DST_MAC						0x01, 0x80, 0xc2, 0x00, 0x00, 0x0e
+#define REMOTE_SETUP_MODE_SRC_MAC_OFFSET					6
+#define REMOTE_SETUP_MODE_SRC_MAC						0xda, 0xec, 0xe5, 0x8f, 0x60, 0x14
+
+#define REMOTE_SETUP_MODE_ETHERTYPE_OFFSET					(REMOTE_SETUP_MODE_MAC_LEN + REMOTE_SETUP_MODE_MAC_LEN)
+#define REMOTE_SETUP_MODE_ETHERTYPE_LEN						2
+#define REMOTE_SETUP_MODE_ETHERTYPE						0x23, 0x42
+
+#define REMOTE_SETUP_MODE_DATA_CMD_OFFSET					(REMOTE_SETUP_MODE_ETHERTYPE_OFFSET + REMOTE_SETUP_MODE_ETHERTYPE_LEN)
+#define REMOTE_SETUP_MODE_DATA_CMD_SETUP					"SETUP"

package/gluon-setup-mode/src/send-network-request.c

@@ -0,0 +1,91 @@
+/* SPDX-License-Identifier: GPL-2.0-only */
+
+/*
+ * Utility for performing remote setup-mode activation
+ *
+ * Copyright (c) David Bauer <[email protected]>
+ */
+
+#include <stdio.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <unistd.h>
+#include <arpa/inet.h>
+#include <linux/if_packet.h>
+#include <net/ethernet.h>
+#include <string.h>
+#include <net/if.h>
+#include <errno.h>
+#include <sys/ioctl.h>
+
+#include "gluon-remote-setup-mode.h"
+
+#define LLDP_DELAY	(REMOTE_SETUP_MODE_TX_INTERVAL * 1000)
+
+char buf[] = {
+	/* Destination - LLDP Multicast */
+	REMOTE_SETUP_MODE_DST_MAC,
+	/* Source */
+	REMOTE_SETUP_MODE_SRC_MAC,
+	/* Type */
+	REMOTE_SETUP_MODE_ETHERTYPE,
+	/* Magic*/
+	'S', 'E', 'T', 'U', 'P',
+	/* Trail */
+	0x00,
+};
+
+int get_ifindex(int sock, const char *ifname)
+{
+	struct ifreq ifr;
+
+	strncpy((char *)ifr.ifr_name, ifname, IFNAMSIZ);
+
+	if (ioctl(sock, SIOCGIFINDEX, &ifr)) {
+		printf("IOCTL error: %s\n", strerror(errno));
+		return -1;
+	}
+
+	return ifr.ifr_ifindex;
+}
+
+int main(int argc, char *argv[])
+{
+	struct sockaddr_ll sll;
+	int ifindex;
+	int s_fd;
+
+	if (argc < 2 || !strcmp("help", argv[1])) {
+		printf("Usage: %s <ifname>\n", argv[0]);
+		return 1;
+	}
+
+	s_fd = socket(AF_PACKET,SOCK_RAW,htons(ETH_P_ALL));
+	if (s_fd < 0) {
+		printf("Socket error: %s\n", strerror(errno));
+		return 1;
+	}
+
+	ifindex = get_ifindex(s_fd, argv[1]);
+	if (ifindex < 0) {
+		return 1;
+	}
+
+	memset(&sll, 0, sizeof(sll));
+	sll.sll_family = AF_PACKET;
+	sll.sll_ifindex = ifindex;
+
+	printf("Sending Reset command\n");
+	while (1) {
+		if (sendto(s_fd, buf, sizeof(buf), 0, (struct sockaddr *) &sll, sizeof(sll)) < 0) {
+			printf("Error sending packet: %s\n", strerror(errno));
+			return 1;
+		}
+
+		usleep(LLDP_DELAY);
+	}
+
+	close(s_fd);
+
+	return 0;
+}