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

177 lines
4.4 KiB
Go
Raw Normal View History

2020-04-27 19:58:18 +02:00
// Package yandex implements a DNS provider for solving the DNS-01 challenge using Yandex.
package yandex
import (
"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"
"github.com/go-acme/lego/v4/providers/dns/yandex/internal"
2020-04-27 19:58:18 +02:00
"github.com/miekg/dns"
)
const defaultTTL = 21600
// Environment variables names.
const (
envNamespace = "YANDEX_"
EnvPddToken = envNamespace + "PDD_TOKEN"
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.
2020-04-27 19:58:18 +02:00
type Config struct {
PddToken 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.
2020-04-27 19:58:18 +02:00
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt(EnvTTL, defaultTTL),
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.
2020-04-27 19:58:18 +02:00
type DNSProvider struct {
client *internal.Client
config *Config
}
// NewDNSProvider returns a DNSProvider instance configured for Yandex.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvPddToken)
if err != nil {
2020-10-27 13:01:05 +02:00
return nil, fmt.Errorf("yandex: %w", err)
2020-04-27 19:58:18 +02:00
}
config := NewDefaultConfig()
config.PddToken = values[EnvPddToken]
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for Yandex.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("yandex: the configuration of the DNS provider is nil")
}
if config.PddToken == "" {
return nil, fmt.Errorf("yandex: credentials missing")
}
client, err := internal.NewClient(config.PddToken)
if err != nil {
2020-10-27 13:01:05 +02:00
return nil, fmt.Errorf("yandex: %w", err)
2020-04-27 19:58:18 +02:00
}
if config.HTTPClient != nil {
client.HTTPClient = config.HTTPClient
}
return &DNSProvider{client: client, config: config}, nil
}
// Present creates a TXT record to fulfill the dns-01 challenge.
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
2020-04-27 19:58:18 +02:00
rootDomain, subDomain, err := splitDomain(info.EffectiveFQDN)
2020-04-27 19:58:18 +02:00
if err != nil {
2020-10-27 13:01:05 +02:00
return fmt.Errorf("yandex: %w", err)
2020-04-27 19:58:18 +02:00
}
data := internal.Record{
Domain: rootDomain,
SubDomain: subDomain,
Type: "TXT",
TTL: d.config.TTL,
Content: info.Value,
2020-04-27 19:58:18 +02:00
}
_, err = d.client.AddRecord(data)
if err != nil {
2020-10-27 13:01:05 +02:00
return fmt.Errorf("yandex: %w", err)
2020-04-27 19:58:18 +02:00
}
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
2020-04-27 19:58:18 +02:00
rootDomain, subDomain, err := splitDomain(info.EffectiveFQDN)
2020-04-27 19:58:18 +02:00
if err != nil {
2020-10-27 13:01:05 +02:00
return fmt.Errorf("yandex: %w", err)
2020-04-27 19:58:18 +02:00
}
records, err := d.client.GetRecords(rootDomain)
if err != nil {
2020-10-27 13:01:05 +02:00
return fmt.Errorf("yandex: %w", err)
2020-04-27 19:58:18 +02:00
}
var record *internal.Record
for _, rcd := range records {
2020-07-10 01:48:18 +02:00
rcd := rcd
if rcd.Type == "TXT" && rcd.SubDomain == subDomain && rcd.Content == info.Value {
2020-04-27 19:58:18 +02:00
record = &rcd
break
}
}
if record == nil {
return fmt.Errorf("yandex: TXT record not found for domain: %s", domain)
}
data := internal.Record{
ID: record.ID,
Domain: rootDomain,
}
_, err = d.client.RemoveRecord(data)
if err != nil {
2020-10-27 13:01:05 +02:00
return fmt.Errorf("yandex: %w", err)
2020-04-27 19:58:18 +02:00
}
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
}
func splitDomain(full string) (string, string, error) {
split := dns.Split(full)
if len(split) < 2 {
return "", "", fmt.Errorf("unsupported domain: %s", full)
}
if len(split) == 2 {
return full, "", nil
}
domain := full[split[len(split)-2]:]
subDomain := full[:split[len(split)-2]-1]
return domain, subDomain, nil
}