1
0
mirror of https://github.com/go-acme/lego.git synced 2024-12-24 01:29:16 +02:00
lego/providers/dns/autodns/autodns.go

152 lines
4.3 KiB
Go
Raw Normal View History

2020-05-08 19:35:25 +02:00
// Package autodns implements a DNS provider for solving the DNS-01 challenge using auto DNS.
2019-11-01 12:20:34 +02:00
package autodns
import (
2023-05-05 09:49:38 +02:00
"context"
2020-02-27 20:14:46 +02:00
"errors"
2019-11-01 12:20:34 +02:00
"fmt"
"net/http"
"net/url"
"time"
2020-09-02 03:20:01 +02:00
"github.com/go-acme/lego/v4/challenge/dns01"
"github.com/go-acme/lego/v4/platform/config/env"
2023-05-05 09:49:38 +02:00
"github.com/go-acme/lego/v4/providers/dns/autodns/internal"
2019-11-01 12:20:34 +02:00
)
// Environment variables names.
2019-11-01 12:20:34 +02:00
const (
envNamespace = "AUTODNS_"
EnvAPIUser = envNamespace + "API_USER"
EnvAPIPassword = envNamespace + "API_PASSWORD"
EnvAPIEndpoint = envNamespace + "ENDPOINT"
EnvAPIEndpointContext = envNamespace + "CONTEXT"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
2019-11-01 12:20:34 +02:00
)
2020-05-08 19:35:25 +02:00
// Config is used to configure the creation of the DNSProvider.
2019-11-01 12:20:34 +02:00
type Config struct {
Endpoint *url.URL
Username string
Password string
Context int
TTL int
PropagationTimeout time.Duration
PollingInterval time.Duration
HTTPClient *http.Client
}
2020-05-08 19:35:25 +02:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
2019-11-01 12:20:34 +02:00
func NewDefaultConfig() *Config {
2023-05-05 09:49:38 +02:00
endpoint, _ := url.Parse(env.GetOrDefaultString(EnvAPIEndpoint, internal.DefaultEndpoint))
2019-11-01 12:20:34 +02:00
return &Config{
Endpoint: endpoint,
2023-05-05 09:49:38 +02:00
Context: env.GetOrDefaultInt(EnvAPIEndpointContext, internal.DefaultEndpointContext),
TTL: env.GetOrDefaultInt(EnvTTL, 600),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 2*time.Minute),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 2*time.Second),
2019-11-01 12:20:34 +02:00
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
2019-11-01 12:20:34 +02:00
},
}
}
2020-05-08 19:35:25 +02:00
// DNSProvider implements the challenge.Provider interface.
2019-11-01 12:20:34 +02:00
type DNSProvider struct {
config *Config
2023-05-05 09:49:38 +02:00
client *internal.Client
2019-11-01 12:20:34 +02:00
}
2020-05-08 19:35:25 +02:00
// NewDNSProvider returns a DNSProvider instance configured for autoDNS.
// Credentials must be passed in the environment variables.
2019-11-01 12:20:34 +02:00
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvAPIUser, EnvAPIPassword)
2019-11-01 12:20:34 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("autodns: %w", err)
2019-11-01 12:20:34 +02:00
}
config := NewDefaultConfig()
config.Username = values[EnvAPIUser]
config.Password = values[EnvAPIPassword]
2019-11-01 12:20:34 +02:00
return NewDNSProviderConfig(config)
}
2020-05-08 19:35:25 +02:00
// NewDNSProviderConfig return a DNSProvider instance configured for autoDNS.
2019-11-01 12:20:34 +02:00
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
2020-02-27 20:14:46 +02:00
return nil, errors.New("autodns: config is nil")
2019-11-01 12:20:34 +02:00
}
if config.Username == "" {
2020-02-27 20:14:46 +02:00
return nil, errors.New("autodns: missing user")
2019-11-01 12:20:34 +02:00
}
if config.Password == "" {
2020-02-27 20:14:46 +02:00
return nil, errors.New("autodns: missing password")
2019-11-01 12:20:34 +02:00
}
2023-05-05 09:49:38 +02:00
client := internal.NewClient(config.Username, config.Password, config.Context)
if config.Endpoint != nil {
client.BaseURL = config.Endpoint
}
if config.HTTPClient != nil {
client.HTTPClient = config.HTTPClient
}
return &DNSProvider{config: config, client: client}, nil
2019-11-01 12:20:34 +02:00
}
2020-05-08 19:35:25 +02:00
// 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.
2019-11-01 12:20:34 +02:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
2019-11-01 12:20:34 +02:00
2023-05-05 09:49:38 +02:00
records := []*internal.ResourceRecord{{
Name: info.EffectiveFQDN,
2019-11-01 12:20:34 +02:00
TTL: int64(d.config.TTL),
Type: "TXT",
Value: info.Value,
2019-11-01 12:20:34 +02:00
}}
2022-11-25 19:12:21 +02:00
// TODO(ldez) replace domain by FQDN to follow CNAME.
2023-05-05 09:49:38 +02:00
_, err := d.client.AddTxtRecords(context.Background(), domain, records)
2019-11-01 12:20:34 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("autodns: %w", err)
2019-11-01 12:20:34 +02:00
}
return nil
}
2020-05-08 19:35:25 +02:00
// CleanUp removes the TXT record previously created.
2019-11-01 12:20:34 +02:00
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
2019-11-01 12:20:34 +02:00
2023-05-05 09:49:38 +02:00
records := []*internal.ResourceRecord{{
Name: info.EffectiveFQDN,
2019-11-01 12:20:34 +02:00
TTL: int64(d.config.TTL),
Type: "TXT",
Value: info.Value,
2019-11-01 12:20:34 +02:00
}}
2022-11-25 19:12:21 +02:00
// TODO(ldez) replace domain by FQDN to follow CNAME.
2023-05-05 09:49:38 +02:00
if err := d.client.RemoveTXTRecords(context.Background(), domain, records); err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("autodns: %w", err)
2019-11-01 12:20:34 +02:00
}
return nil
}