hotspot_ynh/scripts/install

#!/bin/bash

# Wifi Hotspot app for YunoHost
# Copyright (C) 2015 Julien Vaubourg <julien@vaubourg.com>
# 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 <http://www.gnu.org/licenses/>.

#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================

source _common.sh
source /usr/share/yunohost/helpers

#=================================================
# MANAGE SCRIPT FAILURE
#=================================================

# Exit if an error occurs during the execution of the script
ynh_abort_if_errors

#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================

# Retrieve arguments
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_print_info "Validating installation parameters..."

# Check destination directory
final_path="/var/www/$app"
test ! -e "$final_path" || ynh_die "This path already contains a folder"

# Normalize the url path syntax
path_url=$(ynh_normalize_url_path $path_url)

# Register (book) web path
ynh_webpath_register $app $domain $path_url

# Check arguments
if [[ -z $wifi_ssid || -z $wifi_passphrase ]]; then
  ynh_die "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 "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 "Only printable ASCII characters are permitted in your password (WPA2 passphrase)"
fi

#=================================================
# RUN PREREQUISITES
#=================================================

source ./prerequisites

#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
ynh_print_info "Storing installation settings..."

ynh_app_setting_set "$app" domain "$domain"
ynh_app_setting_set "$app" final_path "$final_path"
ynh_app_setting_set "$app" wifi_ssid "$wifi_ssid"
ynh_app_setting_set "$app" wifi_passphrase "$wifi_passphrase"
ynh_app_setting_set "$app" firmware_nonfree "$firmware_nonfree"

#=================================================
# STANDARD MODIFICATIONS
#=================================================
# FIND AND OPEN A PORT
#=================================================
ynh_print_info "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
#=================================================

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 if non-free is set on sources.list
  if ! grep -q non-free /etc/apt/sources.list ; then
    sed '/debian/{s/main/& non-free/}' -i /etc/apt/sources.list
  fi

  packages=$nonfree_packages
else
  packages=$free_packages

  # Extract from http://packages.trisquel.info/toutatis-updates/open-ath9k-htc-firmware
  # https://www.fsf.org/news/ryf-certification-thinkpenguin-usb-with-atheros-chip
  # https://wiki.debian.org/ath9k_htc/open_firmware
  mkdir -p /lib/firmware
  install -b -o root -g root -m 0644 ../conf/firmware_htc-7010.fw /lib/firmware/htc_7010.fw
  install -b -o root -g root -m 0644 ../conf/firmware_htc-9271.fw /lib/firmware/htc_9271.fw
fi

ynh_package_update

#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_print_info "Installing dependencies..."

ynh_install_app_dependencies "$pkg_dependencies" "$packages"

#=================================================
# NGINX CONFIGURATION
#=================================================
ynh_print_info "Configuring nginx web server..."

# Create a dedicated nginx config
ynh_add_nginx_config

#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_print_info "Configuring system user..."

# Create a system user
ynh_system_user_create $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 "__HOTSPOT_SYSUSER__" "${app}" /etc/sudoers.d/${app}_ynh

#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_print_info "Configuring php-fpm..."

# Create a dedicated php-fpm config
ynh_add_fpm_config

#=================================================
# INSTALL CUSTOM SCRIPTS
#=================================================

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

wifi_device=$(bash ../conf/iw_devices | awk -F\| '{ print $1 }')

ynh_app_setting_set $app multissid 1
ynh_app_setting_set $app wifi_ssid "${wifi_ssid}"
ynh_app_setting_set $app wifi_secure 1
ynh_app_setting_set $app wifi_passphrase "${wifi_passphrase}"
ynh_app_setting_set $app wifi_device "${wifi_device}"
ynh_app_setting_set $app wifi_channel 6
ynh_app_setting_set $app ip6_addr "${ip6_addr}"
ynh_app_setting_set $app ip6_firewall 1
ynh_app_setting_set $app ip6_net "${ip6_net}"
ynh_app_setting_set $app ip6_dns0 2001:913::8
ynh_app_setting_set $app ip6_dns1 2001:910:800::12
ynh_app_setting_set $app ip4_dns0 80.67.188.188
ynh_app_setting_set $app ip4_dns1 80.67.169.12
ynh_app_setting_set $app ip4_nat_prefix 10.0.242
ynh_app_setting_set $app vpnclient no
ynh_app_setting_set $app service_name $service_name

if [[ -z $wifi_device ]]; then
  ynh_app_setting_set $app service_enabled 0
  wifi_device=none
else
  ynh_app_setting_set $app service_enabled 1
fi

#=================================================
# COPY CONFIGS
#=================================================

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/

#=================================================
# COPY WEB SOURCES
#=================================================

mkdir -pm 0755 ${final_path}/
cp -a ../sources/* ${final_path}/

chown -R www-data: ${final_path}/
chmod -R 0644 ${final_path}/*
find ${final_path}/ -type d -exec chmod +x {} \;

#=================================================
# FIX CONFIGS
#=================================================

## hostapd
ynh_replace_string "^DAEMON_CONF=$" "&/etc/hostapd/hostapd.conf" /etc/init.d/hostapd

# Fix sources
ynh_replace_string "__PATH__" "${path_url}" "$final_path/config.php"

#=================================================
# STORE THE CONFIG FILE CHECKSUM
#=================================================

# Calculate and store the config file checksum into the app settings
ynh_store_file_checksum "$final_path/config.php"
ynh_store_file_checksum "/etc/init.d/hostapd"

#=================================================
# SETUP SYSTEMD
#=================================================
ynh_print_info "Configuring a systemd service..."

# Create a dedicated systemd config
ynh_add_systemd_config $service_name

# 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
systemctl stop hostapd

#=================================================
# RELOAD NGINX AND PHP-FPM
#=================================================
ynh_print_info "Reloading nginx web server..."

systemctl reload nginx

# Remove IPv6 address set if there is a VPN installed
if [[ $ip6_addr != none ]]; then
  ip -6 address show dev tun0 2> /dev/null | grep -q "${ip6_addr}/"
  if [[ "$?" -eq 0 ]]; then
    ip address delete "${ip6_addr}/128" dev tun0 &> /dev/null
  fi
fi

# register the service
yunohost service add $service_name --description "Creates a Wi-Fi access point"

# enable and start the 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
  systemctl enable $service_name
  systemctl start $service_name
fi

#=================================================
# END OF SCRIPT
#=================================================

ynh_print_info "Installation of $app completed"