dyndnsfree.go raw

   1  // Package dyndnsfree implements a DNS provider for solving the DNS-01 challenge using DynDnsFree.de API.
   2  package dyndnsfree
   3  
   4  import (
   5  	"context"
   6  	"errors"
   7  	"fmt"
   8  	"net/http"
   9  	"time"
  10  
  11  	"github.com/go-acme/lego/v4/challenge/dns01"
  12  	"github.com/go-acme/lego/v4/platform/config/env"
  13  	"github.com/go-acme/lego/v4/providers/dns/dyndnsfree/internal"
  14  	"github.com/go-acme/lego/v4/providers/dns/internal/clientdebug"
  15  )
  16  
  17  // Environment variables names.
  18  const (
  19  	envNamespace = "DYNDNSFREE_"
  20  
  21  	EnvUsername = envNamespace + "USERNAME"
  22  	EnvPassword = envNamespace + "PASSWORD"
  23  
  24  	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
  25  	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
  26  	EnvHTTPTimeout        = envNamespace + "HTTP_TIMEOUT"
  27  )
  28  
  29  // Config is used to configure the creation of the DNSProvider.
  30  type Config struct {
  31  	Username string
  32  	Password string
  33  
  34  	PropagationTimeout time.Duration
  35  	PollingInterval    time.Duration
  36  	HTTPClient         *http.Client
  37  }
  38  
  39  // NewDefaultConfig returns a default configuration for the DNSProvider.
  40  func NewDefaultConfig() *Config {
  41  	return &Config{
  42  		PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
  43  		PollingInterval:    env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
  44  		HTTPClient: &http.Client{
  45  			Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
  46  		},
  47  	}
  48  }
  49  
  50  // DNSProvider implements the challenge.Provider interface.
  51  type DNSProvider struct {
  52  	config *Config
  53  	client *internal.Client
  54  }
  55  
  56  // NewDNSProvider returns a DNSProvider instance configured for DynDNSFree.
  57  func NewDNSProvider() (*DNSProvider, error) {
  58  	values, err := env.Get(EnvUsername, EnvPassword)
  59  	if err != nil {
  60  		return nil, fmt.Errorf("dyndnsfree: %w", err)
  61  	}
  62  
  63  	config := NewDefaultConfig()
  64  	config.Username = values[EnvUsername]
  65  	config.Password = values[EnvPassword]
  66  
  67  	return NewDNSProviderConfig(config)
  68  }
  69  
  70  // NewDNSProviderConfig return a DNSProvider instance configured for DynDNSFree.
  71  func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
  72  	if config == nil {
  73  		return nil, errors.New("dyndnsfree: the configuration of the DNS provider is nil")
  74  	}
  75  
  76  	client, err := internal.NewClient(config.Username, config.Password)
  77  	if err != nil {
  78  		return nil, fmt.Errorf("dyndnsfree: new client: %w", err)
  79  	}
  80  
  81  	if config.HTTPClient != nil {
  82  		client.HTTPClient = config.HTTPClient
  83  	}
  84  
  85  	client.HTTPClient = clientdebug.Wrap(client.HTTPClient)
  86  
  87  	return &DNSProvider{
  88  		config: config,
  89  		client: client,
  90  	}, nil
  91  }
  92  
  93  // Present creates a TXT record using the specified parameters.
  94  func (d *DNSProvider) Present(domain, token, keyAuth string) error {
  95  	info := dns01.GetChallengeInfo(domain, keyAuth)
  96  
  97  	authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
  98  	if err != nil {
  99  		return fmt.Errorf("dyndnsforfree: could not find zone for domain %q: %w", domain, err)
 100  	}
 101  
 102  	err = d.client.AddTXTRecord(context.Background(), dns01.UnFqdn(authZone), dns01.UnFqdn(info.EffectiveFQDN), info.Value)
 103  	if err != nil {
 104  		return fmt.Errorf("dyndnsfree: add record: %w", err)
 105  	}
 106  
 107  	return nil
 108  }
 109  
 110  // CleanUp removes the TXT record matching the specified parameters.
 111  func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
 112  	// Records are deleted automatically.
 113  	return nil
 114  }
 115  
 116  // Timeout returns the timeout and interval to use when checking for DNS propagation.
 117  // Adjusting here to cope with spikes in propagation times.
 118  func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
 119  	return d.config.PropagationTimeout, d.config.PollingInterval
 120  }
 121