From 9f86882f775f75f69617ecc160e39f4e0b7ae27f Mon Sep 17 00:00:00 2001 From: decker Date: Mon, 14 Nov 2016 18:41:37 +0800 Subject: [PATCH] Add dns provider for dnspod (#312) --- cli.go | 1 + cli_handlers.go | 5 +- providers/dns/dnspod/dnspod.go | 146 ++++++++++++++++++++++++++++ providers/dns/dnspod/dnspod_test.go | 72 ++++++++++++++ 4 files changed, 223 insertions(+), 1 deletion(-) create mode 100644 providers/dns/dnspod/dnspod.go create mode 100644 providers/dns/dnspod/dnspod_test.go diff --git a/cli.go b/cli.go index 6b2eec42..9fac2dd5 100644 --- a/cli.go +++ b/cli.go @@ -220,6 +220,7 @@ Here is an example bash command using the CloudFlare DNS provider: fmt.Fprintln(w, "\tvultr:\tVULTR_API_KEY") fmt.Fprintln(w, "\tovh:\tOVH_ENDPOINT, OVH_APPLICATION_KEY, OVH_APPLICATION_SECRET, OVH_CONSUMER_KEY") fmt.Fprintln(w, "\tpdns:\tPDNS_API_KEY, PDNS_API_URL") + fmt.Fprintln(w, "\tdnspod:\tDNSPOD_API_KEY") w.Flush() fmt.Println(` diff --git a/cli_handlers.go b/cli_handlers.go index 39a449e0..45e78124 100644 --- a/cli_handlers.go +++ b/cli_handlers.go @@ -15,12 +15,13 @@ import ( "github.com/urfave/cli" "github.com/xenolf/lego/acme" - "github.com/xenolf/lego/providers/dns/azure" "github.com/xenolf/lego/providers/dns/auroradns" + "github.com/xenolf/lego/providers/dns/azure" "github.com/xenolf/lego/providers/dns/cloudflare" "github.com/xenolf/lego/providers/dns/digitalocean" "github.com/xenolf/lego/providers/dns/dnsimple" "github.com/xenolf/lego/providers/dns/dnsmadeeasy" + "github.com/xenolf/lego/providers/dns/dnspod" "github.com/xenolf/lego/providers/dns/dyn" "github.com/xenolf/lego/providers/dns/exoscale" "github.com/xenolf/lego/providers/dns/gandi" @@ -175,6 +176,8 @@ func setup(c *cli.Context) (*Configuration, *Account, *acme.Client) { provider, err = pdns.NewDNSProvider() case "ns1": provider, err = ns1.NewDNSProvider() + case "dnspod": + provider, err = dnspod.NewDNSProvider() } if err != nil { diff --git a/providers/dns/dnspod/dnspod.go b/providers/dns/dnspod/dnspod.go new file mode 100644 index 00000000..0ce08a8b --- /dev/null +++ b/providers/dns/dnspod/dnspod.go @@ -0,0 +1,146 @@ +// Package dnspod implements a DNS provider for solving the DNS-01 challenge +// using dnspod DNS. +package dnspod + +import ( + "fmt" + "os" + "strings" + + "github.com/decker502/dnspod-go" + "github.com/xenolf/lego/acme" +) + +// DNSProvider is an implementation of the acme.ChallengeProvider interface. +type DNSProvider struct { + 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) { + key := os.Getenv("DNSPOD_API_KEY") + return NewDNSProviderCredentials(key) +} + +// NewDNSProviderCredentials uses the supplied credentials to return a +// DNSProvider instance configured for dnspod. +func NewDNSProviderCredentials(key string) (*DNSProvider, error) { + if key == "" { + return nil, fmt.Errorf("dnspod credentials missing") + } + + params := dnspod.CommonParams{LoginToken: key, Format: "json"} + return &DNSProvider{ + client: dnspod.NewClient(params), + }, nil +} + +// Present creates a TXT record to fulfil the dns-01 challenge. +func (c *DNSProvider) Present(domain, token, keyAuth string) error { + fqdn, value, ttl := acme.DNS01Record(domain, keyAuth) + zoneID, zoneName, err := c.getHostedZone(domain) + if err != nil { + return err + } + + recordAttributes := c.newTxtRecord(zoneName, fqdn, value, ttl) + _, _, err = c.client.Domains.CreateRecord(zoneID, *recordAttributes) + if err != nil { + return fmt.Errorf("dnspod API call failed: %v", err) + } + + return nil +} + +// CleanUp removes the TXT record matching the specified parameters. +func (c *DNSProvider) CleanUp(domain, token, keyAuth string) error { + fqdn, _, _ := acme.DNS01Record(domain, keyAuth) + + records, err := c.findTxtRecords(domain, fqdn) + if err != nil { + return err + } + + zoneID, _, err := c.getHostedZone(domain) + if err != nil { + return err + } + + for _, rec := range records { + _, err := c.client.Domains.DeleteRecord(zoneID, rec.ID) + if err != nil { + return err + } + } + return nil +} + +func (c *DNSProvider) getHostedZone(domain string) (string, string, error) { + zones, _, err := c.client.Domains.List() + if err != nil { + return "", "", fmt.Errorf("dnspod API call failed: %v", err) + } + + authZone, err := acme.FindZoneByFqdn(acme.ToFqdn(domain), acme.RecursiveNameservers) + if err != nil { + return "", "", err + } + + var hostedZone dnspod.Domain + for _, zone := range zones { + if zone.Name == acme.UnFqdn(authZone) { + hostedZone = zone + } + } + + if hostedZone.ID == 0 { + return "", "", fmt.Errorf("Zone %s not found in dnspod for domain %s", authZone, domain) + + } + + return fmt.Sprintf("%v", hostedZone.ID), hostedZone.Name, nil +} + +func (c *DNSProvider) newTxtRecord(zone, fqdn, value string, ttl int) *dnspod.Record { + name := c.extractRecordName(fqdn, zone) + + return &dnspod.Record{ + Type: "TXT", + Name: name, + Value: value, + Line: "默认", + TTL: "600", + } +} + +func (c *DNSProvider) findTxtRecords(domain, fqdn string) ([]dnspod.Record, error) { + zoneID, zoneName, err := c.getHostedZone(domain) + if err != nil { + return nil, err + } + + var records []dnspod.Record + result, _, err := c.client.Domains.ListRecords(zoneID, "") + if err != nil { + return records, fmt.Errorf("dnspod API call has failed: %v", err) + } + + recordName := c.extractRecordName(fqdn, zoneName) + + for _, record := range result { + if record.Name == recordName { + records = append(records, record) + } + } + + return records, nil +} + +func (c *DNSProvider) extractRecordName(fqdn, domain string) string { + name := acme.UnFqdn(fqdn) + if idx := strings.Index(name, "."+domain); idx != -1 { + return name[:idx] + } + return name +} diff --git a/providers/dns/dnspod/dnspod_test.go b/providers/dns/dnspod/dnspod_test.go new file mode 100644 index 00000000..3311eb0a --- /dev/null +++ b/providers/dns/dnspod/dnspod_test.go @@ -0,0 +1,72 @@ +package dnspod + +import ( + "github.com/stretchr/testify/assert" + "os" + "testing" + "time" +) + +var ( + dnspodLiveTest bool + dnspodAPIKey string + dnspodDomain string +) + +func init() { + dnspodAPIKey = os.Getenv("DNSPOD_API_KEY") + dnspodDomain = os.Getenv("DNSPOD_DOMAIN") + if len(dnspodAPIKey) > 0 && len(dnspodDomain) > 0 { + dnspodLiveTest = true + } +} + +func restorednspodEnv() { + os.Setenv("DNSPOD_API_KEY", dnspodAPIKey) +} + +func TestNewDNSProviderValid(t *testing.T) { + os.Setenv("DNSPOD_API_KEY", "") + _, err := NewDNSProviderCredentials("123") + assert.NoError(t, err) + restorednspodEnv() +} +func TestNewDNSProviderValidEnv(t *testing.T) { + os.Setenv("DNSPOD_API_KEY", "123") + _, err := NewDNSProvider() + assert.NoError(t, err) + restorednspodEnv() +} + +func TestNewDNSProviderMissingCredErr(t *testing.T) { + os.Setenv("DNSPOD_API_KEY", "") + _, err := NewDNSProvider() + assert.EqualError(t, err, "dnspod credentials missing") + restorednspodEnv() +} + +func TestLivednspodPresent(t *testing.T) { + if !dnspodLiveTest { + t.Skip("skipping live test") + } + + provider, err := NewDNSProviderCredentials(dnspodAPIKey) + assert.NoError(t, err) + + err = provider.Present(dnspodDomain, "", "123d==") + assert.NoError(t, err) +} + +func TestLivednspodCleanUp(t *testing.T) { + if !dnspodLiveTest { + t.Skip("skipping live test") + } + + time.Sleep(time.Second * 1) + + provider, err := NewDNSProviderCredentials(dnspodAPIKey) + assert.NoError(t, err) + + err = provider.CleanUp(dnspodDomain, "", "123d==") + assert.NoError(t, err) +}