certbot'renewing letencrypt certificate plugin - automatic verification aliyun/tencentyun/godaddy dns
Go to file
虞大胆 45a55ae626
最近更新了几个PR,有问题反馈给我。
2020-02-13 19:17:32 +08:00
php-version add domain.ini 2019-07-22 11:45:14 +08:00
python-version feat: add python version of huaweicloud dns api 2020-02-08 00:02:32 +08:00
README.md 最近更新了几个PR,有问题反馈给我。 2020-02-13 19:17:32 +08:00
au.sh Update au.sh 2020-02-13 19:06:42 +08:00
domain.ini add domain.ini 2019-07-22 11:45:14 +08:00

996.icu LICENSE

功能

使用 certbot 工具,为不能自动给 letencrypt 通配符证书自动续期renew而烦恼吗这个工具能够帮忙

不管是申请还是续期,只要是通配符证书,只能采用 dns-01 的方式校验申请者的域名,也就是说 certbot 操作者必须手动添加 DNS TXT 记录。

如果你编写一个 Cron (比如 1 1 */1 * * root certbot-auto renew),自动 renew 通配符证书,此时 Cron 无法自动添加 TXT 记录,这样 renew 操作就会失败,如何解决?

certbot 提供了一个 hook可以编写一个 Shell 脚本,让脚本调用 DNS 服务商的 API 接口,动态添加 TXT 记录,这样就无需人工干预了。

在 certbot 官方提供的插件和 hook 例子中,都没有针对国内 DNS 服务器的样例,所以我编写了这样一个工具,目前支持阿里云 DNS腾讯云 DNS华为云 NDSGoDaddycertbot 官方没有对应的插件)。

近期合并了几个PR没有测试有问题反馈给我谢谢

自动申请通配符证书

1下载

$ git clone https://github.com/ywdblog/certbot-letencrypt-wildcardcertificates-alydns-au

$ cd certbot-letencrypt-wildcardcertificates-alydns-au

$ chmod 0777 au.sh

2配置

1domain.ini

如果domain.ini文件没有你的根域名请自行添加。

2DNS API 密钥:

这个 API 密钥什么意思呢?由于需要通过 API 操作阿里云 DNS, 腾讯云 DNS 的记录,所以需要去域名服务商哪儿获取 API 密钥,然后配置在 au.sh 文件中:

3选择运行环境

目前该工具支持五种运行环境和场景,通过 hook 文件和参数来调用:

  • PHP(>4以上版本均可)
    • au.sh php aly add/cleanPHP操作阿里云DNS增加/清空DNS。
    • au.sh php txy add/cleanPHP操作腾讯云DNS增加/清空DNS。
    • au.sh php godaddy add/cleanPHP操作GoDaddy DNS增加/清空DNS。
  • Python(支持2.7和3.7,无需任何第三方库)
    • au.sh python aly add/cleanPython操作阿里云DNS增加/清空DNS。
    • au.sh python txy add/cleanPython操作腾讯云DNS增加/清空DNS。
    • au.sh python hwy add/cleanPython操作华为云DNS增加/清空DNS。
    • au.sh python godaddy add/cleanPython操作GoDaddy DNS增加/清空DNS。

根据自己服务器环境和域名服务商选择任意一个 hook shell包含相应参数具体使用见下面。

3申请证书

测试是否有错误:

$ ./certbot-auto certonly  -d *.example.com --manual --preferred-challenges dns --dry-run  --manual-auth-hook "/脚本目录/au.sh php aly add" --manual-cleanup-hook "/脚本目录/au.sh php aly clean"

Debug 操作 DNS API 可能会遇到一系列问题,比如 API token 权限不足,遇到相关问题,可以查看 /var/log/certd.log。

重要解释: --manual-auth-hook 和 --manual-cleanup-hook 有三个参数:

  • 第一个代表你要选择那种语言(php/python)
  • 第二个参数代表你的DNS厂商(aly/txy)
  • 第三个参数是固定的(--manual-auth-hook中用add--manual-clean-hook中用clean)

比如你要选择Python环境可以将 --manual-auth-hook 输入修改为 "/脚本目录/au.sh python aly add"--manual-cleanup-hook 输入修改为 "/脚本目录/au.sh python aly clean"

确认无误后,实际运行(去除 --dry-run 参数):

# 实际申请
$ ./certbot-auto certonly  -d *.example.com --manual --preferred-challenges dns --manual-auth-hook "/脚本目录/au.sh php aly add" --manual-cleanup-hook "/脚本目录/au.sh php aly clean"

参数解释(可以不用关心):

  • certonly表示采用验证模式只会获取证书不会为web服务器配置证书
  • --manual表示插件
  • --preferred-challenges dns表示采用DNS验证申请者合法性是不是域名的管理者
  • --dry-run在实际申请/更新证书前进行测试,强烈推荐
  • -d表示需要为那个域名申请证书可以有多个。
  • --manual-auth-hook在执行命令的时候调用一个 hook 文件
  • --manual-cleanup-hook清除 DNS 添加的记录

如果你想为多个域名申请通配符证书(合并在一张证书中,也叫做 SAN 通配符证书),直接输入多个 -d 参数即可,比如:

$ ./certbot-auto certonly  -d *.example.com -d *.example.org -d www.example.cn  --manual --preferred-challenges dns  --dry-run --manual-auth-hook "/脚本目录/au.sh php aly add" --manual-cleanup-hook "/脚本目录/au.sh php aly clean"

续期证书

1对机器上所有证书 renew

$ ./certbot-auto renew  --manual --preferred-challenges dns --manual-auth-hook "/脚本目录/au.sh php aly add" --manual-cleanup-hook "/脚本目录/au.sh php aly clean"

2对某一张证书进行续期

先看看机器上有多少证书:

$ ./certbot-auto certificates

可以看到很多证书,如图:

管理证书

记住证书名,比如 simplehttps.com然后运行下列命令 renew

$ ./certbot-auto renew --cert-name simplehttps.com  --manual-auth-hook "/脚本目录/au.sh php aly add" --manual-cleanup-hook "/脚本目录/au.sh php aly clean"

加入 crontab

编辑文件 /etc/crontab :

#证书有效期<30天才会renew所以crontab可以配置为1天或1周
1 1 */1 * * root certbot-auto renew --manual --preferred-challenges dns  --manual-auth-hook "/脚本目录/au.sh php aly add" --manual-cleanup-hook "/脚本目录/au.sh php aly clean"

如果是certbot 机器和运行web服务比如 nginxapache的机器是同一台那么成功renew证书后可以启动对应的web 服务器运行下列crontab :

# 注意只有成功renew证书才会重新启动nginx
1 1 */1 * * root certbot-auto renew --manual --preferred-challenges dns --deploy-hook  "service nginx restart" --manual-auth-hook "/脚本目录/au.sh php aly add" --manual-cleanup-hook "/脚本目录/au.sh php aly clean"

注意只有单机建议这样运行如果要将证书同步到多台web服务器需要有别的方案目前在开发中主要目的就是同步证书到集群服务器上

贡献

  • 阿里云 python 版 @Duke-Wu
  • 腾讯云 python 版 @akgnah
  • 华为云 python 版 @jinhucheung
  • GoDaddy PHP 版 wlx_1990 2019-01-11

其他

公众号二维码:

公众号:虞大胆的叽叽喳喳,yudadanwx

《深入浅出HTTPS从原理到实战》二维码

深入浅出HTTPS:从原理到实战