1
0
mirror of https://github.com/go-acme/lego.git synced 2024-12-23 09:15:11 +02:00
lego/providers/dns/digitalocean/digitalocean.go

166 lines
4.7 KiB
Go
Raw Normal View History

// Package digitalocean implements a DNS provider for solving the DNS-01 challenge using digitalocean DNS.
2016-02-29 04:48:41 +02:00
package digitalocean
import (
2023-05-05 09:49:38 +02:00
"context"
"errors"
"fmt"
"net/http"
2023-05-05 09:49:38 +02:00
"net/url"
"sync"
"time"
2016-02-29 04:48:41 +02:00
"github.com/go-acme/lego/v4/challenge"
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/digitalocean/internal"
)
// Environment variables names.
const (
envNamespace = "DO_"
EnvAuthToken = envNamespace + "AUTH_TOKEN"
EnvAPIUrl = envNamespace + "API_URL"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
var _ challenge.ProviderTimeout = (*DNSProvider)(nil)
2020-05-08 19:35:25 +02:00
// Config is used to configure the creation of the DNSProvider.
type Config struct {
BaseURL string
AuthToken string
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.
func NewDefaultConfig() *Config {
return &Config{
2023-05-05 09:49:38 +02:00
BaseURL: env.GetOrDefaultString(EnvAPIUrl, internal.DefaultBaseURL),
TTL: env.GetOrDefaultInt(EnvTTL, 30),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 60*time.Second),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 5*time.Second),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
},
}
}
2020-05-08 19:35:25 +02:00
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
2023-05-05 09:49:38 +02:00
config *Config
client *internal.Client
recordIDs map[string]int
recordIDsMu sync.Mutex
2018-05-30 19:53:04 +02:00
}
// NewDNSProvider returns a DNSProvider instance configured for Digital
// Ocean. Credentials must be passed in the environment variable:
// DO_AUTH_TOKEN.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvAuthToken)
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("digitalocean: %w", err)
}
config := NewDefaultConfig()
config.AuthToken = values[EnvAuthToken]
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for Digital Ocean.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("digitalocean: the configuration of the DNS provider is nil")
}
if config.AuthToken == "" {
2020-02-27 20:14:46 +02:00
return nil, errors.New("digitalocean: credentials missing")
}
2023-05-05 09:49:38 +02:00
client := internal.NewClient(internal.OAuthStaticAccessToken(config.HTTPClient, config.AuthToken))
if config.BaseURL != "" {
var err error
client.BaseURL, err = url.Parse(config.BaseURL)
if err != nil {
return nil, fmt.Errorf("digitalocean: %w", err)
}
}
return &DNSProvider{
config: config,
2023-05-05 09:49:38 +02:00
client: client,
recordIDs: 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
}
2020-05-08 19:35:25 +02:00
// Present creates a TXT record using the specified parameters.
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
2023-05-05 09:49:38 +02:00
if err != nil {
return fmt.Errorf("digitalocean: could not find zone for domain %q: %w", domain, err)
2023-05-05 09:49:38 +02:00
}
record := internal.Record{Type: "TXT", Name: info.EffectiveFQDN, Data: info.Value, TTL: d.config.TTL}
respData, err := d.client.AddTxtRecord(context.Background(), authZone, record)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("digitalocean: %w", err)
}
d.recordIDsMu.Lock()
2019-11-05 13:58:13 +02:00
d.recordIDs[token] = respData.DomainRecord.ID
d.recordIDsMu.Unlock()
return nil
}
2020-05-08 19:35:25 +02:00
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("digitalocean: could not find zone for domain %q: %w", domain, err)
}
// get the record's unique ID from when we created it
d.recordIDsMu.Lock()
2019-11-05 13:58:13 +02:00
recordID, ok := d.recordIDs[token]
d.recordIDsMu.Unlock()
if !ok {
return fmt.Errorf("digitalocean: unknown record ID for '%s'", info.EffectiveFQDN)
}
2023-05-05 09:49:38 +02:00
err = d.client.RemoveTxtRecord(context.Background(), authZone, recordID)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("digitalocean: %w", err)
}
// Delete record ID from map
d.recordIDsMu.Lock()
2019-11-05 13:58:13 +02:00
delete(d.recordIDs, token)
d.recordIDsMu.Unlock()
return nil
}