mirror of
https://github.com/go-acme/lego.git
synced 2024-12-03 03:08:57 +02:00
128 lines
3.9 KiB
Go
128 lines
3.9 KiB
Go
// Package sonic implements a DNS provider for solving the DNS-01 challenge using Sonic.
|
|
package sonic
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"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/sonic/internal"
|
|
)
|
|
|
|
// Environment variables names.
|
|
const (
|
|
envNamespace = "SONIC_"
|
|
|
|
EnvUserID = envNamespace + "USER_ID"
|
|
EnvAPIKey = envNamespace + "API_KEY"
|
|
|
|
EnvTTL = envNamespace + "TTL"
|
|
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
|
|
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
|
|
EnvSequenceInterval = envNamespace + "SEQUENCE_INTERVAL"
|
|
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
|
|
)
|
|
|
|
// Config is used to configure the creation of the DNSProvider.
|
|
type Config struct {
|
|
UserID string
|
|
APIKey string
|
|
HTTPClient *http.Client
|
|
PropagationTimeout time.Duration
|
|
PollingInterval time.Duration
|
|
SequenceInterval time.Duration
|
|
TTL int
|
|
}
|
|
|
|
// NewDefaultConfig returns a default configuration for the DNSProvider.
|
|
func NewDefaultConfig() *Config {
|
|
return &Config{
|
|
TTL: env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
|
|
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
|
|
SequenceInterval: env.GetOrDefaultSecond(EnvSequenceInterval, dns01.DefaultPropagationTimeout),
|
|
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
|
|
HTTPClient: &http.Client{
|
|
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 10*time.Second),
|
|
},
|
|
}
|
|
}
|
|
|
|
// DNSProvider implements the challenge.Provider interface.
|
|
type DNSProvider struct {
|
|
config *Config
|
|
client *internal.Client
|
|
}
|
|
|
|
// NewDNSProvider returns a DNSProvider instance configured for Sonic.
|
|
// Credentials must be passed in the environment variables:
|
|
// SONIC_USERID and SONIC_APIKEY.
|
|
func NewDNSProvider() (*DNSProvider, error) {
|
|
values, err := env.Get(EnvUserID, EnvAPIKey)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("sonic: %w", err)
|
|
}
|
|
|
|
config := NewDefaultConfig()
|
|
config.UserID = values[EnvUserID]
|
|
config.APIKey = values[EnvAPIKey]
|
|
|
|
return NewDNSProviderConfig(config)
|
|
}
|
|
|
|
// NewDNSProviderConfig return a DNSProvider instance configured for Sonic.
|
|
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
|
|
if config == nil {
|
|
return nil, errors.New("sonic: the configuration of the DNS provider is nil")
|
|
}
|
|
|
|
client, err := internal.NewClient(config.UserID, config.APIKey)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("sonic: %w", err)
|
|
}
|
|
|
|
if config.HTTPClient != nil {
|
|
client.HTTPClient = config.HTTPClient
|
|
}
|
|
|
|
return &DNSProvider{client: client, config: config}, nil
|
|
}
|
|
|
|
// Present creates a TXT record using the specified parameters.
|
|
func (d *DNSProvider) Present(domainName, token, keyAuth string) error {
|
|
fqdn, value := dns01.GetRecord(domainName, keyAuth)
|
|
|
|
err := d.client.SetRecord(dns01.UnFqdn(fqdn), value, d.config.TTL)
|
|
if err != nil {
|
|
return fmt.Errorf("sonic: unable to create record for %s: %w", fqdn, err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// CleanUp removes the TXT records matching the specified parameters.
|
|
func (d *DNSProvider) CleanUp(domainName, token, keyAuth string) error {
|
|
fqdn, _ := dns01.GetRecord(domainName, keyAuth)
|
|
|
|
err := d.client.SetRecord(dns01.UnFqdn(fqdn), "_", d.config.TTL)
|
|
if err != nil {
|
|
return fmt.Errorf("sonic: unable to clean record for %s: %w", fqdn, err)
|
|
}
|
|
|
|
return 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
|
|
}
|
|
|
|
// Sequential All DNS challenges for this provider will be resolved sequentially.
|
|
// Returns the interval between each iteration.
|
|
func (d *DNSProvider) Sequential() time.Duration {
|
|
return d.config.SequenceInterval
|
|
}
|