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

197 lines
5.3 KiB
Go
Raw Normal View History

2018-09-08 14:08:07 +02:00
// Package netcup implements a DNS Provider for solving the DNS-01 challenge using the netcup DNS API.
2019-03-11 18:56:48 +02:00
package netcup
2018-09-08 14:08:07 +02:00
import (
2023-05-05 09:49:38 +02:00
"context"
"errors"
2018-09-08 14:08:07 +02:00
"fmt"
"net/http"
"strings"
"time"
2020-09-02 03:20:01 +02:00
"github.com/go-acme/lego/v4/challenge/dns01"
"github.com/go-acme/lego/v4/log"
"github.com/go-acme/lego/v4/platform/config/env"
"github.com/go-acme/lego/v4/providers/dns/netcup/internal"
2018-09-08 14:08:07 +02:00
)
// Environment variables names.
const (
envNamespace = "NETCUP_"
EnvCustomerNumber = envNamespace + "CUSTOMER_NUMBER"
EnvAPIKey = envNamespace + "API_KEY"
EnvAPIPassword = envNamespace + "API_PASSWORD"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
2020-05-08 19:35:25 +02:00
// 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
}
2020-05-08 19:35:25 +02:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 120*time.Second),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 5*time.Second),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 10*time.Second),
},
}
}
2020-05-08 19:35:25 +02:00
// DNSProvider implements the challenge.Provider interface.
2018-09-08 14:08:07 +02:00
type DNSProvider struct {
client *internal.Client
config *Config
2018-09-08 14:08:07 +02:00
}
// NewDNSProvider returns a DNSProvider instance configured for netcup.
// Credentials must be passed in the environment variables:
2020-05-08 19:35:25 +02:00
// NETCUP_CUSTOMER_NUMBER, NETCUP_API_KEY, NETCUP_API_PASSWORD.
2018-09-08 14:08:07 +02:00
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvCustomerNumber, EnvAPIKey, EnvAPIPassword)
2018-09-08 14:08:07 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("netcup: %w", err)
2018-09-08 14:08:07 +02:00
}
config := NewDefaultConfig()
config.Customer = values[EnvCustomerNumber]
config.Key = values[EnvAPIKey]
config.Password = values[EnvAPIPassword]
return NewDNSProviderConfig(config)
2018-09-08 14:08:07 +02:00
}
// 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 14:08:07 +02:00
}
client, err := internal.NewClient(config.Customer, config.Key, config.Password)
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("netcup: %w", err)
2018-09-08 14:08:07 +02:00
}
client.HTTPClient = config.HTTPClient
return &DNSProvider{client: client, config: config}, nil
2018-09-08 14:08:07 +02:00
}
2020-05-08 19:35:25 +02:00
// Present creates a TXT record to fulfill the dns-01 challenge.
2022-11-25 19:12:21 +02:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
2018-09-08 14:08:07 +02:00
zone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
2018-09-08 14:08:07 +02:00
if err != nil {
2023-05-05 09:49:38 +02:00
return fmt.Errorf("netcup: could not find zone for domain %q (%s): %w", domain, info.EffectiveFQDN, err)
2018-09-08 14:08:07 +02:00
}
2023-05-05 09:49:38 +02:00
ctx, err := d.client.CreateSessionContext(context.Background())
2018-09-08 14:08:07 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("netcup: %w", err)
2018-09-08 14:08:07 +02:00
}
defer func() {
2023-05-05 09:49:38 +02:00
err = d.client.Logout(ctx)
if err != nil {
log.Print("netcup: %v", err)
}
}()
hostname := strings.Replace(info.EffectiveFQDN, "."+zone, "", 1)
record := internal.DNSRecord{
Hostname: hostname,
RecordType: "TXT",
Destination: info.Value,
TTL: d.config.TTL,
}
2018-09-08 14:08:07 +02:00
zone = dns01.UnFqdn(zone)
2023-05-05 09:49:38 +02:00
records, err := d.client.GetDNSRecords(ctx, zone)
2018-09-08 14:08:07 +02:00
if err != nil {
// skip no existing records
log.Infof("no existing records, error ignored: %v", err)
2018-09-08 14:08:07 +02:00
}
records = append(records, record)
2023-05-05 09:49:38 +02:00
err = d.client.UpdateDNSRecord(ctx, zone, records)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("netcup: failed to add TXT-Record: %w", err)
}
return nil
2018-09-08 14:08:07 +02:00
}
2020-05-08 19:35:25 +02:00
// CleanUp removes the TXT record matching the specified parameters.
2022-11-25 19:12:21 +02:00
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
2018-09-08 14:08:07 +02:00
zone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
2018-09-08 14:08:07 +02:00
if err != nil {
2023-05-05 09:49:38 +02:00
return fmt.Errorf("netcup: could not find zone for domain %q (%s): %w", domain, info.EffectiveFQDN, err)
2018-09-08 14:08:07 +02:00
}
2023-05-05 09:49:38 +02:00
ctx, err := d.client.CreateSessionContext(context.Background())
2018-09-08 14:08:07 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("netcup: %w", err)
2018-09-08 14:08:07 +02:00
}
defer func() {
2023-05-05 09:49:38 +02:00
err = d.client.Logout(ctx)
if err != nil {
log.Print("netcup: %v", err)
}
}()
hostname := strings.Replace(info.EffectiveFQDN, "."+zone, "", 1)
2018-09-08 14:08:07 +02:00
zone = dns01.UnFqdn(zone)
2018-09-08 14:08:07 +02:00
2023-05-05 09:49:38 +02:00
records, err := d.client.GetDNSRecords(ctx, zone)
2018-09-08 14:08:07 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("netcup: %w", err)
2018-09-08 14:08:07 +02:00
}
record := internal.DNSRecord{
Hostname: hostname,
RecordType: "TXT",
Destination: info.Value,
}
2018-09-08 14:08:07 +02:00
idx, err := internal.GetDNSRecordIdx(records, record)
2018-09-08 14:08:07 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("netcup: %w", err)
2018-09-08 14:08:07 +02:00
}
records[idx].DeleteRecord = true
2023-05-05 09:49:38 +02:00
err = d.client.UpdateDNSRecord(ctx, zone, []internal.DNSRecord{records[idx]})
2018-09-08 14:08:07 +02:00
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("netcup: %w", err)
2018-09-08 14:08:07 +02: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 14:08:07 +02:00
}