traefik/vendor/github.com/xenolf/lego/providers/dns/godaddy/godaddy.go

152 lines
4.2 KiB
Go
Raw Normal View History

// Package godaddy implements a DNS provider for solving the DNS-01 challenge using godaddy DNS.
package godaddy
import (
2018-09-17 13:16:03 +00:00
"errors"
2018-07-03 10:44:04 +00:00
"fmt"
"net/http"
"strings"
2018-07-03 10:44:04 +00:00
"time"
2019-01-07 17:30:06 +00:00
"github.com/xenolf/lego/challenge/dns01"
2018-07-03 10:44:04 +00:00
"github.com/xenolf/lego/platform/config/env"
)
2018-09-17 13:16:03 +00:00
const (
// defaultBaseURL represents the API endpoint to call.
defaultBaseURL = "https://api.godaddy.com"
minTTL = 600
)
// Config is used to configure the creation of the DNSProvider
type Config struct {
APIKey string
APISecret string
PropagationTimeout time.Duration
PollingInterval time.Duration
2019-01-07 17:30:06 +00:00
SequenceInterval time.Duration
2018-09-17 13:16:03 +00:00
TTL int
HTTPClient *http.Client
}
// NewDefaultConfig returns a default configuration for the DNSProvider
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt("GODADDY_TTL", minTTL),
PropagationTimeout: env.GetOrDefaultSecond("GODADDY_PROPAGATION_TIMEOUT", 120*time.Second),
PollingInterval: env.GetOrDefaultSecond("GODADDY_POLLING_INTERVAL", 2*time.Second),
2019-01-07 17:30:06 +00:00
SequenceInterval: env.GetOrDefaultSecond("GODADDY_SEQUENCE_INTERVAL", dns01.DefaultPropagationTimeout),
2018-09-17 13:16:03 +00:00
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond("GODADDY_HTTP_TIMEOUT", 30*time.Second),
},
}
}
2018-05-31 07:30:04 +00:00
// DNSProvider is an implementation of the acme.ChallengeProvider interface
type DNSProvider struct {
2018-09-17 13:16:03 +00:00
config *Config
}
// NewDNSProvider returns a DNSProvider instance configured for godaddy.
2018-09-17 13:16:03 +00:00
// Credentials must be passed in the environment variables:
// GODADDY_API_KEY and GODADDY_API_SECRET.
func NewDNSProvider() (*DNSProvider, error) {
2018-07-03 10:44:04 +00:00
values, err := env.Get("GODADDY_API_KEY", "GODADDY_API_SECRET")
if err != nil {
2018-09-17 13:16:03 +00:00
return nil, fmt.Errorf("godaddy: %v", err)
2018-07-03 10:44:04 +00:00
}
2018-09-17 13:16:03 +00:00
config := NewDefaultConfig()
config.APIKey = values["GODADDY_API_KEY"]
config.APISecret = values["GODADDY_API_SECRET"]
return NewDNSProviderConfig(config)
}
2018-09-17 13:16:03 +00:00
// NewDNSProviderConfig return a DNSProvider instance configured for godaddy.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("godaddy: the configuration of the DNS provider is nil")
}
if config.APIKey == "" || config.APISecret == "" {
return nil, fmt.Errorf("godaddy: credentials missing")
}
2018-10-10 14:28:04 +00:00
if config.TTL < minTTL {
return nil, fmt.Errorf("godaddy: invalid TTL, TTL (%d) must be greater than %d", config.TTL, minTTL)
}
2018-09-17 13:16:03 +00:00
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.
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
2018-09-17 13:16:03 +00:00
return d.config.PropagationTimeout, d.config.PollingInterval
}
2018-10-10 14:28:04 +00:00
// Present creates a TXT record to fulfill the dns-01 challenge
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
2019-01-07 17:30:06 +00:00
fqdn, value := dns01.GetRecord(domain, keyAuth)
2018-07-03 10:44:04 +00:00
domainZone, err := d.getZone(fqdn)
if err != nil {
return err
}
2018-07-03 10:44:04 +00:00
recordName := d.extractRecordName(fqdn, domainZone)
rec := []DNSRecord{
{
Type: "TXT",
Name: recordName,
Data: value,
2018-09-17 13:16:03 +00:00
TTL: d.config.TTL,
},
}
2018-07-03 10:44:04 +00:00
return d.updateRecords(rec, domainZone, recordName)
}
// CleanUp sets null value in the TXT DNS record as GoDaddy has no proper DELETE record method
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
2019-01-07 17:30:06 +00:00
fqdn, _ := dns01.GetRecord(domain, keyAuth)
2018-07-03 10:44:04 +00:00
domainZone, err := d.getZone(fqdn)
if err != nil {
return err
}
2018-07-03 10:44:04 +00:00
recordName := d.extractRecordName(fqdn, domainZone)
rec := []DNSRecord{
{
Type: "TXT",
Name: recordName,
Data: "null",
},
}
2018-07-03 10:44:04 +00:00
return d.updateRecords(rec, domainZone, recordName)
}
2019-01-07 17:30:06 +00:00
// Sequential All DNS challenges for this provider will be resolved sequentially.
// Returns the interval between each iteration.
func (d *DNSProvider) Sequential() time.Duration {
return d.config.SequenceInterval
}
2019-01-07 17:30:06 +00:00
func (d *DNSProvider) extractRecordName(fqdn, domain string) string {
name := dns01.UnFqdn(fqdn)
if idx := strings.Index(name, "."+domain); idx != -1 {
return name[:idx]
}
return name
}
2019-01-07 17:30:06 +00:00
func (d *DNSProvider) getZone(fqdn string) (string, error) {
authZone, err := dns01.FindZoneByFqdn(fqdn)
if err != nil {
2019-01-07 17:30:06 +00:00
return "", err
}
2019-01-07 17:30:06 +00:00
return dns01.UnFqdn(authZone), nil
}