mijnhost.go raw
1 // Package mijnhost implements a DNS provider for solving the DNS-01 challenge using mijn.host DNS.
2 package mijnhost
3
4 import (
5 "context"
6 "errors"
7 "fmt"
8 "net/http"
9 "time"
10
11 "github.com/go-acme/lego/v4/challenge"
12 "github.com/go-acme/lego/v4/challenge/dns01"
13 "github.com/go-acme/lego/v4/platform/config/env"
14 "github.com/go-acme/lego/v4/providers/dns/internal/clientdebug"
15 "github.com/go-acme/lego/v4/providers/dns/mijnhost/internal"
16 )
17
18 // Environment variables names.
19 const (
20 envNamespace = "MIJNHOST_"
21
22 EnvAPIKey = envNamespace + "API_KEY"
23
24 EnvTTL = envNamespace + "TTL"
25 EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
26 EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
27 EnvSequenceInterval = envNamespace + "SEQUENCE_INTERVAL"
28 EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
29 )
30
31 const txtType = "TXT"
32
33 var _ challenge.ProviderTimeout = (*DNSProvider)(nil)
34
35 // Config is used to configure the creation of the DNSProvider.
36 type Config struct {
37 APIKey string
38 TTL int
39 PropagationTimeout time.Duration
40 PollingInterval time.Duration
41 SequenceInterval time.Duration
42 HTTPClient *http.Client
43 }
44
45 // NewDefaultConfig returns a default configuration for the DNSProvider.
46 func NewDefaultConfig() *Config {
47 return &Config{
48 TTL: env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
49 PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
50 PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
51 SequenceInterval: env.GetOrDefaultSecond(EnvSequenceInterval, 5*time.Second),
52 HTTPClient: &http.Client{
53 Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
54 },
55 }
56 }
57
58 // DNSProvider implements the challenge.Provider interface.
59 type DNSProvider struct {
60 config *Config
61 client *internal.Client
62 }
63
64 // NewDNSProvider returns a DNSProvider instance configured for mijn.host DNS.
65 // MIJNHOST_API_KEY must be passed in the environment variables.
66 func NewDNSProvider() (*DNSProvider, error) {
67 values, err := env.Get(EnvAPIKey)
68 if err != nil {
69 return nil, fmt.Errorf("mijnhost: %w", err)
70 }
71
72 config := NewDefaultConfig()
73 config.APIKey = values[EnvAPIKey]
74
75 return NewDNSProviderConfig(config)
76 }
77
78 // NewDNSProviderConfig return a DNSProvider instance configured for mijn.host DNS.
79 func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
80 if config == nil {
81 return nil, errors.New("mijnhost: the configuration of the DNS provider is nil")
82 }
83
84 if config.APIKey == "" {
85 return nil, errors.New("mijnhost: APIKey is missing")
86 }
87
88 client := internal.NewClient(config.APIKey)
89
90 if config.HTTPClient != nil {
91 client.HTTPClient = config.HTTPClient
92 }
93
94 client.HTTPClient = clientdebug.Wrap(client.HTTPClient)
95
96 return &DNSProvider{
97 config: config,
98 client: client,
99 }, nil
100 }
101
102 // Timeout returns the timeout and interval to use when checking for DNS propagation.
103 // Adjusting here to cope with spikes in propagation times.
104 func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
105 return d.config.PropagationTimeout, d.config.PollingInterval
106 }
107
108 // Sequential All DNS challenges for this provider will be resolved sequentially.
109 // Returns the interval between each iteration.
110 func (d *DNSProvider) Sequential() time.Duration {
111 return d.config.SequenceInterval
112 }
113
114 // Present creates a TXT record to fulfill the dns-01 challenge.
115 func (d *DNSProvider) Present(domain, token, keyAuth string) error {
116 ctx := context.Background()
117
118 info := dns01.GetChallengeInfo(domain, keyAuth)
119
120 domains, err := d.client.ListDomains(ctx)
121 if err != nil {
122 return fmt.Errorf("mijnhost: list domains: %w", err)
123 }
124
125 dom, err := findDomain(domains, domain)
126 if err != nil {
127 return fmt.Errorf("mijnhost: find domain: %w", err)
128 }
129
130 records, err := d.client.GetRecords(ctx, dom.Domain)
131 if err != nil {
132 return fmt.Errorf("mijnhost: get records: %w", err)
133 }
134
135 subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, dom.Domain)
136 if err != nil {
137 return fmt.Errorf("mijnhost: %w", err)
138 }
139
140 record := internal.Record{
141 Type: txtType,
142 Name: subDomain,
143 Value: info.Value,
144 TTL: d.config.TTL,
145 }
146
147 // mijn.host doesn't support multiple values for a domain,
148 // so we removed existing record for the subdomain.
149 cleanedRecords := filterRecords(records, func(record internal.Record) bool {
150 return record.Type == txtType && (record.Name == subDomain || record.Name == dns01.UnFqdn(info.EffectiveFQDN))
151 })
152
153 cleanedRecords = append(cleanedRecords, record)
154
155 err = d.client.UpdateRecords(ctx, dom.Domain, cleanedRecords)
156 if err != nil {
157 return fmt.Errorf("mijnhost: update records: %w", err)
158 }
159
160 return nil
161 }
162
163 // CleanUp removes the TXT record.
164 func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
165 ctx := context.Background()
166
167 info := dns01.GetChallengeInfo(domain, keyAuth)
168
169 domains, err := d.client.ListDomains(ctx)
170 if err != nil {
171 return fmt.Errorf("mijnhost: list domains: %w", err)
172 }
173
174 dom, err := findDomain(domains, domain)
175 if err != nil {
176 return fmt.Errorf("mijnhost: find domain: %w", err)
177 }
178
179 records, err := d.client.GetRecords(ctx, dom.Domain)
180 if err != nil {
181 return fmt.Errorf("mijnhost: get records: %w", err)
182 }
183
184 cleanedRecords := filterRecords(records, func(record internal.Record) bool {
185 return record.Type == txtType && record.Value == info.Value
186 })
187
188 err = d.client.UpdateRecords(ctx, dom.Domain, cleanedRecords)
189 if err != nil {
190 return fmt.Errorf("mijnhost: update records: %w", err)
191 }
192
193 return nil
194 }
195
196 func findDomain(domains []internal.Domain, fqdn string) (internal.Domain, error) {
197 for domain := range dns01.UnFqdnDomainsSeq(fqdn) {
198 for _, dom := range domains {
199 if dom.Domain == domain {
200 return dom, nil
201 }
202 }
203 }
204
205 return internal.Domain{}, fmt.Errorf("domain %s not found", fqdn)
206 }
207
208 func filterRecords(records []internal.Record, fn func(record internal.Record) bool) []internal.Record {
209 var newRecords []internal.Record
210
211 for _, record := range records {
212 if record.Type == "TXT" && fn(record) {
213 continue
214 }
215
216 newRecords = append(newRecords, record)
217 }
218
219 return newRecords
220 }
221