lego/providers/dns/otc/otc.go

195 lines
5.6 KiB
Go
Raw Normal View History

// Package otc implements a DNS provider for solving the DNS-01 challenge using Open Telekom Cloud Managed DNS.
2019-03-11 16:56:48 +00:00
package otc
import (
"errors"
"fmt"
"net"
"net/http"
"time"
2020-09-02 01:20:01 +00:00
"github.com/go-acme/lego/v4/challenge/dns01"
"github.com/go-acme/lego/v4/platform/config/env"
)
const defaultIdentityEndpoint = "https://iam.eu-de.otc.t-systems.com:443/v3/auth/tokens"
2020-05-08 17:35:25 +00:00
// minTTL 300 is otc minimum value for TTL.
const minTTL = 300
// Environment variables names.
const (
envNamespace = "OTC_"
EnvDomainName = envNamespace + "DOMAIN_NAME"
EnvUserName = envNamespace + "USER_NAME"
EnvPassword = envNamespace + "PASSWORD"
EnvProjectName = envNamespace + "PROJECT_NAME"
EnvIdentityEndpoint = envNamespace + "IDENTITY_ENDPOINT"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
2020-05-08 17:35:25 +00:00
// Config is used to configure the creation of the DNSProvider.
type Config struct {
IdentityEndpoint string
DomainName string
ProjectName string
UserName string
Password string
PropagationTimeout time.Duration
PollingInterval time.Duration
TTL int
HTTPClient *http.Client
}
2020-05-08 17:35:25 +00:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt(EnvTTL, minTTL),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
IdentityEndpoint: env.GetOrDefaultString(EnvIdentityEndpoint, defaultIdentityEndpoint),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 10*time.Second),
Transport: &http.Transport{
Proxy: http.ProxyFromEnvironment,
DialContext: (&net.Dialer{
Timeout: 30 * time.Second,
KeepAlive: 30 * time.Second,
DualStack: true,
}).DialContext,
MaxIdleConns: 100,
IdleConnTimeout: 90 * time.Second,
TLSHandshakeTimeout: 10 * time.Second,
ExpectContinueTimeout: 1 * time.Second,
// Workaround for keep alive bug in otc api
DisableKeepAlives: true,
},
},
}
}
2020-05-08 17:35:25 +00:00
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
config *Config
baseURL string
token string
}
// NewDNSProvider returns a DNSProvider instance configured for OTC DNS.
// Credentials must be passed in the environment variables: OTC_USER_NAME,
// OTC_DOMAIN_NAME, OTC_PASSWORD OTC_PROJECT_NAME and OTC_IDENTITY_ENDPOINT.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvDomainName, EnvUserName, EnvPassword, EnvProjectName)
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("otc: %w", err)
}
config := NewDefaultConfig()
config.DomainName = values[EnvDomainName]
config.UserName = values[EnvUserName]
config.Password = values[EnvPassword]
config.ProjectName = values[EnvProjectName]
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for OTC DNS.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("otc: the configuration of the DNS provider is nil")
}
if config.DomainName == "" || config.UserName == "" || config.Password == "" || config.ProjectName == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("otc: credentials missing")
}
if config.TTL < minTTL {
return nil, fmt.Errorf("otc: invalid TTL, TTL (%d) must be greater than %d", config.TTL, minTTL)
}
if config.IdentityEndpoint == "" {
config.IdentityEndpoint = defaultIdentityEndpoint
}
return &DNSProvider{config: config}, nil
}
2020-05-08 17:35:25 +00:00
// Present creates a TXT record using the specified parameters.
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
fqdn, value := dns01.GetRecord(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(fqdn)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("otc: %w", err)
}
err = d.login()
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("otc: %w", err)
}
zoneID, err := d.getZoneID(authZone)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("otc: unable to get zone: %w", err)
}
resource := fmt.Sprintf("zones/%s/recordsets", zoneID)
r1 := &recordset{
Name: fqdn,
Description: "Added TXT record for ACME dns-01 challenge using lego client",
Type: "TXT",
TTL: d.config.TTL,
2021-11-03 19:39:12 +00:00
Records: []string{fmt.Sprintf("%q", value)},
}
_, err = d.sendRequest(http.MethodPost, resource, r1)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("otc: %w", err)
}
return nil
}
2020-05-08 17:35:25 +00:00
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
fqdn, _ := dns01.GetRecord(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(fqdn)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("otc: %w", err)
}
err = d.login()
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("otc: %w", err)
}
zoneID, err := d.getZoneID(authZone)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("otc: %w", err)
}
recordID, err := d.getRecordSetID(zoneID, fqdn)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("otc: unable go get record %s for zone %s: %w", fqdn, domain, err)
}
err = d.deleteRecordSet(zoneID, recordID)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("otc: %w", err)
}
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
}