selectel.go raw

   1  // Package selectel implements a DNS provider for solving the DNS-01 challenge using Selectel Domains API.
   2  // Selectel Domain API reference: https://kb.selectel.com/23136054.html
   3  // Token: https://my.selectel.ru/profile/apikeys
   4  package selectel
   5  
   6  import (
   7  	"errors"
   8  	"fmt"
   9  	"net/http"
  10  	"time"
  11  
  12  	"github.com/go-acme/lego/v4/challenge"
  13  	"github.com/go-acme/lego/v4/challenge/dns01"
  14  	"github.com/go-acme/lego/v4/platform/config/env"
  15  	"github.com/go-acme/lego/v4/providers/dns/internal/selectel"
  16  )
  17  
  18  // Environment variables names.
  19  const (
  20  	envNamespace = "SELECTEL_"
  21  
  22  	EnvBaseURL  = envNamespace + "BASE_URL"
  23  	EnvAPIToken = envNamespace + "API_TOKEN"
  24  
  25  	EnvTTL                = envNamespace + "TTL"
  26  	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
  27  	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
  28  	EnvHTTPTimeout        = envNamespace + "HTTP_TIMEOUT"
  29  )
  30  
  31  var _ challenge.ProviderTimeout = (*DNSProvider)(nil)
  32  
  33  // Config is used to configure the creation of the DNSProvider.
  34  type Config = selectel.Config
  35  
  36  // NewDefaultConfig returns a default configuration for the DNSProvider.
  37  func NewDefaultConfig() *Config {
  38  	return &Config{
  39  		BaseURL:            env.GetOrDefaultString(EnvBaseURL, ""),
  40  		TTL:                env.GetOrDefaultInt(EnvTTL, selectel.MinTTL),
  41  		PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 120*time.Second),
  42  		PollingInterval:    env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
  43  		HTTPClient: &http.Client{
  44  			Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
  45  		},
  46  	}
  47  }
  48  
  49  // DNSProvider implements the challenge.Provider interface.
  50  type DNSProvider struct {
  51  	prv challenge.ProviderTimeout
  52  }
  53  
  54  // NewDNSProvider returns a DNSProvider instance configured for Selectel Domains API.
  55  // API token must be passed in the environment variable SELECTEL_API_TOKEN.
  56  func NewDNSProvider() (*DNSProvider, error) {
  57  	values, err := env.Get(EnvAPIToken)
  58  	if err != nil {
  59  		return nil, fmt.Errorf("selectel: %w", err)
  60  	}
  61  
  62  	config := NewDefaultConfig()
  63  	config.Token = values[EnvAPIToken]
  64  
  65  	return NewDNSProviderConfig(config)
  66  }
  67  
  68  // NewDNSProviderConfig return a DNSProvider instance configured for selectel.
  69  func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
  70  	if config == nil {
  71  		return nil, errors.New("selectel: the configuration of the DNS provider is nil")
  72  	}
  73  
  74  	provider, err := selectel.NewDNSProviderConfig(config)
  75  	if err != nil {
  76  		return nil, fmt.Errorf("selectel: %w", err)
  77  	}
  78  
  79  	return &DNSProvider{prv: provider}, nil
  80  }
  81  
  82  // Present creates a TXT record using the specified parameters.
  83  func (d *DNSProvider) Present(domain, token, keyAuth string) error {
  84  	err := d.prv.Present(domain, token, keyAuth)
  85  	if err != nil {
  86  		return fmt.Errorf("selectel: %w", err)
  87  	}
  88  
  89  	return nil
  90  }
  91  
  92  // CleanUp removes the TXT record matching the specified parameters.
  93  func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
  94  	err := d.prv.CleanUp(domain, token, keyAuth)
  95  	if err != nil {
  96  		return fmt.Errorf("selectel: %w", err)
  97  	}
  98  
  99  	return nil
 100  }
 101  
 102  // Timeout returns the timeout and interval to use when checking for DNS propagation.
 103  // Adjusting here to cope with spikes in propagation times.
 104  func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
 105  	return d.prv.Timeout()
 106  }
 107