1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
|
// 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/v4/challenge/dns01"
"github.com/go-acme/lego/v4/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"
)
// Config is used to configure the creation of the DNSProvider.
type Config struct {
BaseURL string
Username string
Password string
Zone string
TTL int
PollingInterval time.Duration
PropagationTimeout time.Duration
HTTPTimeout time.Duration
}
// NewDefaultConfig returns a default configuration for the DNSProvider.
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),
}
return config
}
// DNSProvider implements the challenge.Provider interface.
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)
if err != nil {
return nil, fmt.Errorf("liquidweb: %w", err)
}
config := NewDefaultConfig()
config.BaseURL = env.GetOrFile(EnvURL)
config.Username = values[EnvUsername]
config.Password = values[EnvPassword]
config.Zone = values[EnvZone]
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 == "" {
return nil, errors.New("liquidweb: zone is missing")
}
if config.Username == "" {
return nil, errors.New("liquidweb: username is missing")
}
if config.Password == "" {
return nil, errors.New("liquidweb: password is missing")
}
// Initialize LW client.
client, err := lw.NewAPI(config.Username, config.Password, config.BaseURL, int(config.HTTPTimeout.Seconds()))
if err != nil {
return nil, fmt.Errorf("liquidweb: could not create Liquid Web API client: %w", err)
}
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
}
// Present creates a TXT record using the specified parameters.
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 {
return fmt.Errorf("liquidweb: could not create TXT record: %w", err)
}
d.recordIDsMu.Lock()
d.recordIDs[token] = int(dnsEntry.ID)
d.recordIDsMu.Unlock()
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
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 {
return fmt.Errorf("liquidweb: could not remove TXT record: %w", err)
}
d.recordIDsMu.Lock()
delete(d.recordIDs, token)
d.recordIDsMu.Unlock()
return nil
}
|