lego/providers/dns/ovh/ovh.go

219 lines
6.4 KiB
Go
Raw Normal View History

// Package ovh implements a DNS provider for solving the DNS-01 challenge using OVH DNS.
2019-03-11 16:56:48 +00:00
package ovh
2016-06-16 19:11:19 +00:00
import (
"errors"
2016-06-16 19:11:19 +00:00
"fmt"
"net/http"
2016-06-16 19:11:19 +00:00
"strings"
2016-06-24 18:23:28 +00:00
"sync"
"time"
2016-06-16 19:11:19 +00:00
"github.com/go-acme/lego/v3/challenge/dns01"
"github.com/go-acme/lego/v3/platform/config/env"
2016-06-16 19:11:19 +00:00
"github.com/ovh/go-ovh/ovh"
)
// OVH API reference: https://eu.api.ovh.com/
// Create a Token: https://eu.api.ovh.com/createToken/
// Environment variables names.
const (
envNamespace = "OVH_"
EnvEndpoint = envNamespace + "ENDPOINT"
EnvApplicationKey = envNamespace + "APPLICATION_KEY"
EnvApplicationSecret = envNamespace + "APPLICATION_SECRET"
EnvConsumerKey = envNamespace + "CONSUMER_KEY"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
// Record a DNS record
type Record struct {
2019-09-19 17:07:00 +00:00
ID int64 `json:"id,omitempty"`
FieldType string `json:"fieldType,omitempty"`
SubDomain string `json:"subDomain,omitempty"`
Target string `json:"target,omitempty"`
TTL int `json:"ttl,omitempty"`
Zone string `json:"zone,omitempty"`
}
// Config is used to configure the creation of the DNSProvider
type Config struct {
APIEndpoint string
ApplicationKey string
ApplicationSecret string
ConsumerKey string
PropagationTimeout time.Duration
PollingInterval time.Duration
TTL int
HTTPClient *http.Client
}
// NewDefaultConfig returns a default configuration for the DNSProvider
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, ovh.DefaultTimeout),
},
}
}
2019-08-20 16:40:41 +00:00
// DNSProvider is an implementation of the challenge.Provider interface
2016-06-16 19:11:19 +00:00
// that uses OVH's REST API to manage TXT records for a domain.
type DNSProvider struct {
config *Config
2016-06-24 18:23:28 +00:00
client *ovh.Client
2019-09-19 17:07:00 +00:00
recordIDs map[string]int64
2016-06-24 18:23:28 +00:00
recordIDsMu sync.Mutex
2016-06-16 19:11:19 +00:00
}
// NewDNSProvider returns a DNSProvider instance configured for OVH
// Credentials must be passed in the environment variable:
// OVH_ENDPOINT : it must be ovh-eu or ovh-ca
// OVH_APPLICATION_KEY
// OVH_APPLICATION_SECRET
// OVH_CONSUMER_KEY
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvEndpoint, EnvApplicationKey, EnvApplicationSecret, EnvConsumerKey)
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("ovh: %w", err)
}
config := NewDefaultConfig()
config.APIEndpoint = values[EnvEndpoint]
config.ApplicationKey = values[EnvApplicationKey]
config.ApplicationSecret = values[EnvApplicationSecret]
config.ConsumerKey = values[EnvConsumerKey]
return NewDNSProviderConfig(config)
2016-06-16 19:11:19 +00:00
}
// NewDNSProviderConfig return a DNSProvider instance configured for OVH.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("ovh: the configuration of the DNS provider is nil")
2016-06-16 19:11:19 +00:00
}
if config.APIEndpoint == "" || config.ApplicationKey == "" || config.ApplicationSecret == "" || config.ConsumerKey == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("ovh: credentials missing")
}
2016-06-16 19:11:19 +00:00
client, err := ovh.NewClient(
config.APIEndpoint,
config.ApplicationKey,
config.ApplicationSecret,
config.ConsumerKey,
)
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("ovh: %w", err)
}
client.Client = config.HTTPClient
2016-06-16 19:11:19 +00:00
return &DNSProvider{
config: config,
client: client,
2019-09-19 17:07:00 +00:00
recordIDs: make(map[string]int64),
2016-06-16 19:11:19 +00:00
}, nil
}
// Present creates a TXT record to fulfill the dns-01 challenge.
2016-06-16 19:11:19 +00:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
fqdn, value := dns01.GetRecord(domain, keyAuth)
2016-06-16 19:11:19 +00:00
// Parse domain name
authZone, err := dns01.FindZoneByFqdn(dns01.ToFqdn(domain))
2016-06-16 19:11:19 +00:00
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("ovh: could not determine zone for domain %q: %w", domain, err)
2016-06-16 19:11:19 +00:00
}
authZone = dns01.UnFqdn(authZone)
2016-06-16 19:11:19 +00:00
subDomain := d.extractRecordName(fqdn, authZone)
reqURL := fmt.Sprintf("/domain/zone/%s/record", authZone)
reqData := Record{FieldType: "TXT", SubDomain: subDomain, Target: value, TTL: d.config.TTL}
2016-06-16 19:11:19 +00:00
// Create TXT record
var respData Record
2016-06-16 19:11:19 +00:00
err = d.client.Post(reqURL, reqData, &respData)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("ovh: error when call api to add record (%s): %w", reqURL, err)
2016-06-16 19:11:19 +00:00
}
// Apply the change
reqURL = fmt.Sprintf("/domain/zone/%s/refresh", authZone)
err = d.client.Post(reqURL, nil, nil)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("ovh: error when call api to refresh zone (%s): %w", reqURL, err)
2016-06-16 19:11:19 +00:00
}
d.recordIDsMu.Lock()
2019-11-05 11:58:13 +00:00
d.recordIDs[token] = respData.ID
2016-06-16 19:11:19 +00:00
d.recordIDsMu.Unlock()
return nil
}
// CleanUp removes the TXT record matching the specified parameters
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
fqdn, _ := dns01.GetRecord(domain, keyAuth)
2016-06-16 19:11:19 +00:00
// get the record's unique ID from when we created it
d.recordIDsMu.Lock()
2019-11-05 11:58:13 +00:00
recordID, ok := d.recordIDs[token]
2016-06-16 19:11:19 +00:00
d.recordIDsMu.Unlock()
if !ok {
return fmt.Errorf("ovh: unknown record ID for '%s'", fqdn)
2016-06-16 19:11:19 +00:00
}
authZone, err := dns01.FindZoneByFqdn(dns01.ToFqdn(domain))
2016-06-16 19:11:19 +00:00
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("ovh: could not determine zone for domain %q: %w", domain, err)
2016-06-16 19:11:19 +00:00
}
authZone = dns01.UnFqdn(authZone)
2016-06-16 19:11:19 +00:00
2016-06-24 18:23:28 +00:00
reqURL := fmt.Sprintf("/domain/zone/%s/record/%d", authZone, recordID)
2016-06-16 19:11:19 +00:00
err = d.client.Delete(reqURL, nil)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("ovh: error when call OVH api to delete challenge record (%s): %w", reqURL, err)
2016-06-16 19:11:19 +00:00
}
// Apply the change
reqURL = fmt.Sprintf("/domain/zone/%s/refresh", authZone)
err = d.client.Post(reqURL, nil, nil)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("ovh: error when call api to refresh zone (%s): %w", reqURL, err)
}
2016-06-16 19:11:19 +00:00
// Delete record ID from map
d.recordIDsMu.Lock()
2019-11-05 11:58:13 +00:00
delete(d.recordIDs, token)
2016-06-16 19:11:19 +00:00
d.recordIDsMu.Unlock()
return nil
}
// Timeout returns the timeout and interval to use when checking for DNS propagation.
// Adjusting here to cope with spikes in propagation times.
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
return d.config.PropagationTimeout, d.config.PollingInterval
}
2016-06-16 19:11:19 +00:00
func (d *DNSProvider) extractRecordName(fqdn, domain string) string {
name := dns01.UnFqdn(fqdn)
2016-06-16 19:11:19 +00:00
if idx := strings.Index(name, "."+domain); idx != -1 {
return name[:idx]
}
return name
}