Domainnameshop provider (#1625)

* Added basic structure for domain name shop * Finished proof of concept for domainnameshop * Fixed handeling of IDNA for CNAME records * Updated documentation notes * Added docs * Ran linter and vet * Removed proxy config used for debugging * Ran go generate * Fixed issue with TTLs being restricted to a multiple of 60 * Ran tests, vet and linting and fixed flaws * Fixed typo in docs * Improved code based on feedback * Fixed issues with TXT records not working properly * Refactored according to new file layout proposed * Updated documentation matrix * Suggestions and corrections * Corrected according to suggestions Co-authored-by: Simen Bai <git@simenbai.no> Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
2024-05-11 05:55:12 +00:00 · 2022-08-01 18:01:37 +02:00
parent befb52be86
commit e9510da434
12 changed files with 688 additions and 0 deletions
--- a/providers/domainnameshop/domainnameshopProvider.go
+++ b/providers/domainnameshop/domainnameshopProvider.go
@@ -0,0 +1,101 @@
+package domainnameshop
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/StackExchange/dnscontrol/v3/models"
+	"github.com/StackExchange/dnscontrol/v3/providers"
+)
+
+/**
+
+DomainNameShop Provider
+
+Info required in 'creds.json':
+	- token		API Token
+	- secret	API Secret
+
+*/
+
+type domainNameShopProvider struct {
+	Token  string // The API token
+	Secret string // The API secret
+}
+
+var features = providers.DocumentationNotes{
+	providers.CanAutoDNSSEC:          providers.Cannot(),        // Maybe there is support for it
+	providers.CanGetZones:            providers.Unimplemented(), //
+	providers.CanUseAlias:            providers.Unimplemented(), // Can possibly be implemented, needs further research
+	providers.CanUseCAA:              providers.Can(),
+	providers.CanUseDS:               providers.Unimplemented(), // Seems to support but needs to be implemented
+	providers.CanUseDSForChildren:    providers.Unimplemented(), // Seems to support but needs to be implemented
+	providers.CanUseNAPTR:            providers.Cannot(),        // Does not seem to support it
+	providers.CanUsePTR:              providers.Unimplemented(), // Seems to support but needs to be implemented
+	providers.CanUseSOA:              providers.Cannot(),        // Does not seem to support it
+	providers.CanUseSRV:              providers.Can(),
+	providers.CanUseSSHFP:            providers.Cannot(),        // Does not seem to support it
+	providers.CanUseTLSA:             providers.Unimplemented(), // Seems to support but needs to be implemented
+	providers.DocCreateDomains:       providers.Unimplemented(), // Not tested
+	providers.DocDualHost:            providers.Unimplemented(), // Not tested
+	providers.DocOfficiallySupported: providers.Cannot(),
+}
+
+// Register with the dnscontrol system.
+// This establishes the name (all caps), and the function to call to initialize it.
+func init() {
+	fns := providers.DspFuncs{
+		Initializer:   newDomainNameShopProvider,
+		RecordAuditor: auditRecords,
+	}
+
+	providers.RegisterDomainServiceProviderType("DOMAINNAMESHOP", fns, features)
+}
+
+// newDomainNameShopProvider creates a DomainNameShop specific DNS provider.
+func newDomainNameShopProvider(conf map[string]string, metadata json.RawMessage) (providers.DNSServiceProvider, error) {
+	if conf["token"] == "" {
+		return nil, fmt.Errorf("no DomainNameShop token provided")
+	} else if conf["secret"] == "" {
+		return nil, fmt.Errorf("no DomainNameShop secret provided")
+	}
+
+	api := &domainNameShopProvider{
+		Token:  conf["token"],
+		Secret: conf["secret"],
+	}
+
+	// Consider testing if creds work
+	return api, nil
+}
+
+func auditRecords(records []*models.RecordConfig) error {
+	return nil
+}
+
+type domainResponse struct {
+	ID          int      `json:"id"`
+	Domain      string   `json:"domain"`
+	Nameservers []string `json:"nameservers"`
+}
+
+// The Actual fields are the values in the right format according to what is needed for RecordConfig.
+//  While the values without Actual are the values directly as received from the DomainNameShop API.
+//  This is done to make it easier to use the values at later points.
+type domainNameShopRecord struct {
+	ID             int    `json:"id"`
+	Host           string `json:"host"`
+	TTL            uint16 `json:"ttl,omitempty"`
+	Type           string `json:"type"`
+	Data           string `json:"data"`
+	Priority       string `json:"priority,omitempty"`
+	ActualPriority uint16
+	Weight         string `json:"weight,omitempty"`
+	ActualWeight   uint16
+	Port           string `json:"port,omitempty"`
+	ActualPort     uint16
+	CAATag         string `json:"tag,omitempty"`
+	ActualCAAFlag  string `json:"flags,omitempty"`
+	CAAFlag        uint64
+	DomainID       string
+}