mirror of
https://github.com/go-acme/lego.git
synced 2024-12-05 03:58:54 +02:00
136 lines
4.1 KiB
Go
136 lines
4.1 KiB
Go
// Package regru implements a DNS provider for solving the DNS-01 challenge using reg.ru DNS.
|
|
package regru
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/go-acme/lego/v3/challenge/dns01"
|
|
"github.com/go-acme/lego/v3/platform/config/env"
|
|
"github.com/go-acme/lego/v3/providers/dns/regru/internal"
|
|
)
|
|
|
|
// Environment variables names.
|
|
const (
|
|
envNamespace = "REGRU_"
|
|
|
|
EnvUsername = envNamespace + "USERNAME"
|
|
EnvPassword = envNamespace + "PASSWORD"
|
|
|
|
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 {
|
|
Username 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{
|
|
TTL: env.GetOrDefaultInt(EnvTTL, 300),
|
|
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
|
|
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
|
|
HTTPClient: &http.Client{
|
|
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
|
|
},
|
|
}
|
|
}
|
|
|
|
// DNSProvider is an implementation of the challenge.Provider interface.
|
|
type DNSProvider struct {
|
|
config *Config
|
|
client *internal.Client
|
|
}
|
|
|
|
// NewDNSProvider returns a DNSProvider instance configured for reg.ru.
|
|
// Credentials must be passed in the environment variables:
|
|
// REGRU_USERNAME and REGRU_PASSWORD.
|
|
func NewDNSProvider() (*DNSProvider, error) {
|
|
values, err := env.Get(EnvUsername, EnvPassword)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("regru: %w", err)
|
|
}
|
|
|
|
config := NewDefaultConfig()
|
|
config.Username = values[EnvUsername]
|
|
config.Password = values[EnvPassword]
|
|
|
|
return NewDNSProviderConfig(config)
|
|
}
|
|
|
|
// NewDNSProviderConfig return a DNSProvider instance configured for reg.ru.
|
|
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
|
|
if config == nil {
|
|
return nil, errors.New("regru: the configuration of the DNS provider is nil")
|
|
}
|
|
|
|
if config.Username == "" || config.Password == "" {
|
|
return nil, errors.New("regru: incomplete credentials, missing username and/or password")
|
|
}
|
|
|
|
client := internal.NewClient(config.Username, 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
|
|
}
|
|
|
|
// 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("regru: could not find zone for domain %q and fqdn %q : %w", domain, fqdn, err)
|
|
}
|
|
|
|
subDomain := dns01.UnFqdn(strings.TrimSuffix(fqdn, authZone))
|
|
err = d.client.AddTXTRecord(dns01.UnFqdn(authZone), subDomain, value)
|
|
if err != nil {
|
|
return fmt.Errorf("regru: failed to create TXT records [domain: %s, sub domain: %s]: %w",
|
|
dns01.UnFqdn(authZone), subDomain, err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// CleanUp removes the TXT record matching the specified parameters
|
|
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
|
|
fqdn, value := dns01.GetRecord(domain, keyAuth)
|
|
|
|
authZone, err := dns01.FindZoneByFqdn(fqdn)
|
|
if err != nil {
|
|
return fmt.Errorf("regru: could not find zone for domain %q and fqdn %q : %w", domain, fqdn, err)
|
|
}
|
|
|
|
subDomain := dns01.UnFqdn(strings.TrimSuffix(fqdn, authZone))
|
|
err = d.client.RemoveTxtRecord(dns01.UnFqdn(authZone), subDomain, value)
|
|
if err != nil {
|
|
return fmt.Errorf("regru: failed to remove TXT records [domain: %s, sub domain: %s]: %w",
|
|
dns01.UnFqdn(authZone), subDomain, err)
|
|
}
|
|
|
|
return nil
|
|
}
|