install 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  1. #!/bin/bash
  2. # Wifi Hotspot app for YunoHost
  3. # Copyright (C) 2015 Julien Vaubourg <julien@vaubourg.com>
  4. # Contribute at https://github.com/labriqueinternet/hotspot_ynh
  5. #
  6. # This program is free software: you can redistribute it and/or modify
  7. # it under the terms of the GNU Affero General Public License as published by
  8. # the Free Software Foundation, either version 3 of the License, or
  9. # (at your option) any later version.
  10. #
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. # GNU Affero General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU Affero General Public License
  17. # along with this program. If not, see <http://www.gnu.org/licenses/>.
  18. #=================================================
  19. # GENERIC START
  20. #=================================================
  21. # IMPORT GENERIC HELPERS
  22. #=================================================
  23. source _common.sh
  24. source /usr/share/yunohost/helpers
  25. #=================================================
  26. # MANAGE SCRIPT FAILURE
  27. #=================================================
  28. # Exit if an error occurs during the execution of the script
  29. ynh_abort_if_errors
  30. #=================================================
  31. # RETRIEVE ARGUMENTS FROM THE MANIFEST
  32. #=================================================
  33. # Retrieve arguments
  34. domain=$YNH_APP_ARG_DOMAIN
  35. path_url=$YNH_APP_ARG_PATH
  36. wifi_ssid=$YNH_APP_ARG_WIFI_SSID
  37. wifi_passphrase=$YNH_APP_ARG_WIFI_PASSPHRASE
  38. firmware_nonfree=$YNH_APP_ARG_FIRMWARE_NONFREE
  39. app=$YNH_APP_INSTANCE_NAME
  40. # the service name must match the service template files
  41. service_name='ynh-hotspot'
  42. #=================================================
  43. # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
  44. #=================================================
  45. ynh_print_info "Validating installation parameters..."
  46. # Check destination directory
  47. final_path="/var/www/$app"
  48. test ! -e "$final_path" || ynh_die "This path already contains a folder"
  49. # Normalize the url path syntax
  50. path_url=$(ynh_normalize_url_path $path_url)
  51. # Register (book) web path
  52. ynh_webpath_register $app $domain $path_url
  53. # Check arguments
  54. if [[ -z $wifi_ssid || -z $wifi_passphrase ]]; then
  55. ynh_die "Your Wifi Hotspot needs a name and a password"
  56. fi
  57. # Check passphrase length
  58. wifi_passphrase_length="$(echo -n "${wifi_passphrase}" | wc -c)"
  59. if [[ $wifi_passphrase_length -lt 8 || $wifi_passphrase_length -gt 63 ]]; then
  60. ynh_die "Your password must from 8 to 63 characters (WPA2 passphrase)"
  61. fi
  62. # Check no special characters are present in the passphrase
  63. if [[ $wifi_passphrase =~ [^[:print:]] ]]; then
  64. ynh_die "Only printable ASCII characters are permitted in your password (WPA2 passphrase)"
  65. fi
  66. #=================================================
  67. # RUN PREREQUISITES
  68. #=================================================
  69. source ./prerequisites
  70. #=================================================
  71. # STORE SETTINGS FROM MANIFEST
  72. #=================================================
  73. ynh_print_info "Storing installation settings..."
  74. ynh_app_setting_set "$app" domain "$domain"
  75. ynh_app_setting_set "$app" final_path "$final_path"
  76. ynh_app_setting_set "$app" wifi_ssid "$wifi_ssid"
  77. ynh_app_setting_set "$app" wifi_passphrase "$wifi_passphrase"
  78. ynh_app_setting_set "$app" firmware_nonfree "$firmware_nonfree"
  79. #=================================================
  80. # STANDARD MODIFICATIONS
  81. #=================================================
  82. # FIND AND OPEN A PORT
  83. #=================================================
  84. ynh_print_info "Configuring firewall..."
  85. # Update firewall for DHCP
  86. ynh_exec_warn_less yunohost firewall allow --no-upnp --ipv6 UDP 547
  87. ynh_exec_warn_less yunohost firewall allow --no-upnp UDP 67
  88. #=================================================
  89. # INSTALL NONFREE FIRWARE IF REQUESTED
  90. #=================================================
  91. export DEBIAN_FRONTEND=noninteractive
  92. # Packaged USB Wireless Device firmwares
  93. # Based on https://wiki.debian.org/WiFi#USB_Devices
  94. if [[ $firmware_nonfree -eq 1 ]]; then
  95. # check if non-free is set on sources.list
  96. if ! grep -q non-free /etc/apt/sources.list ; then
  97. sed '/debian/{s/main/& non-free/}' -i /etc/apt/sources.list
  98. fi
  99. packages=$nonfree_packages
  100. else
  101. packages=$free_packages
  102. # Extract from http://packages.trisquel.info/toutatis-updates/open-ath9k-htc-firmware
  103. # https://www.fsf.org/news/ryf-certification-thinkpenguin-usb-with-atheros-chip
  104. # https://wiki.debian.org/ath9k_htc/open_firmware
  105. mkdir -p /lib/firmware
  106. install -b -o root -g root -m 0644 ../conf/firmware_htc-7010.fw /lib/firmware/htc_7010.fw
  107. install -b -o root -g root -m 0644 ../conf/firmware_htc-9271.fw /lib/firmware/htc_9271.fw
  108. fi
  109. ynh_package_update
  110. #=================================================
  111. # INSTALL DEPENDENCIES
  112. #=================================================
  113. ynh_print_info "Installing dependencies..."
  114. ynh_install_app_dependencies "$pkg_dependencies" "$packages"
  115. #=================================================
  116. # NGINX CONFIGURATION
  117. #=================================================
  118. ynh_print_info "Configuring nginx web server..."
  119. # Create a dedicated nginx config
  120. ynh_add_nginx_config
  121. #=================================================
  122. # CREATE DEDICATED USER
  123. #=================================================
  124. ynh_print_info "Configuring system user..."
  125. # Create a system user
  126. ynh_system_user_create $app
  127. # Ensure the system user has enough sudo permissions
  128. install -b -o root -g root -m 0440 ../conf/sudoers.conf /etc/sudoers.d/${app}_ynh
  129. ynh_replace_string "__HOTSPOT_SYSUSER__" "${app}" /etc/sudoers.d/${app}_ynh
  130. #=================================================
  131. # PHP-FPM CONFIGURATION
  132. #=================================================
  133. ynh_print_info "Configuring php-fpm..."
  134. # Create a dedicated php-fpm config
  135. ynh_add_fpm_config
  136. #=================================================
  137. # INSTALL CUSTOM SCRIPTS
  138. #=================================================
  139. install -o root -g root -m 0755 ../conf/iw_multissid /usr/local/bin/
  140. install -o root -g root -m 0755 ../conf/iw_devices /usr/local/bin/
  141. install -o root -g root -m 0755 ../conf/iw_ssids /usr/local/bin/
  142. install -o root -g root -m 0755 ../conf/ipv6_expanded /usr/local/bin/
  143. install -o root -g root -m 0755 ../conf/ipv6_compressed /usr/local/bin/
  144. if [[ ! -v ip6_net ]]; then # if ip6_net not set
  145. ip6_net=none
  146. ip6_addr=none
  147. if [[ -e /tmp/.ynh-vpnclient-started ]]; then
  148. vpnclient_ip6_net=$(ynh_app_setting_get vpnclient ip6_net 2>&1)
  149. vpnclient_ip6_addr=$(ynh_app_setting_get vpnclient ip6_addr 2>&1)
  150. if [[ $vpnclient_ip6_net =~ :: && $vpnclient_ip6_addr =~ :: ]]; then
  151. ip6_net=${vpnclient_ip6_net}
  152. ip6_addr=${vpnclient_ip6_addr}
  153. fi
  154. fi
  155. fi
  156. wifi_device=$(bash ../conf/iw_devices | awk -F\| '{ print $1 }')
  157. ynh_app_setting_set $app multissid 1
  158. ynh_app_setting_set $app wifi_ssid "${wifi_ssid}"
  159. ynh_app_setting_set $app wifi_secure 1
  160. ynh_app_setting_set $app wifi_passphrase "${wifi_passphrase}"
  161. ynh_app_setting_set $app wifi_device "${wifi_device}"
  162. ynh_app_setting_set $app wifi_channel 6
  163. ynh_app_setting_set $app ip6_addr "${ip6_addr}"
  164. ynh_app_setting_set $app ip6_firewall 1
  165. ynh_app_setting_set $app ip6_net "${ip6_net}"
  166. ynh_app_setting_set $app ip6_dns0 2001:913::8
  167. ynh_app_setting_set $app ip6_dns1 2001:910:800::12
  168. ynh_app_setting_set $app ip4_dns0 80.67.188.188
  169. ynh_app_setting_set $app ip4_dns1 80.67.169.12
  170. ynh_app_setting_set $app ip4_nat_prefix 10.0.242
  171. ynh_app_setting_set $app vpnclient no
  172. ynh_app_setting_set $app service_name $service_name
  173. if [[ -z $wifi_device ]]; then
  174. ynh_app_setting_set $app service_enabled 0
  175. wifi_device=none
  176. else
  177. ynh_app_setting_set $app service_enabled 1
  178. fi
  179. #=================================================
  180. # COPY CONFIGS
  181. #=================================================
  182. mkdir -pm 0755 /etc/dnsmasq.dhcpd/
  183. chown root: /etc/dnsmasq.dhcpd/
  184. install -b -o root -g root -m 0644 ../conf/hostapd.conf.tpl? /etc/hostapd/
  185. install -b -o root -g root -m 0644 ../conf/dnsmasq_dhcpdv6.conf.tpl /etc/dnsmasq.dhcpd/dhcpdv6.conf.tpl
  186. install -b -o root -g root -m 0644 ../conf/dnsmasq_dhcpdv4.conf.tpl /etc/dnsmasq.dhcpd/dhcpdv4.conf.tpl
  187. # Copy init script
  188. install -o root -g root -m 0755 ../conf/$service_name /usr/local/bin/
  189. #=================================================
  190. # COPY WEB SOURCES
  191. #=================================================
  192. mkdir -pm 0755 ${final_path}/
  193. cp -a ../sources/* ${final_path}/
  194. chown -R root: ${final_path}/
  195. chmod -R 0644 ${final_path}/*
  196. find ${final_path}/ -type d -exec chmod +x {} \;
  197. #=================================================
  198. # FIX CONFIGS
  199. #=================================================
  200. ## hostapd
  201. ynh_replace_string "^DAEMON_CONF=$" "&/etc/hostapd/hostapd.conf" /etc/init.d/hostapd
  202. # Fix sources
  203. ynh_replace_string "__PATH__" "${path_url}" "$final_path/config.php"
  204. #=================================================
  205. # SETUP SYSTEMD
  206. #=================================================
  207. ynh_print_info "Configuring a systemd service..."
  208. # Create a dedicated systemd config
  209. ynh_add_systemd_config $service_name
  210. # Set default inits
  211. # The boot order of these services are important, so they are disabled by default
  212. # and the ynh-hotspot service handles them.
  213. systemctl disable hostapd
  214. systemctl stop hostapd
  215. #=================================================
  216. # RELOAD NGINX AND PHP-FPM
  217. #=================================================
  218. ynh_print_info "Reloading nginx web server..."
  219. systemctl reload nginx
  220. # Remove IPv6 address set if there is a VPN installed
  221. if [[ $ip6_addr != none ]]; then
  222. ip -6 address show dev tun0 2> /dev/null | grep -q "${ip6_addr}/"
  223. if [[ "$?" -eq 0 ]]; then
  224. ip address delete "${ip6_addr}/128" dev tun0 &> /dev/null
  225. fi
  226. fi
  227. # register the service
  228. yunohost service add $service_name --description "creates a Wi-Fi access point"
  229. # enable and start the service if device is present
  230. if [[ $wifi_device == none ]]; then
  231. echo "WARNING: Wifi Hotspot is not started because no wifi device was found (please, check the web admin)" >&2
  232. else
  233. systemctl enable $service_name
  234. systemctl start $service_name
  235. fi
  236. #=================================================
  237. # END OF SCRIPT
  238. #=================================================
  239. ynh_print_info "Installation of $app completed"