Add DNS provider for all-inkl (#1444)

cmd/zz_gen_cmd_dnshelp.go

@@ -16,6 +16,7 @@ func allDNSCodes() string {
 		"manual",
 		"acme-dns",
 		"alidns",
+		"allinkl",
 		"arvancloud",
 		"auroradns",
 		"autodns",
@@ -150,6 +151,26 @@ func displayDNSHelp(name string) error {
 		ew.writeln()
 		ew.writeln(`More information: https://go-acme.github.io/lego/dns/alidns`)
 
+	case "allinkl":
+		// generated from: providers/dns/allinkl/allinkl.toml
+		ew.writeln(`Configuration for all-inkl.`)
+		ew.writeln(`Code:	'allinkl'`)
+		ew.writeln(`Since:	'v4.5.0'`)
+		ew.writeln()
+
+		ew.writeln(`Credentials:`)
+		ew.writeln(`	- "ALL_INKL_API_KEY":	API login`)
+		ew.writeln(`	- "ALL_INKL_PASSWORD":	API password`)
+		ew.writeln()
+
+		ew.writeln(`Additional Configuration:`)
+		ew.writeln(`	- "ALL_INKL_HTTP_TIMEOUT":	API request timeout`)
+		ew.writeln(`	- "ALL_INKL_POLLING_INTERVAL":	Time between DNS propagation check`)
+		ew.writeln(`	- "ALL_INKL_PROPAGATION_TIMEOUT":	Maximum waiting time for DNS propagation`)
+
+		ew.writeln()
+		ew.writeln(`More information: https://go-acme.github.io/lego/dns/allinkl`)
+
 	case "arvancloud":
 		// generated from: providers/dns/arvancloud/arvancloud.toml
 		ew.writeln(`Configuration for ArvanCloud.`)

docs/content/dns/zz_gen_allinkl.md

@@ -0,0 +1,63 @@
+---
+title: "all-inkl"
+date: 2019-03-03T16:39:46+01:00
+draft: false
+slug: allinkl
+---
+
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
+<!-- providers/dns/allinkl/allinkl.toml -->
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
+
+Since: v4.5.0
+
+Configuration for [all-inkl](https://all-inkl.com).
+
+
+<!--more-->
+
+- Code: `allinkl`
+
+Here is an example bash command using the all-inkl provider:
+
+```bash
+ALL_INKL_LOGIN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
+ALL_INKL_PASSWORD=yyyyyyyyyyyyyyyyyyyyyyyyyy \
+lego --email myemail@example.com --dns allinkl --domains my.example.org run
+```
+
+
+
+
+## Credentials
+
+| Environment Variable Name | Description |
+|-----------------------|-------------|
+| `ALL_INKL_API_KEY` | API login |
+| `ALL_INKL_PASSWORD` | API password |
+
+The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
+More information [here](/lego/dns/#configuration-and-credentials).
+
+
+## Additional Configuration
+
+| Environment Variable Name | Description |
+|--------------------------------|-------------|
+| `ALL_INKL_HTTP_TIMEOUT` | API request timeout |
+| `ALL_INKL_POLLING_INTERVAL` | Time between DNS propagation check |
+| `ALL_INKL_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
+
+The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
+More information [here](/lego/dns/#configuration-and-credentials).
+
+
+
+
+## More information
+
+- [API documentation](https://kasapi.kasserver.com/dokumentation/phpdoc/index.html)
+
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
+<!-- providers/dns/allinkl/allinkl.toml -->
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

go.mod

@@ -31,6 +31,7 @@ require (
 	github.com/linode/linodego v0.25.3
 	github.com/liquidweb/liquidweb-go v1.6.3
 	github.com/miekg/dns v1.1.40
+	github.com/mitchellh/mapstructure v1.4.1
 	github.com/namedotcom/go v0.0.0-20180403034216-08470befbe04
 	github.com/nrdcg/auroradns v1.0.1
 	github.com/nrdcg/desec v0.5.0

go.sum

@@ -324,8 +324,9 @@ github.com/mitchellh/gox v0.4.0/go.mod h1:Sd9lOJ0+aimLBi73mGofS1ycjY8lL3uZM3JPS4
 github.com/mitchellh/iochan v1.0.0/go.mod h1:JwYml1nuB7xOzsp52dPpHFffvOCDupsG0QubkSMEySY=
 github.com/mitchellh/mapstructure v0.0.0-20160808181253-ca63d7c062ee/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
 github.com/mitchellh/mapstructure v1.1.2/go.mod h1:FVVH3fgwuzCH5S8UJGiWEs2h04kUh9fWfEaFds41c1Y=
-github.com/mitchellh/mapstructure v1.3.3 h1:SzB1nHZ2Xi+17FP0zVQBHIZqvwRN9408fJO8h+eeNA8=
 github.com/mitchellh/mapstructure v1.3.3/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
+github.com/mitchellh/mapstructure v1.4.1 h1:CpVNEelQCZBooIPDn+AR3NpivK/TIKU8bDxdASFVQag=
+github.com/mitchellh/mapstructure v1.4.1/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg=
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=

providers/dns/allinkl/allinkl.go

@@ -0,0 +1,161 @@
+// Package allinkl implements a DNS provider for solving the DNS-01 challenge using all-inkl.
+package allinkl
+
+import (
+	"errors"
+	"fmt"
+	"net/http"
+	"strings"
+	"sync"
+	"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/allinkl/internal"
+)
+
+// Environment variables names.
+const (
+	envNamespace = "ALL_INKL_"
+
+	EnvLogin    = envNamespace + "LOGIN"
+	EnvPassword = envNamespace + "PASSWORD"
+
+	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 {
+	Login              string
+	Password           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{
+		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
+
+	recordIDs   map[string]string
+	recordIDsMu sync.Mutex
+}
+
+// NewDNSProvider returns a DNSProvider instance configured for all-inkl.
+// Credentials must be passed in the environment variable: ALL_INKL_API_KEY, ALL_INKL_PASSWORD.
+func NewDNSProvider() (*DNSProvider, error) {
+	values, err := env.Get(EnvLogin, EnvPassword)
+	if err != nil {
+		return nil, fmt.Errorf("allinkl: %w", err)
+	}
+
+	config := NewDefaultConfig()
+	config.Login = values[EnvLogin]
+	config.Password = values[EnvPassword]
+
+	return NewDNSProviderConfig(config)
+}
+
+// NewDNSProviderConfig return a DNSProvider instance configured for all-inkl.
+func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
+	if config == nil {
+		return nil, errors.New("allinkl: the configuration of the DNS provider is nil")
+	}
+
+	if config.Login == "" || config.Password == "" {
+		return nil, errors.New("allinkl: missing credentials")
+	}
+
+	client := internal.NewClient(config.Login, config.Password)
+
+	if config.HTTPClient != nil {
+		client.HTTPClient = config.HTTPClient
+	}
+
+	return &DNSProvider{
+		config:    config,
+		client:    client,
+		recordIDs: make(map[string]string),
+	}, 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
+}
+
+// Present creates a TXT record using the specified parameters.
+func (d *DNSProvider) Present(domain, token, keyAuth string) error {
+	fqdn, value := dns01.GetRecord(domain, keyAuth)
+
+	authZone, err := dns01.FindZoneByFqdn(fqdn)
+	if err != nil {
+		return fmt.Errorf("allinkl: could not determine zone for domain %q: %w", domain, err)
+	}
+
+	credential, err := d.client.Authentication(60, true)
+	if err != nil {
+		return fmt.Errorf("allinkl: %w", err)
+	}
+
+	subDomain := dns01.UnFqdn(strings.TrimSuffix(fqdn, authZone))
+
+	record := internal.DNSRequest{
+		ZoneHost:   authZone,
+		RecordType: "TXT",
+		RecordName: subDomain,
+		RecordData: value,
+	}
+
+	recordID, err := d.client.AddDNSSettings(credential, record)
+	if err != nil {
+		return fmt.Errorf("allinkl: %w", err)
+	}
+
+	d.recordIDsMu.Lock()
+	d.recordIDs[token] = recordID
+	d.recordIDsMu.Unlock()
+
+	return nil
+}
+
+// CleanUp removes the TXT record matching the specified parameters.
+func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
+	fqdn, _ := dns01.GetRecord(domain, keyAuth)
+
+	credential, err := d.client.Authentication(60, true)
+	if err != nil {
+		return fmt.Errorf("allinkl: %w", err)
+	}
+
+	// gets the record's unique ID from when we created it
+	d.recordIDsMu.Lock()
+	recordID, ok := d.recordIDs[token]
+	d.recordIDsMu.Unlock()
+	if !ok {
+		return fmt.Errorf("allinkl: unknown record ID for '%s' '%s'", fqdn, token)
+	}
+
+	_, err = d.client.DeleteDNSSettings(credential, recordID)
+	if err != nil {
+		return fmt.Errorf("allinkl: %w", err)
+	}
+
+	return nil
+}

providers/dns/allinkl/allinkl.toml

@@ -0,0 +1,24 @@
+Name = "all-inkl"
+Description = ''''''
+URL = "https://all-inkl.com"
+Code = "allinkl"
+Since = "v4.5.0"
+
+Example = '''
+ALL_INKL_LOGIN=xxxxxxxxxxxxxxxxxxxxxxxxxx \
+ALL_INKL_PASSWORD=yyyyyyyyyyyyyyyyyyyyyyyyyy \
+lego --email myemail@example.com --dns allinkl --domains my.example.org run
+'''
+
+[Configuration]
+  [Configuration.Credentials]
+    ALL_INKL_API_KEY = "API login"
+    ALL_INKL_PASSWORD = "API password"
+  [Configuration.Additional]
+    ALL_INKL_POLLING_INTERVAL = "Time between DNS propagation check"
+    ALL_INKL_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
+    ALL_INKL_HTTP_TIMEOUT = "API request timeout"
+
+[Links]
+  API = "https://kasapi.kasserver.com/dokumentation/phpdoc/index.html"
+  Guide = "https://kasapi.kasserver.com/dokumentation/"