-
-
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.
Add DNS provider for Regfish (#2320)
- Loading branch information
Showing
10 changed files
with
390 additions
and
9 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| --- | ||
| title: "Regfish" | ||
| date: 2019-03-03T16:39:46+01:00 | ||
| draft: false | ||
| slug: regfish | ||
| dnsprovider: | ||
| since: "v4.20.0" | ||
| code: "regfish" | ||
| url: "https://regfish.de/" | ||
| --- | ||
|
|
||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
| <!-- providers/dns/regfish/regfish.toml --> | ||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
|
|
||
|
|
||
| Configuration for [Regfish](https://regfish.de/). | ||
|
|
||
|
|
||
| <!--more--> | ||
|
|
||
| - Code: `regfish` | ||
| - Since: v4.20.0 | ||
|
|
||
|
|
||
| Here is an example bash command using the Regfish provider: | ||
|
|
||
| ```bash | ||
| REGFISH_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \ | ||
| lego --email [email protected] --dns regfish --domains my.example.org run | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Credentials | ||
|
|
||
| | Environment Variable Name | Description | | ||
| |-----------------------|-------------| | ||
| | `REGFISH_API_KEY` | API key | | ||
|
|
||
| The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. | ||
| More information [here]({{% ref "dns#configuration-and-credentials" %}}). | ||
|
|
||
|
|
||
| ## Additional Configuration | ||
|
|
||
| | Environment Variable Name | Description | | ||
| |--------------------------------|-------------| | ||
| | `REGFISH_HTTP_TIMEOUT` | API request timeout | | ||
| | `REGFISH_POLLING_INTERVAL` | Time between DNS propagation check | | ||
| | `REGFISH_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | | ||
| | `REGFISH_TTL` | The TTL of the TXT record used for the DNS challenge | | ||
|
|
||
| The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. | ||
| More information [here]({{% ref "dns#configuration-and-credentials" %}}). | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## More information | ||
|
|
||
| - [API documentation](https://regfish.readme.io/) | ||
| - [Go client](https://github.com/regfish/regfish-dnsapi-go) | ||
|
|
||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
| <!-- providers/dns/regfish/regfish.toml --> | ||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> |
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
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 |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| // Package regfish implements a DNS provider for solving the DNS-01 challenge using Regfish. | ||
| package regfish | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/go-acme/lego/v4/challenge/dns01" | ||
| "github.com/go-acme/lego/v4/platform/config/env" | ||
| regfishapi "github.com/regfish/regfish-dnsapi-go" | ||
| ) | ||
|
|
||
| // Environment variables names. | ||
| const ( | ||
| envNamespace = "REGFISH_" | ||
|
|
||
| EnvAPIKey = envNamespace + "API_KEY" | ||
|
|
||
| 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 { | ||
| APIKey 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, dns01.DefaultTTL), | ||
| PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, dns01.DefaultPropagationTimeout), | ||
| 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 *regfishapi.Client | ||
|
|
||
| recordIDs map[string]int | ||
| recordIDsMu sync.Mutex | ||
| } | ||
|
|
||
| // NewDNSProvider returns a DNSProvider instance configured for Regfish. | ||
| func NewDNSProvider() (*DNSProvider, error) { | ||
| values, err := env.Get(EnvAPIKey) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("regfish: %w", err) | ||
| } | ||
|
|
||
| config := NewDefaultConfig() | ||
| config.APIKey = values[EnvAPIKey] | ||
|
|
||
| return NewDNSProviderConfig(config) | ||
| } | ||
|
|
||
| // NewDNSProviderConfig return a DNSProvider instance configured for Regfish. | ||
| func NewDNSProviderConfig(config *Config) (*DNSProvider, error) { | ||
| if config == nil { | ||
| return nil, errors.New("regfish: the configuration of the DNS provider is nil") | ||
| } | ||
|
|
||
| if config.APIKey == "" { | ||
| return nil, errors.New("regfish: credentials missing") | ||
| } | ||
|
|
||
| client := regfishapi.NewClient(config.APIKey) | ||
|
|
||
| return &DNSProvider{ | ||
| config: config, | ||
| client: client, | ||
| recordIDs: make(map[string]int), | ||
| }, nil | ||
| } | ||
|
|
||
| // Present creates a TXT record using the specified parameters. | ||
| func (d *DNSProvider) Present(domain, token, keyAuth string) error { | ||
| info := dns01.GetChallengeInfo(domain, keyAuth) | ||
|
|
||
| record := regfishapi.Record{ | ||
| Name: info.EffectiveFQDN, | ||
| Type: "TXT", | ||
| Data: info.Value, | ||
| TTL: d.config.TTL, | ||
| } | ||
|
|
||
| newRecord, err := d.client.CreateRecord(record) | ||
| if err != nil { | ||
| return fmt.Errorf("regfish: create record: %w", err) | ||
| } | ||
|
|
||
| d.recordIDsMu.Lock() | ||
| d.recordIDs[token] = newRecord.ID | ||
| d.recordIDsMu.Unlock() | ||
|
|
||
| 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) | ||
|
|
||
| // get 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("regfish: unknown record ID for '%s'", info.EffectiveFQDN) | ||
| } | ||
|
|
||
| err := d.client.DeleteRecord(recordID) | ||
| if err != nil { | ||
| return fmt.Errorf("regfish: delete record: %w", err) | ||
| } | ||
|
|
||
| // Delete record ID from map | ||
| 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 | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| Name = "Regfish" | ||
| Description = '''''' | ||
| URL = "https://regfish.de/" | ||
| Code = "regfish" | ||
| Since = "v4.20.0" | ||
|
|
||
| Example = ''' | ||
| REGFISH_API_KEY="xxxxxxxxxxxxxxxxxxxxx" \ | ||
| lego --email [email protected] --dns regfish --domains my.example.org run | ||
| ''' | ||
|
|
||
| [Configuration] | ||
| [Configuration.Credentials] | ||
| REGFISH_API_KEY = "API key" | ||
| [Configuration.Additional] | ||
| REGFISH_POLLING_INTERVAL = "Time between DNS propagation check" | ||
| REGFISH_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" | ||
| REGFISH_TTL = "The TTL of the TXT record used for the DNS challenge" | ||
| REGFISH_HTTP_TIMEOUT = "API request timeout" | ||
|
|
||
| [Links] | ||
| API = "https://regfish.readme.io/" | ||
| GoClient = "https://github.com/regfish/regfish-dnsapi-go" |
Oops, something went wrong.