mirror of
https://github.com/go-acme/lego.git
synced 2024-12-23 09:15:11 +02:00
183 lines
4.7 KiB
Go
183 lines
4.7 KiB
Go
// Package arvancloud implements a DNS provider for solving the DNS-01 challenge using ArvanCloud DNS.
|
|
package arvancloud
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"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/arvancloud/internal"
|
|
)
|
|
|
|
const minTTL = 600
|
|
|
|
// Environment variables names.
|
|
const (
|
|
envNamespace = "ARVANCLOUD_"
|
|
|
|
EnvAPIKey = envNamespace + "API_KEY"
|
|
|
|
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 {
|
|
APIKey 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, minTTL),
|
|
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 120*time.Second),
|
|
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 2*time.Second),
|
|
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 ArvanCloud.
|
|
// Credentials must be passed in the environment variable: ARVANCLOUD_API_KEY.
|
|
func NewDNSProvider() (*DNSProvider, error) {
|
|
values, err := env.Get(EnvAPIKey)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("arvancloud: %w", err)
|
|
}
|
|
|
|
config := NewDefaultConfig()
|
|
config.APIKey = values[EnvAPIKey]
|
|
|
|
return NewDNSProviderConfig(config)
|
|
}
|
|
|
|
// NewDNSProviderConfig return a DNSProvider instance configured for ArvanCloud.
|
|
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
|
|
if config == nil {
|
|
return nil, errors.New("arvancloud: the configuration of the DNS provider is nil")
|
|
}
|
|
|
|
if config.APIKey == "" {
|
|
return nil, errors.New("arvancloud: credentials missing")
|
|
}
|
|
|
|
if config.TTL < minTTL {
|
|
return nil, fmt.Errorf("arvancloud: invalid TTL, TTL (%d) must be greater than %d", config.TTL, minTTL)
|
|
}
|
|
|
|
client := internal.NewClient(config.APIKey)
|
|
|
|
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 to fulfill the dns-01 challenge.
|
|
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
|
|
fqdn, value := dns01.GetRecord(domain, keyAuth)
|
|
|
|
authZone, err := getZone(fqdn)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
subDomain, err := dns01.ExtractSubDomain(fqdn, authZone)
|
|
if err != nil {
|
|
return fmt.Errorf("arvancloud: %w", err)
|
|
}
|
|
|
|
record := internal.DNSRecord{
|
|
Type: "txt",
|
|
Name: subDomain,
|
|
Value: internal.TXTRecordValue{Text: value},
|
|
TTL: d.config.TTL,
|
|
UpstreamHTTPS: "default",
|
|
IPFilterMode: &internal.IPFilterMode{
|
|
Count: "single",
|
|
GeoFilter: "none",
|
|
Order: "none",
|
|
},
|
|
}
|
|
|
|
newRecord, err := d.client.CreateRecord(authZone, record)
|
|
if err != nil {
|
|
return fmt.Errorf("arvancloud: failed to add TXT record: fqdn=%s: %w", fqdn, err)
|
|
}
|
|
|
|
d.recordIDsMu.Lock()
|
|
d.recordIDs[token] = newRecord.ID
|
|
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)
|
|
|
|
authZone, err := getZone(fqdn)
|
|
if err != nil {
|
|
return 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("arvancloud: unknown record ID for '%s' '%s'", fqdn, token)
|
|
}
|
|
|
|
if err := d.client.DeleteRecord(authZone, recordID); err != nil {
|
|
return fmt.Errorf("arvancloud: failed to delate TXT record: id=%s: %w", recordID, err)
|
|
}
|
|
|
|
// deletes record ID from map
|
|
d.recordIDsMu.Lock()
|
|
delete(d.recordIDs, token)
|
|
d.recordIDsMu.Unlock()
|
|
|
|
return nil
|
|
}
|
|
|
|
func getZone(fqdn string) (string, error) {
|
|
authZone, err := dns01.FindZoneByFqdn(fqdn)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
return dns01.UnFqdn(authZone), nil
|
|
}
|