Add support for autodns

README.md

@@ -44,18 +44,18 @@ Detailed documentation is available [here](https://go-acme.github.io/lego/dns).
 |                                                                                 |                                                                                 |                                                                                 |                                                                                 |
 |---------------------------------------------------------------------------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
 | [Alibaba Cloud DNS](https://go-acme.github.io/lego/dns/alidns/)                 | [Amazon Lightsail](https://go-acme.github.io/lego/dns/lightsail/)               | [Amazon Route 53](https://go-acme.github.io/lego/dns/route53/)                  | [Aurora DNS](https://go-acme.github.io/lego/dns/auroradns/)                     |
-| [Azure](https://go-acme.github.io/lego/dns/azure/)                              | [Bindman](https://go-acme.github.io/lego/dns/bindman/)                          | [Bluecat](https://go-acme.github.io/lego/dns/bluecat/)                          | [Cloudflare](https://go-acme.github.io/lego/dns/cloudflare/)                    |
-| [ClouDNS](https://go-acme.github.io/lego/dns/cloudns/)                          | [CloudXNS](https://go-acme.github.io/lego/dns/cloudxns/)                        | [ConoHa](https://go-acme.github.io/lego/dns/conoha/)                            | [Designate DNSaaS for Openstack](https://go-acme.github.io/lego/dns/designate/) |
-| [Digital Ocean](https://go-acme.github.io/lego/dns/digitalocean/)               | [DNS Made Easy](https://go-acme.github.io/lego/dns/dnsmadeeasy/)                | [DNSimple](https://go-acme.github.io/lego/dns/dnsimple/)                        | [DNSPod](https://go-acme.github.io/lego/dns/dnspod/)                            |
-| [Domain Offensive (do.de)](https://go-acme.github.io/lego/dns/dode/)            | [DreamHost](https://go-acme.github.io/lego/dns/dreamhost/)                      | [Duck DNS](https://go-acme.github.io/lego/dns/duckdns/)                         | [Dyn](https://go-acme.github.io/lego/dns/dyn/)                                  |
-| [EasyDNS](https://go-acme.github.io/lego/dns/easydns/)                          | [Exoscale](https://go-acme.github.io/lego/dns/exoscale/)                        | [External program](https://go-acme.github.io/lego/dns/exec/)                    | [FastDNS](https://go-acme.github.io/lego/dns/fastdns/)                          |
-| [Gandi Live DNS (v5)](https://go-acme.github.io/lego/dns/gandiv5/)              | [Gandi](https://go-acme.github.io/lego/dns/gandi/)                              | [Glesys](https://go-acme.github.io/lego/dns/glesys/)                            | [Go Daddy](https://go-acme.github.io/lego/dns/godaddy/)                         |
-| [Google Cloud](https://go-acme.github.io/lego/dns/gcloud/)                      | [Hosting.de](https://go-acme.github.io/lego/dns/hostingde/)                     | [HTTP request](https://go-acme.github.io/lego/dns/httpreq/)                     | [Internet Initiative Japan](https://go-acme.github.io/lego/dns/iij/)            |
-| [INWX](https://go-acme.github.io/lego/dns/inwx/)                                | [Joker](https://go-acme.github.io/lego/dns/joker/)                              | [Joohoi's ACME-DNS](https://go-acme.github.io/lego/dns/acme-dns)                | [Linode (deprecated)](https://go-acme.github.io/lego/dns/linode/)               |
-| [Linode (v4)](https://go-acme.github.io/lego/dns/linodev4/)                     | [Liquid Web](https://go-acme.github.io/lego/dns/liquidweb/)                     | [Manual](https://go-acme.github.io/lego/dns/manual/)                            | [MyDNS.jp](https://go-acme.github.io/lego/dns/mydnsjp/)                         |<!--  -->
-| [Name.com](https://go-acme.github.io/lego/dns/namedotcom/)                      | [Namecheap](https://go-acme.github.io/lego/dns/namecheap/)                      | [Namesilo](https://go-acme.github.io/lego/dns/namesilo/)                        | [Netcup](https://go-acme.github.io/lego/dns/netcup/)                            |
-| [NIFCloud](https://go-acme.github.io/lego/dns/nifcloud/)                        | [NS1](https://go-acme.github.io/lego/dns/ns1/)                                  | [Open Telekom Cloud](https://go-acme.github.io/lego/dns/otc/)                   | [Oracle Cloud](https://go-acme.github.io/lego/dns/oraclecloud/)                 |
-| [OVH](https://go-acme.github.io/lego/dns/ovh/)                                  | [PowerDNS](https://go-acme.github.io/lego/dns/pdns/)                            | [Rackspace](https://go-acme.github.io/lego/dns/rackspace/)                      | [RFC2136](https://go-acme.github.io/lego/dns/rfc2136/)                          |
-| [Sakura Cloud](https://go-acme.github.io/lego/dns/sakuracloud/)                 | [Selectel](https://go-acme.github.io/lego/dns/selectel/)                        | [Stackpath](https://go-acme.github.io/lego/dns/stackpath/)                      | [TransIP](https://go-acme.github.io/lego/dns/transip/)                          |
-| [VegaDNS](https://go-acme.github.io/lego/dns/vegadns/)                          | [Vscale](https://go-acme.github.io/lego/dns/vscale/)                            | [Versio](https://go-acme.github.io/lego/dns/versio/)                            | [Vultr](https://go-acme.github.io/lego/dns/vultr/)                              |
-| [Zone.ee](https://go-acme.github.io/lego/dns/zoneee/)
+| [Autodns](https://go-acme.github.io/lego/dns/autodns/)                          | [Azure](https://go-acme.github.io/lego/dns/azure/)                              | [Bindman](https://go-acme.github.io/lego/dns/bindman/)                          | [Bluecat](https://go-acme.github.io/lego/dns/bluecat/)                          |
+| [Cloudflare](https://go-acme.github.io/lego/dns/cloudflare/)                    | [ClouDNS](https://go-acme.github.io/lego/dns/cloudns/)                          | [CloudXNS](https://go-acme.github.io/lego/dns/cloudxns/)                        | [ConoHa](https://go-acme.github.io/lego/dns/conoha/)                            | 
+| [Designate DNSaaS for Openstack](https://go-acme.github.io/lego/dns/designate/) | [Digital Ocean](https://go-acme.github.io/lego/dns/digitalocean/)               | [DNS Made Easy](https://go-acme.github.io/lego/dns/dnsmadeeasy/)                | [DNSimple](https://go-acme.github.io/lego/dns/dnsimple/)                        |
+| [DNSPod](https://go-acme.github.io/lego/dns/dnspod/)                            | [Domain Offensive (do.de)](https://go-acme.github.io/lego/dns/dode/)            | [DreamHost](https://go-acme.github.io/lego/dns/dreamhost/)                      | [Duck DNS](https://go-acme.github.io/lego/dns/duckdns/)                         |
+| [Dyn](https://go-acme.github.io/lego/dns/dyn/)                                  | [EasyDNS](https://go-acme.github.io/lego/dns/easydns/)                          | [Exoscale](https://go-acme.github.io/lego/dns/exoscale/)                        | [External program](https://go-acme.github.io/lego/dns/exec/)                    |
+| [FastDNS](https://go-acme.github.io/lego/dns/fastdns/)                          | [Gandi Live DNS (v5)](https://go-acme.github.io/lego/dns/gandiv5/)              | [Gandi](https://go-acme.github.io/lego/dns/gandi/)                              | [Glesys](https://go-acme.github.io/lego/dns/glesys/)                            |
+| [Go Daddy](https://go-acme.github.io/lego/dns/godaddy/)                         | [Google Cloud](https://go-acme.github.io/lego/dns/gcloud/)                      | [Hosting.de](https://go-acme.github.io/lego/dns/hostingde/)                     | [HTTP request](https://go-acme.github.io/lego/dns/httpreq/)                     |
+| [Internet Initiative Japan](https://go-acme.github.io/lego/dns/iij/)            | [INWX](https://go-acme.github.io/lego/dns/inwx/)                                | [Joker](https://go-acme.github.io/lego/dns/joker/)                              | [Joohoi's ACME-DNS](https://go-acme.github.io/lego/dns/acme-dns)                |
+| [Linode (deprecated)](https://go-acme.github.io/lego/dns/linode/)               | [Linode (v4)](https://go-acme.github.io/lego/dns/linodev4/)                     | [Liquid Web](https://go-acme.github.io/lego/dns/liquidweb/)                     | [Manual](https://go-acme.github.io/lego/dns/manual/)                            |
+| [MyDNS.jp](https://go-acme.github.io/lego/dns/mydnsjp/)                         | [Name.com](https://go-acme.github.io/lego/dns/namedotcom/)                      | [Namecheap](https://go-acme.github.io/lego/dns/namecheap/)                      | [Namesilo](https://go-acme.github.io/lego/dns/namesilo/)                        |
+| [Netcup](https://go-acme.github.io/lego/dns/netcup/)                            | [NIFCloud](https://go-acme.github.io/lego/dns/nifcloud/)                        | [NS1](https://go-acme.github.io/lego/dns/ns1/)                                  | [Open Telekom Cloud](https://go-acme.github.io/lego/dns/otc/)                   |
+| [Oracle Cloud](https://go-acme.github.io/lego/dns/oraclecloud/)                 | [OVH](https://go-acme.github.io/lego/dns/ovh/)                                  | [PowerDNS](https://go-acme.github.io/lego/dns/pdns/)                            | [Rackspace](https://go-acme.github.io/lego/dns/rackspace/)                      |
+| [RFC2136](https://go-acme.github.io/lego/dns/rfc2136/)                          | [Sakura Cloud](https://go-acme.github.io/lego/dns/sakuracloud/)                 | [Selectel](https://go-acme.github.io/lego/dns/selectel/)                        | [Stackpath](https://go-acme.github.io/lego/dns/stackpath/)                      |
+| [TransIP](https://go-acme.github.io/lego/dns/transip/)                          | [VegaDNS](https://go-acme.github.io/lego/dns/vegadns/)                          | [Vscale](https://go-acme.github.io/lego/dns/vscale/)                            | [Versio](https://go-acme.github.io/lego/dns/versio/)                            |
+| [Vultr](https://go-acme.github.io/lego/dns/vultr/)                              | [Zone.ee](https://go-acme.github.io/lego/dns/zoneee/)

cmd/zz_gen_cmd_dnshelp.go

@@ -17,6 +17,7 @@ func allDNSCodes() string {
 		"acme-dns",
 		"alidns",
 		"auroradns",
+		"autodns",
 		"azure",
 		"bindman",
 		"bluecat",
@@ -141,6 +142,24 @@ func displayDNSHelp(name string) error {
 		ew.writeln()
 		ew.writeln(`More information: https://go-acme.github.io/lego/dns/auroradns`)
 
+	case "autodns":
+		// generated from: providers/dns/autodns/autodns.toml
+		ew.writeln(`Configuration for Autodns.`)
+		ew.writeln(`Code:	'autodns'`)
+		ew.writeln(`Since:	'v3.1.0'`)
+		ew.writeln()
+
+		ew.writeln(`Credentials:`)
+		ew.writeln(`	- "AUTODNS_API_PASSWORD":	User Password`)
+		ew.writeln(`	- "AUTODNS_API_USER":	Username`)
+		ew.writeln(`	- "AUTODNS_CONTEXT":	API context (4 for production, 1 for testing. Defaults to 4)`)
+		ew.writeln(`	- "AUTODNS_ENDPOINT":	API endpoint URL`)
+		ew.writeln(`	- "AUTODNS_TTL":	The TTL of the TXT record used for the DNS challenge`)
+		ew.writeln()
+
+		ew.writeln()
+		ew.writeln(`More information: https://go-acme.github.io/lego/dns/autodns`)
+
 	case "azure":
 		// generated from: providers/dns/azure/azure.toml
 		ew.writeln(`Configuration for Azure.`)

providers/dns/autodns/autodns.go

@@ -0,0 +1,111 @@
+package autodns
+
+import (
+	"fmt"
+	"net/http"
+	"net/url"
+	"time"
+
+	"github.com/go-acme/lego/v3/challenge/dns01"
+	"github.com/go-acme/lego/v3/platform/config/env"
+)
+
+const (
+	envAPIUser            = `AUTODNS_API_USER`
+	envAPIPassword        = `AUTODNS_API_PASSWORD`
+	envAPIEndpoint        = `AUTODNS_ENDPOINT`
+	envAPIEndpointContext = `AUTODNS_CONTEXT`
+	envTTL                = `AUTODNS_TTL`
+	envPropagationTimeout = `AUTODNS_PROPAGATION_TIMEOUT`
+	envPollingInterval    = `AUTODNS_POLLING_INTERVAL`
+	envHTTPTimeout        = `AUTODNS_HTTP_TIMEOUT`
+
+	defaultEndpoint = `https://api.autodns.com/v1/`
+	demoEndpoint    = `https://api.demo.autodns.com/v1/`
+
+	defaultEndpointContext int = 4
+	defaultTTL             int = 600
+)
+
+type Config struct {
+	Endpoint           *url.URL
+	Username           string        `json:"username"`
+	Password           string        `json:"password"`
+	Context            int           `json:"-"`
+	TTL                int           `json:"-"`
+	PropagationTimeout time.Duration `json:"-"`
+	PollingInterval    time.Duration `json:"-"`
+	HTTPClient         *http.Client
+}
+
+func NewDefaultConfig() *Config {
+	endpoint, _ := url.Parse(env.GetOrDefaultString(envAPIEndpoint, defaultEndpoint))
+
+	return &Config{
+		Endpoint:           endpoint,
+		Context:            env.GetOrDefaultInt(envAPIEndpointContext, defaultEndpointContext),
+		TTL:                env.GetOrDefaultInt(envTTL, defaultTTL),
+		PropagationTimeout: env.GetOrDefaultSecond(envPropagationTimeout, 2*time.Minute),
+		PollingInterval:    env.GetOrDefaultSecond(envPollingInterval, 2*time.Second),
+		HTTPClient: &http.Client{
+			Timeout: env.GetOrDefaultSecond(envHTTPTimeout, 30*time.Second),
+		},
+	}
+}
+
+type DNSProvider struct {
+	config *Config
+}
+
+func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
+	return d.config.PropagationTimeout, d.config.PollingInterval
+}
+
+func NewDNSProvider() (*DNSProvider, error) {
+	values, err := env.Get(envAPIUser, envAPIPassword)
+	if err != nil {
+		return nil, fmt.Errorf("autodns: %v", err)
+	}
+
+	config := NewDefaultConfig()
+	config.Username = values[envAPIUser]
+	config.Password = values[envAPIPassword]
+
+	return NewDNSProviderConfig(config)
+}
+
+func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
+	if config == nil {
+		return nil, fmt.Errorf("autodns: NewDNSProviderConfig: config is nil")
+	}
+
+	if config.Username == "" {
+		return nil, fmt.Errorf("autodns: NewDNSProviderConfig: missing user")
+	}
+
+	if config.Password == "" {
+		return nil, fmt.Errorf("autodns: NewDNSProviderConfig: missing password")
+	}
+
+	return &DNSProvider{config: config}, nil
+}
+
+// Present creates a TXT record to fulfill the dns-01 challenge
+func (d *DNSProvider) Present(domain, token, keyAuth string) (err error) {
+	fqdn, value := dns01.GetRecord(domain, keyAuth)
+	_, err = d.addTxtRecord(domain, fqdn, value)
+	if err != nil {
+		return fmt.Errorf("autodns: %v", err)
+	}
+	return nil
+}
+
+// CleanUp removes the TXT record previously created
+func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
+	fqdn, realToken := dns01.GetRecord(domain, keyAuth)
+	if err := d.removeTXTRecord(domain, fqdn, realToken); err != nil {
+		return fmt.Errorf("autodns: removeTXTRecord: %v", err)
+	}
+
+	return nil
+}

providers/dns/autodns/autodns.toml

@@ -0,0 +1,25 @@
+Name = "Autodns"
+Description = ''''''
+URL = "https://www.internetx.com/domains/autodns/"
+Code = "autodns"
+Since = "v3.1.0"
+
+Example = '''
+AUTODNS_API_USER=usernam \
+AUTODNS_API_PASSWORD=supersecretpassword \
+lego --dns autodns --domains my.domain.com --email my@email.com run
+'''
+
+[Configuration]
+  [Configuration.Credentials]
+    AUTODNS_API_USER = "Username"
+    AUTODNS_API_PASSWORD = "User Password"
+  [Configuration.Additional]
+    AUTODNS_ENDPOINT = "API endpoint URL, defaults to https://api.autodns.com/v1/"
+    AUTODNS_CONTEXT = "API context (4 for production, 1 for testing. Defaults to 4)"
+    AUTODNS_TTL = "The TTL of the TXT record used for the DNS challenge"
+    AUTODNS_POLLING_INTERVAL = "Time between DNS propagation check"
+    AUTODNS_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
+    AUTODNS_HTTP_TIMEOUT = "API request timeout, defaults to 30 seconds"
+[Links]
+  API = "https://help.internetx.com/display/APIJSONEN"

providers/dns/autodns/autodns_test.go

@@ -0,0 +1,143 @@
+package autodns
+
+import (
+	"net/http"
+	"net/url"
+	"reflect"
+	"testing"
+	"time"
+
+	"github.com/go-acme/lego/v3/platform/tester"
+	"github.com/stretchr/testify/assert"
+)
+
+var envTest = tester.NewEnvTest(envAPIEndpoint, envAPIUser, envAPIPassword)
+
+func TestNewDNSProvider(t *testing.T) {
+	defaultEndpointURL, _ := url.Parse(defaultEndpoint)
+	examplEndpointURL, _ := url.Parse(demoEndpoint)
+
+	tests := []struct {
+		name        string
+		want        *DNSProvider
+		wantErr     bool
+		expectedErr string
+		env         map[string]string
+	}{
+		{
+			name: "complete, no errors",
+			want: &DNSProvider{
+				config: &Config{
+					Endpoint:           defaultEndpointURL,
+					Username:           "test",
+					Password:           "1234",
+					Context:            defaultEndpointContext,
+					TTL:                defaultTTL,
+					PropagationTimeout: 2 * time.Minute,
+					PollingInterval:    2 * time.Second,
+					HTTPClient: &http.Client{
+						Timeout: 30 * time.Second,
+					},
+				},
+			},
+			env: map[string]string{
+				envAPIUser:     "test",
+				envAPIPassword: "1234",
+			},
+		},
+		{
+			name: "different endpoint url",
+			want: &DNSProvider{
+				config: &Config{
+					Endpoint:           examplEndpointURL,
+					Username:           "test",
+					Password:           "1234",
+					Context:            defaultEndpointContext,
+					TTL:                defaultTTL,
+					PropagationTimeout: 2 * time.Minute,
+					PollingInterval:    2 * time.Second,
+					HTTPClient: &http.Client{
+						Timeout: 30 * time.Second,
+					},
+				},
+			},
+			env: map[string]string{
+				envAPIUser:     "test",
+				envAPIPassword: "1234",
+				envAPIEndpoint: demoEndpoint,
+			},
+		},
+		{
+			name: "missing credentials",
+			env: map[string]string{
+				envAPIUser:     "",
+				envAPIPassword: "",
+			},
+			wantErr:     true,
+			expectedErr: "autodns: some credentials information are missing: AUTODNS_API_USER,AUTODNS_API_PASSWORD",
+		},
+		{
+			name: "missing username",
+			env: map[string]string{
+				envAPIUser:     "",
+				envAPIPassword: "1234",
+			},
+			wantErr:     true,
+			expectedErr: "autodns: some credentials information are missing: AUTODNS_API_USER",
+		},
+		{
+			name: "missing password",
+			env: map[string]string{
+				envAPIUser:     "user",
+				envAPIPassword: "",
+			},
+			wantErr:     true,
+			expectedErr: "autodns: some credentials information are missing: AUTODNS_API_PASSWORD",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			defer envTest.RestoreEnv()
+			envTest.ClearEnv()
+			envTest.Apply(tt.env)
+
+			got, err := NewDNSProvider()
+			if (err != nil) != tt.wantErr {
+				t.Errorf("NewDNSProvider() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if (err != nil) && tt.wantErr {
+				assert.EqualError(t, err, tt.expectedErr)
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("NewDNSProvider() got = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestLivePresent(t *testing.T) {
+	if !envTest.IsLiveTest() {
+		t.Skip("skipping live test")
+	}
+
+	envTest.RestoreEnv()
+	provider, err := NewDNSProvider()
+	assert.NoError(t, err)
+
+	err = provider.Present(envTest.GetDomain(), "", "123d==")
+	assert.NoError(t, err)
+}
+
+func TestLiveCleanUp(t *testing.T) {
+	if !envTest.IsLiveTest() {
+		t.Skip("skipping live test")
+	}
+
+	envTest.RestoreEnv()
+	provider, err := NewDNSProvider()
+	assert.NoError(t, err)
+
+	err = provider.CleanUp(envTest.GetDomain(), "", "123d==")
+	assert.NoError(t, err)
+}