Add DNS provider for TodayNIC/时代互联 (#2788)

providers/dns/todaynic/internal/client.go

@@ -0,0 +1,141 @@
+package internal
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"io"
+	"net/http"
+	"net/url"
+	"strconv"
+	"time"
+
+	"github.com/go-acme/lego/v4/providers/dns/internal/errutils"
+	"github.com/go-acme/lego/v4/providers/dns/internal/useragent"
+	querystring "github.com/google/go-querystring/query"
+)
+
+const defaultBaseURL = "https://todapi.now.cn:2443"
+
+// Client the TodayNIC API client.
+type Client struct {
+	authUserID string
+	apiKey     string
+
+	BaseURL    *url.URL
+	HTTPClient *http.Client
+}
+
+// NewClient creates a new Client.
+func NewClient(authUserID, apiKey string) (*Client, error) {
+	if authUserID == "" || apiKey == "" {
+		return nil, errors.New("credentials missing")
+	}
+
+	baseURL, _ := url.Parse(defaultBaseURL)
+
+	return &Client{
+		authUserID: authUserID,
+		apiKey:     apiKey,
+		BaseURL:    baseURL,
+		HTTPClient: &http.Client{Timeout: 10 * time.Second},
+	}, nil
+}
+
+func (c *Client) AddRecord(ctx context.Context, record Record) (int, error) {
+	endpoint := c.BaseURL.JoinPath("api", "dns", "add-domain-record.json")
+
+	query, err := querystring.Values(record)
+	if err != nil {
+		return 0, err
+	}
+
+	req, err := c.newRequest(ctx, endpoint, query)
+	if err != nil {
+		return 0, err
+	}
+
+	var result APIResponse
+
+	err = c.do(req, &result)
+	if err != nil {
+		return 0, err
+	}
+
+	return result.ID, nil
+}
+
+func (c *Client) DeleteRecord(ctx context.Context, recordID int) error {
+	endpoint := c.BaseURL.JoinPath("api", "dns", "delete-domain-record.json")
+
+	query := endpoint.Query()
+	query.Set("Id", strconv.Itoa(recordID))
+
+	req, err := c.newRequest(ctx, endpoint, query)
+	if err != nil {
+		return err
+	}
+
+	return c.do(req, nil)
+}
+
+func (c *Client) do(req *http.Request, result any) error {
+	useragent.SetHeader(req.Header)
+
+	resp, err := c.HTTPClient.Do(req)
+	if err != nil {
+		return errutils.NewHTTPDoError(req, err)
+	}
+
+	defer func() { _ = resp.Body.Close() }()
+
+	if resp.StatusCode/100 != 2 {
+		return parseError(req, resp)
+	}
+
+	if result == nil {
+		return nil
+	}
+
+	raw, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return errutils.NewReadResponseError(req, resp.StatusCode, err)
+	}
+
+	err = json.Unmarshal(raw, result)
+	if err != nil {
+		return errutils.NewUnmarshalError(req, resp.StatusCode, raw, err)
+	}
+
+	return nil
+}
+
+func (c *Client) newRequest(ctx context.Context, endpoint *url.URL, query url.Values) (*http.Request, error) {
+	query.Set("auth-userid", c.authUserID)
+	query.Set("api-key", c.apiKey)
+
+	endpoint.RawQuery = query.Encode()
+
+	req, err := http.NewRequestWithContext(ctx, http.MethodGet, endpoint.String(), nil)
+	if err != nil {
+		return nil, fmt.Errorf("unable to create request: %w", err)
+	}
+
+	req.Header.Set("Accept", "application/json")
+
+	return req, nil
+}
+
+func parseError(req *http.Request, resp *http.Response) error {
+	raw, _ := io.ReadAll(resp.Body)
+
+	var errAPI APIError
+
+	err := json.Unmarshal(raw, &errAPI)
+	if err != nil {
+		return errutils.NewUnexpectedStatusCodeError(req, resp.StatusCode, raw)
+	}
+
+	return &errAPI
+}

providers/dns/todaynic/internal/client_test.go

@@ -0,0 +1,94 @@
+package internal
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"net/url"
+	"testing"
+
+	"github.com/go-acme/lego/v4/platform/tester/servermock"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func mockBuilder() *servermock.Builder[*Client] {
+	return servermock.NewBuilder[*Client](
+		func(server *httptest.Server) (*Client, error) {
+			client, err := NewClient("user123", "secret")
+			if err != nil {
+				return nil, err
+			}
+
+			client.BaseURL, _ = url.Parse(server.URL)
+			client.HTTPClient = server.Client()
+
+			return client, nil
+		},
+		servermock.CheckHeader().
+			WithJSONHeaders(),
+	)
+}
+
+func TestClient_AddRecord(t *testing.T) {
+	client := mockBuilder().
+		Route("GET /api/dns/add-domain-record.json",
+			servermock.ResponseFromFixture("add_record.json"),
+			servermock.CheckQueryParameter().Strict().
+				With("Domain", "example.com").
+				With("Host", "_acme-challenge").
+				With("Type", "TXT").
+				With("Value", "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY").
+				With("Ttl", "600").
+				With("auth-userid", "user123").
+				With("api-key", "secret"),
+		).
+		Build(t)
+
+	record := Record{
+		Domain: "example.com",
+		Host:   "_acme-challenge",
+		Type:   "TXT",
+		Value:  "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY",
+		TTL:    "600",
+	}
+
+	recordID, err := client.AddRecord(t.Context(), record)
+	require.NoError(t, err)
+
+	assert.Equal(t, 11554102, recordID)
+}
+
+func TestClient_AddRecord_error(t *testing.T) {
+	client := mockBuilder().
+		Route("GET /api/dns/add-domain-record.json",
+			servermock.ResponseFromFixture("error.json").
+				WithStatusCode(http.StatusNotFound),
+		).
+		Build(t)
+
+	record := Record{
+		Domain: "example.com",
+		Host:   "_acme-challenge",
+		Type:   "TXT",
+		Value:  "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY",
+		TTL:    "600",
+	}
+
+	_, err := client.AddRecord(t.Context(), record)
+	require.EqualError(t, err, "host.repeat (2d5876b2-f272-43e9-acc1-4c6a3d3683b1)")
+}
+
+func TestClient_DeleteRecord(t *testing.T) {
+	client := mockBuilder().
+		Route("GET /api/dns/delete-domain-record.json",
+			servermock.ResponseFromFixture("add_record.json"),
+			servermock.CheckQueryParameter().Strict().
+				With("Id", "123").
+				With("auth-userid", "user123").
+				With("api-key", "secret"),
+		).
+		Build(t)
+
+	err := client.DeleteRecord(t.Context(), 123)
+	require.NoError(t, err)
+}

providers/dns/todaynic/internal/fixtures/add_record.json

@@ -0,0 +1,4 @@
+{
+  "RequestId": "f60ea4d9-67ef-49fa-bbae-06178a6e7293",
+  "Id": 11554102
+}

providers/dns/todaynic/internal/fixtures/error.json

@@ -0,0 +1,4 @@
+{
+  "RequestId": "2d5876b2-f272-43e9-acc1-4c6a3d3683b1",
+  "error": "host.repeat"
+}

providers/dns/todaynic/internal/types.go

@@ -0,0 +1,26 @@
+package internal
+
+import "fmt"
+
+type APIError struct {
+	RequestID string `json:"RequestId"`
+	Message   string `json:"error"`
+}
+
+func (a *APIError) Error() string {
+	return fmt.Sprintf("%s (%s)", a.Message, a.RequestID)
+}
+
+type Record struct {
+	Domain string `url:"Domain,omitempty"`
+	Host   string `url:"Host,omitempty"`
+	Type   string `url:"Type,omitempty"`
+	Value  string `url:"Value,omitempty"`
+	Mx     string `url:"Mx,omitempty"`
+	TTL    string `url:"Ttl,omitempty"`
+}
+
+type APIResponse struct {
+	RequestID string `json:"RequestId"`
+	ID        int    `json:"Id"`
+}

providers/dns/todaynic/todaynic.go

@@ -0,0 +1,164 @@
+// Package todaynic implements a DNS provider for solving the DNS-01 challenge using TodayNIC.
+package todaynic
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"net/http"
+	"strconv"
+	"sync"
+	"time"
+
+	"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/clientdebug"
+	"github.com/go-acme/lego/v4/providers/dns/todaynic/internal"
+)
+
+// Environment variables names.
+const (
+	envNamespace = "TODAYNIC_"
+
+	EnvAuthUserID = envNamespace + "AUTH_USER_ID"
+	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 struct {
+	AuthUserID string
+	APIKey     string
+
+	PropagationTimeout time.Duration
+	PollingInterval    time.Duration
+	TTL                int
+	HTTPClient         *http.Client
+}
+
+// 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*time.Second),
+		},
+	}
+}
+
+// DNSProvider implements the challenge.Provider interface.
+type DNSProvider struct {
+	config *Config
+	client *internal.Client
+
+	recordIDs   map[string]int
+	recordIDsMu sync.Mutex
+}
+
+// NewDNSProvider returns a DNSProvider instance configured for TodayNIC.
+func NewDNSProvider() (*DNSProvider, error) {
+	values, err := env.Get(EnvAuthUserID, EnvAPIKey)
+	if err != nil {
+		return nil, fmt.Errorf("todaynic: %w", err)
+	}
+
+	config := NewDefaultConfig()
+	config.AuthUserID = values[EnvAuthUserID]
+	config.APIKey = values[EnvAPIKey]
+
+	return NewDNSProviderConfig(config)
+}
+
+// NewDNSProviderConfig return a DNSProvider instance configured for TodayNIC.
+func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
+	if config == nil {
+		return nil, errors.New("todaynic: the configuration of the DNS provider is nil")
+	}
+
+	client, err := internal.NewClient(config.AuthUserID, config.APIKey)
+	if err != nil {
+		return nil, fmt.Errorf("todaynic: %w", err)
+	}
+
+	if config.HTTPClient != nil {
+		client.HTTPClient = config.HTTPClient
+	}
+
+	client.HTTPClient = clientdebug.Wrap(client.HTTPClient)
+
+	return &DNSProvider{
+		config:    config,
+		client:    client,
+		recordIDs: make(map[string]int),
+	}, 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("todaynic: could not find zone for domain %q: %w", domain, err)
+	}
+
+	subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
+	if err != nil {
+		return fmt.Errorf("todaynic: %w", err)
+	}
+
+	record := internal.Record{
+		Domain: dns01.UnFqdn(authZone),
+		Host:   subDomain,
+		Type:   "TXT",
+		Value:  info.Value,
+		TTL:    strconv.Itoa(d.config.TTL),
+	}
+
+	recordID, err := d.client.AddRecord(context.Background(), record)
+	if err != nil {
+		return fmt.Errorf("todaynic: add record: %w", err)
+	}
+
+	d.recordIDsMu.Lock()
+	d.recordIDs[token] = recordID
+	d.recordIDsMu.Unlock()
+
+	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)
+
+	d.recordIDsMu.Lock()
+	recordID, ok := d.recordIDs[token]
+	d.recordIDsMu.Unlock()
+
+	if !ok {
+		return fmt.Errorf("todaynic: unknown record ID for '%s' '%s'", info.EffectiveFQDN, token)
+	}
+
+	err := d.client.DeleteRecord(context.Background(), recordID)
+	if err != nil {
+		return fmt.Errorf("todaynic: delete record: %w", err)
+	}
+
+	d.recordIDsMu.Lock()
+	delete(d.recordIDs, token)
+	d.recordIDsMu.Unlock()
+
+	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
+}

providers/dns/todaynic/todaynic.toml

@@ -0,0 +1,25 @@
+Name = "TodayNIC/时代互联"
+Description = ''''''
+URL = "https://www.todaynic.com/"
+Code = "todaynic"
+Since = "v4.32.0"
+
+Example = '''
+TODAYNIC_AUTH_USER_ID="xxx" \
+TODAYNIC_API_KEY="yyy" \
+lego --dns todaynic -d '*.example.com' -d example.com run
+'''
+
+[Configuration]
+  [Configuration.Credentials]
+    TODAYNIC_AUTH_USER_ID = "account ID"
+    TODAYNIC_API_KEY = "API key"
+  [Configuration.Additional]
+    TODAYNIC_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"
+    TODAYNIC_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 60)"
+    TODAYNIC_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 600)"
+    TODAYNIC_HTTP_TIMEOUT = "API request timeout in seconds (Default: 30)"
+
+[Links]
+  API = "https://www.todaynic.com/partner/mode_Http_Api_detail.php"
+  apipost =  "https://docs.apipost.net/docs/detail/49dcef10a876000?target_id=0"

providers/dns/todaynic/todaynic_test.go

@@ -0,0 +1,207 @@
+package todaynic
+
+import (
+	"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"
+)
+
+const envDomain = envNamespace + "DOMAIN"
+
+var envTest = tester.NewEnvTest(EnvAuthUserID, EnvAPIKey).WithDomain(envDomain)
+
+func TestNewDNSProvider(t *testing.T) {
+	testCases := []struct {
+		desc     string
+		envVars  map[string]string
+		expected string
+	}{
+		{
+			desc: "success",
+			envVars: map[string]string{
+				EnvAuthUserID: "user123",
+				EnvAPIKey:     "secret",
+			},
+		},
+		{
+			desc: "missing user ID",
+			envVars: map[string]string{
+				EnvAuthUserID: "",
+				EnvAPIKey:     "secret",
+			},
+			expected: "todaynic: some credentials information are missing: TODAYNIC_AUTH_USER_ID",
+		},
+		{
+			desc: "missing API key",
+			envVars: map[string]string{
+				EnvAuthUserID: "user123",
+				EnvAPIKey:     "",
+			},
+			expected: "todaynic: some credentials information are missing: TODAYNIC_API_KEY",
+		},
+		{
+			desc:     "missing credentials",
+			envVars:  map[string]string{},
+			expected: "todaynic: some credentials information are missing: TODAYNIC_AUTH_USER_ID,TODAYNIC_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.config)
+				require.NotNil(t, p.client)
+			} else {
+				require.EqualError(t, err, test.expected)
+			}
+		})
+	}
+}
+
+func TestNewDNSProviderConfig(t *testing.T) {
+	testCases := []struct {
+		desc       string
+		authUserID string
+		apiKey     string
+		expected   string
+	}{
+		{
+			desc:       "success",
+			authUserID: "user123",
+			apiKey:     "secret",
+		},
+		{
+			desc:     "missing user ID",
+			apiKey:   "secret",
+			expected: "todaynic: credentials missing",
+		},
+		{
+			desc:       "missing API key",
+			authUserID: "user123",
+			expected:   "todaynic: credentials missing",
+		},
+		{
+			desc:     "missing credentials",
+			expected: "todaynic: credentials missing",
+		},
+	}
+
+	for _, test := range testCases {
+		t.Run(test.desc, func(t *testing.T) {
+			config := NewDefaultConfig()
+			config.AuthUserID = test.authUserID
+			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 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)
+}
+
+func mockBuilder() *servermock.Builder[*DNSProvider] {
+	return servermock.NewBuilder(
+		func(server *httptest.Server) (*DNSProvider, error) {
+			config := NewDefaultConfig()
+			config.AuthUserID = "user123"
+			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(),
+	)
+}
+
+func TestDNSProvider_Present(t *testing.T) {
+	provider := mockBuilder().
+		Route("GET /api/dns/add-domain-record.json",
+			servermock.ResponseFromInternal("add_record.json"),
+			servermock.CheckQueryParameter().Strict().
+				With("Domain", "example.com").
+				With("Host", "_acme-challenge").
+				With("Type", "TXT").
+				With("Value", "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY").
+				With("Ttl", "600").
+				With("auth-userid", "user123").
+				With("api-key", "secret"),
+		).
+		Build(t)
+
+	err := provider.Present("example.com", "abc", "123d==")
+	require.NoError(t, err)
+}
+
+func TestDNSProvider_CleanUp(t *testing.T) {
+	provider := mockBuilder().
+		Route("GET /api/dns/delete-domain-record.json",
+			servermock.ResponseFromInternal("add_record.json"),
+			servermock.CheckQueryParameter().Strict().
+				With("Id", "123").
+				With("auth-userid", "user123").
+				With("api-key", "secret"),
+		).
+		Build(t)
+
+	provider.recordIDs["abc"] = 123
+
+	err := provider.CleanUp("example.com", "abc", "123d==")
+	require.NoError(t, err)
+}

providers/dns/zz_gen_dns_providers.go

@@ -163,6 +163,7 @@ import (
 	"github.com/go-acme/lego/v4/providers/dns/technitium"
 	"github.com/go-acme/lego/v4/providers/dns/tencentcloud"
 	"github.com/go-acme/lego/v4/providers/dns/timewebcloud"
+	"github.com/go-acme/lego/v4/providers/dns/todaynic"
 	"github.com/go-acme/lego/v4/providers/dns/transip"
 	"github.com/go-acme/lego/v4/providers/dns/ultradns"
 	"github.com/go-acme/lego/v4/providers/dns/uniteddomains"
@@ -506,6 +507,8 @@ func NewDNSChallengeProviderByName(name string) (challenge.Provider, error) {
 		return tencentcloud.NewDNSProvider()
 	case "timewebcloud":
 		return timewebcloud.NewDNSProvider()
+	case "todaynic":
+		return todaynic.NewDNSProvider()
 	case "transip":
 		return transip.NewDNSProvider()
 	case "ultradns":