lego/providers/dns/zoneee/zoneee.go

168 lines
4.2 KiB
Go
Raw Normal View History

// Package zoneee implements a DNS provider for solving the DNS-01 challenge through zone.ee.
2019-03-11 16:56:48 +00:00
package zoneee
import (
"errors"
"fmt"
"net/http"
"net/url"
"time"
2020-09-02 01:20:01 +00:00
"github.com/go-acme/lego/v4/challenge/dns01"
"github.com/go-acme/lego/v4/platform/config/env"
)
// Environment variables names.
const (
envNamespace = "ZONEEE_"
EnvEndpoint = envNamespace + "ENDPOINT"
EnvAPIUser = envNamespace + "API_USER"
EnvAPIKey = envNamespace + "API_KEY"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
2020-05-08 17:35:25 +00:00
// Config is used to configure the creation of the DNSProvider.
type Config struct {
Endpoint *url.URL
Username string
APIKey string
PropagationTimeout time.Duration
PollingInterval time.Duration
HTTPClient *http.Client
}
2020-05-08 17:35:25 +00:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
func NewDefaultConfig() *Config {
endpoint, _ := url.Parse(defaultEndpoint)
return &Config{
Endpoint: endpoint,
// zone.ee can take up to 5min to propagate according to the support
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 5*time.Minute),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 5*time.Second),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
},
}
}
2020-05-08 17:35:25 +00:00
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
config *Config
}
// NewDNSProvider returns a DNSProvider instance.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvAPIUser, EnvAPIKey)
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("zoneee: %w", err)
}
rawEndpoint := env.GetOrDefaultString(EnvEndpoint, defaultEndpoint)
endpoint, err := url.Parse(rawEndpoint)
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("zoneee: %w", err)
}
config := NewDefaultConfig()
config.Username = values[EnvAPIUser]
config.APIKey = values[EnvAPIKey]
config.Endpoint = endpoint
return NewDNSProviderConfig(config)
}
2020-05-08 17:35:25 +00:00
// NewDNSProviderConfig return a DNSProvider instance configured for Zone.ee.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("zoneee: the configuration of the DNS provider is nil")
}
if config.Username == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("zoneee: credentials missing: username")
}
if config.APIKey == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("zoneee: credentials missing: API key")
}
if config.Endpoint == nil {
return nil, errors.New("zoneee: the endpoint is missing")
}
return &DNSProvider{config: config}, nil
}
// Timeout returns the timeout and interval to use when checking for DNS propagation.
// Adjusting here to cope with spikes in propagation times.
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
return d.config.PropagationTimeout, d.config.PollingInterval
}
2020-05-08 17:35:25 +00:00
// Present creates a TXT record to fulfill the dns-01 challenge.
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
fqdn, value := dns01.GetRecord(domain, keyAuth)
record := txtRecord{
Name: fqdn[:len(fqdn)-1],
Destination: value,
}
2020-02-08 10:38:57 +00:00
authZone, err := getHostedZone(domain)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("zoneee: %w", err)
2020-02-08 10:38:57 +00:00
}
_, err = d.addTxtRecord(authZone, record)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("zoneee: %w", err)
}
return nil
}
2020-05-08 17:35:25 +00:00
// CleanUp removes the TXT record previously created.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
_, value := dns01.GetRecord(domain, keyAuth)
2020-02-08 10:38:57 +00:00
authZone, err := getHostedZone(domain)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("zoneee: %w", err)
2020-02-08 10:38:57 +00:00
}
records, err := d.getTxtRecords(authZone)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("zoneee: %w", err)
}
var id string
for _, record := range records {
if record.Destination == value {
id = record.ID
}
}
if id == "" {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("zoneee: txt record does not exist for %s", value)
}
2020-02-08 10:38:57 +00:00
if err = d.removeTxtRecord(authZone, id); err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("zoneee: %w", err)
}
return nil
}
2020-02-08 10:38:57 +00:00
func getHostedZone(domain string) (string, error) {
authZone, err := dns01.FindZoneByFqdn(dns01.ToFqdn(domain))
if err != nil {
return "", err
}
zoneName := dns01.UnFqdn(authZone)
return zoneName, nil
}