#!/bin/bash # Wifi Hotspot app for YunoHost # Copyright (C) 2015 Julien Vaubourg # Contribute at https://github.com/labriqueinternet/hotspot_ynh # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # 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 Affero General Public License for more details. # # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . #================================================= # GENERIC START #================================================= # IMPORT GENERIC HELPERS #================================================= source _common.sh source /usr/share/yunohost/helpers #================================================= # MANAGE SCRIPT FAILURE #================================================= ynh_clean_setup () { ynh_clean_check_starting } # Exit if an error occurs during the execution of the script ynh_abort_if_errors #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= domain=$YNH_APP_ARG_DOMAIN path_url=$YNH_APP_ARG_PATH wifi_ssid=$YNH_APP_ARG_WIFI_SSID wifi_passphrase=$YNH_APP_ARG_WIFI_PASSPHRASE firmware_nonfree=$YNH_APP_ARG_FIRMWARE_NONFREE app=$YNH_APP_INSTANCE_NAME # the service name must match the service template files service_name='ynh-hotspot' #================================================= # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS #================================================= ynh_script_progression --message="Validating installation parameters..." final_path=/var/www/$app test ! -e "$final_path" || ynh_die --message="This path already contains a folder" # Register (book) web path ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url if [ $firmware_nonfree = "no" ]; then firmware_nonfree=0 elif [ $firmware_nonfree = "yes" ]; then firmware_nonfree=1 fi # Check arguments if [[ -z $wifi_ssid || -z $wifi_passphrase ]]; then ynh_die --message="Your Wifi Hotspot needs a name and a password" fi # Check passphrase length wifi_passphrase_length="$(echo -n "${wifi_passphrase}" | wc -c)" if [[ $wifi_passphrase_length -lt 8 || $wifi_passphrase_length -gt 63 ]]; then ynh_die --message="Your password must from 8 to 63 characters (WPA2 passphrase)" fi # Check no special characters are present in the passphrase if [[ $wifi_passphrase =~ [^[:print:]] ]]; then ynh_die --message="Only printable ASCII characters are permitted in your password (WPA2 passphrase)" fi #================================================= # STORE SETTINGS FROM MANIFEST #================================================= ynh_script_progression --message="Storing installation settings..." ynh_app_setting_set --app=$app --key=domain --value=$domain ynh_app_setting_set --app=$app --key=wifi_ssid --value="$wifi_ssid" ynh_app_setting_set --app=$app --key=wifi_passphrase --value="$wifi_passphrase" ynh_app_setting_set --app=$app --key=firmware_nonfree --value="$firmware_nonfree" ynh_app_setting_set --app=$app --key=service_name --value=$service_name #================================================= # STANDARD MODIFICATIONS #================================================= # FIND AND OPEN A PORT #================================================= ynh_script_progression --message="Configuring firewall..." # Update firewall for DHCP ynh_exec_warn_less yunohost firewall allow --no-upnp --ipv6 UDP 547 ynh_exec_warn_less yunohost firewall allow --no-upnp UDP 67 #================================================= # INSTALL NONFREE FIRWARE IF REQUESTED #================================================= ynh_script_progression --message="Installing firmware..." export DEBIAN_FRONTEND=noninteractive # Packaged USB Wireless Device firmwares # Based on https://wiki.debian.org/WiFi#USB_Devices if [[ $firmware_nonfree -eq 1 ]]; then check_armbian_nonfree_conflict ynh_install_extra_app_dependencies --repo="deb http://deb.debian.org/debian $(ynh_get_debian_release) non-free" --package="$nonfree_firmware_packages" else pkg_dependencies="$pkg_dependencies $free_firmware_packages" fi #================================================= # INSTALL DEPENDENCIES #================================================= ynh_script_progression --message="Installing dependencies..." ynh_install_app_dependencies $pkg_dependencies #================================================= # CREATE DEDICATED USER #================================================= ynh_script_progression --message="Configuring system user..." # Create a system user ynh_system_user_create --username=$app # Ensure the system user has enough sudo permissions install -b -o root -g root -m 0440 ../conf/sudoers.conf /etc/sudoers.d/${app}_ynh ynh_replace_string --match_string="__HOTSPOT_SYSUSER__" --replace_string="${app}" --target_file="/etc/sudoers.d/${app}_ynh" #================================================= # INSTALL CUSTOM SCRIPTS #================================================= ynh_script_progression --message="Installing custom script..." install -o root -g root -m 0755 ../conf/iw_multissid /usr/local/bin/ install -o root -g root -m 0755 ../conf/iw_devices /usr/local/bin/ install -o root -g root -m 0755 ../conf/iw_ssids /usr/local/bin/ install -o root -g root -m 0755 ../conf/ipv6_expanded /usr/local/bin/ install -o root -g root -m 0755 ../conf/ipv6_compressed /usr/local/bin/ if [[ ! -v ip6_net ]]; then # if ip6_net not set ip6_net=none ip6_addr=none if [[ -e /tmp/.ynh-vpnclient-started ]]; then vpnclient_ip6_net=$(ynh_app_setting_get vpnclient ip6_net 2>&1) vpnclient_ip6_addr=$(ynh_app_setting_get vpnclient ip6_addr 2>&1) if [[ $vpnclient_ip6_net =~ :: && $vpnclient_ip6_addr =~ :: ]]; then ip6_net=${vpnclient_ip6_net} ip6_addr=${vpnclient_ip6_addr} fi fi fi hot_reload_usb_wifi_cards wifi_device=$(bash ../conf/iw_devices | awk -F\| '{ print $1 }') ynh_app_setting_set --app=$app --key=multissid --value=1 ynh_app_setting_set --app=$app --key=wifi_ssid --value="${wifi_ssid}" ynh_app_setting_set --app=$app --key=wifi_secure --value=1 ynh_app_setting_set --app=$app --key=wifi_passphrase --value="${wifi_passphrase}" ynh_app_setting_set --app=$app --key=wifi_device --value="${wifi_device}" ynh_app_setting_set --app=$app --key=wifi_channel --value=6 ynh_app_setting_set --app=$app --key=ip6_addr --value="${ip6_addr}" ynh_app_setting_set --app=$app --key=ip6_firewall --value=1 ynh_app_setting_set --app=$app --key=ip6_net --value="${ip6_net}" ynh_app_setting_set --app=$app --key=ip6_dns0 --value=2001:913::8 ynh_app_setting_set --app=$app --key=ip6_dns1 --value=2001:910:800::12 ynh_app_setting_set --app=$app --key=ip4_dns0 --value=80.67.188.188 ynh_app_setting_set --app=$app --key=ip4_dns1 --value=80.67.169.12 ynh_app_setting_set --app=$app --key=ip4_nat_prefix --value=10.0.242 ynh_app_setting_set --app=$app --key=vpnclient --value=no if [[ -z $wifi_device ]]; then ynh_app_setting_set --app=$app --key=service_enabled --value=0 wifi_device=none else ynh_app_setting_set --app=$app --key=service_enabled --value=1 fi #================================================= # COPY CONFIGS #================================================= ynh_script_progression --message="Copying configuration..." mkdir -pm 0755 /etc/dnsmasq.dhcpd/ chown root: /etc/dnsmasq.dhcpd/ install -b -o root -g root -m 0644 ../conf/hostapd.conf.tpl? /etc/hostapd/ install -b -o root -g root -m 0644 ../conf/dnsmasq_dhcpdv6.conf.tpl /etc/dnsmasq.dhcpd/dhcpdv6.conf.tpl install -b -o root -g root -m 0644 ../conf/dnsmasq_dhcpdv4.conf.tpl /etc/dnsmasq.dhcpd/dhcpdv4.conf.tpl # Copy init script install -o root -g root -m 0755 ../conf/$service_name /usr/local/bin/ ynh_replace_string --match_string="__PHPVERSION__" --replace_string="${YNH_PHP_VERSION}" --target_file="/usr/local/bin/$service_name" #================================================= # COPY WEB SOURCES #================================================= ynh_script_progression --message="Setting up source files..." ynh_app_setting_set --app=$app --key=final_path --value=$final_path mkdir -pm 0755 $final_path cp -a ../sources/* ${final_path}/ chmod -R 0644 ${final_path}/* chmod 750 "$final_path" chmod -R o-rwx "$final_path" chown -R $app:$app "$final_path" #================================================= # NGINX CONFIGURATION #================================================= ynh_script_progression --message="Configuring NGINX web server..." # Create a dedicated NGINX config ynh_add_nginx_config #================================================= # PHP-FPM CONFIGURATION #================================================= ynh_script_progression --message="Configuring PHP-FPM..." # Create a dedicated PHP-FPM config ynh_add_fpm_config #================================================= # CONFIGURE HOSTAPD #================================================= ynh_script_progression --message="Configuring hostapd..." ## hostapd ynh_replace_string --match_string="^DAEMON_CONF=$" --replace_string="&/etc/hostapd/hostapd.conf" --target_file=/etc/init.d/hostapd # We also need to put this in /etc/default/hostapd because on some setup # like RPi, the version of hostapd is different and /etc/init.d/hostapd # isnt used ... instead the service is "pure systemd" ... echo "DAEMON_CONF=/etc/hostapd/hostapd.conf" > /etc/default/hostapd # Apply configuration ynh_add_config --template="config.php.tpl" --destination="$final_path/config.php" chown $app:$app "$final_path/config.php" # Set default inits # The boot order of these services are important, so they are disabled by default # and the ynh-hotspot service handles them. systemctl disable hostapd --quiet systemctl stop hostapd systemctl unmask hostapd # On some system e.g. RPi, for some reason hostapd is masked after install ... #================================================= # STORE THE CONFIG FILE CHECKSUM #================================================= ynh_script_progression --message="Storing the config file checksum..." # Calculate and store the config file checksum into the app settings ynh_store_file_checksum --file="/etc/init.d/hostapd" #================================================= # SETUP SYSTEMD #================================================= ynh_script_progression --message="Configuring a systemd service..." # Create a dedicated systemd config ynh_add_systemd_config --service=$service_name # Remove IPv6 address set if there is a VPN installed if [[ $ip6_addr != none ]]; then if ip -6 address show dev tun0 2> /dev/null | grep -q "${ip6_addr}/"; then ip address delete "${ip6_addr}/128" dev tun0 &> /dev/null fi fi #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= ynh_script_progression --message="Integrating service in YunoHost..." yunohost service add $service_name --description "Creates a Wi-Fi access point" --test_status "systemctl is-active hostapd" --needs_exposed_ports 67 547 #================================================= # START SYSTEMD SERVICE #================================================= ynh_script_progression --message="Starting a systemd service..." # Start a systemd service if device is present if [[ $wifi_device == none ]]; then echo "WARNING: Wifi Hotspot is not started because no wifi device was found (please, check the web admin)" >&2 else ynh_systemd_action --service_name=$service_name --action="start" --log_path=systemd #--line_match="Started YunoHost Wifi Hotspot" fi #================================================= # END OF SCRIPT #================================================= ynh_script_progression --message="Installation of $app completed"