diff --git a/README.md b/README.md index 51944b9d8..303f8824b 100644 --- a/README.md +++ b/README.md @@ -193,70 +193,70 @@ Detailed documentation is available [here](https://go-acme.github.io/lego/dns). Nodion NS1 + Octenium Open Telekom Cloud Oracle Cloud OVH - plesk.com + plesk.com Porkbun PowerDNS Rackspace - Rain Yun/雨云 + Rain Yun/雨云 RcodeZero reg.ru Regfish - RFC2136 + RFC2136 RimuHosting RU CENTER Sakura Cloud - Scaleway + Scaleway Selectel Selectel v2 SelfHost.(de|eu) - Servercow + Servercow Shellrent Simply.com Sonic - Spaceship + Spaceship Stackpath Technitium Tencent Cloud DNS - Tencent EdgeOne + Tencent EdgeOne Timeweb Cloud TransIP UKFast SafeDNS - Ultradns + Ultradns Variomedia VegaDNS Vercel - Versio.[nl|eu|uk] + Versio.[nl|eu|uk] VinylDNS VK Cloud Volcano Engine/火山引擎 - Vscale + Vscale Vultr Webnames Websupport - WEDOS + WEDOS West.cn/西部数码 Yandex 360 Yandex Cloud - Yandex PDD + Yandex PDD Zone.ee ZoneEdit Zonomi - diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index f3f603cf1..92f7b5a07 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -125,6 +125,7 @@ func allDNSCodes() string { "njalla", "nodion", "ns1", + "octenium", "oraclecloud", "otc", "ovh", @@ -2574,6 +2575,26 @@ func displayDNSHelp(w io.Writer, name string) error { ew.writeln() ew.writeln(`More information: https://go-acme.github.io/lego/dns/ns1`) + case "octenium": + // generated from: providers/dns/octenium/octenium.toml + ew.writeln(`Configuration for Octenium.`) + ew.writeln(`Code: 'octenium'`) + ew.writeln(`Since: 'v4.27.0'`) + ew.writeln() + + ew.writeln(`Credentials:`) + ew.writeln(` - "OCTENIUM_API_KEY": API key`) + ew.writeln() + + ew.writeln(`Additional Configuration:`) + ew.writeln(` - "OCTENIUM_HTTP_TIMEOUT": API request timeout in seconds (Default: 30)`) + ew.writeln(` - "OCTENIUM_POLLING_INTERVAL": Time between DNS propagation check in seconds (Default: 2)`) + ew.writeln(` - "OCTENIUM_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation in seconds (Default: 60)`) + ew.writeln(` - "OCTENIUM_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/octenium`) + case "oraclecloud": // generated from: providers/dns/oraclecloud/oraclecloud.toml ew.writeln(`Configuration for Oracle Cloud.`) diff --git a/docs/content/dns/zz_gen_octenium.md b/docs/content/dns/zz_gen_octenium.md new file mode 100644 index 000000000..874c4e780 --- /dev/null +++ b/docs/content/dns/zz_gen_octenium.md @@ -0,0 +1,67 @@ +--- +title: "Octenium" +date: 2019-03-03T16:39:46+01:00 +draft: false +slug: octenium +dnsprovider: + since: "v4.27.0" + code: "octenium" + url: "https://octenium.com/" +--- + + + + + + +Configuration for [Octenium](https://octenium.com/). + + + + +- Code: `octenium` +- Since: v4.27.0 + + +Here is an example bash command using the Octenium provider: + +```bash +OCTENIUM_API_KEY="xxx" \ +lego --email you@example.com --dns octenium -d '*.example.com' -d example.com run +``` + + + + +## Credentials + +| Environment Variable Name | Description | +|-----------------------|-------------| +| `OCTENIUM_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 | +|--------------------------------|-------------| +| `OCTENIUM_HTTP_TIMEOUT` | API request timeout in seconds (Default: 30) | +| `OCTENIUM_POLLING_INTERVAL` | Time between DNS propagation check in seconds (Default: 2) | +| `OCTENIUM_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation in seconds (Default: 60) | +| `OCTENIUM_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://octenium.com/api#tag/Domains-DNS) + + + + diff --git a/docs/data/zz_cli_help.toml b/docs/data/zz_cli_help.toml index edcf0b7a7..8943057d0 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, beget, 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 + acme-dns, active24, alidns, allinkl, arvancloud, auroradns, autodns, axelname, azion, azure, azuredns, baiducloud, beget, 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, 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, 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/octenium/fixtures/add_dns_record.json b/providers/dns/octenium/fixtures/add_dns_record.json new file mode 100644 index 000000000..25edcdf11 --- /dev/null +++ b/providers/dns/octenium/fixtures/add_dns_record.json @@ -0,0 +1,14 @@ +{ + "api-status": "success", + "api-response": { + "record": { + "type": "TXT", + "name": "_acme-challenge.example.com.", + "ttl": 120, + "value": "w6uP8Tcg6K2QR905Rms8iXTlksL6OD1KOWBxTK7wxPI", + "raw": { + "txtdata": "w6uP8Tcg6K2QR905Rms8iXTlksL6OD1KOWBxTK7wxPI" + } + } + } +} diff --git a/providers/dns/octenium/fixtures/delete_dns_record.json b/providers/dns/octenium/fixtures/delete_dns_record.json new file mode 100644 index 000000000..2aa9415cc --- /dev/null +++ b/providers/dns/octenium/fixtures/delete_dns_record.json @@ -0,0 +1,11 @@ +{ + "api-status": "success", + "api-response": { + "deleted": { + "count": 1, + "lines": [ + 123 + ] + } + } +} diff --git a/providers/dns/octenium/fixtures/list_dns_records.json b/providers/dns/octenium/fixtures/list_dns_records.json new file mode 100644 index 000000000..405afff11 --- /dev/null +++ b/providers/dns/octenium/fixtures/list_dns_records.json @@ -0,0 +1,27 @@ +{ + "api-status": "success", + "api-response": { + "records": [ + { + "line": 31, + "type": "TXT", + "name": "_dmarc.example.com.", + "ttl": 300, + "value": "xxx", + "raw": { + "txtdata": "xxx" + } + }, + { + "line": 123, + "type": "TXT", + "name": "_acme-challenge.example.com.", + "ttl": 300, + "value": "w6uP8Tcg6K2QR905Rms8iXTlksL6OD1KOWBxTK7wxPI", + "raw": { + "txtdata": "w6uP8Tcg6K2QR905Rms8iXTlksL6OD1KOWBxTK7wxPI" + } + } + ] + } +} diff --git a/providers/dns/octenium/fixtures/list_domains.json b/providers/dns/octenium/fixtures/list_domains.json new file mode 100644 index 000000000..a62febcda --- /dev/null +++ b/providers/dns/octenium/fixtures/list_domains.json @@ -0,0 +1,13 @@ +{ + "api-status": "success", + "api-response": { + "domains": { + "2976": { + "domain-name": "example.com", + "registration-date": "21\/08\/2025", + "expiration-date": "-", + "status": "active" + } + } + } +} diff --git a/providers/dns/octenium/internal/client.go b/providers/dns/octenium/internal/client.go new file mode 100644 index 000000000..474770aeb --- /dev/null +++ b/providers/dns/octenium/internal/client.go @@ -0,0 +1,204 @@ +package internal + +import ( + "context" + "encoding/json" + "errors" + "fmt" + "io" + "net/http" + "net/url" + "strconv" + "strings" + "time" + + "github.com/go-acme/lego/v4/providers/dns/internal/errutils" + querystring "github.com/google/go-querystring/query" +) + +const defaultBaseURL = "https://api.panel.octenium.com/" + +const statusSuccess = "success" + +// Client the Octenium 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 +} + +// ListDomains retrieves a list of domains. +// https://octenium.com/api#tag/Domains/operation/listdomains +func (c *Client) ListDomains(ctx context.Context, domain string) (map[string]Domain, error) { + endpoint := c.BaseURL.JoinPath("domains") + + data := endpoint.Query() + data.Set("domain-name", domain) + endpoint.RawQuery = data.Encode() + + req, err := newRequest(ctx, http.MethodGet, endpoint, nil) + if err != nil { + return nil, err + } + + result := &DomainsResponse{} + + err = c.do(req, result) + if err != nil { + return nil, err + } + + return result.Domains, nil +} + +// ListDNSRecords retrieves a list of DNS records. +// https://octenium.com/api#tag/Domains-DNS/operation/domains-dns-records-list +func (c *Client) ListDNSRecords(ctx context.Context, orderID, recordType string) ([]Record, error) { + endpoint := c.BaseURL.JoinPath("domains", "dns-records", "list") + + data := make(url.Values) + data.Set("order-id", orderID) + data.Set("types[]", recordType) + + req, err := newRequest(ctx, http.MethodPost, endpoint, data) + if err != nil { + return nil, err + } + + result := &ListRecordsResponse{} + + err = c.do(req, result) + if err != nil { + return nil, err + } + + return result.Records, nil +} + +// AddDNSRecord adds a DNS record. +// https://octenium.com/api#tag/Domains-DNS/operation/domains-dns-records-add +func (c *Client) AddDNSRecord(ctx context.Context, orderID string, record Record) (*Record, error) { + endpoint := c.BaseURL.JoinPath("domains", "dns-records", "add") + + data, err := querystring.Values(record) + if err != nil { + return nil, err + } + + data.Set("order-id", orderID) + + req, err := newRequest(ctx, http.MethodPost, endpoint, data) + if err != nil { + return nil, err + } + + result := &AddRecordResponse{} + + err = c.do(req, result) + if err != nil { + return nil, err + } + + return result.Record, nil +} + +// DeleteDNSRecord deletes a DNS record. +// https://octenium.com/api#tag/Domains-DNS/operation/domains-dns-records-delete +func (c *Client) DeleteDNSRecord(ctx context.Context, orderID string, recordID int) (*DeletedRecordInfo, error) { + endpoint := c.BaseURL.JoinPath("domains", "dns-records", "delete") + + data := make(url.Values) + data.Set("order-id", orderID) + data.Set("line", strconv.Itoa(recordID)) + + req, err := newRequest(ctx, http.MethodPost, endpoint, data) + if err != nil { + return nil, err + } + + result := &DeleteRecordResponse{} + + err = c.do(req, result) + if err != nil { + return nil, err + } + + return result.Deleted, nil +} + +func (c *Client) do(req *http.Request, result any) error { + req.Header.Set("X-Api-Key", 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 { + raw, _ := io.ReadAll(resp.Body) + + return errutils.NewUnexpectedStatusCodeError(req, resp.StatusCode, raw) + } + + raw, err := io.ReadAll(resp.Body) + if err != nil { + return errutils.NewReadResponseError(req, resp.StatusCode, err) + } + + var response APIResponse + + err = json.Unmarshal(raw, &response) + if err != nil { + return errutils.NewUnmarshalError(req, resp.StatusCode, raw, err) + } + + if response.Status != statusSuccess { + return fmt.Errorf("unexpected status: %s: %s", response.Status, response.Error) + } + + err = json.Unmarshal(response.Response, result) + if err != nil { + return errutils.NewUnmarshalError(req, resp.StatusCode, response.Response, err) + } + + return nil +} + +func newRequest(ctx context.Context, method string, endpoint *url.URL, payload url.Values) (*http.Request, error) { + var body io.Reader = http.NoBody + + if method == http.MethodPost && payload != nil { + body = strings.NewReader(payload.Encode()) + } + + req, err := http.NewRequestWithContext(ctx, method, endpoint.String(), body) + if err != nil { + return nil, fmt.Errorf("unable to create request: %w", err) + } + + req.Header.Set("Accept", "application/json") + + if method == http.MethodPost && payload != nil { + req.Header.Set("Content-Type", "application/x-www-form-urlencoded") + } + + return req, nil +} diff --git a/providers/dns/octenium/internal/client_test.go b/providers/dns/octenium/internal/client_test.go new file mode 100644 index 000000000..ff1b21961 --- /dev/null +++ b/providers/dns/octenium/internal/client_test.go @@ -0,0 +1,224 @@ +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(). + WithAccept("application/json"). + With("X-Api-Key", "secret"), + ) +} + +func TestClient_ListDomains(t *testing.T) { + client := mockBuilder(). + Route("GET /domains", + servermock.ResponseFromFixture("list_domains.json"), + servermock.CheckQueryParameter().Strict(). + With("domain-name", "example.com")). + Build(t) + + domains, err := client.ListDomains(t.Context(), "example.com") + require.NoError(t, err) + + expected := map[string]Domain{ + "2976": {DomainName: "example.com", RegistrationDate: "12/09/2021", ExpirationDate: "12/09/2024", Status: "active"}, + "2977": {DomainName: "example.org", RegistrationDate: "01/10/2021", ExpirationDate: "01/10/2024", Status: "active"}, + "2978": {DomainName: "example.net", RegistrationDate: "21/08/2025", ExpirationDate: "-", Status: "active"}, + } + + assert.Equal(t, expected, domains) +} + +func TestClient_ListDomains_error(t *testing.T) { + client := mockBuilder(). + Route("GET /domains", + servermock.Noop().WithStatusCode(http.StatusBadRequest)). + Build(t) + + _, err := client.ListDomains(t.Context(), "example.com") + require.EqualError(t, err, "unexpected status code: [status code: 400] body: ") +} + +func TestClient_ListDomains_api_error(t *testing.T) { + client := mockBuilder(). + Route("GET /domains", + servermock.ResponseFromFixture("error.json")). + Build(t) + + _, err := client.ListDomains(t.Context(), "example.com") + require.EqualError(t, err, "unexpected status: error: missing required fields (type, name, ttl)") +} + +func TestClient_ListDNSRecords(t *testing.T) { + client := mockBuilder(). + Route("POST /domains/dns-records/list", + servermock.ResponseFromFixture("list_dns_records.json"), + servermock.CheckHeader(). + WithContentType("application/x-www-form-urlencoded"), + servermock.CheckForm().Strict(). + With("order-id", "abc"). + With("types[]", "TXT")). + Build(t) + + records, err := client.ListDNSRecords(t.Context(), "abc", "TXT") + require.NoError(t, err) + + expected := []Record{ + {ID: 15, Type: "A", Name: "example.com.", TTL: 14400, Value: "203.0.113.10"}, + {ID: 22, Type: "MX", Name: "example.com.", TTL: 14400, Value: "10 mail.example.com."}, + {ID: 31, Type: "TXT", Name: "_dmarc.example.com.", TTL: 300, Value: "v=DMARC1; p=none; rua=mailto:dmarc@example.com"}, + } + + assert.Equal(t, expected, records) +} + +func TestClient_ListDNSRecords_error(t *testing.T) { + client := mockBuilder(). + Route("POST /domains/dns-records/list", + servermock.Noop().WithStatusCode(http.StatusBadRequest)). + Build(t) + + _, err := client.ListDNSRecords(t.Context(), "abc", "TXT") + require.EqualError(t, err, "unexpected status code: [status code: 400] body: ") +} + +func TestClient_ListDNSRecords_api_error(t *testing.T) { + client := mockBuilder(). + Route("POST /domains/dns-records/list", + servermock.ResponseFromFixture("error.json")). + Build(t) + + _, err := client.ListDNSRecords(t.Context(), "abc", "TXT") + require.EqualError(t, err, "unexpected status: error: missing required fields (type, name, ttl)") +} + +func TestClient_AddDNSRecord(t *testing.T) { + client := mockBuilder(). + Route("POST /domains/dns-records/add", + servermock.ResponseFromFixture("add_dns_record.json"), + servermock.CheckHeader(). + WithContentType("application/x-www-form-urlencoded"), + servermock.CheckForm().Strict(). + With("order-id", "abc"). + With("name", "example.com."). + With("ttl", "120"). + With("type", "TXT"). + With("value", "txtTXTtxt")). + Build(t) + + record := Record{ + Type: "TXT", + Name: "example.com.", + TTL: 120, + Value: "txtTXTtxt", + } + + result, err := client.AddDNSRecord(t.Context(), "abc", record) + require.NoError(t, err) + + expected := &Record{ + Type: "A", + Name: "example.com.", + TTL: 14400, + Value: "203.0.113.10", + } + + assert.Equal(t, expected, result) +} + +func TestClient_AddDNSRecord_error(t *testing.T) { + client := mockBuilder(). + Route("POST /domains/dns-records/add", + servermock.Noop().WithStatusCode(http.StatusBadRequest)). + Build(t) + + record := Record{ + Type: "TXT", + Name: "example.com.", + TTL: 120, + Value: "txtTXTtxt", + } + + _, err := client.AddDNSRecord(t.Context(), "abc", record) + require.EqualError(t, err, "unexpected status code: [status code: 400] body: ") +} + +func TestClient_AddDNSRecord_api_error(t *testing.T) { + client := mockBuilder(). + Route("POST /domains/dns-records/add", + servermock.ResponseFromFixture("error.json")). + Build(t) + + record := Record{ + Type: "TXT", + Name: "example.com.", + TTL: 120, + Value: "txtTXTtxt", + } + + _, err := client.AddDNSRecord(t.Context(), "abc", record) + require.EqualError(t, err, "unexpected status: error: missing required fields (type, name, ttl)") +} + +func TestClient_DeleteDNSRecord(t *testing.T) { + client := mockBuilder(). + Route("POST /domains/dns-records/delete", + servermock.ResponseFromFixture("delete_dns_record.json"), + servermock.CheckHeader(). + WithContentType("application/x-www-form-urlencoded"), + servermock.CheckForm().Strict(). + With("order-id", "abc"). + With("line", "123")). + Build(t) + + result, err := client.DeleteDNSRecord(t.Context(), "abc", 123) + require.NoError(t, err) + + expected := &DeletedRecordInfo{ + Count: 1, + Lines: []int{15}, + } + + assert.Equal(t, expected, result) +} + +func TestClient_DeleteDNSRecord_error(t *testing.T) { + client := mockBuilder(). + Route("POST /domains/dns-records/delete", + servermock.Noop().WithStatusCode(http.StatusBadRequest)). + Build(t) + + _, err := client.DeleteDNSRecord(t.Context(), "abc", 123) + require.EqualError(t, err, "unexpected status code: [status code: 400] body: ") +} + +func TestClient_DeleteDNSRecord_api_error(t *testing.T) { + client := mockBuilder(). + Route("POST /domains/dns-records/delete", + servermock.ResponseFromFixture("error.json")). + Build(t) + + _, err := client.DeleteDNSRecord(t.Context(), "abc", 123) + require.EqualError(t, err, "unexpected status: error: missing required fields (type, name, ttl)") +} diff --git a/providers/dns/octenium/internal/fixtures/add_dns_record.json b/providers/dns/octenium/internal/fixtures/add_dns_record.json new file mode 100644 index 000000000..6c73ea1f9 --- /dev/null +++ b/providers/dns/octenium/internal/fixtures/add_dns_record.json @@ -0,0 +1,14 @@ +{ + "api-status": "success", + "api-response": { + "record": { + "type": "A", + "name": "example.com.", + "ttl": 14400, + "value": "203.0.113.10", + "raw": { + "address": "203.0.113.10" + } + } + } +} diff --git a/providers/dns/octenium/internal/fixtures/delete_dns_record.json b/providers/dns/octenium/internal/fixtures/delete_dns_record.json new file mode 100644 index 000000000..0d4692ffd --- /dev/null +++ b/providers/dns/octenium/internal/fixtures/delete_dns_record.json @@ -0,0 +1,11 @@ +{ + "api-status": "success", + "api-response": { + "deleted": { + "count": 1, + "lines": [ + 15 + ] + } + } +} diff --git a/providers/dns/octenium/internal/fixtures/error.json b/providers/dns/octenium/internal/fixtures/error.json new file mode 100644 index 000000000..85a90e425 --- /dev/null +++ b/providers/dns/octenium/internal/fixtures/error.json @@ -0,0 +1,5 @@ +{ + "api-status": "error", + "api-response": [], + "api-error": "missing required fields (type, name, ttl)" +} diff --git a/providers/dns/octenium/internal/fixtures/list_dns_records.json b/providers/dns/octenium/internal/fixtures/list_dns_records.json new file mode 100644 index 000000000..8fa60d86f --- /dev/null +++ b/providers/dns/octenium/internal/fixtures/list_dns_records.json @@ -0,0 +1,38 @@ +{ + "api-status": "success", + "api-response": { + "records": [ + { + "line": 15, + "type": "A", + "name": "example.com.", + "ttl": 14400, + "value": "203.0.113.10", + "raw": { + "address": "203.0.113.10" + } + }, + { + "line": 22, + "type": "MX", + "name": "example.com.", + "ttl": 14400, + "value": "10 mail.example.com.", + "raw": { + "preference": 10, + "exchange": "mail.example.com." + } + }, + { + "line": 31, + "type": "TXT", + "name": "_dmarc.example.com.", + "ttl": 300, + "value": "v=DMARC1; p=none; rua=mailto:dmarc@example.com", + "raw": { + "txtdata": "v=DMARC1; p=none; rua=mailto:dmarc@example.com" + } + } + ] + } +} diff --git a/providers/dns/octenium/internal/fixtures/list_domains.json b/providers/dns/octenium/internal/fixtures/list_domains.json new file mode 100644 index 000000000..b10b705c9 --- /dev/null +++ b/providers/dns/octenium/internal/fixtures/list_domains.json @@ -0,0 +1,25 @@ +{ + "api-status": "success", + "api-response": { + "domains": { + "2976": { + "domain-name": "example.com", + "registration-date": "12/09/2021", + "expiration-date": "12/09/2024", + "status": "active" + }, + "2977": { + "domain-name": "example.org", + "registration-date": "01/10/2021", + "expiration-date": "01/10/2024", + "status": "active" + }, + "2978": { + "domain-name": "example.net", + "registration-date": "21\/08\/2025", + "expiration-date": "-", + "status": "active" + } + } + } +} diff --git a/providers/dns/octenium/internal/types.go b/providers/dns/octenium/internal/types.go new file mode 100644 index 000000000..a31e40921 --- /dev/null +++ b/providers/dns/octenium/internal/types.go @@ -0,0 +1,45 @@ +package internal + +import "encoding/json" + +type APIResponse struct { + Status string `json:"api-status,omitempty"` + Response json.RawMessage `json:"api-response,omitempty"` + Error string `json:"api-error,omitempty"` +} + +type Domain struct { + DomainName string `json:"domain-name,omitempty"` + RegistrationDate string `json:"registration-date,omitempty"` + ExpirationDate string `json:"expiration-date,omitempty"` + Status string `json:"status,omitempty"` +} + +type Record struct { + ID int `json:"line,omitempty" url:"-"` + Type string `json:"type,omitempty" url:"type,omitempty"` + Name string `json:"name,omitempty" url:"name,omitempty"` + TTL int `json:"ttl,omitempty" url:"ttl,omitempty"` + Value string `json:"value,omitempty" url:"value,omitempty"` +} + +type DomainsResponse struct { + Domains map[string]Domain `json:"domains,omitempty"` +} + +type AddRecordResponse struct { + Record *Record `json:"record,omitempty"` +} + +type ListRecordsResponse struct { + Records []Record `json:"records,omitempty"` +} + +type DeleteRecordResponse struct { + Deleted *DeletedRecordInfo `json:"deleted,omitempty"` +} + +type DeletedRecordInfo struct { + Count int `json:"count,omitempty"` + Lines []int `json:"lines,omitempty"` +} diff --git a/providers/dns/octenium/octenium.go b/providers/dns/octenium/octenium.go new file mode 100644 index 000000000..1ace82bf5 --- /dev/null +++ b/providers/dns/octenium/octenium.go @@ -0,0 +1,198 @@ +// Package octenium implements a DNS provider for solving the DNS-01 challenge using Octenium. +package octenium + +import ( + "context" + "errors" + "fmt" + "net/http" + "sync" + "time" + + "github.com/go-acme/lego/v4/challenge/dns01" + "github.com/go-acme/lego/v4/log" + "github.com/go-acme/lego/v4/platform/config/env" + "github.com/go-acme/lego/v4/providers/dns/octenium/internal" + "github.com/hashicorp/go-retryablehttp" +) + +// Environment variables names. +const ( + envNamespace = "OCTENIUM_" + + 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 + + domainIDs map[string]string + domainIDsMu sync.Mutex +} + +// NewDNSProvider returns a DNSProvider instance configured for Octenium. +func NewDNSProvider() (*DNSProvider, error) { + values, err := env.Get(EnvAPIKey) + if err != nil { + return nil, fmt.Errorf("octenium: %w", err) + } + + config := NewDefaultConfig() + config.APIKey = values[EnvAPIKey] + + return NewDNSProviderConfig(config) +} + +// NewDNSProviderConfig return a DNSProvider instance configured for Octenium. +func NewDNSProviderConfig(config *Config) (*DNSProvider, error) { + if config == nil { + return nil, errors.New("octenium: the configuration of the DNS provider is nil") + } + + client, err := internal.NewClient(config.APIKey) + if err != nil { + return nil, fmt.Errorf("octenium: %w", err) + } + + if config.HTTPClient != nil { + client.HTTPClient = config.HTTPClient + } + + retryClient := retryablehttp.NewClient() + retryClient.RetryMax = 5 + if config.HTTPClient != nil { + retryClient.HTTPClient = config.HTTPClient + } + retryClient.Logger = log.Logger + + return &DNSProvider{ + config: config, + client: client, + domainIDs: make(map[string]string), + }, 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("octenium: could not find zone for domain '%s': %w", domain, err) + } + + domainID, err := d.getDomainID(ctx, authZone) + if err != nil { + return fmt.Errorf("octenium: get domain ID: %w", err) + } + + d.domainIDsMu.Lock() + d.domainIDs[token] = domainID + d.domainIDsMu.Unlock() + + record := internal.Record{ + Type: "TXT", + Name: info.EffectiveFQDN, + TTL: d.config.TTL, + Value: info.Value, + } + + _, err = d.client.AddDNSRecord(ctx, domainID, record) + if err != nil { + return fmt.Errorf("octenium: add record: %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) + + d.domainIDsMu.Lock() + domainID, ok := d.domainIDs[token] + d.domainIDsMu.Unlock() + if !ok { + return fmt.Errorf("octenium: unknown domain ID for '%s'", info.EffectiveFQDN) + } + + records, err := d.client.ListDNSRecords(ctx, domainID, "TXT") + if err != nil { + return fmt.Errorf("octenium: list records: %w", err) + } + + for _, record := range records { + if record.Type != "TXT" || record.Name != info.EffectiveFQDN || record.Value != info.Value { + continue + } + + _, err = d.client.DeleteDNSRecord(ctx, domainID, record.ID) + if err != nil { + return fmt.Errorf("octenium: delete record: %w", err) + } + + break + } + + 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 +} + +func (d *DNSProvider) getDomainID(ctx context.Context, authZone string) (string, error) { + domains, err := d.client.ListDomains(ctx, dns01.UnFqdn(authZone)) + if err != nil { + return "", fmt.Errorf("list domains: %w", err) + } + + if len(domains) == 0 { + return "", errors.New("domain not found") + } + + if len(domains) > 1 { + return "", errors.New("multiple domains found") + } + + for id := range domains { + return id, nil + } + + return "", errors.New("domain ID not found") +} diff --git a/providers/dns/octenium/octenium.toml b/providers/dns/octenium/octenium.toml new file mode 100644 index 000000000..5084526fd --- /dev/null +++ b/providers/dns/octenium/octenium.toml @@ -0,0 +1,22 @@ +Name = "Octenium" +Description = '''''' +URL = "https://octenium.com/" +Code = "octenium" +Since = "v4.27.0" + +Example = ''' +OCTENIUM_API_KEY="xxx" \ +lego --email you@example.com --dns octenium -d '*.example.com' -d example.com run +''' + +[Configuration] + [Configuration.Credentials] + OCTENIUM_API_KEY = "API key" + [Configuration.Additional] + OCTENIUM_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)" + OCTENIUM_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 60)" + OCTENIUM_TTL = "The TTL of the TXT record used for the DNS challenge in seconds (Default: 120)" + OCTENIUM_HTTP_TIMEOUT = "API request timeout in seconds (Default: 30)" + +[Links] + API = "https://octenium.com/api#tag/Domains-DNS" diff --git a/providers/dns/octenium/octenium_test.go b/providers/dns/octenium/octenium_test.go new file mode 100644 index 000000000..c3d0ef558 --- /dev/null +++ b/providers/dns/octenium/octenium_test.go @@ -0,0 +1,195 @@ +package octenium + +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(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 API key", + envVars: map[string]string{ + EnvAPIKey: "", + }, + expected: "octenium: some credentials information are missing: OCTENIUM_API_KEY", + }, + { + desc: "missing credentials", + envVars: map[string]string{}, + expected: "octenium: some credentials information are missing: OCTENIUM_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 API key", + expected: "octenium: credentials missing", + }, + { + desc: "missing credentials", + expected: "octenium: 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" + + 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(). + WithAccept("application/json"). + With("X-Api-Key", "secret"), + ) +} + +func TestDNSProvider_Present(t *testing.T) { + provider := mockBuilder(). + Route("GET /domains", + servermock.ResponseFromFixture("list_domains.json"), + servermock.CheckQueryParameter().Strict(). + With("domain-name", "example.com")). + Route("POST /domains/dns-records/add", + servermock.ResponseFromFixture("add_dns_record.json"), + servermock.CheckHeader(). + WithContentType("application/x-www-form-urlencoded"), + servermock.CheckForm().Strict(). + With("order-id", "2976"). + With("name", "_acme-challenge.example.com."). + With("ttl", "120"). + With("type", "TXT"). + With("value", "w6uP8Tcg6K2QR905Rms8iXTlksL6OD1KOWBxTK7wxPI")). + Build(t) + + err := provider.Present("example.com", "", "foobar") + require.NoError(t, err) +} + +func TestDNSProvider_CleanUp(t *testing.T) { + provider := mockBuilder(). + Route("POST /domains/dns-records/list", + servermock.ResponseFromFixture("list_dns_records.json"), + servermock.CheckHeader(). + WithContentType("application/x-www-form-urlencoded"), + servermock.CheckForm().Strict(). + With("order-id", "2976"). + With("types[]", "TXT")). + Route("POST /domains/dns-records/delete", + servermock.ResponseFromFixture("delete_dns_record.json"), + servermock.CheckHeader(). + WithContentType("application/x-www-form-urlencoded"), + servermock.CheckForm().Strict(). + With("order-id", "2976"). + With("line", "123")). + Build(t) + + provider.domainIDs["token"] = "2976" + + err := provider.CleanUp("example.com", "token", "foobar") + require.NoError(t, err) +} diff --git a/providers/dns/zz_gen_dns_providers.go b/providers/dns/zz_gen_dns_providers.go index df0c59bf6..4dcf5317c 100644 --- a/providers/dns/zz_gen_dns_providers.go +++ b/providers/dns/zz_gen_dns_providers.go @@ -119,6 +119,7 @@ import ( "github.com/go-acme/lego/v4/providers/dns/njalla" "github.com/go-acme/lego/v4/providers/dns/nodion" "github.com/go-acme/lego/v4/providers/dns/ns1" + "github.com/go-acme/lego/v4/providers/dns/octenium" "github.com/go-acme/lego/v4/providers/dns/oraclecloud" "github.com/go-acme/lego/v4/providers/dns/otc" "github.com/go-acme/lego/v4/providers/dns/ovh" @@ -400,6 +401,8 @@ func NewDNSChallengeProviderByName(name string) (challenge.Provider, error) { return nodion.NewDNSProvider() case "ns1": return ns1.NewDNSProvider() + case "octenium": + return octenium.NewDNSProvider() case "oraclecloud": return oraclecloud.NewDNSProvider() case "otc":