Files
homegate/dns_challenge.py
DizelBadCoder 5661de72b7
All checks were successful
Test and publish Homegate / checks (push) Successful in 29s
Test and publish Homegate / publish (push) Successful in 12m43s
Add UI DNS challenge issuance and automatic home NPM renewal
2026-10-15 05:42:15 +03:00

176 lines
10 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

"""Background DNS-01 issuance in the home NPM. Renewal belongs to NPM's scheduler."""
from pathlib import Path
import re
import secrets
import threading
import time
import homegate as h
ISSUE_TIMEOUT = 900
RESERVED = {"home", "lan", "local", "localhost", "internal", "invalid", "test", "example", "onion", "arpa"}
def providers(npm):
try:
rows = npm.call("GET", "/nginx/certificates/dns-providers")
legacy = False
except h.APIError as exc:
# In old NPM this path matches /:certificate_id and can return 400.
if exc.status not in (400, 404):
raise
rows = h.read_json(Path(__file__).with_name("dns-providers-legacy.json"))["providers"]
legacy = True
h.require(isinstance(rows, list) and 0 < len(rows) <= 256, "NPM вернул некорректный список DNS-провайдеров")
clean = []
for row in rows:
h.require(isinstance(row, dict) and isinstance(row.get("id"), str) and
re.fullmatch(r"[a-z0-9_-]{1,100}", row["id"]), "Некорректный DNS-провайдер NPM")
clean.append({"id": row["id"], "name": str(row.get("name", row["id"]))[:200],
"template": str(row.get("credentials", ""))[:16384]})
return {"providers": sorted(clean, key=lambda p: p["name"].lower()), "email_required": legacy}
def validate_request(value):
h.require(isinstance(value, dict) and not set(value) -
{"domains", "provider", "credentials", "email", "propagation_seconds", "agree"},
"Некорректные параметры DNS challenge")
domains = value.get("domains")
h.require(isinstance(domains, list) and 1 <= len(domains) <= 100, "Укажите от 1 до 100 доменов")
names = []
for name in domains:
h.require(isinstance(name, str), "Домены должны быть строками")
name = name.strip().lower().rstrip(".")
base = name.removeprefix("*.")
h.require(h.DOMAIN.fullmatch(base) and not base.split(".")[-1].isdigit() and
base.split(".")[-1] not in RESERVED,
"Для Let's Encrypt нужен публичный домен; .home, .local и другие локальные зоны не подходят")
h.require(name not in names, "Домен указан повторно")
names.append(name)
provider = value.get("provider")
h.require(isinstance(provider, str) and re.fullmatch(r"[a-z0-9_-]{1,100}", provider), "Выберите DNS-провайдера")
credentials = value.get("credentials")
h.require(isinstance(credentials, str) and 0 < len(credentials.strip()) <= 16384 and "\x00" not in credentials,
"Введите API-доступ DNS-провайдера в формате шаблона")
email = value.get("email", "")
h.require(isinstance(email, str), "Некорректный email")
email = email.strip()
h.require(not email or re.fullmatch(r"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,63}", email), "Некорректный email")
propagation = value.get("propagation_seconds")
if propagation is not None:
h.number(propagation, 0, 600, "propagation_seconds")
h.require(value.get("agree") is True, "Подтвердите согласие с условиями Let's Encrypt")
return {"domains": names, "provider": provider, "credentials": credentials, "email": email,
"propagation_seconds": propagation, "agree": True}
class DNSChallenge:
def __init__(self, control, connect):
self.path = Path(control) / "dns-challenge.json"
self.connect = connect
self.lock = threading.RLock()
self.thread = None
self.job = h.read_json(self.path, {"status": "idle"})
if self.job["status"] == "running":
self.update(status="unknown", message="Homegate был перезапущен. Проверьте результат в домашнем NPM перед повторным выпуском.")
def update(self, **fields):
with self.lock:
self.job.update(fields)
h.save_json(self.path, self.job)
return self.status()
def status(self):
with self.lock:
# Never publish the full request or an NPM response.
return {k: v for k, v in self.job.items() if k in
{"id", "status", "domains", "provider", "message", "certificate", "started_at"}}
def start(self, value):
request = validate_request(value)
with self.lock:
h.require(self.job["status"] != "running", "Выпуск уже выполняется. Дождитесь результата.")
h.require(self.job["status"] != "unknown" or time.time() - self.job.get("issued_at", self.job.get("started_at", 0)) >= ISSUE_TIMEOUT,
"Результат предыдущего выпуска пока неизвестен. Нажмите «Проверить результат»; повторный выпуск доступен через 15 минут.")
self.job = {"id": secrets.token_hex(16), "status": "running", "domains": request["domains"],
"provider": request["provider"], "started_at": time.time(), "message": "Проверяем домашний NPM…"}
self.update()
self.thread = threading.Thread(target=self.run, args=(request,), daemon=True)
self.thread.start()
return self.status()
def check(self):
with self.lock:
if self.job["status"] in ("idle", "success", "running"):
return self.status()
self.update(status="running", message="Проверяем, завершился ли выпуск в домашнем NPM…")
self.thread = threading.Thread(target=self.run, args=(None,), daemon=True)
self.thread.start()
return self.status()
def matching(self, rows):
matches = []
for row in rows:
if (row.get("provider") == "letsencrypt" and row.get("meta", {}).get("dns_challenge") is True
and row.get("meta", {}).get("dns_provider") == self.job["provider"]
and set(row.get("domain_names", [])) == set(self.job["domains"])):
info = h.certificate_info(row)
try:
h.check_certificate(info, self.job["domains"])
except h.Error:
continue
matches.append(info)
# Reuse a valid certificate instead of submitting a duplicate ACME order.
return sorted(matches, key=lambda c: c["id"], reverse=True)
def run(self, request):
npm, submitted = None, False
try:
npm = self.connect()
if request is None:
h.require(not self.job.get("npm_base") or npm.base == self.job["npm_base"],
"Подключение к домашнему NPM изменилось; проверьте сертификаты в прежнем NPM")
self.update(npm_base=npm.base)
rows = npm.call("GET", "/nginx/certificates")
matches = self.matching(rows)
if matches:
self.update(status="success", certificate=matches[0], message="Сертификат готов. Автопродление выполняет домашний NPM.")
return
if request is None:
self.update(status="unknown", message="Готовый сертификат пока не найден. Выпуск может продолжаться в NPM. Повторный запрос автоматически не отправляется.")
return
catalog = providers(npm)
h.require(any(p["id"] == request["provider"] for p in catalog["providers"]),
"Этот DNS-провайдер не поддерживается домашним NPM")
meta = {"dns_challenge": True, "dns_provider": request["provider"],
"dns_provider_credentials": request["credentials"]}
if catalog["email_required"]:
h.require(bool(request["email"]), "Для этой версии NPM укажите email Let's Encrypt")
meta.update(letsencrypt_email=request["email"], letsencrypt_agree=True)
if request["propagation_seconds"] is not None:
meta["propagation_seconds"] = request["propagation_seconds"]
self.update(issued_at=time.time(), message="Домашний NPM выпускает сертификат через DNS challenge. Это может занять несколько минут.")
submitted = True
result = npm.call("POST", "/nginx/certificates", json={"provider": "letsencrypt",
"domain_names": request["domains"], "meta": meta}, timeout=(5, ISSUE_TIMEOUT))
info = h.certificate_info(result)
h.require(info["provider"] == "letsencrypt" and info["dns_challenge"], "NPM вернул неожиданный тип сертификата")
h.check_certificate(info, request["domains"])
self.update(status="success", certificate=info, message="Сертификат выпущен. Автопродление выполняет домашний NPM.")
except h.APIError as exc:
uncertain = submitted and exc.status in (None, 408, 502, 503, 504)
self.update(status="unknown" if uncertain or request is None else "error", message=(
"NPM не подтвердил результат. Нажмите «Проверить результат»; Homegate не повторяет выпуск автоматически."
if uncertain else "Не удалось выполнить запрос к домашнему NPM. Проверьте подключение, DNS-доступ и журнал NPM. " + str(exc)))
except h.Error as exc:
self.update(status="unknown" if submitted or request is None else "error", message=str(exc))
except Exception:
# Exception representations from parsers/third-party code may contain credentials.
self.update(status="unknown" if submitted or request is None else "error",
message="Не удалось обработать ответ NPM. Проверьте результат в его разделе сертификатов.")
finally:
if request is not None:
request.clear()
if npm:
npm.close()