nihilist/acme.sh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: unify variable naming convention again (revert some changes)

Browse Source
This commit is contained in:
Scruel Tao 2024-02-26 20:55:49 +08:00
parent afed62f6de
commit 5b449999a5
1 changed files with 143 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

265
deploy/synology_dsm.sh
View File

@ -11,31 +11,31 @@
# Usage: # Usage:
# 1. Set required environment variables: # 1. Set required environment variables:
# - use automatically created temp admin user to authenticate # - use automatically created temp admin user to authenticate
# `export SYNO_UseTempAdmin=1` # `export SYNO_USE_TEMP_ADMIN=1`
# - or provide your own admin user credential to authenticate # - or provide your own admin user credential to authenticate
# 1. `export SYNO_Username="adminUser"` # 1. `export SYNO_USERNAME="adminUser"`
# 2. `export SYNO_Password="adminPassword"` # 2. `export SYNO_PASSWORD="adminPassword"`
# 2. Set optional environment variables (shown values are the defaults) # 2. Set optional environment variables (shown values are the defaults)
# - common optional variables # - common optional variables
# - `export SYNO_Scheme="http"` # - `export SYNO_SCHEME="http"`
# - `export SYNO_Hostname="localhost"` # - `export SYNO_HOSTNAME="localhost"`
# - `export SYNO_Port="5000"` # - `export SYNO_PORT="5000"`
# - `export SYNO_Create=1` - to allow creating the cert if it doesn't exist # - `export SYNO_CREATE=""` - to allow creating the cert if it doesn't exist
# - `export SYNO_Certificate=""` - to replace a specific cert by its # - `export SYNO_CERTIFICATE=""` - to replace a specific cert by its
# description # description
# - 2FA-OTP optional variables (with your own admin user) # - 2FA-OTP optional variables (with your own admin user)
# - `export SYNO_DeviceName=""` - required for 2FA-OTP, script won't require # - `export SYNO_OTP_CODE=""` - required for 2FA-OTP, script won't require
# interactive input the device name if set.
# - `export SYNO_OTPCode=""` - required for 2FA-OTP, script won't require
# interactive input the code if set. # interactive input the code if set.
# - `export SYNO_DeviceID=""` - required for omitting 2FA-OTP (might be # - `export SYNO_DEVICE_NAME=""` - required for 2FA-OTP, script won't require
# interactive input the device name if set.
# - `export SYNO_DEVICE_ID=""` - required for omitting 2FA-OTP (might be
# deprecated, auth with OTP code instead) # deprecated, auth with OTP code instead)
# 3. Run command: # 3. Run command:
# `acme.sh --deploy --deploy-hook synology_dsm -d example.com`` # `acme.sh --deploy --deploy-hook synology_dsm -d example.com``
################################################################################ ################################################################################
# Dependencies: # Dependencies:
# - curl # - curl
# - synouser & synogroup (When available and SYNO_UseTempAdmin is set) # - synouser & synogroup (When available and SYNO_USE_TEMP_ADMIN is set)
################################################################################ ################################################################################
# Return value: # Return value:
# 0 means success, otherwise error. # 0 means success, otherwise error.
@ -52,87 +52,85 @@ synology_dsm_deploy() {
_debug _cdomain "$_cdomain" _debug _cdomain "$_cdomain"
# Get username and password, but don't save until we authenticated successfully # Get username and password, but don't save until we authenticated successfully
_getdeployconf SYNO_Username _migratedeployconf SYNO_Username SYNO_USERNAME
_getdeployconf SYNO_Password _migratedeployconf SYNO_Password SYNO_PASSWORD
_getdeployconf SYNO_DeviceID _migratedeployconf SYNO_Device_ID SYNO_DEVICE_ID
_getdeployconf SYNO_DeviceName _migratedeployconf SYNO_Device_Name SYNO_DEVICE_NAME
_getdeployconf SYNO_USERNAME
_getdeployconf SYNO_PASSWORD
_getdeployconf SYNO_DEVICE_ID
_getdeployconf SYNO_DEVICE_NAME
# ## START ## - DEPRECATED, for backward compatibility # Prepare to use temp admin if SYNO_USE_TEMP_ADMIN is set
_getdeployconf SYNO_Device_ID _debug2 SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
_getdeployconf SYNO_Device_Name _getdeployconf SYNO_USE_TEMP_ADMIN
[ -n "$SYNO_DeviceID" ] || SYNO_DeviceID="${SYNO_Device_ID:-}" __check2cleardeployconfexp SYNO_USE_TEMP_ADMIN
[ -n "$SYNO_DeviceName" ] || SYNO_DeviceName="${SYNO_Device_Name:-}" _debug2 SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
# ## END ## - DEPRECATED, for backward compatibility
# Prepare to use temp admin if SYNO_UseTempAdmin is set if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
_getdeployconf SYNO_UseTempAdmin
_debug2 SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
# Back to use existing admin user if explicitly requested
if [ "$SYNO_UseTempAdmin" == "0" ]; then
_debug2 "Back to use existing user rather than temp admin user."
SYNO_UseTempAdmin=""
fi
if [ -n "$SYNO_UseTempAdmin" ]; then
if ! _exists synouser || ! _exists synogroup; then if ! _exists synouser || ! _exists synogroup; then
_err "Tools are missing for creating temp admin user, please set SYNO_Username and SYNO_Password instead." _err "Tools are missing for creating temp admin user, please set SYNO_USERNAME and SYNO_PASSWORD instead."
return 1 return 1
fi fi
[ -n "$SYNO_Username" ] || _savedeployconf SYNO_Username "" [ -n "$SYNO_USERNAME" ] || _savedeployconf SYNO_USERNAME ""
[ -n "$SYNO_Password" ] || _savedeployconf SYNO_Password "" [ -n "$SYNO_PASSWORD" ] || _savedeployconf SYNO_PASSWORD ""
_debug "Setting temp admin user credential..." _debug "Setting temp admin user credential..."
SYNO_Username=sc-acmesh-tmp SYNO_USERNAME=sc-acmesh-tmp
SYNO_Password=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 16) SYNO_PASSWORD=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 16)
# Set 2FA-OTP settings to empty consider they won't be needed. # Set 2FA-OTP settings to empty consider they won't be needed.
SYNO_DeviceID= SYNO_DEVICE_ID=
SYNO_DeviceName= SYNO_DEVICE_NAME=
SYNO_OTPCode= SYNO_OTP_CODE=
# Pre-delete temp admin user if already exists. # Pre-delete temp admin user if already exists.
synouser --del "$SYNO_Username" >/dev/null 2>/dev/null synouser --del "$SYNO_USERNAME" >/dev/null 2>/dev/null
else else
_debug2 SYNO_Username "$SYNO_Username" _debug2 SYNO_USERNAME "$SYNO_USERNAME"
_secure_debug2 SYNO_Password "$SYNO_Password" _secure_debug2 SYNO_PASSWORD "$SYNO_PASSWORD"
_debug2 SYNO_DeviceName "$SYNO_DeviceName" _debug2 SYNO_DEVICE_NAME "$SYNO_DEVICE_NAME"
_secure_debug2 SYNO_DeviceID "$SYNO_DeviceID" _secure_debug2 SYNO_DEVICE_ID "$SYNO_DEVICE_ID"
fi fi
if [ -z "$SYNO_Username" ] || [ -z "$SYNO_Password" ]; then if [ -z "$SYNO_USERNAME" ] || [ -z "$SYNO_PASSWORD" ]; then
_err "You must set either SYNO_UseTempAdmin, or set both SYNO_Username and SYNO_Password." _err "You must set either SYNO_USE_TEMP_ADMIN, or set both SYNO_USERNAME and SYNO_PASSWORD."
return 1 return 1
fi fi
# Optional scheme, hostname and port for Synology DSM # Optional scheme, hostname and port for Synology DSM
_getdeployconf SYNO_Scheme _migratedeployconf SYNO_Scheme SYNO_SCHEME
_getdeployconf SYNO_Hostname _migratedeployconf SYNO_Hostname SYNO_HOSTNAME
_getdeployconf SYNO_Port _migratedeployconf SYNO_Port SYNO_PORT
_getdeployconf SYNO_SCHEME
_getdeployconf SYNO_HOSTNAME
_getdeployconf SYNO_PORT
# Default values for scheme, hostname and port # Default values for scheme, hostname and port
# Defaulting to localhost and http, because it's localhost… # Defaulting to localhost and http, because it's localhost…
[ -n "$SYNO_Scheme" ] || SYNO_Scheme="http" [ -n "$SYNO_SCHEME" ] || SYNO_SCHEME="http"
[ -n "$SYNO_Hostname" ] || SYNO_Hostname="localhost" [ -n "$SYNO_HOSTNAME" ] || SYNO_HOSTNAME="localhost"
[ -n "$SYNO_Port" ] || SYNO_Port="5000" [ -n "$SYNO_PORT" ] || SYNO_PORT="5000"
_savedeployconf SYNO_Scheme "$SYNO_Scheme" _savedeployconf SYNO_SCHEME "$SYNO_SCHEME"
_savedeployconf SYNO_Hostname "$SYNO_Hostname" _savedeployconf SYNO_HOSTNAME "$SYNO_HOSTNAME"
_savedeployconf SYNO_Port "$SYNO_Port" _savedeployconf SYNO_PORT "$SYNO_PORT"
_debug2 SYNO_Scheme "$SYNO_Scheme" _debug2 SYNO_SCHEME "$SYNO_SCHEME"
_debug2 SYNO_Hostname "$SYNO_Hostname" _debug2 SYNO_HOSTNAME "$SYNO_HOSTNAME"
_debug2 SYNO_Port "$SYNO_Port" _debug2 SYNO_PORT "$SYNO_PORT"
# Get the certificate description, but don't save it until we verify it's real # Get the certificate description, but don't save it until we verify it's real
_getdeployconf SYNO_Certificate _migratedeployconf SYNO_Certificate SYNO_CERTIFICATE "base64"
_debug SYNO_Certificate "${SYNO_Certificate:-}" _getdeployconf SYNO_CERTIFICATE
__check2cleardeployconfexp SYNO_CERTIFICATE
_debug SYNO_CERTIFICATE "${SYNO_CERTIFICATE:-}"
# shellcheck disable=SC1003 # We are not trying to escape a single quote # shellcheck disable=SC1003 # We are not trying to escape a single quote
if printf "%s" "$SYNO_Certificate" | grep '\\'; then if printf "%s" "$SYNO_CERTIFICATE" | grep '\\'; then
_err "Do not use a backslash (\) in your certificate description" _err "Do not use a backslash (\) in your certificate description"
return 1 return 1
fi fi
_debug "Getting API version..." _debug "Getting API version..."
_base_url="$SYNO_Scheme://$SYNO_Hostname:$SYNO_Port" _base_url="$SYNO_SCHEME://$SYNO_HOSTNAME:$SYNO_PORT"
_debug _base_url "$_base_url" _debug _base_url "$_base_url"
response=$(_get "$_base_url/webapi/query.cgi?api=SYNO.API.Info&version=1&method=query&query=SYNO.API.Auth") response=$(_get "$_base_url/webapi/query.cgi?api=SYNO.API.Info&version=1&method=query&query=SYNO.API.Auth")
api_path=$(echo "$response" | grep "SYNO.API.Auth" | sed -n 's/.*"path" *: *"\([^"]*\)".*/\1/p') api_path=$(echo "$response" | grep "SYNO.API.Auth" | sed -n 's/.*"path" *: *"\([^"]*\)".*/\1/p')
@ -142,9 +140,9 @@ synology_dsm_deploy() {
_debug3 api_version "$api_version" _debug3 api_version "$api_version"
# Login, get the session ID and SynoToken from JSON # Login, get the session ID and SynoToken from JSON
_info "Logging into $SYNO_Hostname:$SYNO_Port..." _info "Logging into $SYNO_HOSTNAME:$SYNO_PORT..."
encoded_username="$(printf "%s" "$SYNO_Username" | _url_encode)" encoded_username="$(printf "%s" "$SYNO_USERNAME" | _url_encode)"
encoded_password="$(printf "%s" "$SYNO_Password" | _url_encode)" encoded_password="$(printf "%s" "$SYNO_PASSWORD" | _url_encode)"
# ## START ## - DEPRECATED, for backward compatibility # ## START ## - DEPRECATED, for backward compatibility
_getdeployconf SYNO_TOTP_SECRET _getdeployconf SYNO_TOTP_SECRET
@ -159,37 +157,37 @@ synology_dsm_deploy() {
fi fi
DEPRECATED_otp_code="$(oathtool --base32 --totp "$SYNO_TOTP_SECRET" 2>/dev/null)" DEPRECATED_otp_code="$(oathtool --base32 --totp "$SYNO_TOTP_SECRET" 2>/dev/null)"
if [ -z "$SYNO_DeviceID" ]; then if [ -z "$SYNO_DEVICE_ID" ]; then
_getdeployconf SYNO_DID _getdeployconf SYNO_DID
[ -n "$SYNO_DID" ] || SYNO_DeviceID="$SYNO_DID" [ -n "$SYNO_DID" ] || SYNO_DEVICE_ID="$SYNO_DID"
fi fi
if [ -n "$SYNO_DeviceID" ]; then if [ -n "$SYNO_DEVICE_ID" ]; then
_H1="Cookie: did=$SYNO_DeviceID" _H1="Cookie: did=$SYNO_DEVICE_ID"
export _H1 export _H1
_debug3 H1 "${_H1}" _debug3 H1 "${_H1}"
fi fi
response=$(_post "method=login&account=$encoded_username&passwd=$encoded_password&api=SYNO.API.Auth&version=$api_version&enable_syno_token=yes&otp_code=$DEPRECATED_otp_code&device_name=certrenewal&device_id=$SYNO_DeviceID" "$_base_url/webapi/auth.cgi?enable_syno_token=yes") response=$(_post "method=login&account=$encoded_username&passwd=$encoded_password&api=SYNO.API.Auth&version=$api_version&enable_syno_token=yes&otp_code=$DEPRECATED_otp_code&device_name=certrenewal&device_id=$SYNO_DEVICE_ID" "$_base_url/webapi/auth.cgi?enable_syno_token=yes")
_debug3 response "$response" _debug3 response "$response"
# ## END ## - DEPRECATED, for backward compatibility # ## END ## - DEPRECATED, for backward compatibility
# If SYNO_DeviceID or SYNO_OTPCode is set, we treat current account enabled 2FA-OTP. # If SYNO_DEVICE_ID or SYNO_OTP_CODE is set, we treat current account enabled 2FA-OTP.
# Notice that if SYNO_UseTempAdmin=1, both variables will be unset # Notice that if SYNO_USE_TEMP_ADMIN=1, both variables will be unset
else else
if [ -n "$SYNO_DeviceID" ] || [ -n "$SYNO_OTPCode" ]; then if [ -n "$SYNO_DEVICE_ID" ] || [ -n "$SYNO_OTP_CODE" ]; then
response='{"error":{"code":403}}' response='{"error":{"code":403}}'
# Assume the current account disabled 2FA-OTP, try to log in right away. # Assume the current account disabled 2FA-OTP, try to log in right away.
else else
if [ -n "$SYNO_UseTempAdmin" ]; then if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
_debug "Creating temp admin user in Synology DSM..." _debug "Creating temp admin user in Synology DSM..."
synouser --add "$SYNO_Username" "$SYNO_Password" "" 0 "scruelt@hotmail.com" 0 >/dev/null synouser --add "$SYNO_USERNAME" "$SYNO_PASSWORD" "" 0 "scruelt@hotmail.com" 0 >/dev/null
if synogroup --help | grep -q '\-\-memberadd'; then if synogroup --help | grep -q '\-\-memberadd'; then
synogroup --memberadd administrators "$SYNO_Username" >/dev/null synogroup --memberadd administrators "$SYNO_USERNAME" >/dev/null
else else
# For supporting DSM 6.x which only has `--member` parameter. # For supporting DSM 6.x which only has `--member` parameter.
cur_admins=$(synogroup --get administrators | awk -F '[][]' '/Group Members/,0{if(NF>1)printf "%s ", $2}') cur_admins=$(synogroup --get administrators | awk -F '[][]' '/Group Members/,0{if(NF>1)printf "%s ", $2}')
_secure_debug3 admin_users "$cur_admins$SYNO_Username" _secure_debug3 admin_users "$cur_admins$SYNO_USERNAME"
# shellcheck disable=SC2086 # shellcheck disable=SC2086
synogroup --member administrators $cur_admins $SYNO_Username >/dev/null synogroup --member administrators $cur_admins $SYNO_USERNAME >/dev/null
fi fi
# havig a workaround to temporary disable enforce 2FA-OTP # havig a workaround to temporary disable enforce 2FA-OTP
otp_enforce_option=$(synogetkeyvalue /etc/synoinfo.conf otp_enforce_option) otp_enforce_option=$(synogetkeyvalue /etc/synoinfo.conf otp_enforce_option)
@ -203,7 +201,7 @@ synology_dsm_deploy() {
fi fi
fi fi
response=$(_get "$_base_url/webapi/entry.cgi?api=SYNO.API.Auth&version=$api_version&method=login&format=sid&account=$encoded_username&passwd=$encoded_password&enable_syno_token=yes") response=$(_get "$_base_url/webapi/entry.cgi?api=SYNO.API.Auth&version=$api_version&method=login&format=sid&account=$encoded_username&passwd=$encoded_password&enable_syno_token=yes")
if [ -n "$SYNO_UseTempAdmin" ] && [ -n "$otp_enforce_option" ]; then if [ -n "$SYNO_USE_TEMP_ADMIN" ] && [ -n "$otp_enforce_option" ]; then
synosetkeyvalue /etc/synoinfo.conf otp_enforce_option "$otp_enforce_option" synosetkeyvalue /etc/synoinfo.conf otp_enforce_option "$otp_enforce_option"
_info "Restored previous enforce 2FA-OTP option." _info "Restored previous enforce 2FA-OTP option."
fi fi
@ -215,47 +213,47 @@ synology_dsm_deploy() {
# Account has 2FA-OTP enabled, since error 403 reported. # Account has 2FA-OTP enabled, since error 403 reported.
# https://global.download.synology.com/download/Document/Software/DeveloperGuide/Firmware/DSM/All/enu/Synology_DiskStation_Administration_CLI_Guide.pdf # https://global.download.synology.com/download/Document/Software/DeveloperGuide/Firmware/DSM/All/enu/Synology_DiskStation_Administration_CLI_Guide.pdf
if [ "$error_code" == "403" ]; then if [ "$error_code" == "403" ]; then
if [ -z "$SYNO_DeviceName" ]; then if [ -z "$SYNO_DEVICE_NAME" ]; then
printf "Enter device name or leave empty for default (CertRenewal): " printf "Enter device name or leave empty for default (CertRenewal): "
read -r SYNO_DeviceName read -r SYNO_DEVICE_NAME
[ -n "$SYNO_DeviceName" ] || SYNO_DeviceName="CertRenewal" [ -n "$SYNO_DEVICE_NAME" ] || SYNO_DEVICE_NAME="CertRenewal"
fi fi
if [ -n "$SYNO_DeviceID" ]; then if [ -n "$SYNO_DEVICE_ID" ]; then
# Omit OTP code with SYNO_DeviceID. # Omit OTP code with SYNO_DEVICE_ID.
response=$(_get "$_base_url/webapi/$api_path?api=SYNO.API.Auth&version=$api_version&method=login&format=sid&account=$encoded_username&passwd=$encoded_password&enable_syno_token=yes&device_name=$SYNO_DeviceName&device_id=$SYNO_DeviceID") response=$(_get "$_base_url/webapi/$api_path?api=SYNO.API.Auth&version=$api_version&method=login&format=sid&account=$encoded_username&passwd=$encoded_password&enable_syno_token=yes&device_name=$SYNO_DEVICE_NAME&device_id=$SYNO_DEVICE_ID")
_secure_debug3 response "$response" _secure_debug3 response "$response"
else else
# Require the OTP code if still unset. # Require the OTP code if still unset.
if [ -z "$SYNO_OTPCode" ]; then if [ -z "$SYNO_OTP_CODE" ]; then
printf "Enter OTP code for user '%s': " "$SYNO_Username" printf "Enter OTP code for user '%s': " "$SYNO_USERNAME"
read -r SYNO_OTPCode read -r SYNO_OTP_CODE
fi fi
if [ -z "$SYNO_OTPCode" ]; then if [ -z "$SYNO_OTP_CODE" ]; then
response='{"error":{"code":404}}' response='{"error":{"code":404}}'
else else
response=$(_get "$_base_url/webapi/$api_path?api=SYNO.API.Auth&version=$api_version&method=login&format=sid&account=$encoded_username&passwd=$encoded_password&enable_syno_token=yes&enable_device_token=yes&device_name=$SYNO_DeviceName&otp_code=$SYNO_OTPCode") response=$(_get "$_base_url/webapi/$api_path?api=SYNO.API.Auth&version=$api_version&method=login&format=sid&account=$encoded_username&passwd=$encoded_password&enable_syno_token=yes&enable_device_token=yes&device_name=$SYNO_DEVICE_NAME&otp_code=$SYNO_OTP_CODE")
_secure_debug3 response "$response" _secure_debug3 response "$response"
id_property='device_id' id_property='device_id'
[ "${api_version}" -gt '6' ] || id_property='did' [ "${api_version}" -gt '6' ] || id_property='did'
SYNO_DeviceID=$(echo "$response" | grep "$id_property" | sed -n 's/.*"'$id_property'" *: *"\([^"]*\).*/\1/p') SYNO_DEVICE_ID=$(echo "$response" | grep "$id_property" | sed -n 's/.*"'$id_property'" *: *"\([^"]*\).*/\1/p')
_secure_debug2 SYNO_DeviceID "$SYNO_DeviceID" _secure_debug2 SYNO_DEVICE_ID "$SYNO_DEVICE_ID"
fi fi
fi fi
error_code=$(echo "$response" | grep '"error"' | grep -oP '(?<="code":)\d+') error_code=$(echo "$response" | grep '"error"' | grep -oP '(?<="code":)\d+')
fi fi
if [ -n "$error_code" ]; then if [ -n "$error_code" ]; then
if [ "$error_code" == "403" ] && [ -n "$SYNO_DeviceID" ]; then if [ "$error_code" == "403" ] && [ -n "$SYNO_DEVICE_ID" ]; then
_savedeployconf SYNO_DeviceID "" _cleardeployconf SYNO_DEVICE_ID
_err "Failed to authenticate with SYNO_DeviceID (may expired or invalid), please try again in a new terminal window." _err "Failed to authenticate with SYNO_DEVICE_ID (may expired or invalid), please try again in a new terminal window."
elif [ "$error_code" == "404" ]; then elif [ "$error_code" == "404" ]; then
_err "Failed to authenticate with provided 2FA-OTP code, please try again in a new terminal window." _err "Failed to authenticate with provided 2FA-OTP code, please try again in a new terminal window."
elif [ "$error_code" == "406" ]; then elif [ "$error_code" == "406" ]; then
if [ -n "$SYNO_UseTempAdmin" ]; then if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
_err "SYNO_UseTempAdmin=1 is not supported if enforce auth with 2FA-OTP is enabled." _err "SYNO_USE_TEMP_ADMIN=1 is not supported if enforce auth with 2FA-OTP is enabled."
else else
_err "Enforce auth with 2FA-OTP enabled, please configure the user to enable 2FA-OTP to continue." _err "Enforce auth with 2FA-OTP enabled, please configure the user to enable 2FA-OTP to continue."
fi fi
@ -264,7 +262,7 @@ synology_dsm_deploy() {
else else
_err "Failed to authenticate with error: $error_code." _err "Failed to authenticate with error: $error_code."
fi fi
_temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username" _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
return 1 return 1
fi fi
@ -275,7 +273,7 @@ synology_dsm_deploy() {
if [ -z "$sid" ] || [ -z "$token" ]; then if [ -z "$sid" ] || [ -z "$token" ]; then
# Still can't get necessary info even got no errors, may Synology have API updated? # Still can't get necessary info even got no errors, may Synology have API updated?
_err "Unable to authenticate to $_base_url, you may report the full log to the community." _err "Unable to authenticate to $_base_url, you may report the full log to the community."
_temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username" _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
return 1 return 1
fi fi
@ -284,21 +282,23 @@ synology_dsm_deploy() {
_debug2 H1 "${_H1}" _debug2 H1 "${_H1}"
# Now that we know the username and password are good, save them if not in temp admin mode. # Now that we know the username and password are good, save them if not in temp admin mode.
if [ -n "$SYNO_UseTempAdmin" ]; then if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
_savedeployconf SYNO_Username "" _cleardeployconf SYNO_USERNAME
_savedeployconf SYNO_Password "" _cleardeployconf SYNO_PASSWORD
_savedeployconf SYNO_UseTempAdmin "$SYNO_UseTempAdmin" _cleardeployconf SYNO_DEVICE_ID
_cleardeployconf SYNO_DEVICE_NAME
_savedeployconf SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
else else
_savedeployconf SYNO_Username "$SYNO_Username" _savedeployconf SYNO_USERNAME "$SYNO_USERNAME"
_savedeployconf SYNO_Password "$SYNO_Password" _savedeployconf SYNO_PASSWORD "$SYNO_PASSWORD"
_savedeployconf SYNO_DEVICE_ID "$SYNO_DEVICE_ID"
_savedeployconf SYNO_DEVICE_NAME "$SYNO_DEVICE_NAME"
fi fi
_savedeployconf SYNO_DeviceID "$SYNO_DeviceID"
_savedeployconf SYNO_DeviceName "$SYNO_DeviceName"
_info "Getting certificates in Synology DSM..." _info "Getting certificates in Synology DSM..."
response=$(_post "api=SYNO.Core.Certificate.CRT&method=list&version=1&_sid=$sid" "$_base_url/webapi/entry.cgi") response=$(_post "api=SYNO.Core.Certificate.CRT&method=list&version=1&_sid=$sid" "$_base_url/webapi/entry.cgi")
_debug3 response "$response" _debug3 response "$response"
escaped_certificate="$(printf "%s" "$SYNO_Certificate" | sed 's/\([].*^$[]\)/\\\1/g;s/"/\\\\"/g')" escaped_certificate="$(printf "%s" "$SYNO_CERTIFICATE" | sed 's/\([].*^$[]\)/\\\1/g;s/"/\\\\"/g')"
_debug escaped_certificate "$escaped_certificate" _debug escaped_certificate "$escaped_certificate"
id=$(echo "$response" | sed -n "s/.*\"desc\":\"$escaped_certificate\",\"id\":\"\([^\"]*\).*/\1/p") id=$(echo "$response" | sed -n "s/.*\"desc\":\"$escaped_certificate\",\"id\":\"\([^\"]*\).*/\1/p")
_debug2 id "$id" _debug2 id "$id"
@ -310,22 +310,22 @@ synology_dsm_deploy() {
else else
_err "Failed to fetch certificate info with error: $error_code, contact Synology for more info about it." _err "Failed to fetch certificate info with error: $error_code, contact Synology for more info about it."
fi fi
_temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username" _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
return 1 return 1
fi fi
_getdeployconf SYNO_Create _migratedeployconf SYNO_Create SYNO_CREATE
_debug2 SYNO_Create "$SYNO_Create" _getdeployconf SYNO_CREATE
[ -n "$SYNO_Create" ] || SYNO_Create=1 _debug2 SYNO_CREATE "$SYNO_CREATE"
if [ -z "$id" ] && [ -z "$SYNO_Create" ]; then if [ -z "$id" ] && [ -z "$SYNO_CREATE" ]; then
_err "Unable to find certificate: $SYNO_Certificate and $SYNO_Create is not set." _err "Unable to find certificate: $SYNO_CERTIFICATE and $SYNO_CREATE is not set."
_temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username" _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
return 1 return 1
fi fi
# We've verified this certificate description is a thing, so save it # We've verified this certificate description is a thing, so save it
_savedeployconf SYNO_Certificate "$SYNO_Certificate" "base64" _savedeployconf SYNO_CERTIFICATE "$SYNO_CERTIFICATE" "base64"
_info "Generating form POST request..." _info "Generating form POST request..."
nl="\0015\0012" nl="\0015\0012"
@ -334,7 +334,7 @@ synology_dsm_deploy() {
content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"cert\"; filename=\"$(basename "$_ccert")\"${nl}Content-Type: application/octet-stream${nl}${nl}$(cat "$_ccert")\0012" content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"cert\"; filename=\"$(basename "$_ccert")\"${nl}Content-Type: application/octet-stream${nl}${nl}$(cat "$_ccert")\0012"
content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"inter_cert\"; filename=\"$(basename "$_cca")\"${nl}Content-Type: application/octet-stream${nl}${nl}$(cat "$_cca")\0012" content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"inter_cert\"; filename=\"$(basename "$_cca")\"${nl}Content-Type: application/octet-stream${nl}${nl}$(cat "$_cca")\0012"
content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"id\"${nl}${nl}$id" content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"id\"${nl}${nl}$id"
content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"desc\"${nl}${nl}${SYNO_Certificate}" content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"desc\"${nl}${nl}${SYNO_CERTIFICATE}"
if echo "$response" | sed -n "s/.*\"desc\":\"$escaped_certificate\",\([^{]*\).*/\1/p" | grep -- 'is_default":true' >/dev/null; then if echo "$response" | sed -n "s/.*\"desc\":\"$escaped_certificate\",\([^{]*\).*/\1/p" | grep -- 'is_default":true' >/dev/null; then
_debug2 default "This is the default certificate" _debug2 default "This is the default certificate"
content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"as_default\"${nl}${nl}true" content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"as_default\"${nl}${nl}true"
@ -355,11 +355,11 @@ synology_dsm_deploy() {
else else
_info "Restart HTTP services failed." _info "Restart HTTP services failed."
fi fi
_temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username" _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
_logout _logout
return 0 return 0
else else
_temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username" _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
_err "Unable to update certificate, got error response: $response." _err "Unable to update certificate, got error response: $response."
_logout _logout
return 1 return 1
@ -382,3 +382,24 @@ _temp_admin_cleanup() {
synouser --del "$username" >/dev/null synouser --del "$username" >/dev/null
fi fi
} }
#_cleardeployconf key
_cleardeployconf() {
_cleardomainconf "SAVED_$1"
}
# key
__check2cleardeployconfexp() {
# Warning:
_key="$1"
_clear_key="CLEAR_$_key"
# Clear saved settings if explicitly requested
if [ -n "$(eval echo \$$_clear_key)" ]; then
_debug2 "$_key: value cleared from config, exported value will be ignored."
_cleardeployconf "$_key"
eval $_key=
export $_key=
eval SAVED_$_key=
export SAVED_$_key=
fi
}