aboutsummaryrefslogtreecommitdiffstats
path: root/lfacme-dns.7.in
blob: 4d25031f3c15331f2832885bebf39ed1608cd6db (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
.\" This source code is released into the public domain.
.Dd June 4, 2025
.Dt LFACME-DNS 7
.Os
.Sh NAME
.Nm lfacme-dns
.Nd validate an ACME challenge via TSIG DNS updates
.Sh SYNOPSIS
In
.Xr domains.conf 5 :
.Bd -ragged -offset indent
.Ar domain
challenge=dns
.Ed
.Sh DESCRIPTION
The
.Nm
challenge hook will respond to an ACME domain validation using a DNS-based
.Dq dns-01
authorization with TSIG-authenticated Dynamic DNS updates.
To use this challenge hook, configure one or more domains with
.Dq challenge=dns
in
.Xr domains.conf 5 .
.Pp
The
.Dq dns-01
challenge expects the authorization token to be created as a TXT record at the
DNS name
.Dq _acme-challenge. Ns Ar domain .
When
.Nm
responds to the challenge, it will use
.Xr nsupdate 1
to create this record.
The DNS update will be sent to the zone's master server (determined by the
MNAME field in the SOA record), and will be authenticated using the TSIG
key file configured by
.Ar ACME_DNS_KEYFILE
in
.Xr acme.conf 5 .
.Pp
Once validation is complete, the previously created DNS record will be removed.
.Sh CONFIGURATION
The
.Nm
challenge hook supports the following configuration options in
.Xr acme.conf 5 :
.Bl -tag -width indent
.It Va ACME_DNS_KEYFILE
(Required.)
The key file that will be passed to
.Xr nsupdate 1
to authenticate the DNS update.
.It Va ACME_DNS_DIG
Path to the
.Xr dig 1
program.
If not specified,
.Ev $PATH
will be searched.
.It Va ACME_DNS_NSUPDATE
Path to the
.Xr nsupdate 1
program.
If not specified,
.Ev $PATH
will be searched.
.El
.Sh SEE ALSO
.Xr acme.conf 5 ,
.Xr domains.conf 5 ,
.Xr lfacme-renew 8 ,
.Xr nsupdate 1