mirror of
https://github.com/go-acme/lego.git
synced 2024-12-23 17:21:50 +02:00
193 lines
5.3 KiB
Go
193 lines
5.3 KiB
Go
// Package loopia implements a DNS provider for solving the DNS-01 challenge using loopia DNS.
|
|
package loopia
|
|
|
|
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/loopia/internal"
|
|
)
|
|
|
|
const minTTL = 300
|
|
|
|
// Environment variables names.
|
|
const (
|
|
envNamespace = "LOOPIA_"
|
|
|
|
EnvAPIUser = envNamespace + "API_USER"
|
|
EnvAPIPassword = envNamespace + "API_PASSWORD"
|
|
|
|
EnvTTL = envNamespace + "TTL"
|
|
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
|
|
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
|
|
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
|
|
)
|
|
|
|
type dnsClient interface {
|
|
AddTXTRecord(domain string, subdomain string, ttl int, value string) error
|
|
RemoveTXTRecord(domain string, subdomain string, recordID int) error
|
|
GetTXTRecords(domain string, subdomain string) ([]internal.RecordObj, error)
|
|
RemoveSubdomain(domain, subdomain string) error
|
|
}
|
|
|
|
// Config is used to configure the creation of the DNSProvider.
|
|
type Config struct {
|
|
BaseURL string
|
|
APIUser string
|
|
APIPassword 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{
|
|
BaseURL: internal.DefaultBaseURL,
|
|
TTL: env.GetOrDefaultInt(EnvTTL, minTTL),
|
|
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 40*time.Minute),
|
|
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 60*time.Second),
|
|
HTTPClient: &http.Client{
|
|
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 60*time.Second),
|
|
},
|
|
}
|
|
}
|
|
|
|
// DNSProvider implements the challenge.Provider interface.
|
|
type DNSProvider struct {
|
|
config *Config
|
|
client dnsClient
|
|
|
|
inProgressInfo map[string]int
|
|
inProgressMu sync.Mutex
|
|
|
|
findZoneByFqdn func(fqdn string) (string, error)
|
|
}
|
|
|
|
// NewDNSProvider returns a DNSProvider instance configured for Loopia.
|
|
// Credentials must be passed in the environment variables:
|
|
// LOOPIA_API_USER, LOOPIA_API_PASSWORD.
|
|
func NewDNSProvider() (*DNSProvider, error) {
|
|
values, err := env.Get(EnvAPIUser, EnvAPIPassword)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("loopia: %w", err)
|
|
}
|
|
|
|
config := NewDefaultConfig()
|
|
config.APIUser = values[EnvAPIUser]
|
|
config.APIPassword = values[EnvAPIPassword]
|
|
|
|
return NewDNSProviderConfig(config)
|
|
}
|
|
|
|
// NewDNSProviderConfig return a DNSProvider instance configured for Loopia.
|
|
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
|
|
if config == nil {
|
|
return nil, errors.New("loopia: the configuration of the DNS provider is nil")
|
|
}
|
|
|
|
if config.APIUser == "" || config.APIPassword == "" {
|
|
return nil, errors.New("loopia: credentials missing")
|
|
}
|
|
|
|
// Min value for TTL is 300
|
|
if config.TTL < 300 {
|
|
config.TTL = 300
|
|
}
|
|
|
|
client := internal.NewClient(config.APIUser, config.APIPassword)
|
|
|
|
if config.HTTPClient != nil {
|
|
client.HTTPClient = config.HTTPClient
|
|
}
|
|
|
|
return &DNSProvider{
|
|
config: config,
|
|
client: client,
|
|
findZoneByFqdn: dns01.FindZoneByFqdn,
|
|
inProgressInfo: make(map[string]int),
|
|
}, 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)
|
|
|
|
subdomain, authZone := d.splitDomain(fqdn)
|
|
|
|
err := d.client.AddTXTRecord(authZone, subdomain, d.config.TTL, value)
|
|
if err != nil {
|
|
return fmt.Errorf("loopia: failed to add TXT record: %w", err)
|
|
}
|
|
|
|
txtRecords, err := d.client.GetTXTRecords(authZone, subdomain)
|
|
if err != nil {
|
|
return fmt.Errorf("loopia: failed to get TXT records: %w", err)
|
|
}
|
|
|
|
d.inProgressMu.Lock()
|
|
defer d.inProgressMu.Unlock()
|
|
|
|
for _, r := range txtRecords {
|
|
if r.Rdata == value {
|
|
d.inProgressInfo[token] = r.RecordID
|
|
return nil
|
|
}
|
|
}
|
|
|
|
return errors.New("loopia: failed to find the stored TXT record")
|
|
}
|
|
|
|
// CleanUp removes the TXT record matching the specified parameters.
|
|
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
|
|
fqdn, _ := dns01.GetRecord(domain, keyAuth)
|
|
|
|
subdomain, authZone := d.splitDomain(fqdn)
|
|
|
|
d.inProgressMu.Lock()
|
|
defer d.inProgressMu.Unlock()
|
|
|
|
err := d.client.RemoveTXTRecord(authZone, subdomain, d.inProgressInfo[token])
|
|
if err != nil {
|
|
return fmt.Errorf("loopia: failed to remove TXT record: %w", err)
|
|
}
|
|
|
|
records, err := d.client.GetTXTRecords(authZone, subdomain)
|
|
if err != nil {
|
|
return fmt.Errorf("loopia: failed to get TXT records: %w", err)
|
|
}
|
|
|
|
if len(records) > 0 {
|
|
return nil
|
|
}
|
|
|
|
err = d.client.RemoveSubdomain(authZone, subdomain)
|
|
if err != nil {
|
|
return fmt.Errorf("loopia: failed to remove sub-domain: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (d *DNSProvider) splitDomain(fqdn string) (string, string) {
|
|
authZone, _ := d.findZoneByFqdn(fqdn)
|
|
authZone = dns01.UnFqdn(authZone)
|
|
|
|
subdomain := strings.TrimSuffix(dns01.UnFqdn(fqdn), "."+authZone)
|
|
|
|
return subdomain, authZone
|
|
}
|