Programadores → Guias

Certificados wildcard com DNS-01 e certbot

O desafio DNS-01 prova que controla um domínio através de um registo TXT em vez de uma página web. É a única forma de obter um certificado wildcard e funciona para servidores que não são acessíveis a partir da internet. Este hook permite ao certbot publicar esse registo através da API da NameOcean.

A própria NameOcean emite um certificado wildcard gratuito para qualquer domínio no DNS da NameOcean, renova-o e fornece-lhe uma ligação de transferência (SSL, ou POST /ssl/example.com). Utilize este guia quando o seu servidor tiver de obter e renovar o seu próprio certificado.

O que precisa

O DNS do domínio na NameOcean (servidores de nomes ns1.nameocean.net a ns4.nameocean.net).
certbot, dig (dnsutils ou bind-utils) e a CLI nameocean no servidor.
Uma chave de API com dns:read e dns:write. Se possível, restrinja-a ao endereço IP do servidor.

1. Instalar o hook

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 chave fica num ficheiro que apenas o root pode ler; as definições de renovação guardadas pelo certbot nunca a contêm.

2. Obter o certificado

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"

Para cada nome, o hook encontra a zona a que pertence entre as suas zonas da NameOcean, adiciona _acme-challenge como registo TXT e aguarda até que os quatro servidores de nomes respondam com ele, normalmente em menos de dez segundos. Após a verificação, o passo de limpeza elimina exatamente o registo que adicionou. example.com e *.example.com utilizam ambos _acme-challenge.example.com; os dois valores são publicados lado a lado.

3. Renovações

O certbot guarda os hooks juntamente com o certificado, pelo que o seu temporizador o renova da mesma forma. Teste isso uma vez:

root@server

# certbot renew --dry-run

Cada registo que o hook adiciona e elimina aparece em Painel → Atividade com a chave que o fez, e envia os eventos de webhook dns.record.created e dns.record.deleted.

O hook

Leia-o antes de o executar como root. Apenas chama a CLI nameocean e o 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

Sem a CLI

O hook faz duas chamadas à API que pode fazer a partir de qualquer cliente ACME ou linguagem:

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"