1
0
mirror of https://github.com/go-acme/lego.git synced 2024-12-23 01:07:23 +02:00
lego/providers/dns/vkcloud/vkcloud.go
2024-02-11 14:37:09 +01:00

241 lines
6.3 KiB
Go

// Package vkcloud implements a DNS provider for solving the DNS-01 challenge using VK Cloud.
package vkcloud
import (
"errors"
"fmt"
"time"
"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/vkcloud/internal"
"github.com/gophercloud/gophercloud"
)
const (
defaultIdentityEndpoint = "https://infra.mail.ru/identity/v3/"
defaultDNSEndpoint = "https://mcs.mail.ru/public-dns/v2/dns"
)
const defaultDomainName = "users"
// Environment variables names.
const (
envNamespace = "VK_CLOUD_"
EnvDNSEndpoint = envNamespace + "DNS_ENDPOINT"
EnvIdentityEndpoint = envNamespace + "IDENTITY_ENDPOINT"
EnvDomainName = envNamespace + "DOMAIN_NAME"
EnvProjectID = envNamespace + "PROJECT_ID"
EnvUsername = envNamespace + "USERNAME"
EnvPassword = envNamespace + "PASSWORD"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
)
// Config is used to configure the creation of the DNSProvider.
type Config struct {
ProjectID string
Username string
Password string
DNSEndpoint string
IdentityEndpoint string
DomainName string
PropagationTimeout time.Duration
PollingInterval time.Duration
TTL int
}
// NewDefaultConfig returns a default configuration for the DNSProvider.
func NewDefaultConfig() *Config {
return &Config{
TTL: env.GetOrDefaultInt(EnvTTL, 60),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
}
}
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
client *internal.Client
config *Config
}
// NewDNSProvider returns a DNSProvider instance configured for VK Cloud.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvProjectID, EnvUsername, EnvPassword)
if err != nil {
return nil, fmt.Errorf("vkcloud: %w", err)
}
config := NewDefaultConfig()
config.ProjectID = values[EnvProjectID]
config.Username = values[EnvUsername]
config.Password = values[EnvPassword]
config.IdentityEndpoint = env.GetOrDefaultString(EnvIdentityEndpoint, defaultIdentityEndpoint)
config.DomainName = env.GetOrDefaultString(EnvDomainName, defaultDomainName)
config.DNSEndpoint = env.GetOrDefaultString(EnvDNSEndpoint, defaultDNSEndpoint)
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for VK Cloud.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("vkcloud: the configuration of the DNS provider is nil")
}
if config.DNSEndpoint == "" {
return nil, errors.New("vkcloud: DNS endpoint is missing in config")
}
authOpts := gophercloud.AuthOptions{
IdentityEndpoint: config.IdentityEndpoint,
Username: config.Username,
Password: config.Password,
DomainName: config.DomainName,
TenantID: config.ProjectID,
}
client, err := internal.NewClient(config.DNSEndpoint, authOpts)
if err != nil {
return nil, fmt.Errorf("vkcloud: unable to build VK Cloud client: %w", err)
}
return &DNSProvider{
client: client,
config: config,
}, nil
}
// Present creates a TXT record to fulfill the dns-01 challenge.
func (r *DNSProvider) Present(domain, _, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("vkcloud: could not find zone for domain %q: %w", domain, err)
}
authZone = dns01.UnFqdn(authZone)
zones, err := r.client.ListZones()
if err != nil {
return fmt.Errorf("vkcloud: unable to fetch dns zones: %w", err)
}
var zoneUUID string
for _, zone := range zones {
if zone.Zone == authZone {
zoneUUID = zone.UUID
}
}
if zoneUUID == "" {
return fmt.Errorf("vkcloud: cant find dns zone %s in VK Cloud", authZone)
}
subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
if err != nil {
return fmt.Errorf("vkcloud: %w", err)
}
err = r.upsertTXTRecord(zoneUUID, subDomain, info.Value)
if err != nil {
return fmt.Errorf("vkcloud: %w", err)
}
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
func (r *DNSProvider) CleanUp(domain, _, keyAuth string) error {
info := dns01.GetChallengeInfo(domain, keyAuth)
authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
if err != nil {
return fmt.Errorf("vkcloud: could not find zone for domain %q: %w", domain, err)
}
authZone = dns01.UnFqdn(authZone)
zones, err := r.client.ListZones()
if err != nil {
return fmt.Errorf("vkcloud: unable to fetch dns zones: %w", err)
}
var zoneUUID string
for _, zone := range zones {
if zone.Zone == authZone {
zoneUUID = zone.UUID
}
}
if zoneUUID == "" {
return nil
}
subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone)
if err != nil {
return fmt.Errorf("vkcloud: %w", err)
}
err = r.removeTXTRecord(zoneUUID, subDomain, info.Value)
if err != nil {
return fmt.Errorf("vkcloud: %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 (r *DNSProvider) Timeout() (timeout, interval time.Duration) {
return r.config.PropagationTimeout, r.config.PollingInterval
}
func (r *DNSProvider) upsertTXTRecord(zoneUUID, name, value string) error {
records, err := r.client.ListTXTRecords(zoneUUID)
if err != nil {
return err
}
for _, record := range records {
if record.Name == name && record.Content == value {
// The DNSRecord is already present, nothing to do
return nil
}
}
return r.client.CreateTXTRecord(zoneUUID, &internal.DNSTXTRecord{
Name: name,
Content: value,
TTL: r.config.TTL,
})
}
func (r *DNSProvider) removeTXTRecord(zoneUUID, name, value string) error {
records, err := r.client.ListTXTRecords(zoneUUID)
if err != nil {
return err
}
name = dns01.UnFqdn(name)
for _, record := range records {
if record.Name == name && record.Content == value {
return r.client.DeleteTXTRecord(zoneUUID, record.UUID)
}
}
// The DNSRecord is not present, nothing to do
return nil
}