catchdave/replace_synology_ssl_certs.sh

Redjard · 2024-10-23T14:23:59Z

@bungabear @catchdave
I did have problems with the script overwriting a second certificate I created with letsencrypt through dsm for something else.
In the process of fixing that I rewrote the core part of the script, and then a lot more of it around that

The entire rewritten script

# *** 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 your.domain.org'


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"; }

shopt -s nullglob  # allows wildcards like /usr/syno/etc/certificate/_archive/*/ without them adding that literal string if they don't match anything

# 0. Checks
[[ "$EUID" -ne 0 ]] && error_exit "Please run as root"  # Script only works as root
[[ "${DEBUG}" ]] && set -x

# 1. Config
# =================
hostname="$1"  # will update all certs signing for this hostname
# cert="/etc/redjard-certs/$hostname.crt"
# fullchain="/etc/redjard-certs/$hostname.crt"  # usually the cert already has the chain in it
# privkey="/etc/redjard-certs/$hostname.key"
cert="/tmp/$hostname.crt"
fullchain="/tmp/$hostname.crt"  # usually the cert already has the chain in it
privkey="/tmp/$hostname.key"

services_to_restart=("nmbd" "avahi" "ldap-server")
packages_to_restart=("ScsiTarget" "SynologyDrive" "WebDAVServer" "ActiveBackup")
target_cert_dirs=( # directories that have cert.pem, fullchain.pem, and privkey.pem
	"/usr/local/etc/certificate/ActiveBackup/ActiveBackup"
	"/usr/local/etc/certificate/LogCenter/pkg-LogCenter"
	"/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/WebStation/"*/
	"/usr/syno/etc/certificate/system/default"
	"/usr/syno/etc/certificate/system/FQDN"
	"/usr/syno/etc/certificate/smbftpd/ftpd"
	/usr/syno/etc/certificate/_archive/*/
	"/usr/syno/etc/certificate/ReverseProxy/"*/
)
target_obfuscated_cert_dirs=( # for directories that have one cert.conf in nginx format, pointing files in style 01234567-89ab-cdef-0123-456789abcdef.pem
	/usr/syno/etc/www/certificate/system_FQDN
	/usr/syno/etc/www/certificate/system_default
	/usr/syno/etc/www/certificate/ReverseProxy_*/
	/usr/syno/etc/www/certificate/WebStation_*/
)

# 2. 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
	
	# synology generated letsencrypt certs have different filenames, but we don't touch them anyway
	if ! openssl verify -show_chain -x509_strict -verify_hostname "$hostname" -untrusted "$target_dir/cert.pem" "$target_dir/cert.pem" >/dev/null 2>&1; then
		debug "Skipping $target_dir as the cert doesn't sign for $hostname"
		continue
	fi
	
	debug "Copying certificates to '$target_dir'"
	cp "$cert" "$target_dir/cert.pem"
	cp "$fullchain" "$target_dir/fullchain.pem"
	cp "$privkey" "$target_dir/privkey.pem"
	
	# is this necessary?
	if ! chown root:root "$target_dir/"{privkey,fullchain,cert}.pem; then
		warn "Error copying or chowning certs to ${target_dir}"
	fi
done

# somehow WebStation ends up not getting applied later, so lets manually do it (if it works later it will simply get overwritten)
for target_dir in "${target_obfuscated_cert_dirs[@]}"; do
	if [[ ! -d "$target_dir" ]]; then
		debug "Target obfuscated cert directory '$target_dir' not found, skipping..."
		continue
	fi
	
	target_crt=$( grep -o "$target_dir"/cert.conf -Pe '(?<=ssl_certificate\s)\s*.*(?=;$)'     | head -n 1 | xargs )
	target_key=$( grep -o "$target_dir"/cert.conf -Pe '(?<=ssl_certificate_key\s)\s*.*(?=;$)' | head -n 1 | xargs )
	
	# synology generated letsencrypt certs have different filenames, but we don't touch them anyway
	if ! openssl verify -show_chain -x509_strict -verify_hostname "$hostname" -untrusted "$target_crt" "$target_crt" >/dev/null 2>&1; then
		debug "Skipping obfuscated $target_dir as the cert doesn't sign for $hostname"
		continue
	fi
	
	debug "Copying obfuscated certificates to '$target_dir'"
	cp "$fullchain" "$target_crt"
	cp "$privkey" "$target_key"
done

# 3. 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 && sudo systemctl reload nginx; then
    warn "nginx failed to restart"
fi

nginx -s reload

info "Completed"

Basically, the core part is openssl verify -show_chain -x509_strict -verify_hostname "$hostname" -untrusted "$target_dir/cert.pem" "$target_dir/cert.pem".
My modified version is called as syno_insert_cert "redjard.org" (replacing in your own domain naturally).
It will check if the certificate signs for the specified domain, and only replaces it if it does. (Works with any valid domain, doesn't have to be the main one. It would even be possible to add specific domains to certificates only for the purpose of telling them apart.)
I think this command also fails if the certificate is expired, there might be the flag -no_check_time which can be added but I have not confirmed if it works.

Since the script already has a more reliable criterium to find the correct certificates, I removed other conditions and simply added a list of directories to look through and potentially replace certificates in.

I have one loop for directories that have named files, where it replaces cert.pem, fullchain.pem, and privkey.pem, and one loop for directories specifically for some nginx usecases, which have a cert.conf pointing to obfuscated filenames.
The script loops over both these lists and replaces any matching certificates.
If any new location for certificate comes up, one can simply import their certificate, and grep for some string within it throughout the dsm filesystem, then add the discovered directories to the respective list.

I think this is a lot more readable than the original script which has a lot more special cases.

This is my own fork of the script which I have used for quite a while. I have had no issues for my usecase. I tried to quickly rewrite it a bit to get it back in line with how the original script worked, but it might need a few more tweaks to be fully backwards compatible (minus needing a domain name argument).

mamema · 2024-10-30T10:23:24Z

the script from @catchdave imports the certs but at the same time removes all existing ones, as from synology itself for example. Which leads to a non functioning package center.....

catchdave · 2024-10-30T14:30:22Z

@mamema —which line of my script removes existing certs? It is simply a move, chown and restart.

If you’re having issues, please provide more details.

mamema · 2024-10-30T14:55:50Z

i'm happy to provide more info.
It's just what i'm see after running your script.
Adhere to the infos (copy pem's to /tmp/ run the script. At that momernt only the orginal synology.com cert is there and afterwards the pem's get imported and the synolgy cert is gone.
You can test it by yourself with this solution: https://github.com/vdsm/virtual-dsm

catchdave · 2024-10-30T15:58:11Z

I don't see that on my two synology machines, and this is the first I am hearing of this issue. If you can provide specific details on your actual machine(s) that can help understand what is happening, I'm happy to modify the script. Details about DSM version, other scripts that are running, state of your machine and directory listing before and after would be helpful.

mamema · 2024-10-30T16:04:06Z

which directories do you want, it's a fresh install ds1819+ with latest DSM only script is yours?

catchdave · 2024-10-30T19:35:20Z

The directory before and after executing the script that contains the missing/changed certs you say get removed (ls -la).

As much info you can provide - which specific files in which directory go missing, how does this look in the directory on the CLI, how does it look in the UI, etc.

Where is your default cert that goes missing located?

catchdave · 2024-10-31T04:58:41Z

@mamema . This might be helpful to find all certs on your box: https://gist.github.com/catchdave/ff9c7d7a396a3201cfb14f912d3e5cda

mamema · 2024-10-31T14:32:36Z

�[1m=== Summary ===�[0m
�[1;97m�[1;100mTotal Directories �[0m | �[1m8 �[0m
�[1;97m�[1;100mTotal Certificates �[0m | �[1m20 �[0m
�[1;97m�[1;100mTotal Dirs w/ no valid cert �[0m | �[1m1 �[0m
�[1;97m�[1;100mTotal Valid Certs �[0m | �[1m19 �[0m
�[1;97m�[1;100mTotal InValid Certs �[0m | �[1m1 �[0m

all in all only Synology certs. And the remains of my trying import my own certs. They are lying around, but i've had already to reset the certs, as i said, the cert from synology wasn't shown in the security/cert gui area and the package manager wasn't working.
Perhaps this was a missundestanding, the certs are physically there on disk, but after runing your script, the synology one, wasn't shown in the security gui area of DSM

catchdave · 2024-10-31T17:18:28Z

If the certs are physically there, I'm not sure besides maybe how services were restarted would affect the GUI.

I assume you tried restarting the machine?

mamema · 2024-10-31T19:50:07Z

of course. can i enable somew kind of debugging with your script?

catchdave · 2024-11-05T16:46:04Z

@mamema - yes set a manual DEBUG flag in the script (change DEBUG= line to DEBUG=1). This will both print out manual debug statements and turn on set -x which will echo each command before execution.

catchdave · 2024-11-05T20:03:33Z

As the comment threads for this once upon a time simple script ( 😄 ), I have moved this to a public repo instead. That way conversations about potential bugs can take place as issues.

See here: https://github.com/catchdave/ssl-certs/blob/main/replace_synology_ssl_certs.sh

telnetdoogie · 2024-11-09T01:27:15Z

I added a second domain to my Synology today and realized that with multiple certificates for different uses/destinations this got a bit more complex. I rewrote from scratch and it handles multiple certificates and their specific locations pretty well (work for a single cert as well)
https://github.com/telnetdoogie/synology-scripts/blob/main/check_certs.md

catchdave/replace_synology_ssl_certs.sh

Redjard commented Oct 23, 2024

mamema commented Oct 30, 2024

catchdave commented Oct 30, 2024

mamema commented Oct 30, 2024

catchdave commented Oct 30, 2024

mamema commented Oct 30, 2024

catchdave commented Oct 30, 2024

catchdave commented Oct 31, 2024

mamema commented Oct 31, 2024 •

edited

Loading

catchdave commented Oct 31, 2024

mamema commented Oct 31, 2024 •

edited

Loading

catchdave commented Nov 5, 2024 •

edited

Loading

catchdave commented Nov 5, 2024

telnetdoogie commented Nov 9, 2024

catchdave/replace_synology_ssl_certs.sh

Redjard commented Oct 23, 2024

mamema commented Oct 30, 2024

catchdave commented Oct 30, 2024

mamema commented Oct 30, 2024

catchdave commented Oct 30, 2024

mamema commented Oct 30, 2024

catchdave commented Oct 30, 2024

catchdave commented Oct 31, 2024

mamema commented Oct 31, 2024 • edited Loading

catchdave commented Oct 31, 2024

mamema commented Oct 31, 2024 • edited Loading

catchdave commented Nov 5, 2024 • edited Loading

catchdave commented Nov 5, 2024

telnetdoogie commented Nov 9, 2024

mamema commented Oct 31, 2024 •

edited

Loading

mamema commented Oct 31, 2024 •

edited

Loading

catchdave commented Nov 5, 2024 •

edited

Loading