diff --git a/docs/remote_access.md b/docs/remote_access.md index e0c3995..053613f 100644 --- a/docs/remote_access.md +++ b/docs/remote_access.md @@ -2,15 +2,17 @@ This tutorial is adapted from a tutorial that you can find [here](https://www.raspberryconnect.com/projects/65-raspberrypi-hotspot-accesspoints/157-raspberry-pi-auto-wifi-hotspot-switch-internet). +All the files modified in this document are also available in the repository, in the folder `scripts/raspbian_configuration`. The architecture of this folder shows where each file belong. + In order to work as an access point, the Raspberry Pi will need to have access point software installed, along with DHCP server software to provide connecting devices with a network address. To create an access point, we'll need DNSMasq and HostAPD. Install all the required software in one go with this command:: -``` +```sh sudo apt install dnsmasq hostapd ``` Since the configuration files are not ready yet, turn the new software off as follows:: -``` +```sh sudo systemctl unmask hostapd sudo systemctl disable dnsmasq sudo systemctl disable hostapd @@ -55,7 +57,7 @@ The country_code should be set to your country to comply with local RF laws. You To save the config file press `CTRL+O` and to exit press `CTRL+X`. We also use a special function to change the network name to the machine name. Add this to `/etc/rc.local` with `sudo nano /etc/rc.local`: -``` +```sh # Replace wifi hostname sed -i "s/^ssid.*/ssid=PlanktoScope-$(python3 -c "import planktoscope.uuidName as uuidName; print(uuidName.machineName(machine=uuidName.getSerial()).replace(' ','_'))")/" /etc/hostapd/hostapd.conf ``` @@ -82,6 +84,14 @@ server=1.1.1.1 domain-needed bogus-priv dhcp-range=192.168.4.100,192.168.4.200,12h + +#AutoEthernet config +interface=eth0 +bind-dynamic +server=1.1.1.1 +domain-needed +bogus-priv +dhcp-range=192.168.5.100,192.168.5.200,12h ``` and then save `CTRL+O` and exit `CTRL+X`. @@ -91,27 +101,41 @@ Reload dnsmasq to use the updated configuration: sudo systemctl reload dnsmasq ``` -## IP forwarding - -While the RPi is in hotspot mode ip forwarding needs to be on so the internet works when an ethernet cable is attached. The autohotspot script will switch ip forwarding on and off between network mode and hotspot mode but it needs to be on by default for the script to manage ip forwarding. Edit `/etc/sysctl.conf` with `sudo nano /etc/sysctl.conf` and change the line 28 so it reads as follows: -``` -# Uncomment the next line to enable packet forwarding for IPv4 -net.ipv4.ip_forward=1 -``` - -Save and exit. - - ## DHCPCD DHCPCD is the software that manages the network setup. The next step is to stop dhcpcd from starting the wifi network so the autohotspot script in the next step takes control of that. Ethernet will still be managed by dhcpcd. +This will also create a fallback configuration to a static IP if no DHCP server is present on the Ethernet network. + Just add this line to the end of /etc/dhcpcd.conf with `sudo nano /etc/dhcpcd.conf`: ``` nohook wpa_supplicant + +# define static profile +profile static_eth0 +static ip_address=192.168.5.1/24 +static routers=192.168.5.1 +static domain_name_servers=192.168.5.1 + +# fallback to static profile on eth0 +interface eth0 +fallback static_eth0 ``` Save and exit. +For the fallback Ethernet network to work, we also need to add a hook to DHCPCD so it starts up the local DHCP server (dnsmasq). Edit the file `/etc/dhcpcd.enter-hook` with `sudo nano /etc/dhcpcd.enter-hook`: + +```sh +if [ "$interface" = "eth0" ] && [ "$if_up" ]; then + systemctl start dnsmasq + if [ "$reason" = "STATIC" ] || [ "$reason" = "TIMEOUT" ] || [ "$reason" = "EXPIRE" ] || [ "$reason" = "NAK" ]; then + systemctl start dnsmasq + elif [ "$reason" = "NOCARRIER" ] || [ "$reason" = "INFORM" ] || [ "$reason" = "DEPARTED" ]; then + systemctl stop dnsmasq + fi +fi +``` + ## Autohotspot service file @@ -165,21 +189,28 @@ If no wifi signal is found for a known SSID then the script will shutdown the wi The script works with SSID's that contain spaces and by entering your routers MAC address it can be used with hidden SSID's. !!! info Hidden SSIDs + If your routers SSID is not broadcast/hidden then find this section in the script + ``` #Enter the Routers Mac Addresses for hidden SSIDs, seperated by spaces ie #( '11:22:33:44:55:66' 'aa:bb:cc:dd:ee:ff' ) mac=() ``` + and enter you routers MAC address in the brackets of mac=() as shown in the example. Make sure mutiple MAC addresses are seperated by a space. Create a new file with the command `sudo nano /usr/bin/autohotspotN` and add the following: ```sh #!/bin/bash -#version 0.96-N/HS-I +#version 0.961-N/HS-I-PlanktonPlanet -#You may share this script on the condition a reference to RaspberryConnect.com -#must be included in copies or derivatives of this script. +#changes by PlanktonPlanet includes the following: +#- formatting and shellcheck validation +#- removal of ip forwarding setup + +#You may share this script on the condition a reference to RaspberryConnect.com +#must be included in copies or derivatives of this script. #Network Wifi & Hotspot with Internet #A script to switch between a wifi network and an Internet routed Hotspot @@ -189,174 +220,147 @@ Create a new file with the command `sudo nano /usr/bin/autohotspotN` and add the #http://www.raspberryconnect.com wifidev="wlan0" #device name to use. Default is wlan0. -ethdev="eth0" #Ethernet port to use with IP tables -#use the command: iw dev ,to see wifi interface name - -IFSdef=$IFS -cnt=0 -#These four lines capture the wifi networks the RPi is setup to use -wpassid=$(awk '/ssid="/{ print $0 }' /etc/wpa_supplicant/wpa_supplicant.conf | awk -F'ssid=' '{ print $2 }' ORS=',' | sed 's/\"/''/g' | sed 's/,$//') -wpassid=$(echo "${wpassid//[$'\r\n']}") -IFS="," -ssids=($wpassid) -IFS=$IFSdef #reset back to defaults +ethdev="eth0" #Ethernet port to use with IP tables +#use the command: iw dev ,to see wifi interface name +#These two lines capture the wifi networks the RPi is setup to use +wpassid=$(awk '/ssid="/{ print $0 }' /etc/wpa_supplicant/wpa_supplicant.conf | awk -F'ssid=' '{ print $2 }' | sed 's/\r//g' | awk 'BEGIN{ORS=","} {print}' | sed 's/\"/''/g' | sed 's/,$//') +IFS="," read -r -a ssids <<<"$wpassid" #Note:If you only want to check for certain SSIDs #Remove the # in in front of ssids=('mySSID1'.... below and put a # infront of all four lines above # separated by a space, eg ('mySSID1' 'mySSID2') #ssids=('mySSID1' 'mySSID2' 'mySSID3') -#Enter the Routers Mac Addresses for hidden SSIDs, seperated by spaces ie -#( '11:22:33:44:55:66' 'aa:bb:cc:dd:ee:ff' ) +#Enter the Routers Mac Addresses for hidden SSIDs, seperated by spaces ie +#( '11:22:33:44:55:66' 'aa:bb:cc:dd:ee:ff' ) mac=() ssidsmac=("${ssids[@]}" "${mac[@]}") #combines ssid and MAC for checking -createAdHocNetwork() -{ - echo "Creating Hotspot" - ip link set dev "$wifidev" down - ip a add 192.168.4.1/24 brd + dev "$wifidev" - ip link set dev "$wifidev" up - dhcpcd -k "$wifidev" >/dev/null 2>&1 - iptables -t nat -A POSTROUTING -o "$ethdev" -j MASQUERADE - iptables -A FORWARD -i "$ethdev" -o "$wifidev" -m state --state RELATED,ESTABLISHED -j ACCEPT - iptables -A FORWARD -i "$wifidev" -o "$ethdev" -j ACCEPT - systemctl start dnsmasq - systemctl start hostapd - echo 1 > /proc/sys/net/ipv4/ip_forward +createAdHocNetwork() { + echo "Creating Hotspot" + ip link set dev "$wifidev" down + ip a add 192.168.4.1/24 brd + dev "$wifidev" + ip link set dev "$wifidev" up + dhcpcd -k "$wifidev" >/dev/null 2>&1 + systemctl start dnsmasq + systemctl start hostapd } -KillHotspot() -{ - echo "Shutting Down Hotspot" - ip link set dev "$wifidev" down - systemctl stop hostapd - systemctl stop dnsmasq - iptables -D FORWARD -i "$ethdev" -o "$wifidev" -m state --state RELATED,ESTABLISHED -j ACCEPT - iptables -D FORWARD -i "$wifidev" -o "$ethdev" -j ACCEPT - echo 0 > /proc/sys/net/ipv4/ip_forward - ip addr flush dev "$wifidev" - ip link set dev "$wifidev" up - dhcpcd -n "$wifidev" >/dev/null 2>&1 +KillHotspot() { + echo "Shutting Down Hotspot" + ip link set dev "$wifidev" down + systemctl stop hostapd + systemctl stop dnsmasq + ip addr flush dev "$wifidev" + ip link set dev "$wifidev" up + dhcpcd -n "$wifidev" >/dev/null 2>&1 } -ChkWifiUp() -{ - echo "Checking WiFi connection ok" - sleep 20 #give time for connection to be completed to router - if ! wpa_cli -i "$wifidev" status | grep 'ip_address' >/dev/null 2>&1 - then #Failed to connect to wifi (check your wifi settings, password etc) - echo 'Wifi failed to connect, falling back to Hotspot.' - wpa_cli terminate "$wifidev" >/dev/null 2>&1 - createAdHocNetwork - fi +ChkWifiUp() { + echo "Checking WiFi connection ok" + sleep 20 #give time for connection to be completed to router + if ! wpa_cli -i "$wifidev" status | grep 'ip_address' >/dev/null 2>&1; then #Failed to connect to wifi (check your wifi settings, password etc) + echo 'Wifi failed to connect, falling back to Hotspot.' + wpa_cli terminate "$wifidev" >/dev/null 2>&1 + createAdHocNetwork + fi } -chksys() -{ - #After some system updates hostapd gets masked using Raspbian Buster, and above. This checks and fixes - #the issue and also checks dnsmasq is ok so the hotspot can be generated. - #Check Hostapd is unmasked and disabled - if systemctl -all list-unit-files hostapd.service | grep "hostapd.service masked" >/dev/null 2>&1 ;then - systemctl unmask hostapd.service >/dev/null 2>&1 - fi - if systemctl -all list-unit-files hostapd.service | grep "hostapd.service enabled" >/dev/null 2>&1 ;then - systemctl disable hostapd.service >/dev/null 2>&1 - systemctl stop hostapd >/dev/null 2>&1 - fi - #Check dnsmasq is disabled - if systemctl -all list-unit-files dnsmasq.service | grep "dnsmasq.service masked" >/dev/null 2>&1 ;then - systemctl unmask dnsmasq >/dev/null 2>&1 - fi - if systemctl -all list-unit-files dnsmasq.service | grep "dnsmasq.service enabled" >/dev/null 2>&1 ;then - systemctl disable dnsmasq >/dev/null 2>&1 - systemctl stop dnsmasq >/dev/null 2>&1 - fi +chksys() { + #After some system updates hostapd gets masked using Raspbian Buster, and above. This checks and fixes + #the issue and also checks dnsmasq is ok so the hotspot can be generated. + #Check Hostapd is unmasked and disabled + if systemctl -all list-unit-files hostapd.service | grep "hostapd.service masked" >/dev/null 2>&1; then + systemctl unmask hostapd.service >/dev/null 2>&1 + fi + if systemctl -all list-unit-files hostapd.service | grep "hostapd.service enabled" >/dev/null 2>&1; then + systemctl disable hostapd.service >/dev/null 2>&1 + systemctl stop hostapd >/dev/null 2>&1 + fi + #Check dnsmasq is disabled + if systemctl -all list-unit-files dnsmasq.service | grep "dnsmasq.service masked" >/dev/null 2>&1; then + systemctl unmask dnsmasq >/dev/null 2>&1 + fi + if systemctl -all list-unit-files dnsmasq.service | grep "dnsmasq.service enabled" >/dev/null 2>&1; then + systemctl disable dnsmasq >/dev/null 2>&1 + systemctl stop dnsmasq >/dev/null 2>&1 + fi } +FindSSID() { + #Check to see what SSID's and MAC addresses are in range + ssidChk='NoSSid' + i=0 + j=0 + until [ $i -eq 1 ]; do #wait for wifi if busy, usb wifi is slower. + ssidreply=$( (iw dev "$wifidev" scan ap-force | grep -E "^BSS|SSID:") 2>&1) >/dev/null 2>&1 + #echo "SSid's in range: " $ssidreply + printf '%s\n' "${ssidreply[@]}" + echo "Device Available Check try " $j + if ((j >= 5)); then #if busy 5 times goto hotspot + echo "Device busy or unavailable 5 times, going to Hotspot" + ssidreply="" + i=1 + elif echo "$ssidreply" | grep "No such device (-19)" >/dev/null 2>&1; then + echo "No Device Reported, try " $j + NoDevice + elif echo "$ssidreply" | grep "Network is down (-100)" >/dev/null 2>&1; then + echo "Network Not available, trying again" $j + j=$((j + 1)) + sleep 2 + elif echo "$ssidreply" | grep "Read-only file system (-30)" >/dev/null 2>&1; then + echo "Temporary Read only file system, trying again" + j=$((j + 1)) + sleep 2 + elif echo "$ssidreply" | grep "Invalid exchange (-52)" >/dev/null 2>&1; then + echo "Temporary unavailable, trying again" + j=$((j + 1)) + sleep 2 + elif echo "$ssidreply" | grep -v "resource busy (-16)" >/dev/null 2>&1; then + echo "Device Available, checking SSid Results" + i=1 + else #see if device not busy in 2 seconds + echo "Device unavailable checking again, try " $j + j=$((j + 1)) + sleep 2 + fi + done -FindSSID() -{ -#Check to see what SSID's and MAC addresses are in range -ssidChk=('NoSSid') -i=0; j=0 -until [ $i -eq 1 ] #wait for wifi if busy, usb wifi is slower. -do - ssidreply=$((iw dev "$wifidev" scan ap-force | egrep "^BSS|SSID:") 2>&1) >/dev/null 2>&1 - #echo "SSid's in range: " $ssidreply - printf '%s\n' "${ssidreply[@]}" - echo "Device Available Check try " $j - if (($j >= 10)); then #if busy 10 times goto hotspot - echo "Device busy or unavailable 10 times, going to Hotspot" - ssidreply="" - i=1 - elif echo "$ssidreply" | grep "No such device (-19)" >/dev/null 2>&1; then - echo "No Device Reported, try " $j - NoDevice - elif echo "$ssidreply" | grep "Network is down (-100)" >/dev/null 2>&1 ; then - echo "Network Not available, trying again" $j - j=$((j + 1)) - sleep 2 - elif echo "$ssidreply" | grep "Read-only file system (-30)" >/dev/null 2>&1 ; then - echo "Temporary Read only file system, trying again" - j=$((j + 1)) - sleep 2 - elif echo "$ssidreply" | grep "Invalid exchange (-52)" >/dev/null 2>&1 ; then - echo "Temporary unavailable, trying again" - j=$((j + 1)) - sleep 2 - elif echo "$ssidreply" | grep -v "resource busy (-16)" >/dev/null 2>&1 ; then - echo "Device Available, checking SSid Results" - i=1 - else #see if device not busy in 2 seconds - echo "Device unavailable checking again, try " $j - j=$((j + 1)) - sleep 2 - fi -done - -for ssid in "${ssidsmac[@]}" -do - if (echo "$ssidreply" | grep "$ssid") >/dev/null 2>&1 - then - #Valid SSid found, passing to script - echo "Valid SSID Detected, assesing Wifi status" - ssidChk=$ssid - return 0 - else - #No Network found, NoSSid issued" - echo "No SSid found, assessing WiFi status" - ssidChk='NoSSid' - fi -done + for ssid in "${ssidsmac[@]}"; do + if (echo "$ssidreply" | grep -F -- "$ssid") >/dev/null 2>&1; then + #Valid SSid found, passing to script + echo "Valid SSID Detected, assesing Wifi status" + ssidChk=$ssid + return 0 + else + #No Network found, NoSSid issued" + echo "No SSid found, assessing WiFi status" + ssidChk='NoSSid' + fi + done } -NoDevice() -{ - #if no wifi device,ie usb wifi removed, activate wifi so when it is - #reconnected wifi to a router will be available - echo "No wifi device connected" - wpa_supplicant -B -i "$wifidev" -c /etc/wpa_supplicant/wpa_supplicant.conf >/dev/null 2>&1 - exit 1 +NoDevice() { + #if no wifi device,ie usb wifi removed, activate wifi so when it is + #reconnected wifi to a router will be available + echo "No wifi device connected" + wpa_supplicant -B -i "$wifidev" -c /etc/wpa_supplicant/wpa_supplicant.conf >/dev/null 2>&1 + exit 1 } chksys FindSSID #Create Hotspot or connect to valid wifi networks -if [ "$ssidChk" != "NoSSid" ] -then - echo 0 > /proc/sys/net/ipv4/ip_forward #deactivate ip forwarding - if systemctl status hostapd | grep "(running)" >/dev/null 2>&1 - then #hotspot running and ssid in range +if [ "$ssidChk" != "NoSSid" ]; then + if systemctl status hostapd | grep "(running)" >/dev/null 2>&1; then #hotspot running and ssid in range KillHotspot echo "Hotspot Deactivated, Bringing Wifi Up" wpa_supplicant -B -i "$wifidev" -c /etc/wpa_supplicant/wpa_supplicant.conf >/dev/null 2>&1 ChkWifiUp - elif { wpa_cli -i "$wifidev" status | grep 'ip_address'; } >/dev/null 2>&1 - then #Already connected + elif { wpa_cli -i "$wifidev" status | grep 'ip_address'; } >/dev/null 2>&1; then #Already connected echo "Wifi already connected to a network" else #ssid exists and no hotspot running connect to wifi network echo "Connecting to the WiFi Network" @@ -364,15 +368,15 @@ then ChkWifiUp fi else #ssid or MAC address not in range - if systemctl status hostapd | grep "(running)" >/dev/null 2>&1 - then + if systemctl status hostapd | grep "(running)" >/dev/null 2>&1; then echo "Hostspot already active" - elif { wpa_cli status | grep "$wifidev"; } >/dev/null 2>&1 - then + elif { wpa_cli status | grep "$wifidev"; } >/dev/null 2>&1; then echo "Cleaning wifi files and Activating Hotspot" wpa_cli terminate >/dev/null 2>&1 ip addr flush "$wifidev" ip link set dev "$wifidev" down + # ip addr flush "$ethdev" + # ip link set dev "$ethdev" down rm -r /var/run/wpa_supplicant >/dev/null 2>&1 createAdHocNetwork else #"No SSID, activating Hotspot" diff --git a/scripts/raspbian_configuration/etc/dhcpcd.conf b/scripts/raspbian_configuration/etc/dhcpcd.conf index cec2928..ea93680 100644 --- a/scripts/raspbian_configuration/etc/dhcpcd.conf +++ b/scripts/raspbian_configuration/etc/dhcpcd.conf @@ -59,3 +59,13 @@ slaac private #fallback static_eth0 nohook wpa_supplicant + +# define static profile +profile static_eth0 +static ip_address=192.168.5.1/24 +static routers=192.168.5.1 +static domain_name_servers=192.168.5.1 + +# fallback to static profile on eth0 +interface eth0 +fallback static_eth0 diff --git a/scripts/raspbian_configuration/etc/dhcpcd.enter-hook b/scripts/raspbian_configuration/etc/dhcpcd.enter-hook new file mode 100644 index 0000000..6253a7d --- /dev/null +++ b/scripts/raspbian_configuration/etc/dhcpcd.enter-hook @@ -0,0 +1,8 @@ +if [ "$interface" = "eth0" ] && [ "$if_up" ]; then + systemctl start dnsmasq + if [ "$reason" = "STATIC" ] || [ "$reason" = "TIMEOUT" ] || [ "$reason" = "EXPIRE" ] || [ "$reason" = "NAK" ]; then + systemctl start dnsmasq + elif [ "$reason" = "NOCARRIER" ] || [ "$reason" = "INFORM" ] || [ "$reason" = "DEPARTED" ]; then + systemctl stop dnsmasq + fi +fi diff --git a/scripts/raspbian_configuration/etc/dnsmasq.conf b/scripts/raspbian_configuration/etc/dnsmasq.conf index f523554..0873a8d 100644 --- a/scripts/raspbian_configuration/etc/dnsmasq.conf +++ b/scripts/raspbian_configuration/etc/dnsmasq.conf @@ -27,8 +27,8 @@ # Replies which are not DNSSEC signed may be legitimate, because the domain # is unsigned, or may be forgeries. Setting this option tells dnsmasq to -# check that an unsigned reply is OK, by finding a secure proof that a DS -# record somewhere between the root and the domain does not exist. +# check that an unsigned reply is OK, by finding a secure proof that a DS +# record somewhere between the root and the domain does not exist. # The cost of setting this is that even queries in unsigned domains will need # one or more extra DNS queries to verify. #dnssec-check-unsigned @@ -183,11 +183,11 @@ #dhcp-range=1234::2, 1234::500, 64, 12h # Do Router Advertisements, BUT NOT DHCP for this subnet. -#dhcp-range=1234::, ra-only +#dhcp-range=1234::, ra-only # Do Router Advertisements, BUT NOT DHCP for this subnet, also try and -# add names to the DNS for the IPv6 address of SLAAC-configured dual-stack -# hosts. Use the DHCPv4 lease to derive the name, network segment and +# add names to the DNS for the IPv6 address of SLAAC-configured dual-stack +# hosts. Use the DHCPv4 lease to derive the name, network segment and # MAC address and assume that the host will also have an # IPv6 address calculated using the SLAAC algorithm. #dhcp-range=1234::, ra-names @@ -210,9 +210,9 @@ #dhcp-range=1234::, ra-stateless, ra-names # Do router advertisements for all subnets where we're doing DHCPv6 -# Unless overridden by ra-stateless, ra-names, et al, the router +# Unless overridden by ra-stateless, ra-names, et al, the router # advertisements will have the M and O bits set, so that the clients -# get addresses and configuration from DHCPv6, and the A bit reset, so the +# get addresses and configuration from DHCPv6, and the A bit reset, so the # clients don't use SLAAC addresses. #enable-ra @@ -285,11 +285,11 @@ # any machine with Ethernet address starting 11:22:33: #dhcp-host=11:22:33:*:*:*,set:red -# Give a fixed IPv6 address and name to client with +# Give a fixed IPv6 address and name to client with # DUID 00:01:00:01:16:d2:83:fc:92:d4:19:e2:d8:b2 # Note the MAC addresses CANNOT be used to identify DHCPv6 clients. # Note also that the [] around the IPv6 address are obligatory. -#dhcp-host=id:00:01:00:01:16:d2:83:fc:92:d4:19:e2:d8:b2, fred, [1234::5] +#dhcp-host=id:00:01:00:01:16:d2:83:fc:92:d4:19:e2:d8:b2, fred, [1234::5] # Ignore any clients which are not specified in dhcp-host lines # or /etc/ethers. Equivalent to ISC "deny unknown-clients". @@ -345,7 +345,7 @@ # Send DHCPv6 option. Note [] around IPv6 addresses. #dhcp-option=option6:dns-server,[1234::77],[1234::88] -# Send DHCPv6 option for namservers as the machine running +# Send DHCPv6 option for namservers as the machine running # dnsmasq and another. #dhcp-option=option6:dns-server,[::],[1234::88] @@ -494,7 +494,6 @@ # to 5. See page 19 of # http://download.intel.com/design/archives/wfm/downloads/pxespec.pdf - # Enable dnsmasq's built-in TFTP server #enable-tftp @@ -550,7 +549,7 @@ # Set the DHCP server to enable DHCPv4 Rapid Commit Option per RFC 4039. # In this mode it will respond to a DHCPDISCOVER message including a Rapid Commit # option with a DHCPACK including a Rapid Commit option and fully committed address -# and configuration information. This must only be enabled if either the server is +# and configuration information. This must only be enabled if either the server is # the only server for the subnet, or multiple servers are present and they each # commit a binding for all clients. #dhcp-rapid-commit @@ -682,11 +681,18 @@ dhcp-mac=set:client_is_a_pi,B8:27:EB:*:*:* dhcp-reply-delay=tag:client_is_a_pi,2 - #AutoHotspot config interface=wlan0 -bind-dynamic +bind-dynamic server=1.1.1.1 domain-needed bogus-priv dhcp-range=192.168.4.100,192.168.4.200,12h + +#AutoEthernet config +interface=eth0 +bind-dynamic +server=1.1.1.1 +domain-needed +bogus-priv +dhcp-range=192.168.5.100,192.168.5.200,12h diff --git a/scripts/raspbian_configuration/etc/sysctl.conf b/scripts/raspbian_configuration/etc/sysctl.conf deleted file mode 100644 index b41f07b..0000000 --- a/scripts/raspbian_configuration/etc/sysctl.conf +++ /dev/null @@ -1,68 +0,0 @@ -# -# /etc/sysctl.conf - Configuration file for setting system variables -# See /etc/sysctl.d/ for additional system variables. -# See sysctl.conf (5) for information. -# - -#kernel.domainname = example.com - -# Uncomment the following to stop low-level messages on console -#kernel.printk = 3 4 1 3 - -##############################################################3 -# Functions previously found in netbase -# - -# Uncomment the next two lines to enable Spoof protection (reverse-path filter) -# Turn on Source Address Verification in all interfaces to -# prevent some spoofing attacks -#net.ipv4.conf.default.rp_filter=1 -#net.ipv4.conf.all.rp_filter=1 - -# Uncomment the next line to enable TCP/IP SYN cookies -# See http://lwn.net/Articles/277146/ -# Note: This may impact IPv6 TCP sessions too -#net.ipv4.tcp_syncookies=1 - -# Uncomment the next line to enable packet forwarding for IPv4 -net.ipv4.ip_forward=1 - -# Uncomment the next line to enable packet forwarding for IPv6 -# Enabling this option disables Stateless Address Autoconfiguration -# based on Router Advertisements for this host -#net.ipv6.conf.all.forwarding=1 - - -################################################################### -# Additional settings - these settings can improve the network -# security of the host and prevent against some network attacks -# including spoofing attacks and man in the middle attacks through -# redirection. Some network environments, however, require that these -# settings are disabled so review and enable them as needed. -# -# Do not accept ICMP redirects (prevent MITM attacks) -#net.ipv4.conf.all.accept_redirects = 0 -#net.ipv6.conf.all.accept_redirects = 0 -# _or_ -# Accept ICMP redirects only for gateways listed in our default -# gateway list (enabled by default) -# net.ipv4.conf.all.secure_redirects = 1 -# -# Do not send ICMP redirects (we are not a router) -#net.ipv4.conf.all.send_redirects = 0 -# -# Do not accept IP source route packets (we are not a router) -#net.ipv4.conf.all.accept_source_route = 0 -#net.ipv6.conf.all.accept_source_route = 0 -# -# Log Martian Packets -#net.ipv4.conf.all.log_martians = 1 -# - -################################################################### -# Magic system request Key -# 0=disable, 1=enable all, >1 bitmask of sysrq functions -# See https://www.kernel.org/doc/html/latest/admin-guide/sysrq.html -# for what other values do -#kernel.sysrq=438 - diff --git a/scripts/raspbian_configuration/usr/bin/autohotspotN b/scripts/raspbian_configuration/usr/bin/autohotspotN index 7be29d7..99c3b79 100755 --- a/scripts/raspbian_configuration/usr/bin/autohotspotN +++ b/scripts/raspbian_configuration/usr/bin/autohotspotN @@ -1,8 +1,12 @@ #!/bin/bash -#version 0.96-N/HS-I +#version 0.961-N/HS-I-PlanktonPlanet -#You may share this script on the condition a reference to RaspberryConnect.com -#must be included in copies or derivatives of this script. +#changes by PlanktonPlanet includes the following: +#- formatting and shellcheck validation +#- removal of ip forwarding setup + +#You may share this script on the condition a reference to RaspberryConnect.com +#must be included in copies or derivatives of this script. #Network Wifi & Hotspot with Internet #A script to switch between a wifi network and an Internet routed Hotspot @@ -12,174 +16,147 @@ #http://www.raspberryconnect.com wifidev="wlan0" #device name to use. Default is wlan0. -ethdev="eth0" #Ethernet port to use with IP tables -#use the command: iw dev ,to see wifi interface name - -IFSdef=$IFS -cnt=0 -#These four lines capture the wifi networks the RPi is setup to use -wpassid=$(awk '/ssid="/{ print $0 }' /etc/wpa_supplicant/wpa_supplicant.conf | awk -F'ssid=' '{ print $2 }' ORS=',' | sed 's/\"/''/g' | sed 's/,$//') -wpassid=$(echo "${wpassid//[$'\r\n']}") -IFS="," -ssids=($wpassid) -IFS=$IFSdef #reset back to defaults +ethdev="eth0" #Ethernet port to use with IP tables +#use the command: iw dev ,to see wifi interface name +#These two lines capture the wifi networks the RPi is setup to use +wpassid=$(awk '/ssid="/{ print $0 }' /etc/wpa_supplicant/wpa_supplicant.conf | awk -F'ssid=' '{ print $2 }' | sed 's/\r//g' | awk 'BEGIN{ORS=","} {print}' | sed 's/\"/''/g' | sed 's/,$//') +IFS="," read -r -a ssids <<<"$wpassid" #Note:If you only want to check for certain SSIDs #Remove the # in in front of ssids=('mySSID1'.... below and put a # infront of all four lines above # separated by a space, eg ('mySSID1' 'mySSID2') #ssids=('mySSID1' 'mySSID2' 'mySSID3') -#Enter the Routers Mac Addresses for hidden SSIDs, seperated by spaces ie -#( '11:22:33:44:55:66' 'aa:bb:cc:dd:ee:ff' ) +#Enter the Routers Mac Addresses for hidden SSIDs, seperated by spaces ie +#( '11:22:33:44:55:66' 'aa:bb:cc:dd:ee:ff' ) mac=() ssidsmac=("${ssids[@]}" "${mac[@]}") #combines ssid and MAC for checking -createAdHocNetwork() -{ - echo "Creating Hotspot" - ip link set dev "$wifidev" down - ip a add 192.168.4.1/24 brd + dev "$wifidev" - ip link set dev "$wifidev" up - dhcpcd -k "$wifidev" >/dev/null 2>&1 - iptables -t nat -A POSTROUTING -o "$ethdev" -j MASQUERADE - iptables -A FORWARD -i "$ethdev" -o "$wifidev" -m state --state RELATED,ESTABLISHED -j ACCEPT - iptables -A FORWARD -i "$wifidev" -o "$ethdev" -j ACCEPT - systemctl start dnsmasq - systemctl start hostapd - echo 1 > /proc/sys/net/ipv4/ip_forward +createAdHocNetwork() { + echo "Creating Hotspot" + ip link set dev "$wifidev" down + ip a add 192.168.4.1/24 brd + dev "$wifidev" + ip link set dev "$wifidev" up + dhcpcd -k "$wifidev" >/dev/null 2>&1 + systemctl start dnsmasq + systemctl start hostapd } -KillHotspot() -{ - echo "Shutting Down Hotspot" - ip link set dev "$wifidev" down - systemctl stop hostapd - systemctl stop dnsmasq - iptables -D FORWARD -i "$ethdev" -o "$wifidev" -m state --state RELATED,ESTABLISHED -j ACCEPT - iptables -D FORWARD -i "$wifidev" -o "$ethdev" -j ACCEPT - echo 0 > /proc/sys/net/ipv4/ip_forward - ip addr flush dev "$wifidev" - ip link set dev "$wifidev" up - dhcpcd -n "$wifidev" >/dev/null 2>&1 +KillHotspot() { + echo "Shutting Down Hotspot" + ip link set dev "$wifidev" down + systemctl stop hostapd + systemctl stop dnsmasq + ip addr flush dev "$wifidev" + ip link set dev "$wifidev" up + dhcpcd -n "$wifidev" >/dev/null 2>&1 } -ChkWifiUp() -{ - echo "Checking WiFi connection ok" - sleep 20 #give time for connection to be completed to router - if ! wpa_cli -i "$wifidev" status | grep 'ip_address' >/dev/null 2>&1 - then #Failed to connect to wifi (check your wifi settings, password etc) - echo 'Wifi failed to connect, falling back to Hotspot.' - wpa_cli terminate "$wifidev" >/dev/null 2>&1 - createAdHocNetwork - fi +ChkWifiUp() { + echo "Checking WiFi connection ok" + sleep 20 #give time for connection to be completed to router + if ! wpa_cli -i "$wifidev" status | grep 'ip_address' >/dev/null 2>&1; then #Failed to connect to wifi (check your wifi settings, password etc) + echo 'Wifi failed to connect, falling back to Hotspot.' + wpa_cli terminate "$wifidev" >/dev/null 2>&1 + createAdHocNetwork + fi } -chksys() -{ - #After some system updates hostapd gets masked using Raspbian Buster, and above. This checks and fixes - #the issue and also checks dnsmasq is ok so the hotspot can be generated. - #Check Hostapd is unmasked and disabled - if systemctl -all list-unit-files hostapd.service | grep "hostapd.service masked" >/dev/null 2>&1 ;then - systemctl unmask hostapd.service >/dev/null 2>&1 - fi - if systemctl -all list-unit-files hostapd.service | grep "hostapd.service enabled" >/dev/null 2>&1 ;then - systemctl disable hostapd.service >/dev/null 2>&1 - systemctl stop hostapd >/dev/null 2>&1 - fi - #Check dnsmasq is disabled - if systemctl -all list-unit-files dnsmasq.service | grep "dnsmasq.service masked" >/dev/null 2>&1 ;then - systemctl unmask dnsmasq >/dev/null 2>&1 - fi - if systemctl -all list-unit-files dnsmasq.service | grep "dnsmasq.service enabled" >/dev/null 2>&1 ;then - systemctl disable dnsmasq >/dev/null 2>&1 - systemctl stop dnsmasq >/dev/null 2>&1 - fi +chksys() { + #After some system updates hostapd gets masked using Raspbian Buster, and above. This checks and fixes + #the issue and also checks dnsmasq is ok so the hotspot can be generated. + #Check Hostapd is unmasked and disabled + if systemctl -all list-unit-files hostapd.service | grep "hostapd.service masked" >/dev/null 2>&1; then + systemctl unmask hostapd.service >/dev/null 2>&1 + fi + if systemctl -all list-unit-files hostapd.service | grep "hostapd.service enabled" >/dev/null 2>&1; then + systemctl disable hostapd.service >/dev/null 2>&1 + systemctl stop hostapd >/dev/null 2>&1 + fi + #Check dnsmasq is disabled + if systemctl -all list-unit-files dnsmasq.service | grep "dnsmasq.service masked" >/dev/null 2>&1; then + systemctl unmask dnsmasq >/dev/null 2>&1 + fi + if systemctl -all list-unit-files dnsmasq.service | grep "dnsmasq.service enabled" >/dev/null 2>&1; then + systemctl disable dnsmasq >/dev/null 2>&1 + systemctl stop dnsmasq >/dev/null 2>&1 + fi } +FindSSID() { + #Check to see what SSID's and MAC addresses are in range + ssidChk='NoSSid' + i=0 + j=0 + until [ $i -eq 1 ]; do #wait for wifi if busy, usb wifi is slower. + ssidreply=$( (iw dev "$wifidev" scan ap-force | grep -E "^BSS|SSID:") 2>&1) >/dev/null 2>&1 + #echo "SSid's in range: " $ssidreply + printf '%s\n' "${ssidreply[@]}" + echo "Device Available Check try " $j + if ((j >= 5)); then #if busy 5 times goto hotspot + echo "Device busy or unavailable 5 times, going to Hotspot" + ssidreply="" + i=1 + elif echo "$ssidreply" | grep "No such device (-19)" >/dev/null 2>&1; then + echo "No Device Reported, try " $j + NoDevice + elif echo "$ssidreply" | grep "Network is down (-100)" >/dev/null 2>&1; then + echo "Network Not available, trying again" $j + j=$((j + 1)) + sleep 2 + elif echo "$ssidreply" | grep "Read-only file system (-30)" >/dev/null 2>&1; then + echo "Temporary Read only file system, trying again" + j=$((j + 1)) + sleep 2 + elif echo "$ssidreply" | grep "Invalid exchange (-52)" >/dev/null 2>&1; then + echo "Temporary unavailable, trying again" + j=$((j + 1)) + sleep 2 + elif echo "$ssidreply" | grep -v "resource busy (-16)" >/dev/null 2>&1; then + echo "Device Available, checking SSid Results" + i=1 + else #see if device not busy in 2 seconds + echo "Device unavailable checking again, try " $j + j=$((j + 1)) + sleep 2 + fi + done -FindSSID() -{ -#Check to see what SSID's and MAC addresses are in range -ssidChk=('NoSSid') -i=0; j=0 -until [ $i -eq 1 ] #wait for wifi if busy, usb wifi is slower. -do - ssidreply=$((iw dev "$wifidev" scan ap-force | egrep "^BSS|SSID:") 2>&1) >/dev/null 2>&1 - #echo "SSid's in range: " $ssidreply - printf '%s\n' "${ssidreply[@]}" - echo "Device Available Check try " $j - if (($j >= 10)); then #if busy 10 times goto hotspot - echo "Device busy or unavailable 10 times, going to Hotspot" - ssidreply="" - i=1 - elif echo "$ssidreply" | grep "No such device (-19)" >/dev/null 2>&1; then - echo "No Device Reported, try " $j - NoDevice - elif echo "$ssidreply" | grep "Network is down (-100)" >/dev/null 2>&1 ; then - echo "Network Not available, trying again" $j - j=$((j + 1)) - sleep 2 - elif echo "$ssidreply" | grep "Read-only file system (-30)" >/dev/null 2>&1 ; then - echo "Temporary Read only file system, trying again" - j=$((j + 1)) - sleep 2 - elif echo "$ssidreply" | grep "Invalid exchange (-52)" >/dev/null 2>&1 ; then - echo "Temporary unavailable, trying again" - j=$((j + 1)) - sleep 2 - elif echo "$ssidreply" | grep -v "resource busy (-16)" >/dev/null 2>&1 ; then - echo "Device Available, checking SSid Results" - i=1 - else #see if device not busy in 2 seconds - echo "Device unavailable checking again, try " $j - j=$((j + 1)) - sleep 2 - fi -done - -for ssid in "${ssidsmac[@]}" -do - if (echo "$ssidreply" | grep "$ssid") >/dev/null 2>&1 - then - #Valid SSid found, passing to script - echo "Valid SSID Detected, assesing Wifi status" - ssidChk=$ssid - return 0 - else - #No Network found, NoSSid issued" - echo "No SSid found, assessing WiFi status" - ssidChk='NoSSid' - fi -done + for ssid in "${ssidsmac[@]}"; do + if (echo "$ssidreply" | grep -F -- "$ssid") >/dev/null 2>&1; then + #Valid SSid found, passing to script + echo "Valid SSID Detected, assesing Wifi status" + ssidChk=$ssid + return 0 + else + #No Network found, NoSSid issued" + echo "No SSid found, assessing WiFi status" + ssidChk='NoSSid' + fi + done } -NoDevice() -{ - #if no wifi device,ie usb wifi removed, activate wifi so when it is - #reconnected wifi to a router will be available - echo "No wifi device connected" - wpa_supplicant -B -i "$wifidev" -c /etc/wpa_supplicant/wpa_supplicant.conf >/dev/null 2>&1 - exit 1 +NoDevice() { + #if no wifi device,ie usb wifi removed, activate wifi so when it is + #reconnected wifi to a router will be available + echo "No wifi device connected" + wpa_supplicant -B -i "$wifidev" -c /etc/wpa_supplicant/wpa_supplicant.conf >/dev/null 2>&1 + exit 1 } chksys FindSSID #Create Hotspot or connect to valid wifi networks -if [ "$ssidChk" != "NoSSid" ] -then - echo 0 > /proc/sys/net/ipv4/ip_forward #deactivate ip forwarding - if systemctl status hostapd | grep "(running)" >/dev/null 2>&1 - then #hotspot running and ssid in range +if [ "$ssidChk" != "NoSSid" ]; then + if systemctl status hostapd | grep "(running)" >/dev/null 2>&1; then #hotspot running and ssid in range KillHotspot echo "Hotspot Deactivated, Bringing Wifi Up" wpa_supplicant -B -i "$wifidev" -c /etc/wpa_supplicant/wpa_supplicant.conf >/dev/null 2>&1 ChkWifiUp - elif { wpa_cli -i "$wifidev" status | grep 'ip_address'; } >/dev/null 2>&1 - then #Already connected + elif { wpa_cli -i "$wifidev" status | grep 'ip_address'; } >/dev/null 2>&1; then #Already connected echo "Wifi already connected to a network" else #ssid exists and no hotspot running connect to wifi network echo "Connecting to the WiFi Network" @@ -187,19 +164,18 @@ then ChkWifiUp fi else #ssid or MAC address not in range - if systemctl status hostapd | grep "(running)" >/dev/null 2>&1 - then + if systemctl status hostapd | grep "(running)" >/dev/null 2>&1; then echo "Hostspot already active" - elif { wpa_cli status | grep "$wifidev"; } >/dev/null 2>&1 - then + elif { wpa_cli status | grep "$wifidev"; } >/dev/null 2>&1; then echo "Cleaning wifi files and Activating Hotspot" wpa_cli terminate >/dev/null 2>&1 ip addr flush "$wifidev" ip link set dev "$wifidev" down + # ip addr flush "$ethdev" + # ip link set dev "$ethdev" down rm -r /var/run/wpa_supplicant >/dev/null 2>&1 createAdHocNetwork else #"No SSID, activating Hotspot" createAdHocNetwork fi fi -