Merge ~morphis/snappy-hwe-snaps/+git/wifi-ap:dual-mode into ~snappy-hwe-team/snappy-hwe-snaps/+git/wifi-ap:master

[Simon Fels]

This namely brings support for simultaneous operating the STA and AP modes. This is depends basically on the hardware and needs to be configured with setting 'wifi-interface-mode' to 'virtual' which is the default. The service will create a virtual interface of type '__ap' and tells hostapd to operate on this. To avoid confusion with a possible running network-manager instance we're marking the interface as temporarily unmanaged through the nmcli utility regardless which 'wifi-interface-mode' is configured.

Next to the changes above this contains some small cleanups and changes the command line arguments of the config script slightly.

Default WiFi passphrase is now 'UbuntuAP'.

Handle errors in different cases correctly.

Fix NAT routing via iptables to forward connections from the right network interface.

This doesn't use yet the existing 'network-manager' part to include nmcli in the snap as its not clear yet if that will pass the snap builds on launchpad.

CI build: https://jenkins.canonical.com/system-enablement/job/generic-build-snap/32/ (ignore the network-manager*.snap artifact, the job is not that stable yet as it doesn't cleanup correctly)

[Konrad Zapałowicz (kzapalowicz)]

Sweet

review: Approve (code)

[Jim Hodapp (jhodapp)]

See comments inline below.

review: Needs Fixing (code)

[Matteo Croce (teknoraver)]

review: Needs Fixing

[Matteo Croce (teknoraver)]

review: Approve

diff --git a/bin/ap.sh b/bin/ap.sh
index 33f20f0..66aa782 100755
--- a/bin/ap.sh
+++ b/bin/ap.sh
@@ -16,7 +16,13 @@
 
 set -x
 
+if [ $(id -u) -ne 0 ] ; then
+	echo "ERROR: $0 needs to be executed as root!"
+	exit 1
+fi
+
 . $SNAP/bin/config-internal.sh
+. $SNAP/bin/helper.sh
 
 DEFAULT_ACCESS_POINT_INTERFACE="ap0"
 
@@ -25,58 +31,7 @@ if [ "$DISABLED" == "1" ] ; then
 	exit 0
 fi
 
-generate_dnsmasq_config() {
-	(
-	iface=$WIFI_INTERFACE
-	if [ "$WIFI_INTERFACE_MODE" == "virtual" ] ; then
-		iface=$DEFAULT_ACCESS_POINT_INTERFACE
-	fi
-
-	cat<<-EOF
-	port=53
-	all-servers
-	interface=$iface
-	except-interface=lo
-	listen-address=$WIFI_ADDRESS
-	bind-interfaces
-	dhcp-range=$DHCP_RANGE_START,$DHCP_RANGE_STOP,$DHCP_LEASE_TIME
-	dhcp-option=6, $WIFI_ADDRESS
-	EOF
-	) > $SNAP_DATA/dnsmasq.conf
-}
-
-start_dnsmasq() {
-	iface=$WIFI_INTERFACE
-
-	# If WiFi interface is managed by ifupdown leave it as is
-	if [ -e /etc/network/interfaces.d/$iface ]; then
-		exit 0
-	fi
-
-	# Create our AP interface if required
-	if [ "$WIFI_INTERFACE_MODE" == "virtual" ] ; then
-		iface=$DEFAULT_ACCESS_POINT_INTERFACE
-		$SNAP/bin/iw dev $WIFI_INTERFACE interface add $iface type __ap
-		sleep 2
-	fi
-
-	# Initial wifi interface configuration
-	ifconfig $iface up
-	ifconfig $iface $WIFI_ADDRESS netmask 255.255.255.0
-	sleep 2
-
-	if [ "$SHARE_NETWORK_INTERFACE" != "none" ] ; then
-		# Enable NAT to forward our network connection
-		iptables --table nat --append POSTROUTING --out-interface $ETHERNET_INTERFACE -j MASQUERADE
-		iptables --append FORWARD --in-interface $iface -j ACCEPT
-
-		sysctl -w net.ipv4.ip_forward=1
-	fi
-
-	$SNAP/bin/dnsmasq -k -C $SNAP_DATA/dnsmasq.conf -l $SNAP_DATA/dnsmasq.leases -x $SNAP_DATA/dnsmasq.pid &
-}
-
-stop_dnsmasq() {
+shutdown() {
 	DNSMASQ_PID=$(cat $SNAP_DATA/dnsmasq.pid)
 	kill -TERM $DNSMASQ_PID
 	wait $DNSMASQ_PID
@@ -88,40 +43,90 @@ stop_dnsmasq() {
 
 	if [ "$SHARE_NETWORK_INTERFACE" != "none" ] ; then
 		# flush forwarding rules out
-		iptables --table nat --delete POSTROUTING --out-interface $ETHERNET_INTERFACE -j MASQUERADE
+		iptables --table nat --delete POSTROUTING --out-interface $SHARE_NETWORK_INTERFACE -j MASQUERADE
 		iptables --delete FORWARD --in-interface $iface -j ACCEPT
+		sysctl -w net.ipv4.ip_forward=0
 	fi
 
 	if [ "$WIFI_INTERFACE_MODE" == "virtual" ] ; then
 		$SNAP/bin/iw dev $iface del
 	fi
-
-	# disable ipv4 forward
-	sysctl -w net.ipv4.ip_forward=0
 }
 
-generate_dnsmasq_config
-start_dnsmasq
-
 iface=$WIFI_INTERFACE
 if [ "$WIFI_INTERFACE_MODE" == "virtual" ] ; then
 	iface=$DEFAULT_ACCESS_POINT_INTERFACE
+
+	# Make sure if the real wifi interface is connected we use
+	# the same channel for our AP as otherwise the created AP
+	# will not work.
+	channel_in_use=$(iw dev $WIFI_INTERFACE info |awk '/channel/{print$2}')
+	if [ $channel_in_use != $WIFI_CHANNEL ] ; then
+		echo "ERROR: You configured a different channel than the WiFi device"
+		echo "       is currently using. This will not work as most devices"
+		echo "       require you to operate for AP and STA on the same channel."
+		exit 1
+	fi
+fi
+
+# Create our AP interface if required
+if [ "$WIFI_INTERFACE_MODE" = "virtual" ] ; then
+	iface=$DEFAULT_ACCESS_POINT_INTERFACE
+	$SNAP/bin/iw dev $WIFI_INTERFACE interface add $iface type __ap
+	sleep 2
+fi
+if [ "$WIFI_INTERFACE_MODE" = "direct" ] ; then
+	# If WiFi interface is managed by ifupdown or network-manager leave it as is
+	assert_not_managed_by_ifupdown $iface
 fi
 
+# Prevent network-manager from touching the interface we want to use. If
+# network-manager was configured to use the interface its nothing we want
+# to prevent here as this is how the user configured the system.
+$SNAP/bin/nmcli d set $iface managed no
+
+# Initial wifi interface configuration
+ifconfig $iface up
+if [ $? -ne 0 ] ; then
+	echo "ERROR: Failed to enable WiFi network interface '$iface'"
+
+	# Remove virtual interface again if we created one
+	if [ "$WIFI_INTERFACE_MODE" = "virtual" ] ; then
+		$SNAP/bin/iw dev $iface del
+	fi
+
+	# Hand interface back to network-manager. This will also trigger the
+	# auto connection process inside network-manager to get connected
+	# with the previous network.
+	$SNAP/bin/nmcli d set $iface managed yes
+
+	exit 1
+fi
+
+# Configure interface and give it a moment to settle
+ifconfig $iface $WIFI_ADDRESS netmask $WIFI_NETMASK
+sleep 2
+
+if [ "$SHARE_NETWORK_INTERFACE" != "none" ] ; then
+	# Enable NAT to forward our network connection
+	iptables --table nat --append POSTROUTING --out-interface $SHARE_NETWORK_INTERFACE -j MASQUERADE
+	iptables --append FORWARD --in-interface $iface -j ACCEPT
+	sysctl -w net.ipv4.ip_forward=1
+fi
+
+generate_dnsmasq_config $SNAP_DATA/dnsmasq.conf
+$SNAP/bin/dnsmasq -k -C $SNAP_DATA/dnsmasq.conf -l $SNAP_DATA/dnsmasq.leases -x $SNAP_DATA/dnsmasq.pid &
+
 # Wait a bit until our WiFi network interface is correctly
 # setup by dnsmasq
-grep $iface /proc/net/dev &> /dev/null
-while [ $? != 0 ] ; do
-	sleep 5
-	grep $iface /proc/net/dev &> /dev/null
-done
+wait_until_interface_is_available $iface
 
 driver=$WIFI_HOSTAPD_DRIVER
 if [ "$driver" == "rtl8188" ] ; then
 	driver=rtl871xdrv
 fi
 
-# Generate our configuration file
+# Generate our hostapd configuration file
 cat <<EOF > $SNAP_DATA/hostapd.conf
 interface=$iface
 driver=$driver
@@ -132,8 +137,6 @@ wmm_enabled=1
 ieee80211n=1
 ssid=$WIFI_SSID
 hw_mode=$WIFI_OPERATION_MODE
-# Enable 40MHz channels with 20ns guard interval
-ht_capab=[HT40][SHORT-GI-20][DSSS_CCK-40]
 EOF
 
 case "$WIFI_SECURITY" in
@@ -182,9 +185,9 @@ function exit_handler() {
 	# Wait until hostapd is correctly terminated before we continue
 	# doing anything
 	wait $HOSTAPD_PID
-	stop_dnsmasq
+	shutdown
 	exit 0
 }
 
 wait $HOSTAPD_PID
-stop_dnsmasq
\ No newline at end of file
+shutdown
\ No newline at end of file
diff --git a/bin/config.sh b/bin/config.sh
index 4c5bb41..0bf7839 100755
--- a/bin/config.sh
+++ b/bin/config.sh
@@ -17,12 +17,21 @@
 . $SNAP/bin/config-internal.sh
 
 set_item() {
+	if [ -z "$1" ] || [ -z "$2" ] ; then
+		echo "ERROR: You need to provide a key and a value to set"
+		echo
+		echo "You can call '$0 get' to list of all possible keys"
+		exit 1
+	fi
 	case $1 in
 		disabled)
 			DISABLED=$2
 			if [ "$DISABLED" == "0" ] ; then
-				echo "To really startup the service you have to start the"
-				echo "relevant service components on your own:"
+				echo "You have successfully enabled the access point but you still"
+				echo "need to either reboot the device or restart the systemd"
+				echo "service to make the service reloading its configuration."
+				echo "You can just run the following command (as root) if you"
+				echo "do not want to reboot your device:"
 				echo
 				echo " $ systemctl restart snap.wifi-ap.backend"
 			fi
@@ -30,73 +39,131 @@ set_item() {
 		debug)
 			DEBUG=$2
 			;;
-		wifi-interface)
+		wifi.interface)
 			WIFI_INTERFACE=$2
 			;;
-		wifi-address)
+		wifi.address)
 			WIFI_ADDRESS=$2
 			;;
-		wifi-interface-mode)
+		wifi.netmask)
+			WIFI_NETMASK=$2
+			;;
+		wifi.interface-mode)
 			WIFI_INTERFACE_MODE=$2
 			;;
-		wifi-hostapd-driver)
+		wifi.hostapd-driver)
 			WIFI_HOSTAPD_DRIVER=$2
 			if [ "$WIFI_HOSTAPD_DRIVER" == "rtl8188" ] ; then
 				# Select correct mode for the rtl8188 driver
 				WIFI_INTERFACE_MODE=direct
 			fi
 			;;
-		wifi-ssid)
+		wifi.ssid)
 			WIFI_SSID=$2
 			;;
-		wifi-security)
+		wifi.security)
 			WIFI_SECURITY=$2
 			;;
-		wifi-security-passphrase)
+		wifi.security-passphrase)
 			WIFI_SECURITY_PASSPHRASE=$2
 			;;
-		wifi-channel)
+		wifi.channel)
 			WIFI_CHANNEL=$2
 			;;
-		wifi-operation-mode)
+		wifi.operation-mode)
 			WIFI_OPERATION_MODE=$2
 			;;
-		share-network-interface)
+		share.network-interface)
 			SHARE_NETWORK_INTERFACE=$2
 			;;
-		dhcp-range-start)
+		dhcp.range-start)
 			DHCP_RANGE_START=$2
 			;;
-		dhcp-range-stop)
+		dhcp.range-stop)
 			DHCP_RANGE_STOP=$2
 			;;
-		dhcp-lease-time)
+		dhcp.lease-time)
 			DHCP_LEASE_TIME=$2
 			;;
 		*)
+			echo "ERROR: Unknown config item '$1'"
+			exit 1
+	esac
+}
+
+get_item() {
+	case $1 in
+		disabled)
+			echo $DISABLED
+			;;
+		debug)
+			echo $DEBUG
+			;;
+		wifi.interface)
+			echo $WIFI_INTERFACE
+			;;
+		wifi.address)
+			echo $WIFI_ADDRESS
+			;;
+		wifi.netmask)
+			echo $WIFI_NETMASK
+			;;
+		wifi.interface-mode)
+			echo $WIFI_INTERFACE_MODE
+			;;
+		wifi.hostapd-driver)
+			echo $WIFI_HOSTAPD_DRIVER
+			;;
+		wifi.ssid)
+			echo $WIFI_SSID
+			;;
+		wifi.security)
+			echo $WIFI_SECURITY
+			;;
+		wifi.security-passphrase)
+			echo $WIFI_SECURITY_PASSPHRASE
+			;;
+		wifi.channel)
+			echo $WIFI_CHANNEL
+			;;
+		wifi.operation-mode)
+			echo $WIFI_OPERATION_MODE
+			;;
+		share.network-interface)
+			echo $SHARE_NETWORK_INTERFACE
+			;;
+		dhcp.range-start)
+			echo $DHCP_RANGE_START
+			;;
+		dhcp.range-stop)
+			echo $DHCP_RANGE_STOP
+			;;
+		dhcp.lease-time)
+			echo $DHCP_LEASE_TIME
+			;;
+		*)
 			echo "Unknown config item '$1'"
 			exit 1
 	esac
 }
 
 dump_config() {
-	echo "Current configuration:"
-	echo "==========================================================="
 	echo "disabled: $DISABLED"
 	echo "debug: $DEBUG"
-	echo "wifi-interface: $WIFI_INTERFACE"
-	echo "wifi-address: $WIFI_ADDRESS"
-	echo "wifi-interface-mode: $WIFI_INTERFACE_MODE"
-	echo "wifi-hostapd-driver: $WIFI_HOSTAPD_DRIVER"
-	echo "wifi-ssid: $WIFI_SSID"
-	echo "wifi-security: $WIFI_SECURITY"
-	echo "wifi-security-passphrase: $WIFI_SECURITY_PASSPHRASE"
-	echo "wifi-channel: $WIFI_CHANNEL"
-	echo "wifi-operation-mode: $WIFI_OPERATION_MODE"
-	echo "share-network-interface: $SHARE_NETWORK_INTERFACE"
-	echo "dhcp-range-start: $DHCP_RANGE_START"
-	echo "dhcp-range-stop: $DHCP_RANGE_STOP"
-	echo "dhcp-lease-time: $DHCP_LEASE_TIME"
+	echo "wifi.interface: $WIFI_INTERFACE"
+	echo "wifi.address: $WIFI_ADDRESS"
+	echo "wifi.netmask: $WIFI_NETMASK"
+	echo "wifi.interface-mode: $WIFI_INTERFACE_MODE"
+	echo "wifi.hostapd-driver: $WIFI_HOSTAPD_DRIVER"
+	echo "wifi.ssid: $WIFI_SSID"
+	echo "wifi.security: $WIFI_SECURITY"
+	echo "wifi.security-passphrase: $WIFI_SECURITY_PASSPHRASE"
+	echo "wifi.channel: $WIFI_CHANNEL"
+	echo "wifi.operation-mode: $WIFI_OPERATION_MODE"
+	echo "share.network-interface: $SHARE_NETWORK_INTERFACE"
+	echo "dhcp.range-start: $DHCP_RANGE_START"
+	echo "dhcp.range-stop: $DHCP_RANGE_STOP"
+	echo "dhcp.lease-time: $DHCP_LEASE_TIME"
 }
 
 write_configuration() {
@@ -109,6 +176,7 @@ write_configuration() {
 	DEBUG=$DEBUG
 	WIFI_INTERFACE=$WIFI_INTERFACE
 	WIFI_ADDRESS=$WIFI_ADDRESS
+	WIFI_NETMASK=$WIFI_NETMASK
 	WIFI_INTERFACE_MODE=$WIFI_INTERFACE_MODE
 	WIFI_HOSTAPD_DRIVER=$WIFI_HOSTAPD_DRIVER
 	WIFI_SSID=$WIFI_SSID
@@ -123,8 +191,21 @@ write_configuration() {
 	EOF
 }
 
+if [ -z "$1" ] ; then
+	echo "Usage: $0 get|set <key> [<value>]"
+	echo
+	echo "You can call '$0 get' to list of all possible keys"
+	exit
+fi
+
+
+
 case "$1" in
 	set)
+		if [ $(id -u) -ne 0 ] ; then
+			echo "ERROR: '$@' needs to be executed as root!"
+			exit 1
+		fi
 		shift
 		key=$1
 		shift
@@ -133,8 +214,13 @@ case "$1" in
 		set_item $key $value
 		write_configuration
 		;;
-	dump)
-		dump_config
+	get)
+		shift
+		if [ "$1" = "" ] ; then
+			dump_config
+		else
+			echo "$1: $(get_item $1)"
+		fi
 		shift
 		;;
 	*)
diff --git a/bin/helper.sh b/bin/helper.sh
new file mode 100644
index 0000000..df56715
--- /dev/null
+++ b/bin/helper.sh
@@ -0,0 +1,52 @@
+#!/bin/bash
+#
+# Copyright (C) 2015, 2016 Canonical Ltd
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+set -x
+
+wait_until_interface_is_available() {
+	grep $1 /proc/net/dev &> /dev/null
+	while [ $? != 0 ] ; do
+		sleep 5
+		grep $1 /proc/net/dev &> /dev/null
+	done
+}
+
+assert_not_managed_by_ifupdown() {
+	if [ -e /etc/network/interfaces.d/$1 ]; then
+		echo "ERROR: Interface $1 is managed by ifupdown and can't be used"
+		exit 1
+	fi
+}
+
+generate_dnsmasq_config() {
+	{
+	iface=$WIFI_INTERFACE
+	if [ "$WIFI_INTERFACE_MODE" = "virtual" ] ; then
+		iface=$DEFAULT_ACCESS_POINT_INTERFACE
+	fi
+
+	cat<<-EOF
+	port=53
+	all-servers
+	interface=$iface
+	except-interface=lo
+	listen-address=$WIFI_ADDRESS
+	bind-interfaces
+	dhcp-range=$DHCP_RANGE_START,$DHCP_RANGE_STOP,$DHCP_LEASE_TIME
+	dhcp-option=6, $WIFI_ADDRESS
+	EOF
+	} > $1
+}
diff --git a/conf/default-config b/conf/default-config
index 8259e90..1fa5c4f 100644
--- a/conf/default-config
+++ b/conf/default-config
@@ -22,6 +22,7 @@ DEBUG=0
 # Default configuration
 WIFI_INTERFACE=wlan0
 WIFI_ADDRESS=192.168.7.1
+WIFI_NETMASK=255.255.255.0
 
 # Possible options are: uap, direct
 #   virtual:
@@ -40,7 +41,7 @@ WIFI_SSID="Ubuntu"
 # Can be 'open' or 'wpa2'
 WIFI_SECURITY="open"
 # WIFI_SECURITY="wpa2"
-# WIFI_SECURITY_PASSPHRASE="Ubuntu16.04"
+# WIFI_SECURITY_PASSPHRASE="UbuntuAP"
 
 WIFI_CHANNEL=6
 # Operation mode (a = IEEE 802.11a (5 GHz), b = IEEE 802.11b (2.4 GHz),
diff --git a/snapcraft.yaml b/snapcraft.yaml
index 3d583eb..8733027 100644
--- a/snapcraft.yaml
+++ b/snapcraft.yaml
@@ -17,6 +17,7 @@ apps:
       - network-control
       - firewall-control
       - network-bind
+      - network-manager
   config:
     command: bin/config.sh
 
@@ -24,14 +25,12 @@ parts:
   scripts:
     plugin: dump
     source: .
-    filesets:
-      all:
+    snap:
         - bin/config.sh
         - bin/config-internal.sh
         - bin/ap.sh
+        - bin/helper.sh
         - conf/default-config
-    snap:
-      - $all
   network-utils:
     plugin: nil
     stage-packages:
@@ -100,3 +99,9 @@ parts:
         - rtl8188/hostapd
     snap:
       - $binaries
+  nmlci:
+    plugin: nil
+    stage-packages:
+      - network-manager
+    organize:
+      usr/bin/nmcli: bin/nmcli