Featured image of post 使用acme.sh为网站设置免费HTTPS证书的完整指南

使用acme.sh为网站设置免费HTTPS证书的完整指南

本教程详细介绍了如何使用acme.sh,一个流行的命令行工具,为你的网站自动申请和安装免费的HTTPS证书,提高网站的安全性

阅读时长: 5 分钟
共 2139字
作者: eimoon.com

1 安装acme.sh

curl https://get.acme.sh | sh -s email=[email protected]
上面的命令进行了以下几步:
(1)acme.sh 安装到 你的当前用户 目录下  ~/.acme.sh/ 
(2)创建 一个别名, 方便直接使用: alias acme.sh=~/.acme.sh/acme.sh
```bash
alias acme.sh=~/.acme.sh/acme.sh
```
(3)创建 cronjob,每天 0:00 自动检测所有证书,如果快过期了,会自动更新证书。

2 生成证书

acme.sh 实现了 acme 协议支持的所有验证协议.支持的ca详细查看github ,这里要注意一下,acme.sh 以前的默认是Letsencrypt.org CA ,后面更改了默认设置了ZeroSSL.com CA,见acme的githuwiki

acme.s一般有两种方式实现验证: http 和 dns 验证.

第一种方式:http 方式

需要在你的网站根目录下放置一个文件, 来验证你的域名所有权,完成验证. 然后就可以生成证书了.

acme.sh --issue -d mydomain.com -d www.mydomain.com --webroot /home/wwwroot/mydomain.com/

只需要指定域名, 并指定域名所在的网站根目录. acme.sh 会全自动的生成验证文件, 并放到网站的根目录, 然后自动完成验证. 最后会自动删除验证文件. 整个过程没有任何副作用. 实际上acme.sh 会在网站根目录下新建一个.well-known/acme-challenge/ 里面放一个验证文件,这里要注意你当前用户对网站的根目录有写入的权限,否则会验证错误。

acme.sh 还可以智能的配置中自动完成验证, 你不需要指定网站根目录,后面带上参数–nginx 或者–apache 就可以了。 apache 自动查找根目录

acme.sh --issue -d mydomain.com --apache

nginx 自动查找根目录

acme.sh --issue -d mydomain.com --nginx

注意, 无论是 apache 还是 nginx 模式, acme.sh在完成验证之后, 会恢复到之前的状态, 都不会私自更改你本身的配置. 好处是你不用担心配置被搞坏, 也有一个缺点, 你需要自己配置 ssl 的配置, 否则只能成功生成证书, 你的网站还是无法访问https. 但是为了安全, 你还是自己手动改配置吧.

如果你还没有运行任何 web 服务, 80 端口是空闲的, 那么 acme.sh 还能假装自己是一个webserver, 临时听在80 端口, 完成验证:

acme.sh --issue -d mydomain.com --standalone

更高级的用法请参考: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert

第二种 手动 dns 方式

手动在域名上添加一条 txt 解析记录, 验证域名所有权.这种方式的好处是, 你不需要任何服务器, 不需要任何公网 ip, 只需要 dns 的解析记录即可完成验证. 坏处是,如果没有同时配置 Automatic DNS API,使用这种方式 acme.sh 将无法自动更新证书,每次都需要手动再次重新解析验证域名所有权。

acme.sh --issue --dns -d mydomain.com \
 --yes-I-know-dns-manual-mode-enough-go-ahead-please

然后, acme.sh 会生成相应的解析记录显示出来, 你只需要在你的域名管理面板中添加这条 txt 记录即可.

等待解析完成之后, 重新生成证书:

acme.sh --renew -d mydomain.com \
  --yes-I-know-dns-manual-mode-enough-go-ahead-please

注意第二次这里用的是 –renew

dns 方式的真正强大之处在于可以使用域名解析商提供的 api 自动添加 txt 记录完成验证.

acme.sh 目前支持 cloudflare, dnspod, cloudxns, godaddy 以及 ovh 等数十种解析商的自动集成.

以 dnspod 为例, 你需要先登录到 dnspod 账号, 生成你的 api id 和 api key, 都是免费的. 然后:


export DP_Id="1234"

export DP_Key="sADDsdasdgdsf"

acme.sh --issue --dns dns_dp -d aa.com -d www.aa.com

证书就会自动生成了. 这里给出的 api id 和 api key 会被自动记录下来, 将来你在使用 dnspod api 的时候, 就不需要再次指定了. 直接生成就好了:

acme.sh --issue -d mydomain2.com --dns  dns_dp

更详细的 api 用法: https://github.com/Neilpang/acme.sh/blob/master/dnsapi/README.md

3 copy/安装 证书

前面证书生成以后, 接下来需要把证书 copy 到真正需要用它的地方.

注意, 默认生成的证书都放在安装目录下: ~/.acme.sh/, 不要直接使用此目录下的文件, 例如: 不要直接让 nginx/apache 的配置文件使用这下面的文件. 这里面的文件都是内部使用, 而且目录结构可能会变化.

正确的使用方法是使用 –install-cert 命令,并指定目标位置, 然后证书文件会被copy到相应的位置, 例如:

Apache 示例:

acme.sh --install-cert -d example.com \
--cert-file      /path/to/certfile/in/apache/cert.pem  \
--key-file       /path/to/keyfile/in/apache/key.pem  \
--fullchain-file /path/to/fullchain/certfile/apache/fullchain.pem \
--reloadcmd     "service apache2 force-reload"

Nginx 示例:

acme.sh --install-cert -d example.com \
--key-file       /etc/nginx/ssl/privkey.pem  \ 
--fullchain-file /etc/nginx/ssl/fullchain.pem

运行完后在重新加载nginx 或者重新启动nginx,重载使用 service nginx force-reload, 不是 service nginx reload, 据测试, reload 并不会重新加载证书。

Nginx 的配置 ssl_certificate 文件名为fullchain.cer 和 privkey.pem ,否则 SSL Labs 的测试会报 Chain issues Incomplete 错误。

–install-cert命令可以携带很多参数, 来指定目标文件. 并且可以指定 reloadcmd, 当证书更新以后, reloadcmd会被自动调用,让服务器生效.

详细参数请参考: https://github.com/Neilpang/acme.sh#3-install-the-issued-cert-to-apachenginx-etc

值得注意的是, 这里指定的所有参数都会被自动记录下来, 并在将来证书自动更新以后, 被再次自动调用.

4 查看已安装证书信息

acme.sh --info -d example.com

5 更新证书

目前证书在 60 天以后会自动更新, 你无需任何操作. 可以查看 crontab -l 类似这样的

56 * * * * "/root/.acme.sh"/acme.sh --cron --home "/root/.acme.sh" > /dev/null

6 更新 acme.sh

目前由于 acme 协议和 letsencrypt CA 都在频繁的更新, 因此 acme.sh 也经常更新以保持同步.

升级 acme.sh 到最新版 :

acme.sh --upgrade

如果你不想手动升级, 可以开启自动升级:

acme.sh --upgrade --auto-upgrade

之后, acme.sh 就会自动保持更新了.

你也可以随时关闭自动更新:

acme.sh --upgrade --auto-upgrade  0

7 吊销域名证书

要使用 acme.sh 注销现有的域名证书,可以使用 –revoke 命令,后跟域名

acme.sh --revoke -d yourdomain.com

8. 出错怎么办:

如果出错, 请添加 debug log:


acme.sh --issue  .....  --debug 

或者:

acme.sh --issue  .....  --debug  2

请参考: https://github.com/Neilpang/acme.sh/wiki/How-to-debug-acme.sh

一些常见错误

acme 错误Can not init api, for https://acme.zerossl.com/v2/DV90

原因可能与acme 将默认 CA 更改为 ZeroSSL有关 [githubwiki] (https://github.com/acmesh-official/acme.sh/wiki/Change-default-CA-to-ZeroSSL) [letsencrypt社区] https://community.letsencrypt.org/t/the-acme-sh-will-change-default-ca-to-zerossl-on-august-1st-2021/144052

全局设置默认ca为LetsEncrypt

acme.sh --set-default-ca  --server  letsencrypt

在单一域名中指定为LetsEncrypt

acme.sh  --issue  -d example.com --dns dns_cf    --server  letsencrypt

yourdomain.com: Can not write token to file : /usr/share/nginx/html//.well-known/acme-challenge

这个一般是你的文件没有写入权限,提升用户权限,或者自己在你的网站目录下新建.well-known并设置合适的写入权限即可。

本文并非完全的使用说明, 还有很多高级的功能, 更高级的用法请参看其他github,wiki尽量参考英文说明,中文说明省略了很多。

https://github.com/Neilpang/acme.sh/wiki

最后,我个人经常使用的实际上是certbot, 使用起来可能更方便,大家可以根据自己的喜好选择。

微信公众号

使用 Hugo 构建
主题 StackJimmy 设计