-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
638 additions
and
490 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,142 +1,143 @@ | ||
| // Package beget implements a DNS provider for solving the DNS-01 challenge using beget.com DNS. | ||
| package beget | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "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/beget/internal" | ||
| ) | ||
|
|
||
| // Environment variables names. | ||
| const ( | ||
| envNamespace = "BEGET_" | ||
|
|
||
| EnvUsername = envNamespace + "USERNAME" | ||
| EnvPassword = envNamespace + "PASSWORD" | ||
|
|
||
| EnvTTL = envNamespace + "TTL" | ||
| EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT" | ||
| EnvPollingInterval = envNamespace + "POLLING_INTERVAL" | ||
| EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT" | ||
| ) | ||
|
|
||
| // Config is used to configure the creation of the DNSProvider. | ||
| type Config struct { | ||
| Username string | ||
| Password string | ||
|
|
||
| PropagationTimeout time.Duration | ||
| PollingInterval time.Duration | ||
| TTL int | ||
| HTTPClient *http.Client | ||
| } | ||
|
|
||
| // NewDefaultConfig returns a default configuration for the DNSProvider. | ||
| func NewDefaultConfig() *Config { | ||
| return &Config{ | ||
| TTL: env.GetOrDefaultInt(EnvTTL, 300), | ||
| PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout*2), //2m | ||
| PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval), | ||
| HTTPClient: &http.Client{ | ||
| Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second), | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // DNSProvider implements the challenge.Provider interface. | ||
| type DNSProvider struct { | ||
| config *Config | ||
| client *internal.Client | ||
| } | ||
|
|
||
| // NewDNSProvider returns a DNSProvider instance configured for beget.com. | ||
| // Credentials must be passed in the environment variables: | ||
| // BEGET_USERNAME and BEGET_PASSWORD. | ||
| func NewDNSProvider() (*DNSProvider, error) { | ||
| values, err := env.Get(EnvUsername, EnvPassword) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("beget: %w", err) | ||
| } | ||
|
|
||
| config := NewDefaultConfig() | ||
| config.Username = values[EnvUsername] | ||
| config.Password = values[EnvPassword] | ||
|
|
||
| return NewDNSProviderConfig(config) | ||
| } | ||
|
|
||
| // NewDNSProviderConfig return a DNSProvider instance configured for beget.com. | ||
| func NewDNSProviderConfig(config *Config) (*DNSProvider, error) { | ||
| if config == nil { | ||
| return nil, errors.New("beget: the configuration of the DNS provider is nil") | ||
| } | ||
|
|
||
| if config.Username == "" || config.Password == "" { | ||
| return nil, errors.New("beget: incomplete credentials, missing username and/or password") | ||
| } | ||
|
|
||
| client := internal.NewClient(config.Username, config.Password) | ||
|
|
||
| if config.HTTPClient != nil { | ||
| client.HTTPClient = config.HTTPClient | ||
| } | ||
|
|
||
| return &DNSProvider{config: config, client: client}, 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 | ||
| } | ||
|
|
||
| // 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("beget: could not find zone for domain %q and fqdn %q : %w", domain, info.EffectiveFQDN, err) | ||
| } | ||
|
|
||
| subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: %w", err) | ||
| } | ||
|
|
||
| err = d.client.AddTXTRecord(dns01.UnFqdn(authZone), subDomain, info.Value) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: failed to create TXT records [domain: %s, sub domain: %s]: %w", | ||
| dns01.UnFqdn(authZone), subDomain, 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) | ||
|
|
||
| authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: could not find zone for domain %q and fqdn %q : %w", domain, info.EffectiveFQDN, err) | ||
| } | ||
|
|
||
| subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: %w", err) | ||
| } | ||
|
|
||
| err = d.client.RemoveTxtRecord(dns01.UnFqdn(authZone), subDomain) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: failed to remove TXT records [domain: %s, sub domain: %s]: %w", | ||
| dns01.UnFqdn(authZone), subDomain, err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
| // Package beget implements a DNS provider for solving the DNS-01 challenge using beget.com DNS. | ||
| package beget | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "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/beget/internal" | ||
| ) | ||
|
|
||
| // Environment variables names. | ||
| const ( | ||
| envNamespace = "BEGET_" | ||
|
|
||
| EnvUsername = envNamespace + "USERNAME" | ||
| EnvPassword = envNamespace + "PASSWORD" | ||
|
|
||
| EnvTTL = envNamespace + "TTL" | ||
| EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT" | ||
| EnvPollingInterval = envNamespace + "POLLING_INTERVAL" | ||
| EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT" | ||
| ) | ||
|
|
||
| // Config is used to configure the creation of the DNSProvider. | ||
| type Config struct { | ||
| Username string | ||
| Password string | ||
|
|
||
| PropagationTimeout time.Duration | ||
| PollingInterval time.Duration | ||
| TTL int | ||
| HTTPClient *http.Client | ||
| } | ||
|
|
||
| // NewDefaultConfig returns a default configuration for the DNSProvider. | ||
| func NewDefaultConfig() *Config { | ||
| return &Config{ | ||
| TTL: env.GetOrDefaultInt(EnvTTL, 300), | ||
| PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout*2), // 2m | ||
| PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, dns01.DefaultPollingInterval), | ||
| HTTPClient: &http.Client{ | ||
| Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 30*time.Second), | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // DNSProvider implements the challenge.Provider interface. | ||
| type DNSProvider struct { | ||
| config *Config | ||
| client *internal.Client | ||
| } | ||
|
|
||
| // NewDNSProvider returns a DNSProvider instance configured for beget.com. | ||
| // Credentials must be passed in the environment variables: | ||
| // BEGET_USERNAME and BEGET_PASSWORD. | ||
| func NewDNSProvider() (*DNSProvider, error) { | ||
| values, err := env.Get(EnvUsername, EnvPassword) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("beget: %w", err) | ||
| } | ||
|
|
||
| config := NewDefaultConfig() | ||
| config.Username = values[EnvUsername] | ||
| config.Password = values[EnvPassword] | ||
|
|
||
| return NewDNSProviderConfig(config) | ||
| } | ||
|
|
||
| // NewDNSProviderConfig return a DNSProvider instance configured for beget.com. | ||
| func NewDNSProviderConfig(config *Config) (*DNSProvider, error) { | ||
| if config == nil { | ||
| return nil, errors.New("beget: the configuration of the DNS provider is nil") | ||
| } | ||
|
|
||
| if config.Username == "" || config.Password == "" { | ||
| return nil, errors.New("beget: incomplete credentials, missing username and/or password") | ||
| } | ||
|
|
||
| client := internal.NewClient(config.Username, config.Password) | ||
|
|
||
| if config.HTTPClient != nil { | ||
| client.HTTPClient = config.HTTPClient | ||
| } | ||
|
|
||
| return &DNSProvider{config: config, client: client}, 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 | ||
| } | ||
|
|
||
| // 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("beget: could not find zone for domain %q: %w", domain, err) | ||
| } | ||
|
|
||
| subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: %w", err) | ||
| } | ||
|
|
||
| err = d.client.AddTXTRecord(context.Background(), dns01.UnFqdn(authZone), subDomain, info.Value) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: failed to create TXT records [domain: %s, sub domain: %s]: %w", | ||
| dns01.UnFqdn(authZone), subDomain, 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) | ||
|
|
||
| authZone, err := dns01.FindZoneByFqdn(info.EffectiveFQDN) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: could not find zone for domain %q: %w", domain, err) | ||
| } | ||
|
|
||
| subDomain, err := dns01.ExtractSubDomain(info.EffectiveFQDN, authZone) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: %w", err) | ||
| } | ||
|
|
||
| err = d.client.RemoveTxtRecord(context.Background(), dns01.UnFqdn(authZone), subDomain) | ||
| if err != nil { | ||
| return fmt.Errorf("beget: failed to remove TXT records [domain: %s, sub domain: %s]: %w", | ||
| dns01.UnFqdn(authZone), subDomain, err) | ||
| } | ||
|
|
||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.