Add DNS provider for cloud.ru (#1968)

Author: ldez

README.md

@@ -31,6 +31,7 @@ func allDNSCodes() string {
 		"clouddns",
 		"cloudflare",
 		"cloudns",
+		"cloudru",
 		"cloudxns",
 		"conoha",
 		"constellix",
@@ -516,6 +517,29 @@ func displayDNSHelp(w io.Writer, name string) error {
 		ew.writeln()
 		ew.writeln(`More information: https://go-acme.github.io/lego/dns/cloudns`)
 
+	case "cloudru":
+		// generated from: providers/dns/cloudru/cloudru.toml
+		ew.writeln(`Configuration for Cloud.ru.`)
+		ew.writeln(`Code:	'cloudru'`)
+		ew.writeln(`Since:	'v4.14.0'`)
+		ew.writeln()
+
+		ew.writeln(`Credentials:`)
+		ew.writeln(`	- "CLOUDRU_KEY_ID":	Key ID (login)`)
+		ew.writeln(`	- "CLOUDRU_SECRET":	Key Secret`)
+		ew.writeln(`	- "CLOUDRU_SERVICE_INSTANCE_ID":	Service Instance ID (parentId)`)
+		ew.writeln()
+
+		ew.writeln(`Additional Configuration:`)
+		ew.writeln(`	- "CLOUDRU_HTTP_TIMEOUT":	API request timeout`)
+		ew.writeln(`	- "CLOUDRU_POLLING_INTERVAL":	Time between DNS propagation check`)
+		ew.writeln(`	- "CLOUDRU_PROPAGATION_TIMEOUT":	Maximum waiting time for DNS propagation`)
+		ew.writeln(`	- "CLOUDRU_SEQUENCE_INTERVAL":	Time between sequential requests`)
+		ew.writeln(`	- "CLOUDRU_TTL":	The TTL of the TXT record used for the DNS challenge`)
+
+		ew.writeln()
+		ew.writeln(`More information: https://go-acme.github.io/lego/dns/cloudru`)
+
 	case "cloudxns":
 		// generated from: providers/dns/cloudxns/cloudxns.toml
 		ew.writeln(`Configuration for CloudXNS.`)

cmd/zz_gen_cmd_dnshelp.go

@@ -0,0 +1,72 @@
+---
+title: "Cloud.ru"
+date: 2019-03-03T16:39:46+01:00
+draft: false
+slug: cloudru
+dnsprovider:
+  since:    "v4.14.0"
+  code:     "cloudru"
+  url:      "https://cloud.ru"
+---
+
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
+<!-- providers/dns/cloudru/cloudru.toml -->
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
+
+
+Configuration for [Cloud.ru](https://cloud.ru).
+
+
+<!--more-->
+
+- Code: `cloudru`
+- Since: v4.14.0
+
+
+Here is an example bash command using the Cloud.ru provider:
+
+```bash
+CLOUDRU_SERVICE_INSTANCE_ID=ppp \
+CLOUDRU_KEY_ID=xxx \
+CLOUDRU_SECRET=yyy \
+lego --email [email protected] --dns cloudru --domains my.example.org run
+```
+
+
+
+
+## Credentials
+
+| Environment Variable Name | Description |
+|-----------------------|-------------|
+| `CLOUDRU_KEY_ID` | Key ID (login) |
+| `CLOUDRU_SECRET` | Key Secret |
+| `CLOUDRU_SERVICE_INSTANCE_ID` | Service Instance ID (parentId) |
+
+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 |
+|--------------------------------|-------------|
+| `CLOUDRU_HTTP_TIMEOUT` | API request timeout |
+| `CLOUDRU_POLLING_INTERVAL` | Time between DNS propagation check |
+| `CLOUDRU_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
+| `CLOUDRU_SEQUENCE_INTERVAL` | Time between sequential requests |
+| `CLOUDRU_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://cloud.ru/ru/docs/clouddns/ug/topics/api-ref.html)
+
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
+<!-- providers/dns/cloudru/cloudru.toml -->
+<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->

docs/content/dns/zz_gen_cloudru.md

@@ -137,7 +137,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, cloudxns, conoha, constellix, derak, desec, designate, digitalocean, 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, httpreq, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ipv64, iwantmyname, joker, liara, lightsail, linode, liquidweb, loopia, luadns, manual, metaname, 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, servercow, simply, sonic, stackpath, tencentcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, vscale, vultr, websupport, wedos, yandex, 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, derak, desec, designate, digitalocean, 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, httpreq, hurricane, hyperone, ibmcloud, iij, iijdpf, infoblox, infomaniak, internetbs, inwx, ionos, ipv64, iwantmyname, joker, liara, lightsail, linode, liquidweb, loopia, luadns, manual, metaname, 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, servercow, simply, sonic, stackpath, tencentcloud, transip, ultradns, variomedia, vegadns, vercel, versio, vinyldns, vkcloud, vscale, vultr, websupport, wedos, yandex, yandexcloud, zoneee, zonomi
 
 More information: https://go-acme.github.io/lego/dns
 """

docs/data/zz_cli_help.toml

@@ -0,0 +1,200 @@
+// Package cloudru implements a DNS provider for solving the DNS-01 challenge using cloud.ru DNS.
+package cloudru
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"net/http"
+	"strconv"
+	"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/cloudru/internal"
+)
+
+// Environment variables names.
+const (
+	envNamespace = "CLOUDRU_"
+
+	EnvServiceInstanceID = envNamespace + "SERVICE_INSTANCE_ID"
+	EnvKeyID             = envNamespace + "KEY_ID"
+	EnvSecret            = envNamespace + "SECRET"
+
+	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 {
+	ServiceInstanceID string
+	KeyID             string
+	Secret            string
+
+	PropagationTimeout time.Duration
+	PollingInterval    time.Duration
+	SequenceInterval   time.Duration
+	HTTPClient         *http.Client
+	TTL                int
+}
+
+// NewDefaultConfig returns a default configuration for the DNSProvider.
+func NewDefaultConfig() *Config {
+	return &Config{
+		TTL:                env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
+		PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 5*time.Minute),
+		PollingInterval:    env.GetOrDefaultSecond(EnvPollingInterval, 5*time.Second),
+		SequenceInterval:   env.GetOrDefaultSecond(EnvSequenceInterval, dns01.DefaultPropagationTimeout),
+		HTTPClient: &http.Client{
+			Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
+		},
+	}
+}
+
+type DNSProvider struct {
+	config    *Config
+	client    *internal.Client
+	records   map[string]*internal.Record
+	recordsMu sync.Mutex
+}
+
+// NewDNSProvider returns a DNSProvider instance configured for cloud.ru.
+// Credentials must be passed in the environment variables:
+// CLOUDRU_SERVICE_INSTANCE_ID, CLOUDRU_KEY_ID, and CLOUDRU_SECRET.
+func NewDNSProvider() (*DNSProvider, error) {
+	values, err := env.Get(EnvServiceInstanceID, EnvKeyID, EnvSecret)
+	if err != nil {
+		return nil, fmt.Errorf("cloudru: %w", err)
+	}
+
+	config := NewDefaultConfig()
+	config.ServiceInstanceID = values[EnvServiceInstanceID]
+	config.KeyID = values[EnvKeyID]
+	config.Secret = values[EnvSecret]
+
+	return NewDNSProviderConfig(config)
+}
+
+// NewDNSProviderConfig return a DNSProvider instance configured for cloud.ru.
+func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
+	if config == nil {
+		return nil, errors.New("cloudru: the configuration of the DNS provider is nil")
+	}
+
+	if config.ServiceInstanceID == "" || config.KeyID == "" || config.Secret == "" {
+		return nil, errors.New("cloudru: some credentials information are missing")
+	}
+
+	client := internal.NewClient(config.KeyID, config.Secret)
+
+	if config.HTTPClient != nil {
+		client.HTTPClient = config.HTTPClient
+	}
+
+	return &DNSProvider{
+		config:  config,
+		client:  client,
+		records: make(map[string]*internal.Record),
+	}, nil
+}
+
+// Present creates a TXT record using the specified parameters.
+func (d *DNSProvider) Present(domain, token, keyAuth string) error {
+	info := dns01.GetChallengeInfo(domain, keyAuth)
+
+	authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
+	if err != nil {
+		return fmt.Errorf("cloudru: could not find zone for domain %q (%s): %w", domain, info.EffectiveFQDN, err)
+	}
+
+	authZone = dns01.UnFqdn(authZone)
+
+	ctx, err := d.client.CreateAuthenticatedContext(context.Background())
+	if err != nil {
+		return fmt.Errorf("cloudru: %w", err)
+	}
+
+	zone, err := d.getZoneInformationByName(ctx, d.config.ServiceInstanceID, authZone)
+	if err != nil {
+		return fmt.Errorf("cloudru: could not find zone information (ServiceInstanceID: %s, zone: %s): %w", d.config.ServiceInstanceID, authZone, err)
+	}
+
+	record := internal.Record{
+		Name:   info.EffectiveFQDN,
+		Type:   "TXT",
+		Values: []string{info.Value},
+		TTL:    strconv.Itoa(d.config.TTL),
+	}
+
+	newRecord, err := d.client.CreateRecord(ctx, zone.ID, record)
+	if err != nil {
+		return fmt.Errorf("cloudru: could not create record: %w", err)
+	}
+
+	d.recordsMu.Lock()
+	d.records[token] = newRecord
+	d.recordsMu.Unlock()
+
+	return nil
+}
+
+// CleanUp removes a given record that was generated by Present.
+func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
+	info := dns01.GetChallengeInfo(domain, keyAuth)
+
+	d.recordsMu.Lock()
+	record, ok := d.records[token]
+	d.recordsMu.Unlock()
+
+	if !ok {
+		return fmt.Errorf("cloudru: unknown recordID for %q", info.EffectiveFQDN)
+	}
+
+	ctx, err := d.client.CreateAuthenticatedContext(context.Background())
+	if err != nil {
+		return fmt.Errorf("cloudru: %w", err)
+	}
+
+	err = d.client.DeleteRecord(ctx, record.ZoneID, record.Name, "TXT")
+	if err != nil {
+		return fmt.Errorf("cloudru: %w", err)
+	}
+
+	d.recordsMu.Lock()
+	delete(d.records, token)
+	d.recordsMu.Unlock()
+
+	return nil
+}
+
+// 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
+}
+
+// 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) getZoneInformationByName(ctx context.Context, parentID, name string) (internal.Zone, error) {
+	zs, err := d.client.GetZones(ctx, parentID)
+	if err != nil {
+		return internal.Zone{}, err
+	}
+
+	for _, element := range zs {
+		if element.Name == name {
+			return element, nil
+		}
+	}
+
+	return internal.Zone{}, errors.New("could not find Zone record")
+}

providers/dns/cloudru/cloudru.go

@@ -0,0 +1,27 @@
+Name = "Cloud.ru"
+Description = ''''''
+URL = "https://cloud.ru"
+Code = "cloudru"
+Since = "v4.14.0"
+
+Example = '''
+CLOUDRU_SERVICE_INSTANCE_ID=ppp \
+CLOUDRU_KEY_ID=xxx \
+CLOUDRU_SECRET=yyy \
+lego --email [email protected] --dns cloudru --domains my.example.org run
+'''
+
+[Configuration]
+  [Configuration.Credentials]
+    CLOUDRU_SERVICE_INSTANCE_ID = "Service Instance ID (parentId)"
+    CLOUDRU_KEY_ID = "Key ID (login)"
+    CLOUDRU_SECRET = "Key Secret"
+  [Configuration.Additional]
+    CLOUDRU_POLLING_INTERVAL = "Time between DNS propagation check"
+    CLOUDRU_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
+    CLOUDRU_TTL = "The TTL of the TXT record used for the DNS challenge"
+    CLOUDRU_HTTP_TIMEOUT = "API request timeout"
+    CLOUDRU_SEQUENCE_INTERVAL = "Time between sequential requests"
+
+[Links]
+  API = "https://cloud.ru/ru/docs/clouddns/ug/topics/api-ref.html"