Add DNS provider for DanDomain

providers/dns/curanet/curanet.go

@@ -2,16 +2,15 @@
 package curanet
 
 import (
-	"context"
 	"errors"
 	"fmt"
 	"net/http"
 	"time"
 
+	"github.com/go-acme/lego/v4/challenge"
 	"github.com/go-acme/lego/v4/challenge/dns01"
 	"github.com/go-acme/lego/v4/platform/config/env"
-	"github.com/go-acme/lego/v4/providers/dns/curanet/internal"
-	"github.com/go-acme/lego/v4/providers/dns/internal/clientdebug"
+	"github.com/go-acme/lego/v4/providers/dns/internal/curanet"
 )
 
 // Environment variables names.
@@ -27,14 +26,7 @@ const (
 )
 
 // Config is used to configure the creation of the DNSProvider.
-type Config struct {
-	APIKey string
-
-	PropagationTimeout time.Duration
-	PollingInterval    time.Duration
-	TTL                int
-	HTTPClient         *http.Client
-}
+type Config = curanet.Config
 
 // NewDefaultConfig returns a default configuration for the DNSProvider.
 func NewDefaultConfig() *Config {
@@ -50,8 +42,7 @@ func NewDefaultConfig() *Config {
 
 // DNSProvider implements the challenge.Provider interface.
 type DNSProvider struct {
-	config *Config
-	client *internal.Client
+	prv challenge.ProviderTimeout
 }
 
 // NewDNSProvider returns a DNSProvider instance configured for Curanet.
@@ -73,96 +64,36 @@ func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
 		return nil, errors.New("curanet: the configuration of the DNS provider is nil")
 	}
 
-	client, err := internal.NewClient(config.APIKey)
+	provider, err := curanet.NewDNSProviderConfig(config, "")
 	if err != nil {
 		return nil, fmt.Errorf("curanet: %w", err)
 	}
 
-	if config.HTTPClient != nil {
-		client.HTTPClient = config.HTTPClient
-	}
-
-	client.HTTPClient = clientdebug.Wrap(client.HTTPClient)
-
-	return &DNSProvider{
-		config: config,
-		client: client,
-	}, nil
+	return &DNSProvider{prv: provider}, nil
 }
 
 // Present creates a TXT record using the specified parameters.
 func (d *DNSProvider) Present(domain, token, keyAuth string) error {
-	info := dns01.GetChallengeInfo(domain, keyAuth)
-
-	authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
-	if err != nil {
-		return fmt.Errorf("curanet: could not find zone for domain %q: %w", domain, err)
-	}
-
-	subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
+	err := d.prv.Present(domain, token, keyAuth)
 	if err != nil {
 		return fmt.Errorf("curanet: %w", err)
 	}
 
-	record := internal.Record{
-		Name: subDomain,
-		Type: "TXT",
-		TTL:  d.config.TTL,
-		Data: info.Value,
-	}
-
-	err = d.client.CreateRecord(context.Background(), dns01.UnFqdn(authZone), record)
-	if err != nil {
-		return fmt.Errorf("curanet: create record: %w", err)
-	}
-
 	return nil
 }
 
 // CleanUp removes the TXT record matching the specified parameters.
 func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
-	info := dns01.GetChallengeInfo(domain, keyAuth)
-
-	authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
-	if err != nil {
-		return fmt.Errorf("curanet: could not find zone for domain %q: %w", domain, err)
-	}
-
-	subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
+	err := d.prv.CleanUp(domain, token, keyAuth)
 	if err != nil {
 		return fmt.Errorf("curanet: %w", err)
 	}
 
-	record, err := d.findRecord(context.Background(), dns01.UnFqdn(authZone), subDomain, info.Value)
-	if err != nil {
-		return fmt.Errorf("curanet: %w", err)
-	}
-
-	err = d.client.DeleteRecord(context.Background(), dns01.UnFqdn(authZone), record.ID)
-	if err != nil {
-		return fmt.Errorf("curanet: delete record: %w", 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) findRecord(ctx context.Context, zone, subDomain, value string) (*internal.Record, error) {
-	records, err := d.client.GetRecords(ctx, zone, subDomain, "TXT")
-	if err != nil {
-		return nil, fmt.Errorf("get records: %w", err)
-	}
-
-	for _, record := range records {
-		if record.Name == subDomain && record.Type == "TXT" && record.Data == value {
-			return &record, nil
-		}
-	}
-
-	return nil, errors.New("record not found")
+	return d.prv.Timeout()
 }

providers/dns/curanet/curanet_test.go

@@ -1,13 +1,9 @@
 package curanet
 
 import (
-	"net/http"
-	"net/http/httptest"
-	"net/url"
 	"testing"
 
 	"github.com/go-acme/lego/v4/platform/tester"
-	"github.com/go-acme/lego/v4/platform/tester/servermock"
 	"github.com/stretchr/testify/require"
 )
 
@@ -47,8 +43,7 @@ func TestNewDNSProvider(t *testing.T) {
 			if test.expected == "" {
 				require.NoError(t, err)
 				require.NotNil(t, p)
-				require.NotNil(t, p.config)
-				require.NotNil(t, p.client)
+				require.NotNil(t, p.prv)
 			} else {
 				require.EqualError(t, err, test.expected)
 			}
@@ -82,8 +77,7 @@ func TestNewDNSProviderConfig(t *testing.T) {
 			if test.expected == "" {
 				require.NoError(t, err)
 				require.NotNil(t, p)
-				require.NotNil(t, p.config)
-				require.NotNil(t, p.client)
+				require.NotNil(t, p.prv)
 			} else {
 				require.EqualError(t, err, test.expected)
 			}
@@ -118,56 +112,3 @@ func TestLiveCleanUp(t *testing.T) {
 	err = provider.CleanUp(envTest.GetDomain(), "", "123d==")
 	require.NoError(t, err)
 }
-
-func mockBuilder() *servermock.Builder[*DNSProvider] {
-	return servermock.NewBuilder(
-		func(server *httptest.Server) (*DNSProvider, error) {
-			config := NewDefaultConfig()
-			config.APIKey = "secret"
-			config.HTTPClient = server.Client()
-
-			p, err := NewDNSProviderConfig(config)
-			if err != nil {
-				return nil, err
-			}
-
-			p.client.BaseURL, _ = url.Parse(server.URL)
-
-			return p, nil
-		},
-		servermock.CheckHeader().
-			WithJSONHeaders().
-			WithAuthorization("Bearer secret"),
-	)
-}
-
-func TestDNSProvider_Present(t *testing.T) {
-	provider := mockBuilder().
-		Route("POST /dns/v2/Domains/example.com/Records",
-			servermock.Noop().
-				WithStatusCode(http.StatusCreated),
-			servermock.CheckRequestJSONBodyFromInternal("records_create-request.json"),
-		).
-		Build(t)
-
-	err := provider.Present("example.com", "abc", "123d==")
-	require.NoError(t, err)
-}
-
-func TestDNSProvider_CleanUp(t *testing.T) {
-	provider := mockBuilder().
-		Route("GET /dns/v2/Domains/example.com/Records",
-			servermock.ResponseFromInternal("records_get.json"),
-			servermock.CheckQueryParameter().Strict().
-				With("name", "_acme-challenge").
-				With("type", "TXT"),
-		).
-		Route("DELETE /dns/v2/Domains/example.com/Records/1234",
-			servermock.Noop().
-				WithStatusCode(http.StatusOK),
-		).
-		Build(t)
-
-	err := provider.CleanUp("example.com", "abc", "123d==")
-	require.NoError(t, err)
-}

providers/dns/dandomain/dandomain.go

@@ -0,0 +1,99 @@
+// Package dandomain implements a DNS provider for solving the DNS-01 challenge using DanDomain.
+package dandomain
+
+import (
+	"errors"
+	"fmt"
+	"net/http"
+	"time"
+
+	"github.com/go-acme/lego/v4/challenge"
+	"github.com/go-acme/lego/v4/challenge/dns01"
+	"github.com/go-acme/lego/v4/platform/config/env"
+	"github.com/go-acme/lego/v4/providers/dns/internal/curanet"
+)
+
+// Environment variables names.
+const (
+	envNamespace = "DANDOMAIN_"
+
+	EnvAPIKey = envNamespace + "API_KEY"
+
+	EnvTTL                = envNamespace + "TTL"
+	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
+	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
+	EnvHTTPTimeout        = envNamespace + "HTTP_TIMEOUT"
+)
+
+// Config is used to configure the creation of the DNSProvider.
+type Config = curanet.Config
+
+// NewDefaultConfig returns a default configuration for the DNSProvider.
+func NewDefaultConfig() *Config {
+	return &Config{
+		TTL:                env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
+		PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
+		PollingInterval:    env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
+		HTTPClient: &http.Client{
+			Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
+		},
+	}
+}
+
+// DNSProvider implements the challenge.Provider interface.
+type DNSProvider struct {
+	prv challenge.ProviderTimeout
+}
+
+// NewDNSProvider returns a DNSProvider instance configured for DanDomain.
+func NewDNSProvider() (*DNSProvider, error) {
+	values, err := env.Get(EnvAPIKey)
+	if err != nil {
+		return nil, fmt.Errorf("dandomain: %w", err)
+	}
+
+	config := NewDefaultConfig()
+	config.APIKey = values[EnvAPIKey]
+
+	return NewDNSProviderConfig(config)
+}
+
+// NewDNSProviderConfig return a DNSProvider instance configured for DanDomain.
+func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
+	if config == nil {
+		return nil, errors.New("dandomain: the configuration of the DNS provider is nil")
+	}
+
+	provider, err := curanet.NewDNSProviderConfig(config, "")
+	if err != nil {
+		return nil, fmt.Errorf("dandomain: %w", err)
+	}
+
+	return &DNSProvider{prv: provider}, nil
+}
+
+// Present creates a TXT record using the specified parameters.
+func (d *DNSProvider) Present(domain, token, keyAuth string) error {
+	err := d.prv.Present(domain, token, keyAuth)
+	if err != nil {
+		return fmt.Errorf("dandomain: %w", err)
+	}
+
+	return nil
+}
+
+// CleanUp removes the TXT record matching the specified parameters.
+func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
+	err := d.prv.CleanUp(domain, token, keyAuth)
+	if err != nil {
+		return fmt.Errorf("dandomain: %w", 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.prv.Timeout()
+}

providers/dns/dandomain/dandomain.toml

@@ -0,0 +1,22 @@
+Name = "DanDomain"
+Description = ''''''
+URL = "https://dandomain.dk/"
+Code = "dandomain"
+Since = "v4.32.0"
+
+Example = '''
+DANDOMAIN_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \
+lego --dns dandomain -d '*.example.com' -d example.com run
+'''
+
+[Configuration]
+  [Configuration.Credentials]
+    DANDOMAIN_API_KEY = "API key"
+  [Configuration.Additional]
+    DANDOMAIN_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"
+    DANDOMAIN_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 60)"
+    DANDOMAIN_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)"
+    DANDOMAIN_HTTP_TIMEOUT = "API request timeout in seconds (Default: 30)"
+
+[Links]
+  API = "https://api.dandomain.dk/dns/swagger/index.html"

providers/dns/dandomain/dandomain_test.go

@@ -0,0 +1,114 @@
+package dandomain
+
+import (
+	"testing"
+
+	"github.com/go-acme/lego/v4/platform/tester"
+	"github.com/stretchr/testify/require"
+)
+
+const envDomain = envNamespace + "DOMAIN"
+
+var envTest = tester.NewEnvTest(EnvAPIKey).WithDomain(envDomain)
+
+func TestNewDNSProvider(t *testing.T) {
+	testCases := []struct {
+		desc     string
+		envVars  map[string]string
+		expected string
+	}{
+		{
+			desc: "success",
+			envVars: map[string]string{
+				EnvAPIKey: "secret",
+			},
+		},
+		{
+			desc:     "missing credentials",
+			envVars:  map[string]string{},
+			expected: "dandomain: some credentials information are missing: DANDOMAIN_API_KEY",
+		},
+	}
+
+	for _, test := range testCases {
+		t.Run(test.desc, func(t *testing.T) {
+			defer envTest.RestoreEnv()
+
+			envTest.ClearEnv()
+
+			envTest.Apply(test.envVars)
+
+			p, err := NewDNSProvider()
+
+			if test.expected == "" {
+				require.NoError(t, err)
+				require.NotNil(t, p)
+				require.NotNil(t, p.prv)
+			} else {
+				require.EqualError(t, err, test.expected)
+			}
+		})
+	}
+}
+
+func TestNewDNSProviderConfig(t *testing.T) {
+	testCases := []struct {
+		desc     string
+		apiKey   string
+		expected string
+	}{
+		{
+			desc:   "success",
+			apiKey: "secret",
+		},
+		{
+			desc:     "missing credentials",
+			expected: "dandomain: credentials missing",
+		},
+	}
+
+	for _, test := range testCases {
+		t.Run(test.desc, func(t *testing.T) {
+			config := NewDefaultConfig()
+			config.APIKey = test.apiKey
+
+			p, err := NewDNSProviderConfig(config)
+
+			if test.expected == "" {
+				require.NoError(t, err)
+				require.NotNil(t, p)
+				require.NotNil(t, p.prv)
+			} else {
+				require.EqualError(t, err, test.expected)
+			}
+		})
+	}
+}
+
+func TestLivePresent(t *testing.T) {
+	if !envTest.IsLiveTest() {
+		t.Skip("skipping live test")
+	}
+
+	envTest.RestoreEnv()
+
+	provider, err := NewDNSProvider()
+	require.NoError(t, err)
+
+	err = provider.Present(envTest.GetDomain(), "", "123d==")
+	require.NoError(t, err)
+}
+
+func TestLiveCleanUp(t *testing.T) {
+	if !envTest.IsLiveTest() {
+		t.Skip("skipping live test")
+	}
+
+	envTest.RestoreEnv()
+
+	provider, err := NewDNSProvider()
+	require.NoError(t, err)
+
+	err = provider.CleanUp(envTest.GetDomain(), "", "123d==")
+	require.NoError(t, err)
+}

providers/dns/internal/curanet/provider.go

@@ -0,0 +1,138 @@
+// Package curanet implements a DNS provider for solving the DNS-01 challenge using Curanet.
+package curanet
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"net/http"
+	"net/url"
+	"time"
+
+	"github.com/go-acme/lego/v4/challenge/dns01"
+	"github.com/go-acme/lego/v4/providers/dns/internal/clientdebug"
+	"github.com/go-acme/lego/v4/providers/dns/internal/curanet/internal"
+)
+
+// Config is used to configure the creation of the DNSProvider.
+type Config struct {
+	APIKey string
+
+	PropagationTimeout time.Duration
+	PollingInterval    time.Duration
+	TTL                int
+	HTTPClient         *http.Client
+}
+
+// DNSProvider implements the challenge.Provider interface.
+type DNSProvider struct {
+	config *Config
+	client *internal.Client
+}
+
+// NewDNSProviderConfig return a DNSProvider instance configured for Curanet.
+func NewDNSProviderConfig(config *Config, baseURL string) (*DNSProvider, error) {
+	if config == nil {
+		return nil, errors.New("the configuration of the DNS provider is nil")
+	}
+
+	client, err := internal.NewClient(config.APIKey)
+	if err != nil {
+		return nil, err
+	}
+
+	if baseURL != "" {
+		client.BaseURL, err = url.Parse(baseURL)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	if config.HTTPClient != nil {
+		client.HTTPClient = config.HTTPClient
+	}
+
+	client.HTTPClient = clientdebug.Wrap(client.HTTPClient)
+
+	return &DNSProvider{
+		config: config,
+		client: client,
+	}, nil
+}
+
+// Present creates a TXT record using the specified parameters.
+func (d *DNSProvider) Present(domain, token, keyAuth string) error {
+	info := dns01.GetChallengeInfo(domain, keyAuth)
+
+	authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
+	if err != nil {
+		return fmt.Errorf("could not find zone for domain %q: %w", domain, err)
+	}
+
+	subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
+	if err != nil {
+		return err
+	}
+
+	record := internal.Record{
+		Name: subDomain,
+		Type: "TXT",
+		TTL:  d.config.TTL,
+		Data: info.Value,
+	}
+
+	err = d.client.CreateRecord(context.Background(), dns01.UnFqdn(authZone), record)
+	if err != nil {
+		return fmt.Errorf("create record: %w", err)
+	}
+
+	return nil
+}
+
+// CleanUp removes the TXT record matching the specified parameters.
+func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
+	info := dns01.GetChallengeInfo(domain, keyAuth)
+
+	authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
+	if err != nil {
+		return fmt.Errorf("could not find zone for domain %q: %w", domain, err)
+	}
+
+	subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
+	if err != nil {
+		return err
+	}
+
+	record, err := d.findRecord(context.Background(), dns01.UnFqdn(authZone), subDomain, info.Value)
+	if err != nil {
+		return err
+	}
+
+	err = d.client.DeleteRecord(context.Background(), dns01.UnFqdn(authZone), record.ID)
+	if err != nil {
+		return fmt.Errorf("delete record: %w", 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) findRecord(ctx context.Context, zone, subDomain, value string) (*internal.Record, error) {
+	records, err := d.client.GetRecords(ctx, zone, subDomain, "TXT")
+	if err != nil {
+		return nil, fmt.Errorf("get records: %w", err)
+	}
+
+	for _, record := range records {
+		if record.Name == subDomain && record.Type == "TXT" && record.Data == value {
+			return &record, nil
+		}
+	}
+
+	return nil, errors.New("record not found")
+}

providers/dns/internal/curanet/provider_test.go

@@ -0,0 +1,101 @@
+package curanet
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"net/url"
+	"testing"
+
+	"github.com/go-acme/lego/v4/platform/tester/servermock"
+	"github.com/stretchr/testify/require"
+)
+
+func TestNewDNSProviderConfig(t *testing.T) {
+	testCases := []struct {
+		desc     string
+		apiKey   string
+		expected string
+	}{
+		{
+			desc:   "success",
+			apiKey: "secret",
+		},
+		{
+			desc:     "missing credentials",
+			expected: "credentials missing",
+		},
+	}
+
+	for _, test := range testCases {
+		t.Run(test.desc, func(t *testing.T) {
+			config := &Config{}
+			config.APIKey = test.apiKey
+
+			p, err := NewDNSProviderConfig(config, "")
+
+			if test.expected == "" {
+				require.NoError(t, err)
+				require.NotNil(t, p)
+				require.NotNil(t, p.config)
+				require.NotNil(t, p.client)
+			} else {
+				require.EqualError(t, err, test.expected)
+			}
+		})
+	}
+}
+
+func mockBuilder() *servermock.Builder[*DNSProvider] {
+	return servermock.NewBuilder(
+		func(server *httptest.Server) (*DNSProvider, error) {
+			config := &Config{
+				APIKey:     "secret",
+				TTL:        120,
+				HTTPClient: server.Client(),
+			}
+
+			p, err := NewDNSProviderConfig(config, "")
+			if err != nil {
+				return nil, err
+			}
+
+			p.client.BaseURL, _ = url.Parse(server.URL)
+
+			return p, nil
+		},
+		servermock.CheckHeader().
+			WithJSONHeaders().
+			WithAuthorization("Bearer secret"),
+	)
+}
+
+func TestDNSProvider_Present(t *testing.T) {
+	provider := mockBuilder().
+		Route("POST /dns/v2/Domains/example.com/Records",
+			servermock.Noop().
+				WithStatusCode(http.StatusCreated),
+			servermock.CheckRequestJSONBodyFromInternal("records_create-request.json"),
+		).
+		Build(t)
+
+	err := provider.Present("example.com", "abc", "123d==")
+	require.NoError(t, err)
+}
+
+func TestDNSProvider_CleanUp(t *testing.T) {
+	provider := mockBuilder().
+		Route("GET /dns/v2/Domains/example.com/Records",
+			servermock.ResponseFromInternal("records_get.json"),
+			servermock.CheckQueryParameter().Strict().
+				With("name", "_acme-challenge").
+				With("type", "TXT"),
+		).
+		Route("DELETE /dns/v2/Domains/example.com/Records/1234",
+			servermock.Noop().
+				WithStatusCode(http.StatusOK),
+		).
+		Build(t)
+
+	err := provider.CleanUp("example.com", "abc", "123d==")
+	require.NoError(t, err)
+}