Wildcard tanúsítványok DNS-01-gyel és certbottal

A DNS-01 kihívás egy weboldal helyett egy TXT rekorddal igazolja, hogy Ön rendelkezik a domain felett. Ez az egyetlen módja a wildcard tanúsítvány megszerzésének, és olyan szervereknél is működik, amelyek nem érhetők el az internetről. Ez a hook lehetővé teszi, hogy a certbot a NameOcean API-n keresztül tegye közzé ezt a rekordot.

A NameOcean maga is kiállít ingyenes wildcard tanúsítványt bármely, a NameOcean DNS-en lévő domainhez, megújítja, és letöltési linket ad hozzá (SSL, vagy POST /ssl/example.com). Ezt az útmutatót akkor használja, ha a szervernek saját magának kell megszereznie és megújítania a tanúsítványát.

Amire szüksége lesz

A domain DNS-e a NameOceanen van (névszerverek: ns1.nameocean.net – ns4.nameocean.net).
certbot, dig (dnsutils vagy bind-utils) és a nameocean CLI a szerveren.
Egy API-kulcs dns:read és dns:write jogosultsággal. Ha lehetséges, korlátozza a szerver IP-címére.

1. A hook telepítése

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

A kulcs egy olyan fájlban marad, amelyet csak a root olvashat; a certbot mentett megújítási beállításai soha nem tartalmazzák.

2. A tanúsítvány megszerzése

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"

A hook minden névhez megkeresi a NameOcean zónái közül azt, amelyhez tartozik, TXT rekordként hozzáadja az _acme-challenge bejegyzést, és megvárja, amíg mind a négy névszerver ezzel válaszol – ez általában tíz másodpercen belül megtörténik. Az ellenőrzés után a takarítási lépés pontosan azt a rekordot törli, amelyet hozzáadott. Az example.com és a *.example.com egyaránt az _acme-challenge.example.com nevet használja; a két érték egymás mellett kerül közzétételre.

3. Megújítások

A certbot a tanúsítvánnyal együtt tárolja a hookokat, így az időzítője ugyanígy újítja meg. Ezt egyszer tesztelje:

root@server

# certbot renew --dry-run

Minden rekord, amelyet a hook hozzáad vagy töröl, megjelenik az Irányítópult → Tevékenység menüpontban az azt végrehajtó kulccsal együtt, és dns.record.created, illetve dns.record.deleted webhook eseményt küld.

A hook

Olvassa el, mielőtt rootként futtatja. Csak a nameocean CLI-t és a dig parancsot hívja meg.

/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 nélkül

A hook két API-hívást végez, amelyeket bármely ACME-kliensből vagy programozási nyelvből elvégezhet:

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"