httpnet.go raw

   1  // Package httpnet implements a DNS provider for solving the DNS-01 challenge using http.net.
   2  package httpnet
   3  
   4  import (
   5  	"errors"
   6  	"fmt"
   7  	"net/http"
   8  	"time"
   9  
  10  	"github.com/go-acme/lego/v4/challenge"
  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/internal/hostingde"
  14  )
  15  
  16  // Environment variables names.
  17  const (
  18  	envNamespace = "HTTPNET_"
  19  
  20  	EnvAPIKey   = envNamespace + "API_KEY"
  21  	EnvZoneName = envNamespace + "ZONE_NAME"
  22  
  23  	EnvTTL                = envNamespace + "TTL"
  24  	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
  25  	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
  26  	EnvHTTPTimeout        = envNamespace + "HTTP_TIMEOUT"
  27  )
  28  
  29  const defaultBaseURL = "https://partner.http.net/api/dns/v1/json"
  30  
  31  var _ challenge.ProviderTimeout = (*DNSProvider)(nil)
  32  
  33  // Config is used to configure the creation of the DNSProvider.
  34  type Config = hostingde.Config
  35  
  36  // NewDefaultConfig returns a default configuration for the DNSProvider.
  37  func NewDefaultConfig() *Config {
  38  	return &Config{
  39  		ZoneName:           env.GetOrFile(EnvZoneName),
  40  		TTL:                env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
  41  		PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 2*time.Minute),
  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 http.net.
  55  // Credentials must be passed in the environment variables:
  56  // HTTPNET_ZONE_NAME and HTTPNET_API_KEY.
  57  func NewDNSProvider() (*DNSProvider, error) {
  58  	values, err := env.Get(EnvAPIKey)
  59  	if err != nil {
  60  		return nil, fmt.Errorf("httpnet: %w", err)
  61  	}
  62  
  63  	config := NewDefaultConfig()
  64  	config.APIKey = values[EnvAPIKey]
  65  
  66  	return NewDNSProviderConfig(config)
  67  }
  68  
  69  // NewDNSProviderConfig return a DNSProvider instance configured for http.net.
  70  func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
  71  	if config == nil {
  72  		return nil, errors.New("httpnet: the configuration of the DNS provider is nil")
  73  	}
  74  
  75  	provider, err := hostingde.NewDNSProviderConfig(config, defaultBaseURL)
  76  	if err != nil {
  77  		return nil, fmt.Errorf("httpnet: %w", err)
  78  	}
  79  
  80  	return &DNSProvider{prv: provider}, nil
  81  }
  82  
  83  // Present creates a TXT record using the specified parameters.
  84  func (d *DNSProvider) Present(domain, token, keyAuth string) error {
  85  	err := d.prv.Present(domain, token, keyAuth)
  86  	if err != nil {
  87  		return fmt.Errorf("httpnet: %w", err)
  88  	}
  89  
  90  	return nil
  91  }
  92  
  93  // CleanUp removes the TXT record matching the specified parameters.
  94  func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
  95  	err := d.prv.CleanUp(domain, token, keyAuth)
  96  	if err != nil {
  97  		return fmt.Errorf("httpnet: %w", err)
  98  	}
  99  
 100  	return nil
 101  }
 102  
 103  // Timeout returns the timeout and interval to use when checking for DNS propagation.
 104  // Adjusting here to cope with spikes in propagation times.
 105  func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
 106  	return d.prv.Timeout()
 107  }
 108