mirror of
https://github.com/go-acme/lego.git
synced 2024-12-23 09:15:11 +02:00
205 lines
5.6 KiB
Go
205 lines
5.6 KiB
Go
// Package auroradns implements a DNS provider for solving the DNS-01 challenge using Aurora DNS.
|
|
package auroradns
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/go-acme/lego/v4/challenge/dns01"
|
|
"github.com/go-acme/lego/v4/platform/config/env"
|
|
"github.com/nrdcg/auroradns"
|
|
)
|
|
|
|
const defaultBaseURL = "https://api.auroradns.eu"
|
|
|
|
// Environment variables names.
|
|
const (
|
|
envNamespace = "AURORA_"
|
|
|
|
EnvAPIKey = envNamespace + "API_KEY"
|
|
EnvSecret = envNamespace + "SECRET"
|
|
EnvEndpoint = envNamespace + "ENDPOINT"
|
|
|
|
EnvTTL = envNamespace + "TTL"
|
|
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
|
|
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
|
|
)
|
|
|
|
// Config is used to configure the creation of the DNSProvider.
|
|
type Config struct {
|
|
BaseURL string
|
|
APIKey string
|
|
Secret string
|
|
PropagationTimeout time.Duration
|
|
PollingInterval time.Duration
|
|
TTL int
|
|
}
|
|
|
|
// NewDefaultConfig returns a default configuration for the DNSProvider.
|
|
func NewDefaultConfig() *Config {
|
|
return &Config{
|
|
TTL: env.GetOrDefaultInt(EnvTTL, 300),
|
|
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
|
|
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
|
|
}
|
|
}
|
|
|
|
// DNSProvider implements the challenge.Provider interface.
|
|
type DNSProvider struct {
|
|
recordIDs map[string]string
|
|
recordIDsMu sync.Mutex
|
|
config *Config
|
|
client *auroradns.Client
|
|
}
|
|
|
|
// NewDNSProvider returns a DNSProvider instance configured for AuroraDNS.
|
|
// Credentials must be passed in the environment variables:
|
|
// AURORA_API_KEY and AURORA_SECRET.
|
|
func NewDNSProvider() (*DNSProvider, error) {
|
|
values, err := env.Get(EnvAPIKey, EnvSecret)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("aurora: %w", err)
|
|
}
|
|
|
|
config := NewDefaultConfig()
|
|
config.BaseURL = env.GetOrFile(EnvEndpoint)
|
|
config.APIKey = values[EnvAPIKey]
|
|
config.Secret = values[EnvSecret]
|
|
|
|
return NewDNSProviderConfig(config)
|
|
}
|
|
|
|
// NewDNSProviderConfig return a DNSProvider instance configured for AuroraDNS.
|
|
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
|
|
if config == nil {
|
|
return nil, errors.New("aurora: the configuration of the DNS provider is nil")
|
|
}
|
|
|
|
if config.APIKey == "" || config.Secret == "" {
|
|
return nil, errors.New("aurora: some credentials information are missing")
|
|
}
|
|
|
|
if config.BaseURL == "" {
|
|
config.BaseURL = defaultBaseURL
|
|
}
|
|
|
|
tr, err := auroradns.NewTokenTransport(config.APIKey, config.Secret)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("aurora: %w", err)
|
|
}
|
|
|
|
client, err := auroradns.NewClient(tr.Client(), auroradns.WithBaseURL(config.BaseURL))
|
|
if err != nil {
|
|
return nil, fmt.Errorf("aurora: %w", err)
|
|
}
|
|
|
|
return &DNSProvider{
|
|
config: config,
|
|
client: client,
|
|
recordIDs: make(map[string]string),
|
|
}, nil
|
|
}
|
|
|
|
// 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)
|
|
if err != nil {
|
|
return fmt.Errorf("aurora: could not find zone for domain %q: %w", domain, err)
|
|
}
|
|
|
|
// 1. Aurora will happily create the TXT record when it is provided a fqdn,
|
|
// but it will only appear in the control panel and will not be
|
|
// propagated to DNS servers. Extract and use subdomain instead.
|
|
// 2. A trailing dot in the fqdn will cause Aurora to add a trailing dot to
|
|
// the subdomain, resulting in _acme-challenge..<domain> rather
|
|
// than _acme-challenge.<domain>
|
|
|
|
subdomain := info.EffectiveFQDN[0 : len(info.EffectiveFQDN)-len(authZone)-1]
|
|
|
|
authZone = dns01.UnFqdn(authZone)
|
|
|
|
zone, err := d.getZoneInformationByName(authZone)
|
|
if err != nil {
|
|
return fmt.Errorf("aurora: could not create record: %w", err)
|
|
}
|
|
|
|
record := auroradns.Record{
|
|
RecordType: "TXT",
|
|
Name: subdomain,
|
|
Content: info.Value,
|
|
TTL: d.config.TTL,
|
|
}
|
|
|
|
newRecord, _, err := d.client.CreateRecord(zone.ID, record)
|
|
if err != nil {
|
|
return fmt.Errorf("aurora: could not create record: %w", err)
|
|
}
|
|
|
|
d.recordIDsMu.Lock()
|
|
d.recordIDs[token] = newRecord.ID
|
|
d.recordIDsMu.Unlock()
|
|
|
|
return nil
|
|
}
|
|
|
|
// CleanUp removes a given record that was generated by Present.
|
|
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
|
|
info := dns01.GetChallengeInfo(domain, keyAuth)
|
|
|
|
d.recordIDsMu.Lock()
|
|
recordID, ok := d.recordIDs[token]
|
|
d.recordIDsMu.Unlock()
|
|
|
|
if !ok {
|
|
return fmt.Errorf("aurora: unknown recordID for %q", info.EffectiveFQDN)
|
|
}
|
|
|
|
authZone, err := dns01.FindZoneByFqdn(dns01.ToFqdn(info.EffectiveFQDN))
|
|
if err != nil {
|
|
return fmt.Errorf("aurora: could not find zone for domain %q: %w", domain, err)
|
|
}
|
|
|
|
authZone = dns01.UnFqdn(authZone)
|
|
|
|
zone, err := d.getZoneInformationByName(authZone)
|
|
if err != nil {
|
|
return fmt.Errorf("aurora: %w", err)
|
|
}
|
|
|
|
_, _, err = d.client.DeleteRecord(zone.ID, recordID)
|
|
if err != nil {
|
|
return fmt.Errorf("aurora: %w", err)
|
|
}
|
|
|
|
d.recordIDsMu.Lock()
|
|
delete(d.recordIDs, token)
|
|
d.recordIDsMu.Unlock()
|
|
|
|
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
|
|
}
|
|
|
|
func (d *DNSProvider) getZoneInformationByName(name string) (auroradns.Zone, error) {
|
|
zs, _, err := d.client.ListZones()
|
|
if err != nil {
|
|
return auroradns.Zone{}, err
|
|
}
|
|
|
|
for _, element := range zs {
|
|
if element.Name == name {
|
|
return element, nil
|
|
}
|
|
}
|
|
|
|
return auroradns.Zone{}, errors.New("could not find Zone record")
|
|
}
|