Add DNS provider for Core-Networks (#2101)

Author: ldez

README.md

@@ -0,0 +1,70 @@
+---
+title: "Core-Networks"
+date: 2019-03-03T16:39:46+01:00
+draft: false
+slug: corenetworks
+dnsprovider:
+  since:    "v4.20.0"
+  code:     "corenetworks"
+  url:      "https://www.core-networks.de/"
+---
+
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
+<!-- providers/dns/corenetworks/corenetworks.toml -->
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
+
+
+Configuration for [Core-Networks](https://www.core-networks.de/).
+
+
+<!--more-->
+
+- Code: `corenetworks`
+- Since: v4.20.0
+
+
+Here is an example bash command using the Core-Networks provider:
+
+```bash
+CORENETWORKS_LOGIN="xxxx" \
+CORENETWORKS_PASSWORD="yyyy" \
+lego --email myemail@example.com --dns corenetworks --domains my.example.org run
+```
+
+
+
+
+## Credentials
+
+| Environment Variable Name | Description |
+|-----------------------|-------------|
+| `CORENETWORKS_LOGIN` | The username of the API account |
+| `CORENETWORKS_PASSWORD` | The password |
+
+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 |
+|--------------------------------|-------------|
+| `CORENETWORKS_HTTP_TIMEOUT` | API request timeout |
+| `CORENETWORKS_POLLING_INTERVAL` | Time between DNS propagation check |
+| `CORENETWORKS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
+| `CORENETWORKS_SEQUENCE_INTERVAL` | Time between sequential requests |
+| `CORENETWORKS_TTL` | The TTL of the TXT record used for the DNS challenge |
+
+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://beta.api.core-networks.de/doc/)
+
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
+<!-- providers/dns/corenetworks/corenetworks.toml -->
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

cmd/zz_gen_cmd_dnshelp.go

@@ -141,7 +141,7 @@ To display the documentation for a specific DNS provider, run:
   $ lego dnshelp -c code
 
 Supported DNS providers:
-  acme-dns, alidns, allinkl, arvancloud, auroradns, autodns, azure, azuredns, bindman, bluecat, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, conoha, constellix, cpanel, derak, desec, designate, digitalocean, directadmin, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dynu, easydns, edgedns, efficientip, epik, exec, exoscale, 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, liara, lightsail, limacity, linode, liquidweb, loopia, luadns, mailinabox, manual, metaname, mijnhost, mittwald, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, nearlyfreespeech, netcup, netlify, nicmanager, nifcloud, njalla, nodion, ns1, oraclecloud, otc, ovh, pdns, plesk, porkbun, rackspace, rcodezero, regru, rfc2136, rimuhosting, route53, safedns, sakuracloud, scaleway, selectel, selectelv2, selfhostde, servercow, shellrent, simply, sonic, stackpath, tencentcloud, timewebcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, volcengine, vscale, vultr, webnames, websupport, wedos, yandex, yandex360, yandexcloud, zoneee, zonomi
+  acme-dns, alidns, allinkl, arvancloud, auroradns, autodns, azure, azuredns, bindman, bluecat, brandit, bunny, checkdomain, civo, clouddns, cloudflare, cloudns, cloudru, cloudxns, conoha, constellix, corenetworks, cpanel, derak, desec, designate, digitalocean, directadmin, dnshomede, dnsimple, dnsmadeeasy, dnspod, dode, domeneshop, dreamhost, duckdns, dyn, dynu, easydns, edgedns, efficientip, epik, exec, exoscale, 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, liara, lightsail, limacity, linode, liquidweb, loopia, luadns, mailinabox, manual, metaname, mijnhost, mittwald, mydnsjp, mythicbeasts, namecheap, namedotcom, namesilo, nearlyfreespeech, netcup, netlify, nicmanager, nifcloud, njalla, nodion, ns1, oraclecloud, otc, ovh, pdns, plesk, porkbun, rackspace, rcodezero, regru, rfc2136, rimuhosting, route53, safedns, sakuracloud, scaleway, selectel, selectelv2, selfhostde, servercow, shellrent, simply, sonic, stackpath, tencentcloud, timewebcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, volcengine, vscale, vultr, webnames, websupport, wedos, yandex, yandex360, yandexcloud, zoneee, zonomi
 
 More information: https://go-acme.github.io/lego/dns
 """

docs/content/dns/zz_gen_corenetworks.md

@@ -0,0 +1,181 @@
+package corenetworks
+
+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/corenetworks/internal"
+)
+
+// Environment variables names.
+const (
+	envNamespace = "CORENETWORKS_"
+
+	EnvLogin    = envNamespace + "LOGIN"
+	EnvPassword = envNamespace + "PASSWORD"
+
+	EnvTTL                = envNamespace + "TTL"
+	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
+	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
+	EnvSequenceInterval   = envNamespace + "SEQUENCE_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
+	SequenceInterval   time.Duration
+	TTL                int
+	HTTPClient         *http.Client
+}
+
+// NewDefaultConfig returns a default configuration for the DNSProvider.
+func NewDefaultConfig() *Config {
+	return &Config{
+		TTL:                env.GetOrDefaultInt(EnvTTL, 3600),
+		PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
+		PollingInterval:    env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
+		SequenceInterval:   env.GetOrDefaultSecond(EnvSequenceInterval, dns01.DefaultPropagationTimeout),
+		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 Core-Networks.
+// Credentials must be passed in the environment variables: CORENETWORKS_LOGIN, CORENETWORKS_PASSWORD.
+func NewDNSProvider() (*DNSProvider, error) {
+	values, err := env.Get(EnvLogin, EnvPassword)
+	if err != nil {
+		return nil, fmt.Errorf("corenetworks: %w", err)
+	}
+
+	config := NewDefaultConfig()
+	config.Login = values[EnvLogin]
+	config.Password = values[EnvPassword]
+
+	return NewDNSProviderConfig(config)
+}
+
+// NewDNSProviderConfig return a DNSProvider instance configured for Bluecat DNS.
+func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
+	if config == nil {
+		return nil, errors.New("corenetworks: the configuration of the DNS provider is nil")
+	}
+
+	if config.Login == "" || config.Password == "" {
+		return nil, errors.New("corenetworks: credentials missing")
+	}
+
+	client := internal.NewClient(config.Login, config.Password)
+
+	if config.HTTPClient != nil {
+		client.HTTPClient = config.HTTPClient
+	}
+
+	return &DNSProvider{config: config, client: client}, 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
+}
+
+// Sequential All DNS challenges for this provider will be resolved sequentially.
+// Returns the interval between each iteration.
+func (d *DNSProvider) Sequential() time.Duration {
+	return d.config.SequenceInterval
+}
+
+// Present creates a TXT record using the specified parameters.
+func (d *DNSProvider) Present(domain, token, keyAuth string) error {
+	info := dns01.GetChallengeInfo(domain, keyAuth)
+
+	ctx, err := d.client.CreateAuthenticatedContext(context.Background())
+	if err != nil {
+		return fmt.Errorf("create authentication token: %w", err)
+	}
+
+	zone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
+	if err != nil {
+		return fmt.Errorf("corenetworks: could not find zone for domain %q: %w", domain, err)
+	}
+
+	subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, zone)
+	if err != nil {
+		return fmt.Errorf("corenetworks: %w", err)
+	}
+
+	record := internal.Record{
+		Name: subDomain,
+		TTL:  d.config.TTL,
+		Type: "TXT",
+		Data: info.Value,
+	}
+
+	err = d.client.AddRecord(ctx, dns01.UnFqdn(zone), record)
+	if err != nil {
+		return fmt.Errorf("corenetworks: add record: %w", err)
+	}
+
+	err = d.client.CommitRecords(ctx, dns01.UnFqdn(zone))
+	if err != nil {
+		return fmt.Errorf("corenetworks: commit records: %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)
+
+	ctx, err := d.client.CreateAuthenticatedContext(context.Background())
+	if err != nil {
+		return fmt.Errorf("create authentication token: %w", err)
+	}
+
+	zone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
+	if err != nil {
+		return fmt.Errorf("corenetworks: could not find zone for domain %q: %w", domain, err)
+	}
+
+	subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, zone)
+	if err != nil {
+		return fmt.Errorf("corenetworks: %w", err)
+	}
+
+	record := internal.Record{
+		Name: subDomain,
+		TTL:  d.config.TTL,
+		Type: "TXT",
+		Data: info.Value,
+	}
+
+	err = d.client.DeleteRecords(ctx, dns01.UnFqdn(zone), record)
+	if err != nil {
+		return fmt.Errorf("corenetworks: delete records: %w", err)
+	}
+
+	err = d.client.CommitRecords(ctx, dns01.UnFqdn(zone))
+	if err != nil {
+		return fmt.Errorf("corenetworks: commit records: %w", err)
+	}
+
+	return nil
+}

docs/data/zz_cli_help.toml

@@ -0,0 +1,25 @@
+Name = "Core-Networks"
+Description = ''''''
+URL = "https://www.core-networks.de/"
+Code = "corenetworks"
+Since = "v4.20.0"
+
+Example = '''
+CORENETWORKS_LOGIN="xxxx" \
+CORENETWORKS_PASSWORD="yyyy" \
+lego --email myemail@example.com --dns corenetworks --domains my.example.org run
+'''
+
+[Configuration]
+  [Configuration.Credentials]
+    CORENETWORKS_LOGIN = "The username of the API account"
+    CORENETWORKS_PASSWORD = "The password"
+  [Configuration.Additional]
+    CORENETWORKS_POLLING_INTERVAL = "Time between DNS propagation check"
+    CORENETWORKS_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
+    CORENETWORKS_TTL = "The TTL of the TXT record used for the DNS challenge"
+    CORENETWORKS_HTTP_TIMEOUT = "API request timeout"
+    CORENETWORKS_SEQUENCE_INTERVAL = "Time between sequential requests"
+
+[Links]
+  API = "https://beta.api.core-networks.de/doc/"