群晖的证书以前一直用的是自己手动申请、手动上传,90天一到就得重新弄一遍,经常忘。这次改成用acme.sh在Mac上自动续期,证书用的是FreeSSL(现在叫LiteSSL)的免费证书,域名验证走腾讯云DNSPod的API,续期完再用脚本推送到群晖。
为什么没用acme.sh自带的群晖部署(synology_dsm):它要把群晖的账号密码保存在本机,开了两步验证的还要保存受信任设备,我不想把群晖管理员的凭据放在别的机器上,所以推送这一步改成了手动脚本,账号密码运行时输入,不保存。
一、准备工作
1. 腾讯云API密钥
域名的DNS在DNSPod,acme.sh用 dns_tencent 插件自动添加验证用的TXT记录,需要腾讯云的SecretId和SecretKey。
不要用主账号的密钥。在腾讯云 访问管理(CAM) 里新建一个子用户,只给它 QcloudDNSPodFullAccess 这一个权限,用这个子用户的密钥就行,万一泄露了也只能改DNS。
2. LiteSSL的EAB
LiteSSL的ACME接口需要EAB(External Account Binding),登录freessl.cn,在 自动化-EAB管理 里新建一组,会得到EAB KID和EAB HMAC Key。
注意:一组EAB只能绑定一个ACME账户,用过一次就不能再用了,再用会报 externalAccountRequired: External account binding has already been used。换电脑或者重新注册账户的时候,要去控制台新建一组。
二、安装acme.sh并申请证书
- 安装acme.sh(邮箱换成自己的)
curl https://get.acme.sh | sh -s email=你的邮箱- 用EAB注册LiteSSL的账户
~/.acme.sh/acme.sh --register-account --server https://acme.litessl.com/acme/v2/directory \
--eab-kid 你的KID --eab-hmac-key 你的HMAC- 导入腾讯云密钥,申请证书(我用的是ECC证书)
export Tencent_SecretId=你的SecretId
export Tencent_SecretKey=你的SecretKey
~/.acme.sh/acme.sh --issue --server https://acme.litessl.com/acme/v2/directory \
-d nas.example.com --dns dns_tencent --keylength ec-256申请成功以后,这两个密钥会被保存到 ~/.acme.sh/account.conf,后面自动续期要用,这个文件不能删。如果以后在腾讯云把这组密钥删了或者换了,续期就会失败,要把新的密钥export一次再重新申请。
- 把证书装到指定目录
D=$HOME/SSL
~/.acme.sh/acme.sh --install-cert -d nas.example.com --ecc \
--key-file $D/privkey.pem --fullchain-file $D/fullchain.pem \
--cert-file $D/cert.pem --ca-file $D/chain.pem这个目录会被记住,以后每次续期都会自动更新这几个文件。大部分服务用 fullchain.pem 和 privkey.pem 就够了。
三、自动续期
安装acme.sh的时候会自动加一条crontab,用 crontab -l 能看到,大概是这样:
43 3,9,15,21 * * * ~/.acme.sh/acme.sh --cron --home ~/.acme.sh每天跑几次检查,到续期时间了就自动续。现在acme.sh会按CA给的续期窗口(ARI)决定什么时候续,不一定是固定的第60天。
Mac上的crontab只有开机并且没睡眠的时候才会执行,长时间不开机或者出门在外,记得手动续一下。
我写了个手动续期的脚本,存成 续期SSL证书.command,chmod +x 以后在Mac上双击就能运行:
#!/bin/bash
ACME_HOME="$HOME/.acme.sh"
DOMAIN="nas.example.com"
SSL_DIR="$HOME/SSL"
echo "当前证书:"
openssl x509 -in "$SSL_DIR/cert.pem" -noout -subject -enddate 2>/dev/null || echo "(未找到 $SSL_DIR/cert.pem)"
echo
read -r -p "是否强制续期?未到期时不加强制会直接跳过 [y/N] " ans
FORCE=""
"$ans" =~ ^[Yy]$ && FORCE="--force"
"$ACME_HOME/acme.sh" --home "$ACME_HOME" --renew -d "$DOMAIN" --ecc $FORCE
rc=$?
echo
echo "续期后证书:"
openssl x509 -in "$SSL_DIR/cert.pem" -noout -subject -enddate 2>/dev/null
echo
if [ $rc -eq 0 ]; then
echo "完成。"
elif [ $rc -eq 2 ]; then
echo "证书未到续期时间,已跳过。需要时可重新运行并选择强制续期。"
else
echo "续期失败(退出码 $rc),请查看上方日志。"
fi
read -r -p "按回车键关闭窗口..."acme.sh没到续期时间会返回2,所以单独判断了一下。
四、推送证书到群晖
脚本直接调群晖DSM的API,按证书的「描述」找到原来那张证书原地替换,原来是默认证书的还是默认证书,绑定在上面的服务(DSM、Photos、Drive、WebDAV这些)也不用重新设置。地址、端口、账号、密码、两步验证码都是运行时输入,不写到任何文件里。存成 推送证书到群晖.command:
#!/bin/bash
SSL_DIR="$HOME/SSL"
KEY="$SSL_DIR/privkey.pem"
CERT="$SSL_DIR/cert.pem"
CHAIN="$SSL_DIR/chain.pem"
finish() { echo; read -r -p "按回车键关闭窗口..."; exit "$1"; }
for f in "$KEY" "$CERT" "$CHAIN"; do
[ -f "$f" ] || { echo "缺少文件:$f"; finish 1; }
done
echo "待推送证书:"
openssl x509 -in "$CERT" -noout -subject -enddate
echo
read -r -p "群晖地址(域名或 IP): " HOST
read -r -p "DSM HTTPS 端口: " PORT
read -r -p "管理员账号: " USER
read -r -s -p "密码(输入时不显示): " PASS; echo
read -r -p "2FA 验证码(未开启则直接回车): " OTP
read -r -p "要替换的证书描述 [nas.example.com]: " DESC
DESC="${DESC:-nas.example.com}"
read -r -p "是否跳过 HTTPS 证书校验?用 IP 连接或旧证书已过期时需要 [y/N] " INSEC
CURL=(curl -sS -m 120)
"$INSEC" =~ ^[Yy]$ && CURL+=(-k)
BASE="https://$HOST:$PORT/webapi/entry.cgi"
json() { python3 -I -c "import json,sys;d=json.load(sys.stdin);$1"; }
# 登录(密码通过 stdin 传给 curl,不出现在进程参数里)
echo "登录 $HOST:$PORT ..."
LOGIN=$(printf '%s' "$PASS" | "${CURL[@]}" "$BASE" \
--data-urlencode api=SYNO.API.Auth --data-urlencode version=6 --data-urlencode method=login \
--data-urlencode format=sid --data-urlencode enable_syno_token=yes \
--data-urlencode "account=$USER" --data-urlencode "passwd@-" \
${OTP:+--data-urlencode "otp_code=$OTP"})
unset PASS OTP
[ -n "$LOGIN" ] || { echo "无法连接群晖(地址/端口错误,或证书校验失败可选择跳过校验)"; finish 1; }
SID=$(echo "$LOGIN" | json 'print(d["data"]["sid"] if d.get("success") else "")')
TOKEN=$(echo "$LOGIN" | json 'print(d["data"].get("synotoken","") if d.get("success") else "")')
if [ -z "$SID" ]; then
CODE=$(echo "$LOGIN" | json 'print(d.get("error",{}).get("code",""))')
case "$CODE" in
400) echo "登录失败:账号或密码错误";;
403) echo "登录失败:该账号开启了 2FA,请输入验证码";;
404) echo "登录失败:2FA 验证码错误或已过期";;
*) echo "登录失败:$LOGIN";;
esac
finish 1
fi
logout() { "${CURL[@]}" "$BASE?api=SYNO.API.Auth&version=6&method=logout&_sid=$SID" >/dev/null; }
# 按描述查找证书 ID,并判断是否为默认证书
LIST=$("${CURL[@]}" -H "X-SYNO-TOKEN: $TOKEN" "$BASE?api=SYNO.Core.Certificate.CRT&version=1&method=list&_sid=$SID")
read -r ID IS_DEFAULT < <(echo "$LIST" | DESC="$DESC" json '
import os
if not d.get("success"): print("ERR", d.get("error",{}).get("code","")); sys.exit()
m=[c for c in d["data"]["certificates"] if c["desc"]==os.environ["DESC"]]
print((m[0]["id"]+" "+str(m[0]["is_default"]).lower()) if m else "NONE false")')
if [ "$ID" = "ERR" ]; then
echo "获取证书列表失败(错误码 $IS_DEFAULT,105 表示账号不是管理员)"; logout; finish 1
elif [ "$ID" = "NONE" ]; then
read -r -p "群晖上没有描述为「$DESC」的证书,是否新建一张?[y/N] " NEW
"$NEW" =~ ^[Yy]$ || { logout; finish 1; }
ID=""
read -r -p "是否设为默认证书?[y/N] " DEF
"$DEF" =~ ^[Yy]$ && IS_DEFAULT=true
fi
echo "上传证书(可能需要约 1 分钟)..."
FORM=(-F "key=@$KEY" -F "cert=@$CERT" -F "inter_cert=@$CHAIN" -F "id=$ID" -F "desc=$DESC")
[ "$IS_DEFAULT" = "true" ] && FORM+=(-F "as_default=true")
RESP=$("${CURL[@]}" "${FORM[@]}" "$BASE?api=SYNO.Core.Certificate&method=import&version=1&SynoToken=$TOKEN&_sid=$SID")
logout
if echo "$RESP" | json 'sys.exit(0 if d.get("success") else 1)' 2>/dev/null; then
echo "推送成功。"
echo | openssl s_client -connect "$HOST:$PORT" -servername "$DESC" 2>/dev/null | openssl x509 -noout -enddate 2>/dev/null \
| sed 's/^/群晖当前证书 /'
finish 0
else
echo "推送失败:$RESP"
finish 1
fi几个要注意的地方:
- 替换是按「描述」匹配的,所以群晖 控制面板-安全性-证书 里那张证书的描述要和输入的一致。对不上的话会新建一张证书,不会自动变成默认证书,要自己去切换
- 两步验证码大概30秒就过期了,所以放在最后几项输入,输完赶紧回车
- 用IP连接群晖,或者群晖上的旧证书已经过期了,要选跳过HTTPS校验,不然连不上。最好还是用域名连
- 如果Mac上开了代理(比如fake-ip模式),域名会被解析到198.18.x.x这种地址,连不到群晖。可以在
/etc/hosts里加一行,把域名指向群晖的局域网IP:
192.168.x.x nas.example.com不建议为了省事去开acme.sh的 HTTPS_INSECURE,它会让acme.sh和CA之间的通信也不校验证书。
五、换电脑的时候
- 新电脑按上面第二步重新装一遍。EAB要去控制台新建一组,旧的不能用
- 腾讯云密钥可以继续用原来那个子用户的,也可以新建一组
- 新电脑弄好以后,记得把旧电脑上的续期停掉,不然两边都在续:
~/.acme.sh/acme.sh --remove -d nas.example.com --ecc