Skip to content

Instantly share code, notes, and snippets.

@catchdave
Last active October 7, 2024 20:19
Show Gist options
  • Save catchdave/69854624a21ac75194706ec20ca61327 to your computer and use it in GitHub Desktop.
Save catchdave/69854624a21ac75194706ec20ca61327 to your computer and use it in GitHub Desktop.
CLI script to programmatically replace SSL certs on Synology NAS
#!/bin/bash
#
# *** For DSM v7.x ***
#
# How to use this script:
# 1. Get your 3 PEM files ready to copy over from your local machine/update server (privkey.pem, fullchain.pem, cert.pem)
# and put into a directory (this will be $CERT_DIRECTORY).
# Personally, I use this script (https://gist.github.com/catchdave/3f6f412bbf0f0cec32469fb0c9747295) to automate steps 1 & 4.
# 2. Ensure you have a user setup on synology that has ssh access (and ssh access is setup).
# This user will need to be able to sudo as root (i.e. add this line to sudoers, <USER> is the user you create):
# <USER> ALL=(ALL) NOPASSWD: /var/services/homes/<USER>/replace_certs.sh
# 3. Copy this script to Synology: sudo scp replace_synology_ssl_certs.sh $USER@$SYNOLOGY_SERVER:~/
# 4. Call this script as follows:
# sudo bash -c scp ${CERT_DIRECTORY}/{privkey,fullchain,cert}.pem $USER@$SYNOLOGY_SERVER:/tmp/ \
# && ssh $USER@$SYNOLOGY_SERVER 'sudo ./replace_synology_ssl_certs.sh'
# Script start.
DEBUG= # Set to any non-empty value to turn on debug mode
error_exit() { echo "[ERROR] $1"; exit 1; }
warn() { echo "[WARN ] $1"; }
info() { echo "[INFO ] $1"; }
debug() { [[ "${DEBUG}" ]] && echo "[DEBUG ] $1"; }
# 1. Initialization
# =================
[[ "$EUID" -ne 0 ]] && error_exit "Please run as root" # Script only works as root
certs_src_dir="/usr/syno/etc/certificate/system/default"
services_to_restart=("nmbd" "avahi" "ldap-server")
packages_to_restart=("ScsiTarget" "SynologyDrive" "WebDAVServer" "ActiveBackup")
target_cert_dirs=(
"/usr/syno/etc/certificate/system/FQDN"
"/usr/local/etc/certificate/ScsiTarget/pkg-scsi-plugin-server/"
"/usr/local/etc/certificate/SynologyDrive/SynologyDrive/"
"/usr/local/etc/certificate/WebDAVServer/webdav/"
"/usr/local/etc/certificate/ActiveBackup/ActiveBackup/"
"/usr/syno/etc/certificate/smbftpd/ftpd/")
# Add the default directory
default_dir_name=$(</usr/syno/etc/certificate/_archive/DEFAULT)
if [[ -n "$default_dir_name" ]]; then
target_cert_dirs+=("/usr/syno/etc/certificate/_archive/${default_dir_name}")
debug "Default cert directory found: '/usr/syno/etc/certificate/_archive/${default_dir_name}'"
else
warn "No default directory found. Probably unusual? Check: 'cat /usr/syno/etc/certificate/_archive/DEFAULT'"
fi
# Add reverse proxy app directories
for proxy in /usr/syno/etc/certificate/ReverseProxy/*/; do
debug "Found proxy dir: ${proxy}"
target_cert_dirs+=("${proxy}")
done
[[ "${DEBUG}" ]] && set -x
# 2. Move and chown certificates from /tmp to default directory
# =============================================================
mv /tmp/{privkey,fullchain,cert}.pem "${certs_src_dir}/" || error_exit "Halting because of error moving files"
chown root:root "${certs_src_dir}/"{privkey,fullchain,cert}.pem || error_exit "Halting because of error chowning files"
info "Certs moved from /tmp & chowned."
# 3. Copy certificates to target directories if they exist
# ========================================================
for target_dir in "${target_cert_dirs[@]}"; do
if [[ ! -d "$target_dir" ]]; then
debug "Target cert directory '$target_dir' not found, skipping..."
continue
fi
info "Copying certificates to '$target_dir'"
if ! (cp "${certs_src_dir}/"{privkey,fullchain,cert}.pem "$target_dir/" && \
chown root:root "$target_dir/"{privkey,fullchain,cert}.pem); then
warn "Error copying or chowning certs to ${target_dir}"
fi
done
# 4. Restart services & packages
# ==============================
info "Rebooting all the things..."
for service in "${services_to_restart[@]}"; do
/usr/syno/bin/synosystemctl restart "$service"
done
for package in "${packages_to_restart[@]}"; do # Restart packages that are installed & turned on
/usr/syno/bin/synopkg is_onoff "$package" 1>/dev/null && /usr/syno/bin/synopkg restart "$package"
done
# Restart nginx
if ! /usr/syno/bin/synow3tool --gen-all && sudo /usr/syno/bin/synosystemctl restart nginx; then
warn "nginx failed to restart"
fi
info "Completed"
@DianLiI
Copy link

DianLiI commented Feb 20, 2023

I think there is a bug where line 22 always returns true. Should the line be if [ "$DEFAULT_DIR_NAME" != "" ]; then instead?

@MrPeteH
Copy link

MrPeteH commented Mar 15, 2023

Yes, synosystemctl is DMS7. Here's a link to my DSM7 version. NOTE that some packages do not use either synoservicectl OR synosystemctl... but synopkg instead! https://gist.github.com/MrPeteH/80b487a2f400e5c0d538b18ae2f5dd76

@catchdave
Copy link
Author

Refactored script to be cleaner and added some packages to restart as per @MrPeteH.

@MrPeteH
Copy link

MrPeteH commented Mar 22, 2023

Refactored script to be cleaner and added some packages to restart as per @MrPeteH.*

WONDERFUL refactor job!

Unfortunately, I found some challenges...

First, what appears to be a bug:

  • While it DOES work to copy the three files to the system/default and system/FQDN folders (privkey,fullchain,cert}.pem
    • DSM does some work in those two folders automagically, to create/update four additional files: chain.pem, info (no extn), root.pem, and short-chain.pem
    • But DSM doesn't do that in any of the other folders.
    • SO, this script needs to copy all seven files from the source folder, not just three! (I do not know what process causes the extra updates, nor how quickly. seems very fast...)
    • (Just do find / -name cert.pem to discover all of yours... )

Next, suggestions that relate to the up-front instructions:

  • Many like to configure an alt ssh port. To specify the port in scp, use -P nnnn, in ssh -p nnnn
  • DSM wipes out all customizations to sudoers on update. So it's better to recommend adding a line to sudoers.d/sudo-USER
  • Sadly, brace expansion doesn't work in /bin/sh which can easily be the default shell for embedded scripts (like in ACME actions!) -- best workaround is either spell it all out, or embed the script in a script file with #!/bin/csh or whatever... (I just now discovered this was killing some of my automation :( )

@catchdave
Copy link
Author

catchdave commented Mar 22, 2023

@MrPeteH : Thanks!

  1. Regarding the other files beyond the 3 certs not being copied - have you noticed any issues with them not moving? As I use this script every 90 days (via letsencrypt), I have no problems in SSL certs working in all applications that use SSL certs on my Nas. Perhaps these files don't matter? On my NAS, I have not noticed any issues.
  2. Sudo and ports. Yes true to both - I have only noticed a wipe on a major upgrade (from 6.x to 7.x), minor updates are fine. I can look into testing what works. FWIW, my main focus on this gist on moving certs, I have so far intentionally been vague about managing SSH access (I figure anyone doing this stuff has ssh/sudo figured out already)
  3. Brace expansion. I understand /bin/sh doesn't support it. However, this script is explicit about using bash and is designed to run on synology (which has bash) via a direct ssh call. If you're using parts of this script in somewhere else - that's fine, but not it's not my intention to support uses outside of being executed directly (which will always use /bin/bash). How are you calling this script?

@MrPeteH
Copy link

MrPeteH commented Mar 22, 2023

  1. Brace expansion. I understand /bin/sh doesn't support it. However, this script is explicit about using bash and is designed to run on synology (which has bash) via a direct ssh call. If you're using parts of this script in somewhere else - that's fine, but not it's not my intention to support uses outside of being executed directly (which will always use /bin/bash). How are you calling this script?

I'm talking about the recommended calling usage in the comments at the top... which of course is assumed to be in some OTHER machine, using scp and ssh to get the data to the Synology NAS. :)

The other files: I did see an issue once, but not since. All I know is, DSM creates those other files, and copies them all when installing a package. No idea why they don't get updated when the main system certs update. Perhaps we could call that a DSM bug LOL

@catchdave
Copy link
Author

catchdave commented Mar 23, 2023

I'm talking about the recommended calling usage in the comments at the top... which of course is assumed to be in some OTHER machine, using scp and ssh to get the data to the Synology NAS. :)

Makes sense! Appreciate the explanation :) @MrPeteH

@fhemberger
Copy link

fhemberger commented Apr 6, 2023

Thanks for the script! To make it a bit more dynamic, you can discover the target directories and the services/packages to restart:

# Output *all* parameters handed to the method (required to dump arrays)
error_exit() { echo "[ERROR] $*"; exit 1; }
warn() { echo "[WARN ] $*"; }
info() { echo "[INFO ] $*"; }
debug() { [[ "${DEBUG}" ]] && echo "[DEBUG ] $*"; }

# ...

service_cert_dirs="$(find /usr/syno/etc/certificate -name "cert.pem" -exec dirname {} \;)"
package_cert_dirs="$(find /usr/local/etc/certificate -name "cert.pem" -exec dirname {} \;)"

services_to_restart=()
for service in $service_cert_dirs; do
  service_name="$(echo "$service" | grep -Po '/usr/syno/etc/certificate/\K[^/]+')"
  if [[ "$service_name" != "system" && "$service_name" != "_archive" && "$service_name" != "ReverseProxy" ]]; then
    services_to_restart+=("$service_name")
  fi
done;

packages_to_restart=()
for package in $package_cert_dirs; do
  package_name="$(echo "$package" | grep -Po '/usr/local/etc/certificate/\K[^/]+')"
  packages_to_restart+=("$package_name")
done;

debug "Services to restart: ${services_to_restart[*]}"
debug "Packages to restart: ${packages_to_restart[*]}"

@footswitch
Copy link

footswitch commented Apr 9, 2023

[EDIT] I was using the wrong chain file.

First of all let me thank you for sharing this. I have win-acme (Let's Encrypt) renewing the certificates on a Windows machine, and need a way of replacing the certificates in Synology automatically.

I'm on DSM 7.1-42661 Update 4
I tried, to the best of my abilities, to adapt this script for my NAS (adding packages to restart, and target dirs).
I copied my adaptation to a new Task, running as root, and in the Task Log I can see that the script executes all steps successfully.
(Except Surveillance Station)

[EDIT] reloading nginx instead of restarting, the output is this:

Failed to restart package [SurveillanceStation], err=[272]
Sync W3 certificate info successfully
Generated nginx tmp config is not valid
Job for nginx.service failed. See "systemctl status nginx.service" and "journalctl -xe" for details.

But after completion, I'm always getting all the apps greyed out with an exclamation sign, even if I restart DSM altogether.
After restarting I can no longer access DSM via https, only via http.
And to rectify all that, I have to go into Control Panel -> Security, and re-add (import and replace) the default certificate.

After doing that, I have to restart once more, and one app still needs to be repaired - Surveillance Station.
Note: in the case of Surveillance Station, it has an App Portal configured (Control Panel -> Login Portal).
But I added another loop to replace certificates in AppPortal as well - for proxy in /usr/syno/etc/certificate/AppPortal/*/; do ...

I'm really at a loss here...
Can you share your experience?

@fhemberger
Copy link

@footswitch Have you tried running nginx -t to see what's wrong with the nginx config? Do the certificate and key file have the right user/access rights?

@footswitch
Copy link

footswitch commented Apr 9, 2023

[EDIT] I was using the wrong chain file.

@fhemberger, the files are copied and chowned, and if that wasn't the case, the script would output the warning Error copying or chowning(...)
Querying nginx -t before the script:

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful

After replacing the cert files and reloading nginx:

nginx: [emerg] SSL_CTX_use_PrivateKey("/usr/syno/etc/www/certificate/system_default/3e35dc1f-4740-487a-b658-90708050766e.pem") failed (SSL: error:0B080074:lib(11):func(128):reason(116))
nginx: configuration file /etc/nginx/nginx.conf test failed

I'm using the exact same files when importing/replacing the certificate via DSM portal.

My Log looks like this:

[INFO ] ok privkey.pem exists.
[INFO ] ok cert.pem exists.
[INFO ] ok fullchain.pem exists.
[INFO ] Certs chowned at source dir.
[INFO ] Copying certificates to '/usr/syno/etc/certificate/system/default'
[INFO ] Copying certificates to '/usr/syno/etc/certificate/smbftpd/ftpd'
[INFO ] Copying certificates to '/usr/local/etc/certificate/HyperBackupVault/HyperBackupVault'
[INFO ] Copying certificates to '/usr/local/etc/certificate/LogCenter/pkg-LogCenter'
[INFO ] Copying certificates to '/usr/local/etc/certificate/PrestoServer/PrestoServer'
[INFO ] Copying certificates to '/usr/local/etc/certificate/ReplicationService/snapshot_receiver'
[INFO ] Copying certificates to '/usr/local/etc/certificate/ScsiTarget/pkg-scsi-plugin-server'
[INFO ] Copying certificates to '/usr/local/etc/certificate/SynologyDrive/SynologyDrive'
[INFO ] Copying certificates to '/usr/local/etc/certificate/VPNCenter/OpenVPN'
[INFO ] Copying certificates to '/usr/syno/etc/certificate/_archive/PrfwoX'
[INFO ] Copying certificates to '/usr/syno/etc/certificate/AppPortal/SurveillanceStation_AltPort/'
[INFO ] Rebooting all the things...
Fail to restart [nmbd]. # this was in the original script so I just left it there anyway.
[avahi] restarted.
Fail to restart [ldap-server]. # this was in the original script so I just left it there anyway.
[ftpd] restarted.
restart package [HyperBackup] successfully
restart package [HyperBackupVault] successfully
restart package [LogCenter] successfully
restart package [PrestoServer] successfully
restart package [ReplicationService] successfully
restart package [ScsiTarget] successfully
restart package [SynologyDrive] successfully
restart package [VPNCenter] successfully
Failed to restart package [SurveillanceStation], err=[272]
Sync W3 certificate info successfully
Generated nginx tmp config is not valid
Job for nginx.service failed. See "systemctl status nginx.service" and "journalctl -xe" for details.
[INFO ] Completed


systemctl status nginx.service

(...)
ExecReload=/usr/syno/bin/synow3tool --nginx=reload (code=exited, status=1/FAILURE)
(...)
Start Nginx Server in Abnormal Mode ......
(...)
nginx.service: control process exited, code=exited status=1
Reload failed for Nginx.

@MrPeteH
Copy link

MrPeteH commented Apr 9, 2023

I'm talking about the recommended calling usage in the comments at the top... which of course is assumed to be in some OTHER machine, using scp and ssh to get the data to the Synology NAS. :)

Makes sense! Appreciate the explanation :) @MrPeteH

FWIW, I just did a deeper dive on why platforms like pfSense don't have bash-type shells at all. It's because the security "attack surface" is too large for such capable shells. So they don't have it and discourage installing it! I can understand that... and in this case, the cost is simply to pre-expand those file lists. :)

@footswitch
Copy link

footswitch commented Apr 13, 2023

[EDIT] I was using the wrong chain file.

So I updated to the latest DSM 7.1.1-42962 Update 4, and I'm still facing the same issues.
After running the script, basically everything stops working, and I have to manually import the certificate files in Control Panel --> Security, to restore functionality.
I even changed the script back, to copy the files first to the default directory - thought it could make a difference.
I really don't get what I'm doing wrong, compared to your positive experiences.

Running Task as root

#!/bin/bash

DEBUG=  # Set to any non-empty value to turn on debug mode
error_exit() { echo "[ERROR] $1"; exit 1; }
warn() { echo "[WARN ] $1"; }
info() { echo "[INFO ] $1"; }
debug() { [[ "${DEBUG}" ]] && echo "[DEBUG ] $1"; }

# 1. Initialization
# =================
[[ "$EUID" -ne 0 ]] && error_exit "Please run as root"  # Script only works as root

certs_src_dir="/volume1/exch-cert" # where the new certificate files are located
certs_default_dir="/usr/syno/etc/certificate/system/default"
services_to_restart=("nmbd" "avahi" "ldap-server" "ftpd")
packages_to_restart=(
	"FQDN"
	"HyperBackup"
	"HyperBackupVault"
	"LogCenter"
	"PrestoServer"
	"ReplicationService"
	"ScsiTarget"
	"SynologyDrive"
	"VPNCenter"
	"WebDAVServer"
	"SurveillanceStation"
	)
	
# "ActiveBackup" # ActiveBackup uses a self signed certificate.

target_cert_dirs=(
    "/usr/syno/etc/certificate/system/FQDN"
	"/usr/syno/etc/certificate/smbftpd/ftpd"
	"/usr/local/etc/certificate/HyperBackupVault/HyperBackupVault"
	"/usr/local/etc/certificate/LogCenter/pkg-LogCenter"
	"/usr/local/etc/certificate/PrestoServer/PrestoServer"
	"/usr/local/etc/certificate/ReplicationService/snapshot_receiver"
	"/usr/local/etc/certificate/ScsiTarget/pkg-scsi-plugin-server"
    "/usr/local/etc/certificate/SynologyDrive/SynologyDrive"
	"/usr/local/etc/certificate/VPNCenter/OpenVPN"
    "/usr/local/etc/certificate/WebDAVServer/webdav"
	)
	
# "/usr/local/etc/certificate/ActiveBackup/ActiveBackup" # ActiveBackup uses a Long Term self signed certificate.


# Check files exist at source dir
if [ -e "${certs_src_dir}/privkey.pem" ]
then
    info "ok privkey.pem exists in source dir."
else
    error_exit "privkey.pem not found in source dir. Exiting with no changes."
fi

if [ -e "${certs_src_dir}/cert.pem" ]
then
    info "ok cert.pem exists in source dir."
else
    error_exit "cert.pem not found in source dir. Exiting with no changes."
fi

if [ -e "${certs_src_dir}/fullchain.pem" ]
then
    info "ok fullchain.pem exists in source dir."
else
    error_exit "fullchain.pem not found in source dir. Exiting with no changes."
fi



# Find the default certificate directory
default_dir_name=$(</usr/syno/etc/certificate/_archive/DEFAULT)
if [[ -n "$default_dir_name" ]]; then
    target_cert_dirs+=("/usr/syno/etc/certificate/_archive/${default_dir_name}")
    debug "Default cert directory found: '/usr/syno/etc/certificate/_archive/${default_dir_name}'"
else
    warn "No default directory found. Probably unusual? Check: 'cat /usr/syno/etc/certificate/_archive/DEFAULT'"
fi

# Add Reverse Proxy App directories
for proxy in /usr/syno/etc/certificate/ReverseProxy/*/; do
    debug "Found ReverseProxy dir: ${proxy}"
    target_cert_dirs+=("${proxy}")
done

# Add AppPortal directories
for proxy in /usr/syno/etc/certificate/AppPortal/*/; do
    debug "Found AppPortal dir: ${proxy}"
    target_cert_dirs+=("${proxy}")
done


[[ "${DEBUG}" ]] && set -x


# 2. root own certificates in source dir
# =============================================================
cp "${certs_src_dir}/"{privkey,fullchain,cert}.pem "${certs_default_dir}/" || error_exit "Halting because of error moving files"
chown root:root "${certs_default_dir}/"{privkey,fullchain,cert}.pem || error_exit "Halting because of error chowning files"
info "Certs copied and chowned at system default dir."

# 3. Copy certificates to target directories if they exist
# ========================================================
for target_dir in "${target_cert_dirs[@]}"; do
    if [[ ! -d "$target_dir" ]]; then
      debug "Target cert directory '$target_dir' not found, skipping..."
      continue
    fi

    info "Copying and chowning certificates to '$target_dir'"
    if ! cp "${certs_default_dir}/"{privkey,fullchain,cert}.pem "$target_dir/" && \
        chown root:root "$target_dir/"{privkey,fullchain,cert}.pem; then
          warn "Error copying or chowning certs to ${target_dir}"
    fi
done


# Remove cert files from source folder
rm "${certs_src_dir}/privkey.pem"
rm "${certs_src_dir}/fullchain.pem"
rm "${certs_src_dir}/last-cert.pem"
# Rename cert.pem to last-cert.pem
mv "${certs_src_dir}/cert.pem" "${certs_src_dir}/last-cert.pem"


# 4. Restart services & packages
# ==============================
info "Rebooting all the things..."
for service in "${services_to_restart[@]}"; do
    /usr/syno/bin/synosystemctl restart "$service"
done

for package in "${packages_to_restart[@]}"; do  # Restart packages that are installed & turned on
    /usr/syno/bin/synopkg is_onoff "$package" 1>/dev/null && /usr/syno/bin/synopkg restart "$package"
done

# Restart nginx !!! WARNING !!! this may behave unexpectedly (for instance restarts running VMs / Docker images)
# /usr/syno/bin/synosystemctl restart nginx

# In DSM7 to avoid docker and VMM to restart when restarting nginx use:
# synow3tool --gen-all && systemctl reload nginx
# source: https://www.reddit.com/r/synology/comments/olve56/comment/h5hsogq/

# Faster ngnix restart (if certs don't appear to be refreshing, change to synosystemctl
if ! /usr/syno/bin/synow3tool --gen-all && sudo systemctl reload nginx; then
    warn "nginx failed to reload"
fi


info "Completed"

@telnetdoogie
Copy link

Been playing with this quite a bit, and note I'm using DSM 7.2 beta right now. Was working "ok" but refreshing the certs remained a problem for me, unless I did the full restart which restarted docker and everything - less than optimal.

Here's my modified section 4 which seems to work and I can consistently reproduce (test is to manually update cert with an old one thru UI, then once I've validated the date of the cert, fully close browser, run the script in command line, wait 20 seconds for all restarts to 'take', and then re-open DSM in the browser and re-check the certificate date. So far working well.

# 4. Restart services & packages
# ==============================
info "Rebooting all the things..."
for service in "${services_to_restart[@]}"; do
        /usr/syno/bin/synosystemctl restart "$service"
done
for package in "${packages_to_restart[@]}"; do  # Restart packages that are installed & turned on
        /usr/syno/bin/synopkg is_onoff "$package" 1>/dev/null && /usr/syno/bin/synopkg restart "$package"
done

# Faster ngnix restart (if certs don't appear to be refreshing, change to synosystemctl
if ! /usr/syno/bin/synow3tool --gen-all ; then
    warn "synow3tool --gen-all failed"
fi
if ! /usr/syno/bin/synow3tool --nginx=reload ; then
    warn "/usr/syno/bin/synow3tool --nginx=reload failed"
fi
if ! /usr/syno/bin/synow3tool --restart-dsm-service; then
    warn "/usr/syno/bin/synow3tool --restart-dsm-service failed"
fi

info "Completed"

@telnetdoogie
Copy link

telnetdoogie commented Apr 16, 2023

If anyone is still watching this thread / script... I did some research on what exactly happens when you run synow3tool --gen-all
Basically this command will take the certs from the /usr/syno/etc/certificate/_archive folder and sync all of the other appropriate folders with that certificate. It:

  • Reads the cert files in /usr/syno/etc/certificate/_archive/{randomchars}
  • Re-creates all of the folders in /usr/syno/etc/certificate/ReverseProxy with completely new folders with the certs, and removes the old ones.
  • Creates a new version of the /usr/syno/etc/certificate/system/FQDN folder (naming it something like FQDN.temp)
  • Updates the certs in /usr/syno/etc/certificate/system/FQDN.temp with the ones from archive
  • Deletes /usr/syno/etc/certificate/system/FQDN
  • Renames /usr/syno/etc/certificate/system/FQDN.temp to /usr/syno/etc/certificate/system/FQDN
  • Creates /usr/syno/etc/certificate/system/default.temp
  • Copy all of the certs from /usr/syno/etc/certificate/_archive/{randomchars} to /usr/syno/etc/certificate/system/default.temp
  • Renames /usr/syno/etc/certificate/system/default.temp to /usr/syno/etc/certificate/system/default

...So... basically it looks like the much simpler option is to drop your new certs in the /usr/syno/etc/certificate/_archive/{randomchars} folder and then run synow3tool --gen-all as root. There's no need to do the ReverseProxy folders or the FQDN folders for example.

Because I have no services installed like HyperBackupVault etc., I can't tell if those are taken care of by the synow3tool as well or not, I'll do more research there.

In my case, the only additional folders I have that don't seem to be taken care of by the synow3tool sync are:

  • /usr/syno/etc/certificate/kmip/kmip (Key Manager)
  • /usr/syno/etc/certificate/smbftpd/ftpd (FTPS)

@footswitch
Copy link

footswitch commented Apr 18, 2023

[EDIT] I was using the wrong chain file.

@telnetdoogie this is still not working for me. But at least now I got more descriptive errors...

[WARN ] synow3tool --gen-all failed
(...)
nginx: [emerg] SSL_CTX_use_PrivateKey("/usr/syno/etc/www/certificate/system_default/b4d6e608-ec11-4368-8219-db76840ed58f.pem") failed (SSL: error:0B080074:x509 certificate routines:X509_check_private_key:key values mismatch)
(...)
/usr/syno/bin/synow3tool: unrecognized option '--restart-dsm-service'

@footswitch
Copy link

footswitch commented Apr 18, 2023

[EDIT] I was using the wrong chain file.

[EDIT] Deleting stuff under /usr/syno/etc/www/certificate/[...] messed up my DSM installation.
So my recommendation is don't do it.

If I remove everything inside /usr/syno/etc/www/certificate/system_default/, then synow3tool --gen-all will generate the necessary certificates in those folders.
Also, the SurveillanceStation folder that was missing from my configuration was also located there /usr/syno/etc/www/certificate/
However, I still get this error Generated nginx tmp config is not valid, which only happens if I change the certificates in the other folders.
I still don't know what am I missing here.

@fhemberger
Copy link

@footswitch The error message hints at the key you are copying doesn't match the underlying CSR of the certificate. It's not a matter of the script.

@footswitch
Copy link

@fhemberger THANK YOU for making me recheck everything. It was painful but I got it now.
DSM was misleading me to use the wrong "chain" file all along.
My certificate files are generated with win-acme, which outputs four files:
...-key.pem --> privkey.pem
...-crt.pem --> cert.pem
...-chain-only.pem --> fullchain.pem (wrong)
...-chain.pem -- NOT USED

When I replace the certificate in the UI (Control Panel --> Security --> Certificates), I select these files above, with ...-chain-only.pem being the intermediate certificate, and the certificate was getting replaced with no errors.

But in order for the script to work, the files must be:
...-key.pem --> privkey.pem
...-crt.pem --> cert.pem
...-chain-only.pem -- NOT USED
...-chain.pem --> fullchain.pem (right)

@carmatana
Copy link

carmatana commented Apr 19, 2023

@footswitch

After reading your last comment, specifically the part of Win-Acme...

you (and others) may benefit of using docker-certbot direct in your synology.

I use the certificates only for the Reverse Proxy (in conjunction to Pomerium) to access my docker containers and the DSM interface

I created the certificates with:

docker run -it --rm --name certbot -v "/volume1/Primero/Certs/certbot/etc/letsencrypt:/etc/letsencrypt" -v "/volume1/Primero/Certs/certbot/var/lib/letsencrypt:/var/lib/letsencrypt" -v "/volume1/Primero/Certs/certbot/log/:/var/log" -v "/volume1/Primero/Certs/certbot/certs_to_syno:/certs" certbot/certbot certonly --agree-tos --manual --manual-auth-hook /etc/letsencrypt/acme-dns-auth.py --preferred-challenges dns --debug-challenges -d *.carXXXXXX.xyz -d carXXXXXX.xyz

And then I have a scheduled task in Synology's task scheduler that runs every X days to renovate them with:

docker run --rm --name certbot -v "/volume1/Primero/Certs/certbot/etc/letsencrypt:/etc/letsencrypt" -v "/volume1/Primero/Certs/certbot/var/lib/letsencrypt:/var/lib/letsencrypt" -v "/volume1/Primero/Certs/certbot/log/:/var/log/letsencrypt/" -v "/volume1/Primero/Certs/certbot/certs_to_syno:/certs" certbot/certbot renew --no-random-sleep-on-renew --deploy-hook "cp /etc/letsencrypt/live/caXXXXXX.xyz/*.pem /certs"

With the last part of the renovation command (--deploy-hook "cp...."), if the certificates were renovated (meaning the time to do so has arrived, the standard is 30 days before expiration) , the certificates are copied to a specific directory and then (not included above) copied to the correspondent directory inside the synology directory (in my case: /usr/syno/etc/certificate/_archive/u0rjgL) . I could copy them directly to the final the synology directory but I use this bridge to detect any error in the process.

Then, for me it is enough to have in the script:

synow3tool --gen-all && systemctl reload nginx

to have the new certifcates "activated" for the reverse proxy

With this script I have the full end-to-end process automated: from renovation to activation.

The script has to be run with root privileges.

The complete script does a lot of validations that may be redundant, I am not sharing it here because it does not have a good "coding standard" (i.e. I use hard values instead of variables) and comments are in spanish but happy to share more info if required.

@footswitch
Copy link

@carmatana thank you for your input.
In my case we have the certs in Windows because we need them there to begin with.
In this discussion we all have the same starting point: our certificates aren't managed by DSM.
The only thing I didn't test, is if it's enough to copy just to a single default folder, and run:
synow3tool --gen-all && systemctl reload nginx
Or if we do need to copy to every folder and restart every service.

@telnetdoogie
Copy link

@footswitch dropping the certs, named appropriately, in the …/_archive/{randomletters referred to in DEFAULT} and then running the three commands:

/usr/syno/bin/synow3tool --gen-all
/usr/syno/bin/synow3tool --nginx=reload
/usr/syno/bin/synow3tool --restart-dsm-service

should take care of most needs. But as the script above shows, there are some additional folders where certificates are also stored that the above three commands won’t sync to. My latest thoughts are that it might be a good idea to just replace these folders with symlinks to the default folder so it’s easier to keep everything synced, versus copying the certs into more locations. But I haven’t tried that, nor am I sure that those other locations are actually needed or referenced anywhere.

@telnetdoogie
Copy link

I’ve been keeping my own tweaked version of this awesome script Here which, similar to @carmatana - I generate certs with certbot in docker on the synology on a schedule. I don’t use the scp portion to copy, and I just schedule this script to run every week so I added logic to check to see whether the latest certs differ from those already installed for DSM and only do the updates and sync if they are different.

@MrPeteH
Copy link

MrPeteH commented Apr 21, 2023

@telnetdoogie essentially, your "external" source of certs is the docker.

It's still external; the difference is you have kinda direct access to the Synology filesystem.
Some people have SMB access to the filesystem.
Some have scp access to the filesystem.
It's all good. :-D

@MrPeteH
Copy link

MrPeteH commented Apr 21, 2023

The big picture for this:

  • We all generate the certs somewhere, potentially for use in a number of places on our network.
  • We need to get the certs regularly and automagically installed and running in a Synology

So we

  1. copy updated certs into the Syno
  2. run this script which puts them in all the necessary places
  3. AND it restarts necessary packages/services

@edvalley
Copy link

Sorry, but I think acmesh perfectly fits this use case. That said, of course, this is not the same case where your Synology device has Internet access and you can use Let's Encrypt directly from DSM web interface.

@MrPeteH
Copy link

MrPeteH commented Apr 27, 2023

Sorry, but I think acmesh perfectly fits this use case. That said, of course, this is not the same case where your Synology device has Internet access and you can use Let's Encrypt directly from DSM web interface.

Many of us use exactly that somewhere else. The whole purpose of this script is properly injecting the resulting certs into DSM :)

@edvalley
Copy link

Sorry, but I think acmesh perfectly fits this use case. That said, of course, this is not the same case where your Synology device has Internet access and you can use Let's Encrypt directly from DSM web interface.

Many of us use exactly that somewhere else. The whole purpose of this script is properly injecting the resulting certs into DSM :)

What I meant was that acmesh has a deploy hook for Synology DSM. Read some info here.

@ridv
Copy link

ridv commented May 9, 2023

Highly suggest checking out https://github.com/reddec/syno-cli/tree/master

It uses the same API as acmesh but it's in an easy to consume cli for folks to leverage.

@MrPeteH
Copy link

MrPeteH commented May 15, 2023

@edvalley and @ridv

What I meant was that acmesh has a deploy hook for Synology DSM. Read some info here.

According to those documents, this deploy hook does install the cert into DSM, but does NOT install it into the various packages and services ("Certificate should now show up in "Control Panel" -> "Security" -> "Certificates" and can be assigned to Services..."). This script does it all rather nicely.

I love the exploring being done by everyone! It's true:

  • Those who can use acme.sh deploy hooks can take care of the transfer to DSM more easily that way
  • If synow3tool --gen-all takes care of deploying into all packages and services, then the rest of the work can be avoided

I'll do some exploring on both for my use case, when I get a few more round 'tuits. ;)
(My use case: certs generated in pfSense on another host+VM.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment