metaregistrar.go raw

   1  // Package metaregistrar implements a DNS provider for solving the DNS-01 challenge using Metaregistrar.
   2  package metaregistrar
   3  
   4  import (
   5  	"context"
   6  	"errors"
   7  	"fmt"
   8  	"net/http"
   9  	"strconv"
  10  	"time"
  11  
  12  	"github.com/go-acme/lego/v4/challenge/dns01"
  13  	"github.com/go-acme/lego/v4/platform/config/env"
  14  	"github.com/go-acme/lego/v4/providers/dns/internal/clientdebug"
  15  	"github.com/go-acme/lego/v4/providers/dns/metaregistrar/internal"
  16  )
  17  
  18  // Environment variables names.
  19  const (
  20  	envNamespace = "METAREGISTRAR_"
  21  
  22  	EnvToken = envNamespace + "API_TOKEN"
  23  
  24  	EnvTTL                = envNamespace + "TTL"
  25  	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
  26  	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
  27  	EnvHTTPTimeout        = envNamespace + "HTTP_TIMEOUT"
  28  )
  29  
  30  // Config is used to configure the creation of the DNSProvider.
  31  type Config struct {
  32  	APIToken string
  33  
  34  	PropagationTimeout time.Duration
  35  	PollingInterval    time.Duration
  36  	TTL                int
  37  	HTTPClient         *http.Client
  38  }
  39  
  40  // NewDefaultConfig returns a default configuration for the DNSProvider.
  41  func NewDefaultConfig() *Config {
  42  	return &Config{
  43  		TTL:                env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
  44  		PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
  45  		PollingInterval:    env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
  46  		HTTPClient: &http.Client{
  47  			Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
  48  		},
  49  	}
  50  }
  51  
  52  // DNSProvider implements the challenge.Provider interface.
  53  type DNSProvider struct {
  54  	config *Config
  55  	client *internal.Client
  56  }
  57  
  58  // NewDNSProvider returns a DNSProvider instance configured for Metaregistrar.
  59  func NewDNSProvider() (*DNSProvider, error) {
  60  	values, err := env.Get(EnvToken)
  61  	if err != nil {
  62  		return nil, fmt.Errorf("metaregistrar: %w", err)
  63  	}
  64  
  65  	config := NewDefaultConfig()
  66  	config.APIToken = values[EnvToken]
  67  
  68  	return NewDNSProviderConfig(config)
  69  }
  70  
  71  // NewDNSProviderConfig return a DNSProvider instance configured for Metaregistrar.
  72  func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
  73  	if config == nil {
  74  		return nil, errors.New("metaregistrar: the configuration of the DNS provider is nil")
  75  	}
  76  
  77  	client, err := internal.NewClient(config.APIToken)
  78  	if err != nil {
  79  		return nil, fmt.Errorf("metaregistrar: %w", err)
  80  	}
  81  
  82  	if config.HTTPClient != nil {
  83  		client.HTTPClient = config.HTTPClient
  84  	}
  85  
  86  	client.HTTPClient = clientdebug.Wrap(client.HTTPClient)
  87  
  88  	return &DNSProvider{
  89  		config: config,
  90  		client: client,
  91  	}, nil
  92  }
  93  
  94  // Present creates a TXT record using the specified parameters.
  95  func (d *DNSProvider) Present(domain, token, keyAuth string) error {
  96  	info := dns01.GetChallengeInfo(domain, keyAuth)
  97  
  98  	authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
  99  	if err != nil {
 100  		return fmt.Errorf("metaregistrar: could not find zone for domain %q: %w", domain, err)
 101  	}
 102  
 103  	updateRequest := internal.DNSZoneUpdateRequest{
 104  		Add: []internal.Record{{
 105  			Name:    dns01.UnFqdn(info.EffectiveFQDN),
 106  			Type:    "TXT",
 107  			TTL:     d.config.TTL,
 108  			Content: info.Value,
 109  		}},
 110  	}
 111  
 112  	_, err = d.client.UpdateDNSZone(context.Background(), dns01.UnFqdn(authZone), updateRequest)
 113  	if err != nil {
 114  		return fmt.Errorf("metaregistrar: %w", err)
 115  	}
 116  
 117  	return nil
 118  }
 119  
 120  // CleanUp removes the TXT record matching the specified parameters.
 121  func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
 122  	info := dns01.GetChallengeInfo(domain, keyAuth)
 123  
 124  	authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
 125  	if err != nil {
 126  		return fmt.Errorf("metaregistrar: could not find zone for domain %q: %w", domain, err)
 127  	}
 128  
 129  	updateRequest := internal.DNSZoneUpdateRequest{
 130  		Remove: []internal.Record{{
 131  			Name:    dns01.UnFqdn(info.EffectiveFQDN),
 132  			Type:    "TXT",
 133  			TTL:     d.config.TTL,
 134  			Content: strconv.Quote(info.Value),
 135  		}},
 136  	}
 137  
 138  	_, err = d.client.UpdateDNSZone(context.Background(), dns01.UnFqdn(authZone), updateRequest)
 139  	if err != nil {
 140  		return fmt.Errorf("metaregistrar: %w", err)
 141  	}
 142  
 143  	return nil
 144  }
 145  
 146  // Timeout returns the timeout and interval to use when checking for DNS propagation.
 147  // Adjusting here to cope with spikes in propagation times.
 148  func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
 149  	return d.config.PropagationTimeout, d.config.PollingInterval
 150  }
 151