Aldebaran

人生最棒的感觉,就是你做到别人说你做不到的事。

0%

Let's Encrypt之acme.sh

指原莉乃

前言

Let’s Encrypt 是一个证书颁发机构(CA)。是由互联网安全研究小组(ISRG,Internet Security Research Group)主导并开发的一个新型数字证书认证机构(CA,Certificate Authority)。该项目旨在开发一个自由且开放的自动化 CA 套件,并向公众提供相关的证书免费签发服务以降低安全通讯的财务、技术和教育成本。

互联网安全研究小组拟定了 ACME 协议。

说到 ACME 协议,我们不得不提一下传统 CA 的认证方式。

Let’s Encrypt 服务所签发的证书为域名认证证书(DV,Domain-validated Certificate),签发这类证书需要域名所有者完成以下至少一种挑战Challenge以证明自己对域名的所有权:

  • 验证申请人对域名的 Whois 信息中邮箱的控制权;
  • 验证申请人对域名的常见管理员邮箱(如以 [email protected][email protected] 开头的邮箱等)的控制权;
  • 在 DNS 的 TXT 记录中发布一条 CA 提供的字符串;
  • 在包含域名的网址中特定路径发布一条 CA 提供的字符串。

不难发现,其中最容易实现自动化的一种操作必然为最后一条,ACME 协议中的 Simple HTTP 认证即是用一种类似的方法对从未签发过任何证书的域名进行认证。该协议要求在访问 http://域名/.well-known/acme-challenge/指定字符串 时返回特定的字符串。

acme.sh实现了 acme 协议, 可以从 letsencrypt 生成免费的证书.

acme.sh纯用Shell(Unix外壳)语言编写的ACME协议客户端。支持ACME v1/ACME v2和ACME v2通配符证书

安装acme.sh

  • 普通安装

    安装很简单, 一个命令(普通用户和 root 用户都可以安装使用):

    $ curl  https://get.acme.sh | sh
    $ alias acme.sh=~/.acme.sh/acme.sh
  • 高级安装(可选)

    $ git clone https://github.com/Neilpang/acme.sh.git
    $ cd acme.sh
    $ ./acme.sh --install \
    --home ~/myacme \
    --config-home ~/myacme/data \
    --cert-home  ~/mycerts \
    --accountemail  "[email protected]" \
    --accountkey  ~/myaccount.key \
    --accountconf ~/myaccount.conf \
    --useragent  "this is my client."

常用的签名方式

acme.sh 实现了 acme 协议支持的所有验证协议.

更多范例请访问: https://github.com/Neilpang/acme.sh/wiki/How-to-issue-a-cert

下面是常用的两种

  1. http方式

    • Webroot mode

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

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

      只需要指定域名, 并指定域名所在的网站根目录. acme.sh 会全自动的生成验证文件, 并放到网站的根目录, 然后自动完成验证. 最后会聪明的删除验证文件. 整个过程没有任何副作用.

    • Nginx/apache mode

      如果你用的 apache/nginx服务器, acme.sh 还可以智能的从配置中自动完成验证, 你不需要指定网站根目录:

      Apache

      如果您的网站运行的是apache服务器,则acme.sh可以使用apache服务器颁发证书。并且acme.sh会在证书颁发后恢复您的apache conf,不用担心。
      $ acme.sh --issue  -d mydomain.com  --apache

      Nginx

      如果您的网站运行的是nginx服务器,则acme.sh可以使用nginx服务器颁发证书。颁发证书后,acme.sh会还原您的nginx conf,请放心。
      
      $ acme.sh --issue  -d mydomain.com  --nginx
      
      有时,无法自动找到nginx conf文件,您可以指定以下文件之一:
      
      $ acme.sh  --issue  -d example.com  --nginx /etc/nginx/nginx.conf
      
      你还可以指定网站conf:
      
      $ acme.sh  --issue  -d example.com  --nginx /etc/nginx/conf.d/example.com.conf

      注意: 无论是 apache 还是 nginx 模式, acme.sh在完成验证之后, 会恢复到之前的状态, 都不会私自更改你本身的配置.

    • Standalone mode

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

      $ acme.sh  --issue -d mydomain.com  --standalone
      
      $ acme.sh --issue --standalone -d example.com -d www.example.com -d cp.example.com
  2. dns 方式

    在域名上添加一条 txt 解析记录, 验证域名所有权.

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

    $ acme.sh  --issue  --dns -d mydomain.com

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

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

    $ acme.sh  --renew   -d mydomain.com

    注意第二次这里用的是 –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
  3. 混合模式

    颁发包含多个域的单个证书。每个域使用不同的验证方法

    $ acme.sh  --issue  \
        -d aa.com  -w /home/wwwroot/aa.com \
        -d bb.com  --dns dns_cf \
        -d cc.com  --apache \
        -d dd.com  -w /home/wwwroot/dd.com

只需颁发证书

例子:

  • Example 1: Single domain.

    $ acme.sh --issue -d example.com -w /home/wwwroot/example.com

    or:

    $ acme.sh --issue -d example.com -w /home/username/public_html

    or:

    $ acme.sh --issue -d example.com -w /var/www/html
  • Example 2: Multiple domains in the same cert.

    $ acme.sh --issue -d example.com -d www.example.com -d cp.example.com -w /home/wwwroot/example.com

参数/home/wwwroot/example.com 和/home/username/public_html或是/var/www/html都是你托管网站文件的Web根文件夹。你必须具有write access该文件夹。

第二个参数“ example.com”是您要为其颁发证书的域名。您必须在那里至少有一个域名。

你必须将所有域指向并绑定到同一个webroot目录:/home/wwwroot/example.com。

证书将被放置在 ~/.acme.sh/example.com/

证书每60天自动更新一次。

颁发ECC证书

Let’s Encrypt现在可以颁发ECDSA证书。

只需将keylength参数设置为prefix即可ec-

例如:

  • Single domain ECC certificate

    $ acme.sh --issue -w /home/wwwroot/example.com -d example.com --keylength ec-256
  • SAN multi domain ECC certificate

    $ acme.sh --issue -w /home/wwwroot/example.com -d example.com -d www.example.com --keylength ec-256

keylength的参数

有效值为:

ec-256 (prime256v1, "ECDSA P-256")
ec-384 (secp384r1, "ECDSA P-384")
ec-521 (secp521r1, "ECDSA P-521", which is not supported by Let's Encrypt yet.)

其他使用

  • 复制证书

    生成证书后,你可能希望将证书安装/复制到Apache/Nginx或其他服务器。你必须使用此命令将证书复制到目标文件,请勿使用〜/ .acme.sh /文件夹中的证书文件,这些文件仅供内部使用,将来文件夹结构可能会更改。

    • Apache example:

      $ 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 example:

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

      默认情况下,证书将每60天更新一次(可配置)。证书更新后,将通过以下命令自动重新加载Apache / Nginx服务:service apache2 force-reload或service nginx force-reload。

      请注意:reloadcmd非常重要。该证书可以自动更新,但是,如果没有正确的“ reloadcmd”,该证书可能无法刷新到您的服务器(如nginx或apache),那么您的网站将无法在60天内显示更新的证书。

  • 发行通配符证书

    很简单,只需提供一个通配符域作为-d参数。

    $ acme.sh  --issue -d example.com  -d '*.example.com'  --dns dns_cf
  • 如何续订证书

    你不需要手动续订证书。所有证书将每60天自动更新一次。

    但是,你也可以强制续订证书:

    $ acme.sh --renew -d example.com --force

    或者,对于ECC证书:

    $ acme.sh --renew -d example.com --force --ecc
  • 更新 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

参考网站

官网

certbot

acme.sh