feat: Add DNS provider for EuroDNS

This commit is contained in:
Fernandez Ludovic 2024-11-21 00:43:57 +01:00
commit 445c341760
10 changed files with 1302 additions and 0 deletions

View file

@ -0,0 +1,197 @@
// Package eurodns implements a DNS provider for solving the DNS-01 challenge using EuroDNS.
package eurodns
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/eurodns/internal"
"github.com/go-acme/lego/v4/providers/dns/internal/clientdebug"
)
// Environment variables names.
const (
envNamespace = "EURODNS_"
EnvApplicationID = envNamespace + "APP_ID"
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 {
ApplicationID string
APIKey string
PropagationTimeout time.Duration
PollingInterval time.Duration
TTL int
HTTPClient *http.Client
}
// NewDefaultConfig returns a default configuration for the DNSProvider.
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
},
}
}
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
config *Config
client *internal.Client
}
// NewDNSProvider returns a DNSProvider instance configured for EuroDNS.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvApplicationID, EnvAPIKey)
if err != nil {
return nil, fmt.Errorf("eurodns: %w", err)
}
config := NewDefaultConfig()
config.ApplicationID = values[EnvApplicationID]
config.APIKey = values[EnvAPIKey]
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for EuroDNS.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("eurodns: the configuration of the DNS provider is nil")
}
client, err := internal.NewClient(config.ApplicationID, config.APIKey)
if err != nil {
return nil, fmt.Errorf("eurodns: %w", err)
}
if config.HTTPClient != nil {
client.HTTPClient = config.HTTPClient
}
client.HTTPClient = clientdebug.Wrap(client.HTTPClient)
return &DNSProvider{
config: config,
client: client,
}, nil
}
// Present creates a TXT record using the specified parameters.
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
ctx := context.Background()
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("eurodns: could not find zone for domain %q: %w", domain, err)
}
subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
if err != nil {
return fmt.Errorf("eurodns: %w", err)
}
authZone = dns01.UnFqdn(authZone)
zone, err := d.client.GetZone(ctx, authZone)
if err != nil {
return fmt.Errorf("eurodns: get zone: %w", err)
}
zone.Records = append(zone.Records, internal.Record{
Type: "TXT",
Host: subDomain,
TTL: d.config.TTL,
RData: info.Value,
})
validation, err := d.client.ValidateZone(ctx, authZone, zone)
if err != nil {
return fmt.Errorf("eurodns: validate zone: %w", err)
}
if validation.Report != nil && !validation.Report.IsValid {
return fmt.Errorf("eurodns: %w", validation.Report)
}
err = d.client.SaveZone(ctx, authZone, zone)
if err != nil {
return fmt.Errorf("eurodns: save zone: %w", err)
}
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
ctx := context.Background()
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("eurodns: could not find zone for domain %q: %w", domain, err)
}
subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
if err != nil {
return fmt.Errorf("eurodns: %w", err)
}
authZone = dns01.UnFqdn(authZone)
zone, err := d.client.GetZone(ctx, authZone)
if err != nil {
return fmt.Errorf("eurodns: get zone: %w", err)
}
var recordsToKeep []internal.Record
for _, record := range zone.Records {
if record.Type == "TXT" && record.Host == subDomain && record.RData == info.Value {
continue
}
recordsToKeep = append(recordsToKeep, record)
}
zone.Records = recordsToKeep
validation, err := d.client.ValidateZone(ctx, authZone, zone)
if err != nil {
return fmt.Errorf("eurodns: validate zone: %w", err)
}
if validation.Report != nil && !validation.Report.IsValid {
return fmt.Errorf("eurodns: %w", validation.Report)
}
err = d.client.SaveZone(ctx, authZone, zone)
if err != nil {
return fmt.Errorf("eurodns: save zone: %w", err)
}
return nil
}
// Timeout returns the timeout and interval to use when checking for DNS propagation.
// Adjusting here to cope with spikes in propagation times.
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
return d.config.PropagationTimeout, d.config.PollingInterval
}

View file

@ -0,0 +1,24 @@
Name = "EuroDNS"
Description = ''''''
URL = "https://www.eurodns.com/"
Code = "eurodns"
Since = "v4.33.0"
Example = '''
EURODNS_APP_ID="xxx" \
EURODNS_API_KEY="yyy" \
lego --dns eurodns -d '*.example.com' -d example.com run
'''
[Configuration]
[Configuration.Credentials]
EURODNS_APP_ID = "Application ID"
EURODNS_API_KEY = "API key"
[Configuration.Additional]
EURODNS_POLLING_INTERVAL = "Time between DNS propagation check"
EURODNS_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
EURODNS_TTL = "The TTL of the TXT record used for the DNS challenge"
EURODNS_HTTP_TIMEOUT = "API request timeout"
[Links]
API = "https://docapi.eurodns.com/"

View file

@ -0,0 +1,215 @@
package eurodns
import (
"net/http"
"net/http/httptest"
"net/url"
"testing"
"github.com/go-acme/lego/v4/platform/tester"
"github.com/go-acme/lego/v4/platform/tester/servermock"
"github.com/go-acme/lego/v4/providers/dns/eurodns/internal"
"github.com/stretchr/testify/require"
)
const envDomain = envNamespace + "DOMAIN"
var envTest = tester.NewEnvTest(EnvApplicationID, EnvAPIKey).WithDomain(envDomain)
func TestNewDNSProvider(t *testing.T) {
testCases := []struct {
desc string
envVars map[string]string
expected string
}{
{
desc: "success",
envVars: map[string]string{
EnvApplicationID: "abc",
EnvAPIKey: "secret",
},
},
{
desc: "missing application ID",
envVars: map[string]string{
EnvApplicationID: "",
EnvAPIKey: "secret",
},
expected: "eurodns: some credentials information are missing: EURODNS_APP_ID",
},
{
desc: "missing API secret",
envVars: map[string]string{
EnvApplicationID: "",
EnvAPIKey: "secret",
},
expected: "eurodns: some credentials information are missing: EURODNS_APP_ID",
},
{
desc: "missing credentials",
envVars: map[string]string{},
expected: "eurodns: some credentials information are missing: EURODNS_APP_ID,EURODNS_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
appID string
apiKey string
expected string
}{
{
desc: "success",
appID: "abc",
apiKey: "secret",
},
{
desc: "missing application ID",
expected: "eurodns: credentials missing",
apiKey: "secret",
},
{
desc: "missing API secret",
expected: "eurodns: credentials missing",
appID: "abc",
},
{
desc: "missing credentials",
expected: "eurodns: credentials missing",
},
}
for _, test := range testCases {
t.Run(test.desc, func(t *testing.T) {
config := NewDefaultConfig()
config.ApplicationID = test.appID
config.APIKey = test.apiKey
p, err := NewDNSProviderConfig(config)
if test.expected == "" {
require.NoError(t, err)
require.NotNil(t, p)
require.NotNil(t, p.config)
require.NotNil(t, p.client)
} else {
require.EqualError(t, err, test.expected)
}
})
}
}
func TestLivePresent(t *testing.T) {
if !envTest.IsLiveTest() {
t.Skip("skipping live test")
}
envTest.RestoreEnv()
provider, err := NewDNSProvider()
require.NoError(t, err)
err = provider.Present(envTest.GetDomain(), "", "123d==")
require.NoError(t, err)
}
func TestLiveCleanUp(t *testing.T) {
if !envTest.IsLiveTest() {
t.Skip("skipping live test")
}
envTest.RestoreEnv()
provider, err := NewDNSProvider()
require.NoError(t, err)
err = provider.CleanUp(envTest.GetDomain(), "", "123d==")
require.NoError(t, err)
}
func mockBuilder() *servermock.Builder[*DNSProvider] {
return servermock.NewBuilder(
func(server *httptest.Server) (*DNSProvider, error) {
config := NewDefaultConfig()
config.APIKey = "secret"
config.ApplicationID = "abc"
config.HTTPClient = server.Client()
provider, err := NewDNSProviderConfig(config)
if err != nil {
return nil, err
}
provider.client.BaseURL, _ = url.Parse(server.URL)
return provider, nil
},
servermock.CheckHeader().
WithJSONHeaders().
With(internal.HeaderAppID, "abc").
With(internal.HeaderAPIKey, "secret"),
)
}
func TestDNSProvider_Present(t *testing.T) {
provider := mockBuilder().
Route("GET /example.com",
servermock.ResponseFromInternal("get_zone.json"),
).
Route("POST /example.com/check",
servermock.ResponseFromInternal("get_zone.json"),
servermock.CheckRequestJSONBodyFromInternal("zones_add.json"),
).
Route("PUT /example.com",
servermock.Noop().
WithStatusCode(http.StatusNoContent),
servermock.CheckRequestJSONBodyFromInternal("zones_add.json"),
).
Build(t)
err := provider.Present("example.com", "abc", "123d==")
require.NoError(t, err)
}
func TestDNSProvider_CleanUp(t *testing.T) {
provider := mockBuilder().
Route("GET /example.com",
servermock.ResponseFromInternal("zones_add.json"),
).
Route("POST /example.com/check",
servermock.ResponseFromInternal("zones_remove.json"),
servermock.CheckRequestJSONBodyFromInternal("zones_remove.json"),
).
Route("PUT /example.com",
servermock.Noop().
WithStatusCode(http.StatusNoContent),
servermock.CheckRequestJSONBodyFromInternal("zones_remove.json"),
).
Build(t)
err := provider.CleanUp("example.com", "abc", "123d==")
require.NoError(t, err)
}

View file

@ -0,0 +1,166 @@
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://rest-api.eurodns.com/dns-zones/"
const (
HeaderAppID = "X-APP-ID"
HeaderAPIKey = "X-API-KEY"
)
// Client the EuroDNS API client.
type Client struct {
appID string
apiKey string
BaseURL *url.URL
HTTPClient *http.Client
}
// NewClient creates a new Client.
func NewClient(appID, apiKey string) (*Client, error) {
if appID == "" || apiKey == "" {
return nil, errors.New("credentials missing")
}
baseURL, _ := url.Parse(defaultBaseURL)
return &Client{
appID: appID,
apiKey: apiKey,
BaseURL: baseURL,
HTTPClient: &http.Client{Timeout: 10 * time.Second},
}, nil
}
// GetZone gets a DNS Zone.
func (c *Client) GetZone(ctx context.Context, domain string) (*Zone, error) {
endpoint := c.BaseURL.JoinPath(domain)
req, err := newJSONRequest(ctx, http.MethodGet, endpoint, nil)
if err != nil {
return nil, err
}
result := &Zone{}
err = c.do(req, result)
if err != nil {
return nil, err
}
return result, nil
}
// SaveZone saves a DNS Zone.
func (c *Client) SaveZone(ctx context.Context, domain string, zone *Zone) error {
endpoint := c.BaseURL.JoinPath(domain)
req, err := newJSONRequest(ctx, http.MethodPut, endpoint, zone)
if err != nil {
return err
}
return c.do(req, nil)
}
// ValidateZone validates DNS Zone.
func (c *Client) ValidateZone(ctx context.Context, domain string, zone *Zone) (*Zone, error) {
endpoint := c.BaseURL.JoinPath(domain, "check")
req, err := newJSONRequest(ctx, http.MethodPost, endpoint, zone)
if err != nil {
return nil, err
}
result := &Zone{}
err = c.do(req, result)
if err != nil {
return nil, err
}
return result, nil
}
func (c *Client) do(req *http.Request, result any) error {
req.Header.Set(HeaderAppID, c.appID)
req.Header.Set(HeaderAPIKey, c.apiKey)
resp, err := c.HTTPClient.Do(req)
if err != nil {
return errutils.NewHTTPDoError(req, err)
}
defer func() { _ = resp.Body.Close() }()
if resp.StatusCode/100 != 2 {
return parseError(req, resp)
}
if result == nil {
return nil
}
raw, err := io.ReadAll(resp.Body)
if err != nil {
return errutils.NewReadResponseError(req, resp.StatusCode, err)
}
err = json.Unmarshal(raw, result)
if err != nil {
return errutils.NewUnmarshalError(req, resp.StatusCode, raw, err)
}
return nil
}
func newJSONRequest(ctx context.Context, method string, endpoint *url.URL, payload any) (*http.Request, error) {
buf := new(bytes.Buffer)
if payload != nil {
err := json.NewEncoder(buf).Encode(payload)
if err != nil {
return nil, fmt.Errorf("failed to create request JSON body: %w", err)
}
}
req, err := http.NewRequestWithContext(ctx, method, endpoint.String(), buf)
if err != nil {
return nil, fmt.Errorf("unable to create request: %w", err)
}
req.Header.Set("Accept", "application/json")
if payload != nil {
req.Header.Set("Content-Type", "application/json")
}
return req, nil
}
func parseError(req *http.Request, resp *http.Response) error {
raw, _ := io.ReadAll(resp.Body)
var errAPI APIError
err := json.Unmarshal(raw, &errAPI)
if err != nil {
return errutils.NewUnexpectedStatusCodeError(req, resp.StatusCode, raw)
}
return fmt.Errorf("%d: %w", resp.StatusCode, &errAPI)
}

View file

@ -0,0 +1,215 @@
package internal
import (
"context"
"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("abc", "secret")
if err != nil {
return nil, err
}
client.HTTPClient = server.Client()
client.BaseURL, _ = url.Parse(server.URL)
return client, nil
},
servermock.CheckHeader().
WithJSONHeaders().
With(HeaderAppID, "abc").
With(HeaderAPIKey, "secret"),
)
}
func TestClient_GetZone(t *testing.T) {
client := mockBuilder().
Route("GET /example.com",
servermock.ResponseFromFixture("get_zone.json"),
).
Build(t)
zone, err := client.GetZone(context.Background(), "example.com")
require.NoError(t, err)
assert.Equal(t, expectedZone(), zone)
}
func TestClient_GetZone_error(t *testing.T) {
client := mockBuilder().
Route("GET /example.com",
servermock.ResponseFromFixture("error.json").
WithStatusCode(http.StatusUnauthorized),
).
Build(t)
_, err := client.GetZone(context.Background(), "example.com")
require.Error(t, err)
require.EqualError(t, err, "401: INVALID_API_KEY: Invalid API Key")
}
func TestClient_SaveZone(t *testing.T) {
client := mockBuilder().
Route("PUT /example.com",
servermock.Noop().
WithStatusCode(http.StatusNoContent),
servermock.CheckRequestJSONBodyFromFixture("zones_add.json"),
).
Build(t)
record := Record{
Type: "TXT",
Host: "_acme-challenge",
RData: "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY",
TTL: 120,
}
err := client.SaveZone(context.Background(), "example.com", expectedZone(record))
require.NoError(t, err)
}
func TestClient_SaveZone_error(t *testing.T) {
client := mockBuilder().
Route("PUT /example.com",
servermock.ResponseFromFixture("error.json").
WithStatusCode(http.StatusUnauthorized),
).
Build(t)
err := client.SaveZone(context.Background(), "example.com", expectedZone())
require.Error(t, err)
require.EqualError(t, err, "401: INVALID_API_KEY: Invalid API Key")
}
func TestClient_ValidateZone(t *testing.T) {
client := mockBuilder().
Route("POST /example.com/check",
servermock.ResponseFromFixture("zones_add.json"),
servermock.CheckRequestJSONBodyFromFixture("zones_add.json"),
).
Build(t)
record := Record{
Type: "TXT",
Host: "_acme-challenge",
RData: "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY",
TTL: 120,
}
zone, err := client.ValidateZone(context.Background(), "example.com", expectedZone(record))
require.NoError(t, err)
assert.Equal(t, expectedZone(record), zone)
}
func TestClient_ValidateZone_error(t *testing.T) {
client := mockBuilder().
Route("POST /example.com/check",
servermock.ResponseFromFixture("error.json").
WithStatusCode(http.StatusUnauthorized),
).
Build(t)
_, err := client.ValidateZone(context.Background(), "example.com", expectedZone())
require.Error(t, err)
require.EqualError(t, err, "401: INVALID_API_KEY: Invalid API Key")
}
func expectedZone(records ...Record) *Zone {
rs := []Record{{
Type: "A",
Host: "string",
RData: "string",
Updated: true,
Locked: true,
IsDynDNS: true,
Proxy: "ON",
}}
rs = append(rs, records...)
return &Zone{
Name: "string",
DomainConnect: true,
Records: rs,
URLForwards: []URLForward{{
ForwardType: "FRAME",
Host: "string",
URL: "string",
Title: "string",
Keywords: "string",
Description: "string",
Updated: true,
}},
MailForwards: []MailForward{{
Source: "string",
Destination: "string",
Updated: true,
}},
Report: &Report{
IsValid: true,
URLForwardErrors: []URLForwardError{{
Messages: []string{"string"},
Severity: "ERROR",
URLForward: &URLForward{
ForwardType: "FRAME",
Host: "string",
URL: "string",
Title: "string",
Keywords: "string",
Description: "string",
Updated: true,
},
}},
MailForwardErrors: []MailForwardError{{
Messages: []string{"string"},
MailForward: &MailForward{
Source: "string",
Destination: "string",
Updated: true,
},
Severity: "ERROR",
}},
ZoneErrors: []ZoneError{{
Message: "string",
Severity: "ERROR",
Records: []Record{{
Type: "A",
Host: "string",
RData: "string",
Updated: true,
Locked: true,
IsDynDNS: true,
Proxy: "ON",
}},
URLForwards: []URLForward{{
ForwardType: "FRAME",
Host: "string",
URL: "string",
Title: "string",
Keywords: "string",
Description: "string",
Updated: true,
}},
MailForwards: []MailForward{{
Source: "string",
Destination: "string",
Updated: true,
}},
}},
},
}
}

View file

@ -0,0 +1,8 @@
{
"errors": [
{
"code": "INVALID_API_KEY",
"title": "Invalid API Key"
}
]
}

View file

@ -0,0 +1,130 @@
{
"name": "string",
"domainConnect": true,
"records": [
{
"id": 0,
"type": "A",
"host": "string",
"ttl": 0,
"rdata": "string",
"updated": true,
"locked": true,
"isDynDns": true,
"proxy": "ON"
}
],
"urlForwards": [
{
"id": 0,
"forwardType": "FRAME",
"host": "string",
"url": "string",
"title": "string",
"keywords": "string",
"description": "string",
"updated": true
}
],
"mailForwards": [
{
"id": 0,
"source": "string",
"destination": "string",
"updated": true
}
],
"report": {
"isValid": true,
"recordErrors": [
{
"messages": [
"string"
],
"record": {
"id": 0,
"type": "A",
"host": "string",
"ttl": 0,
"rdata": "string",
"updated": true,
"locked": true,
"isDynDns": true,
"proxy": "ON"
},
"severity": "ERROR"
}
],
"urlForwardErrors": [
{
"messages": [
"string"
],
"urlForward": {
"id": 0,
"forwardType": "FRAME",
"host": "string",
"url": "string",
"title": "string",
"keywords": "string",
"description": "string",
"updated": true
},
"severity": "ERROR"
}
],
"mailForwardErrors": [
{
"messages": [
"string"
],
"mailForward": {
"id": 0,
"source": "string",
"destination": "string",
"updated": true
},
"severity": "ERROR"
}
],
"zoneErrors": [
{
"message": "string",
"records": [
{
"id": 0,
"type": "A",
"host": "string",
"ttl": 0,
"rdata": "string",
"updated": true,
"locked": true,
"isDynDns": true,
"proxy": "ON"
}
],
"urlForwards": [
{
"id": 0,
"forwardType": "FRAME",
"host": "string",
"url": "string",
"title": "string",
"keywords": "string",
"description": "string",
"updated": true
}
],
"mailForwards": [
{
"id": 0,
"source": "string",
"destination": "string",
"updated": true
}
],
"severity": "ERROR"
}
]
}
}

View file

@ -0,0 +1,110 @@
{
"name": "string",
"domainConnect": true,
"records": [
{
"type": "A",
"host": "string",
"rdata": "string",
"updated": true,
"locked": true,
"isDynDns": true,
"proxy": "ON"
},
{
"type": "TXT",
"host": "_acme-challenge",
"ttl": 120,
"rdata": "ADw2sEd82DUgXcQ9hNBZThJs7zVJkR5v9JeSbAb9mZY",
"updated": false,
"locked": false,
"isDynDns": false
}
],
"urlForwards": [
{
"forwardType": "FRAME",
"host": "string",
"url": "string",
"title": "string",
"keywords": "string",
"description": "string",
"updated": true
}
],
"mailForwards": [
{
"source": "string",
"destination": "string",
"updated": true
}
],
"report": {
"isValid": true,
"urlForwardErrors": [
{
"messages": [
"string"
],
"urlForward": {
"forwardType": "FRAME",
"host": "string",
"url": "string",
"title": "string",
"keywords": "string",
"description": "string",
"updated": true
},
"severity": "ERROR"
}
],
"mailForwardErrors": [
{
"messages": [
"string"
],
"mailForward": {
"source": "string",
"destination": "string",
"updated": true
},
"severity": "ERROR"
}
],
"zoneErrors": [
{
"message": "string",
"records": [
{
"type": "A",
"host": "string",
"rdata": "string",
"updated": true,
"locked": true,
"isDynDns": true,
"proxy": "ON"
}
],
"urlForwards": [
{
"forwardType": "FRAME",
"host": "string",
"url": "string",
"title": "string",
"keywords": "string",
"description": "string",
"updated": true
}
],
"mailForwards": [
{
"source": "string",
"destination": "string",
"updated": true
}
],
"severity": "ERROR"
}
]
}
}

View file

@ -0,0 +1,101 @@
{
"name": "string",
"domainConnect": true,
"records": [
{
"type": "A",
"host": "string",
"rdata": "string",
"updated": true,
"locked": true,
"isDynDns": true,
"proxy": "ON"
}
],
"urlForwards": [
{
"forwardType": "FRAME",
"host": "string",
"url": "string",
"title": "string",
"keywords": "string",
"description": "string",
"updated": true
}
],
"mailForwards": [
{
"source": "string",
"destination": "string",
"updated": true
}
],
"report": {
"isValid": true,
"urlForwardErrors": [
{
"messages": [
"string"
],
"urlForward": {
"forwardType": "FRAME",
"host": "string",
"url": "string",
"title": "string",
"keywords": "string",
"description": "string",
"updated": true
},
"severity": "ERROR"
}
],
"mailForwardErrors": [
{
"messages": [
"string"
],
"mailForward": {
"source": "string",
"destination": "string",
"updated": true
},
"severity": "ERROR"
}
],
"zoneErrors": [
{
"message": "string",
"records": [
{
"type": "A",
"host": "string",
"rdata": "string",
"updated": true,
"locked": true,
"isDynDns": true,
"proxy": "ON"
}
],
"urlForwards": [
{
"forwardType": "FRAME",
"host": "string",
"url": "string",
"title": "string",
"keywords": "string",
"description": "string",
"updated": true
}
],
"mailForwards": [
{
"source": "string",
"destination": "string",
"updated": true
}
],
"severity": "ERROR"
}
]
}
}

View file

@ -0,0 +1,136 @@
package internal
import (
"fmt"
"strings"
)
type APIError struct {
Errors []Error `json:"errors"`
}
func (a *APIError) Error() string {
var msg []string
for _, e := range a.Errors {
msg = append(msg, fmt.Sprintf("%s: %s", e.Code, e.Title))
}
return strings.Join(msg, ", ")
}
type Error struct {
Code string `json:"code"`
Title string `json:"title"`
}
type Zone struct {
Name string `json:"name,omitempty"`
DomainConnect bool `json:"domainConnect,omitempty"`
Records []Record `json:"records,omitempty"`
URLForwards []URLForward `json:"urlForwards,omitempty"`
MailForwards []MailForward `json:"mailForwards,omitempty"`
Report *Report `json:"report,omitempty"`
}
type Record struct {
ID int `json:"id,omitempty"`
Type string `json:"type,omitempty"`
Host string `json:"host,omitempty"`
TTL int `json:"ttl,omitempty"`
RData string `json:"rdata,omitempty"`
Updated bool `json:"updated"`
Locked bool `json:"locked"`
IsDynDNS bool `json:"isDynDns"`
Proxy string `json:"proxy,omitempty"`
}
type URLForward struct {
ID int `json:"id,omitempty"`
ForwardType string `json:"forwardType,omitempty"`
Host string `json:"host,omitempty"`
URL string `json:"url,omitempty"`
Title string `json:"title,omitempty"`
Keywords string `json:"keywords,omitempty"`
Description string `json:"description,omitempty"`
Updated bool `json:"updated,omitempty"`
}
type MailForward struct {
ID int `json:"id,omitempty"`
Source string `json:"source,omitempty"`
Destination string `json:"destination,omitempty"`
Updated bool `json:"updated,omitempty"`
}
type Report struct {
IsValid bool `json:"isValid,omitempty"`
RecordErrors []RecordError `json:"report,omitempty"`
URLForwardErrors []URLForwardError `json:"urlForwardErrors,omitempty"`
MailForwardErrors []MailForwardError `json:"mailForwardErrors,omitempty"`
ZoneErrors []ZoneError `json:"zoneErrors,omitempty"`
}
func (r *Report) Error() string {
var msg []string
for _, e := range r.RecordErrors {
msg = append(msg, e.Error())
}
for _, e := range r.URLForwardErrors {
msg = append(msg, e.Error())
}
for _, e := range r.MailForwardErrors {
msg = append(msg, e.Error())
}
for _, e := range r.ZoneErrors {
msg = append(msg, e.Error())
}
return strings.Join(msg, ", ")
}
type RecordError struct {
Messages []string `json:"messages,omitempty"`
Record *Record `json:"recordErrors,omitempty"`
Severity string `json:"severity,omitempty"`
}
func (e *RecordError) Error() string {
return fmt.Sprintf("record error (%s): %s", e.Severity, strings.Join(e.Messages, ", "))
}
type URLForwardError struct {
Messages []string `json:"messages,omitempty"`
URLForward *URLForward `json:"urlForward,omitempty"`
Severity string `json:"severity,omitempty"`
}
func (e *URLForwardError) Error() string {
return fmt.Sprintf("URL forward error (%s): %s", e.Severity, strings.Join(e.Messages, ", "))
}
type MailForwardError struct {
Messages []string `json:"messages,omitempty"`
MailForward *MailForward `json:"mailForward,omitempty"`
Severity string `json:"severity,omitempty"`
}
func (e *MailForwardError) Error() string {
return fmt.Sprintf("mail forward error (%s): %s", e.Severity, strings.Join(e.Messages, ", "))
}
type ZoneError struct {
Message string `json:"message,omitempty"`
Records []Record `json:"records,omitempty"`
URLForwards []URLForward `json:"urlForwards,omitempty"`
MailForwards []MailForward `json:"mailForwards,omitempty"`
Severity string `json:"severity,omitempty"`
}
func (e *ZoneError) Error() string {
return fmt.Sprintf("zone error (%s): %s", e.Severity, e.Message)
}