lego/providers/dns/cloudxns/cloudxns.go

122 lines
3.5 KiB
Go
Raw Normal View History

// Package cloudxns implements a DNS provider for solving the DNS-01 challenge using CloudXNS DNS.
2019-03-11 16:56:48 +00:00
package cloudxns
2018-05-30 17:53:04 +00:00
import (
2018-09-15 17:26:45 +00:00
"errors"
2018-05-30 17:53:04 +00:00
"fmt"
"net/http"
"time"
"github.com/go-acme/lego/v3/challenge/dns01"
"github.com/go-acme/lego/v3/platform/config/env"
"github.com/go-acme/lego/v3/providers/dns/cloudxns/internal"
2018-05-30 17:53:04 +00:00
)
// Environment variables names.
const (
envNamespace = "CLOUDXNS_"
EnvAPIKey = envNamespace + "API_KEY"
EnvSecretKey = envNamespace + "SECRET_KEY"
EnvTTL = envNamespace + "TTL"
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.
2018-09-15 17:26:45 +00:00
type Config struct {
APIKey string
SecretKey string
PropagationTimeout time.Duration
PollingInterval time.Duration
TTL int
HTTPClient *http.Client
}
2020-05-08 17:35:25 +00:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
2018-09-15 17:26:45 +00:00
func NewDefaultConfig() *Config {
return &Config{
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
TTL: env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
},
2018-09-15 17:26:45 +00:00
}
}
2018-05-30 17:53:04 +00:00
2020-05-08 17:35:25 +00:00
// DNSProvider implements the challenge.Provider interface.
2018-05-30 17:53:04 +00:00
type DNSProvider struct {
2018-09-15 17:26:45 +00:00
config *Config
client *internal.Client
2018-05-30 17:53:04 +00:00
}
2018-09-15 17:26:45 +00:00
// NewDNSProvider returns a DNSProvider instance configured for CloudXNS.
// Credentials must be passed in the environment variables:
// CLOUDXNS_API_KEY and CLOUDXNS_SECRET_KEY.
2018-05-30 17:53:04 +00:00
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvAPIKey, EnvSecretKey)
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("CloudXNS: %w", err)
}
2018-09-15 17:26:45 +00:00
config := NewDefaultConfig()
config.APIKey = values[EnvAPIKey]
config.SecretKey = values[EnvSecretKey]
2018-05-30 17:53:04 +00:00
2018-09-15 17:26:45 +00:00
return NewDNSProviderConfig(config)
2018-05-30 17:53:04 +00:00
}
2018-09-15 17:26:45 +00:00
// NewDNSProviderConfig return a DNSProvider instance configured for CloudXNS.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("CloudXNS: the configuration of the DNS provider is nil")
2018-05-30 17:53:04 +00:00
}
client, err := internal.NewClient(config.APIKey, config.SecretKey)
2018-05-30 17:53:04 +00:00
if err != nil {
2018-09-15 17:26:45 +00:00
return nil, err
2018-05-30 17:53:04 +00:00
}
2018-09-15 17:26:45 +00:00
client.HTTPClient = config.HTTPClient
2018-05-30 17:53:04 +00:00
2018-10-11 13:49:33 +00:00
return &DNSProvider{client: client, config: config}, nil
2018-05-30 17:53:04 +00:00
}
// Present creates a TXT record to fulfill the dns-01 challenge.
2018-09-15 17:26:45 +00:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
fqdn, value := dns01.GetRecord(domain, keyAuth)
2018-05-30 17:53:04 +00:00
2018-09-15 17:26:45 +00:00
info, err := d.client.GetDomainInformation(fqdn)
2018-05-30 17:53:04 +00:00
if err != nil {
2018-09-15 17:26:45 +00:00
return err
2018-05-30 17:53:04 +00:00
}
2018-09-15 17:26:45 +00:00
return d.client.AddTxtRecord(info, fqdn, value, d.config.TTL)
2018-05-30 17:53:04 +00:00
}
2018-09-15 17:26:45 +00:00
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
fqdn, _ := dns01.GetRecord(domain, keyAuth)
2018-05-30 17:53:04 +00:00
2018-09-15 17:26:45 +00:00
info, err := d.client.GetDomainInformation(fqdn)
2018-05-30 17:53:04 +00:00
if err != nil {
return err
}
2018-09-15 17:26:45 +00:00
record, err := d.client.FindTxtRecord(info.ID, fqdn)
2018-05-30 17:53:04 +00:00
if err != nil {
return err
}
2018-09-15 17:26:45 +00:00
return d.client.RemoveTxtRecord(record.RecordID, info.ID)
2018-05-30 17:53:04 +00:00
}
2018-09-15 17:26:45 +00:00
// 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
2018-05-30 17:53:04 +00:00
}