From cf3839ececc8d53bb55446958f7345bb1f8f8c4c Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Thu, 22 Feb 2024 12:38:51 +0800
Subject: [PATCH 01/13] doc(deploy): update usage doc

---
 deploy/synology_dsm.sh | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index 55898a6f..09d02c2a 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -9,12 +9,13 @@
 # Issues:  https://github.com/acmesh-official/acme.sh/issues/2727
 ################################################################################
 # Usage:
+# 1. Set required environment variables (two ways):
 # - Create temp admin user automatically:
 #   export SYNO_USE_TEMP_ADMIN=1
 # - Or provide your own admin user credential:
 #   1. export SYNO_Username="adminUser"
 #   2. export SYNO_Password="adminPassword"
-# Optional exports (shown values are the defaults):
+# 2. Set optional environment variables (shown values are the defaults):
 # - export SYNO_Certificate="" - to replace a specific certificate via description
 # - export SYNO_Scheme="http"
 # - export SYNO_Hostname="localhost"
@@ -22,7 +23,8 @@
 # - export SYNO_Create=1   - to allow creating the certificate if it doesn't exist
 # - export SYNO_Device_Name="CertRenewal" - required if 2FA-OTP enabled
 # - export SYNO_Device_ID=""              - required for skipping 2FA-OTP
-# 3. acme.sh --deploy --deploy-hook synology_dsm -d example.com
+# 3. Run command:
+# acme.sh --deploy --deploy-hook synology_dsm -d example.com
 ################################################################################
 # Dependencies:
 # - jq & curl

From f840f7d75b736e9c9cc2166cb194e175ef3e88b0 Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Fri, 23 Feb 2024 19:58:24 +0800
Subject: [PATCH 02/13] refactor: unify variable naming convention

---
 deploy/synology_dsm.sh | 210 ++++++++++++++++++++++-------------------
 1 file changed, 115 insertions(+), 95 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index 09d02c2a..d39d0c22 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -10,25 +10,26 @@
 ################################################################################
 # Usage:
 # 1. Set required environment variables (two ways):
-# - Create temp admin user automatically:
-#   export SYNO_USE_TEMP_ADMIN=1
-# - Or provide your own admin user credential:
-#   1. export SYNO_Username="adminUser"
-#   2. export SYNO_Password="adminPassword"
-# 2. Set optional environment variables (shown values are the defaults):
-# - export SYNO_Certificate="" - to replace a specific certificate via description
-# - export SYNO_Scheme="http"
-# - export SYNO_Hostname="localhost"
-# - export SYNO_Port="5000"
-# - export SYNO_Create=1   - to allow creating the certificate if it doesn't exist
-# - export SYNO_Device_Name="CertRenewal" - required if 2FA-OTP enabled
-# - export SYNO_Device_ID=""              - required for skipping 2FA-OTP
+# - Create temp admin user automatically
+#   `export SYNO_UseTempAdmin=1`
+# - Or provide your own admin user credential by:
+#   1. `export SYNO_Username="adminUser"`
+#   2. `export SYNO_Password="adminPassword"`
+# 2. Set optional environment variables (shown values are the defaults)
+# - `export SYNO_Scheme="http"`
+# - `export SYNO_Hostname="localhost"`
+# - `export SYNO_Port="5000"`
+# - `export SYNO_Create=1` - to allow creating the cert if it doesn't exist
+# - `export SYNO_Certificate=""` - to replace a specific cert by its description
+# - `export SYNO_DeviceName=""`  - required for 2FA-OTP
+# - `export SYNO_DeviceID=""`    - required for omitting 2FA-OTP (only pro
+#                                  users may set)
 # 3. Run command:
 # acme.sh --deploy --deploy-hook synology_dsm -d example.com
 ################################################################################
 # Dependencies:
 # - jq & curl
-# - synouser & synogroup (When available and SYNO_USE_TEMP_ADMIN is set)
+# - synouser & synogroup (When available and SYNO_UseTempAdmin is set)
 ################################################################################
 # Return value:
 # 0 means success, otherwise error.
@@ -44,53 +45,66 @@ synology_dsm_deploy() {
 
   _debug _cdomain "$_cdomain"
 
-  # Get username & password, but don't save until we authenticated successfully
-  _getdeployconf SYNO_USE_TEMP_ADMIN
+  # Get username and password, but don't save until we authenticated successfully
   _getdeployconf SYNO_Username
   _getdeployconf SYNO_Password
+  _getdeployconf SYNO_DeviceName
+  _getdeployconf SYNO_DeviceID
   _getdeployconf SYNO_Create
-  _getdeployconf SYNO_DID
-  _getdeployconf SYNO_TOTP_SECRET
-  _getdeployconf SYNO_Device_Name
+
+  # ## START ## - DEPRECATED, for backward compatibility
   _getdeployconf SYNO_Device_ID
+  _getdeployconf SYNO_Device_Name
+  [ -n "$SYNO_DeviceID" ] || SYNO_DeviceID="$SYNO_Device_ID"
+  [ -n "$SYNO_DeviceName" ] || SYNO_DeviceName="$SYNO_Device_Name"
+  # ## END ## - DEPRECATED, for backward compatibility
+  [ -n "$SYNO_Create" ] || SYNO_Create=1
+
+  # Prepare to use temp admin if SYNO_UseTempAdmin is set
+  _getdeployconf SYNO_UseTempAdmin
+  _debug2 SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
 
-  # Prepare temp admin user info if SYNO_USE_TEMP_ADMIN is set
-  if [ -n "${SYNO_USE_TEMP_ADMIN:-}" ]; then
-    if ! _exists synouser; then
-      if ! _exists synogroup; then
-        _err "Tools are missing for creating temp admin user, please set SYNO_Username & SYNO_Password instead."
-        return 1
-      fi
+  if [ -n "$SYNO_UseTempAdmin" ]; then
+    if ! _exists synouser || ! _exists synogroup; then
+      _err "Tools are missing for creating temp admin user, please set SYNO_Username and SYNO_Password instead."
+      return 1
     fi
+    # Clean up
+    [ -n "$SYNO_Username" ] || _savedeployconf SYNO_Username ""
+    [ -n "$SYNO_Password" ] || _savedeployconf SYNO_Password ""
+    synouser --del "$SYNO_Username" >/dev/null 2>/dev/null
+
     _debug "Setting temp admin user credential..."
     SYNO_Username=sc-acmesh-tmp
     SYNO_Password=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 16)
     # Ignore 2FA-OTP settings which won't be needed.
-    SYNO_Device_Name=
-    SYNO_Device_ID=
+    SYNO_DeviceID=
+    SYNO_DeviceName=
+
+    _savedeployconf SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
+  else
+    _debug2 SYNO_Username "$SYNO_Username"
+    _secure_debug2 SYNO_Password "$SYNO_Password"
+    _debug2 SYNO_Create "$SYNO_Create"
+    _debug2 SYNO_DeviceName "$SYNO_DeviceName"
+    _secure_debug2 SYNO_DeviceID "$SYNO_DeviceID"
   fi
 
-  if [ -z "${SYNO_Username:-}" ] || [ -z "${SYNO_Password:-}" ]; then
-    _err "You must set either SYNO_USE_TEMP_ADMIN, or set both SYNO_Username and SYNO_Password."
+  if [ -z "$SYNO_Username" ] || [ -z "$SYNO_Password" ]; then
+    _err "You must set either SYNO_UseTempAdmin, or set both SYNO_Username and SYNO_Password."
     return 1
   fi
-  _debug2 SYNO_Username "$SYNO_Username"
-  _secure_debug2 SYNO_Password "$SYNO_Password"
-  _debug2 SYNO_Create "$SYNO_Create"
-  _debug2 SYNO_Device_Name "$SYNO_Device_Name"
-  _secure_debug2 SYNO_Device_ID "$SYNO_Device_ID"
 
-  # Optional scheme, hostname & port for Synology DSM
+  # Optional scheme, hostname and port for Synology DSM
   _getdeployconf SYNO_Scheme
   _getdeployconf SYNO_Hostname
   _getdeployconf SYNO_Port
 
-  # Default values for scheme, hostname & port
-  # Defaulting to localhost & http, because it's localhost…
-  [ -n "${SYNO_Scheme}" ] || SYNO_Scheme="http"
-  [ -n "${SYNO_Hostname}" ] || SYNO_Hostname="localhost"
-  [ -n "${SYNO_Port}" ] || SYNO_Port="5000"
-  _savedeployconf SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
+  # Default values for scheme, hostname and port
+  # Defaulting to localhost and http, because it's localhost…
+  [ -n "$SYNO_Scheme" ] || SYNO_Scheme="http"
+  [ -n "$SYNO_Hostname" ] || SYNO_Hostname="localhost"
+  [ -n "$SYNO_Port" ] || SYNO_Port="5000"
   _savedeployconf SYNO_Scheme "$SYNO_Scheme"
   _savedeployconf SYNO_Hostname "$SYNO_Hostname"
   _savedeployconf SYNO_Port "$SYNO_Port"
@@ -100,7 +114,7 @@ synology_dsm_deploy() {
 
   # Get the certificate description, but don't save it until we verify it's real
   _getdeployconf SYNO_Certificate
-  _debug SYNO_Certificate "${SYNO_Certificate:-}"
+  _debug SYNO_Certificate "$SYNO_Certificate"
 
   # shellcheck disable=SC1003 # We are not trying to escape a single quote
   if printf "%s" "$SYNO_Certificate" | grep '\\'; then
@@ -108,10 +122,16 @@ synology_dsm_deploy() {
     return 1
   fi
 
+  if [ -n "$SYNO_UseTempAdmin" ]; then
+    _debug "Creating temp admin user in Synology DSM..."
+    synouser --add "$SYNO_Username" "$SYNO_Password" "" 0 "scruelt@hotmail.com" 0 >/dev/null
+    synogroup --memberadd administrators "$SYNO_Username" >/dev/null
+  fi
+
   _base_url="$SYNO_Scheme://$SYNO_Hostname:$SYNO_Port"
   _debug _base_url "$_base_url"
 
-  _debug "Getting API version"
+  _debug "Getting API version..."
   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_version=$(echo "$response" | grep "SYNO.API.Auth" | sed -n 's/.*"maxVersion" *: *\([0-9]*\).*/\1/p')
@@ -119,13 +139,15 @@ synology_dsm_deploy() {
   _debug3 api_path "$api_path"
   _debug3 api_version "$api_version"
 
-  # Login, get the session ID & SynoToken from JSON
-  _info "Logging into $SYNO_Hostname:$SYNO_Port"
+  # Login, get the session ID and SynoToken from JSON
+  _info "Logging into $SYNO_Hostname:$SYNO_Port..."
   encoded_username="$(printf "%s" "$SYNO_Username" | _url_encode)"
   encoded_password="$(printf "%s" "$SYNO_Password" | _url_encode)"
 
   otp_code=""
-  # START - DEPRECATED, only kept for legacy compatibility reasons
+  # ## START ## - DEPRECATED, for backward compatibility
+  _getdeployconf SYNO_TOTP_SECRET
+
   if [ -n "$SYNO_TOTP_SECRET" ]; then
     _info "WARNING: Usage of SYNO_TOTP_SECRET is deprecated!"
     _info "         See synology_dsm.sh script or ACME.sh Wiki page for details:"
@@ -134,47 +156,45 @@ synology_dsm_deploy() {
       _err "oathtool could not be found, install oathtool to use SYNO_TOTP_SECRET"
       return 1
     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 [ -n "$SYNO_DID" ]; then
-      _H1="Cookie: did=$SYNO_DID"
+    if [ -z "$SYNO_DeviceID" ]; then
+      _getdeployconf SYNO_DID
+      [ -n "$SYNO_DID" ] || SYNO_DeviceID="$SYNO_DID"
+    fi
+    if [ -n "$SYNO_DeviceID" ]; then
+      _H1="Cookie: did=$SYNO_DeviceID"
       export _H1
       _debug3 H1 "${_H1}"
     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_DID" "$_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_DeviceID" "$_base_url/webapi/auth.cgi?enable_syno_token=yes")
     _debug3 response "$response"
-  # END - DEPRECATED, only kept for legacy compatibility reasons
-  # If SYNO_DeviceDevice_ID & SYNO_Device_Name both empty, just log in normally
-  elif [ -z "${SYNO_Device_ID:-}" ] && [ -z "${SYNO_Device_Name:-}" ]; then
-    if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
-      _debug "Creating temp admin user in Synology DSM"
-      synouser --del "$SYNO_Username" >/dev/null 2>/dev/null
-      synouser --add "$SYNO_Username" "$SYNO_Password" "" 0 "" 0 >/dev/null
-      synogroup --memberadd administrators "$SYNO_Username" >/dev/null
-    fi
+  # ## END ## - DEPRECATED, for backward compatibility
+  # If SYNO_Device_ID & SYNO_DeviceName both empty, just log in normally
+  elif [ -z "${SYNO_DeviceID:-}" ] && [ -z "${SYNO_DeviceName:-}" ]; then
     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")
     _debug3 response "$response"
   # Get device ID if still empty first, otherwise log in right away
-  # If SYNO_Device_Name is set, we treat that account enabled two-factor authorization, consider SYNO_Device_ID is not set, so it won't be able to login without requiring the OTP code.
-  elif [ -n "${SYNO_Device_Name:-}" ] && [ -z "${SYNO_Device_ID:-}" ]; then
-    printf "Enter OTP code for user '%s': " "$SYNO_Username"
-    read -r otp_code
-    response=$(_get "$_base_url/webapi/$api_path?api=SYNO.API.Auth&version=$api_version&method=login&format=sid&account=$encoded_username&passwd=$encoded_password&otp_code=$otp_code&enable_syno_token=yes&enable_device_token=yes&device_name=$SYNO_Device_Name")
-    _secure_debug3 response "$response"
+  # If SYNO_DeviceName is set, we treat that account enabled two-factor authorization, consider SYNO_DeviceID is not set, so it won't be able to login without requiring the OTP code.
+  elif [ -n "${SYNO_DeviceName:-}" ] && [ -z "${SYNO_DeviceID:-}" ]; then
+        printf "Enter OTP code for user '%s': " "$SYNO_Username"
+        read -r otp_code
+        response=$(_get "$_base_url/webapi/$api_path?api=SYNO.API.Auth&version=$api_version&method=login&format=sid&account=$encoded_username&passwd=$encoded_password&otp_code=$otp_code&enable_syno_token=yes&enable_device_token=yes&device_name=$SYNO_DeviceName")
+        _secure_debug3 response "$response"
 
-    id_property='device_id'
-    [ "${api_version}" -gt '6' ] || id_property='did'
-    SYNO_Device_ID=$(echo "$response" | grep "$id_property" | sed -n 's/.*"'$id_property'" *: *"\([^"]*\).*/\1/p')
-    _secure_debug2 SYNO_Device_ID "$SYNO_Device_ID"
-  # Otherwise, if SYNO_Device_ID is set, we can just use it to login.
+        id_property='device_id'
+        [ "${api_version}" -gt '6' ] || id_property='did'
+        SYNO_DeviceID=$(echo "$response" | grep "$id_property" | sed -n 's/.*"'$id_property'" *: *"\([^"]*\).*/\1/p')
+        _secure_debug2 SYNO_DeviceID "$SYNO_DeviceID"
+  # Otherwise, if SYNO_DeviceID is set, we can just use it to login.
   else
-    if [ -z "${SYNO_Device_Name:-}" ]; then
+    if [ -z "${SYNO_DeviceName:-}" ]; then
       printf "Enter device name or leave empty for default (CertRenewal): "
-      read -r SYNO_Device_Name
-      [ -n "${SYNO_Device_Name}" ] || SYNO_Device_Name="CertRenewal"
+      read -r SYNO_DeviceName
+      [ -n "${SYNO_DeviceName}" ] || SYNO_DeviceName="CertRenewal"
     fi
-    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")
+    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")
     _secure_debug3 response "$response"
   fi
 
@@ -185,8 +205,8 @@ synology_dsm_deploy() {
   if [ -z "$sid" ] || [ -z "$token" ]; then
     _err "Unable to authenticate to $_base_url - check your username & password."
     _err "If two-factor authentication is enabled for the user:"
-    _err "- set SYNO_Device_Name then input *correct* OTP-code manually"
-    _err "- get & set SYNO_Device_ID via your browser cookies"
+    _err "- set SYNO_DeviceName then input *correct* OTP-code manually"
+    _err "- get & set SYNO_DeviceID via your browser cookies"
     _remove_temp_admin "$SYNO_USE_TEMP_ADMIN" "$SYNO_Username"
     return 1
   fi
@@ -195,15 +215,15 @@ synology_dsm_deploy() {
   export _H1
   _debug2 H1 "${_H1}"
 
-  # Now that we know the username & password are good, save them
-  _savedeployconf SYNO_Username "$SYNO_Username"
-  _savedeployconf SYNO_Password "$SYNO_Password"
-  if [ -z "${SYNO_USE_TEMP_ADMIN:-}" ]; then
-    _savedeployconf SYNO_Device_Name "$SYNO_Device_Name"
-    _savedeployconf SYNO_Device_ID "$SYNO_Device_ID"
+  # Now that we know the username and password are good, save them if not in temp admin mode.
+  if [ -z "$SYNO_UseTempAdmin" ]; then
+    _savedeployconf SYNO_Username "$SYNO_Username"
+    _savedeployconf SYNO_Password "$SYNO_Password"
+    _savedeployconf SYNO_DeviceID "$SYNO_DeviceID"
+    _savedeployconf SYNO_DeviceName "$SYNO_DeviceName"
   fi
 
-  _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")
   _debug3 response "$response"
   escaped_certificate="$(printf "%s" "$SYNO_Certificate" | sed 's/\([].*^$[]\)/\\\1/g;s/"/\\\\"/g')"
@@ -211,16 +231,16 @@ synology_dsm_deploy() {
   id=$(echo "$response" | sed -n "s/.*\"desc\":\"$escaped_certificate\",\"id\":\"\([^\"]*\).*/\1/p")
   _debug2 id "$id"
 
-  if [ -z "$id" ] && [ -z "${SYNO_Create:-}" ]; then
-    _err "Unable to find certificate: $SYNO_Certificate & \$SYNO_Create is not set"
-    _remove_temp_admin "$SYNO_USE_TEMP_ADMIN" "$SYNO_Username"
+  if [ -z "$id" ] && [ -z "$SYNO_Create" ]; then
+    _err "Unable to find certificate: $SYNO_Certificate and $SYNO_Create is not set."
+    _remove_temp_admin "$SYNO_UseTempAdmin" "$SYNO_Username"
     return 1
   fi
 
   # We've verified this certificate description is a thing, so save it
   _savedeployconf SYNO_Certificate "$SYNO_Certificate" "base64"
 
-  _info "Generate form POST request"
+  _info "Generating form POST request.."
   nl="\0015\0012"
   delim="--------------------------$(_utc_date | tr -d -- '-: ')"
   content="--$delim${nl}Content-Disposition: form-data; name=\"key\"; filename=\"$(basename "$_ckey")\"${nl}Content-Type: application/octet-stream${nl}${nl}$(cat "$_ckey")\0012"
@@ -238,22 +258,22 @@ synology_dsm_deploy() {
   content="$(printf "%b_" "$content")"
   content="${content%_}" # protect trailing \n
 
-  _info "Upload certificate to the Synology DSM"
+  _info "Upload certificate to the Synology DSM."
   response=$(_post "$content" "$_base_url/webapi/entry.cgi?api=SYNO.Core.Certificate&method=import&version=1&SynoToken=$token&_sid=$sid" "" "POST" "multipart/form-data; boundary=${delim}")
   _debug3 response "$response"
 
   if ! echo "$response" | grep '"error":' >/dev/null; then
     if echo "$response" | grep '"restart_httpd":true' >/dev/null; then
-      _info "Restarting HTTP services succeeded"
+      _info "Restarting HTTP services succeeded..."
     else
-      _info "Restarting HTTP services failed"
+      _info "Restarting HTTP services failed."
     fi
-    _remove_temp_admin "$SYNO_USE_TEMP_ADMIN" "$SYNO_Username"
+    _remove_temp_admin "$SYNO_UseTempAdmin" "$SYNO_Username"
     _logout
     return 0
   else
-    _remove_temp_admin "$SYNO_USE_TEMP_ADMIN" "$SYNO_Username"
-    _err "Unable to update certificate, error code $response"
+    _remove_temp_admin "$SYNO_UseTempAdmin" "$SYNO_Username"
+    _err "Unable to update certificate, error code $response."
     _logout
     return 1
   fi
@@ -271,7 +291,7 @@ _remove_temp_admin() {
   username=$2
 
   if [ -n "${flag}" ]; then
-    _debug "Removing temp admin user in Synology DSM"
+    _debug "Removing temp admin user in Synology DSM..."
     synouser --del "$username" >/dev/null
   fi
 }

From 7248560169b1c76d6821fdb459bd7125f0a850dc Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Fri, 23 Feb 2024 20:00:00 +0800
Subject: [PATCH 03/13] feat: support DSM 6.x

---
 deploy/synology_dsm.sh | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index d39d0c22..cd8ef239 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -122,16 +122,23 @@ synology_dsm_deploy() {
     return 1
   fi
 
+  # Create temp admin user
   if [ -n "$SYNO_UseTempAdmin" ]; then
     _debug "Creating temp admin user in Synology DSM..."
     synouser --add "$SYNO_Username" "$SYNO_Password" "" 0 "scruelt@hotmail.com" 0 >/dev/null
-    synogroup --memberadd administrators "$SYNO_Username" >/dev/null
+    if [ -n "$(synogroup --help | grep '\-\-memberadd')" ]; then
+      synogroup --memberaddx administrators "$SYNO_Username" >/dev/null
+    else
+      # 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}')
+      _secure_debug3 admin_users "$cur_admins$SYNO_Username"
+      synogroup --memberx administrators $cur_admins $SYNO_Username >/dev/null
+    fi
   fi
 
+  _debug "Getting API version..."
   _base_url="$SYNO_Scheme://$SYNO_Hostname:$SYNO_Port"
   _debug _base_url "$_base_url"
-
-  _debug "Getting API version..."
   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_version=$(echo "$response" | grep "SYNO.API.Auth" | sed -n 's/.*"maxVersion" *: *\([0-9]*\).*/\1/p')

From dbe0d477d6de710cd390eaa6a13b5be3cdd10f16 Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Mon, 26 Feb 2024 04:50:30 +0800
Subject: [PATCH 04/13] feat: more user-friendly logic & error messages.

---
 deploy/synology_dsm.sh | 206 +++++++++++++++++++++++++++--------------
 1 file changed, 136 insertions(+), 70 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index cd8ef239..0a2bdf7a 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -9,26 +9,33 @@
 # Issues:  https://github.com/acmesh-official/acme.sh/issues/2727
 ################################################################################
 # Usage:
-# 1. Set required environment variables (two ways):
-# - Create temp admin user automatically
-#   `export SYNO_UseTempAdmin=1`
-# - Or provide your own admin user credential by:
+# 1. Set required environment variables:
+# - use automatically created temp admin user to authenticate
+#   1. disable "enfore 2FA-OTP for admins" via control panel
+#   2. `export SYNO_UseTempAdmin=1`
+# - or provide your own admin user credential to authenticate
 #   1. `export SYNO_Username="adminUser"`
 #   2. `export SYNO_Password="adminPassword"`
 # 2. Set optional environment variables (shown values are the defaults)
-# - `export SYNO_Scheme="http"`
-# - `export SYNO_Hostname="localhost"`
-# - `export SYNO_Port="5000"`
-# - `export SYNO_Create=1` - to allow creating the cert if it doesn't exist
-# - `export SYNO_Certificate=""` - to replace a specific cert by its description
-# - `export SYNO_DeviceName=""`  - required for 2FA-OTP
-# - `export SYNO_DeviceID=""`    - required for omitting 2FA-OTP (only pro
-#                                  users may set)
+# - common optional variables
+#   - `export SYNO_Scheme="http"`
+#   - `export SYNO_Hostname="localhost"`
+#   - `export SYNO_Port="5000"`
+#   - `export SYNO_Create=1` - to allow creating the cert if it doesn't exist
+#   - `export SYNO_Certificate=""` - to replace a specific cert by its
+#                                    description
+# - 2FA-OTP optional variables (with your own admin user)
+#   - `export SYNO_DeviceName=""`  - 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.
+#   - `export SYNO_DeviceID=""`    - required for omitting 2FA-OTP (might be
+#                                    deprecated, auth with OTP code instead)
 # 3. Run command:
 # acme.sh --deploy --deploy-hook synology_dsm -d example.com
 ################################################################################
 # Dependencies:
-# - jq & curl
+# - curl
 # - synouser & synogroup (When available and SYNO_UseTempAdmin is set)
 ################################################################################
 # Return value:
@@ -48,44 +55,48 @@ synology_dsm_deploy() {
   # Get username and password, but don't save until we authenticated successfully
   _getdeployconf SYNO_Username
   _getdeployconf SYNO_Password
-  _getdeployconf SYNO_DeviceName
   _getdeployconf SYNO_DeviceID
-  _getdeployconf SYNO_Create
+  _getdeployconf SYNO_DeviceName
 
   # ## START ## - DEPRECATED, for backward compatibility
   _getdeployconf SYNO_Device_ID
   _getdeployconf SYNO_Device_Name
-  [ -n "$SYNO_DeviceID" ] || SYNO_DeviceID="$SYNO_Device_ID"
-  [ -n "$SYNO_DeviceName" ] || SYNO_DeviceName="$SYNO_Device_Name"
+  [ -n "$SYNO_DeviceID" ] || SYNO_DeviceID="${SYNO_Device_ID:-}"
+  [ -n "$SYNO_DeviceName" ] || SYNO_DeviceName="${SYNO_Device_Name:-}"
   # ## END ## - DEPRECATED, for backward compatibility
-  [ -n "$SYNO_Create" ] || SYNO_Create=1
 
   # Prepare to use temp admin if SYNO_UseTempAdmin is set
   _getdeployconf SYNO_UseTempAdmin
   _debug2 SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
 
+  # Back to use existing admin user if explicitly requested
+  if [ "$SYNO_UseTempAdmin" -eq 0 ]; then
+    _debug2 Back to use existing user rather than temp admin user.
+    SYNO_UseTempAdmin=""
+  fi
+  _savedeployconf SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
+
   if [ -n "$SYNO_UseTempAdmin" ]; then
     if ! _exists synouser || ! _exists synogroup; then
       _err "Tools are missing for creating temp admin user, please set SYNO_Username and SYNO_Password instead."
       return 1
     fi
-    # Clean up
+
     [ -n "$SYNO_Username" ] || _savedeployconf SYNO_Username ""
     [ -n "$SYNO_Password" ] || _savedeployconf SYNO_Password ""
-    synouser --del "$SYNO_Username" >/dev/null 2>/dev/null
 
     _debug "Setting temp admin user credential..."
     SYNO_Username=sc-acmesh-tmp
     SYNO_Password=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 16)
-    # Ignore 2FA-OTP settings which won't be needed.
+    # Set 2FA-OTP settings to empty consider they won't be needed.
     SYNO_DeviceID=
     SYNO_DeviceName=
-
-    _savedeployconf SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
+    SYNO_OTPCode=
+    # Pre-delete temp admin user if already exists.
+    synouser --del "$SYNO_Username" >/dev/null 2>/dev/null
   else
     _debug2 SYNO_Username "$SYNO_Username"
     _secure_debug2 SYNO_Password "$SYNO_Password"
-    _debug2 SYNO_Create "$SYNO_Create"
     _debug2 SYNO_DeviceName "$SYNO_DeviceName"
     _secure_debug2 SYNO_DeviceID "$SYNO_DeviceID"
   fi
@@ -114,7 +125,7 @@ synology_dsm_deploy() {
 
   # Get the certificate description, but don't save it until we verify it's real
   _getdeployconf SYNO_Certificate
-  _debug SYNO_Certificate "$SYNO_Certificate"
+  _debug SYNO_Certificate "${SYNO_Certificate:-}"
 
   # shellcheck disable=SC1003 # We are not trying to escape a single quote
   if printf "%s" "$SYNO_Certificate" | grep '\\'; then
@@ -122,20 +133,6 @@ synology_dsm_deploy() {
     return 1
   fi
 
-  # Create temp admin user
-  if [ -n "$SYNO_UseTempAdmin" ]; then
-    _debug "Creating temp admin user in Synology DSM..."
-    synouser --add "$SYNO_Username" "$SYNO_Password" "" 0 "scruelt@hotmail.com" 0 >/dev/null
-    if [ -n "$(synogroup --help | grep '\-\-memberadd')" ]; then
-      synogroup --memberaddx administrators "$SYNO_Username" >/dev/null
-    else
-      # 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}')
-      _secure_debug3 admin_users "$cur_admins$SYNO_Username"
-      synogroup --memberx administrators $cur_admins $SYNO_Username >/dev/null
-    fi
-  fi
-
   _debug "Getting API version..."
   _base_url="$SYNO_Scheme://$SYNO_Hostname:$SYNO_Port"
   _debug _base_url "$_base_url"
@@ -151,7 +148,6 @@ synology_dsm_deploy() {
   encoded_username="$(printf "%s" "$SYNO_Username" | _url_encode)"
   encoded_password="$(printf "%s" "$SYNO_Password" | _url_encode)"
 
-  otp_code=""
   # ## START ## - DEPRECATED, for backward compatibility
   _getdeployconf SYNO_TOTP_SECRET
 
@@ -178,31 +174,85 @@ synology_dsm_deploy() {
     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")
     _debug3 response "$response"
   # ## END ## - DEPRECATED, for backward compatibility
-  # If SYNO_Device_ID & SYNO_DeviceName both empty, just log in normally
-  elif [ -z "${SYNO_DeviceID:-}" ] && [ -z "${SYNO_DeviceName:-}" ]; then
-    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")
-    _debug3 response "$response"
-  # Get device ID if still empty first, otherwise log in right away
-  # If SYNO_DeviceName is set, we treat that account enabled two-factor authorization, consider SYNO_DeviceID is not set, so it won't be able to login without requiring the OTP code.
-  elif [ -n "${SYNO_DeviceName:-}" ] && [ -z "${SYNO_DeviceID:-}" ]; then
+  # If SYNO_DeviceID or SYNO_OTPCode is set, we treat current account enabled 2FA-OTP.
+  # Notice that if SYNO_UseTempAdmin=1, both variables will be unset
+  else
+    if [ -n "$SYNO_UseTempAdmin" ]; then
+      _debug "Creating temp admin user in Synology DSM..."
+      synouser --add "$SYNO_Username" "$SYNO_Password" "" 0 "scruelt@hotmail.com" 0 >/dev/null
+      if synogroup --help | grep -q '\-\-memberadd'; then
+        synogroup --memberadd administrators "$SYNO_Username" >/dev/null
+      else
+        # 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}')
+        _secure_debug3 admin_users "$cur_admins$SYNO_Username"
+        # shellcheck disable=SC2086
+        synogroup --member administrators $cur_admins $SYNO_Username >/dev/null
+      fi
+    fi
+    if [ -n "$SYNO_DeviceID" ] || [ -n "$SYNO_OTPCode" ]; then
+      response='{"error":{"code":403}}'
+    # Assume the current account disabled 2FA-OTP, try to log in right away.
+    else
+      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")
+      _debug3 response "$response"
+    fi
+  fi
+
+  error_code=$(echo "$response" | grep '"error"' | grep -oP '(?<="code":)\d+')
+  # Account has 2FA-OTP enabled, since error 403 reported.
+  if [ "${error_code:-0}" -eq 403 ]; then
+    if [ -z "$SYNO_DeviceName" ]; then
+      printf "Enter device name or leave empty for default (CertRenewal): "
+      read -r SYNO_DeviceName
+      [ -n "$SYNO_DeviceName" ] || SYNO_DeviceName="CertRenewal"
+    fi
+
+    if [ -n "$SYNO_DeviceID" ]; then
+      # Omit OTP code with 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_DeviceName&device_id=$SYNO_DeviceID")
+      _secure_debug3 response "$response"
+    else
+      # Require the OTP code if still unset.
+      if [ -z "$SYNO_OTPCode" ]; then
         printf "Enter OTP code for user '%s': " "$SYNO_Username"
-        read -r otp_code
-        response=$(_get "$_base_url/webapi/$api_path?api=SYNO.API.Auth&version=$api_version&method=login&format=sid&account=$encoded_username&passwd=$encoded_password&otp_code=$otp_code&enable_syno_token=yes&enable_device_token=yes&device_name=$SYNO_DeviceName")
+        read -r SYNO_OTPCode
+      fi
+
+      if [ -z "$SYNO_OTPCode" ]; then
+        response='{"error":{"code":404}}'
+      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")
         _secure_debug3 response "$response"
 
         id_property='device_id'
         [ "${api_version}" -gt '6' ] || id_property='did'
         SYNO_DeviceID=$(echo "$response" | grep "$id_property" | sed -n 's/.*"'$id_property'" *: *"\([^"]*\).*/\1/p')
         _secure_debug2 SYNO_DeviceID "$SYNO_DeviceID"
-  # Otherwise, if SYNO_DeviceID is set, we can just use it to login.
-  else
-    if [ -z "${SYNO_DeviceName:-}" ]; then
-      printf "Enter device name or leave empty for default (CertRenewal): "
-      read -r SYNO_DeviceName
-      [ -n "${SYNO_DeviceName}" ] || SYNO_DeviceName="CertRenewal"
+      fi
     fi
-    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")
-    _secure_debug3 response "$response"
+    error_code=$(echo "$response" | grep '"error"' | grep -oP '(?<="code":)\d+')
+  fi
+
+  if [ -n "$error_code" ]; then
+    if [ "$error_code" -eq 403 ] && [ -n "$SYNO_DeviceID" ]; then
+      _savedeployconf SYNO_DeviceID ""
+      _err "Failed to authenticate with SYNO_DeviceID (may expired or invalid), please try again in a new terminal window."
+    elif [ "$error_code" -eq 404 ]; then
+      _err "Failed to authenticate with provided 2FA-OTP code, please try again in a new terminal window."
+    elif [ "$error_code" -eq 406 ]; then
+      if [ -n "$SYNO_UseTempAdmin" ]; then
+        _err "SYNO_UseTempAdmin=1 is not supported if enforce auth with 2FA-OTP is enabled."
+      else
+        _err "Enforce auth with 2FA-OTP enabled, please configure the user to enable 2FA-OTP to continue."
+      fi
+    elif [ "$error_code" -eq 400 ] || [ "$error_code" -eq 401 ] || [ "$error_code" -eq 408 ] || [ "$error_code" -eq 409 ] || [ "$error_code" -eq 410 ]; then
+      _err "Failed to authenticate with a non-existent or disabled account, or the account password is incorrect or has expired."
+    else
+      _err "Failed to authenticate with error: $error_code."
+    fi
+    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
+    return 1
   fi
 
   sid=$(echo "$response" | grep "sid" | sed -n 's/.*"sid" *: *"\([^"]*\).*/\1/p')
@@ -210,11 +260,9 @@ synology_dsm_deploy() {
   _debug "Session ID" "$sid"
   _debug SynoToken "$token"
   if [ -z "$sid" ] || [ -z "$token" ]; then
-    _err "Unable to authenticate to $_base_url - check your username & password."
-    _err "If two-factor authentication is enabled for the user:"
-    _err "- set SYNO_DeviceName then input *correct* OTP-code manually"
-    _err "- get & set SYNO_DeviceID via your browser cookies"
-    _remove_temp_admin "$SYNO_USE_TEMP_ADMIN" "$SYNO_Username"
+    # 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."
+    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
     return 1
   fi
 
@@ -223,12 +271,15 @@ synology_dsm_deploy() {
   _debug2 H1 "${_H1}"
 
   # Now that we know the username and password are good, save them if not in temp admin mode.
-  if [ -z "$SYNO_UseTempAdmin" ]; then
+  if [ -n "$SYNO_UseTempAdmin" ]; then
+    _savedeployconf SYNO_Username ""
+    _savedeployconf SYNO_Password ""
+  else
     _savedeployconf SYNO_Username "$SYNO_Username"
     _savedeployconf SYNO_Password "$SYNO_Password"
-    _savedeployconf SYNO_DeviceID "$SYNO_DeviceID"
-    _savedeployconf SYNO_DeviceName "$SYNO_DeviceName"
   fi
+  _savedeployconf SYNO_DeviceID "$SYNO_DeviceID"
+  _savedeployconf SYNO_DeviceName "$SYNO_DeviceName"
 
   _info "Getting certificates in Synology DSM..."
   response=$(_post "api=SYNO.Core.Certificate.CRT&method=list&version=1&_sid=$sid" "$_base_url/webapi/entry.cgi")
@@ -238,9 +289,24 @@ synology_dsm_deploy() {
   id=$(echo "$response" | sed -n "s/.*\"desc\":\"$escaped_certificate\",\"id\":\"\([^\"]*\).*/\1/p")
   _debug2 id "$id"
 
+  error_code=$(echo "$response" | grep '"error"' | grep -oP '(?<="code":)\d+')
+  if [ -n "$error_code" ]; then
+    if [ "$error_code" -eq 105 ]; then
+      _err "Current user is not administrator and does not have sufficient permission for deploying."
+    else
+      _err "Failed to fetch certificate info with error: $error_code, contact Synology for more info about it."
+    fi
+    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
+    return 1
+  fi
+
+  _getdeployconf SYNO_Create
+  _debug2 SYNO_Create "$SYNO_Create"
+  [ -n "$SYNO_Create" ] || SYNO_Create=1
+
   if [ -z "$id" ] && [ -z "$SYNO_Create" ]; then
     _err "Unable to find certificate: $SYNO_Certificate and $SYNO_Create is not set."
-    _remove_temp_admin "$SYNO_UseTempAdmin" "$SYNO_Username"
+    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
     return 1
   fi
 
@@ -275,11 +341,11 @@ synology_dsm_deploy() {
     else
       _info "Restarting HTTP services failed."
     fi
-    _remove_temp_admin "$SYNO_UseTempAdmin" "$SYNO_Username"
+    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
     _logout
     return 0
   else
-    _remove_temp_admin "$SYNO_UseTempAdmin" "$SYNO_Username"
+    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
     _err "Unable to update certificate, error code $response."
     _logout
     return 1
@@ -293,12 +359,12 @@ _logout() {
   _debug3 response "$response"
 }
 
-_remove_temp_admin() {
+_temp_admin_cleanup() {
   flag=$1
   username=$2
 
   if [ -n "${flag}" ]; then
-    _debug "Removing temp admin user in Synology DSM..."
+    _debug "Cleanuping temp admin info..."
     synouser --del "$username" >/dev/null
   fi
 }

From 59d1e16f9cb33ebeac1624f131a39c7088514204 Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Mon, 26 Feb 2024 06:21:03 +0800
Subject: [PATCH 05/13] feat: bypass enforce temp admin 2FA

---
 deploy/synology_dsm.sh | 66 +++++++++++++++++++++++++-----------------
 1 file changed, 40 insertions(+), 26 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index 0a2bdf7a..4b12a18e 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -11,8 +11,7 @@
 # Usage:
 # 1. Set required environment variables:
 # - use automatically created temp admin user to authenticate
-#   1. disable "enfore 2FA-OTP for admins" via control panel
-#   2. `export SYNO_UseTempAdmin=1`
+#   `export SYNO_UseTempAdmin=1`
 # - or provide your own admin user credential to authenticate
 #   1. `export SYNO_Username="adminUser"`
 #   2. `export SYNO_Password="adminPassword"`
@@ -70,8 +69,8 @@ synology_dsm_deploy() {
   _debug2 SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
 
   # Back to use existing admin user if explicitly requested
-  if [ "$SYNO_UseTempAdmin" -eq 0 ]; then
-    _debug2 Back to use existing user rather than temp admin user.
+  if [ "$SYNO_UseTempAdmin" == "0" ]; then
+    _debug2 "Back to use existing user rather than temp admin user."
     SYNO_UseTempAdmin=""
   fi
   _savedeployconf SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
@@ -177,31 +176,46 @@ synology_dsm_deploy() {
   # If SYNO_DeviceID or SYNO_OTPCode is set, we treat current account enabled 2FA-OTP.
   # Notice that if SYNO_UseTempAdmin=1, both variables will be unset
   else
-    if [ -n "$SYNO_UseTempAdmin" ]; then
-      _debug "Creating temp admin user in Synology DSM..."
-      synouser --add "$SYNO_Username" "$SYNO_Password" "" 0 "scruelt@hotmail.com" 0 >/dev/null
-      if synogroup --help | grep -q '\-\-memberadd'; then
-        synogroup --memberadd administrators "$SYNO_Username" >/dev/null
-      else
-        # 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}')
-        _secure_debug3 admin_users "$cur_admins$SYNO_Username"
-        # shellcheck disable=SC2086
-        synogroup --member administrators $cur_admins $SYNO_Username >/dev/null
-      fi
-    fi
     if [ -n "$SYNO_DeviceID" ] || [ -n "$SYNO_OTPCode" ]; then
       response='{"error":{"code":403}}'
     # Assume the current account disabled 2FA-OTP, try to log in right away.
     else
+      if [ -n "$SYNO_UseTempAdmin" ]; then
+        _debug "Creating temp admin user in Synology DSM..."
+        synouser --add "$SYNO_Username" "$SYNO_Password" "" 0 "scruelt@hotmail.com" 0 >/dev/null
+        if synogroup --help | grep -q '\-\-memberadd'; then
+          synogroup --memberadd administrators "$SYNO_Username" >/dev/null
+        else
+          # 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}')
+          _secure_debug3 admin_users "$cur_admins$SYNO_Username"
+          # shellcheck disable=SC2086
+          synogroup --member administrators $cur_admins $SYNO_Username >/dev/null
+        fi
+        # havig a workaround to temporary disable enforce 2FA-OTP
+        otp_enforce_option=$(synogetkeyvalue /etc/synoinfo.conf otp_enforce_option)
+        if [ -n "$otp_enforce_option" ] && [ "${otp_enforce_option:-"none"}" != "none" ]; then
+          synosetkeyvalue /etc/synoinfo.conf otp_enforce_option none
+          _info "Temporary disabled enforce 2FA-OTP to complete authentication."
+          _info "previous_otp_enforce_option" "$otp_enforce_option"
+
+        else
+          otp_enforce_option=""
+        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")
+      if [ -n "$SYNO_UseTempAdmin" ] && [ -n "$otp_enforce_option" ]; then
+        synosetkeyvalue /etc/synoinfo.conf otp_enforce_option "$otp_enforce_option"
+        _info "Restored previous enforce 2FA-OTP option."
+      fi
       _debug3 response "$response"
     fi
   fi
 
   error_code=$(echo "$response" | grep '"error"' | grep -oP '(?<="code":)\d+')
   # Account has 2FA-OTP enabled, since error 403 reported.
-  if [ "${error_code:-0}" -eq 403 ]; then
+  # 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 [ -z "$SYNO_DeviceName" ]; then
       printf "Enter device name or leave empty for default (CertRenewal): "
       read -r SYNO_DeviceName
@@ -235,18 +249,18 @@ synology_dsm_deploy() {
   fi
 
   if [ -n "$error_code" ]; then
-    if [ "$error_code" -eq 403 ] && [ -n "$SYNO_DeviceID" ]; then
+    if [ "$error_code" == "403" ] && [ -n "$SYNO_DeviceID" ]; then
       _savedeployconf SYNO_DeviceID ""
       _err "Failed to authenticate with SYNO_DeviceID (may expired or invalid), please try again in a new terminal window."
-    elif [ "$error_code" -eq 404 ]; then
+    elif [ "$error_code" == "404" ]; then
       _err "Failed to authenticate with provided 2FA-OTP code, please try again in a new terminal window."
-    elif [ "$error_code" -eq 406 ]; then
+    elif [ "$error_code" == "406" ]; then
       if [ -n "$SYNO_UseTempAdmin" ]; then
         _err "SYNO_UseTempAdmin=1 is not supported if enforce auth with 2FA-OTP is enabled."
       else
         _err "Enforce auth with 2FA-OTP enabled, please configure the user to enable 2FA-OTP to continue."
       fi
-    elif [ "$error_code" -eq 400 ] || [ "$error_code" -eq 401 ] || [ "$error_code" -eq 408 ] || [ "$error_code" -eq 409 ] || [ "$error_code" -eq 410 ]; then
+    elif [ "$error_code" == "400" ] || [ "$error_code" == "401" ] || [ "$error_code" == "408" ] || [ "$error_code" == "409" ] || [ "$error_code" == "410" ]; then
       _err "Failed to authenticate with a non-existent or disabled account, or the account password is incorrect or has expired."
     else
       _err "Failed to authenticate with error: $error_code."
@@ -313,7 +327,7 @@ synology_dsm_deploy() {
   # We've verified this certificate description is a thing, so save it
   _savedeployconf SYNO_Certificate "$SYNO_Certificate" "base64"
 
-  _info "Generating form POST request.."
+  _info "Generating form POST request..."
   nl="\0015\0012"
   delim="--------------------------$(_utc_date | tr -d -- '-: ')"
   content="--$delim${nl}Content-Disposition: form-data; name=\"key\"; filename=\"$(basename "$_ckey")\"${nl}Content-Type: application/octet-stream${nl}${nl}$(cat "$_ckey")\0012"
@@ -337,16 +351,16 @@ synology_dsm_deploy() {
 
   if ! echo "$response" | grep '"error":' >/dev/null; then
     if echo "$response" | grep '"restart_httpd":true' >/dev/null; then
-      _info "Restarting HTTP services succeeded..."
+      _info "Restart HTTP services succeeded."
     else
-      _info "Restarting HTTP services failed."
+      _info "Restart HTTP services failed."
     fi
     _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
     _logout
     return 0
   else
     _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
-    _err "Unable to update certificate, error code $response."
+    _err "Unable to update certificate, got error response: $response."
     _logout
     return 1
   fi

From afed62f6de12384acbcd269672e711bed0ffa863 Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Mon, 26 Feb 2024 07:05:00 +0800
Subject: [PATCH 06/13] fix: should save `SYNO_UseTempAdmin` only after login
 success.

---
 deploy/synology_dsm.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index 4b12a18e..65340211 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -31,7 +31,7 @@
 #   - `export SYNO_DeviceID=""`    - required for omitting 2FA-OTP (might be
 #                                    deprecated, auth with OTP code instead)
 # 3. Run command:
-# acme.sh --deploy --deploy-hook synology_dsm -d example.com
+# `acme.sh --deploy --deploy-hook synology_dsm -d example.com``
 ################################################################################
 # Dependencies:
 # - curl
@@ -73,7 +73,6 @@ synology_dsm_deploy() {
     _debug2 "Back to use existing user rather than temp admin user."
     SYNO_UseTempAdmin=""
   fi
-  _savedeployconf SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
 
   if [ -n "$SYNO_UseTempAdmin" ]; then
     if ! _exists synouser || ! _exists synogroup; then
@@ -288,6 +287,7 @@ synology_dsm_deploy() {
   if [ -n "$SYNO_UseTempAdmin" ]; then
     _savedeployconf SYNO_Username ""
     _savedeployconf SYNO_Password ""
+    _savedeployconf SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
   else
     _savedeployconf SYNO_Username "$SYNO_Username"
     _savedeployconf SYNO_Password "$SYNO_Password"

From 5b449999a5fc2da598dd11accce58b5a34c4a2cc Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Mon, 26 Feb 2024 20:55:49 +0800
Subject: [PATCH 07/13] refactor: unify variable naming convention again
 (revert some changes)

---
 deploy/synology_dsm.sh | 269 ++++++++++++++++++++++-------------------
 1 file changed, 145 insertions(+), 124 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index 65340211..0157b469 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -11,31 +11,31 @@
 # Usage:
 # 1. Set required environment variables:
 # - 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
-#   1. `export SYNO_Username="adminUser"`
-#   2. `export SYNO_Password="adminPassword"`
+#   1. `export SYNO_USERNAME="adminUser"`
+#   2. `export SYNO_PASSWORD="adminPassword"`
 # 2. Set optional environment variables (shown values are the defaults)
 # - common optional variables
-#   - `export SYNO_Scheme="http"`
-#   - `export SYNO_Hostname="localhost"`
-#   - `export SYNO_Port="5000"`
-#   - `export SYNO_Create=1` - to allow creating the cert if it doesn't exist
-#   - `export SYNO_Certificate=""` - to replace a specific cert by its
+#   - `export SYNO_SCHEME="http"`
+#   - `export SYNO_HOSTNAME="localhost"`
+#   - `export SYNO_PORT="5000"`
+#   - `export SYNO_CREATE=""` - to allow creating the cert if it doesn't exist
+#   - `export SYNO_CERTIFICATE=""` - to replace a specific cert by its
 #                                    description
 # - 2FA-OTP optional variables (with your own admin user)
-#   - `export SYNO_DeviceName=""`  - 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
+#   - `export SYNO_OTP_CODE=""`     - required for 2FA-OTP, script won't require
 #                                    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)
 # 3. Run command:
 # `acme.sh --deploy --deploy-hook synology_dsm -d example.com``
 ################################################################################
 # Dependencies:
 # - curl
-# - synouser & synogroup (When available and SYNO_UseTempAdmin is set)
+# - synouser & synogroup (When available and SYNO_USE_TEMP_ADMIN is set)
 ################################################################################
 # Return value:
 # 0 means success, otherwise error.
@@ -52,87 +52,85 @@ synology_dsm_deploy() {
   _debug _cdomain "$_cdomain"
 
   # Get username and password, but don't save until we authenticated successfully
-  _getdeployconf SYNO_Username
-  _getdeployconf SYNO_Password
-  _getdeployconf SYNO_DeviceID
-  _getdeployconf SYNO_DeviceName
-
-  # ## START ## - DEPRECATED, for backward compatibility
-  _getdeployconf SYNO_Device_ID
-  _getdeployconf SYNO_Device_Name
-  [ -n "$SYNO_DeviceID" ] || SYNO_DeviceID="${SYNO_Device_ID:-}"
-  [ -n "$SYNO_DeviceName" ] || SYNO_DeviceName="${SYNO_Device_Name:-}"
-  # ## END ## - DEPRECATED, for backward compatibility
-
-  # Prepare to use temp admin if SYNO_UseTempAdmin is set
-  _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
+  _migratedeployconf SYNO_Username SYNO_USERNAME
+  _migratedeployconf SYNO_Password SYNO_PASSWORD
+  _migratedeployconf SYNO_Device_ID SYNO_DEVICE_ID
+  _migratedeployconf SYNO_Device_Name SYNO_DEVICE_NAME
+  _getdeployconf SYNO_USERNAME
+  _getdeployconf SYNO_PASSWORD
+  _getdeployconf SYNO_DEVICE_ID
+  _getdeployconf SYNO_DEVICE_NAME
+
+  # Prepare to use temp admin if SYNO_USE_TEMP_ADMIN is set
+  _debug2 SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
+  _getdeployconf SYNO_USE_TEMP_ADMIN
+  __check2cleardeployconfexp SYNO_USE_TEMP_ADMIN
+  _debug2 SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
+
+  if [ -n "$SYNO_USE_TEMP_ADMIN" ]; 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
     fi
 
-    [ -n "$SYNO_Username" ] || _savedeployconf SYNO_Username ""
-    [ -n "$SYNO_Password" ] || _savedeployconf SYNO_Password ""
+    [ -n "$SYNO_USERNAME" ] || _savedeployconf SYNO_USERNAME ""
+    [ -n "$SYNO_PASSWORD" ] || _savedeployconf SYNO_PASSWORD ""
 
     _debug "Setting temp admin user credential..."
-    SYNO_Username=sc-acmesh-tmp
-    SYNO_Password=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 16)
+    SYNO_USERNAME=sc-acmesh-tmp
+    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.
-    SYNO_DeviceID=
-    SYNO_DeviceName=
-    SYNO_OTPCode=
+    SYNO_DEVICE_ID=
+    SYNO_DEVICE_NAME=
+    SYNO_OTP_CODE=
     # 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
-    _debug2 SYNO_Username "$SYNO_Username"
-    _secure_debug2 SYNO_Password "$SYNO_Password"
-    _debug2 SYNO_DeviceName "$SYNO_DeviceName"
-    _secure_debug2 SYNO_DeviceID "$SYNO_DeviceID"
+    _debug2 SYNO_USERNAME "$SYNO_USERNAME"
+    _secure_debug2 SYNO_PASSWORD "$SYNO_PASSWORD"
+    _debug2 SYNO_DEVICE_NAME "$SYNO_DEVICE_NAME"
+    _secure_debug2 SYNO_DEVICE_ID "$SYNO_DEVICE_ID"
   fi
 
-  if [ -z "$SYNO_Username" ] || [ -z "$SYNO_Password" ]; then
-    _err "You must set either SYNO_UseTempAdmin, or set both SYNO_Username and SYNO_Password."
+  if [ -z "$SYNO_USERNAME" ] || [ -z "$SYNO_PASSWORD" ]; then
+    _err "You must set either SYNO_USE_TEMP_ADMIN, or set both SYNO_USERNAME and SYNO_PASSWORD."
     return 1
   fi
 
   # Optional scheme, hostname and port for Synology DSM
-  _getdeployconf SYNO_Scheme
-  _getdeployconf SYNO_Hostname
-  _getdeployconf SYNO_Port
+  _migratedeployconf SYNO_Scheme SYNO_SCHEME
+  _migratedeployconf SYNO_Hostname SYNO_HOSTNAME
+  _migratedeployconf SYNO_Port SYNO_PORT
+  _getdeployconf SYNO_SCHEME
+  _getdeployconf SYNO_HOSTNAME
+  _getdeployconf SYNO_PORT
 
   # Default values for scheme, hostname and port
   # Defaulting to localhost and http, because it's localhost…
-  [ -n "$SYNO_Scheme" ] || SYNO_Scheme="http"
-  [ -n "$SYNO_Hostname" ] || SYNO_Hostname="localhost"
-  [ -n "$SYNO_Port" ] || SYNO_Port="5000"
-  _savedeployconf SYNO_Scheme "$SYNO_Scheme"
-  _savedeployconf SYNO_Hostname "$SYNO_Hostname"
-  _savedeployconf SYNO_Port "$SYNO_Port"
-  _debug2 SYNO_Scheme "$SYNO_Scheme"
-  _debug2 SYNO_Hostname "$SYNO_Hostname"
-  _debug2 SYNO_Port "$SYNO_Port"
+  [ -n "$SYNO_SCHEME" ] || SYNO_SCHEME="http"
+  [ -n "$SYNO_HOSTNAME" ] || SYNO_HOSTNAME="localhost"
+  [ -n "$SYNO_PORT" ] || SYNO_PORT="5000"
+  _savedeployconf SYNO_SCHEME "$SYNO_SCHEME"
+  _savedeployconf SYNO_HOSTNAME "$SYNO_HOSTNAME"
+  _savedeployconf SYNO_PORT "$SYNO_PORT"
+  _debug2 SYNO_SCHEME "$SYNO_SCHEME"
+  _debug2 SYNO_HOSTNAME "$SYNO_HOSTNAME"
+  _debug2 SYNO_PORT "$SYNO_PORT"
 
   # Get the certificate description, but don't save it until we verify it's real
-  _getdeployconf SYNO_Certificate
-  _debug SYNO_Certificate "${SYNO_Certificate:-}"
+  _migratedeployconf SYNO_Certificate SYNO_CERTIFICATE "base64"
+  _getdeployconf SYNO_CERTIFICATE
+  __check2cleardeployconfexp SYNO_CERTIFICATE
+  _debug SYNO_CERTIFICATE "${SYNO_CERTIFICATE:-}"
 
   # 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"
     return 1
   fi
 
   _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"
   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')
@@ -142,9 +140,9 @@ synology_dsm_deploy() {
   _debug3 api_version "$api_version"
 
   # Login, get the session ID and SynoToken from JSON
-  _info "Logging into $SYNO_Hostname:$SYNO_Port..."
-  encoded_username="$(printf "%s" "$SYNO_Username" | _url_encode)"
-  encoded_password="$(printf "%s" "$SYNO_Password" | _url_encode)"
+  _info "Logging into $SYNO_HOSTNAME:$SYNO_PORT..."
+  encoded_username="$(printf "%s" "$SYNO_USERNAME" | _url_encode)"
+  encoded_password="$(printf "%s" "$SYNO_PASSWORD" | _url_encode)"
 
   # ## START ## - DEPRECATED, for backward compatibility
   _getdeployconf SYNO_TOTP_SECRET
@@ -159,37 +157,37 @@ synology_dsm_deploy() {
     fi
     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
-      [ -n "$SYNO_DID" ] || SYNO_DeviceID="$SYNO_DID"
+      [ -n "$SYNO_DID" ] || SYNO_DEVICE_ID="$SYNO_DID"
     fi
-    if [ -n "$SYNO_DeviceID" ]; then
-      _H1="Cookie: did=$SYNO_DeviceID"
+    if [ -n "$SYNO_DEVICE_ID" ]; then
+      _H1="Cookie: did=$SYNO_DEVICE_ID"
       export _H1
       _debug3 H1 "${_H1}"
     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"
   # ## END ## - DEPRECATED, for backward compatibility
-  # If SYNO_DeviceID or SYNO_OTPCode is set, we treat current account enabled 2FA-OTP.
-  # Notice that if SYNO_UseTempAdmin=1, both variables will be unset
+  # If SYNO_DEVICE_ID or SYNO_OTP_CODE is set, we treat current account enabled 2FA-OTP.
+  # Notice that if SYNO_USE_TEMP_ADMIN=1, both variables will be unset
   else
-    if [ -n "$SYNO_DeviceID" ] || [ -n "$SYNO_OTPCode" ]; then
+    if [ -n "$SYNO_DEVICE_ID" ] || [ -n "$SYNO_OTP_CODE" ]; then
       response='{"error":{"code":403}}'
     # Assume the current account disabled 2FA-OTP, try to log in right away.
     else
-      if [ -n "$SYNO_UseTempAdmin" ]; then
+      if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
         _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
-          synogroup --memberadd administrators "$SYNO_Username" >/dev/null
+          synogroup --memberadd administrators "$SYNO_USERNAME" >/dev/null
         else
           # 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}')
-          _secure_debug3 admin_users "$cur_admins$SYNO_Username"
+          _secure_debug3 admin_users "$cur_admins$SYNO_USERNAME"
           # shellcheck disable=SC2086
-          synogroup --member administrators $cur_admins $SYNO_Username >/dev/null
+          synogroup --member administrators $cur_admins $SYNO_USERNAME >/dev/null
         fi
         # havig a workaround to temporary disable enforce 2FA-OTP
         otp_enforce_option=$(synogetkeyvalue /etc/synoinfo.conf otp_enforce_option)
@@ -203,7 +201,7 @@ synology_dsm_deploy() {
         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")
-      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"
         _info "Restored previous enforce 2FA-OTP option."
       fi
@@ -215,47 +213,47 @@ synology_dsm_deploy() {
   # 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
   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): "
-      read -r SYNO_DeviceName
-      [ -n "$SYNO_DeviceName" ] || SYNO_DeviceName="CertRenewal"
+      read -r SYNO_DEVICE_NAME
+      [ -n "$SYNO_DEVICE_NAME" ] || SYNO_DEVICE_NAME="CertRenewal"
     fi
 
-    if [ -n "$SYNO_DeviceID" ]; then
-      # Omit OTP code with 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_DeviceName&device_id=$SYNO_DeviceID")
+    if [ -n "$SYNO_DEVICE_ID" ]; then
+      # 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_DEVICE_NAME&device_id=$SYNO_DEVICE_ID")
       _secure_debug3 response "$response"
     else
       # Require the OTP code if still unset.
-      if [ -z "$SYNO_OTPCode" ]; then
-        printf "Enter OTP code for user '%s': " "$SYNO_Username"
-        read -r SYNO_OTPCode
+      if [ -z "$SYNO_OTP_CODE" ]; then
+        printf "Enter OTP code for user '%s': " "$SYNO_USERNAME"
+        read -r SYNO_OTP_CODE
       fi
 
-      if [ -z "$SYNO_OTPCode" ]; then
+      if [ -z "$SYNO_OTP_CODE" ]; then
         response='{"error":{"code":404}}'
       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"
 
         id_property='device_id'
         [ "${api_version}" -gt '6' ] || id_property='did'
-        SYNO_DeviceID=$(echo "$response" | grep "$id_property" | sed -n 's/.*"'$id_property'" *: *"\([^"]*\).*/\1/p')
-        _secure_debug2 SYNO_DeviceID "$SYNO_DeviceID"
+        SYNO_DEVICE_ID=$(echo "$response" | grep "$id_property" | sed -n 's/.*"'$id_property'" *: *"\([^"]*\).*/\1/p')
+        _secure_debug2 SYNO_DEVICE_ID "$SYNO_DEVICE_ID"
       fi
     fi
     error_code=$(echo "$response" | grep '"error"' | grep -oP '(?<="code":)\d+')
   fi
 
   if [ -n "$error_code" ]; then
-    if [ "$error_code" == "403" ] && [ -n "$SYNO_DeviceID" ]; then
-      _savedeployconf SYNO_DeviceID ""
-      _err "Failed to authenticate with SYNO_DeviceID (may expired or invalid), please try again in a new terminal window."
+    if [ "$error_code" == "403" ] && [ -n "$SYNO_DEVICE_ID" ]; then
+      _cleardeployconf SYNO_DEVICE_ID
+      _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
       _err "Failed to authenticate with provided 2FA-OTP code, please try again in a new terminal window."
     elif [ "$error_code" == "406" ]; then
-      if [ -n "$SYNO_UseTempAdmin" ]; then
-        _err "SYNO_UseTempAdmin=1 is not supported if enforce auth with 2FA-OTP is enabled."
+      if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
+        _err "SYNO_USE_TEMP_ADMIN=1 is not supported if enforce auth with 2FA-OTP is enabled."
       else
         _err "Enforce auth with 2FA-OTP enabled, please configure the user to enable 2FA-OTP to continue."
       fi
@@ -264,7 +262,7 @@ synology_dsm_deploy() {
     else
       _err "Failed to authenticate with error: $error_code."
     fi
-    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
+    _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
     return 1
   fi
 
@@ -275,7 +273,7 @@ synology_dsm_deploy() {
   if [ -z "$sid" ] || [ -z "$token" ]; then
     # 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."
-    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
+    _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
     return 1
   fi
 
@@ -284,21 +282,23 @@ synology_dsm_deploy() {
   _debug2 H1 "${_H1}"
 
   # Now that we know the username and password are good, save them if not in temp admin mode.
-  if [ -n "$SYNO_UseTempAdmin" ]; then
-    _savedeployconf SYNO_Username ""
-    _savedeployconf SYNO_Password ""
-    _savedeployconf SYNO_UseTempAdmin "$SYNO_UseTempAdmin"
+  if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
+    _cleardeployconf SYNO_USERNAME
+    _cleardeployconf SYNO_PASSWORD
+    _cleardeployconf SYNO_DEVICE_ID
+    _cleardeployconf SYNO_DEVICE_NAME
+    _savedeployconf SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
   else
-    _savedeployconf SYNO_Username "$SYNO_Username"
-    _savedeployconf SYNO_Password "$SYNO_Password"
+    _savedeployconf SYNO_USERNAME "$SYNO_USERNAME"
+    _savedeployconf SYNO_PASSWORD "$SYNO_PASSWORD"
+    _savedeployconf SYNO_DEVICE_ID "$SYNO_DEVICE_ID"
+    _savedeployconf SYNO_DEVICE_NAME "$SYNO_DEVICE_NAME"
   fi
-  _savedeployconf SYNO_DeviceID "$SYNO_DeviceID"
-  _savedeployconf SYNO_DeviceName "$SYNO_DeviceName"
 
   _info "Getting certificates in Synology DSM..."
   response=$(_post "api=SYNO.Core.Certificate.CRT&method=list&version=1&_sid=$sid" "$_base_url/webapi/entry.cgi")
   _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"
   id=$(echo "$response" | sed -n "s/.*\"desc\":\"$escaped_certificate\",\"id\":\"\([^\"]*\).*/\1/p")
   _debug2 id "$id"
@@ -310,22 +310,22 @@ synology_dsm_deploy() {
     else
       _err "Failed to fetch certificate info with error: $error_code, contact Synology for more info about it."
     fi
-    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
+    _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
     return 1
   fi
 
-  _getdeployconf SYNO_Create
-  _debug2 SYNO_Create "$SYNO_Create"
-  [ -n "$SYNO_Create" ] || SYNO_Create=1
+  _migratedeployconf SYNO_Create SYNO_CREATE
+  _getdeployconf SYNO_CREATE
+  _debug2 SYNO_CREATE "$SYNO_CREATE"
 
-  if [ -z "$id" ] && [ -z "$SYNO_Create" ]; then
-    _err "Unable to find certificate: $SYNO_Certificate and $SYNO_Create is not set."
-    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
+  if [ -z "$id" ] && [ -z "$SYNO_CREATE" ]; then
+    _err "Unable to find certificate: $SYNO_CERTIFICATE and $SYNO_CREATE is not set."
+    _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
     return 1
   fi
 
   # 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..."
   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=\"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=\"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
     _debug2 default "This is the default certificate"
     content="$content${nl}--$delim${nl}Content-Disposition: form-data; name=\"as_default\"${nl}${nl}true"
@@ -355,11 +355,11 @@ synology_dsm_deploy() {
     else
       _info "Restart HTTP services failed."
     fi
-    _temp_admin_cleanup "$SYNO_UseTempAdmin" "$SYNO_Username"
+    _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
     _logout
     return 0
   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."
     _logout
     return 1
@@ -382,3 +382,24 @@ _temp_admin_cleanup() {
     synouser --del "$username" >/dev/null
   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
+}

From 192ec598a34397c33c4dd9bf5318053c4dfff5ed Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Mon, 26 Feb 2024 19:52:06 +0800
Subject: [PATCH 08/13] feat: add `SYNO_LOCAL_HOSTNAME` to prevent remote
 deploy via temp admin method

---
 deploy/synology_dsm.sh | 53 ++++++++++++++++++++++++++----------------
 1 file changed, 33 insertions(+), 20 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index 0157b469..f1ff27a9 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -8,30 +8,34 @@
 # Updated: 2023-07-03
 # Issues:  https://github.com/acmesh-official/acme.sh/issues/2727
 ################################################################################
-# Usage:
+# Usage (shown values are the examples):
 # 1. Set required environment variables:
 # - use automatically created temp admin user to authenticate
-#   `export SYNO_USE_TEMP_ADMIN=1`
+#   export SYNO_USE_TEMP_ADMIN=1
 # - or provide your own admin user credential to authenticate
-#   1. `export SYNO_USERNAME="adminUser"`
-#   2. `export SYNO_PASSWORD="adminPassword"`
-# 2. Set optional environment variables (shown values are the defaults)
+#   1. export SYNO_USERNAME="adminUser"
+#   2. export SYNO_PASSWORD="adminPassword"
+# 2. Set optional environment variables
 # - common optional variables
-#   - `export SYNO_SCHEME="http"`
-#   - `export SYNO_HOSTNAME="localhost"`
-#   - `export SYNO_PORT="5000"`
-#   - `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_SCHEME="http"         - defaults to "http"
+#   - export SYNO_HOSTNAME="localhost"  - defaults to "localhost"
+#   - export SYNO_PORT="5000"           - defaults to "5000"
+#   - export SYNO_CREATE=1 - to allow creating the cert if it doesn't exist
+#   - export SYNO_CERTIFICATE="" - to replace a specific cert by its
 #                                    description
 # - 2FA-OTP optional variables (with your own admin user)
-#   - `export SYNO_OTP_CODE=""`     - required for 2FA-OTP, script won't require
-#                                    interactive input the code if set.
-#   - `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)
+#   - export SYNO_OTP_CODE="XXXXXX" - if set, script won't require to
+#                                     interactive input the OTP code
+#   - export SYNO_DEVICE_NAME="CertRenewal" - if set, script won't require to
+#                                             interactive input the device name
+#   - export SYNO_DEVICE_ID=""    - (deprecated) required for omitting 2FA-OTP
+#                                   (please auth with OTP code instead)
+# - temp admin optional variables
+#   - export SYNO_LOCAL_HOSTNAME=1   - if set to 1, force to treat hostname is
+#                                      targeting current local machine (since
+#                                      this method only locally supported)
 # 3. Run command:
-# `acme.sh --deploy --deploy-hook synology_dsm -d example.com``
+# acme.sh --deploy --deploy-hook synology_dsm -d example.com
 ################################################################################
 # Dependencies:
 # - curl
@@ -83,8 +87,6 @@ synology_dsm_deploy() {
     SYNO_DEVICE_ID=
     SYNO_DEVICE_NAME=
     SYNO_OTP_CODE=
-    # Pre-delete temp admin user if already exists.
-    synouser --del "$SYNO_USERNAME" >/dev/null 2>/dev/null
   else
     _debug2 SYNO_USERNAME "$SYNO_USERNAME"
     _secure_debug2 SYNO_PASSWORD "$SYNO_PASSWORD"
@@ -178,7 +180,16 @@ synology_dsm_deploy() {
     # Assume the current account disabled 2FA-OTP, try to log in right away.
     else
       if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
+        _getdeployconf SYNO_LOCAL_HOSTNAME
+        _debug SYNO_LOCAL_HOSTNAME "${SYNO_LOCAL_HOSTNAME:-}"
+        if [ "$SYNO_LOCAL_HOSTNAME" != "1" ] && [ "$SYNO_LOCAL_HOSTNAME" == "$SYNO_HOSTNAME" ]; then
+          if [ "$SYNO_HOSTNAME" != "localhost" ] && [ "$SYNO_HOSTNAME" != "127.0.0.1" ]; then
+            _err "SYNO_USE_TEMP_ADMIN=1 Only support locally deployment, if you are sure that hostname $SYNO_HOSTNAME is targeting to your **current local machine**, execute 'export SYNO_LOCAL_HOSTNAME=1' then rerun."
+            return 1
+          fi
+        fi
         _debug "Creating temp admin user in Synology DSM..."
+        synouser --del "$SYNO_USERNAME" >/dev/null 2>/dev/null
         synouser --add "$SYNO_USERNAME" "$SYNO_PASSWORD" "" 0 "scruelt@hotmail.com" 0 >/dev/null
         if synogroup --help | grep -q '\-\-memberadd'; then
           synogroup --memberadd administrators "$SYNO_USERNAME" >/dev/null
@@ -229,6 +240,7 @@ synology_dsm_deploy() {
         printf "Enter OTP code for user '%s': " "$SYNO_USERNAME"
         read -r SYNO_OTP_CODE
       fi
+      _secure_debug SYNO_OTP_CODE "${SYNO_OTP_CODE:-}"
 
       if [ -z "$SYNO_OTP_CODE" ]; then
         response='{"error":{"code":404}}'
@@ -288,6 +300,7 @@ synology_dsm_deploy() {
     _cleardeployconf SYNO_DEVICE_ID
     _cleardeployconf SYNO_DEVICE_NAME
     _savedeployconf SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
+    _savedeployconf SYNO_LOCAL_HOSTNAME "$SYNO_HOSTNAME"
   else
     _savedeployconf SYNO_USERNAME "$SYNO_USERNAME"
     _savedeployconf SYNO_PASSWORD "$SYNO_PASSWORD"
@@ -308,7 +321,7 @@ synology_dsm_deploy() {
     if [ "$error_code" -eq 105 ]; then
       _err "Current user is not administrator and does not have sufficient permission for deploying."
     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, please try again or contact Synology to learn more."
     fi
     _temp_admin_cleanup "$SYNO_USE_TEMP_ADMIN" "$SYNO_USERNAME"
     return 1

From 50eda6b6786dae308b0959ec6b464c7bfca7408b Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Mon, 26 Feb 2024 21:07:15 +0800
Subject: [PATCH 09/13] fix: lint

---
 deploy/synology_dsm.sh | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index f1ff27a9..24a6f024 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -206,7 +206,6 @@ synology_dsm_deploy() {
           synosetkeyvalue /etc/synoinfo.conf otp_enforce_option none
           _info "Temporary disabled enforce 2FA-OTP to complete authentication."
           _info "previous_otp_enforce_option" "$otp_enforce_option"
-
         else
           otp_enforce_option=""
         fi
@@ -403,16 +402,15 @@ _cleardeployconf() {
 
 # key
 __check2cleardeployconfexp() {
-  # Warning: 
   _key="$1"
   _clear_key="CLEAR_$_key"
   # Clear saved settings if explicitly requested
-  if [ -n "$(eval echo \$$_clear_key)" ]; then
+  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=
+    eval "$_key"=
+    export "$_key"=
+    eval SAVED_"$_key"=
+    export SAVED_"$_key"=
   fi
 }

From 68e3a12a918e349da1f0bd97aa7ce0906dd97484 Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Mon, 26 Feb 2024 23:38:44 +0800
Subject: [PATCH 10/13] feat: improve robustness of the usage of DSM tool
 `synogroup`

---
 deploy/synology_dsm.sh | 43 ++++++++++++++++++++++++++++--------------
 1 file changed, 29 insertions(+), 14 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index 24a6f024..1e4be8e9 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -68,7 +68,7 @@ synology_dsm_deploy() {
   # Prepare to use temp admin if SYNO_USE_TEMP_ADMIN is set
   _debug2 SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
   _getdeployconf SYNO_USE_TEMP_ADMIN
-  __check2cleardeployconfexp SYNO_USE_TEMP_ADMIN
+  _check2cleardeployconfexp SYNO_USE_TEMP_ADMIN
   _debug2 SYNO_USE_TEMP_ADMIN "$SYNO_USE_TEMP_ADMIN"
 
   if [ -n "$SYNO_USE_TEMP_ADMIN" ]; then
@@ -122,7 +122,7 @@ synology_dsm_deploy() {
   # Get the certificate description, but don't save it until we verify it's real
   _migratedeployconf SYNO_Certificate SYNO_CERTIFICATE "base64"
   _getdeployconf SYNO_CERTIFICATE
-  __check2cleardeployconfexp SYNO_CERTIFICATE
+  _check2cleardeployconfexp SYNO_CERTIFICATE
   _debug SYNO_CERTIFICATE "${SYNO_CERTIFICATE:-}"
 
   # shellcheck disable=SC1003 # We are not trying to escape a single quote
@@ -189,16 +189,24 @@ synology_dsm_deploy() {
           fi
         fi
         _debug "Creating temp admin user in Synology DSM..."
-        synouser --del "$SYNO_USERNAME" >/dev/null 2>/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
+          _temp_admin_create $SYNO_USERNAME $SYNO_PASSWORD
           synogroup --memberadd administrators "$SYNO_USERNAME" >/dev/null
-        else
+        elif synogroup --help | grep -q '\-\-member '; then
           # 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}')
-          _secure_debug3 admin_users "$cur_admins$SYNO_USERNAME"
-          # shellcheck disable=SC2086
-          synogroup --member administrators $cur_admins $SYNO_USERNAME >/dev/null
+          if [ -n "$cur_admins" ]; then
+            _temp_admin_create $SYNO_USERNAME $SYNO_PASSWORD
+            _secure_debug3 admin_users "$cur_admins$SYNO_USERNAME"
+            # shellcheck disable=SC2086
+            synogroup --member administrators $cur_admins $SYNO_USERNAME >/dev/null
+          else
+            _err "Tool synogroup may be broken, please set SYNO_USERNAME and SYNO_PASSWORD instead."
+            return 1
+          fi
+        else
+          _err "Unsupported synogroup tool detected, please set SYNO_USERNAME and SYNO_PASSWORD instead."
+          return 1
         fi
         # havig a workaround to temporary disable enforce 2FA-OTP
         otp_enforce_option=$(synogetkeyvalue /etc/synoinfo.conf otp_enforce_option)
@@ -385,13 +393,20 @@ _logout() {
   _debug3 response "$response"
 }
 
+_temp_admin_create() {
+  _username="$1"
+  _password="$2"
+  synouser --del "$_username" >/dev/null 2>/dev/null
+  synouser --add "$_username" "$_password" "" 0 "scruelt@hotmail.com" 0 >/dev/null
+}
+
 _temp_admin_cleanup() {
-  flag=$1
-  username=$2
+  _flag=$1
+  _username=$2
 
-  if [ -n "${flag}" ]; then
+  if [ -n "${_flag}" ]; then
     _debug "Cleanuping temp admin info..."
-    synouser --del "$username" >/dev/null
+    synouser --del "$_username" >/dev/null
   fi
 }
 
@@ -401,7 +416,7 @@ _cleardeployconf() {
 }
 
 # key
-__check2cleardeployconfexp() {
+_check2cleardeployconfexp() {
   _key="$1"
   _clear_key="CLEAR_$_key"
   # Clear saved settings if explicitly requested

From ff090d2f74f994da4bca89b942b08bb714b25a46 Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Mon, 26 Feb 2024 23:45:19 +0800
Subject: [PATCH 11/13] fix lint

---
 deploy/synology_dsm.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index 1e4be8e9..7eca0f9c 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -190,13 +190,13 @@ synology_dsm_deploy() {
         fi
         _debug "Creating temp admin user in Synology DSM..."
         if synogroup --help | grep -q '\-\-memberadd '; then
-          _temp_admin_create $SYNO_USERNAME $SYNO_PASSWORD
+          _temp_admin_create "$SYNO_USERNAME" "$SYNO_PASSWORD"
           synogroup --memberadd administrators "$SYNO_USERNAME" >/dev/null
         elif synogroup --help | grep -q '\-\-member '; then
           # 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}')
           if [ -n "$cur_admins" ]; then
-            _temp_admin_create $SYNO_USERNAME $SYNO_PASSWORD
+            _temp_admin_create "$SYNO_USERNAME" "$SYNO_PASSWORD"
             _secure_debug3 admin_users "$cur_admins$SYNO_USERNAME"
             # shellcheck disable=SC2086
             synogroup --member administrators $cur_admins $SYNO_USERNAME >/dev/null

From 6af52933155c913d236f5be7bc1c5d4eccf05887 Mon Sep 17 00:00:00 2001
From: Scruel Tao <scruelt@hotmail.com>
Date: Wed, 28 Feb 2024 02:00:07 +0800
Subject: [PATCH 12/13] doc: adjust

---
 deploy/synology_dsm.sh | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/deploy/synology_dsm.sh b/deploy/synology_dsm.sh
index 7eca0f9c..b3bd6197 100644
--- a/deploy/synology_dsm.sh
+++ b/deploy/synology_dsm.sh
@@ -23,17 +23,17 @@
 #   - export SYNO_CREATE=1 - to allow creating the cert if it doesn't exist
 #   - export SYNO_CERTIFICATE="" - to replace a specific cert by its
 #                                    description
-# - 2FA-OTP optional variables (with your own admin user)
-#   - export SYNO_OTP_CODE="XXXXXX" - if set, script won't require to
-#                                     interactive input the OTP code
-#   - export SYNO_DEVICE_NAME="CertRenewal" - if set, script won't require to
-#                                             interactive input the device name
-#   - export SYNO_DEVICE_ID=""    - (deprecated) required for omitting 2FA-OTP
-#                                   (please auth with OTP code instead)
 # - temp admin optional variables
 #   - export SYNO_LOCAL_HOSTNAME=1   - if set to 1, force to treat hostname is
 #                                      targeting current local machine (since
 #                                      this method only locally supported)
+# - exsiting admin 2FA-OTP optional variables
+#   - export SYNO_OTP_CODE="XXXXXX" - if set, script won't require to
+#                                     interactive input the OTP code
+#   - export SYNO_DEVICE_NAME="CertRenewal" - if set, script won't require to
+#                                             interactive input the device name
+#   - export SYNO_DEVICE_ID=""      - (deprecated, auth with OTP code instead)
+#                                     required for omitting 2FA-OTP
 # 3. Run command:
 # acme.sh --deploy --deploy-hook synology_dsm -d example.com
 ################################################################################

From 43b5ea801f4baa162f921769317a6a8ad85576a0 Mon Sep 17 00:00:00 2001
From: neil <neilgit@neilpang.com>
Date: Sun, 21 Apr 2024 11:21:45 +0200
Subject: [PATCH 13/13] convert to pkcs12 when renewal fix
 https://github.com/acmesh-official/acme.sh/issues/3474#issuecomment-2058126129

---
 acme.sh | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/acme.sh b/acme.sh
index 1fa47989..d154cf77 100755
--- a/acme.sh
+++ b/acme.sh
@@ -1430,6 +1430,9 @@ _toPkcs() {
   else
     ${ACME_OPENSSL_BIN:-openssl} pkcs12 -export -out "$_cpfx" -inkey "$_ckey" -in "$_ccert" -certfile "$_cca"
   fi
+  if [ "$?" == "0" ]; then
+    _savedomainconf "Le_PFXPassword" "$pfxPassword"
+  fi
 
 }
 
@@ -5338,6 +5341,12 @@ $_authorizations_map"
   _savedomainconf "Le_NextRenewTimeStr" "$Le_NextRenewTimeStr"
   _savedomainconf "Le_NextRenewTime" "$Le_NextRenewTime"
 
+  #convert to pkcs12
+  if [ "$Le_PFXPassword" ]; then
+    _toPkcs "$CERT_PFX_PATH" "$CERT_KEY_PATH" "$CERT_PATH" "$CA_CERT_PATH" "$Le_PFXPassword"
+  fi
+  export CERT_PFX_PATH
+
   if [ "$_real_cert$_real_key$_real_ca$_reload_cmd$_real_fullchain" ]; then
     _savedomainconf "Le_RealCertPath" "$_real_cert"
     _savedomainconf "Le_RealCACertPath" "$_real_ca"