forked from TrueCloudLab/lego
42941ccea6
- Packages - Isolate code used by the CLI into the package `cmd` - (experimental) Add e2e tests for HTTP01, TLS-ALPN-01 and DNS-01, use [Pebble](https://github.com/letsencrypt/pebble) and [challtestsrv](https://github.com/letsencrypt/boulder/tree/master/test/challtestsrv) - Support non-ascii domain name (punnycode) - Check all challenges in a predictable order - No more global exported variables - Archive revoked certificates - Fixes revocation for subdomains and non-ascii domains - Disable pending authorizations - use pointer for RemoteError/ProblemDetails - Poll authz URL instead of challenge URL - The ability for a DNS provider to solve the challenge sequentially - Check all nameservers in a predictable order - Option to disable the complete propagation Requirement - CLI, support for renew with CSR - CLI, add SAN on renew - Add command to list certificates. - Logs every iteration of waiting for the propagation - update DNSimple client - update github.com/miekg/dns
111 lines
3.2 KiB
Go
111 lines
3.2 KiB
Go
// Package dreamhost implements a DNS provider for solving the DNS-01 challenge using DreamHost.
|
|
// See https://help.dreamhost.com/hc/en-us/articles/217560167-API_overview
|
|
// and https://help.dreamhost.com/hc/en-us/articles/217555707-DNS-API-commands for the API spec.
|
|
package dreamhost
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"time"
|
|
|
|
"github.com/xenolf/lego/challenge/dns01"
|
|
"github.com/xenolf/lego/platform/config/env"
|
|
)
|
|
|
|
// Config is used to configure the creation of the DNSProvider
|
|
type Config struct {
|
|
BaseURL string
|
|
APIKey string
|
|
PropagationTimeout time.Duration
|
|
PollingInterval time.Duration
|
|
HTTPClient *http.Client
|
|
}
|
|
|
|
// NewDefaultConfig returns a default configuration for the DNSProvider
|
|
func NewDefaultConfig() *Config {
|
|
return &Config{
|
|
BaseURL: defaultBaseURL,
|
|
PropagationTimeout: env.GetOrDefaultSecond("DREAMHOST_PROPAGATION_TIMEOUT", 60*time.Minute),
|
|
PollingInterval: env.GetOrDefaultSecond("DREAMHOST_POLLING_INTERVAL", 1*time.Minute),
|
|
HTTPClient: &http.Client{
|
|
Timeout: env.GetOrDefaultSecond("DREAMHOST_HTTP_TIMEOUT", 30*time.Second),
|
|
},
|
|
}
|
|
}
|
|
|
|
// DNSProvider adds and removes the record for the DNS challenge
|
|
type DNSProvider struct {
|
|
config *Config
|
|
}
|
|
|
|
// NewDNSProvider returns a new DNS provider using
|
|
// environment variable DREAMHOST_TOKEN for adding and removing the DNS record.
|
|
func NewDNSProvider() (*DNSProvider, error) {
|
|
values, err := env.Get("DREAMHOST_API_KEY")
|
|
if err != nil {
|
|
return nil, fmt.Errorf("dreamhost: %v", err)
|
|
}
|
|
|
|
config := NewDefaultConfig()
|
|
config.APIKey = values["DREAMHOST_API_KEY"]
|
|
|
|
return NewDNSProviderConfig(config)
|
|
}
|
|
|
|
// NewDNSProviderConfig return a DNSProvider instance configured for DreamHost.
|
|
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
|
|
if config == nil {
|
|
return nil, errors.New("dreamhost: the configuration of the DNS provider is nil")
|
|
}
|
|
|
|
if config.APIKey == "" {
|
|
return nil, errors.New("dreamhost: credentials missing")
|
|
}
|
|
|
|
if config.BaseURL == "" {
|
|
config.BaseURL = defaultBaseURL
|
|
}
|
|
|
|
return &DNSProvider{config: config}, nil
|
|
}
|
|
|
|
// 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)
|
|
record := dns01.UnFqdn(fqdn)
|
|
|
|
u, err := d.buildQuery(cmdAddRecord, record, value)
|
|
if err != nil {
|
|
return fmt.Errorf("dreamhost: %v", err)
|
|
}
|
|
|
|
err = d.updateTxtRecord(u)
|
|
if err != nil {
|
|
return fmt.Errorf("dreamhost: %v", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// CleanUp clears DreamHost TXT record
|
|
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
|
|
fqdn, value := dns01.GetRecord(domain, keyAuth)
|
|
record := dns01.UnFqdn(fqdn)
|
|
|
|
u, err := d.buildQuery(cmdRemoveRecord, record, value)
|
|
if err != nil {
|
|
return fmt.Errorf("dreamhost: %v", err)
|
|
}
|
|
|
|
err = d.updateTxtRecord(u)
|
|
if err != nil {
|
|
return fmt.Errorf("dreamhost: %v", 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
|
|
}
|