Vývojáři → Návody

Wildcard certifikáty s DNS-01 a certbotem

Výzva DNS-01 prokazuje, že doménu ovládáte, pomocí TXT záznamu místo webové stránky. Je to jediný způsob, jak získat wildcard certifikát, a funguje i pro servery, které nejsou dostupné z internetu. Tento hook umožňuje certbotu publikovat tento záznam přes NameOcean API.

NameOcean sám vydává bezplatný wildcard certifikát pro každou doménu na NameOcean DNS, obnovuje jej a poskytne vám odkaz ke stažení (SSL nebo POST /ssl/example.com). Tento návod použijte, pokud má váš server získávat a obnovovat vlastní certifikát.

Co budete potřebovat

DNS domény na NameOcean (jmenné servery ns1.nameocean.net až ns4.nameocean.net).
certbot, dig (dnsutils nebo bind-utils) a nameocean CLI na serveru.
API klíč s oprávněními dns:read a dns:write. Pokud můžete, omezte jej na IP adresu serveru.

1. Instalace hooku

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

Klíč zůstává v souboru, který může číst pouze root; uložená nastavení obnovy certbotu jej nikdy neobsahují.

2. Získání certifikátu

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"

Hook pro každé jméno najde zónu, do které patří, mezi vašimi zónami na NameOcean, přidá _acme-challenge jako TXT záznam a počká, dokud jej všechny čtyři jmenné servery nevracejí, obvykle do deseti sekund. Po ověření krok úklidu smaže přesně ten záznam, který přidal. example.com i *.example.com používají _acme-challenge.example.com; obě hodnoty jsou publikovány vedle sebe.

3. Obnovy

certbot ukládá hooky spolu s certifikátem, takže jej jeho časovač obnoví stejným způsobem. Jednou to otestujte:

root@server

# certbot renew --dry-run

Každý záznam, který hook přidá a smaže, najdete v Nástěnka → Aktivita spolu s klíčem, který akci provedl, a odesílá události webhooku dns.record.created a dns.record.deleted.

Hook

Než jej spustíte jako root, přečtěte si jej. Volá pouze nameocean CLI a 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

Bez CLI

Hook provádí dvě volání API, která můžete provést z libovolného ACME klienta nebo jazyka:

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"