feat: add gname applicant

internal/pkg/core/applicant/acme-dns-01/lego-providers/gname/gname.go

@@ -0,0 +1,40 @@
+package gname
+
+import (
+	"errors"
+	"time"
+
+	"github.com/go-acme/lego/v4/challenge"
+
+	internal "github.com/usual2970/certimate/internal/pkg/core/applicant/acme-dns-01/lego-providers/gname/internal"
+)
+
+type GnameApplicantConfig struct {
+	AppId                 string `json:"appId"`
+	AppKey                string `json:"appKey"`
+	DnsPropagationTimeout int32  `json:"dnsPropagationTimeout,omitempty"`
+	DnsTTL                int32  `json:"dnsTTL,omitempty"`
+}
+
+func NewChallengeProvider(config *GnameApplicantConfig) (challenge.Provider, error) {
+	if config == nil {
+		return nil, errors.New("config is nil")
+	}
+
+	providerConfig := internal.NewDefaultConfig()
+	providerConfig.AppID = config.AppId
+	providerConfig.AppKey = config.AppKey
+	if config.DnsPropagationTimeout != 0 {
+		providerConfig.PropagationTimeout = time.Duration(config.DnsPropagationTimeout) * time.Second
+	}
+	if config.DnsTTL != 0 {
+		providerConfig.TTL = int(config.DnsTTL)
+	}
+
+	provider, err := internal.NewDNSProviderConfig(providerConfig)
+	if err != nil {
+		return nil, err
+	}
+
+	return provider, nil
+}

internal/pkg/core/applicant/acme-dns-01/lego-providers/gname/internal/lego.go

@@ -0,0 +1,196 @@
+package lego_gname
+
+import (
+	"errors"
+	"fmt"
+	"time"
+
+	"github.com/go-acme/lego/v4/challenge"
+	"github.com/go-acme/lego/v4/challenge/dns01"
+	"github.com/go-acme/lego/v4/platform/config/env"
+
+	gnamesdk "github.com/usual2970/certimate/internal/pkg/vendors/gname-sdk"
+)
+
+const (
+	envNamespace = "GNAME_"
+
+	EnvAppID  = envNamespace + "APP_ID"
+	EnvAppKey = envNamespace + "APP_KEY"
+
+	EnvTTL                = envNamespace + "TTL"
+	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
+	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
+	EnvHTTPTimeout        = envNamespace + "HTTP_TIMEOUT"
+)
+
+var _ challenge.ProviderTimeout = (*DNSProvider)(nil)
+
+type Config struct {
+	AppID  string
+	AppKey string
+
+	PropagationTimeout time.Duration
+	PollingInterval    time.Duration
+	TTL                int
+	HTTPTimeout        time.Duration
+}
+
+type DNSProvider struct {
+	client *gnamesdk.GnameClient
+	config *Config
+}
+
+func NewDefaultConfig() *Config {
+	return &Config{
+		TTL:                env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
+		PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 2*time.Minute),
+		PollingInterval:    env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval),
+		HTTPTimeout:        env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second),
+	}
+}
+
+func NewDNSProvider() (*DNSProvider, error) {
+	values, err := env.Get(EnvAppID, EnvAppKey)
+	if err != nil {
+		return nil, fmt.Errorf("gname: %w", err)
+	}
+
+	config := NewDefaultConfig()
+	config.AppID = values[EnvAppID]
+	config.AppKey = values[EnvAppKey]
+
+	return NewDNSProviderConfig(config)
+}
+
+func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
+	if config == nil {
+		return nil, errors.New("gname: the configuration of the DNS provider is nil")
+	}
+
+	client := gnamesdk.NewGnameClient(config.AppID, config.AppKey).
+		WithTimeout(config.HTTPTimeout)
+
+	return &DNSProvider{
+		client: client,
+		config: config,
+	}, nil
+}
+
+func (d *DNSProvider) Present(domain, token, keyAuth string) error {
+	info := dns01.GetChallengeInfo(domain, keyAuth)
+
+	zoneName, err := dns01.FindZoneByFqdn(info.EffectiveFQDN)
+	if err != nil {
+		return fmt.Errorf("gname: %w", err)
+	}
+
+	subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, zoneName)
+	if err != nil {
+		return fmt.Errorf("gname: %w", err)
+	}
+
+	if err := d.addOrUpdateDNSRecord(domain, subDomain, info.Value); err != nil {
+		return fmt.Errorf("gname: %w", err)
+	}
+
+	return nil
+}
+
+func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
+	fqdn, value := dns01.GetRecord(domain, keyAuth)
+	subDomain := dns01.UnFqdn(fqdn)
+
+	if err := d.removeDNSRecord(domain, subDomain, value); err != nil {
+		return fmt.Errorf("gname: %w", err)
+	}
+
+	return nil
+}
+
+func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
+	return d.config.PropagationTimeout, d.config.PollingInterval
+}
+
+func (d *DNSProvider) getDNSRecord(domain, subDomain string) (*gnamesdk.ResolutionRecord, error) {
+	page := 1
+	pageSize := 20
+	for {
+		request := &gnamesdk.ListDomainResolutionRequest{}
+		request.ZoneName = domain
+		request.Page = &page
+		request.PageSize = &pageSize
+
+		response, err := d.client.ListDomainResolution(request)
+		if err != nil {
+			return nil, err
+		}
+
+		for _, record := range response.Data {
+			if record.RecordType == "TXT" && record.RecordName == subDomain {
+				return record, nil
+			}
+		}
+
+		if len(response.Data) == 0 {
+			break
+		}
+		if response.Page*response.PageSize >= response.Count {
+			break
+		}
+
+		page++
+	}
+
+	return nil, nil
+}
+
+func (d *DNSProvider) addOrUpdateDNSRecord(domain, subDomain, value string) error {
+	record, err := d.getDNSRecord(domain, subDomain)
+	if err != nil {
+		return err
+	}
+
+	if record == nil {
+		request := &gnamesdk.AddDomainResolutionRequest{
+			ZoneName:    domain,
+			RecordType:  "TXT",
+			RecordName:  subDomain,
+			RecordValue: value,
+			TTL:         d.config.TTL,
+		}
+		_, err := d.client.AddDomainResolution(request)
+		return err
+	} else {
+		request := &gnamesdk.ModifyDomainResolutionRequest{
+			ID:          record.ID,
+			ZoneName:    domain,
+			RecordType:  "TXT",
+			RecordName:  subDomain,
+			RecordValue: value,
+			TTL:         d.config.TTL,
+		}
+		_, err := d.client.ModifyDomainResolution(request)
+		return err
+	}
+
+	return nil
+}
+
+func (d *DNSProvider) removeDNSRecord(domain, subDomain, value string) error {
+	record, err := d.getDNSRecord(domain, subDomain)
+	if err != nil {
+		return err
+	}
+
+	if record == nil {
+		return nil
+	}
+
+	request := &gnamesdk.DeleteDomainResolutionRequest{
+		ZoneName: domain,
+		RecordID: record.ID,
+	}
+	_, err = d.client.DeleteDomainResolution(request)
+	return err
+}