1
0
mirror of https://github.com/go-acme/lego.git synced 2024-12-05 12:00:24 +02:00
lego/providers/dns/rackspace/rackspace.go

171 lines
4.8 KiB
Go
Raw Normal View History

// Package rackspace implements a DNS provider for solving the DNS-01 challenge using rackspace DNS.
2019-03-11 18:56:48 +02:00
package rackspace
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"net/http"
"time"
2020-09-02 03:20:01 +02:00
"github.com/go-acme/lego/v4/challenge/dns01"
"github.com/go-acme/lego/v4/platform/config/env"
)
2020-05-08 19:35:25 +02:00
// defaultBaseURL represents the Identity API endpoint to call.
const defaultBaseURL = "https://identity.api.rackspacecloud.com/v2.0/tokens"
// Environment variables names.
const (
envNamespace = "RACKSPACE_"
EnvUser = envNamespace + "USER"
EnvAPIKey = envNamespace + "API_KEY"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT"
)
2020-05-08 19:35:25 +02:00
// Config is used to configure the creation of the DNSProvider.
type Config struct {
BaseURL string
APIUser string
APIKey string
PropagationTimeout time.Duration
PollingInterval time.Duration
TTL int
HTTPClient *http.Client
}
2020-05-08 19:35:25 +02:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
func NewDefaultConfig() *Config {
return &Config{
BaseURL: defaultBaseURL,
TTL: env.GetOrDefaultInt(EnvTTL, 300),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
HTTPClient: &http.Client{
Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
},
}
}
2020-05-08 19:35:25 +02:00
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
config *Config
token string
cloudDNSEndpoint string
}
// NewDNSProvider returns a DNSProvider instance configured for Rackspace.
// Credentials must be passed in the environment variables:
// RACKSPACE_USER and RACKSPACE_API_KEY.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvUser, EnvAPIKey)
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("rackspace: %w", err)
}
config := NewDefaultConfig()
config.APIUser = values[EnvUser]
config.APIKey = values[EnvAPIKey]
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for Rackspace.
// It authenticates against the API, also grabbing the DNS Endpoint.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("rackspace: the configuration of the DNS provider is nil")
}
if config.APIUser == "" || config.APIKey == "" {
2020-02-27 20:14:46 +02:00
return nil, errors.New("rackspace: credentials missing")
}
identity, err := login(config)
if err != nil {
2020-02-27 20:14:46 +02:00
return nil, fmt.Errorf("rackspace: %w", err)
}
// Iterate through the Service Catalog to get the DNS Endpoint
var dnsEndpoint string
for _, service := range identity.Access.ServiceCatalog {
if service.Name == "cloudDNS" {
dnsEndpoint = service.Endpoints[0].PublicURL
break
}
}
if dnsEndpoint == "" {
2020-02-27 20:14:46 +02:00
return nil, errors.New("rackspace: failed to populate DNS endpoint, check Rackspace API for changes")
}
return &DNSProvider{
config: config,
token: identity.Access.Token.ID,
cloudDNSEndpoint: dnsEndpoint,
}, nil
}
2020-05-08 19:35:25 +02:00
// Present creates a TXT record to fulfill the dns-01 challenge.
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
fqdn, value := dns01.GetRecord(domain, keyAuth)
zoneID, err := d.getHostedZoneID(fqdn)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("rackspace: %w", err)
}
2018-05-30 19:53:04 +02:00
rec := Records{
Record: []Record{{
Name: dns01.UnFqdn(fqdn),
Type: "TXT",
Data: value,
TTL: d.config.TTL,
}},
}
body, err := json.Marshal(rec)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("rackspace: %w", err)
}
_, err = d.makeRequest(http.MethodPost, fmt.Sprintf("/domains/%s/records", zoneID), bytes.NewReader(body))
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("rackspace: %w", err)
}
return nil
}
2020-05-08 19:35:25 +02:00
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
fqdn, _ := dns01.GetRecord(domain, keyAuth)
zoneID, err := d.getHostedZoneID(fqdn)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("rackspace: %w", err)
}
record, err := d.findTxtRecord(fqdn, zoneID)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("rackspace: %w", err)
}
_, err = d.makeRequest(http.MethodDelete, fmt.Sprintf("/domains/%s/records?id=%s", zoneID, record.ID), nil)
if err != nil {
2020-02-27 20:14:46 +02:00
return fmt.Errorf("rackspace: %w", err)
}
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
}