lego/providers/dns/netcup/netcup.go

210 lines
5.8 KiB
Go
Raw Normal View History

2018-09-08 12:08:07 +00:00
// Package netcup implements a DNS Provider for solving the DNS-01 challenge using the netcup DNS API.
package netcup
import (
"errors"
2018-09-08 12:08:07 +00:00
"fmt"
"net/http"
"strings"
"time"
"github.com/xenolf/lego/acme"
"github.com/xenolf/lego/log"
2018-09-08 12:08:07 +00:00
"github.com/xenolf/lego/platform/config/env"
)
// Config is used to configure the creation of the DNSProvider
type Config struct {
Key string
Password string
Customer string
TTL int
PropagationTimeout time.Duration
PollingInterval time.Duration
HTTPClient *http.Client
}
// NewDefaultConfig returns a default configuration for the DNSProvider
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt("NETCUP_TTL", 120),
PropagationTimeout: env.GetOrDefaultSecond("NETCUP_PROPAGATION_TIMEOUT", 120*time.Second),
PollingInterval: env.GetOrDefaultSecond("NETCUP_POLLING_INTERVAL", 5*time.Second),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond("NETCUP_HTTP_TIMEOUT", 10*time.Second),
},
}
}
2018-09-08 12:08:07 +00:00
// DNSProvider is an implementation of the acme.ChallengeProvider interface
type DNSProvider struct {
client *Client
config *Config
2018-09-08 12:08:07 +00:00
}
// NewDNSProvider returns a DNSProvider instance configured for netcup.
// Credentials must be passed in the environment variables:
// NETCUP_CUSTOMER_NUMBER, NETCUP_API_KEY, NETCUP_API_PASSWORD
2018-09-08 12:08:07 +00:00
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get("NETCUP_CUSTOMER_NUMBER", "NETCUP_API_KEY", "NETCUP_API_PASSWORD")
if err != nil {
return nil, fmt.Errorf("netcup: %v", err)
}
config := NewDefaultConfig()
config.Customer = values["NETCUP_CUSTOMER_NUMBER"]
config.Key = values["NETCUP_API_KEY"]
config.Password = values["NETCUP_API_PASSWORD"]
return NewDNSProviderConfig(config)
2018-09-08 12:08:07 +00:00
}
// NewDNSProviderCredentials uses the supplied credentials
// to return a DNSProvider instance configured for netcup.
// Deprecated
2018-09-08 12:08:07 +00:00
func NewDNSProviderCredentials(customer, key, password string) (*DNSProvider, error) {
config := NewDefaultConfig()
config.Customer = customer
config.Key = key
config.Password = password
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for netcup.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("netcup: the configuration of the DNS provider is nil")
2018-09-08 12:08:07 +00:00
}
client, err := NewClient(config.Customer, config.Key, config.Password)
if err != nil {
return nil, fmt.Errorf("netcup: %v", err)
2018-09-08 12:08:07 +00:00
}
client.HTTPClient = config.HTTPClient
return &DNSProvider{client: client, config: config}, nil
2018-09-08 12:08:07 +00:00
}
// Present creates a TXT record to fulfill the dns-01 challenge
func (d *DNSProvider) Present(domainName, token, keyAuth string) error {
fqdn, value, _ := acme.DNS01Record(domainName, keyAuth)
zone, err := acme.FindZoneByFqdn(fqdn, acme.RecursiveNameservers)
if err != nil {
return fmt.Errorf("netcup: failed to find DNSZone, %v", err)
}
sessionID, err := d.client.Login()
if err != nil {
return fmt.Errorf("netcup: %v", err)
2018-09-08 12:08:07 +00:00
}
defer func() {
err = d.client.Logout(sessionID)
if err != nil {
log.Print("netcup: %v", err)
}
}()
2018-09-08 12:08:07 +00:00
hostname := strings.Replace(fqdn, "."+zone, "", 1)
record := createTxtRecord(hostname, value, d.config.TTL)
2018-09-08 12:08:07 +00:00
zone = acme.UnFqdn(zone)
records, err := d.client.GetDNSRecords(zone, sessionID)
2018-09-08 12:08:07 +00:00
if err != nil {
// skip no existing records
log.Infof("no existing records, error ignored: %v", err)
2018-09-08 12:08:07 +00:00
}
records = append(records, record)
err = d.client.UpdateDNSRecord(sessionID, zone, records)
if err != nil {
return fmt.Errorf("netcup: failed to add TXT-Record: %v", err)
}
return nil
2018-09-08 12:08:07 +00:00
}
// CleanUp removes the TXT record matching the specified parameters
func (d *DNSProvider) CleanUp(domainName, token, keyAuth string) error {
fqdn, value, _ := acme.DNS01Record(domainName, keyAuth)
2018-09-08 12:08:07 +00:00
zone, err := acme.FindZoneByFqdn(fqdn, acme.RecursiveNameservers)
if err != nil {
return fmt.Errorf("netcup: failed to find DNSZone, %v", err)
2018-09-08 12:08:07 +00:00
}
sessionID, err := d.client.Login()
if err != nil {
return fmt.Errorf("netcup: %v", err)
2018-09-08 12:08:07 +00:00
}
defer func() {
err = d.client.Logout(sessionID)
if err != nil {
log.Print("netcup: %v", err)
}
}()
2018-09-08 12:08:07 +00:00
hostname := strings.Replace(fqdn, "."+zone, "", 1)
zone = acme.UnFqdn(zone)
records, err := d.client.GetDNSRecords(zone, sessionID)
if err != nil {
return fmt.Errorf("netcup: %v", err)
2018-09-08 12:08:07 +00:00
}
record := createTxtRecord(hostname, value, 0)
2018-09-08 12:08:07 +00:00
idx, err := getDNSRecordIdx(records, record)
2018-09-08 12:08:07 +00:00
if err != nil {
return fmt.Errorf("netcup: %v", err)
2018-09-08 12:08:07 +00:00
}
records[idx].DeleteRecord = true
err = d.client.UpdateDNSRecord(sessionID, zone, []DNSRecord{records[idx]})
2018-09-08 12:08:07 +00:00
if err != nil {
return fmt.Errorf("netcup: %v", err)
2018-09-08 12:08:07 +00:00
}
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
2018-09-08 12:08:07 +00:00
}
// getDNSRecordIdx searches a given array of DNSRecords for a given DNSRecord
// equivalence is determined by Destination and RecortType attributes
// returns index of given DNSRecord in given array of DNSRecords
func getDNSRecordIdx(records []DNSRecord, record DNSRecord) (int, error) {
for index, element := range records {
if record.Destination == element.Destination && record.RecordType == element.RecordType {
return index, nil
}
}
return -1, fmt.Errorf("no DNS Record found")
}
// createTxtRecord uses the supplied values to return a DNSRecord of type TXT for the dns-01 challenge
func createTxtRecord(hostname, value string, ttl int) DNSRecord {
return DNSRecord{
ID: 0,
Hostname: hostname,
RecordType: "TXT",
Priority: "",
Destination: value,
DeleteRecord: false,
State: "",
TTL: ttl,
}
}