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

190 lines
4.9 KiB
Go
Raw Normal View History

2019-01-07 17:30:06 +00:00
// Package dnspod implements a DNS provider for solving the DNS-01 challenge using dnspod DNS.
2017-02-07 21:33:23 +00:00
package dnspod
import (
2018-09-17 13:16:03 +00:00
"errors"
2017-02-07 21:33:23 +00:00
"fmt"
2018-09-17 13:16:03 +00:00
"net/http"
"strconv"
2017-02-07 21:33:23 +00:00
"strings"
2018-09-17 13:16:03 +00:00
"time"
2017-02-07 21:33:23 +00:00
2019-01-25 09:24:04 +00:00
dnspod "github.com/decker502/dnspod-go"
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"
2017-02-07 21:33:23 +00:00
)
2018-09-17 13:16:03 +00:00
// Config is used to configure the creation of the DNSProvider
type Config struct {
LoginToken string
TTL int
PropagationTimeout time.Duration
PollingInterval time.Duration
HTTPClient *http.Client
}
// NewDefaultConfig returns a default configuration for the DNSProvider
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt("DNSPOD_TTL", 600),
2019-01-07 17:30:06 +00:00
PropagationTimeout: env.GetOrDefaultSecond("DNSPOD_PROPAGATION_TIMEOUT", dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond("DNSPOD_POLLING_INTERVAL", dns01.DefaultPollingInterval),
2018-09-17 13:16:03 +00:00
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond("DNSPOD_HTTP_TIMEOUT", 0),
},
}
}
2018-05-31 07:30:04 +00:00
// DNSProvider is an implementation of the acme.ChallengeProvider interface.
2017-02-07 21:33:23 +00:00
type DNSProvider struct {
2018-09-17 13:16:03 +00:00
config *Config
2017-02-07 21:33:23 +00:00
client *dnspod.Client
}
// NewDNSProvider returns a DNSProvider instance configured for dnspod.
// Credentials must be passed in the environment variables: DNSPOD_API_KEY.
func NewDNSProvider() (*DNSProvider, error) {
2018-07-03 10:44:04 +00:00
values, err := env.Get("DNSPOD_API_KEY")
if err != nil {
2018-09-17 13:16:03 +00:00
return nil, fmt.Errorf("dnspod: %v", err)
2018-07-03 10:44:04 +00:00
}
2018-09-17 13:16:03 +00:00
config := NewDefaultConfig()
config.LoginToken = values["DNSPOD_API_KEY"]
return NewDNSProviderConfig(config)
2017-02-07 21:33:23 +00:00
}
2018-09-17 13:16:03 +00:00
// NewDNSProviderConfig return a DNSProvider instance configured for dnspod.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("dnspod: the configuration of the DNS provider is nil")
}
if config.LoginToken == "" {
return nil, fmt.Errorf("dnspod: credentials missing")
2017-02-07 21:33:23 +00:00
}
2018-09-17 13:16:03 +00:00
params := dnspod.CommonParams{LoginToken: config.LoginToken, Format: "json"}
client := dnspod.NewClient(params)
client.HttpClient = config.HTTPClient
2018-10-11 14:50:04 +00:00
return &DNSProvider{client: client, config: config}, nil
2017-02-07 21:33:23 +00:00
}
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
zoneID, zoneName, err := d.getHostedZone(domain)
2017-02-07 21:33:23 +00:00
if err != nil {
return err
}
2018-09-17 13:16:03 +00:00
recordAttributes := d.newTxtRecord(zoneName, fqdn, value, d.config.TTL)
2018-07-03 10:44:04 +00:00
_, _, err = d.client.Domains.CreateRecord(zoneID, *recordAttributes)
2017-02-07 21:33:23 +00:00
if err != nil {
2018-09-17 13:16:03 +00:00
return fmt.Errorf("API call failed: %v", err)
2017-02-07 21:33:23 +00:00
}
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
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)
2017-02-07 21:33:23 +00:00
2018-07-03 10:44:04 +00:00
records, err := d.findTxtRecords(domain, fqdn)
2017-02-07 21:33:23 +00:00
if err != nil {
return err
}
2018-07-03 10:44:04 +00:00
zoneID, _, err := d.getHostedZone(domain)
2017-02-07 21:33:23 +00:00
if err != nil {
return err
}
for _, rec := range records {
2018-07-03 10:44:04 +00:00
_, err := d.client.Domains.DeleteRecord(zoneID, rec.ID)
2017-02-07 21:33:23 +00:00
if err != nil {
return err
}
}
return nil
}
2018-09-17 13:16:03 +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-07-03 10:44:04 +00:00
func (d *DNSProvider) getHostedZone(domain string) (string, string, error) {
zones, _, err := d.client.Domains.List()
2017-02-07 21:33:23 +00:00
if err != nil {
2018-09-17 13:16:03 +00:00
return "", "", fmt.Errorf("API call failed: %v", err)
2017-02-07 21:33:23 +00:00
}
2019-01-07 17:30:06 +00:00
authZone, err := dns01.FindZoneByFqdn(dns01.ToFqdn(domain))
2017-02-07 21:33:23 +00:00
if err != nil {
return "", "", err
}
var hostedZone dnspod.Domain
for _, zone := range zones {
2019-01-07 17:30:06 +00:00
if zone.Name == dns01.UnFqdn(authZone) {
2017-02-07 21:33:23 +00:00
hostedZone = zone
}
}
if hostedZone.ID == 0 {
2018-07-03 10:44:04 +00:00
return "", "", fmt.Errorf("zone %s not found in dnspod for domain %s", authZone, domain)
2017-02-07 21:33:23 +00:00
}
return fmt.Sprintf("%v", hostedZone.ID), hostedZone.Name, nil
}
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) newTxtRecord(zone, fqdn, value string, ttl int) *dnspod.Record {
name := d.extractRecordName(fqdn, zone)
2017-02-07 21:33:23 +00:00
return &dnspod.Record{
Type: "TXT",
Name: name,
Value: value,
Line: "默认",
2018-09-17 13:16:03 +00:00
TTL: strconv.Itoa(ttl),
2017-02-07 21:33:23 +00:00
}
}
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) findTxtRecords(domain, fqdn string) ([]dnspod.Record, error) {
zoneID, zoneName, err := d.getHostedZone(domain)
2017-02-07 21:33:23 +00:00
if err != nil {
return nil, err
}
var records []dnspod.Record
2018-07-03 10:44:04 +00:00
result, _, err := d.client.Domains.ListRecords(zoneID, "")
2017-02-07 21:33:23 +00:00
if err != nil {
2018-09-17 13:16:03 +00:00
return records, fmt.Errorf("API call has failed: %v", err)
2017-02-07 21:33:23 +00:00
}
2018-07-03 10:44:04 +00:00
recordName := d.extractRecordName(fqdn, zoneName)
2017-02-07 21:33:23 +00:00
for _, record := range result {
if record.Name == recordName {
records = append(records, record)
}
}
return records, nil
}
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) extractRecordName(fqdn, domain string) string {
2019-01-07 17:30:06 +00:00
name := dns01.UnFqdn(fqdn)
2017-02-07 21:33:23 +00:00
if idx := strings.Index(name, "."+domain); idx != -1 {
return name[:idx]
}
return name
}