使用 DNS-01 和 certbot 获取通配符证书

DNS-01 验证通过 TXT 记录（而非网页）来证明您对域名的控制权。这是获取通配符证书的唯一方式，也适用于无法从互联网访问的服务器。此钩子脚本让 certbot 通过 NameOcean API 发布该记录。

对于使用 NameOcean DNS 的任何域名，NameOcean 本身就会免费签发通配符证书、自动续期并为您提供下载链接（SSL，或 POST /ssl/example.com）。如果您希望服务器自行获取和续期证书，请参阅本指南。

准备工作

域名的 DNS 托管在 NameOcean 上（域名服务器为 ns1.nameocean.net 至 ns4.nameocean.net）。
服务器上已安装 certbot、dig（dnsutils 或 bind-utils）以及 nameocean CLI。
一个具有 dns:read 和 dns:write 权限的 API 密钥。如有可能，请将其限制为仅允许该服务器的 IP 地址使用。

1. 安装钩子脚本

root@server

# curl -fsSL https://nameocean.net/install.sh | sh
# curl -fsSL https://nameocean.net/developers/guides/letsencrypt-dns-01/nameocean-hook.sh \
    -o /etc/letsencrypt/nameocean-hook.sh
# chmod 700 /etc/letsencrypt/nameocean-hook.sh
# echo 'NAMEOCEAN_API_KEY=no_live_…' > /etc/letsencrypt/nameocean.env
# chmod 600 /etc/letsencrypt/nameocean.env

密钥保存在仅 root 可读的文件中；certbot 保存的续期配置中不会包含该密钥。

2. 获取证书

root@server

# certbot certonly --manual --preferred-challenges dns \
    --manual-auth-hook "/etc/letsencrypt/nameocean-hook.sh auth" \
    --manual-cleanup-hook "/etc/letsencrypt/nameocean-hook.sh cleanup" \
    -d example.com -d "*.example.com"

对于每个名称，钩子脚本会在您的 NameOcean 区域中找到其所属区域，添加 _acme-challenge TXT 记录，并等待四台域名服务器全部返回该记录，通常在十秒内完成。验证完成后，清理步骤会准确删除它所添加的记录。example.com 和 *.example.com 都使用 _acme-challenge.example.com；两个值会同时发布。

3. 续期

certbot 会将钩子与证书一并保存，因此其定时任务会以相同方式续期证书。请先测试一次：

root@server

# certbot renew --dry-run

钩子脚本添加和删除的每条记录都会显示在“控制面板 → 活动”中，并注明所用的密钥，同时会发送 dns.record.created 和 dns.record.deleted Webhook 事件。

钩子脚本

以 root 身份运行前请先阅读。它只调用 nameocean CLI 和 dig。

/etc/letsencrypt/nameocean-hook.sh

#!/bin/sh
# certbot DNS-01 hooks for NameOcean DNS:
#   --manual-auth-hook "/etc/letsencrypt/nameocean-hook.sh auth"
#   --manual-cleanup-hook "/etc/letsencrypt/nameocean-hook.sh cleanup"
# Needs the nameocean CLI and an API key with dns:write, in /etc/letsencrypt/nameocean.env:
#   NAMEOCEAN_API_KEY=no_live_...
set -e
[ -f /etc/letsencrypt/nameocean.env ] && . /etc/letsencrypt/nameocean.env && export NAMEOCEAN_API_KEY

# the zone CERTBOT_DOMAIN is in: the longest of your zones it ends with
zone="$NAMEOCEAN_ZONE"
if [ -z "$zone" ]; then
  for z in $(nameocean dns ls --json | sed -n 's/.*"name": *"\([^"]*\)".*/\1/p'); do
    case "$CERTBOT_DOMAIN" in "$z" | *".$z") [ ${#z} -gt ${#zone} ] && zone="$z" ;; esac
  done
fi
[ -n "$zone" ] || { echo "no NameOcean DNS zone for $CERTBOT_DOMAIN" >&2; exit 1; }
name="_acme-challenge"
[ "$CERTBOT_DOMAIN" = "$zone" ] || name="_acme-challenge.${CERTBOT_DOMAIN%.$zone}"

case "$1" in
auth)
  id=$(nameocean dns add "$zone" TXT "$name" "$CERTBOT_VALIDATION" --ttl 5m --json \
    | sed -n 's/.*"id": *\([0-9][0-9]*\).*/\1/p' | head -n 1)
  [ -n "$id" ] || { echo "could not add the TXT record" >&2; exit 1; }
  echo "$id" # certbot passes this to the cleanup hook as CERTBOT_AUTH_OUTPUT
  # wait until all four nameservers answer with it (usually a few seconds)
  for i in $(seq 1 60); do
    n=0
    for ns in ns1 ns2 ns3 ns4; do
      dig +short TXT "$name.$zone" "@$ns.nameocean.net" | grep -q -- "$CERTBOT_VALIDATION" && n=$((n + 1))
    done
    [ "$n" -eq 4 ] && exit 0
    sleep 2
  done
  echo "the TXT record is not on every nameserver after 2 minutes" >&2
  exit 1
  ;;
cleanup)
  [ -z "$CERTBOT_AUTH_OUTPUT" ] || nameocean dns rm "$zone" TXT "$CERTBOT_AUTH_OUTPUT"
  ;;
*)
  echo "usage: $0 auth|cleanup" >&2
  exit 2
  ;;
esac

不使用 CLI

钩子脚本会发起两个 API 调用，您可以在任何 ACME 客户端或编程语言中实现：

curl

$ curl -X POST https://nameocean.net/api/v1/dns/example.com/records \
    -H "Authorization: Bearer $NAMEOCEAN_API_KEY" -H "Content-Type: application/json" \
    -d '{"type": "TXT", "hostname": "_acme-challenge", "text": "<validation>", "ttl": "5m"}'
{"id": 4190, "type": "TXT", "hostname": "_acme-challenge", …}
$ curl -X DELETE https://nameocean.net/api/v1/dns/example.com/records/TXT/4190 \
    -H "Authorization: Bearer $NAMEOCEAN_API_KEY"