1
0
mirror of https://github.com/go-acme/lego.git synced 2024-12-05 03:58:54 +02:00
lego/providers/dns/checkdomain/checkdomain.go

161 lines
4.0 KiB
Go
Raw Normal View History

2020-05-08 19:35:25 +02:00
// Package checkdomain implements a DNS provider for solving the DNS-01 challenge using CheckDomain DNS.
package checkdomain
import (
2020-02-27 20:14:46 +02:00
"errors"
"fmt"
"net/http"
"net/url"
"sync"
"time"
"github.com/go-acme/lego/v3/challenge/dns01"
"github.com/go-acme/lego/v3/platform/config/env"
)
// Environment variables names.
const (
envNamespace = "CHECKDOMAIN_"
EnvEndpoint = envNamespace + "ENDPOINT"
EnvToken = envNamespace + "TOKEN"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
const (
defaultEndpoint = "https://api.checkdomain.de"
defaultTTL = 300
)
2020-05-08 19:35:25 +02:00
// Config is used to configure the creation of the DNSProvider.
type Config struct {
Endpoint *url.URL
Token string
TTL int
PropagationTimeout time.Duration
PollingInterval time.Duration
HTTPClient *http.Client
}
2020-05-08 19:35:25 +02:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt(EnvTTL, defaultTTL),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 5*time.Minute),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 7*time.Second),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
},
}
}
2020-05-08 19:35:25 +02:00
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
config *Config
domainIDMu sync.Mutex
domainIDMapping map[string]int
}
2020-05-08 19:35:25 +02:00
// NewDNSProvider returns a DNSProvider instance configured for CheckDomain.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvToken)
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("checkdomain: %w", err)
}
config := NewDefaultConfig()
config.Token = values[EnvToken]
endpoint, err := url.Parse(env.GetOrDefaultString(EnvEndpoint, defaultEndpoint))
if err != nil {
return nil, fmt.Errorf("checkdomain: invalid %s: %w", EnvEndpoint, err)
}
config.Endpoint = endpoint
return NewDNSProviderConfig(config)
}
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config.Endpoint == nil {
2020-02-27 20:14:46 +02:00
return nil, errors.New("checkdomain: invalid endpoint")
}
if config.Token == "" {
2020-02-27 20:14:46 +02:00
return nil, errors.New("checkdomain: missing token")
}
if config.HTTPClient == nil {
config.HTTPClient = http.DefaultClient
}
return &DNSProvider{
config: config,
domainIDMapping: make(map[string]int),
}, nil
}
2020-05-08 19:35:25 +02:00
// Present creates a TXT record to fulfill the dns-01 challenge.
2020-02-10 19:20:52 +02:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
domainID, err := d.getDomainIDByName(domain)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("checkdomain: %w", err)
}
2020-02-10 19:20:52 +02:00
err = d.checkNameservers(domainID)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("checkdomain: %w", err)
}
name, value := dns01.GetRecord(domain, keyAuth)
2020-02-10 19:20:52 +02:00
err = d.createRecord(domainID, &Record{
Name: name,
2020-02-10 19:20:52 +02:00
TTL: d.config.TTL,
Type: "TXT",
Value: value,
})
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("checkdomain: %w", err)
}
return nil
}
2020-05-08 19:35:25 +02:00
// CleanUp removes the TXT record previously created.
2020-02-10 19:20:52 +02:00
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
domainID, err := d.getDomainIDByName(domain)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("checkdomain: %w", err)
}
2020-02-10 19:20:52 +02:00
err = d.checkNameservers(domainID)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("checkdomain: %w", err)
}
name, value := dns01.GetRecord(domain, keyAuth)
2020-02-10 19:20:52 +02:00
err = d.deleteTXTRecord(domainID, name, value)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("checkdomain: %w", err)
}
2020-02-10 19:20:52 +02:00
d.domainIDMu.Lock()
delete(d.domainIDMapping, name)
d.domainIDMu.Unlock()
return nil
}
2020-05-08 19:35:25 +02:00
// Timeout returns the timeout and interval to use when checking for DNS propagation.
// Adjusting here to cope with spikes in propagation times.
2020-02-10 19:20:52 +02:00
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
return d.config.PropagationTimeout, d.config.PollingInterval
}