From f432d2141e1b61490550a36a37ca2ad028641f86 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Mon, 22 Sep 2025 17:56:19 +0200 Subject: [PATCH] Add DNS provider for Hostinger (#2651) --- README.md | 50 ++-- cmd/zz_gen_cmd_dnshelp.go | 21 ++ docs/content/dns/zz_gen_hostinger.md | 67 ++++++ docs/data/zz_cli_help.toml | 2 +- providers/dns/hostinger/hostinger.go | 213 ++++++++++++++++++ providers/dns/hostinger/hostinger.toml | 22 ++ providers/dns/hostinger/hostinger_test.go | 166 ++++++++++++++ providers/dns/hostinger/internal/client.go | 141 ++++++++++++ .../dns/hostinger/internal/client_test.go | 130 +++++++++++ .../internal/fixtures/error_401.json | 4 + .../internal/fixtures/error_422.json | 10 + .../internal/fixtures/get_dns_records.json | 24 ++ .../fixtures/get_dns_records_acme.json | 27 +++ .../fixtures/update_dns_records-request.json | 28 +++ .../internal/fixtures/update_dns_records.json | 3 + .../update_dns_records_base-request.json | 25 ++ providers/dns/hostinger/internal/types.go | 39 ++++ providers/dns/zz_gen_dns_providers.go | 3 + 18 files changed, 949 insertions(+), 26 deletions(-) create mode 100644 docs/content/dns/zz_gen_hostinger.md create mode 100644 providers/dns/hostinger/hostinger.go create mode 100644 providers/dns/hostinger/hostinger.toml create mode 100644 providers/dns/hostinger/hostinger_test.go create mode 100644 providers/dns/hostinger/internal/client.go create mode 100644 providers/dns/hostinger/internal/client_test.go create mode 100644 providers/dns/hostinger/internal/fixtures/error_401.json create mode 100644 providers/dns/hostinger/internal/fixtures/error_422.json create mode 100644 providers/dns/hostinger/internal/fixtures/get_dns_records.json create mode 100644 providers/dns/hostinger/internal/fixtures/get_dns_records_acme.json create mode 100644 providers/dns/hostinger/internal/fixtures/update_dns_records-request.json create mode 100644 providers/dns/hostinger/internal/fixtures/update_dns_records.json create mode 100644 providers/dns/hostinger/internal/fixtures/update_dns_records_base-request.json create mode 100644 providers/dns/hostinger/internal/types.go diff --git a/README.md b/README.md index 20348d87b..9c2e81cfc 100644 --- a/README.md +++ b/README.md @@ -133,130 +133,130 @@ Detailed documentation is available [here](https://go-acme.github.io/lego/dns). Hetzner Hosting.de + Hostinger Hosttech HTTP request http.net - Huawei Cloud + Huawei Cloud Hurricane Electric DNS HyperOne IBM Cloud (SoftLayer) - IIJ DNS Platform Service + IIJ DNS Platform Service Infoblox Infomaniak Internet Initiative Japan - Internet.bs + Internet.bs INWX Ionos IPv64 - iwantmyname + iwantmyname Joker Joohoi's ACME-DNS KeyHelp - Liara + Liara Lima-City Linode (v4) Liquid Web - Loopia + Loopia LuaDNS Mail-in-a-Box ManageEngine CloudDNS - Manual + Manual Metaname Metaregistrar mijn.host - Mittwald + Mittwald myaddr.{tools,dev,io} MyDNS.jp MythicBeasts - Name.com + Name.com Namecheap Namesilo NearlyFreeSpeech.NET - Netcup + Netcup Netlify Nicmanager NIFCloud - Njalla + Njalla Nodion NS1 Open Telekom Cloud - Oracle Cloud + Oracle Cloud OVH plesk.com Porkbun - PowerDNS + PowerDNS Rackspace Rain Yun/雨云 RcodeZero - reg.ru + reg.ru Regfish RFC2136 RimuHosting - RU CENTER + RU CENTER Sakura Cloud Scaleway Selectel - Selectel v2 + Selectel v2 SelfHost.(de|eu) Servercow Shellrent - Simply.com + Simply.com Sonic Spaceship Stackpath - Technitium + Technitium Tencent Cloud DNS Tencent EdgeOne Timeweb Cloud - TransIP + TransIP UKFast SafeDNS Ultradns Variomedia - VegaDNS + VegaDNS Vercel Versio.[nl|eu|uk] VinylDNS - VK Cloud + VK Cloud Volcano Engine/火山引擎 Vscale Vultr - Webnames + Webnames Websupport WEDOS West.cn/西部数码 - Yandex 360 + Yandex 360 Yandex Cloud Yandex PDD Zone.ee - ZoneEdit + ZoneEdit Zonomi - diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index 5b0da36d4..573c355df 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -77,6 +77,7 @@ func allDNSCodes() string { "googledomains", "hetzner", "hostingde", + "hostinger", "hosttech", "httpnet", "httpreq", @@ -1559,6 +1560,26 @@ func displayDNSHelp(w io.Writer, name string) error { ew.writeln() ew.writeln(`More information: https://go-acme.github.io/lego/dns/hostingde`) + case "hostinger": + // generated from: providers/dns/hostinger/hostinger.toml + ew.writeln(`Configuration for Hostinger.`) + ew.writeln(`Code: 'hostinger'`) + ew.writeln(`Since: 'v4.27.0'`) + ew.writeln() + + ew.writeln(`Credentials:`) + ew.writeln(` - "HOSTINGER_API_TOKEN": API Token`) + ew.writeln() + + ew.writeln(`Additional Configuration:`) + ew.writeln(` - "HOSTINGER_HTTP_TIMEOUT": API request timeout in seconds (Default: 30)`) + ew.writeln(` - "HOSTINGER_POLLING_INTERVAL": Time between DNS propagation check in seconds (Default: 2)`) + ew.writeln(` - "HOSTINGER_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation in seconds (Default: 60)`) + ew.writeln(` - "HOSTINGER_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/hostinger`) + case "hosttech": // generated from: providers/dns/hosttech/hosttech.toml ew.writeln(`Configuration for Hosttech.`) diff --git a/docs/content/dns/zz_gen_hostinger.md b/docs/content/dns/zz_gen_hostinger.md new file mode 100644 index 000000000..193455f63 --- /dev/null +++ b/docs/content/dns/zz_gen_hostinger.md @@ -0,0 +1,67 @@ +--- +title: "Hostinger" +date: 2019-03-03T16:39:46+01:00 +draft: false +slug: hostinger +dnsprovider: + since: "v4.27.0" + code: "hostinger" + url: "https://www.hostinger.com/" +--- + + + + + + +Configuration for [Hostinger](https://www.hostinger.com/). + + + + +- Code: `hostinger` +- Since: v4.27.0 + + +Here is an example bash command using the Hostinger provider: + +```bash +HOSTINGER_API_TOKEN="xxxxxxxxxxxxxxxxxxxxx" \ +lego --email you@example.com --dns hostinger -d '*.example.com' -d example.com run +``` + + + + +## Credentials + +| Environment Variable Name | Description | +|-----------------------|-------------| +| `HOSTINGER_API_TOKEN` | API Token | + +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 | +|--------------------------------|-------------| +| `HOSTINGER_HTTP_TIMEOUT` | API request timeout in seconds (Default: 30) | +| `HOSTINGER_POLLING_INTERVAL` | Time between DNS propagation check in seconds (Default: 2) | +| `HOSTINGER_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation in seconds (Default: 60) | +| `HOSTINGER_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://developers.hostinger.com/#tag/dns-zone) + + + + diff --git a/docs/data/zz_cli_help.toml b/docs/data/zz_cli_help.toml index 6e788392c..c54206ffb 100644 --- a/docs/data/zz_cli_help.toml +++ b/docs/data/zz_cli_help.toml @@ -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, binarylane, 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, edgeone, 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, keyhelp, 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 + acme-dns, active24, alidns, allinkl, arvancloud, auroradns, autodns, axelname, azion, azure, azuredns, baiducloud, binarylane, 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, edgeone, efficientip, epik, exec, exoscale, f5xc, freemyip, gandi, gandiv5, gcloud, gcore, glesys, godaddy, googledomains, hetzner, hostingde, hostinger, hosttech, httpnet, httpreq, huaweicloud, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ipv64, iwantmyname, joker, keyhelp, 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 """ diff --git a/providers/dns/hostinger/hostinger.go b/providers/dns/hostinger/hostinger.go new file mode 100644 index 000000000..34033b5df --- /dev/null +++ b/providers/dns/hostinger/hostinger.go @@ -0,0 +1,213 @@ +// Package hostinger implements a DNS provider for solving the DNS-01 challenge using Hostinger. +package hostinger + +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/hostinger/internal" +) + +// Environment variables names. +const ( + envNamespace = "HOSTINGER_" + + EnvAPIToken = envNamespace + "API_TOKEN" + + 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 { + APIToken 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 Hostinger. +func NewDNSProvider() (*DNSProvider, error) { + values, err := env.Get(EnvAPIToken) + if err != nil { + return nil, fmt.Errorf("hostinger: %w", err) + } + + config := NewDefaultConfig() + config.APIToken = values[EnvAPIToken] + + return NewDNSProviderConfig(config) +} + +// NewDNSProviderConfig return a DNSProvider instance configured for Hostinger. +func NewDNSProviderConfig(config *Config) (*DNSProvider, error) { + if config == nil { + return nil, errors.New("hostinger: the configuration of the DNS provider is nil") + } + + client, err := internal.NewClient(config.APIToken) + if err != nil { + return nil, fmt.Errorf("hostinger: %w", err) + } + + if config.HTTPClient != nil { + client.HTTPClient = config.HTTPClient + } + + return &DNSProvider{ + config: config, + client: client, + }, nil +} + +// Present creates a TXT record using the specified parameters. +func (d *DNSProvider) Present(domain, token, keyAuth string) error { + info := dns01.GetChallengeInfo(domain, keyAuth) + + authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN) + if err != nil { + return fmt.Errorf("hostinger: could not find zone for domain %q: %w", domain, err) + } + + subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone) + if err != nil { + return fmt.Errorf("hostinger: %w", err) + } + + ctx := context.Background() + + recordSets, err := d.client.GetDNSRecords(ctx, dns01.UnFqdn(authZone)) + if err != nil { + return fmt.Errorf("hostinger: get DNS records: %w", err) + } + + var newRecordSet []internal.RecordSet + + var added bool + + for _, recordSet := range recordSets { + if recordSet.Name == subDomain && recordSet.Type == "TXT" { + recordSet.Records = append(recordSet.Records, internal.Record{Content: info.Value}) + } + + added = true + + newRecordSet = append(newRecordSet, recordSet) + } + + if !added { + newRecordSet = append(newRecordSet, internal.RecordSet{ + Name: subDomain, + Type: "TXT", + TTL: d.config.TTL, + Records: []internal.Record{ + {Content: info.Value}, + }, + }) + } + + request := internal.ZoneRequest{ + Overwrite: false, + Zone: newRecordSet, + } + + err = d.client.UpdateDNSRecords(ctx, dns01.UnFqdn(authZone), request) + if err != nil { + return fmt.Errorf("hostinger: update DNS records (add): %w", err) + } + + return nil +} + +// CleanUp removes the TXT record matching the specified parameters. +func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error { + info := dns01.GetChallengeInfo(domain, keyAuth) + + authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN) + if err != nil { + return fmt.Errorf("hostinger: could not find zone for domain %q: %w", domain, err) + } + + subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone) + if err != nil { + return fmt.Errorf("hostinger: %w", err) + } + + ctx := context.Background() + + recordSets, err := d.client.GetDNSRecords(ctx, dns01.UnFqdn(authZone)) + if err != nil { + return fmt.Errorf("hostinger: get DNS records: %w", err) + } + + var changed bool + + var newRecordSet []internal.RecordSet + + for _, recordSet := range recordSets { + if recordSet.Name == subDomain && recordSet.Type == "TXT" { + var rs []internal.Record + + for _, record := range recordSet.Records { + if record.Content == info.Value { + changed = true + } else { + rs = append(rs, record) + } + } + + recordSet.Records = rs + } + + newRecordSet = append(newRecordSet, recordSet) + } + + if !changed { + return nil + } + + request := internal.ZoneRequest{ + Overwrite: false, + Zone: newRecordSet, + } + + err = d.client.UpdateDNSRecords(ctx, dns01.UnFqdn(authZone), request) + if err != nil { + return fmt.Errorf("hostinger: update DNS records (delete): %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 +} diff --git a/providers/dns/hostinger/hostinger.toml b/providers/dns/hostinger/hostinger.toml new file mode 100644 index 000000000..f49e447ed --- /dev/null +++ b/providers/dns/hostinger/hostinger.toml @@ -0,0 +1,22 @@ +Name = "Hostinger" +Description = '''''' +URL = "https://www.hostinger.com/" +Code = "hostinger" +Since = "v4.27.0" + +Example = ''' +HOSTINGER_API_TOKEN="xxxxxxxxxxxxxxxxxxxxx" \ +lego --email you@example.com --dns hostinger -d '*.example.com' -d example.com run +''' + +[Configuration] + [Configuration.Credentials] + HOSTINGER_API_TOKEN = "API Token" + [Configuration.Additional] + HOSTINGER_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)" + HOSTINGER_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 60)" + HOSTINGER_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)" + HOSTINGER_HTTP_TIMEOUT = "API request timeout in seconds (Default: 30)" + +[Links] + API = "https://developers.hostinger.com/#tag/dns-zone" diff --git a/providers/dns/hostinger/hostinger_test.go b/providers/dns/hostinger/hostinger_test.go new file mode 100644 index 000000000..43285920b --- /dev/null +++ b/providers/dns/hostinger/hostinger_test.go @@ -0,0 +1,166 @@ +package hostinger + +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(EnvAPIToken).WithDomain(envDomain) + +func TestNewDNSProvider(t *testing.T) { + testCases := []struct { + desc string + envVars map[string]string + expected string + }{ + { + desc: "success", + envVars: map[string]string{ + EnvAPIToken: "secret", + }, + }, + { + desc: "missing API token", + envVars: map[string]string{ + EnvAPIToken: "", + }, + expected: "hostinger: some credentials information are missing: HOSTINGER_API_TOKEN", + }, + } + + 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 + apiToken string + expected string + }{ + { + desc: "success", + apiToken: "secret", + }, + { + desc: "missing API token", + expected: "hostinger: credentials missing", + }, + } + + for _, test := range testCases { + t.Run(test.desc, func(t *testing.T) { + config := NewDefaultConfig() + config.APIToken = test.apiToken + + p, err := NewDNSProviderConfig(config) + + if test.expected == "" { + require.NoError(t, err) + require.NotNil(t, p) + require.NotNil(t, p.config) + require.NotNil(t, p.client) + } else { + require.EqualError(t, err, test.expected) + } + }) + } +} + +func mockBuilder() *servermock.Builder[*DNSProvider] { + return servermock.NewBuilder( + func(server *httptest.Server) (*DNSProvider, error) { + config := NewDefaultConfig() + config.APIToken = "secret" + + p, err := NewDNSProviderConfig(config) + if err != nil { + return nil, err + } + + p.client.HTTPClient = server.Client() + p.client.BaseURL, _ = url.Parse(server.URL) + + return p, nil + }, + servermock.CheckHeader(). + WithJSONHeaders(). + WithAuthorization("Bearer secret"), + ) +} + +func TestDNSProvider_Present(t *testing.T) { + provider := mockBuilder(). + Route("GET /api/dns/v1/zones/example.com", + servermock.ResponseFromInternal("get_dns_records.json")). + Route("PUT /api/dns/v1/zones/example.com", + servermock.ResponseFromInternal("update_dns_records.json"), + servermock.CheckRequestJSONBodyFromInternal("update_dns_records-request.json")). + Build(t) + + err := provider.Present("example.com", "", "123d==") + require.NoError(t, err) +} + +func TestDNSProvider_CleanUp(t *testing.T) { + provider := mockBuilder(). + Route("GET /api/dns/v1/zones/example.com", + servermock.ResponseFromInternal("get_dns_records_acme.json")). + Route("PUT /api/dns/v1/zones/example.com", + servermock.ResponseFromInternal("update_dns_records.json"), + servermock.CheckRequestJSONBodyFromInternal("update_dns_records_base-request.json")). + Build(t) + + err := provider.CleanUp("example.com", "", "123d==") + require.NoError(t, err) +} + +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/hostinger/internal/client.go b/providers/dns/hostinger/internal/client.go new file mode 100644 index 000000000..b4681bb2b --- /dev/null +++ b/providers/dns/hostinger/internal/client.go @@ -0,0 +1,141 @@ +package internal + +import ( + "bytes" + "context" + "encoding/json" + "errors" + "fmt" + "io" + "net/http" + "net/url" + "time" + + "github.com/go-acme/lego/v4/providers/dns/internal/errutils" +) + +const defaultBaseURL = "https://developers.hostinger.com" + +const authorizationHeader = "Authorization" + +// Client the Hostinger API client. +type Client struct { + token string + + BaseURL *url.URL + HTTPClient *http.Client +} + +// NewClient creates a new Client. +func NewClient(token string) (*Client, error) { + if token == "" { + return nil, errors.New("credentials missing") + } + + baseURL, _ := url.Parse(defaultBaseURL) + + return &Client{ + token: token, + BaseURL: baseURL, + HTTPClient: &http.Client{Timeout: 10 * time.Second}, + }, nil +} + +// GetDNSRecords retrieves DNS zone records for a specific domain. +// https://developers.hostinger.com/#tag/dns-zone/get/api/dns/v1/zones/{domain} +func (c *Client) GetDNSRecords(ctx context.Context, domain string) ([]RecordSet, error) { + endpoint := c.BaseURL.JoinPath("/api/dns/v1/zones/", domain) + + req, err := newJSONRequest(ctx, http.MethodGet, endpoint, nil) + if err != nil { + return nil, err + } + + var result []RecordSet + err = c.do(req, &result) + if err != nil { + return nil, err + } + + return result, nil +} + +// UpdateDNSRecords updates DNS records for the selected domain. +// https://developers.hostinger.com/#tag/dns-zone/put/api/dns/v1/zones/{domain} +func (c *Client) UpdateDNSRecords(ctx context.Context, domain string, zone ZoneRequest) error { + endpoint := c.BaseURL.JoinPath("/api/dns/v1/zones/", domain) + + req, err := newJSONRequest(ctx, http.MethodPut, endpoint, zone) + if err != nil { + return err + } + + return c.do(req, nil) +} + +func (c *Client) do(req *http.Request, result any) error { + req.Header.Set(authorizationHeader, "Bearer "+c.token) + + 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 { + return errutils.NewUnexpectedStatusCodeError(req, resp.StatusCode, raw) + } + + return &errAPI +} diff --git a/providers/dns/hostinger/internal/client_test.go b/providers/dns/hostinger/internal/client_test.go new file mode 100644 index 000000000..a031b0b5c --- /dev/null +++ b/providers/dns/hostinger/internal/client_test.go @@ -0,0 +1,130 @@ +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( + 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("Authorization", "Bearer secret"), + ) +} + +func TestClient_GetDNSRecords(t *testing.T) { + client := mockBuilder(). + Route("GET /api/dns/v1/zones/example.com", + servermock.ResponseFromFixture("get_dns_records.json")). + Build(t) + + records, err := client.GetDNSRecords(t.Context(), "example.com") + require.NoError(t, err) + + expected := []RecordSet{ + { + Name: "_acme-challenge", + Records: []Record{{ + Content: "aaa", + }}, + TTL: 14400, + Type: "TXT", + }, + { + Name: "_acme-challenge", + Records: []Record{{ + Content: "example.com.", + }}, + TTL: 14400, + Type: "A", + }, + } + + assert.Equal(t, expected, records) +} + +func TestClient_GetDNSRecords_error(t *testing.T) { + client := mockBuilder(). + Route("GET /api/dns/v1/zones/example.com", + servermock.ResponseFromFixture("error_401.json"). + WithStatusCode(http.StatusUnauthorized)). + Build(t) + + _, err := client.GetDNSRecords(t.Context(), "example.com") + + require.EqualError(t, err, "26a91bd9-f8c8-4a83-9df9-83e23d696fe3: Unauthenticated") +} + +func TestClient_UpdateDNSRecords(t *testing.T) { + client := mockBuilder(). + Route("PUT /api/dns/v1/zones/example.com", + servermock.ResponseFromFixture("update_dns_records.json"), + servermock.CheckRequestJSONBodyFromFixture("update_dns_records-request.json")). + Build(t) + + zone := ZoneRequest{ + Overwrite: false, + Zone: []RecordSet{ + { + Name: "_acme-challenge", + Records: []Record{ + {Content: "aaa"}, + {Content: "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY"}, + }, + TTL: 14400, + Type: "TXT", + }, + { + Name: "_acme-challenge", + Records: []Record{{ + Content: "example.com.", + }}, + TTL: 14400, + Type: "A", + }, + }, + } + + err := client.UpdateDNSRecords(t.Context(), "example.com", zone) + require.NoError(t, err) +} + +func TestClient_UpdateDNSRecords_error(t *testing.T) { + client := mockBuilder(). + Route("PUT /api/dns/v1/zones/example.com", + servermock.ResponseFromFixture("error_422.json"). + WithStatusCode(http.StatusBadRequest)). + Build(t) + + zone := ZoneRequest{ + Zone: []RecordSet{{ + Name: "_acme-challenge", + Records: []Record{{ + Content: "aaa", + }}, + TTL: 14400, + Type: "TXT", + }}, + } + + err := client.UpdateDNSRecords(t.Context(), "example.com", zone) + + require.EqualError(t, err, "26a91bd9-f8c8-4a83-9df9-83e23d696fe3: The name field is required. (and 1 more error): field_1: The field_1 field is required., The field_1 must be a number.") +} diff --git a/providers/dns/hostinger/internal/fixtures/error_401.json b/providers/dns/hostinger/internal/fixtures/error_401.json new file mode 100644 index 000000000..1b7381ff6 --- /dev/null +++ b/providers/dns/hostinger/internal/fixtures/error_401.json @@ -0,0 +1,4 @@ +{ + "message": "Unauthenticated", + "correlation_id": "26a91bd9-f8c8-4a83-9df9-83e23d696fe3" +} diff --git a/providers/dns/hostinger/internal/fixtures/error_422.json b/providers/dns/hostinger/internal/fixtures/error_422.json new file mode 100644 index 000000000..6ec286823 --- /dev/null +++ b/providers/dns/hostinger/internal/fixtures/error_422.json @@ -0,0 +1,10 @@ +{ + "message": "The name field is required. (and 1 more error)", + "errors": { + "field_1": [ + "The field_1 field is required.", + "The field_1 must be a number." + ] + }, + "correlation_id": "26a91bd9-f8c8-4a83-9df9-83e23d696fe3" +} diff --git a/providers/dns/hostinger/internal/fixtures/get_dns_records.json b/providers/dns/hostinger/internal/fixtures/get_dns_records.json new file mode 100644 index 000000000..e51edd4dc --- /dev/null +++ b/providers/dns/hostinger/internal/fixtures/get_dns_records.json @@ -0,0 +1,24 @@ +[ + { + "name": "_acme-challenge", + "records": [ + { + "content": "aaa", + "is_disabled": false + } + ], + "ttl": 14400, + "type": "TXT" + }, + { + "name": "_acme-challenge", + "records": [ + { + "content": "example.com.", + "is_disabled": false + } + ], + "ttl": 14400, + "type": "A" + } +] diff --git a/providers/dns/hostinger/internal/fixtures/get_dns_records_acme.json b/providers/dns/hostinger/internal/fixtures/get_dns_records_acme.json new file mode 100644 index 000000000..99a574514 --- /dev/null +++ b/providers/dns/hostinger/internal/fixtures/get_dns_records_acme.json @@ -0,0 +1,27 @@ +[ + { + "name": "_acme-challenge", + "records": [ + { + "content": "aaa", + "is_disabled": false + }, + { + "content": "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY" + } + ], + "ttl": 14400, + "type": "TXT" + }, + { + "name": "_acme-challenge", + "records": [ + { + "content": "example.com.", + "is_disabled": false + } + ], + "ttl": 14400, + "type": "A" + } +] diff --git a/providers/dns/hostinger/internal/fixtures/update_dns_records-request.json b/providers/dns/hostinger/internal/fixtures/update_dns_records-request.json new file mode 100644 index 000000000..83d4ab6fb --- /dev/null +++ b/providers/dns/hostinger/internal/fixtures/update_dns_records-request.json @@ -0,0 +1,28 @@ +{ + "overwrite": false, + "zone": [ + { + "name": "_acme-challenge", + "records": [ + { + "content": "aaa" + }, + { + "content": "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY" + } + ], + "ttl": 14400, + "type": "TXT" + }, + { + "name": "_acme-challenge", + "records": [ + { + "content": "example.com." + } + ], + "ttl": 14400, + "type": "A" + } + ] +} diff --git a/providers/dns/hostinger/internal/fixtures/update_dns_records.json b/providers/dns/hostinger/internal/fixtures/update_dns_records.json new file mode 100644 index 000000000..11d2582b4 --- /dev/null +++ b/providers/dns/hostinger/internal/fixtures/update_dns_records.json @@ -0,0 +1,3 @@ +{ + "message": "Request accepted" +} diff --git a/providers/dns/hostinger/internal/fixtures/update_dns_records_base-request.json b/providers/dns/hostinger/internal/fixtures/update_dns_records_base-request.json new file mode 100644 index 000000000..a348db233 --- /dev/null +++ b/providers/dns/hostinger/internal/fixtures/update_dns_records_base-request.json @@ -0,0 +1,25 @@ +{ + "overwrite": false, + "zone": [ + { + "name": "_acme-challenge", + "records": [ + { + "content": "aaa" + } + ], + "ttl": 14400, + "type": "TXT" + }, + { + "name": "_acme-challenge", + "records": [ + { + "content": "example.com." + } + ], + "ttl": 14400, + "type": "A" + } + ] +} diff --git a/providers/dns/hostinger/internal/types.go b/providers/dns/hostinger/internal/types.go new file mode 100644 index 000000000..a79e9f5dc --- /dev/null +++ b/providers/dns/hostinger/internal/types.go @@ -0,0 +1,39 @@ +package internal + +import ( + "fmt" + "strings" +) + +type APIError struct { + Message string `json:"message,omitempty"` + Errors map[string][]string `json:"errors,omitempty"` + CorrelationID string `json:"correlation_id,omitempty"` +} + +func (a *APIError) Error() string { + msg := fmt.Sprintf("%s: %s", a.CorrelationID, a.Message) + + for field, values := range a.Errors { + msg += fmt.Sprintf(": %s: %s", field, strings.Join(values, ", ")) + } + + return msg +} + +type ZoneRequest struct { + Overwrite bool `json:"overwrite"` + Zone []RecordSet `json:"zone,omitempty"` +} + +type RecordSet struct { + Name string `json:"name,omitempty"` + Records []Record `json:"records,omitempty"` + TTL int `json:"ttl,omitempty"` + Type string `json:"type,omitempty"` +} + +type Record struct { + Content string `json:"content,omitempty"` + IsDisabled bool `json:"is_disabled,omitempty"` +} diff --git a/providers/dns/zz_gen_dns_providers.go b/providers/dns/zz_gen_dns_providers.go index 04e7eb5e7..1e6586e89 100644 --- a/providers/dns/zz_gen_dns_providers.go +++ b/providers/dns/zz_gen_dns_providers.go @@ -71,6 +71,7 @@ import ( "github.com/go-acme/lego/v4/providers/dns/googledomains" "github.com/go-acme/lego/v4/providers/dns/hetzner" "github.com/go-acme/lego/v4/providers/dns/hostingde" + "github.com/go-acme/lego/v4/providers/dns/hostinger" "github.com/go-acme/lego/v4/providers/dns/hosttech" "github.com/go-acme/lego/v4/providers/dns/httpnet" "github.com/go-acme/lego/v4/providers/dns/httpreq" @@ -302,6 +303,8 @@ func NewDNSChallengeProviderByName(name string) (challenge.Provider, error) { return hetzner.NewDNSProvider() case "hostingde": return hostingde.NewDNSProvider() + case "hostinger": + return hostinger.NewDNSProvider() case "hosttech": return hosttech.NewDNSProvider() case "httpnet":