From b7a7c926c77013c3d022e24e5d101f05ac2fcac6 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 9 May 2021 11:06:05 +0200 Subject: [PATCH 01/12] Handle migration from bitwarden --- README.md | 13 ++ check_process | 2 +- conf/bitwarden_migration | 17 ++ conf/bitwarden_post_migration.sh | 38 +++++ scripts/_common.sh | 2 +- scripts/upgrade | 49 +++++- scripts/ynh_handle_app_migration | 259 +++++++++++++++++++++++++++++++ 7 files changed, 370 insertions(+), 10 deletions(-) create mode 100644 conf/bitwarden_migration create mode 100644 conf/bitwarden_post_migration.sh create mode 100644 scripts/ynh_handle_app_migration diff --git a/README.md b/README.md index 7386a55..36ea7be 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,19 @@ How to configure this app: by an admin panel at https://vaultwarden.domain.tld/a * Upstream app repository: https://github.com/dani-garcia/vaultwarden * YunoHost website: https://yunohost.org/ +## Migrate from Bitwarden + +This package handle the migration from Bitwarden to Vaultwarden. +For that, you will have to upgrade your Bitwarden application with this repository. +This can only be done from the command-line interface - e.g. through SSH. +Once you're connected, you simply have to execute the following: + +```bash +sudo yunohost app upgrade bitwarden -u https://github.com/YunoHost-Apps/vaultwarden_ynh --debug +``` + +The `--debug` option will let you see the full output. If you encounter any issue, please paste it. + --- ## Developer info diff --git a/check_process b/check_process index 4500271..e77360b 100644 --- a/check_process +++ b/check_process @@ -18,7 +18,7 @@ setup_public=1 upgrade=1 # Bitwarden 1.20.0~ynh4 - #upgrade=1 from_commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db + upgrade=1 from_commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db backup_restore=1 multi_instance=1 port_already_use=0 diff --git a/conf/bitwarden_migration b/conf/bitwarden_migration new file mode 100644 index 0000000..3aaefa3 --- /dev/null +++ b/conf/bitwarden_migration @@ -0,0 +1,17 @@ +#!/bin/bash + +# App main directory +/var/www/$app + +# NGINX web server configuration +/etc/nginx/conf.d/$domain.d/$app.conf + +# App logs +/var/log/$app/ + +# Service configuration +/etc/systemd/system/$app.service + +# Fail2Ban configuration +/etc/fail2ban/jail.d/$app.conf +/etc/fail2ban/filter.d/$app.conf diff --git a/conf/bitwarden_post_migration.sh b/conf/bitwarden_post_migration.sh new file mode 100644 index 0000000..12b186f --- /dev/null +++ b/conf/bitwarden_post_migration.sh @@ -0,0 +1,38 @@ +#!/bin/bash + +# Ending the migration process from Bitwarden to Vaultwarden + +set -u + +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +source /usr/share/yunohost/helpers + +#================================================= +# SET VARIABLES +#================================================= + +old_app="__OLD_APP__" +new_app="__NEW_APP__" +script_name="$0" + +#================================================= +# DELETE OLD APP'S SETTINGS +#================================================= + +#ynh_secure_remove --file="/etc/yunohost/apps/$old_app" +yunohost app ssowatconf + +#================================================= +# REMOVE THE OLD USER +#================================================= + +ynh_system_user_delete --username="$old_app" + +#================================================= +# DELETE THIS SCRIPT +#================================================= + +echo "rm $script_name" | at now + 1 minutes \ No newline at end of file diff --git a/scripts/_common.sh b/scripts/_common.sh index aa3c17a..b73042c 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -5,7 +5,7 @@ #================================================= # dependencies used by the app -pkg_dependencies="curl tar pkg-config libssl-dev libc6-dev" +pkg_dependencies="curl tar pkg-config libssl-dev libc6-dev at" #================================================= # PERSONAL HELPERS diff --git a/scripts/upgrade b/scripts/upgrade index cf2bb2d..29ea99c 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -7,6 +7,7 @@ #================================================= source _common.sh +source ynh_handle_app_migration source /usr/share/yunohost/helpers #================================================= @@ -78,7 +79,26 @@ ynh_remove_logrotate #================================================= ynh_script_progression --message="Stopping a systemd service..." -ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --line_match="Stopped vaultwarden Server" +ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --line_match="Stopped" + +#================================================= +# HANDLE MIGRATION FROM BITWARDEN +#================================================= + +ynh_handle_app_migration --migration_id="bitwarden" --migration_list="bitwarden_migration" +if [ $migration_process -eq 1 ] +then + # If a migration has been perform + # Reload some values changed by the migration process + final_path=$(ynh_app_setting_get --app=$app --key=final_path) + db_name=$(ynh_app_setting_get --app=$app --key=db_name) + + mv $final_path/live/bitwarden_rs.env $final_path/live/vaultwarden.env + ynh_delete_file_checksum --file="$final_path/live/bitwarden_rs.env" + ynh_store_file_checksum --file="$final_path/live/vaultwarden.env" + ynh_secure_remove --file="$final_path/live/bitwarden_rs" + mkdir -p "/etc/yunohost/apps/bitwarden" +fi #================================================= # CREATE DEDICATED USER @@ -169,13 +189,6 @@ fi #================================================= ynh_script_progression --message="Updating a config file..." -# Manage app name change -if test -f "$final_path/live/bitwarden_rs.env"; then - mv -a "$final_path/live/bitwarden_rs.env" "$final_path/live/vaultwarden.env" - ynh_delete_file_checksum --file="$final_path/live/bitwarden_rs.env" - ynh_store_file_checksum --file="$final_path/live/vaultwarden.env" -fi - ynh_add_config --template="../conf/vaultwarden.env" --destination="$final_path/live/vaultwarden.env" chmod 400 "$final_path/live/vaultwarden.env" @@ -210,6 +223,8 @@ ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" --l #================================================= ynh_script_progression --message="Reconfiguring Fail2Ban..." +mkdir -p "/var/log/$app" +touch /var/log/"$app"/"$app".log # Create a dedicated Fail2Ban config ynh_add_fail2ban_config --logpath="/var/log/$app/$app.log" --failregex="^.*Username or password is incorrect\. Try again\. IP: \. Username:.*$" @@ -220,6 +235,24 @@ ynh_script_progression --message="Reloading NGINX web server..." ynh_systemd_action --service_name=nginx --action=reload +#================================================= +# FINISH MIGRATION PROCESS +#================================================= + +if [ $migration_process -eq 1 ] +then + ynh_script_progression --message="Bitwarden has been successfully migrated to Vaultwarden! \ +A last scheduled operation will run in a couple of minutes to finish the \ +migration in YunoHost side. Do not proceed any application operation while \ +you don't see Vaultwarden as installed." + script_post_migration=bitwarden_post_migration.sh + cp ../conf/$script_post_migration /tmp + ynh_replace_string --match_string="__OLD_APP__" --replace_string="$old_app" --target_file=/tmp/$script_post_migration + ynh_replace_string --match_string="__NEW_APP__" --replace_string="$app" --target_file=/tmp/$script_post_migration + chmod +x /tmp/$script_post_migration + (cd /tmp; echo "/tmp/$script_post_migration > /tmp/$script_post_migration.log 2>&1" | at now + 2 minutes) +fi + #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/ynh_handle_app_migration b/scripts/ynh_handle_app_migration new file mode 100644 index 0000000..2873896 --- /dev/null +++ b/scripts/ynh_handle_app_migration @@ -0,0 +1,259 @@ +#!/bin/bash + +# Need also the helper https://github.com/YunoHost-Apps/Experimental_helpers/blob/master/ynh_handle_getopts_args/ynh_handle_getopts_args + +# Make the main steps to migrate an app to its fork. +# +# This helper has to be used for an app which needs to migrate to a new name or a new fork +# (like owncloud to nextcloud or zerobin to privatebin). +# +# This helper will move the files of an app to its new name +# or recreate the things it can't move. +# +# To specify which files it has to move, you have to create a "migration file", stored in ../conf +# This file is a simple list of each file it has to move, +# except that file names must reference the $app variable instead of the real name of the app, +# and every instance-specific variables (like $domain). +# $app is especially important because it's this variable which will be used to identify the old place and the new one for each file. +# +# If a database exists for this app, it will be dumped and then imported in a newly created database, with a new name and new user. +# Don't forget you have to then apply these changes to application-specific settings (depends on the packaged application) +# +# Same things for an existing user, a new one will be created. +# But the old one can't be removed unless it's not used. See below. +# +# If you have some dependencies for your app, it's possible to change the fake debian package which manages them. +# You have to fill the $pkg_dependencies variable, and then a new fake package will be created and installed, +# and the old one will be removed. +# If you don't have a $pkg_dependencies variable, the helper can't know what the app dependencies are. +# +# The app settings.yml will be modified as follows: +# - finalpath will be changed according to the new name (but only if the existing $final_path contains the old app name) +# - The checksums of php-fpm and nginx config files will be updated too. +# - If there is a $db_name value, it will be changed. +# - And, of course, the ID will be changed to the new name too. +# +# Finally, the $app variable will take the value of the new name. +# The helper will set the $migration_process variable to 1 if a migration has been successfully handled. +# +# You have to handle by yourself all the migrations not done by this helper, like configuration or special values in settings.yml +# Also, at the end of the upgrade script, you have to add a post_migration script to handle all the things the helper can't do during YunoHost upgrade (mostly for permission reasons), +# especially remove the old user, move some hooks and remove the old configuration directory +# To launch this script, you have to move it elsewhere and start it after the upgrade script. +# `cp ../conf/$script_post_migration /tmp` +# `(cd /tmp; echo "/tmp/$script_post_migration" | at now + 2 minutes)` +# +# usage: ynh_handle_app_migration migration_id migration_list +# | arg: -i, --migration_id= - ID from which to migrate +# | arg: -l, --migration_list= - File specifying every file to move (one file per line) +ynh_handle_app_migration () { + #================================================= + # LOAD SETTINGS + #================================================= + + old_app=$YNH_APP_INSTANCE_NAME + local old_app_id=$YNH_APP_ID + local old_app_number=$YNH_APP_INSTANCE_NUMBER + + # Declare an array to define the options of this helper. + declare -Ar args_array=( [i]=migration_id= [l]=migration_list= ) + # Get the id from which to migrate + local migration_id + # And the file with the paths to move + local migration_list + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + + # Get the new app id in the manifest + local new_app_id=$(grep \"id\": ../manifest.json | cut -d\" -f4) + if [ $old_app_number -eq 1 ]; then + local new_app=$new_app_id + else + local new_app=${new_app_id}__${old_app_number} + fi + + #================================================= + # CHECK IF IT HAS TO MIGRATE + #================================================= + + migration_process=0 + + if [ "$old_app_id" == "$new_app_id" ] + then + # If the 2 id are the same + # No migration to do. + echo 0 + return 0 + else + if [ "$old_app_id" != "$migration_id" ] + then + # If the new app is not the authorized id, fail. + ynh_die --message="Incompatible application for migration from $old_app_id to $new_app_id" + fi + + ynh_print_info --message="Migrate from $old_app_id to $new_app_id" >&2 + + #================================================= + # CHECK IF THE MIGRATION CAN BE DONE + #================================================= + + # TODO Handle multi instance apps... + # Check that there is not already an app installed for this id. + (yunohost app list | grep -q "id: $new_app") \ + && ynh_die --message="$new_app is already installed" + + #================================================= + # CHECK THE LIST OF FILES TO MOVE + #================================================= + + local temp_migration_list="$(tempfile)" + + # Build the list by removing blank lines and comment lines + sed '/^#.*\|^$/d' "../conf/$migration_list" > "$temp_migration_list" + + # Check if there is no file in the destination + local file_to_move="" + while read file_to_move + do + # Replace all occurences of $app by $new_app in each file to move. + local move_to_destination="${file_to_move//\$app/$new_app}" + test -e "$move_to_destination" && ynh_die --message="A file named $move_to_destination already exists." + done < "$temp_migration_list" + + #================================================= + # COPY YUNOHOST SETTINGS FOR THIS APP + #================================================= + + local settings_dir="/etc/yunohost/apps" + cp -a "$settings_dir/$old_app" "$settings_dir/$new_app" + + # Replace the old id by the new one + ynh_replace_string --match_string="\(^id: .*\)$old_app" --replace_string="\1$new_app" --target_file="$settings_dir/$new_app/settings.yml" + # INFO: There a special behavior with yunohost app setting: + # if the id given in argument does not match with the id + # stored in the config file, the config file will be purged. + # That's why we use sed instead of app setting here. + # https://github.com/YunoHost/yunohost/blob/c6b5284be8da39cf2da4e1036a730eb5e0515096/src/yunohost/app.py#L1316-L1321 + + # Change the label if it's simply the name of the app + old_label=$(ynh_app_setting_get --app=$new_app --key=label) + if [ "${old_label,,}" == "$old_app_id" ] + then + # Build the new label from the id of the app. With the first character as upper case + new_label=$(echo $new_app_id | cut -c1 | tr [:lower:] [:upper:])$(echo $new_app_id | cut -c2-) + ynh_app_setting_set --app=$new_app --key=label --value=$new_label + fi + + #================================================= + # MOVE FILES TO THE NEW DESTINATION + #================================================= + + while read file_to_move + do + # Replace all occurence of $app by $new_app in each file to move. + move_to_destination="$(eval echo "${file_to_move//\$app/$new_app}")" + local real_file_to_move="$(eval echo "${file_to_move//\$app/$old_app}")" + ynh_print_info --message="Move file $real_file_to_move to $move_to_destination" >&2 + mv "$real_file_to_move" "$move_to_destination" + done < "$temp_migration_list" + + #================================================= + # UPDATE SETTINGS KNOWN ENTRIES + #================================================= + + # Replace nginx checksum + ynh_replace_string --match_string="\(^checksum__etc_nginx.*\)_$old_app" --replace_string="\1_$new_app/" --target_file="$settings_dir/$new_app/settings.yml" + + # Replace php5-fpm checksums + ynh_replace_string --match_string="\(^checksum__etc_php5.*[-_]\)$old_app" --replace_string="\1$new_app/" --target_file="$settings_dir/$new_app/settings.yml" + + # Replace final_path + ynh_replace_string --match_string="\(^final_path: .*\)$old_app" --replace_string="\1$new_app" --target_file="$settings_dir/$new_app/settings.yml" + + #================================================= + # MOVE THE MYSQL DATABASE + #================================================= + + old_db_name=$(ynh_app_setting_get --app=$old_app --key=db_name) + + # Check if a database exists before trying to move it + local mysql_root_password=$(cat $MYSQL_ROOT_PWD_FILE) + if [ -n "$old_db_name" ] && mysqlshow -u root -p$mysql_root_password | grep -q "^| $old_db_name" + then + old_db_user=$old_db_name + db_pwd=$(ynh_app_setting_get --app=$old_app --key=mysqlpwd) + + new_db_name=$(ynh_sanitize_dbid --db_name=$new_app) + new_db_user=$new_db_name + ynh_print_info --message="Rename the database $db_name to $new_db_name" >&2 + + local sql_dump="/tmp/${db_name}-$(date '+%s').sql" + + # Dump the old database + ynh_mysql_dump_db --database="$old_db_name" > "$sql_dump" + + # Create a new database + ynh_mysql_setup_db --db_user=$new_db_user --db_name=$new_db_name --db_pwd=$db_pwd + + # Then restore the old one into the new one + ynh_mysql_connect_as --user=$new_db_user --password=$db_pwd --database=$new_db_name < "$sql_dump" + + # Remove the old database + ynh_mysql_remove_db --db_user=$old_db_user --db_name=$old_db_name + + # And the dump + ynh_secure_remove --file="$sql_dump" + + # Update the value of $db_name + db_name=$new_db_name + db_user=$new_db_user + ynh_app_setting_set --app=$new_app --key=db_name --value=$db_name + fi + + #================================================= + # CREATE A NEW USER + #================================================= + + new_final_path=$(ynh_app_setting_get --app=$new_app --key=final_path) + + # Check if the user exists on the system + if ynh_system_user_exists --username="$old_app" + then + ynh_print_info --message="Create a new user $new_app to replace $old_app" >&2 + ynh_system_user_create --username=$app --home_dir="$new_final_path" + fi + + #================================================= + # CHANGE THE FAKE DEPENDENCIES PACKAGE + #================================================= + + # Check if a variable $pkg_dependencies exists + # If this variable doesn't exist, this part shall be managed in the upgrade script. + if [ -n "${pkg_dependencies:-}" ] + then + # Define the name of the package + local old_package_name="${old_app//_/-}-ynh-deps" + local new_package_name="${new_app//_/-}-ynh-deps" + + if ynh_package_is_installed --package="$old_package_name" + then + # Install a new fake package + app=$new_app + ynh_install_app_dependencies $pkg_dependencies + # Then remove the old one + app=$old_app + ynh_remove_app_dependencies + fi + fi + + #================================================= + # UPDATE THE ID OF THE APP + #================================================= + + app=$new_app + + + # Set migration_process to 1 to inform that an upgrade has been made + migration_process=1 + fi +} From 0fe522d34cc7574985c906d43f69d03bd95a80c4 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 9 May 2021 11:20:09 +0200 Subject: [PATCH 02/12] remove test --- scripts/upgrade | 1 - 1 file changed, 1 deletion(-) diff --git a/scripts/upgrade b/scripts/upgrade index 29ea99c..0459bb6 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -97,7 +97,6 @@ then ynh_delete_file_checksum --file="$final_path/live/bitwarden_rs.env" ynh_store_file_checksum --file="$final_path/live/vaultwarden.env" ynh_secure_remove --file="$final_path/live/bitwarden_rs" - mkdir -p "/etc/yunohost/apps/bitwarden" fi #================================================= From 5f671bd62c96db967d6c8eda5d79ad5b126b4e02 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 9 May 2021 20:55:30 +0200 Subject: [PATCH 03/12] Fixing upgrade --- scripts/_common.sh | 2 +- scripts/upgrade | 45 ++++++++++++++++---------------- scripts/ynh_handle_app_migration | 23 ++++++---------- 3 files changed, 32 insertions(+), 38 deletions(-) diff --git a/scripts/_common.sh b/scripts/_common.sh index b73042c..aa3c17a 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -5,7 +5,7 @@ #================================================= # dependencies used by the app -pkg_dependencies="curl tar pkg-config libssl-dev libc6-dev at" +pkg_dependencies="curl tar pkg-config libssl-dev libc6-dev" #================================================= # PERSONAL HELPERS diff --git a/scripts/upgrade b/scripts/upgrade index 0459bb6..36274b6 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -33,28 +33,6 @@ ynh_script_progression --message="Checking version..." upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -if ! ynh_permission_exists --permission="admin"; then - # Create the required permissions - ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin --show_tile="false" -fi - -# Create a permission if needed -if ! ynh_permission_exists --permission="api"; then - ynh_permission_create --permission="api" --url="/api" --additional_urls="/identity/connect/token" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true" -fi - #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= @@ -86,6 +64,7 @@ ynh_systemd_action --service_name=$app --action="stop" --log_path="systemd" --li #================================================= ynh_handle_app_migration --migration_id="bitwarden" --migration_list="bitwarden_migration" + if [ $migration_process -eq 1 ] then # If a migration has been perform @@ -99,6 +78,28 @@ then ynh_secure_remove --file="$final_path/live/bitwarden_rs" fi +#================================================= +# ENSURE DOWNWARD COMPATIBILITY +#================================================= +ynh_script_progression --message="Ensuring downward compatibility..." + +# Cleaning legacy permissions +if ynh_legacy_permissions_exists; then + ynh_legacy_permissions_delete_all + + ynh_app_setting_delete --app=$app --key=is_public +fi + +if ! ynh_permission_exists --permission="admin"; then + # Create the required permissions + ynh_permission_create --permission="admin" --url="/admin" --allowed=$admin --show_tile="false" +fi + +# Create a permission if needed +if ! ynh_permission_exists --permission="api"; then + ynh_permission_create --permission="api" --url="/api" --additional_urls="/identity/connect/token" --allowed="visitors" --auth_header="false" --show_tile="false" --protected="true" +fi + #================================================= # CREATE DEDICATED USER #================================================= diff --git a/scripts/ynh_handle_app_migration b/scripts/ynh_handle_app_migration index 2873896..22f2d62 100644 --- a/scripts/ynh_handle_app_migration +++ b/scripts/ynh_handle_app_migration @@ -47,6 +47,9 @@ # | arg: -i, --migration_id= - ID from which to migrate # | arg: -l, --migration_list= - File specifying every file to move (one file per line) ynh_handle_app_migration () { + # Need for end of install + ynh_package_install at + #================================================= # LOAD SETTINGS #================================================= @@ -99,7 +102,7 @@ ynh_handle_app_migration () { # TODO Handle multi instance apps... # Check that there is not already an app installed for this id. - (yunohost app list | grep -q "id: $new_app") \ + (yunohost app list | grep -q -w "id: $new_app") \ && ynh_die --message="$new_app is already installed" #================================================= @@ -126,6 +129,7 @@ ynh_handle_app_migration () { local settings_dir="/etc/yunohost/apps" cp -a "$settings_dir/$old_app" "$settings_dir/$new_app" + cp -a ../{scripts,conf} "$settings_dir/$new_app" # Replace the old id by the new one ynh_replace_string --match_string="\(^id: .*\)$old_app" --replace_string="\1$new_app" --target_file="$settings_dir/$new_app/settings.yml" @@ -143,6 +147,9 @@ ynh_handle_app_migration () { new_label=$(echo $new_app_id | cut -c1 | tr [:lower:] [:upper:])$(echo $new_app_id | cut -c2-) ynh_app_setting_set --app=$new_app --key=label --value=$new_label fi + + yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$old_app.main', force=True, sync_perm=False)" + yunohost tools shell -c "from yunohost.permission import permission_create; permission_create('$new_app.main', url='/' , sync_perm=True)" #================================================= # MOVE FILES TO THE NEW DESTINATION @@ -210,19 +217,6 @@ ynh_handle_app_migration () { ynh_app_setting_set --app=$new_app --key=db_name --value=$db_name fi - #================================================= - # CREATE A NEW USER - #================================================= - - new_final_path=$(ynh_app_setting_get --app=$new_app --key=final_path) - - # Check if the user exists on the system - if ynh_system_user_exists --username="$old_app" - then - ynh_print_info --message="Create a new user $new_app to replace $old_app" >&2 - ynh_system_user_create --username=$app --home_dir="$new_final_path" - fi - #================================================= # CHANGE THE FAKE DEPENDENCIES PACKAGE #================================================= @@ -252,7 +246,6 @@ ynh_handle_app_migration () { app=$new_app - # Set migration_process to 1 to inform that an upgrade has been made migration_process=1 fi From 36f771cd300cb5d74b987e35e685b54ff339b9cf Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 9 May 2021 20:56:25 +0200 Subject: [PATCH 04/12] Update bitwarden_post_migration.sh --- conf/bitwarden_post_migration.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf/bitwarden_post_migration.sh b/conf/bitwarden_post_migration.sh index 12b186f..15c8f53 100644 --- a/conf/bitwarden_post_migration.sh +++ b/conf/bitwarden_post_migration.sh @@ -22,7 +22,7 @@ script_name="$0" # DELETE OLD APP'S SETTINGS #================================================= -#ynh_secure_remove --file="/etc/yunohost/apps/$old_app" +ynh_secure_remove --file="/etc/yunohost/apps/$old_app" yunohost app ssowatconf #================================================= From a42627b42c8b849a2b671a35fb8bdb832e21cbfc Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 9 May 2021 23:44:32 +0200 Subject: [PATCH 05/12] fix permissions --- scripts/ynh_handle_app_migration | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scripts/ynh_handle_app_migration b/scripts/ynh_handle_app_migration index 22f2d62..2dd80a6 100644 --- a/scripts/ynh_handle_app_migration +++ b/scripts/ynh_handle_app_migration @@ -149,7 +149,9 @@ ynh_handle_app_migration () { fi yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$old_app.main', force=True, sync_perm=False)" - yunohost tools shell -c "from yunohost.permission import permission_create; permission_create('$new_app.main', url='/' , sync_perm=True)" + yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$old_app.admin', force=True, sync_perm=False)" + yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$old_app.api', force=True, sync_perm=False)" + yunohost tools shell -c "from yunohost.permission import permission_create; permission_create('$new_app.main', url='$path_url' , sync_perm=True)" #================================================= # MOVE FILES TO THE NEW DESTINATION From f2cfea446615b66a5e2fdff1dcc91064930d9329 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Tue, 11 May 2021 01:40:02 +0200 Subject: [PATCH 06/12] Fix migration --- scripts/upgrade | 14 +++++++++++++- scripts/ynh_handle_app_migration | 28 ++++++++++++++++++++-------- 2 files changed, 33 insertions(+), 9 deletions(-) diff --git a/scripts/upgrade b/scripts/upgrade index 36274b6..5845e6b 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -72,10 +72,22 @@ then final_path=$(ynh_app_setting_get --app=$app --key=final_path) db_name=$(ynh_app_setting_get --app=$app --key=db_name) + # Move config file mv $final_path/live/bitwarden_rs.env $final_path/live/vaultwarden.env - ynh_delete_file_checksum --file="$final_path/live/bitwarden_rs.env" + ynh_delete_file_checksum --file="/var/www/$old_app/live/bitwarden_rs.env" ynh_store_file_checksum --file="$final_path/live/vaultwarden.env" ynh_secure_remove --file="$final_path/live/bitwarden_rs" + + # Manage permissions + ynh_permission_update --permission="main" --add="all_users" + ynh_permission_update --permission="main" --add="visitors" + + # Remove the service from the list of services known by YunoHost (added from `yunohost service add`) + if ynh_exec_warn_less yunohost service status $old_app >/dev/null + then + ynh_script_progression --message="Removing $old_app service integration..." + yunohost service remove $old_app + fi fi #================================================= diff --git a/scripts/ynh_handle_app_migration b/scripts/ynh_handle_app_migration index 2dd80a6..63f926c 100644 --- a/scripts/ynh_handle_app_migration +++ b/scripts/ynh_handle_app_migration @@ -129,7 +129,7 @@ ynh_handle_app_migration () { local settings_dir="/etc/yunohost/apps" cp -a "$settings_dir/$old_app" "$settings_dir/$new_app" - cp -a ../{scripts,conf} "$settings_dir/$new_app" + cp -a ../{scripts,conf,manifest.json} "$settings_dir/$new_app" # Replace the old id by the new one ynh_replace_string --match_string="\(^id: .*\)$old_app" --replace_string="\1$new_app" --target_file="$settings_dir/$new_app/settings.yml" @@ -148,10 +148,13 @@ ynh_handle_app_migration () { ynh_app_setting_set --app=$new_app --key=label --value=$new_label fi - yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$old_app.main', force=True, sync_perm=False)" - yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$old_app.admin', force=True, sync_perm=False)" - yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$old_app.api', force=True, sync_perm=False)" - yunohost tools shell -c "from yunohost.permission import permission_create; permission_create('$new_app.main', url='$path_url' , sync_perm=True)" + permissions_name=$(yunohost user permission list $old_app --short --output-as plain) + for permission_name in $permissions_name + do + yunohost tools shell -c "from yunohost.permission import permission_delete; permission_delete('$permission_name', force=True, sync_perm=False)" + done + + yunohost tools shell -c "from yunohost.permission import permission_create; permission_create('$new_app.main', url='/' , show_tile=True , sync_perm=True)" #================================================= # MOVE FILES TO THE NEW DESTINATION @@ -171,14 +174,23 @@ ynh_handle_app_migration () { #================================================= # Replace nginx checksum - ynh_replace_string --match_string="\(^checksum__etc_nginx.*\)_$old_app" --replace_string="\1_$new_app/" --target_file="$settings_dir/$new_app/settings.yml" + ynh_replace_string --match_string="\(^checksum__etc_nginx.*\)_$old_app" --replace_string="\1_$new_app" --target_file="$settings_dir/$new_app/settings.yml" - # Replace php5-fpm checksums - ynh_replace_string --match_string="\(^checksum__etc_php5.*[-_]\)$old_app" --replace_string="\1$new_app/" --target_file="$settings_dir/$new_app/settings.yml" + # Replace php-fpm checksums + ynh_replace_string --match_string="\(^checksum__etc_php.*[-_]\)$old_app" --replace_string="\1$new_app" --target_file="$settings_dir/$new_app/settings.yml" # Replace final_path ynh_replace_string --match_string="\(^final_path: .*\)$old_app" --replace_string="\1$new_app" --target_file="$settings_dir/$new_app/settings.yml" + # Replace fail2ban_filter + ynh_replace_string --match_string="\(^checksum__etc_fail2ban_filter.*\)_$old_app" --replace_string="\1_$new_app" --target_file="$settings_dir/$new_app/settings.yml" + + # Replace fail2ban_jail + ynh_replace_string --match_string="\(^checksum__etc_fail2ban_jail.*\)_$old_app" --replace_string="\1_$new_app" --target_file="$settings_dir/$new_app/settings.yml" + + # Replace systemd + ynh_replace_string --match_string="\(^checksum__etc_systemd_system.*\)_$old_app" --replace_string="\1_$new_app" --target_file="$settings_dir/$new_app/settings.yml" + #================================================= # MOVE THE MYSQL DATABASE #================================================= From 5bf693d40f8228d911d817459140e6f96e6967bb Mon Sep 17 00:00:00 2001 From: yalh76 Date: Tue, 11 May 2021 08:18:38 +0200 Subject: [PATCH 07/12] Update check_process --- check_process | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/check_process b/check_process index e77360b..4500271 100644 --- a/check_process +++ b/check_process @@ -18,7 +18,7 @@ setup_public=1 upgrade=1 # Bitwarden 1.20.0~ynh4 - upgrade=1 from_commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db + #upgrade=1 from_commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db backup_restore=1 multi_instance=1 port_already_use=0 From 923c165140b5e461e33b00865bb291899d1906fb Mon Sep 17 00:00:00 2001 From: yalh76 Date: Tue, 11 May 2021 20:01:06 +0200 Subject: [PATCH 08/12] Upgrade version number --- check_process | 6 +++++- manifest.json | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/check_process b/check_process index 4500271..f718e84 100644 --- a/check_process +++ b/check_process @@ -19,6 +19,8 @@ upgrade=1 # Bitwarden 1.20.0~ynh4 #upgrade=1 from_commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db + # 1.21.0~ynh1 + upgrade=1 from_commit=3f7d7d2740a1cb3f16a290b64c89e84422d06ede backup_restore=1 multi_instance=1 port_already_use=0 @@ -28,4 +30,6 @@ Email=yalh@yahoo.com Notification=all ;;; Upgrade options ; commit=d5e1fa7d327c55d8e5ae4c24e7c6aaac006256db - name=1.20.0~ynh4 + name=Bitwarden 1.20.0~ynh4 + ; commit=3f7d7d2740a1cb3f16a290b64c89e84422d06ede + name=1.21.0~ynh1 diff --git a/manifest.json b/manifest.json index dc90e47..3842815 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Manage passwords and other sensitive informations", "fr": "Gérez les mots de passe et autres informations sensibles" }, - "version": "1.21.0~ynh1", + "version": "1.21.0~ynh2", "url": "https://github.com/dani-garcia/vaultwarden", "license": "GPL-3.0-or-later", "maintainer": { From 6d7f849199bfa4515a013524cf37c29d799a5092 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Thu, 13 May 2021 17:53:33 +0200 Subject: [PATCH 09/12] [autopatch] Update issue and PR templates --- issue_template.md => .github/ISSUE_TEMPLATE.md | 4 ++-- .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++++++++++++ pull_request_template.md | 16 ---------------- 3 files changed, 18 insertions(+), 18 deletions(-) rename issue_template.md => .github/ISSUE_TEMPLATE.md (94%) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 pull_request_template.md diff --git a/issue_template.md b/.github/ISSUE_TEMPLATE.md similarity index 94% rename from issue_template.md rename to .github/ISSUE_TEMPLATE.md index 8ad515c..2729a6b 100644 --- a/issue_template.md +++ b/.github/ISSUE_TEMPLATE.md @@ -8,7 +8,7 @@ about: When creating a bug report, please use the following template to provide 1. *Read this whole template first.* 2. *Determine if you are on the right place:* - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* - - *Otherwise, the issue may be due to vaultwarden itself. Refer to its documentation or repository for help.* + - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* - *When in doubt, post here and we will figure it out together.* 3. *Delete the italic comments as you write over them below, and remove this guide.* --- @@ -31,7 +31,7 @@ about: When creating a bug report, please use the following template to provide - *If you performed a command from the CLI, the command itself is enough. For example:* ```sh - sudo yunohost app install vaultwarden + sudo yunohost app install the_app ``` - *If you used the webadmin, please perform the equivalent command from the CLI first.* - *If the error occurs in your browser, explain what you did:* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..ef70e18 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +## Problem + +- *Description of why you made this PR* + +## Solution + +- *And how do you fix that problem* + +## PR Status + +- [ ] Code finished and ready to be reviewed/tested +- [ ] The fix/enhancement were manually tested (if applicable) + +## Automatic tests + +Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization) diff --git a/pull_request_template.md b/pull_request_template.md deleted file mode 100644 index 6c28fc5..0000000 --- a/pull_request_template.md +++ /dev/null @@ -1,16 +0,0 @@ -## Problem -- *Description of why you made this PR* - -## Solution -- *And how do you fix that problem* - -## PR Status -- [ ] Code finished. -- [ ] Tested with Package_check. -- [ ] Fix or enhancement tested. -- [ ] Upgrade from last version tested. -- [ ] Can be reviewed and tested. - -## Package_check results ---- -* An automatic package_check will be launch at https://ci-apps-dev.yunohost.org/, when you add a specific comment to your Pull Request: "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!"* From be299012b0c27a882f4151ad67b2ae850baf6d30 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Fri, 14 May 2021 00:26:09 +0200 Subject: [PATCH 10/12] Update ynh_send_readme_to_admin --- conf/{message => msg_install} | 0 scripts/install | 2 -- scripts/ynh_send_readme_to_admin__2 | 27 ++++++++------------------- 3 files changed, 8 insertions(+), 21 deletions(-) rename conf/{message => msg_install} (100%) diff --git a/conf/message b/conf/msg_install similarity index 100% rename from conf/message rename to conf/msg_install diff --git a/scripts/install b/scripts/install index 2f98459..cadeea8 100644 --- a/scripts/install +++ b/scripts/install @@ -217,8 +217,6 @@ ynh_systemd_action --service_name=nginx --action=reload #================================================= ynh_script_progression --message="Sending a readme for the admin..." -ynh_add_config --template="../conf/message" --destination="../conf/msg_install" - ynh_send_readme_to_admin --app_message="../conf/msg_install" --recipients="$admin_mail" --type='install' #================================================= diff --git a/scripts/ynh_send_readme_to_admin__2 b/scripts/ynh_send_readme_to_admin__2 index fc329d3..ee571cc 100644 --- a/scripts/ynh_send_readme_to_admin__2 +++ b/scripts/ynh_send_readme_to_admin__2 @@ -9,6 +9,8 @@ # If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you # example: "root admin@domain user1 user2" # | arg: -t, --type= - Type of mail, could be 'backup', 'change_url', 'install', 'remove', 'restore', 'upgrade' +# +# Requires YunoHost version 4.1.0 or higher. ynh_send_readme_to_admin() { # Declare an array to define the options of this helper. declare -Ar args_array=( [m]=app_message= [r]=recipients= [t]=type= ) @@ -23,7 +25,7 @@ ynh_send_readme_to_admin() { type="${type:-install}" # Get the value of admin_mail_html - admin_mail_html=$(ynh_app_setting_get "$app" admin_mail_html) + admin_mail_html=$(ynh_app_setting_get $app admin_mail_html) admin_mail_html="${admin_mail_html:-0}" # Retrieve the email of users @@ -68,21 +70,15 @@ ynh_send_readme_to_admin() { mail_subject="$mail_subject has just been installed!" fi + ynh_add_config --template="$app_message" --destination="../conf/msg__to_send" + + ynh_delete_file_checksum --file="../conf/msg__to_send" + local mail_message="This is an automated message from your beloved YunoHost server. Specific information for the application $app. -$(if [ -n "$app_message" ] -then - cat "$app_message" -else - echo "...No specific information..." -fi) - ---- -Automatic diagnosis data from YunoHost - -__PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')__PRE_TAG2__" +$(cat "../conf/msg__to_send")" # Store the message into a file for further modifications. echo "$mail_message" > mail_to_send @@ -103,10 +99,6 @@ __PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/service # Insert url links tags ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "\1" mail_to_send - # Insert pre tags - ynh_replace_string "__PRE_TAG1__" "
" mail_to_send
-		ynh_replace_string "__PRE_TAG2__" "<\pre>" mail_to_send
-
 		# Insert finishing HTML tags
 		echo -e "\n\n" >> mail_to_send
 
@@ -115,9 +107,6 @@ __PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/service
 		# Remove URL tags
 		ynh_replace_string "__URL_TAG[1,3]__" "" mail_to_send
 		ynh_replace_string "__URL_TAG2__" ": " mail_to_send
-
-		# Remove PRE tags
-		ynh_replace_string "__PRE_TAG[1-2]__" "" mail_to_send
 	fi
 
 	# Define binary to use for mail command

From 99e0571eb7efa48da79356df751d9b8c53ce0e01 Mon Sep 17 00:00:00 2001
From: yalh76 
Date: Sun, 6 Jun 2021 19:02:50 +0200
Subject: [PATCH 11/12] Update conf/bitwarden_migration

Co-authored-by: Alexandre Aubin 
---
 conf/bitwarden_migration | 2 --
 1 file changed, 2 deletions(-)

diff --git a/conf/bitwarden_migration b/conf/bitwarden_migration
index 3aaefa3..f5f4468 100644
--- a/conf/bitwarden_migration
+++ b/conf/bitwarden_migration
@@ -1,5 +1,3 @@
-#!/bin/bash
-
 # App main directory
 /var/www/$app
 

From 84a34da278c1edbbdf474ca509bfd69eef132c3f Mon Sep 17 00:00:00 2001
From: yalh76 
Date: Fri, 2 Jul 2021 01:05:32 +0200
Subject: [PATCH 12/12] Updating requirements

---
 manifest.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/manifest.json b/manifest.json
index 3842815..dfdc9cf 100644
--- a/manifest.json
+++ b/manifest.json
@@ -13,7 +13,7 @@
         "name": "yalh76"
     },
     "requirements": {
-        "yunohost": ">= 4.1.7.3"
+        "yunohost": ">= 4.2.0"
     },
     "multi_instance": true,
     "services": [