From 930536f4d27af79c73e09d3054793077c37f1577 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Josu=C3=A9=20Tille?= Date: Thu, 16 Feb 2017 22:54:57 +0100 Subject: [PATCH] Clean common script and update turnserver config --- conf/default_coturn | 5 ++ conf/homeserver.yaml | 2 +- conf/turnserver.conf | 2 +- scripts/_common.sh | 141 ++----------------------------------------- scripts/backup | 1 + scripts/install | 12 ++-- scripts/restore | 85 +++++++++++++++++++++++--- scripts/upgrade | 4 +- 8 files changed, 96 insertions(+), 156 deletions(-) create mode 100644 conf/default_coturn diff --git a/conf/default_coturn b/conf/default_coturn new file mode 100644 index 0000000..fc87269 --- /dev/null +++ b/conf/default_coturn @@ -0,0 +1,5 @@ +# +# Uncomment it if you want to have the turnserver running as +# an automatic system service daemon +# +TURNSERVER_ENABLED=1 diff --git a/conf/homeserver.yaml b/conf/homeserver.yaml index 3f3ec0b..9f03860 100644 --- a/conf/homeserver.yaml +++ b/conf/homeserver.yaml @@ -288,7 +288,7 @@ turn_uris: [ "turn:__DOMAIN__:__TURNSERVER_TLS_PORT__?transport=udp", "turn:__DO turn_shared_secret: "__TURNPWD__" # How long generated TURN credentials last -turn_user_lifetime: "1h" +turn_user_lifetime: "86400000" ## Registration ## diff --git a/conf/turnserver.conf b/conf/turnserver.conf index b82377d..a8506fe 100644 --- a/conf/turnserver.conf +++ b/conf/turnserver.conf @@ -2,8 +2,8 @@ lt-cred-mech use-auth-secret static-auth-secret=__TURNPWD__ realm=__DOMAIN__ +no-stun -listening-port=__PORT__ tls-listening-port=__TLS_PORT__ cert=/etc/yunohost/certs/__DOMAIN__/crt.pem diff --git a/scripts/_common.sh b/scripts/_common.sh index deb11df..46f7cda 100755 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -31,15 +31,16 @@ init_script() { install_arm_package_dep() { wget -q -O '/tmp/python-nacl.deb' "http://ftp.ch.debian.org/debian/pool/main/p/python-nacl/python-nacl_${python_nacl_version}_armhf.deb" + wget -q -O '/tmp/python-ujson.deb' "http://ftp.ch.debian.org/debian/pool/main/u/ujson/python-ujson_${python_ujson_version}_armhf.deb" - if ([[ ! -e '/tmp/python-nacl.deb' ]] || [[ $(md5sum '/tmp/python-nacl.deb' | cut -d' ' -f1) != $md5sum_python_nacl ]]) && \ + if ([[ ! -e '/tmp/python-nacl.deb' ]] || [[ $(md5sum '/tmp/python-nacl.deb' | cut -d' ' -f1) != $md5sum_python_nacl ]]) || \ ([[ ! -e '/tmp/python-ujson.deb' ]] || [[ $(md5sum '/tmp/python-ujson.deb' | cut -d' ' -f1) != $md5sum_python_ujson ]]) then ynh_die "Error : can't get debian dependance package" fi - sudo dpkg -i /tmp/python-nacl.deb - sudo dpkg -i /tmp/python-ujson.deb + sudo dpkg -i /tmp/python-nacl.deb || true + sudo dpkg -i /tmp/python-ujson.deb || true } GET_DEBIAN_VERSION() { @@ -62,31 +63,6 @@ CHECK_VAR () { # Vérifie que la variable n'est pas vide. test -n "$1" || (echo "$2" >&2 && false) } -EXIT_PROPERLY () { # Provoque l'arrêt du script en cas d'erreur. Et nettoye les résidus. - exit_code=$? - if [ "$exit_code" -eq 0 ]; then - exit 0 # Quitte sans erreur si le script se termine correctement. - fi - trap '' EXIT - set +eu - echo -e "\e[91m \e[1m" # Shell in light red bold - echo -e "!!\n $app install's script has encountered an error. Installation was cancelled.\n!!" >&2 - - if type -t CLEAN_SETUP > /dev/null; then # Vérifie l'existance de la fonction avant de l'exécuter. - CLEAN_SETUP # Appel la fonction de nettoyage spécifique du script install. - fi - - # Compense le bug de ssowat qui ne supprime pas l'entrée de l'app en cas d'erreur d'installation. - sudo sed -i "\@\"$domain$path/\":@d" /etc/ssowat/conf.json - - ynh_die -} - -TRAP_ON () { # Activate signal capture - set -eu # Exit if a command fail, and if a variable is used unset. - trap EXIT_PROPERLY EXIT # Capturing exit signals on shell script -} - # Ignore the yunohost-cli log to prevent errors with conditionals commands # usage: NO_LOG COMMAND # Simply duplicate the log, execute the yunohost command and replace the log without the result of this command @@ -101,11 +77,6 @@ NO_LOG() { return $? } -CHECK_USER () { # Vérifie la validité de l'user admin -# $1 = Variable de l'user admin. - ynh_user_exists "$1" || (echo "Wrong admin" >&2 && false) -} - CHECK_PATH () { # Vérifie la présence du / en début de path. Et son absence à la fin. if [ "${path:0:1}" != "/" ]; then # Si le premier caractère n'est pas un / path="/$path" # Ajoute un / en début de path @@ -128,75 +99,6 @@ CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà u fi } -GENERATE_DB () { # Créer une base de données et un utilisateur dédié au nom de l'app. -# $1 = Nom de la base de donnée - db_user=$1 - db_user=${db_user//-/_} # mariadb ne supporte pas les - dans les noms de base de données. Ils sont donc remplacé par des _ - # Génère un mot de passe aléatoire. -# db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20) - db_pwd=$(ynh_string_random) - CHECK_VAR "$db_pwd" "db_pwd empty" - # Utilise '$app' comme nom d'utilisateur et de base de donnée - # Initialise la base de donnée et stocke le mot de passe mysql. - ynh_mysql_create_db "$db_user" "$db_user" $db_pwd - ynh_app_setting_set $app mysqlpwd $db_pwd -} - -SETUP_SOURCE () { # Télécharge la source, décompresse et copie dans $final_path -# $1 = Nom de l'archive téléchargée. - wget -nv -i ../sources/source_url -O $1 - # Vérifie la somme de contrôle de la source téléchargée. - md5sum -c ../sources/source_md5 --status || (echo "Corrupt source" >&2 && false) - # Décompresse la source - if [ "$(echo ${1##*.})" == "gz" ]; then - tar -x -f $1 - elif [ "$(echo ${1##*.})" == "zip" ]; then - unzip -q $1 - else - false # Format d'archive non pris en charge. - fi - # Copie les fichiers sources - sudo cp -a $(cat ../sources/source_dir)/. "$final_path" - # Copie les fichiers additionnels ou modifiés. - if test -e "../sources/ajouts"; then - sudo cp -a ../sources/ajouts/. "$final_path" - fi -} - -ADD_SYS_USER () { # Créer un utilisateur système dédié à l'app - if ! ynh_system_user_exists "$app" # Test l'existence de l'utilisateur - then - sudo useradd -d /var/www/$app --system --user-group $app --shell /usr/sbin/nologin || (echo "Unable to create $app system account" >&2 && false) - fi -} - -POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configure. - sed -i "s@__NAMETOCHANGE__@$app@g" ../conf/php-fpm.conf - sed -i "s@__FINALPATH__@$final_path@g" ../conf/php-fpm.conf - sed -i "s@__USER__@$app@g" ../conf/php-fpm.conf - finalphpconf=/etc/php5/fpm/pool.d/$app.conf - sudo cp ../conf/php-fpm.conf $finalphpconf - sudo chown root: $finalphpconf - finalphpini=/etc/php5/fpm/conf.d/20-$app.ini - sudo cp ../conf/php-fpm.ini $finalphpini - sudo chown root: $finalphpini - sudo service php5-fpm reload -} - -STORE_MD5_CONFIG () { # Enregistre la somme de contrôle du fichier de config -# $1 = Nom du fichier de conf pour le stockage dans settings.yml -# $2 = Nom complet et chemin du fichier de conf. - ynh_app_setting_set $app $1_file_md5 $(sudo md5sum "$2" | cut -d' ' -f1) -} - -CHECK_MD5_CONFIG () { # Créé un backup du fichier de config si il a été modifié. -# $1 = Nom du fichier de conf pour le stockage dans settings.yml -# $2 = Nom complet et chemin du fichier de conf. - if [ "$(ynh_app_setting_get $app $1_file_md5)" != $(sudo md5sum "$2" | cut -d' ' -f1) ]; then - sudo cp -a "$2" "$2.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')" # Si le fichier de config a été modifié, créer un backup. - fi -} - FIND_PORT () { # Cherche un port libre. # $1 = Numéro de port pour débuter la recherche. port=$1 @@ -223,38 +125,3 @@ REMOVE_LOGROTATE_CONF () { # Suppression de la configuration de logrotate sudo rm "/etc/logrotate.d/$app" fi } - -SECURE_REMOVE () { # Suppression de dossier avec vérification des variables - chaine="$1" # L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables. - no_var=0 - while (echo "$chaine" | grep -q '\$') # Boucle tant qu'il y a des $ dans la chaine - do - no_var=1 - global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole la première variable trouvée. - only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière. - real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` permet d'interpréter une variable contenue dans une variable. - if test -z "$real_var" || [ "$real_var" = "/" ]; then - echo "Variable $only_var is empty, suppression of $chaine cancelled." >&2 - return 1 - fi - chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # remplace la variable par sa valeur dans la chaine. - done - if [ "$no_var" -eq 1 ] - then - if [ -e "$chaine" ]; then - echo "Delete directory $chaine" - sudo rm -r "$chaine" - fi - return 0 - else - echo "No detected variable." >&2 - return 1 - fi -} - -REMOVE_SYS_USER () { # Supprime l'utilisateur système dédié à l'app - if ynh_system_user_exists "$app" # Test l'existence de l'utilisateur - then - sudo userdel $app - fi -} diff --git a/scripts/backup b/scripts/backup index 3828550..5f513d4 100644 --- a/scripts/backup +++ b/scripts/backup @@ -59,6 +59,7 @@ ynh_backup "/etc/matrix-synapse" "synapse_config" # Backup coturn server ynh_backup "/etc/turnserver.conf" "coturn_config" +ynh_backup "/etc/default/coturn" "coturn_config_default" # Backup synapse database ynh_backup "/var/lib/matrix-synapse" "data" diff --git a/scripts/install b/scripts/install index ecb5e25..89c401d 100644 --- a/scripts/install +++ b/scripts/install @@ -20,12 +20,9 @@ NO_LOG FIND_PORT 8448 # Cherche un port libre. synapse_tls_port=$port NO_LOG FIND_PORT 8008 # Cherche un port libre. synapse_port=$port -NO_LOG FIND_PORT 3478 # Cherche un port libre. -turnserver_port=$port NO_LOG FIND_PORT 5349 # Cherche un port libre. turnserver_tls_port=$port sudo yunohost firewall allow --no-upnp TCP $synapse_tls_port > /dev/null 2>&1 -sudo yunohost firewall allow --no-upnp Both $turnserver_port > /dev/null 2>&1 sudo yunohost firewall allow --no-upnp Both $turnserver_tls_port > /dev/null 2>&1 # Make dh cert for synapse if it not exist @@ -40,7 +37,6 @@ ynh_app_setting_set $app path $path ynh_app_setting_set $app is_public $is_public ynh_app_setting_set $app synapse_port $synapse_port ynh_app_setting_set $app synapse_tls_port $synapse_tls_port -ynh_app_setting_set $app turnserver_port $turnserver_port ynh_app_setting_set $app turnserver_tls_port $turnserver_tls_port ynh_app_setting_set $app turnserver_pwd $turnserver_pwd @@ -58,12 +54,12 @@ sudo apt-key add "/tmp/matrix-repo-key.asc" echo "matrix-synapse matrix-synapse/server-name select $domain" | sudo debconf-set-selections # Configure dpkg for no questions echo "matrix-synapse matrix-synapse/report-stats select false" | sudo debconf-set-selections # Configure dpkg for no questions -# Enable debian-backports repos -enable_backport_repos - # Install coturn (the turn server) ynh_package_install coturn +# Enable debian-backports repos +enable_backport_repos + # Enable Synapse repos if [[ -n "$(uname -m | grep arm)" ]] then @@ -96,10 +92,10 @@ else fi # Configure Coturn +sudo cp ../conf/default_coturn /etc/default/coturn sudo cp ../conf/turnserver.conf /etc/turnserver.conf sudo sed -i "s@__TURNPWD__@$turnserver_pwd@g" /etc/turnserver.conf sudo sed -i "s@__DOMAIN__@$domain@g" /etc/turnserver.conf -sudo sed -i "s@__PORT__@$turnserver_port@g" /etc/turnserver.conf sudo sed -i "s@__TLS_PORT__@$turnserver_tls_port@g" /etc/turnserver.conf # Configure access for certificates diff --git a/scripts/restore b/scripts/restore index 7a71993..21cf499 100644 --- a/scripts/restore +++ b/scripts/restore @@ -7,6 +7,13 @@ ######## We implement manually this fonctions +#!/bin/bash + +md5sum_python_nacl="34c44f8f5100170bae3b4329ffb43087" +md5sum_python_ujson="5b65f8cb6bedef7971fdc557e09effbe" +python_nacl_version="1.0.1-2" +python_ujson_version="1.35-1" + init_script() { # Exit on command errors and treat unset variables as an error set -eu @@ -33,15 +40,16 @@ init_script() { install_arm_package_dep() { wget -q -O '/tmp/python-nacl.deb' "http://ftp.ch.debian.org/debian/pool/main/p/python-nacl/python-nacl_${python_nacl_version}_armhf.deb" + wget -q -O '/tmp/python-ujson.deb' "http://ftp.ch.debian.org/debian/pool/main/u/ujson/python-ujson_${python_ujson_version}_armhf.deb" - if ([[ ! -e '/tmp/python-nacl.deb' ]] || [[ $(md5sum '/tmp/python-nacl.deb' | cut -d' ' -f1) != $md5sum_python_nacl ]]) && \ + if ([[ ! -e '/tmp/python-nacl.deb' ]] || [[ $(md5sum '/tmp/python-nacl.deb' | cut -d' ' -f1) != $md5sum_python_nacl ]]) || \ ([[ ! -e '/tmp/python-ujson.deb' ]] || [[ $(md5sum '/tmp/python-ujson.deb' | cut -d' ' -f1) != $md5sum_python_ujson ]]) then ynh_die "Error : can't get debian dependance package" fi - sudo dpkg -i /tmp/python-nacl.deb - sudo dpkg -i /tmp/python-ujson.deb + sudo dpkg -i /tmp/python-nacl.deb || true + sudo dpkg -i /tmp/python-ujson.deb || true } GET_DEBIAN_VERSION() { @@ -64,6 +72,69 @@ CHECK_VAR () { # Vérifie que la variable n'est pas vide. test -n "$1" || (echo "$2" >&2 && false) } +# Ignore the yunohost-cli log to prevent errors with conditionals commands +# usage: NO_LOG COMMAND +# Simply duplicate the log, execute the yunohost command and replace the log without the result of this command +# It's a very badly hack... +# Petite copie perso à mon usage ;) +NO_LOG() { + ynh_cli_log=/var/log/yunohost/yunohost-cli.log + sudo cp -a ${ynh_cli_log} ${ynh_cli_log}-move + eval $@ + exit_code=$? + sudo mv ${ynh_cli_log}-move ${ynh_cli_log} + return $? +} + +CHECK_PATH () { # Vérifie la présence du / en début de path. Et son absence à la fin. + if [ "${path:0:1}" != "/" ]; then # Si le premier caractère n'est pas un / + path="/$path" # Ajoute un / en début de path + fi + if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then # Si le dernier caractère est un / et que ce n'est pas le seul caractère. + path="${path:0:${#path}-1}" # Supprime le dernier caractère + fi +} + +CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. + sudo yunohost app checkurl $domain$path -a $app +} + +CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà utilisé. + final_path=/var/www/$app + if [ -e "$final_path" ] + then + echo "This path already contains a folder" >&2 + false + fi +} + +FIND_PORT () { # Cherche un port libre. +# $1 = Numéro de port pour débuter la recherche. + port=$1 + while ! sudo yunohost app checkport $port ; do + port=$((port+1)) + done + CHECK_VAR "$port" "port empty" +} + + +### REMOVE SCRIPT + +REMOVE_NGINX_CONF () { # Suppression de la configuration nginx + if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then # Delete nginx config + echo "Delete nginx config" + sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf" + sudo service nginx reload + fi +} + +REMOVE_LOGROTATE_CONF () { # Suppression de la configuration de logrotate + if [ -e "/etc/logrotate.d/$app" ]; then + echo "Delete logrotate config" + sudo rm "/etc/logrotate.d/$app" + fi +} + ######## End of common fonctions # Init script @@ -93,12 +164,12 @@ sudo apt-key add "/tmp/matrix-repo-key.asc" echo "matrix-synapse matrix-synapse/server-name select $domain" | sudo debconf-set-selections # Configure dpkg for no questions echo "matrix-synapse matrix-synapse/report-stats select false" | sudo debconf-set-selections # Configure dpkg for no questions -# Enable debian-backports repos -enable_backport_repos - # Install coturn (the turn server) ynh_package_install coturn +# Enable debian-backports repos +enable_backport_repos + # Enable Synapse repos if [[ -n "$(uname -m | grep arm)" ]] then @@ -124,6 +195,7 @@ sudo cp -a ./synapse_config/. "/etc/matrix-synapse/." # Restore coturn server sudo cp -a ./coturn_config "/etc/turnserver.conf" +sudo cp -a ./coturn_config_default "/etc/default/coturn" # Restore synapse database sudo cp -a ./data/. "/var/lib/matrix-synapse/." @@ -139,7 +211,6 @@ sudo setfacl -m user:turnserver:r /etc/yunohost/certs/$domain/dh.pem # Ouvre le port dans le firewall sudo yunohost firewall allow --no-upnp TCP $synapse_tls_port > /dev/null 2>&1 -sudo yunohost firewall allow --no-upnp Both $turnserver_port > /dev/null 2>&1 sudo yunohost firewall allow --no-upnp Both $turnserver_tls_port > /dev/null 2>&1 # Régénère la configuration de SSOwat diff --git a/scripts/upgrade b/scripts/upgrade index 784088e..495952f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,9 +12,10 @@ path=$(ynh_app_setting_get $app path) is_public=$(ynh_app_setting_get $app is_public) synapse_port=$(ynh_app_setting_get $app synapse_port) synapse_tls_port=$(ynh_app_setting_get $app synapse_tls_port) -turnserver_port=$(ynh_app_setting_get $app turnserver_port) +turnserver_dbpass=$(ynh_app_setting_get "$app" turnserver_mysqlpwd) turnserver_tls_port=$(ynh_app_setting_get $app turnserver_tls_port) turnserver_pwd=$(ynh_app_setting_get $app turnserver_pwd) +turnserver_dbuser="turnserver" CHECK_PATH # Vérifie et corrige la syntaxe du path. @@ -49,7 +50,6 @@ fi sudo cp ../conf/turnserver.conf /etc/turnserver.conf sudo sed -i "s@__TURNPWD__@$turnserver_pwd@g" /etc/turnserver.conf sudo sed -i "s@__DOMAIN__@$domain@g" /etc/turnserver.conf -sudo sed -i "s@__PORT__@$turnserver_port@g" /etc/turnserver.conf sudo sed -i "s@__TLS_PORT__@$turnserver_tls_port@g" /etc/turnserver.conf # Régénère la configuration de SSOwat