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

200 lines
5.4 KiB
Go

// Package netcup implements a DNS Provider for solving the DNS-01 challenge using the netcup DNS API.
package netcup
import (
"context"
"errors"
"fmt"
"net/http"
"strings"
"time"
"github.com/go-acme/lego/v4/challenge"
"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"
)
// 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"
)
var _ challenge.ProviderTimeout = (*DNSProvider)(nil)
// 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(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),
},
}
}
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
client *internal.Client
config *Config
}
// 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.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvCustomerNumber, EnvAPIKey, EnvAPIPassword)
if err != nil {
return nil, fmt.Errorf("netcup: %w", err)
}
config := NewDefaultConfig()
config.Customer = values[EnvCustomerNumber]
config.Key = values[EnvAPIKey]
config.Password = values[EnvAPIPassword]
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")
}
client, err := internal.NewClient(config.Customer, config.Key, config.Password)
if err != nil {
return nil, fmt.Errorf("netcup: %w", err)
}
client.HTTPClient = config.HTTPClient
return &DNSProvider{client: client, config: config}, nil
}
// Present creates a TXT record to fulfill the dns-01 challenge.
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
zone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("netcup: could not find zone for domain %q: %w", domain, err)
}
ctx, err := d.client.CreateSessionContext(context.Background())
if err != nil {
return fmt.Errorf("netcup: %w", err)
}
defer func() {
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,
}
zone = dns01.UnFqdn(zone)
records, err := d.client.GetDNSRecords(ctx, zone)
if err != nil {
// skip no existing records
log.Infof("no existing records, error ignored: %v", err)
}
records = append(records, record)
err = d.client.UpdateDNSRecord(ctx, zone, records)
if err != nil {
return fmt.Errorf("netcup: failed to add TXT-Record: %w", err)
}
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
zone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("netcup: could not find zone for domain %q: %w", domain, err)
}
ctx, err := d.client.CreateSessionContext(context.Background())
if err != nil {
return fmt.Errorf("netcup: %w", err)
}
defer func() {
err = d.client.Logout(ctx)
if err != nil {
log.Print("netcup: %v", err)
}
}()
hostname := strings.Replace(info.EffectiveFQDN, "."+zone, "", 1)
zone = dns01.UnFqdn(zone)
records, err := d.client.GetDNSRecords(ctx, zone)
if err != nil {
return fmt.Errorf("netcup: %w", err)
}
record := internal.DNSRecord{
Hostname: hostname,
RecordType: "TXT",
Destination: info.Value,
}
idx, err := internal.GetDNSRecordIdx(records, record)
if err != nil {
return fmt.Errorf("netcup: %w", err)
}
records[idx].DeleteRecord = true
err = d.client.UpdateDNSRecord(ctx, zone, []internal.DNSRecord{records[idx]})
if err != nil {
return fmt.Errorf("netcup: %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
}