Add DNS provider for Leaseweb (#2856)

This commit is contained in:
Ludovic Fernandez 2026-02-19 12:52:04 +01:00 committed by GitHub
commit dd1ea80c08
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
21 changed files with 1036 additions and 23 deletions

View file

@ -188,113 +188,113 @@ If your DNS provider is not supported, please open an [issue](https://github.com
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/acme-dns/">Joohoi&#39;s ACME-DNS</a></td>
<td><a href="https://go-acme.github.io/lego/dns/keyhelp/">KeyHelp</a></td>
<td><a href="https://go-acme.github.io/lego/dns/leaseweb/">Leaseweb</a></td>
<td><a href="https://go-acme.github.io/lego/dns/liara/">Liara</a></td>
<td><a href="https://go-acme.github.io/lego/dns/limacity/">Lima-City</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/limacity/">Lima-City</a></td>
<td><a href="https://go-acme.github.io/lego/dns/linode/">Linode (v4)</a></td>
<td><a href="https://go-acme.github.io/lego/dns/liquidweb/">Liquid Web</a></td>
<td><a href="https://go-acme.github.io/lego/dns/loopia/">Loopia</a></td>
<td><a href="https://go-acme.github.io/lego/dns/luadns/">LuaDNS</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/luadns/">LuaDNS</a></td>
<td><a href="https://go-acme.github.io/lego/dns/mailinabox/">Mail-in-a-Box</a></td>
<td><a href="https://go-acme.github.io/lego/dns/manageengine/">ManageEngine CloudDNS</a></td>
<td><a href="https://go-acme.github.io/lego/dns/manual/">Manual</a></td>
<td><a href="https://go-acme.github.io/lego/dns/metaname/">Metaname</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/metaname/">Metaname</a></td>
<td><a href="https://go-acme.github.io/lego/dns/metaregistrar/">Metaregistrar</a></td>
<td><a href="https://go-acme.github.io/lego/dns/mijnhost/">mijn.host</a></td>
<td><a href="https://go-acme.github.io/lego/dns/mittwald/">Mittwald</a></td>
<td><a href="https://go-acme.github.io/lego/dns/myaddr/">myaddr.{tools,dev,io}</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/myaddr/">myaddr.{tools,dev,io}</a></td>
<td><a href="https://go-acme.github.io/lego/dns/mydnsjp/">MyDNS.jp</a></td>
<td><a href="https://go-acme.github.io/lego/dns/mythicbeasts/">MythicBeasts</a></td>
<td><a href="https://go-acme.github.io/lego/dns/namedotcom/">Name.com</a></td>
<td><a href="https://go-acme.github.io/lego/dns/namecheap/">Namecheap</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/namecheap/">Namecheap</a></td>
<td><a href="https://go-acme.github.io/lego/dns/namesilo/">Namesilo</a></td>
<td><a href="https://go-acme.github.io/lego/dns/nearlyfreespeech/">NearlyFreeSpeech.NET</a></td>
<td><a href="https://go-acme.github.io/lego/dns/neodigit/">Neodigit</a></td>
<td><a href="https://go-acme.github.io/lego/dns/netcup/">Netcup</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/netcup/">Netcup</a></td>
<td><a href="https://go-acme.github.io/lego/dns/netlify/">Netlify</a></td>
<td><a href="https://go-acme.github.io/lego/dns/nicmanager/">Nicmanager</a></td>
<td><a href="https://go-acme.github.io/lego/dns/nifcloud/">NIFCloud</a></td>
<td><a href="https://go-acme.github.io/lego/dns/njalla/">Njalla</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/njalla/">Njalla</a></td>
<td><a href="https://go-acme.github.io/lego/dns/nodion/">Nodion</a></td>
<td><a href="https://go-acme.github.io/lego/dns/ns1/">NS1</a></td>
<td><a href="https://go-acme.github.io/lego/dns/octenium/">Octenium</a></td>
<td><a href="https://go-acme.github.io/lego/dns/otc/">Open Telekom Cloud</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/otc/">Open Telekom Cloud</a></td>
<td><a href="https://go-acme.github.io/lego/dns/oraclecloud/">Oracle Cloud</a></td>
<td><a href="https://go-acme.github.io/lego/dns/ovh/">OVH</a></td>
<td><a href="https://go-acme.github.io/lego/dns/plesk/">plesk.com</a></td>
<td><a href="https://go-acme.github.io/lego/dns/porkbun/">Porkbun</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/porkbun/">Porkbun</a></td>
<td><a href="https://go-acme.github.io/lego/dns/pdns/">PowerDNS</a></td>
<td><a href="https://go-acme.github.io/lego/dns/rackspace/">Rackspace</a></td>
<td><a href="https://go-acme.github.io/lego/dns/rainyun/">Rain Yun/雨云</a></td>
<td><a href="https://go-acme.github.io/lego/dns/rcodezero/">RcodeZero</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/rcodezero/">RcodeZero</a></td>
<td><a href="https://go-acme.github.io/lego/dns/regru/">reg.ru</a></td>
<td><a href="https://go-acme.github.io/lego/dns/regfish/">Regfish</a></td>
<td><a href="https://go-acme.github.io/lego/dns/rfc2136/">RFC2136</a></td>
<td><a href="https://go-acme.github.io/lego/dns/rimuhosting/">RimuHosting</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/rimuhosting/">RimuHosting</a></td>
<td><a href="https://go-acme.github.io/lego/dns/nicru/">RU CENTER</a></td>
<td><a href="https://go-acme.github.io/lego/dns/sakuracloud/">Sakura Cloud</a></td>
<td><a href="https://go-acme.github.io/lego/dns/scaleway/">Scaleway</a></td>
<td><a href="https://go-acme.github.io/lego/dns/selectel/">Selectel</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/selectel/">Selectel</a></td>
<td><a href="https://go-acme.github.io/lego/dns/selectelv2/">Selectel v2</a></td>
<td><a href="https://go-acme.github.io/lego/dns/selfhostde/">SelfHost.(de|eu)</a></td>
<td><a href="https://go-acme.github.io/lego/dns/servercow/">Servercow</a></td>
<td><a href="https://go-acme.github.io/lego/dns/shellrent/">Shellrent</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/shellrent/">Shellrent</a></td>
<td><a href="https://go-acme.github.io/lego/dns/simply/">Simply.com</a></td>
<td><a href="https://go-acme.github.io/lego/dns/sonic/">Sonic</a></td>
<td><a href="https://go-acme.github.io/lego/dns/spaceship/">Spaceship</a></td>
<td><a href="https://go-acme.github.io/lego/dns/stackpath/">Stackpath</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/stackpath/">Stackpath</a></td>
<td><a href="https://go-acme.github.io/lego/dns/syse/">Syse</a></td>
<td><a href="https://go-acme.github.io/lego/dns/technitium/">Technitium</a></td>
<td><a href="https://go-acme.github.io/lego/dns/tencentcloud/">Tencent Cloud DNS</a></td>
<td><a href="https://go-acme.github.io/lego/dns/edgeone/">Tencent EdgeOne</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/edgeone/">Tencent EdgeOne</a></td>
<td><a href="https://go-acme.github.io/lego/dns/timewebcloud/">Timeweb Cloud</a></td>
<td><a href="https://go-acme.github.io/lego/dns/todaynic/">TodayNIC/时代互联</a></td>
<td><a href="https://go-acme.github.io/lego/dns/transip/">TransIP</a></td>
<td><a href="https://go-acme.github.io/lego/dns/safedns/">UKFast SafeDNS</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/safedns/">UKFast SafeDNS</a></td>
<td><a href="https://go-acme.github.io/lego/dns/ultradns/">Ultradns</a></td>
<td><a href="https://go-acme.github.io/lego/dns/uniteddomains/">United-Domains</a></td>
<td><a href="https://go-acme.github.io/lego/dns/variomedia/">Variomedia</a></td>
<td><a href="https://go-acme.github.io/lego/dns/vegadns/">VegaDNS</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/vegadns/">VegaDNS</a></td>
<td><a href="https://go-acme.github.io/lego/dns/vercel/">Vercel</a></td>
<td><a href="https://go-acme.github.io/lego/dns/versio/">Versio.[nl|eu|uk]</a></td>
<td><a href="https://go-acme.github.io/lego/dns/vinyldns/">VinylDNS</a></td>
<td><a href="https://go-acme.github.io/lego/dns/virtualname/">Virtualname</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/virtualname/">Virtualname</a></td>
<td><a href="https://go-acme.github.io/lego/dns/vkcloud/">VK Cloud</a></td>
<td><a href="https://go-acme.github.io/lego/dns/volcengine/">Volcano Engine/火山引擎</a></td>
<td><a href="https://go-acme.github.io/lego/dns/vscale/">Vscale</a></td>
<td><a href="https://go-acme.github.io/lego/dns/vultr/">Vultr</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/vultr/">Vultr</a></td>
<td><a href="https://go-acme.github.io/lego/dns/webnamesca/">webnames.ca</a></td>
<td><a href="https://go-acme.github.io/lego/dns/webnames/">webnames.ru</a></td>
<td><a href="https://go-acme.github.io/lego/dns/websupport/">Websupport</a></td>
<td><a href="https://go-acme.github.io/lego/dns/wedos/">WEDOS</a></td>
</tr><tr>
<td><a href="https://go-acme.github.io/lego/dns/wedos/">WEDOS</a></td>
<td><a href="https://go-acme.github.io/lego/dns/westcn/">West.cn/西部数码</a></td>
<td><a href="https://go-acme.github.io/lego/dns/yandex360/">Yandex 360</a></td>
<td><a href="https://go-acme.github.io/lego/dns/yandexcloud/">Yandex Cloud</a></td>
<td><a href="https://go-acme.github.io/lego/dns/yandex/">Yandex PDD</a></td>
</tr><tr>
<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>
<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>
</tr></table>
<!-- END DNS PROVIDERS LIST -->

View file

@ -112,6 +112,7 @@ func allDNSCodes() string {
"jdcloud",
"joker",
"keyhelp",
"leaseweb",
"liara",
"lightsail",
"limacity",
@ -2358,6 +2359,26 @@ func displayDNSHelp(w io.Writer, name string) error {
ew.writeln()
ew.writeln(`More information: https://go-acme.github.io/lego/dns/keyhelp`)
case "leaseweb":
// generated from: providers/dns/leaseweb/leaseweb.toml
ew.writeln(`Configuration for Leaseweb.`)
ew.writeln(`Code: 'leaseweb'`)
ew.writeln(`Since: 'v4.32.0'`)
ew.writeln()
ew.writeln(`Credentials:`)
ew.writeln(` - "LEASEWEB_API_KEY": API key`)
ew.writeln()
ew.writeln(`Additional Configuration:`)
ew.writeln(` - "LEASEWEB_HTTP_TIMEOUT": API request timeout in seconds (Default: 30)`)
ew.writeln(` - "LEASEWEB_POLLING_INTERVAL": Time between DNS propagation check in seconds (Default: 2)`)
ew.writeln(` - "LEASEWEB_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation in seconds (Default: 60)`)
ew.writeln(` - "LEASEWEB_TTL": The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)`)
ew.writeln()
ew.writeln(`More information: https://go-acme.github.io/lego/dns/leaseweb`)
case "liara":
// generated from: providers/dns/liara/liara.toml
ew.writeln(`Configuration for Liara.`)

67
docs/content/dns/zz_gen_leaseweb.md generated Normal file
View file

@ -0,0 +1,67 @@
---
title: "Leaseweb"
date: 2019-03-03T16:39:46+01:00
draft: false
slug: leaseweb
dnsprovider:
since: "v4.32.0"
code: "leaseweb"
url: "https://www.leaseweb.com/en/"
---
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/leaseweb/leaseweb.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
Configuration for [Leaseweb](https://www.leaseweb.com/en/).
<!--more-->
- Code: `leaseweb`
- Since: v4.32.0
Here is an example bash command using the Leaseweb provider:
```bash
LEASEWEB_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \
lego --dns leaseweb -d '*.example.com' -d example.com run
```
## Credentials
| Environment Variable Name | Description |
|-----------------------|-------------|
| `LEASEWEB_API_KEY` | API key |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here]({{% ref "dns#configuration-and-credentials" %}}).
## Additional Configuration
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `LEASEWEB_HTTP_TIMEOUT` | API request timeout in seconds (Default: 30) |
| `LEASEWEB_POLLING_INTERVAL` | Time between DNS propagation check in seconds (Default: 2) |
| `LEASEWEB_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation in seconds (Default: 60) |
| `LEASEWEB_TTL` | The TTL of the TXT record used for the DNS challenge in seconds (Default: 120) |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here]({{% ref "dns#configuration-and-credentials" %}}).
## More information
- [API documentation](https://developer.leaseweb.com/docs/#tag/DNS)
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
<!-- providers/dns/leaseweb/leaseweb.toml -->
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

View file

@ -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, aliesa, allinkl, alwaysdata, anexia, artfiles, arvancloud, auroradns, autodns, axelname, azion, azure, azuredns, baiducloud, beget, binarylane, bindman, bluecat, bluecatv2, bookmyname, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, com35, conoha, conohav3, constellix, corenetworks, cpanel, ddnss, derak, desec, designate, digitalocean, directadmin, dnsexit, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dyndnsfree, dynu, easydns, edgecenter, edgedns, edgeone, efficientip, epik, exec, exoscale, f5xc, freemyip, gandi, gandiv5, gcloud, gcore, gigahostno, glesys, godaddy, googledomains, gravity, hetzner, hostingde, hostinger, hostingnl, hosttech, httpnet, httpreq, huaweicloud, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ionoscloud, ipv64, ispconfig, ispconfigddns, iwantmyname, jdcloud, joker, keyhelp, liara, lightsail, limacity, linode, liquidweb, loopia, luadns, mailinabox, manageengine, manual, metaname, metaregistrar, mijnhost, mittwald, myaddr, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, namesurfer, nearlyfreespeech, neodigit, netcup, netlify, nicmanager, nicru, nifcloud, njalla, nodion, ns1, octenium, 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, syse, technitium, tencentcloud, timewebcloud, todaynic, transip, ultradns, uniteddomains, variomedia, vegadns, vercel, versio, vinyldns, virtualname, vkcloud, volcengine, vscale, vultr, webnames, webnamesca, websupport, wedos, westcn, yandex, yandex360, yandexcloud, zoneedit, zoneee, zonomi
acme-dns, active24, alidns, aliesa, allinkl, alwaysdata, anexia, artfiles, arvancloud, auroradns, autodns, axelname, azion, azure, azuredns, baiducloud, beget, binarylane, bindman, bluecat, bluecatv2, bookmyname, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, com35, conoha, conohav3, constellix, corenetworks, cpanel, ddnss, derak, desec, designate, digitalocean, directadmin, dnsexit, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dyndnsfree, dynu, easydns, edgecenter, edgedns, edgeone, efficientip, epik, exec, exoscale, f5xc, freemyip, gandi, gandiv5, gcloud, gcore, gigahostno, glesys, godaddy, googledomains, gravity, hetzner, hostingde, hostinger, hostingnl, hosttech, httpnet, httpreq, huaweicloud, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ionoscloud, ipv64, ispconfig, ispconfigddns, iwantmyname, jdcloud, joker, keyhelp, leaseweb, liara, lightsail, limacity, linode, liquidweb, loopia, luadns, mailinabox, manageengine, manual, metaname, metaregistrar, mijnhost, mittwald, myaddr, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, namesurfer, nearlyfreespeech, neodigit, netcup, netlify, nicmanager, nicru, nifcloud, njalla, nodion, ns1, octenium, 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, syse, technitium, tencentcloud, timewebcloud, todaynic, transip, ultradns, uniteddomains, variomedia, vegadns, vercel, versio, vinyldns, virtualname, vkcloud, volcengine, vscale, vultr, webnames, webnamesca, websupport, wedos, westcn, yandex, yandex360, yandexcloud, zoneedit, zoneee, zonomi
More information: https://go-acme.github.io/lego/dns
"""

View file

@ -0,0 +1,216 @@
package internal
import (
"bytes"
"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"
)
const defaultBaseURL = "https://api.leaseweb.com/hosting/v2"
const AuthHeader = "X-LSW-Auth"
// Client the Leaseweb API client.
type Client struct {
apiKey string
BaseURL *url.URL
HTTPClient *http.Client
}
// NewClient creates a new Client.
func NewClient(apiKey string) (*Client, error) {
if apiKey == "" {
return nil, errors.New("credentials missing")
}
baseURL, _ := url.Parse(defaultBaseURL)
return &Client{
apiKey: apiKey,
BaseURL: baseURL,
HTTPClient: &http.Client{Timeout: 10 * time.Second},
}, nil
}
// CreateRRSet creates a resource record set.
// https://developer.leaseweb.com/docs/#tag/DNS/operation/createResourceRecordSet
func (c *Client) CreateRRSet(ctx context.Context, domainName string, rrset RRSet) (*RRSet, error) {
endpoint := c.BaseURL.JoinPath("domains", domainName, "resourceRecordSets")
req, err := newJSONRequest(ctx, http.MethodPost, endpoint, rrset)
if err != nil {
return nil, err
}
result := &RRSet{}
err = c.do(req, result)
if err != nil {
return nil, err
}
return result, nil
}
// GetRRSet gets a resource record set.
// https://developer.leaseweb.com/docs/#tag/DNS/operation/getResourceRecordSet
func (c *Client) GetRRSet(ctx context.Context, domainName, name, rType string) (*RRSet, error) {
endpoint := c.BaseURL.JoinPath("domains", domainName, "resourceRecordSets", name, rType)
req, err := newJSONRequest(ctx, http.MethodGet, endpoint, nil)
if err != nil {
return nil, err
}
result := &RRSet{}
err = c.do(req, result)
if err != nil {
return nil, err
}
return result, nil
}
// UpdateRRSet updates a resource record set.
// https://developer.leaseweb.com/docs/#tag/DNS/operation/updateResourceRecordSet
func (c *Client) UpdateRRSet(ctx context.Context, domainName string, rrset RRSet) (*RRSet, error) {
endpoint := c.BaseURL.JoinPath("domains", domainName, "resourceRecordSets", rrset.Name, rrset.Type)
// Reset values that are not allowed to be updated.
rrset.Name = ""
rrset.Type = ""
rrset.Editable = false
req, err := newJSONRequest(ctx, http.MethodPut, endpoint, rrset)
if err != nil {
return nil, err
}
result := &RRSet{}
err = c.do(req, result)
if err != nil {
return nil, err
}
return result, nil
}
// DeleteRRSet deletes a resource record set.
// https://developer.leaseweb.com/docs/#tag/DNS/operation/deleteResourceRecordSet
func (c *Client) DeleteRRSet(ctx context.Context, domainName, name, rType string) error {
endpoint := c.BaseURL.JoinPath("domains", domainName, "resourceRecordSets", name, rType)
req, err := newJSONRequest(ctx, http.MethodDelete, endpoint, nil)
if err != nil {
return err
}
return c.do(req, nil)
}
func (c *Client) do(req *http.Request, result any) error {
useragent.SetHeader(req.Header)
req.Header.Add(AuthHeader, c.apiKey)
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 newJSONRequest(ctx context.Context, method string, endpoint *url.URL, payload any) (*http.Request, error) {
buf := new(bytes.Buffer)
if payload != nil {
err := json.NewEncoder(buf).Encode(payload)
if err != nil {
return nil, fmt.Errorf("failed to create request JSON body: %w", err)
}
}
req, err := http.NewRequestWithContext(ctx, method, endpoint.String(), buf)
if err != nil {
return nil, fmt.Errorf("unable to create request: %w", err)
}
req.Header.Set("Accept", "application/json")
if payload != nil {
req.Header.Set("Content-Type", "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 {
if resp.StatusCode == http.StatusNotFound {
return &NotFoundError{APIError{
CorrelationID: resp.Header.Get("Correlation-Id"),
ErrorCode: strconv.Itoa(http.StatusNotFound),
ErrorMessage: string(raw),
}}
}
return errutils.NewUnexpectedStatusCodeError(req, resp.StatusCode, raw)
}
if errAPI.ErrorCode == strconv.Itoa(http.StatusNotFound) {
return &NotFoundError{APIError: errAPI}
}
return &errAPI
}
// TTLRounder rounds the given TTL in seconds to the next accepted value.
// Accepted TTL values are: 60, 300, 1800, 3600, 14400, 28800, 43200, 86400.
func TTLRounder(ttl int) int {
for _, validTTL := range []int{60, 300, 1800, 3600, 14400, 28800, 43200, 86400} {
if ttl <= validTTL {
return validTTL
}
}
return 3600
}

View file

@ -0,0 +1,149 @@
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("secret")
if err != nil {
return nil, err
}
client.BaseURL, _ = url.Parse(server.URL)
client.HTTPClient = server.Client()
return client, nil
},
servermock.CheckHeader().
WithJSONHeaders().
With(AuthHeader, "secret"),
)
}
func TestClient_CreateRRSet(t *testing.T) {
client := mockBuilder().
Route("POST /domains/example.com/resourceRecordSets",
servermock.ResponseFromFixture("createResourceRecordSet.json"),
servermock.CheckRequestJSONBodyFromFixture("createResourceRecordSet-request.json"),
).
Build(t)
rrset := RRSet{
Content: []string{"ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY"},
Name: "_acme-challenge.example.com.",
TTL: 300,
Type: "TXT",
}
result, err := client.CreateRRSet(t.Context(), "example.com", rrset)
require.NoError(t, err)
expected := &RRSet{
Content: []string{"ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY"},
Name: "_acme-challenge.example.com.",
Editable: true,
TTL: 300,
Type: "TXT",
}
assert.Equal(t, expected, result)
}
func TestClient_GetRRSet(t *testing.T) {
client := mockBuilder().
Route("GET /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromFixture("getResourceRecordSet.json"),
).
Build(t)
result, err := client.GetRRSet(t.Context(), "example.com", "_acme-challenge.example.com.", "TXT")
require.NoError(t, err)
expected := &RRSet{
Content: []string{"foo", "Now36o-3BmlB623-0c1qCIUmgWVVmDJb88KGl24pqpo"},
Name: "_acme-challenge.example.com.",
Editable: true,
TTL: 3600,
Type: "TXT",
}
assert.Equal(t, expected, result)
}
func TestClient_GetRRSet_error_404(t *testing.T) {
client := mockBuilder().
Route("GET /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromFixture("error_404.json").
WithStatusCode(http.StatusNotFound),
).
Build(t)
_, err := client.GetRRSet(t.Context(), "example.com", "_acme-challenge.example.com.", "TXT")
require.EqualError(t, err, "404: Resource not found (289346a1-3eaf-4da4-b707-62ef12eb08be)")
target := &NotFoundError{}
require.ErrorAs(t, err, &target)
}
func TestClient_UpdateRRSet(t *testing.T) {
client := mockBuilder().
Route("PUT /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromFixture("updateResourceRecordSet.json"),
servermock.CheckRequestJSONBodyFromFixture("updateResourceRecordSet-request.json"),
).
Build(t)
rrset := RRSet{
Content: []string{"foo", "Now36o-3BmlB623-0c1qCIUmgWVVmDJb88KGl24pqpo", "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY"},
Name: "_acme-challenge.example.com.",
TTL: 3600,
Type: "TXT",
}
result, err := client.UpdateRRSet(t.Context(), "example.com", rrset)
require.NoError(t, err)
expected := &RRSet{
Content: []string{"foo", "Now36o-3BmlB623-0c1qCIUmgWVVmDJb88KGl24pqpo", "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY"},
Name: "_acme-challenge.example.com.",
Editable: true,
TTL: 3600,
Type: "TXT",
}
assert.Equal(t, expected, result)
}
func TestClient_DeleteRRSet(t *testing.T) {
client := mockBuilder().
Route("DELETE /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.Noop().
WithStatusCode(http.StatusNoContent),
).
Build(t)
err := client.DeleteRRSet(t.Context(), "example.com", "_acme-challenge.example.com.", "TXT")
require.NoError(t, err)
}
func TestClient_DeleteRRSet_error(t *testing.T) {
client := mockBuilder().
Route("DELETE /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromFixture("error_401.json").
WithStatusCode(http.StatusUnauthorized),
).
Build(t)
err := client.DeleteRRSet(t.Context(), "example.com", "_acme-challenge.example.com.", "TXT")
require.EqualError(t, err, "401: You are not authorized to view this resource. (289346a1-3eaf-4da4-b707-62ef12eb08be)")
}

View file

@ -0,0 +1,8 @@
{
"content": [
"ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY"
],
"name": "_acme-challenge.example.com.",
"ttl": 300,
"type": "TXT"
}

View file

@ -0,0 +1,17 @@
{
"_links": {
"self": {
"href": "/domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT"
},
"collection": {
"href": "/domains/example.com/resourceRecordSets"
}
},
"content": [
"ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY"
],
"editable": true,
"name": "_acme-challenge.example.com.",
"ttl": 300,
"type": "TXT"
}

View file

@ -0,0 +1,6 @@
{
"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "400",
"errorDetails": {},
"errorMessage": "The API could not interpret your request correctly."
}

View file

@ -0,0 +1,5 @@
{
"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "401",
"errorMessage": "You are not authorized to view this resource."
}

View file

@ -0,0 +1,5 @@
{
"correlationId": "289346a1-3eaf-4da4-b707-62ef12eb08be",
"errorCode": "404",
"errorMessage": "Resource not found"
}

View file

@ -0,0 +1,18 @@
{
"_links": {
"self": {
"href": "/domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT"
},
"collection": {
"href": "/domains/example.com/resourceRecordSets"
}
},
"content": [
"foo",
"Now36o-3BmlB623-0c1qCIUmgWVVmDJb88KGl24pqpo"
],
"editable": true,
"name": "_acme-challenge.example.com.",
"ttl": 3600,
"type": "TXT"
}

View file

@ -0,0 +1,17 @@
{
"_links": {
"self": {
"href": "/domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT"
},
"collection": {
"href": "/domains/example.com/resourceRecordSets"
}
},
"content": [
"Now36o-3BmlB623-0c1qCIUmgWVVmDJb88KGl24pqpo"
],
"editable": true,
"name": "_acme-challenge.example.com.",
"ttl": 3600,
"type": "TXT"
}

View file

@ -0,0 +1,8 @@
{
"content": [
"foo",
"Now36o-3BmlB623-0c1qCIUmgWVVmDJb88KGl24pqpo",
"ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY"
],
"ttl": 3600
}

View file

@ -0,0 +1,6 @@
{
"content": [
"foo"
],
"ttl": 3600
}

View file

@ -0,0 +1,19 @@
{
"_links": {
"self": {
"href": "/domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT"
},
"collection": {
"href": "/domains/example.com/resourceRecordSets"
}
},
"content": [
"foo",
"Now36o-3BmlB623-0c1qCIUmgWVVmDJb88KGl24pqpo",
"ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY"
],
"editable": true,
"name": "_acme-challenge.example.com.",
"ttl": 3600,
"type": "TXT"
}

View file

@ -0,0 +1,35 @@
package internal
import (
"encoding/json"
"fmt"
)
type NotFoundError struct {
APIError
}
type APIError struct {
CorrelationID string `json:"correlationId,omitempty"`
ErrorCode string `json:"errorCode,omitempty"`
ErrorMessage string `json:"errorMessage,omitempty"`
ErrorDetails json.RawMessage `json:"errorDetails,omitempty"`
}
func (a *APIError) Error() string {
msg := fmt.Sprintf("%s: %s (%s)", a.ErrorCode, a.ErrorMessage, a.CorrelationID)
if len(a.ErrorDetails) > 0 {
msg += fmt.Sprintf(": %s", string(a.ErrorDetails))
}
return msg
}
type RRSet struct {
Content []string `json:"content,omitempty"`
Name string `json:"name,omitempty"`
Editable bool `json:"editable,omitempty"`
TTL int `json:"ttl,omitempty"`
Type string `json:"type,omitempty"`
}

View file

@ -0,0 +1,187 @@
// Package leaseweb implements a DNS provider for solving the DNS-01 challenge using Leaseweb.
package leaseweb
import (
"context"
"errors"
"fmt"
"net/http"
"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/leaseweb/internal"
)
// Environment variables names.
const (
envNamespace = "LEASEWEB_"
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 {
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, 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 {
config *Config
client *internal.Client
}
// NewDNSProvider returns a DNSProvider instance configured for Leaseweb.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvAPIKey)
if err != nil {
return nil, fmt.Errorf("leaseweb: %w", err)
}
config := NewDefaultConfig()
config.APIKey = values[EnvAPIKey]
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for Leaseweb.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("leaseweb: the configuration of the DNS provider is nil")
}
client, err := internal.NewClient(config.APIKey)
if err != nil {
return nil, fmt.Errorf("leaseweb: %w", 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 {
ctx := context.Background()
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("leaseweb: could not find zone for domain %q: %w", domain, err)
}
existingRRSet, err := d.client.GetRRSet(ctx, dns01.UnFqdn(authZone), info.EffectiveFQDN, "TXT")
if err != nil {
notfoundErr := &internal.NotFoundError{}
if !errors.As(err, &notfoundErr) {
return fmt.Errorf("leaseweb: get RRSet: %w", err)
}
// Create the RRSet.
rrset := internal.RRSet{
Content: []string{info.Value},
Name: info.EffectiveFQDN,
TTL: internal.TTLRounder(d.config.TTL),
Type: "TXT",
}
_, err = d.client.CreateRRSet(ctx, dns01.UnFqdn(authZone), rrset)
if err != nil {
return fmt.Errorf("leaseweb: create RRSet: %w", err)
}
return nil
}
// Update the RRSet.
existingRRSet.Content = append(existingRRSet.Content, info.Value)
_, err = d.client.UpdateRRSet(ctx, dns01.UnFqdn(authZone), *existingRRSet)
if err != nil {
return fmt.Errorf("leaseweb: update RRSet: %w", err)
}
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
ctx := context.Background()
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("leaseweb: could not find zone for domain %q: %w", domain, err)
}
existingRRSet, err := d.client.GetRRSet(ctx, dns01.UnFqdn(authZone), info.EffectiveFQDN, "TXT")
if err != nil {
return fmt.Errorf("leaseweb: get RRSet: %w", err)
}
var content []string
for _, s := range existingRRSet.Content {
if s != info.Value {
content = append(content, s)
}
}
if len(content) == 0 {
err = d.client.DeleteRRSet(ctx, dns01.UnFqdn(authZone), info.EffectiveFQDN, "TXT")
if err != nil {
return fmt.Errorf("leaseweb: delete RRSet: %w", err)
}
return nil
}
existingRRSet.Content = content
_, err = d.client.UpdateRRSet(ctx, dns01.UnFqdn(authZone), *existingRRSet)
if err != nil {
return fmt.Errorf("leaseweb: update RRSet: %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
}

View file

@ -0,0 +1,22 @@
Name = "Leaseweb"
Description = ''''''
URL = "https://www.leaseweb.com/en/"
Code = "leaseweb"
Since = "v4.32.0"
Example = '''
LEASEWEB_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \
lego --dns leaseweb -d '*.example.com' -d example.com run
'''
[Configuration]
[Configuration.Credentials]
LEASEWEB_API_KEY = "API key"
[Configuration.Additional]
LEASEWEB_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"
LEASEWEB_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 60)"
LEASEWEB_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)"
LEASEWEB_HTTP_TIMEOUT = "API request timeout in seconds (Default: 30)"
[Links]
API = "https://developer.leaseweb.com/docs/#tag/DNS"

View file

@ -0,0 +1,204 @@
package leaseweb
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/go-acme/lego/v4/providers/dns/leaseweb/internal"
"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: "leaseweb: some credentials information are missing: LEASEWEB_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
apiKey string
expected string
}{
{
desc: "success",
apiKey: "secret",
},
{
desc: "missing credentials",
expected: "leaseweb: 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.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.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().
With(internal.AuthHeader, "secret"),
)
}
func TestDNSProvider_Present_create(t *testing.T) {
provider := mockBuilder().
Route("GET /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromInternal("error_404.json").
WithStatusCode(http.StatusNotFound),
).
Route("POST /domains/example.com/resourceRecordSets",
servermock.ResponseFromInternal("createResourceRecordSet.json"),
servermock.CheckRequestJSONBodyFromInternal("createResourceRecordSet-request.json"),
).
Build(t)
err := provider.Present("example.com", "abc", "123d==")
require.NoError(t, err)
}
func TestDNSProvider_Present_update(t *testing.T) {
provider := mockBuilder().
Route("GET /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromInternal("getResourceRecordSet.json"),
).
Route("PUT /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromInternal("updateResourceRecordSet.json"),
servermock.CheckRequestJSONBodyFromInternal("updateResourceRecordSet-request.json"),
).
Build(t)
err := provider.Present("example.com", "abc", "123d==")
require.NoError(t, err)
}
func TestDNSProvider_CleanUp_delete(t *testing.T) {
provider := mockBuilder().
Route("GET /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromInternal("getResourceRecordSet2.json"),
).
Route("DELETE /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.Noop().
WithStatusCode(http.StatusNoContent),
).
Build(t)
err := provider.CleanUp("example.com", "abc", "1234d==")
require.NoError(t, err)
}
func TestDNSProvider_CleanUp_update(t *testing.T) {
provider := mockBuilder().
Route("GET /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromInternal("getResourceRecordSet.json"),
).
Route("PUT /domains/example.com/resourceRecordSets/_acme-challenge.example.com./TXT",
servermock.ResponseFromInternal("updateResourceRecordSet.json"),
servermock.CheckRequestJSONBodyFromInternal("updateResourceRecordSet-request2.json"),
).
Build(t)
err := provider.CleanUp("example.com", "abc", "1234d==")
require.NoError(t, err)
}

View file

@ -106,6 +106,7 @@ import (
"github.com/go-acme/lego/v4/providers/dns/jdcloud"
"github.com/go-acme/lego/v4/providers/dns/joker"
"github.com/go-acme/lego/v4/providers/dns/keyhelp"
"github.com/go-acme/lego/v4/providers/dns/leaseweb"
"github.com/go-acme/lego/v4/providers/dns/liara"
"github.com/go-acme/lego/v4/providers/dns/lightsail"
"github.com/go-acme/lego/v4/providers/dns/limacity"
@ -398,6 +399,8 @@ func NewDNSChallengeProviderByName(name string) (challenge.Provider, error) {
return joker.NewDNSProvider()
case "keyhelp":
return keyhelp.NewDNSProvider()
case "leaseweb":
return leaseweb.NewDNSProvider()
case "liara":
return liara.NewDNSProvider()
case "lightsail":