// Package huaweicloud implements a DNS provider for solving the DNS-01 challenge using Huawei Cloud. package huaweicloud import ( "context" "errors" "fmt" "strconv" "strings" "sync" "time" "github.com/cenkalti/backoff/v5" "github.com/go-acme/lego/v4/challenge" "github.com/go-acme/lego/v4/challenge/dns01" "github.com/go-acme/lego/v4/platform/config/env" "github.com/go-acme/lego/v4/platform/wait" "github.com/go-acme/lego/v4/providers/dns/huaweicloud/internal" "github.com/go-acme/lego/v4/providers/dns/internal/ptr" hwauthbasic "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hwconfig "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/config" hwdns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2" hwmodel "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model" hwregion "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region" ) // Environment variables names. const ( envNamespace = "HUAWEICLOUD_" EnvAccessKeyID = envNamespace + "ACCESS_KEY_ID" EnvSecretAccessKey = envNamespace + "SECRET_ACCESS_KEY" EnvRegion = envNamespace + "REGION" EnvTTL = envNamespace + "TTL" EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT" EnvPollingInterval = envNamespace + "POLLING_INTERVAL" EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT" ) var _ challenge.ProviderTimeout = (*DNSProvider)(nil) // Config is used to configure the creation of the DNSProvider. type Config struct { AccessKeyID string SecretAccessKey string Region string PropagationTimeout time.Duration PollingInterval time.Duration TTL int32 HTTPTimeout time.Duration } // NewDefaultConfig returns a default configuration for the DNSProvider. func NewDefaultConfig() *Config { return &Config{ TTL: int32(env.GetOrDefaultInt(EnvTTL, 300)), PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout), PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval), HTTPTimeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second), } } // DNSProvider implements the challenge.Provider interface. type DNSProvider struct { config *Config client *internal.DnsClient recordIDs map[string]string recordIDsMu sync.Mutex } // NewDNSProvider returns a DNSProvider instance configured for Huawei Cloud. // Credentials must be passed in the environment variables: // HUAWEICLOUD_ACCESS_KEY_ID, HUAWEICLOUD_SECRET_ACCESS_KEY, and HUAWEICLOUD_REGION. func NewDNSProvider() (*DNSProvider, error) { values, err := env.Get(EnvAccessKeyID, EnvSecretAccessKey, EnvRegion) if err != nil { return nil, fmt.Errorf("huaweicloud: %w", err) } config := NewDefaultConfig() config.AccessKeyID = values[EnvAccessKeyID] config.SecretAccessKey = values[EnvSecretAccessKey] config.Region = values[EnvRegion] return NewDNSProviderConfig(config) } // NewDNSProviderConfig return a DNSProvider instance configured for Huawei Cloud. func NewDNSProviderConfig(config *Config) (*DNSProvider, error) { if config == nil { return nil, errors.New("huaweicloud: the configuration of the DNS provider is nil") } if config.AccessKeyID == "" || config.SecretAccessKey == "" || config.Region == "" { return nil, errors.New("huaweicloud: credentials missing") } auth, err := hwauthbasic.NewCredentialsBuilder(). WithAk(config.AccessKeyID). WithSk(config.SecretAccessKey). SafeBuild() if err != nil { return nil, fmt.Errorf("huaweicloud: crendential build: %w", err) } region, err := hwregion.SafeValueOf(config.Region) if err != nil { return nil, fmt.Errorf("huaweicloud: safe region: %w", err) } client, err := hwdns.DnsClientBuilder(). WithHttpConfig(hwconfig.DefaultHttpConfig().WithTimeout(config.HTTPTimeout)). WithRegion(region). WithCredential(auth). SafeBuild() if err != nil { return nil, fmt.Errorf("huaweicloud: client build: %w", err) } return &DNSProvider{ config: config, client: internal.NewDnsClient(client), recordIDs: map[string]string{}, }, nil } // Present creates a TXT record using the specified parameters. func (d *DNSProvider) Present(domain, token, keyAuth string) error { info := dns01.GetChallengeInfo(domain, keyAuth) authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN) if err != nil { return fmt.Errorf("huaweicloud: could not find zone for domain %q: %w", domain, err) } zoneID, err := d.getZoneID(authZone) if err != nil { return fmt.Errorf("huaweicloud: %w", err) } recordSetID, err := d.getOrCreateRecordSetID(domain, zoneID, info) if err != nil { return fmt.Errorf("huaweicloud: %w", err) } d.recordIDsMu.Lock() d.recordIDs[token] = recordSetID d.recordIDsMu.Unlock() err = wait.Retry(context.Background(), func() error { rs, errShow := d.client.ShowRecordSet(&hwmodel.ShowRecordSetRequest{ ZoneId: zoneID, RecordsetId: recordSetID, }) if errShow != nil { return fmt.Errorf("show record set: %w", errShow) } if !strings.HasSuffix(ptr.Deref(rs.Status), "PENDING_") { return nil } return fmt.Errorf("status: %s", ptr.Deref(rs.Status)) }, backoff.WithBackOff(backoff.NewConstantBackOff(d.config.PollingInterval)), backoff.WithMaxElapsedTime(d.config.PropagationTimeout), ) if err != nil { return fmt.Errorf("huaweicloud: record set sync on %s: %w", domain, err) } 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) // gets the record's unique ID from when we created it d.recordIDsMu.Lock() recordID, ok := d.recordIDs[token] d.recordIDsMu.Unlock() if !ok { return fmt.Errorf("huaweicloud: unknown record ID for '%s' '%s'", info.EffectiveFQDN, token) } authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN) if err != nil { return fmt.Errorf("huaweicloud: could not find zone for domain %q: %w", domain, err) } zoneID, err := d.getZoneID(authZone) if err != nil { return fmt.Errorf("huaweicloud: %w", err) } request := &hwmodel.DeleteRecordSetRequest{ ZoneId: zoneID, RecordsetId: recordID, } _, err = d.client.DeleteRecordSet(request) if err != nil { return fmt.Errorf("huaweicloud: delete record: %w", err) } d.recordIDsMu.Lock() delete(d.recordIDs, token) 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 } func (d *DNSProvider) getOrCreateRecordSetID(domain, zoneID string, info dns01.ChallengeInfo) (string, error) { records, err := d.client.ListRecordSetsByZone(&hwmodel.ListRecordSetsByZoneRequest{ ZoneId: zoneID, Name: ptr.Pointer(info.EffectiveFQDN), }) if err != nil { return "", fmt.Errorf("record list: unable to get record %s for zone %s: %w", info.EffectiveFQDN, domain, err) } var existingRecordSet *hwmodel.ListRecordSets for _, record := range ptr.Deref(records.Recordsets) { if ptr.Deref(record.Type) == "TXT" && ptr.Deref(record.Name) == info.EffectiveFQDN { existingRecordSet = &record } } value := strconv.Quote(info.Value) if existingRecordSet == nil { request := &hwmodel.CreateRecordSetRequest{ ZoneId: zoneID, Body: &hwmodel.CreateRecordSetRequestBody{ Name: info.EffectiveFQDN, Description: ptr.Pointer("Added TXT record for ACME dns-01 challenge using lego client"), Type: "TXT", Ttl: ptr.Pointer(d.config.TTL), Records: []string{value}, }, } resp, errCreate := d.client.CreateRecordSet(request) if errCreate != nil { return "", fmt.Errorf("create record set: %w", errCreate) } return ptr.Deref(resp.Id), nil } updateRequest := &hwmodel.UpdateRecordSetRequest{ ZoneId: zoneID, RecordsetId: ptr.Deref(existingRecordSet.Id), Body: &hwmodel.UpdateRecordSetReq{ Name: existingRecordSet.Name, Description: existingRecordSet.Description, Type: existingRecordSet.Type, Ttl: existingRecordSet.Ttl, Records: ptr.Pointer(append(ptr.Deref(existingRecordSet.Records), value)), }, } resp, err := d.client.UpdateRecordSet(updateRequest) if err != nil { return "", fmt.Errorf("update record set: %w", err) } return ptr.Deref(resp.Id), nil } func (d *DNSProvider) getZoneID(authZone string) (string, error) { zones, err := d.client.ListPublicZones(&hwmodel.ListPublicZonesRequest{}) if err != nil { return "", fmt.Errorf("unable to get zone: %w", err) } for _, zone := range ptr.Deref(zones.Zones) { if ptr.Deref(zone.Name) == authZone { return ptr.Deref(zone.Id), nil } } return "", fmt.Errorf("zone %q not found", authZone) }