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

159 lines
4.6 KiB
Go
Raw Normal View History

2018-11-06 12:56:28 +02:00
// Package transip implements a DNS provider for solving the DNS-01 challenge using TransIP.
2019-03-11 18:56:48 +02:00
package transip
2018-11-06 12:56:28 +02:00
import (
"errors"
"fmt"
"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"
"github.com/transip/gotransip/v6"
transipdomain "github.com/transip/gotransip/v6/domain"
2018-11-06 12:56:28 +02:00
)
// Environment variables names.
const (
envNamespace = "TRANSIP_"
EnvAccountName = envNamespace + "ACCOUNT_NAME"
EnvPrivateKeyPath = envNamespace + "PRIVATE_KEY_PATH"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
)
2020-05-08 19:35:25 +02:00
// Config is used to configure the creation of the DNSProvider.
2018-11-06 12:56:28 +02:00
type Config struct {
AccountName string
PrivateKeyPath string
PropagationTimeout time.Duration
PollingInterval time.Duration
TTL int64
}
2020-05-08 19:35:25 +02:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
2018-11-06 12:56:28 +02:00
func NewDefaultConfig() *Config {
return &Config{
TTL: int64(env.GetOrDefaultInt(EnvTTL, 10)),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 10*time.Minute),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 10*time.Second),
2018-11-06 12:56:28 +02:00
}
}
2020-05-08 19:35:25 +02:00
// DNSProvider implements the challenge.Provider interface.
2018-11-06 12:56:28 +02:00
type DNSProvider struct {
config *Config
repository transipdomain.Repository
2018-11-06 12:56:28 +02:00
}
// NewDNSProvider returns a DNSProvider instance configured for TransIP.
// Credentials must be passed in the environment variables:
// TRANSIP_ACCOUNTNAME, TRANSIP_PRIVATEKEYPATH.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvAccountName, EnvPrivateKeyPath)
2018-11-06 12:56:28 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("transip: %w", err)
2018-11-06 12:56:28 +02:00
}
config := NewDefaultConfig()
config.AccountName = values[EnvAccountName]
config.PrivateKeyPath = values[EnvPrivateKeyPath]
2018-11-06 12:56:28 +02:00
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for TransIP.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("transip: the configuration of the DNS provider is nil")
}
client, err := gotransip.NewClient(gotransip.ClientConfiguration{
2018-11-06 12:56:28 +02:00
AccountName: config.AccountName,
PrivateKeyPath: config.PrivateKeyPath,
})
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("transip: %w", err)
2018-11-06 12:56:28 +02:00
}
repo := transipdomain.Repository{Client: client}
return &DNSProvider{repository: repo, config: config}, nil
2018-11-06 12:56:28 +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
}
2020-05-08 19:35:25 +02:00
// Present creates a TXT record to fulfill the dns-01 challenge.
2018-11-06 12:56:28 +02:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
2018-11-06 12:56:28 +02:00
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
2018-11-06 12:56:28 +02:00
if err != nil {
return fmt.Errorf("transip: could not find zone for domain %q: %w", domain, err)
2018-11-06 12:56:28 +02:00
}
// get the subDomain
subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
if err != nil {
return fmt.Errorf("transip: %w", err)
}
domainName := dns01.UnFqdn(authZone)
2018-11-06 12:56:28 +02:00
entry := transipdomain.DNSEntry{
2018-11-06 12:56:28 +02:00
Name: subDomain,
Expire: int(d.config.TTL),
Type: "TXT",
Content: info.Value,
}
2018-11-06 12:56:28 +02:00
err = d.repository.AddDNSEntry(domainName, entry)
2018-11-06 12:56:28 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("transip: %w", err)
2018-11-06 12:56:28 +02:00
}
2018-11-06 12:56:28 +02:00
return nil
}
2020-05-08 19:35:25 +02:00
// CleanUp removes the TXT record matching the specified parameters.
2018-11-06 12:56:28 +02:00
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
2018-11-06 12:56:28 +02:00
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
2018-11-06 12:56:28 +02:00
if err != nil {
return fmt.Errorf("transip: could not find zone for domain %q: %w", domain, err)
2018-11-06 12:56:28 +02:00
}
// get the subDomain
subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
if err != nil {
return fmt.Errorf("transip: %w", err)
}
domainName := dns01.UnFqdn(authZone)
2018-11-06 12:56:28 +02:00
// get all DNS entries
dnsEntries, err := d.repository.GetDNSEntries(domainName)
2018-11-06 12:56:28 +02:00
if err != nil {
return fmt.Errorf("transip: error for %s in CleanUp: %w", info.EffectiveFQDN, err)
2018-11-06 12:56:28 +02:00
}
// loop through the existing entries and remove the specific record
for _, entry := range dnsEntries {
if entry.Name == subDomain && entry.Content == info.Value {
if err = d.repository.RemoveDNSEntry(domainName, entry); err != nil {
return fmt.Errorf("transip: couldn't get Record ID in CleanUp: %w", err)
}
return nil
2018-11-06 12:56:28 +02:00
}
}
return nil
}