Add DNS provider for ZoneEdit (#2578)

Author: ldez

README.md

@@ -248,10 +248,10 @@ Detailed documentation is available [here](https://go-acme.github.io/lego/dns).
   <td><a href="https://go-acme.github.io/lego/dns/yandex/">Yandex PDD</a></td>
   <td><a href="https://go-acme.github.io/lego/dns/zoneee/">Zone.ee</a></td>
 </tr><tr>
+  <td><a href="https://go-acme.github.io/lego/dns/zoneedit/">ZoneEdit</a></td>
   <td><a href="https://go-acme.github.io/lego/dns/zonomi/">Zonomi</a></td>
   <td></td>
   <td></td>
-  <td></td>
 </tr></table>
 
 <!-- END DNS PROVIDERS LIST -->

cmd/zz_gen_cmd_dnshelp.go

@@ -94,7 +94,7 @@ USAGE:
 
 OPTIONS:
    --days value                              The number of days left on a certificate to renew it. (default: 30)
-   --dynamic                                 Dynamically defines the renewal date. (1/3rd of the lifetime left or 1/2 of the lifetime left, if the lifetime is shorter than 10 days) (default: false)
+   --dynamic                                 Compute dynamically, based on the lifetime of the certificate(s), when to renew: use 1/3rd of the lifetime left, or 1/2 of the lifetime for short-lived certificates). This supersedes --days and will be the default behavior in Lego v5. (default: false)
    --ari-disable                             Do not use the renewalInfo endpoint (RFC9773) to check if a certificate should be renewed. (default: false)
    --ari-wait-to-renew-duration value        The maximum duration you're willing to sleep for a renewal time returned by the renewalInfo endpoint. (default: 0s)
    --reuse-key                               Used to indicate you want to reuse your current private key for the new certificate. (default: false)
@@ -152,7 +152,7 @@ To display the documentation for a specific DNS provider, run:
   $ lego dnshelp -c code
 
 Supported DNS providers:
-  acme-dns, active24, alidns, allinkl, arvancloud, auroradns, autodns, axelname, azion, azure, azuredns, baiducloud, bindman, bluecat, bookmyname, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, conoha, conohav3, constellix, corenetworks, cpanel, derak, desec, designate, digitalocean, directadmin, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dyndnsfree, dynu, easydns, edgedns, efficientip, epik, exec, exoscale, f5xc, freemyip, gandi, gandiv5, gcloud, gcore, glesys, godaddy, googledomains, hetzner, hostingde, hosttech, httpnet, httpreq, huaweicloud, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ipv64, iwantmyname, joker, liara, lightsail, limacity, linode, liquidweb, loopia, luadns, mailinabox, manageengine, manual, metaname, metaregistrar, mijnhost, mittwald, myaddr, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, nearlyfreespeech, netcup, netlify, nicmanager, nicru, nifcloud, njalla, nodion, ns1, oraclecloud, otc, ovh, pdns, plesk, porkbun, rackspace, rainyun, rcodezero, regfish, regru, rfc2136, rimuhosting, route53, safedns, sakuracloud, scaleway, selectel, selectelv2, selfhostde, servercow, shellrent, simply, sonic, spaceship, stackpath, technitium, tencentcloud, timewebcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, volcengine, vscale, vultr, webnames, websupport, wedos, westcn, yandex, yandex360, yandexcloud, zoneee, zonomi
+  acme-dns, active24, alidns, allinkl, arvancloud, auroradns, autodns, axelname, azion, azure, azuredns, baiducloud, bindman, bluecat, bookmyname, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, conoha, conohav3, constellix, corenetworks, cpanel, derak, desec, designate, digitalocean, directadmin, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dyndnsfree, dynu, easydns, edgedns, efficientip, epik, exec, exoscale, f5xc, freemyip, gandi, gandiv5, gcloud, gcore, glesys, godaddy, googledomains, hetzner, hostingde, hosttech, httpnet, httpreq, huaweicloud, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ipv64, iwantmyname, joker, liara, lightsail, limacity, linode, liquidweb, loopia, luadns, mailinabox, manageengine, manual, metaname, metaregistrar, mijnhost, mittwald, myaddr, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, nearlyfreespeech, netcup, netlify, nicmanager, nicru, nifcloud, njalla, nodion, ns1, oraclecloud, otc, ovh, pdns, plesk, porkbun, rackspace, rainyun, rcodezero, regfish, regru, rfc2136, rimuhosting, route53, safedns, sakuracloud, scaleway, selectel, selectelv2, selfhostde, servercow, shellrent, simply, sonic, spaceship, stackpath, technitium, tencentcloud, timewebcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, volcengine, vscale, vultr, webnames, websupport, wedos, westcn, yandex, yandex360, yandexcloud, zoneedit, zoneee, zonomi
 
 More information: https://go-acme.github.io/lego/dns
 """

docs/content/dns/zz_gen_zoneedit.md

@@ -0,0 +1,107 @@
+package internal
+
+import (
+	"bytes"
+	"encoding/xml"
+	"errors"
+	"fmt"
+	"io"
+	"net/http"
+	"net/url"
+	"slices"
+	"time"
+
+	"github.com/go-acme/lego/v4/providers/dns/internal/errutils"
+)
+
+const defaultBaseURL = "https://dynamic.zoneedit.com"
+
+// Client the ZoneEdit API client.
+type Client struct {
+	user      string
+	authToken string
+
+	baseURL    *url.URL
+	HTTPClient *http.Client
+}
+
+// NewClient creates a new Client.
+func NewClient(user, authToken string) (*Client, error) {
+	if user == "" || authToken == "" {
+		return nil, errors.New("credentials missing")
+	}
+
+	baseURL, _ := url.Parse(defaultBaseURL)
+
+	return &Client{
+		user:       user,
+		authToken:  authToken,
+		baseURL:    baseURL,
+		HTTPClient: &http.Client{Timeout: 10 * time.Second},
+	}, nil
+}
+
+func (c *Client) CreateTXTRecord(domain, rdata string) error {
+	return c.perform("txt-create.php", domain, rdata)
+}
+
+func (c *Client) DeleteTXTRecord(domain, rdata string) error {
+	return c.perform("txt-delete.php", domain, rdata)
+}
+
+func (c *Client) perform(actionPath, domain, rdata string) error {
+	endpoint := c.baseURL.JoinPath(actionPath)
+
+	query := endpoint.Query()
+	query.Set("host", domain)
+	query.Set("rdata", rdata)
+	endpoint.RawQuery = query.Encode()
+
+	req, err := http.NewRequest(http.MethodGet, endpoint.String(), http.NoBody)
+	if err != nil {
+		return err
+	}
+
+	return c.do(req)
+}
+
+func (c *Client) do(req *http.Request) error {
+	req.SetBasicAuth(c.user, c.authToken)
+
+	resp, err := c.HTTPClient.Do(req)
+	if err != nil {
+		return errutils.NewHTTPDoError(req, err)
+	}
+
+	defer func() { _ = resp.Body.Close() }()
+
+	if resp.StatusCode/100 != 2 {
+		raw, _ := io.ReadAll(resp.Body)
+
+		return errutils.NewUnexpectedStatusCodeError(req, resp.StatusCode, raw)
+	}
+
+	raw, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return errutils.NewReadResponseError(req, resp.StatusCode, err)
+	}
+
+	if bytes.Contains(raw, []byte("SUCCESS CODE")) {
+		return nil
+	}
+
+	raw = bytes.TrimSpace(raw)
+
+	// The answer is not an XML valid (missing closing), so I fix it to parse it.
+	if bytes.HasSuffix(raw, []byte(">")) {
+		raw = slices.Concat(raw[:len(raw)-1], []byte("/>"))
+	}
+
+	var apiErr APIError
+	err = xml.Unmarshal(raw, &apiErr)
+	if err != nil {
+		return errutils.NewUnexpectedStatusCodeError(req, resp.StatusCode, raw)
+	}
+
+	return fmt.Errorf("[status code: %d] %w", resp.StatusCode, apiErr)
+}

docs/data/zz_cli_help.toml

@@ -0,0 +1,64 @@
+package internal
+
+import (
+	"net/http/httptest"
+	"net/url"
+	"testing"
+
+	"github.com/go-acme/lego/v4/platform/tester/servermock"
+	"github.com/stretchr/testify/require"
+)
+
+func mockBuilder() *servermock.Builder[*Client] {
+	return servermock.NewBuilder(func(server *httptest.Server) (*Client, error) {
+		client, err := NewClient("user", "secret")
+		if err != nil {
+			return nil, err
+		}
+
+		client.baseURL, _ = url.Parse(server.URL)
+		client.HTTPClient = server.Client()
+
+		return client, nil
+	})
+}
+
+func TestClient_CreateTXTRecord(t *testing.T) {
+	client := mockBuilder().
+		Route("GET /txt-create.php",
+			servermock.ResponseFromFixture("success.xml")).
+		Build(t)
+
+	err := client.CreateTXTRecord("_acme-challenge.example.com", "value")
+	require.NoError(t, err)
+}
+
+func TestClient_CreateTXTRecord_error(t *testing.T) {
+	client := mockBuilder().
+		Route("GET /txt-create.php",
+			servermock.ResponseFromFixture("error.xml")).
+		Build(t)
+
+	err := client.CreateTXTRecord("_acme-challenge.example.com", "value")
+	require.EqualError(t, err, "[status code: 200] 708: Failed Login: user (_acme-challenge.example.com)")
+}
+
+func TestClient_DeleteTXTRecord(t *testing.T) {
+	client := mockBuilder().
+		Route("GET /txt-delete.php",
+			servermock.ResponseFromFixture("success.xml")).
+		Build(t)
+
+	err := client.DeleteTXTRecord("_acme-challenge.example.com", "value")
+	require.NoError(t, err)
+}
+
+func TestClient_DeleteTXTRecord_error(t *testing.T) {
+	client := mockBuilder().
+		Route("GET /txt-delete.php",
+			servermock.ResponseFromFixture("error.xml")).
+		Build(t)
+
+	err := client.DeleteTXTRecord("_acme-challenge.example.com", "value")
+	require.EqualError(t, err, "[status code: 200] 708: Failed Login: user (_acme-challenge.example.com)")
+}

providers/dns/zoneedit/internal/client.go

@@ -0,0 +1 @@
+<ERROR CODE="708" TEXT="Failed Login: user" ZONE="_acme-challenge.example.com">

providers/dns/zoneedit/internal/client_test.go

@@ -0,0 +1 @@
+<SUCCESS CODE="200" TEXT="_acme-challenge.example.ca TXT with rdata yaZy0O9QYEKtqBWeJqq7vJYjFuUoB0c0dzjo7UaJcMs deleted" ZONE="example.com">

providers/dns/zoneedit/internal/fixtures/error.xml

@@ -0,0 +1,18 @@
+package internal
+
+import (
+	"encoding/xml"
+	"fmt"
+)
+
+type APIError struct {
+	XMLName xml.Name `xml:"ERROR"`
+	Text    string   `xml:",chardata"`
+	Code    string   `xml:"CODE,attr"`
+	Message string   `xml:"TEXT,attr"`
+	Zone    string   `xml:"ZONE,attr"`
+}
+
+func (a APIError) Error() string {
+	return fmt.Sprintf("%s: %s (%s)", a.Code, a.Message, a.Zone)
+}