1
0
mirror of https://github.com/go-acme/lego.git synced 2024-12-05 20:02:38 +02:00
lego/providers/dns/dnspod/dnspod.go

201 lines
5.1 KiB
Go
Raw Normal View History

// Package dnspod implements a DNS provider for solving the DNS-01 challenge using dnspod DNS.
2019-03-11 18:56:48 +02:00
package dnspod
2016-11-14 12:41:37 +02:00
import (
"errors"
2016-11-14 12:41:37 +02:00
"fmt"
"net/http"
"strconv"
2016-11-14 12:41:37 +02:00
"strings"
"time"
2016-11-14 12:41:37 +02:00
"github.com/go-acme/lego/v3/challenge/dns01"
"github.com/go-acme/lego/v3/platform/config/env"
"github.com/nrdcg/dnspod-go"
2016-11-14 12:41:37 +02:00
)
// Environment variables names.
const (
envNamespace = "DNSPOD_"
EnvAPIKey = envNamespace + "API_KEY"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
2020-05-08 19:35:25 +02: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
}
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, 600),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30),
},
}
}
2020-05-08 19:35:25 +02:00
// DNSProvider implements the challenge.Provider interface.
2016-11-14 12:41:37 +02:00
type DNSProvider struct {
config *Config
2016-11-14 12:41:37 +02: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) {
values, err := env.Get(EnvAPIKey)
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("dnspod: %w", err)
}
config := NewDefaultConfig()
config.LoginToken = values[EnvAPIKey]
return NewDNSProviderConfig(config)
2016-11-14 12:41:37 +02: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 == "" {
2020-02-27 20:14:46 +02:00
return nil, errors.New("dnspod: credentials missing")
2016-11-14 12:41:37 +02:00
}
params := dnspod.CommonParams{LoginToken: config.LoginToken, Format: "json"}
client := dnspod.NewClient(params)
client.HTTPClient = config.HTTPClient
2018-10-11 15:49:33 +02:00
return &DNSProvider{client: client, config: config}, nil
2016-11-14 12:41:37 +02: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)
zoneID, zoneName, err := d.getHostedZone(domain)
2016-11-14 12:41:37 +02:00
if err != nil {
return err
}
recordAttributes := d.newTxtRecord(zoneName, fqdn, value, d.config.TTL)
2020-01-09 12:23:28 +02:00
_, _, err = d.client.Records.Create(zoneID, *recordAttributes)
2016-11-14 12:41:37 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("API call failed: %w", err)
2016-11-14 12:41:37 +02:00
}
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
fqdn, _ := dns01.GetRecord(domain, keyAuth)
2016-11-14 12:41:37 +02:00
records, err := d.findTxtRecords(domain, fqdn)
2016-11-14 12:41:37 +02:00
if err != nil {
return err
}
zoneID, _, err := d.getHostedZone(domain)
2016-11-14 12:41:37 +02:00
if err != nil {
return err
}
for _, rec := range records {
2020-01-09 12:23:28 +02:00
_, err := d.client.Records.Delete(zoneID, rec.ID)
2016-11-14 12:41:37 +02:00
if err != nil {
return err
}
}
return 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
}
func (d *DNSProvider) getHostedZone(domain string) (string, string, error) {
zones, _, err := d.client.Domains.List()
2016-11-14 12:41:37 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return "", "", fmt.Errorf("API call failed: %w", err)
2016-11-14 12:41:37 +02:00
}
authZone, err := dns01.FindZoneByFqdn(dns01.ToFqdn(domain))
2016-11-14 12:41:37 +02:00
if err != nil {
return "", "", err
}
var hostedZone dnspod.Domain
for _, zone := range zones {
if zone.Name == dns01.UnFqdn(authZone) {
2016-11-14 12:41:37 +02:00
hostedZone = zone
}
}
if hostedZone.ID == "" || hostedZone.ID == "0" {
return "", "", fmt.Errorf("zone %s not found in dnspod for domain %s", authZone, domain)
2016-11-14 12:41:37 +02:00
}
return fmt.Sprintf("%v", hostedZone.ID), hostedZone.Name, nil
}
func (d *DNSProvider) newTxtRecord(zone, fqdn, value string, ttl int) *dnspod.Record {
2020-06-27 14:28:59 +02:00
name := extractRecordName(fqdn, zone)
2016-11-14 12:41:37 +02:00
return &dnspod.Record{
Type: "TXT",
Name: name,
Value: value,
Line: "默认",
TTL: strconv.Itoa(ttl),
2016-11-14 12:41:37 +02:00
}
}
func (d *DNSProvider) findTxtRecords(domain, fqdn string) ([]dnspod.Record, error) {
zoneID, zoneName, err := d.getHostedZone(domain)
2016-11-14 12:41:37 +02:00
if err != nil {
return nil, err
}
var records []dnspod.Record
2020-01-09 12:23:28 +02:00
result, _, err := d.client.Records.List(zoneID, "")
2016-11-14 12:41:37 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return records, fmt.Errorf("API call has failed: %w", err)
2016-11-14 12:41:37 +02:00
}
2020-06-27 14:28:59 +02:00
recordName := extractRecordName(fqdn, zoneName)
2016-11-14 12:41:37 +02:00
for _, record := range result {
if record.Name == recordName {
records = append(records, record)
}
}
return records, nil
}
2020-06-27 14:28:59 +02:00
func extractRecordName(fqdn, zone string) string {
name := dns01.UnFqdn(fqdn)
2020-06-27 14:28:59 +02:00
if idx := strings.Index(name, "."+zone); idx != -1 {
2016-11-14 12:41:37 +02:00
return name[:idx]
}
return name
}