lego/providers/dns/liquidweb/liquidweb.go

170 lines
4.6 KiB
Go
Raw Normal View History

2019-08-19 19:41:10 +00:00
// Package liquidweb implements a DNS provider for solving the DNS-01 challenge using Liquid Web.
package liquidweb
import (
"errors"
"fmt"
"strconv"
"sync"
"time"
"github.com/go-acme/lego/v3/challenge/dns01"
"github.com/go-acme/lego/v3/platform/config/env"
lw "github.com/liquidweb/liquidweb-go/client"
"github.com/liquidweb/liquidweb-go/network"
)
const defaultBaseURL = "https://api.stormondemand.com"
// Environment variables names.
const (
envNamespace = "LIQUID_WEB_"
EnvURL = envNamespace + "URL"
EnvUsername = envNamespace + "USERNAME"
EnvPassword = envNamespace + "PASSWORD"
EnvZone = envNamespace + "ZONE"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
2020-05-08 17:35:25 +00:00
// Config is used to configure the creation of the DNSProvider.
2019-08-19 19:41:10 +00:00
type Config struct {
BaseURL string
Username string
Password string
Zone string
TTL int
PollingInterval time.Duration
PropagationTimeout time.Duration
HTTPTimeout time.Duration
}
2020-05-08 17:35:25 +00:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
2019-08-19 19:41:10 +00:00
func NewDefaultConfig() *Config {
config := &Config{
BaseURL: defaultBaseURL,
TTL: env.GetOrDefaultInt(EnvTTL, 300),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 2*time.Minute),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 2*time.Second),
HTTPTimeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 1*time.Minute),
2019-08-19 19:41:10 +00:00
}
return config
}
2020-05-08 17:35:25 +00:00
// DNSProvider implements the challenge.Provider interface.
2019-08-19 19:41:10 +00:00
type DNSProvider struct {
config *Config
client *lw.API
recordIDs map[string]int
recordIDsMu sync.Mutex
}
// NewDNSProvider returns a DNSProvider instance configured for Liquid Web.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvUsername, EnvPassword, EnvZone)
2019-08-19 19:41:10 +00:00
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("liquidweb: %w", err)
2019-08-19 19:41:10 +00:00
}
config := NewDefaultConfig()
config.BaseURL = env.GetOrFile(EnvURL)
config.Username = values[EnvUsername]
config.Password = values[EnvPassword]
config.Zone = values[EnvZone]
2019-08-19 19:41:10 +00:00
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for Liquid Web.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("liquidweb: the configuration of the DNS provider is nil")
}
if config.BaseURL == "" {
config.BaseURL = defaultBaseURL
}
if config.Zone == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("liquidweb: zone is missing")
2019-08-19 19:41:10 +00:00
}
if config.Username == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("liquidweb: username is missing")
2019-08-19 19:41:10 +00:00
}
if config.Password == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("liquidweb: password is missing")
2019-08-19 19:41:10 +00:00
}
// Initialize LW client.
client, err := lw.NewAPI(config.Username, config.Password, config.BaseURL, int(config.HTTPTimeout.Seconds()))
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("liquidweb: could not create Liquid Web API client: %w", err)
2019-08-19 19:41:10 +00:00
}
return &DNSProvider{
config: config,
recordIDs: make(map[string]int),
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() (time.Duration, time.Duration) {
return d.config.PropagationTimeout, d.config.PollingInterval
}
2020-05-08 17:35:25 +00:00
// Present creates a TXT record using the specified parameters.
2019-08-19 19:41:10 +00:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
fqdn, value := dns01.GetRecord(domain, keyAuth)
params := &network.DNSRecordParams{
Name: dns01.UnFqdn(fqdn),
RData: strconv.Quote(value),
Type: "TXT",
Zone: d.config.Zone,
TTL: d.config.TTL,
}
dnsEntry, err := d.client.NetworkDNS.Create(params)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("liquidweb: could not create TXT record: %w", err)
2019-08-19 19:41:10 +00:00
}
d.recordIDsMu.Lock()
d.recordIDs[token] = int(dnsEntry.ID)
d.recordIDsMu.Unlock()
return nil
}
2020-05-08 17:35:25 +00:00
// CleanUp removes the TXT record matching the specified parameters.
2019-08-19 19:41:10 +00:00
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
d.recordIDsMu.Lock()
recordID, ok := d.recordIDs[token]
d.recordIDsMu.Unlock()
if !ok {
return fmt.Errorf("liquidweb: unknown record ID for '%s'", domain)
}
params := &network.DNSRecordParams{ID: recordID}
_, err := d.client.NetworkDNS.Delete(params)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("liquidweb: could not remove TXT record: %w", err)
2019-08-19 19:41:10 +00:00
}
d.recordIDsMu.Lock()
delete(d.recordIDs, token)
d.recordIDsMu.Unlock()
return nil
}