From c759f5655645ed4d9d6b71bab9adaf2373adb9e3 Mon Sep 17 00:00:00 2001 From: jwklijnsma Date: Sun, 21 Jul 2024 13:32:17 +0200 Subject: [PATCH] Add DNS provider for DirectAdmin (#2225) Co-authored-by: Fernandez Ludovic --- README.md | 52 +++--- cmd/zz_gen_cmd_dnshelp.go | 24 +++ docs/content/dns/zz_gen_directadmin.md | 71 ++++++++ docs/data/zz_cli_help.toml | 2 +- providers/dns/directadmin/directadmin.go | 163 ++++++++++++++++++ providers/dns/directadmin/directadmin.toml | 27 +++ providers/dns/directadmin/directadmin_test.go | 156 +++++++++++++++++ providers/dns/directadmin/internal/client.go | 103 +++++++++++ .../dns/directadmin/internal/client_test.go | 155 +++++++++++++++++ providers/dns/directadmin/internal/types.go | 21 +++ providers/dns/dns_providers.go | 3 + 11 files changed, 750 insertions(+), 27 deletions(-) create mode 100644 docs/content/dns/zz_gen_directadmin.md create mode 100644 providers/dns/directadmin/directadmin.go create mode 100644 providers/dns/directadmin/directadmin.toml create mode 100644 providers/dns/directadmin/directadmin_test.go create mode 100644 providers/dns/directadmin/internal/client.go create mode 100644 providers/dns/directadmin/internal/client_test.go create mode 100644 providers/dns/directadmin/internal/types.go diff --git a/README.md b/README.md index 060497c2..e28c89ca 100644 --- a/README.md +++ b/README.md @@ -60,32 +60,32 @@ Detailed documentation is available [here](https://go-acme.github.io/lego/dns). | [Cloud.ru](https://go-acme.github.io/lego/dns/cloudru/) | [CloudDNS](https://go-acme.github.io/lego/dns/clouddns/) | [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/) | [Constellix](https://go-acme.github.io/lego/dns/constellix/) | [CPanel/WHM](https://go-acme.github.io/lego/dns/cpanel/) | | [Derak Cloud](https://go-acme.github.io/lego/dns/derak/) | [deSEC.io](https://go-acme.github.io/lego/dns/desec/) | [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/) | [dnsHome.de](https://go-acme.github.io/lego/dns/dnshomede/) | [DNSimple](https://go-acme.github.io/lego/dns/dnsimple/) | [DNSPod (deprecated)](https://go-acme.github.io/lego/dns/dnspod/) | -| [Domain Offensive (do.de)](https://go-acme.github.io/lego/dns/dode/) | [Domeneshop](https://go-acme.github.io/lego/dns/domeneshop/) | [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/) | [Dynu](https://go-acme.github.io/lego/dns/dynu/) | [EasyDNS](https://go-acme.github.io/lego/dns/easydns/) | [Efficient IP](https://go-acme.github.io/lego/dns/efficientip/) | -| [Epik](https://go-acme.github.io/lego/dns/epik/) | [Exoscale](https://go-acme.github.io/lego/dns/exoscale/) | [External program](https://go-acme.github.io/lego/dns/exec/) | [freemyip.com](https://go-acme.github.io/lego/dns/freemyip/) | -| [G-Core](https://go-acme.github.io/lego/dns/gcore/) | [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/) | [Google Domains](https://go-acme.github.io/lego/dns/googledomains/) | [Hetzner](https://go-acme.github.io/lego/dns/hetzner/) | -| [Hosting.de](https://go-acme.github.io/lego/dns/hostingde/) | [Hosttech](https://go-acme.github.io/lego/dns/hosttech/) | [HTTP request](https://go-acme.github.io/lego/dns/httpreq/) | [http.net](https://go-acme.github.io/lego/dns/httpnet/) | -| [Hurricane Electric DNS](https://go-acme.github.io/lego/dns/hurricane/) | [HyperOne](https://go-acme.github.io/lego/dns/hyperone/) | [IBM Cloud (SoftLayer)](https://go-acme.github.io/lego/dns/ibmcloud/) | [IIJ DNS Platform Service](https://go-acme.github.io/lego/dns/iijdpf/) | -| [Infoblox](https://go-acme.github.io/lego/dns/infoblox/) | [Infomaniak](https://go-acme.github.io/lego/dns/infomaniak/) | [Internet Initiative Japan](https://go-acme.github.io/lego/dns/iij/) | [Internet.bs](https://go-acme.github.io/lego/dns/internetbs/) | -| [INWX](https://go-acme.github.io/lego/dns/inwx/) | [Ionos](https://go-acme.github.io/lego/dns/ionos/) | [IPv64](https://go-acme.github.io/lego/dns/ipv64/) | [iwantmyname](https://go-acme.github.io/lego/dns/iwantmyname/) | -| [Joker](https://go-acme.github.io/lego/dns/joker/) | [Joohoi's ACME-DNS](https://go-acme.github.io/lego/dns/acme-dns/) | [Liara](https://go-acme.github.io/lego/dns/liara/) | [Linode (v4)](https://go-acme.github.io/lego/dns/linode/) | -| [Liquid Web](https://go-acme.github.io/lego/dns/liquidweb/) | [Loopia](https://go-acme.github.io/lego/dns/loopia/) | [LuaDNS](https://go-acme.github.io/lego/dns/luadns/) | [Mail-in-a-Box](https://go-acme.github.io/lego/dns/mailinabox/) | -| [Manual](https://go-acme.github.io/lego/dns/manual/) | [Metaname](https://go-acme.github.io/lego/dns/metaname/) | [MyDNS.jp](https://go-acme.github.io/lego/dns/mydnsjp/) | [MythicBeasts](https://go-acme.github.io/lego/dns/mythicbeasts/) | -| [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/) | [NearlyFreeSpeech.NET](https://go-acme.github.io/lego/dns/nearlyfreespeech/) | -| [Netcup](https://go-acme.github.io/lego/dns/netcup/) | [Netlify](https://go-acme.github.io/lego/dns/netlify/) | [Nicmanager](https://go-acme.github.io/lego/dns/nicmanager/) | [NIFCloud](https://go-acme.github.io/lego/dns/nifcloud/) | -| [Njalla](https://go-acme.github.io/lego/dns/njalla/) | [Nodion](https://go-acme.github.io/lego/dns/nodion/) | [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/) | [plesk.com](https://go-acme.github.io/lego/dns/plesk/) | [Porkbun](https://go-acme.github.io/lego/dns/porkbun/) | -| [PowerDNS](https://go-acme.github.io/lego/dns/pdns/) | [Rackspace](https://go-acme.github.io/lego/dns/rackspace/) | [RcodeZero](https://go-acme.github.io/lego/dns/rcodezero/) | [reg.ru](https://go-acme.github.io/lego/dns/regru/) | -| [RFC2136](https://go-acme.github.io/lego/dns/rfc2136/) | [RimuHosting](https://go-acme.github.io/lego/dns/rimuhosting/) | [Sakura Cloud](https://go-acme.github.io/lego/dns/sakuracloud/) | [Scaleway](https://go-acme.github.io/lego/dns/scaleway/) | -| [Selectel v2](https://go-acme.github.io/lego/dns/selectelv2/) | [Selectel](https://go-acme.github.io/lego/dns/selectel/) | [Servercow](https://go-acme.github.io/lego/dns/servercow/) | [Shellrent](https://go-acme.github.io/lego/dns/shellrent/) | -| [Simply.com](https://go-acme.github.io/lego/dns/simply/) | [Sonic](https://go-acme.github.io/lego/dns/sonic/) | [Stackpath](https://go-acme.github.io/lego/dns/stackpath/) | [Tencent Cloud DNS](https://go-acme.github.io/lego/dns/tencentcloud/) | -| [TransIP](https://go-acme.github.io/lego/dns/transip/) | [UKFast SafeDNS](https://go-acme.github.io/lego/dns/safedns/) | [Ultradns](https://go-acme.github.io/lego/dns/ultradns/) | [Variomedia](https://go-acme.github.io/lego/dns/variomedia/) | -| [VegaDNS](https://go-acme.github.io/lego/dns/vegadns/) | [Vercel](https://go-acme.github.io/lego/dns/vercel/) | [Versio.[nl/eu/uk]](https://go-acme.github.io/lego/dns/versio/) | [VinylDNS](https://go-acme.github.io/lego/dns/vinyldns/) | -| [VK Cloud](https://go-acme.github.io/lego/dns/vkcloud/) | [Vscale](https://go-acme.github.io/lego/dns/vscale/) | [Vultr](https://go-acme.github.io/lego/dns/vultr/) | [Webnames](https://go-acme.github.io/lego/dns/webnames/) | -| [Websupport](https://go-acme.github.io/lego/dns/websupport/) | [WEDOS](https://go-acme.github.io/lego/dns/wedos/) | [Yandex 360](https://go-acme.github.io/lego/dns/yandex360/) | [Yandex Cloud](https://go-acme.github.io/lego/dns/yandexcloud/) | -| [Yandex PDD](https://go-acme.github.io/lego/dns/yandex/) | [Zone.ee](https://go-acme.github.io/lego/dns/zoneee/) | [Zonomi](https://go-acme.github.io/lego/dns/zonomi/) | | +| [directadmin](https://go-acme.github.io/lego/dns/directadmin/) | [DNS Made Easy](https://go-acme.github.io/lego/dns/dnsmadeeasy/) | [dnsHome.de](https://go-acme.github.io/lego/dns/dnshomede/) | [DNSimple](https://go-acme.github.io/lego/dns/dnsimple/) | +| [DNSPod (deprecated)](https://go-acme.github.io/lego/dns/dnspod/) | [Domain Offensive (do.de)](https://go-acme.github.io/lego/dns/dode/) | [Domeneshop](https://go-acme.github.io/lego/dns/domeneshop/) | [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/) | [Dynu](https://go-acme.github.io/lego/dns/dynu/) | [EasyDNS](https://go-acme.github.io/lego/dns/easydns/) | +| [Efficient IP](https://go-acme.github.io/lego/dns/efficientip/) | [Epik](https://go-acme.github.io/lego/dns/epik/) | [Exoscale](https://go-acme.github.io/lego/dns/exoscale/) | [External program](https://go-acme.github.io/lego/dns/exec/) | +| [freemyip.com](https://go-acme.github.io/lego/dns/freemyip/) | [G-Core](https://go-acme.github.io/lego/dns/gcore/) | [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/) | [Google Domains](https://go-acme.github.io/lego/dns/googledomains/) | +| [Hetzner](https://go-acme.github.io/lego/dns/hetzner/) | [Hosting.de](https://go-acme.github.io/lego/dns/hostingde/) | [Hosttech](https://go-acme.github.io/lego/dns/hosttech/) | [HTTP request](https://go-acme.github.io/lego/dns/httpreq/) | +| [http.net](https://go-acme.github.io/lego/dns/httpnet/) | [Hurricane Electric DNS](https://go-acme.github.io/lego/dns/hurricane/) | [HyperOne](https://go-acme.github.io/lego/dns/hyperone/) | [IBM Cloud (SoftLayer)](https://go-acme.github.io/lego/dns/ibmcloud/) | +| [IIJ DNS Platform Service](https://go-acme.github.io/lego/dns/iijdpf/) | [Infoblox](https://go-acme.github.io/lego/dns/infoblox/) | [Infomaniak](https://go-acme.github.io/lego/dns/infomaniak/) | [Internet Initiative Japan](https://go-acme.github.io/lego/dns/iij/) | +| [Internet.bs](https://go-acme.github.io/lego/dns/internetbs/) | [INWX](https://go-acme.github.io/lego/dns/inwx/) | [Ionos](https://go-acme.github.io/lego/dns/ionos/) | [IPv64](https://go-acme.github.io/lego/dns/ipv64/) | +| [iwantmyname](https://go-acme.github.io/lego/dns/iwantmyname/) | [Joker](https://go-acme.github.io/lego/dns/joker/) | [Joohoi's ACME-DNS](https://go-acme.github.io/lego/dns/acme-dns/) | [Liara](https://go-acme.github.io/lego/dns/liara/) | +| [Linode (v4)](https://go-acme.github.io/lego/dns/linode/) | [Liquid Web](https://go-acme.github.io/lego/dns/liquidweb/) | [Loopia](https://go-acme.github.io/lego/dns/loopia/) | [LuaDNS](https://go-acme.github.io/lego/dns/luadns/) | +| [Mail-in-a-Box](https://go-acme.github.io/lego/dns/mailinabox/) | [Manual](https://go-acme.github.io/lego/dns/manual/) | [Metaname](https://go-acme.github.io/lego/dns/metaname/) | [MyDNS.jp](https://go-acme.github.io/lego/dns/mydnsjp/) | +| [MythicBeasts](https://go-acme.github.io/lego/dns/mythicbeasts/) | [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/) | +| [NearlyFreeSpeech.NET](https://go-acme.github.io/lego/dns/nearlyfreespeech/) | [Netcup](https://go-acme.github.io/lego/dns/netcup/) | [Netlify](https://go-acme.github.io/lego/dns/netlify/) | [Nicmanager](https://go-acme.github.io/lego/dns/nicmanager/) | +| [NIFCloud](https://go-acme.github.io/lego/dns/nifcloud/) | [Njalla](https://go-acme.github.io/lego/dns/njalla/) | [Nodion](https://go-acme.github.io/lego/dns/nodion/) | [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/) | [plesk.com](https://go-acme.github.io/lego/dns/plesk/) | +| [Porkbun](https://go-acme.github.io/lego/dns/porkbun/) | [PowerDNS](https://go-acme.github.io/lego/dns/pdns/) | [Rackspace](https://go-acme.github.io/lego/dns/rackspace/) | [RcodeZero](https://go-acme.github.io/lego/dns/rcodezero/) | +| [reg.ru](https://go-acme.github.io/lego/dns/regru/) | [RFC2136](https://go-acme.github.io/lego/dns/rfc2136/) | [RimuHosting](https://go-acme.github.io/lego/dns/rimuhosting/) | [Sakura Cloud](https://go-acme.github.io/lego/dns/sakuracloud/) | +| [Scaleway](https://go-acme.github.io/lego/dns/scaleway/) | [Selectel v2](https://go-acme.github.io/lego/dns/selectelv2/) | [Selectel](https://go-acme.github.io/lego/dns/selectel/) | [Servercow](https://go-acme.github.io/lego/dns/servercow/) | +| [Shellrent](https://go-acme.github.io/lego/dns/shellrent/) | [Simply.com](https://go-acme.github.io/lego/dns/simply/) | [Sonic](https://go-acme.github.io/lego/dns/sonic/) | [Stackpath](https://go-acme.github.io/lego/dns/stackpath/) | +| [Tencent Cloud DNS](https://go-acme.github.io/lego/dns/tencentcloud/) | [TransIP](https://go-acme.github.io/lego/dns/transip/) | [UKFast SafeDNS](https://go-acme.github.io/lego/dns/safedns/) | [Ultradns](https://go-acme.github.io/lego/dns/ultradns/) | +| [Variomedia](https://go-acme.github.io/lego/dns/variomedia/) | [VegaDNS](https://go-acme.github.io/lego/dns/vegadns/) | [Vercel](https://go-acme.github.io/lego/dns/vercel/) | [Versio.[nl/eu/uk]](https://go-acme.github.io/lego/dns/versio/) | +| [VinylDNS](https://go-acme.github.io/lego/dns/vinyldns/) | [VK Cloud](https://go-acme.github.io/lego/dns/vkcloud/) | [Vscale](https://go-acme.github.io/lego/dns/vscale/) | [Vultr](https://go-acme.github.io/lego/dns/vultr/) | +| [Webnames](https://go-acme.github.io/lego/dns/webnames/) | [Websupport](https://go-acme.github.io/lego/dns/websupport/) | [WEDOS](https://go-acme.github.io/lego/dns/wedos/) | [Yandex 360](https://go-acme.github.io/lego/dns/yandex360/) | +| [Yandex Cloud](https://go-acme.github.io/lego/dns/yandexcloud/) | [Yandex PDD](https://go-acme.github.io/lego/dns/yandex/) | [Zone.ee](https://go-acme.github.io/lego/dns/zoneee/) | [Zonomi](https://go-acme.github.io/lego/dns/zonomi/) | diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index fd59f7ac..06134760 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -40,6 +40,7 @@ func allDNSCodes() string { "desec", "designate", "digitalocean", + "directadmin", "dnshomede", "dnsimple", "dnsmadeeasy", @@ -733,6 +734,29 @@ func displayDNSHelp(w io.Writer, name string) error { ew.writeln() ew.writeln(`More information: https://go-acme.github.io/lego/dns/digitalocean`) + case "directadmin": + // generated from: providers/dns/directadmin/directadmin.toml + ew.writeln(`Configuration for directadmin.`) + ew.writeln(`Code: 'directadmin'`) + ew.writeln(`Since: ''`) + ew.writeln() + + ew.writeln(`Credentials:`) + ew.writeln(` - "DIRECTADMIN_API_URL": URL of the API`) + ew.writeln(` - "DIRECTADMIN_PASSWORD": API password`) + ew.writeln(` - "DIRECTADMIN_USERNAME": API username`) + ew.writeln() + + ew.writeln(`Additional Configuration:`) + ew.writeln(` - "DIRECTADMIN_HTTP_TIMEOUT": API request timeout`) + ew.writeln(` - "DIRECTADMIN_POLLING_INTERVAL": Time between DNS propagation check`) + ew.writeln(` - "DIRECTADMIN_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`) + ew.writeln(` - "DIRECTADMIN_TTL": The TTL of the TXT record used for the DNS challenge`) + ew.writeln(` - "DIRECTADMIN_ZONE_NAME": API password`) + + ew.writeln() + ew.writeln(`More information: https://go-acme.github.io/lego/dns/directadmin`) + case "dnshomede": // generated from: providers/dns/dnshomede/dnshomede.toml ew.writeln(`Configuration for dnsHome.de.`) diff --git a/docs/content/dns/zz_gen_directadmin.md b/docs/content/dns/zz_gen_directadmin.md new file mode 100644 index 00000000..bf8d0bf7 --- /dev/null +++ b/docs/content/dns/zz_gen_directadmin.md @@ -0,0 +1,71 @@ +--- +title: "directadmin" +date: 2019-03-03T16:39:46+01:00 +draft: false +slug: directadmin +dnsprovider: + since: "" + code: "directadmin" + url: "directadmin" +--- + + + + + +directadmin api + + + + +- Code: `directadmin` +- Since: + + +Here is an example bash command using the directadmin provider: + +```bash +DIRECTADMIN_API_URL="http://example.com:2222" \ +DIRECTADMIN_USERNAME=xxxx \ +DIRECTADMIN_PASSWORD=yyy \ +lego --email you@example.com --dns directadmin -d "my.example.org" -d "*.example.org" run +``` + + + + +## Credentials + +| Environment Variable Name | Description | +|-----------------------|-------------| +| `DIRECTADMIN_API_URL` | URL of the API | +| `DIRECTADMIN_PASSWORD` | API password | +| `DIRECTADMIN_USERNAME` | API username | + +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 | +|--------------------------------|-------------| +| `DIRECTADMIN_HTTP_TIMEOUT` | API request timeout | +| `DIRECTADMIN_POLLING_INTERVAL` | Time between DNS propagation check | +| `DIRECTADMIN_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | +| `DIRECTADMIN_TTL` | The TTL of the TXT record used for the DNS challenge | +| `DIRECTADMIN_ZONE_NAME` | API password | + +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://www.directadmin.com/api.php) + + + + diff --git a/docs/data/zz_cli_help.toml b/docs/data/zz_cli_help.toml index 6b3d91c0..edf7d618 100644 --- a/docs/data/zz_cli_help.toml +++ b/docs/data/zz_cli_help.toml @@ -138,7 +138,7 @@ To display the documentation for a specific DNS provider, run: $ lego dnshelp -c code Supported DNS providers: - acme-dns, alidns, allinkl, arvancloud, auroradns, autodns, azure, azuredns, bindman, bluecat, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, conoha, constellix, cpanel, derak, desec, designate, digitalocean, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dynu, easydns, edgedns, efficientip, epik, exec, exoscale, freemyip, gandi, gandiv5, gcloud, gcore, glesys, godaddy, googledomains, hetzner, hostingde, hosttech, httpnet, httpreq, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ipv64, iwantmyname, joker, liara, lightsail, linode, liquidweb, loopia, luadns, mailinabox, manual, metaname, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, nearlyfreespeech, netcup, netlify, nicmanager, nifcloud, njalla, nodion, ns1, oraclecloud, otc, ovh, pdns, plesk, porkbun, rackspace, rcodezero, regru, rfc2136, rimuhosting, route53, safedns, sakuracloud, scaleway, selectel, selectelv2, servercow, shellrent, simply, sonic, stackpath, tencentcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, vscale, vultr, webnames, websupport, wedos, yandex, yandex360, yandexcloud, zoneee, zonomi + acme-dns, alidns, allinkl, arvancloud, auroradns, autodns, azure, azuredns, bindman, bluecat, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, conoha, constellix, cpanel, derak, desec, designate, digitalocean, directadmin, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dynu, easydns, edgedns, efficientip, epik, exec, exoscale, freemyip, gandi, gandiv5, gcloud, gcore, glesys, godaddy, googledomains, hetzner, hostingde, hosttech, httpnet, httpreq, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ipv64, iwantmyname, joker, liara, lightsail, linode, liquidweb, loopia, luadns, mailinabox, manual, metaname, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, nearlyfreespeech, netcup, netlify, nicmanager, nifcloud, njalla, nodion, ns1, oraclecloud, otc, ovh, pdns, plesk, porkbun, rackspace, rcodezero, regru, rfc2136, rimuhosting, route53, safedns, sakuracloud, scaleway, selectel, selectelv2, servercow, shellrent, simply, sonic, stackpath, tencentcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, vscale, vultr, webnames, websupport, wedos, yandex, yandex360, yandexcloud, zoneee, zonomi More information: https://go-acme.github.io/lego/dns """ diff --git a/providers/dns/directadmin/directadmin.go b/providers/dns/directadmin/directadmin.go new file mode 100644 index 00000000..5aab7086 --- /dev/null +++ b/providers/dns/directadmin/directadmin.go @@ -0,0 +1,163 @@ +package directadmin + +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/directadmin/internal" +) + +// Environment variables names. +const ( + envNamespace = "DIRECTADMIN_" + + EnvAPIURL = envNamespace + "API_URL" + EnvUsername = envNamespace + "USERNAME" + EnvPassword = envNamespace + "PASSWORD" + EnvZoneName = envNamespace + "ZONE_NAME" + + 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 { + BaseURL string + Username string + Password string + TTL int + PropagationTimeout time.Duration + PollingInterval time.Duration + HTTPClient *http.Client +} + +// NewDefaultConfig returns a default configuration for the DNSProvider. +func NewDefaultConfig() *Config { + return &Config{ + TTL: env.GetOrDefaultInt(EnvTTL, 30), + PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 60*time.Second), + PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 5*time.Second), + HTTPClient: &http.Client{ + Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second), + }, + } +} + +// DNSProvider implements the challenge.Provider interface. +type DNSProvider struct { + client *internal.Client + config *Config +} + +// NewDNSProvider returns a DNSProvider instance configured for DirectAdmin. +// Credentials must be passed in the environment variables: +// DIRECTADMIN_API_URL, DIRECTADMIN_USERNAME, DIRECTADMIN_PASSWORD. +func NewDNSProvider() (*DNSProvider, error) { + values, err := env.Get(EnvAPIURL, EnvUsername, EnvPassword) + if err != nil { + return nil, fmt.Errorf("directadmin: %w", err) + } + + config := NewDefaultConfig() + config.BaseURL = values[EnvAPIURL] + config.Username = values[EnvUsername] + config.Password = values[EnvPassword] + + return NewDNSProviderConfig(config) +} + +// NewDNSProviderConfig return a DNSProvider instance configured for DirectAdmin. +func NewDNSProviderConfig(config *Config) (*DNSProvider, error) { + if config.BaseURL == "" { + return nil, errors.New("directadmin: missing API URL") + } + + if config.Username == "" || config.Password == "" { + return nil, errors.New("directadmin: some credentials information are missing") + } + + client, err := internal.NewClient(config.BaseURL, config.Username, config.Password) + if err != nil { + return nil, fmt.Errorf("directadmin: %w", err) + } + + return &DNSProvider{client: client, config: config}, 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 := getAuthZone(info.EffectiveFQDN) + if err != nil { + return fmt.Errorf("directadmin: [domain: %q] %w", domain, err) + } + + subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone) + if err != nil { + return fmt.Errorf("directadmin: %w", err) + } + + record := internal.Record{ + Name: subDomain, + Type: "TXT", + Value: info.Value, + TTL: d.config.TTL, + } + + err = d.client.SetRecord(context.Background(), dns01.UnFqdn(authZone), record) + if err != nil { + return fmt.Errorf("directadmin: set record for zone %s and subdomain %s: %w", authZone, subDomain, 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 := getAuthZone(info.EffectiveFQDN) + if err != nil { + return fmt.Errorf("directadmin: [domain: %q] %w", domain, err) + } + + subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone) + if err != nil { + return fmt.Errorf("directadmin: %w", err) + } + + record := internal.Record{ + Name: subDomain, + Type: "TXT", + Value: info.Value, + } + + err = d.client.DeleteRecord(context.Background(), dns01.UnFqdn(authZone), record) + if err != nil { + return fmt.Errorf("directadmin: delete record for zone %s and subdomain %s: %w", authZone, subDomain, err) + } + + return nil +} + +func getAuthZone(fqdn string) (string, error) { + authZone := env.GetOrFile(EnvZoneName) + if authZone != "" { + return authZone, nil + } + + authZone, err := dns01.FindZoneByFqdn(fqdn) + if err != nil { + return "", fmt.Errorf("could not find zone for %s: %w", fqdn, err) + } + + return authZone, nil +} diff --git a/providers/dns/directadmin/directadmin.toml b/providers/dns/directadmin/directadmin.toml new file mode 100644 index 00000000..b676cf5b --- /dev/null +++ b/providers/dns/directadmin/directadmin.toml @@ -0,0 +1,27 @@ +Name = "directadmin" +Description = '''directadmin api''' +URL = "directadmin" +Code = "directadmin" + + +Example = ''' +DIRECTADMIN_API_URL="http://example.com:2222" \ +DIRECTADMIN_USERNAME=xxxx \ +DIRECTADMIN_PASSWORD=yyy \ +lego --email you@example.com --dns directadmin -d "my.example.org" -d "*.example.org" run +''' + +[Configuration] + [Configuration.Credentials] + DIRECTADMIN_API_URL = "URL of the API" + DIRECTADMIN_USERNAME = "API username" + DIRECTADMIN_PASSWORD = "API password" + [Configuration.Additional] + DIRECTADMIN_ZONE_NAME = "API password" + DIRECTADMIN_POLLING_INTERVAL = "Time between DNS propagation check" + DIRECTADMIN_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" + DIRECTADMIN_TTL = "The TTL of the TXT record used for the DNS challenge" + DIRECTADMIN_HTTP_TIMEOUT = "API request timeout" + +[Links] + API = "https://www.directadmin.com/api.php" diff --git a/providers/dns/directadmin/directadmin_test.go b/providers/dns/directadmin/directadmin_test.go new file mode 100644 index 00000000..5d91e8c3 --- /dev/null +++ b/providers/dns/directadmin/directadmin_test.go @@ -0,0 +1,156 @@ +package directadmin + +import ( + "testing" + + "github.com/go-acme/lego/v4/platform/tester" + "github.com/stretchr/testify/require" +) + +const envDomain = envNamespace + "DOMAIN" + +var envTest = tester.NewEnvTest(EnvAPIURL, EnvUsername, EnvPassword).WithDomain(envDomain) + +func TestNewDNSProvider(t *testing.T) { + testCases := []struct { + desc string + envVars map[string]string + expected string + }{ + { + desc: "success", + envVars: map[string]string{ + EnvAPIURL: "https://exmaple.com:2222", + EnvUsername: "test", + EnvPassword: "secret", + }, + }, + { + desc: "missing credentials", + envVars: map[string]string{}, + expected: "directadmin: some credentials information are missing: DIRECTADMIN_API_URL,DIRECTADMIN_USERNAME,DIRECTADMIN_PASSWORD", + }, + { + desc: "missing API URL", + envVars: map[string]string{ + EnvUsername: "test", + EnvPassword: "secret", + }, + expected: "directadmin: some credentials information are missing: DIRECTADMIN_API_URL", + }, + { + desc: "missing username", + envVars: map[string]string{ + EnvAPIURL: "https://exmaple.com:2222", + EnvPassword: "secret", + }, + expected: "directadmin: some credentials information are missing: DIRECTADMIN_USERNAME", + }, + { + desc: "missing password", + envVars: map[string]string{ + EnvAPIURL: "https://exmaple.com:2222", + EnvUsername: "test", + }, + expected: "directadmin: some credentials information are missing: DIRECTADMIN_PASSWORD", + }, + } + + 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.client) + require.NotNil(t, p.config) + } else { + require.EqualError(t, err, test.expected) + } + }) + } +} + +func TestNewDNSProviderConfig(t *testing.T) { + testCases := []struct { + desc string + baseURL string + username string + password string + expected string + }{ + { + desc: "success", + baseURL: "https://api.directadmin.com", + username: "test", + password: "secret", + }, + { + desc: "missing API URL", + expected: "directadmin: missing API URL", + }, + { + desc: "missing username", + baseURL: "https://api.directadmin.com", + expected: "directadmin: some credentials information are missing", + }, + { + desc: "missing password", + baseURL: "https://api.directadmin.com", + username: "test", + expected: "directadmin: some credentials information are missing", + }, + } + + for _, test := range testCases { + t.Run(test.desc, func(t *testing.T) { + config := NewDefaultConfig() + config.BaseURL = test.baseURL + config.Username = test.username + config.Password = test.password + + p, err := NewDNSProviderConfig(config) + + if test.expected == "" { + require.NoError(t, err) + require.NotNil(t, p) + require.NotNil(t, p.client) + require.NotNil(t, p.config) + } 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) +} diff --git a/providers/dns/directadmin/internal/client.go b/providers/dns/directadmin/internal/client.go new file mode 100644 index 00000000..fb84257b --- /dev/null +++ b/providers/dns/directadmin/internal/client.go @@ -0,0 +1,103 @@ +package internal + +import ( + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "net/url" + "strings" + "time" + + "github.com/go-acme/lego/v4/providers/dns/internal/errutils" + querystring "github.com/google/go-querystring/query" +) + +// Client the Direct Admin API client. +type Client struct { + baseURL *url.URL + HTTPClient *http.Client + + username string + password string +} + +// NewClient creates a new Client. +func NewClient(baseURL, username, password string) (*Client, error) { + api, err := url.Parse(baseURL) + if err != nil { + return nil, err + } + + return &Client{ + baseURL: api, + HTTPClient: &http.Client{Timeout: 10 * time.Second}, + username: username, + password: password, + }, nil +} + +func (c Client) SetRecord(ctx context.Context, domain string, record Record) error { + data, err := querystring.Values(record) + if err != nil { + return err + } + + data.Set("action", "add") + + return c.do(ctx, domain, data) +} + +func (c Client) DeleteRecord(ctx context.Context, domain string, record Record) error { + data, err := querystring.Values(record) + if err != nil { + return err + } + + data.Set("action", "delete") + + return c.do(ctx, domain, data) +} + +func (c Client) do(ctx context.Context, domain string, data url.Values) error { + endpoint := c.baseURL.JoinPath("CMD_API_DNS_CONTROL") + + query := endpoint.Query() + query.Set("domain", domain) + query.Set("json", "yes") + endpoint.RawQuery = query.Encode() + + req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint.String(), strings.NewReader(data.Encode())) + if err != nil { + return fmt.Errorf("unable to create request: %w", err) + } + + req.SetBasicAuth(c.username, c.password) + req.Header.Add("Content-Type", "application/x-www-form-urlencoded") + + resp, err := c.HTTPClient.Do(req) + if err != nil { + return errutils.NewHTTPDoError(req, err) + } + + defer func() { _ = resp.Body.Close() }() + + if resp.StatusCode != http.StatusOK { + return parseError(req, resp) + } + + return nil +} + +func parseError(req *http.Request, resp *http.Response) error { + raw, _ := io.ReadAll(resp.Body) + + var errInfo APIError + err := json.Unmarshal(raw, &errInfo) + if err != nil { + return errutils.NewUnexpectedStatusCodeError(req, resp.StatusCode, raw) + } + + return fmt.Errorf("[status code %d] %w", resp.StatusCode, errInfo) +} diff --git a/providers/dns/directadmin/internal/client_test.go b/providers/dns/directadmin/internal/client_test.go new file mode 100644 index 00000000..ded4769e --- /dev/null +++ b/providers/dns/directadmin/internal/client_test.go @@ -0,0 +1,155 @@ +package internal + +import ( + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "net/http/httptest" + "net/url" + "testing" + + "github.com/stretchr/testify/require" +) + +func setupTest(t *testing.T) (*Client, *http.ServeMux) { + t.Helper() + + mux := http.NewServeMux() + server := httptest.NewServer(mux) + t.Cleanup(server.Close) + + client, _ := NewClient(server.URL, "user", "secret") + client.HTTPClient = server.Client() + + return client, mux +} + +func newJSONErrorf(reason string, a ...any) string { + err := APIError{ + Message: "Cannot View Dns Record", + Result: fmt.Sprintf(reason, a...), + } + + data, _ := json.Marshal(err) + + return string(data) +} + +func testHandler(kv map[string]string) func(rw http.ResponseWriter, req *http.Request) { + return func(rw http.ResponseWriter, req *http.Request) { + if req.Method != http.MethodPost { + http.Error(rw, fmt.Sprintf("unsupported method %s", req.Method), http.StatusBadRequest) + return + } + + domain := req.URL.Query().Get("domain") + if domain != "example.com" { + http.Error(rw, newJSONErrorf("invalid domain: %s", domain), http.StatusUnauthorized) + return + } + + data, err := io.ReadAll(req.Body) + if err != nil { + http.Error(rw, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) + return + } + + values, err := url.ParseQuery(string(data)) + if err != nil { + http.Error(rw, http.StatusText(http.StatusInternalServerError), http.StatusInternalServerError) + return + } + + for k, v := range kv { + actual := values.Get(k) + if v != actual { + http.Error(rw, newJSONErrorf("invalid %q: %s", k, actual), http.StatusBadRequest) + return + } + } + } +} + +func TestClient_SetRecord(t *testing.T) { + client, mux := setupTest(t) + + kv := map[string]string{ + "action": "add", + "name": "foo", + "type": "TXT", + "value": "txtTXTtxt", + "ttl": "123", + } + + mux.HandleFunc("/CMD_API_DNS_CONTROL", testHandler(kv)) + + record := Record{ + Name: "foo", + Type: "TXT", + Value: "txtTXTtxt", + TTL: 123, + } + + err := client.SetRecord(context.Background(), "example.com", record) + require.NoError(t, err) +} + +func TestClient_SetRecord_error(t *testing.T) { + client, mux := setupTest(t) + + mux.HandleFunc("/CMD_API_DNS_CONTROL", func(rw http.ResponseWriter, req *http.Request) { + http.Error(rw, newJSONErrorf("OOPS"), http.StatusInternalServerError) + }) + + record := Record{ + Name: "foo", + Type: "TXT", + Value: "txtTXTtxt", + TTL: 123, + } + + err := client.SetRecord(context.Background(), "example.com", record) + require.EqualError(t, err, "[status code 500] Cannot View Dns Record: OOPS") +} + +func TestClient_DeleteRecord(t *testing.T) { + client, mux := setupTest(t) + + kv := map[string]string{ + "action": "delete", + "name": "foo", + "type": "TXT", + "value": "txtTXTtxt", + "ttl": "", + } + + mux.HandleFunc("/CMD_API_DNS_CONTROL", testHandler(kv)) + + record := Record{ + Name: "foo", + Type: "TXT", + Value: "txtTXTtxt", + } + + err := client.DeleteRecord(context.Background(), "example.com", record) + require.NoError(t, err) +} + +func TestClient_DeleteRecord_error(t *testing.T) { + client, mux := setupTest(t) + + mux.HandleFunc("/CMD_API_DNS_CONTROL", func(rw http.ResponseWriter, req *http.Request) { + http.Error(rw, newJSONErrorf("OOPS"), http.StatusInternalServerError) + }) + + record := Record{ + Name: "foo", + Type: "TXT", + Value: "txtTXTtxt", + } + + err := client.DeleteRecord(context.Background(), "example.com", record) + require.EqualError(t, err, "[status code 500] Cannot View Dns Record: OOPS") +} diff --git a/providers/dns/directadmin/internal/types.go b/providers/dns/directadmin/internal/types.go new file mode 100644 index 00000000..461e36f9 --- /dev/null +++ b/providers/dns/directadmin/internal/types.go @@ -0,0 +1,21 @@ +package internal + +import "fmt" + +// Record represents a DNS record. +type Record struct { + Name string `url:"name,omitempty"` + Type string `url:"type,omitempty"` + Value string `url:"value,omitempty"` + TTL int `url:"ttl,omitempty"` +} + +// APIError represents a API error. +type APIError struct { + Message string `json:"error,omitempty"` + Result string `json:"result,omitempty"` +} + +func (a APIError) Error() string { + return fmt.Sprintf("%s: %s", a.Message, a.Result) +} diff --git a/providers/dns/dns_providers.go b/providers/dns/dns_providers.go index ff26a492..36a47772 100644 --- a/providers/dns/dns_providers.go +++ b/providers/dns/dns_providers.go @@ -31,6 +31,7 @@ import ( "github.com/go-acme/lego/v4/providers/dns/desec" "github.com/go-acme/lego/v4/providers/dns/designate" "github.com/go-acme/lego/v4/providers/dns/digitalocean" + "github.com/go-acme/lego/v4/providers/dns/directadmin" "github.com/go-acme/lego/v4/providers/dns/dnshomede" "github.com/go-acme/lego/v4/providers/dns/dnsimple" "github.com/go-acme/lego/v4/providers/dns/dnsmadeeasy" @@ -192,6 +193,8 @@ func NewDNSChallengeProviderByName(name string) (challenge.Provider, error) { return designate.NewDNSProvider() case "digitalocean": return digitalocean.NewDNSProvider() + case "directadmin": + return directadmin.NewDNSProvider() case "dnshomede": return dnshomede.NewDNSProvider() case "dnsimple":