2018-11-06 10:56:28 +00:00
|
|
|
// Package transip implements a DNS provider for solving the DNS-01 challenge using TransIP.
|
2019-03-11 15:54:35 +00:00
|
|
|
package transip // import "github.com/xenolf/lego/providers/dns/transip"
|
2018-11-06 10:56:28 +00:00
|
|
|
|
|
|
|
import (
|
|
|
|
"errors"
|
|
|
|
"fmt"
|
|
|
|
"strings"
|
2019-01-09 07:18:12 +00:00
|
|
|
"sync"
|
2018-11-06 10:56:28 +00:00
|
|
|
"time"
|
|
|
|
|
|
|
|
"github.com/transip/gotransip"
|
|
|
|
transipdomain "github.com/transip/gotransip/domain"
|
2018-12-06 21:50:17 +00:00
|
|
|
"github.com/xenolf/lego/challenge/dns01"
|
2018-11-06 10:56:28 +00:00
|
|
|
"github.com/xenolf/lego/platform/config/env"
|
|
|
|
)
|
|
|
|
|
|
|
|
// Config is used to configure the creation of the DNSProvider
|
|
|
|
type Config struct {
|
|
|
|
AccountName string
|
|
|
|
PrivateKeyPath string
|
|
|
|
PropagationTimeout time.Duration
|
|
|
|
PollingInterval time.Duration
|
|
|
|
TTL int64
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewDefaultConfig returns a default configuration for the DNSProvider
|
|
|
|
func NewDefaultConfig() *Config {
|
|
|
|
return &Config{
|
|
|
|
TTL: int64(env.GetOrDefaultInt("TRANSIP_TTL", 10)),
|
|
|
|
PropagationTimeout: env.GetOrDefaultSecond("TRANSIP_PROPAGATION_TIMEOUT", 10*time.Minute),
|
|
|
|
PollingInterval: env.GetOrDefaultSecond("TRANSIP_POLLING_INTERVAL", 10*time.Second),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// DNSProvider describes a provider for TransIP
|
|
|
|
type DNSProvider struct {
|
2019-01-09 07:18:12 +00:00
|
|
|
config *Config
|
|
|
|
client gotransip.Client
|
|
|
|
dnsEntriesMu sync.Mutex
|
2018-11-06 10:56:28 +00: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("TRANSIP_ACCOUNT_NAME", "TRANSIP_PRIVATE_KEY_PATH")
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("transip: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
config := NewDefaultConfig()
|
|
|
|
config.AccountName = values["TRANSIP_ACCOUNT_NAME"]
|
|
|
|
config.PrivateKeyPath = values["TRANSIP_PRIVATE_KEY_PATH"]
|
|
|
|
|
|
|
|
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.NewSOAPClient(gotransip.ClientConfig{
|
|
|
|
AccountName: config.AccountName,
|
|
|
|
PrivateKeyPath: config.PrivateKeyPath,
|
|
|
|
})
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("transip: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
return &DNSProvider{client: client, config: config}, 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
|
|
|
|
}
|
|
|
|
|
|
|
|
// Present creates a TXT record to fulfill the dns-01 challenge
|
|
|
|
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
|
2018-12-06 21:50:17 +00:00
|
|
|
fqdn, value := dns01.GetRecord(domain, keyAuth)
|
2018-11-06 10:56:28 +00:00
|
|
|
|
2018-12-06 21:50:17 +00:00
|
|
|
authZone, err := dns01.FindZoneByFqdn(fqdn)
|
2018-11-06 10:56:28 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-12-06 21:50:17 +00:00
|
|
|
domainName := dns01.UnFqdn(authZone)
|
2018-11-06 10:56:28 +00:00
|
|
|
|
|
|
|
// get the subDomain
|
2018-12-06 21:50:17 +00:00
|
|
|
subDomain := strings.TrimSuffix(dns01.UnFqdn(fqdn), "."+domainName)
|
2018-11-06 10:56:28 +00:00
|
|
|
|
2019-01-09 07:18:12 +00:00
|
|
|
// use mutex to prevent race condition from GetInfo until SetDNSEntries
|
|
|
|
d.dnsEntriesMu.Lock()
|
|
|
|
defer d.dnsEntriesMu.Unlock()
|
|
|
|
|
2018-11-06 10:56:28 +00:00
|
|
|
// get all DNS entries
|
|
|
|
info, err := transipdomain.GetInfo(d.client, domainName)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("transip: error for %s in Present: %v", domain, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// include the new DNS entry
|
|
|
|
dnsEntries := append(info.DNSEntries, transipdomain.DNSEntry{
|
|
|
|
Name: subDomain,
|
|
|
|
TTL: d.config.TTL,
|
|
|
|
Type: transipdomain.DNSEntryTypeTXT,
|
|
|
|
Content: value,
|
|
|
|
})
|
|
|
|
|
|
|
|
// set the updated DNS entries
|
|
|
|
err = transipdomain.SetDNSEntries(d.client, domainName, dnsEntries)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("transip: %v", err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// CleanUp removes the TXT record matching the specified parameters
|
|
|
|
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
|
2018-12-06 21:50:17 +00:00
|
|
|
fqdn, _ := dns01.GetRecord(domain, keyAuth)
|
2018-11-06 10:56:28 +00:00
|
|
|
|
2018-12-06 21:50:17 +00:00
|
|
|
authZone, err := dns01.FindZoneByFqdn(fqdn)
|
2018-11-06 10:56:28 +00:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2018-12-06 21:50:17 +00:00
|
|
|
domainName := dns01.UnFqdn(authZone)
|
2018-11-06 10:56:28 +00:00
|
|
|
|
|
|
|
// get the subDomain
|
2018-12-06 21:50:17 +00:00
|
|
|
subDomain := strings.TrimSuffix(dns01.UnFqdn(fqdn), "."+domainName)
|
2018-11-06 10:56:28 +00:00
|
|
|
|
2019-01-09 07:18:12 +00:00
|
|
|
// use mutex to prevent race condition from GetInfo until SetDNSEntries
|
|
|
|
d.dnsEntriesMu.Lock()
|
|
|
|
defer d.dnsEntriesMu.Unlock()
|
|
|
|
|
2018-11-06 10:56:28 +00:00
|
|
|
// get all DNS entries
|
|
|
|
info, err := transipdomain.GetInfo(d.client, domainName)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("transip: error for %s in CleanUp: %v", fqdn, err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// loop through the existing entries and remove the specific record
|
|
|
|
updatedEntries := info.DNSEntries[:0]
|
|
|
|
for _, e := range info.DNSEntries {
|
|
|
|
if e.Name != subDomain {
|
|
|
|
updatedEntries = append(updatedEntries, e)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// set the updated DNS entries
|
|
|
|
err = transipdomain.SetDNSEntries(d.client, domainName, updatedEntries)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("transip: couldn't get Record ID in CleanUp: %sv", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|