vscale.go raw

   1  // Package vscale implements a DNS provider for solving the DNS-01 challenge using Vscale Domains API.
   2  // Vscale Domain API reference: https://developers.vscale.io/documentation/api/v1/#api-Domains
   3  // Token: https://vscale.io/panel/settings/tokens/
   4  package vscale
   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 = "VSCALE_"
  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  const defaultBaseURL = "https://api.vscale.io/v1/domains"
  32  
  33  var _ challenge.ProviderTimeout = (*DNSProvider)(nil)
  34  
  35  // Config is used to configure the creation of the DNSProvider.
  36  type Config = selectel.Config
  37  
  38  // NewDefaultConfig returns a default configuration for the DNSProvider.
  39  func NewDefaultConfig() *Config {
  40  	return &Config{
  41  		BaseURL:            env.GetOrDefaultString(EnvBaseURL, defaultBaseURL),
  42  		TTL:                env.GetOrDefaultInt(EnvTTL, selectel.MinTTL),
  43  		PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 120*time.Second),
  44  		PollingInterval:    env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
  45  		HTTPClient: &http.Client{
  46  			Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
  47  		},
  48  	}
  49  }
  50  
  51  // DNSProvider implements the challenge.Provider interface.
  52  type DNSProvider struct {
  53  	prv challenge.ProviderTimeout
  54  }
  55  
  56  // NewDNSProvider returns a DNSProvider instance configured for Vscale Domains API.
  57  // API token must be passed in the environment variable VSCALE_API_TOKEN.
  58  func NewDNSProvider() (*DNSProvider, error) {
  59  	values, err := env.Get(EnvAPIToken)
  60  	if err != nil {
  61  		return nil, fmt.Errorf("vscale: %w", err)
  62  	}
  63  
  64  	config := NewDefaultConfig()
  65  	config.Token = values[EnvAPIToken]
  66  
  67  	return NewDNSProviderConfig(config)
  68  }
  69  
  70  // NewDNSProviderConfig return a DNSProvider instance configured for Vscale.
  71  func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
  72  	if config == nil {
  73  		return nil, errors.New("vscale: the configuration of the DNS provider is nil")
  74  	}
  75  
  76  	if config.BaseURL == "" {
  77  		config.BaseURL = defaultBaseURL
  78  	}
  79  
  80  	provider, err := selectel.NewDNSProviderConfig(config)
  81  	if err != nil {
  82  		return nil, fmt.Errorf("vscale: %w", err)
  83  	}
  84  
  85  	return &DNSProvider{prv: provider}, nil
  86  }
  87  
  88  // Present creates a TXT record using the specified parameters.
  89  func (d *DNSProvider) Present(domain, token, keyAuth string) error {
  90  	err := d.prv.Present(domain, token, keyAuth)
  91  	if err != nil {
  92  		return fmt.Errorf("vscale: %w", err)
  93  	}
  94  
  95  	return nil
  96  }
  97  
  98  // CleanUp removes the TXT record matching the specified parameters.
  99  func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
 100  	err := d.prv.CleanUp(domain, token, keyAuth)
 101  	if err != nil {
 102  		return fmt.Errorf("vscale: %w", err)
 103  	}
 104  
 105  	return nil
 106  }
 107  
 108  // Timeout returns the timeout and interval to use when checking for DNS propagation.
 109  // Adjusting here to cope with spikes in propagation times.
 110  func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
 111  	return d.prv.Timeout()
 112  }
 113