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 g-core labs (#1456)
Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>
- Loading branch information
Showing
10 changed files
with
879 additions
and
18 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 |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| title: "G-Core Labs" | ||
| date: 2019-03-03T16:39:46+01:00 | ||
| draft: false | ||
| slug: gcore | ||
| --- | ||
|
|
||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
| <!-- providers/dns/gcore/gcore.toml --> | ||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
|
|
||
| Since: v4.5.0 | ||
|
|
||
| Configuration for [G-Core Labs](https://gcorelabs.com/dns/). | ||
|
|
||
|
|
||
| <!--more--> | ||
|
|
||
| - Code: `gcore` | ||
|
|
||
| Here is an example bash command using the G-Core Labs provider: | ||
|
|
||
| ```bash | ||
| GCORE_PERMANENT_API_TOKEN=xxxxx \ | ||
| lego --email myemail@example.com --dns gcore --domains my.example.org run | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Credentials | ||
|
|
||
| | Environment Variable Name | Description | | ||
| |-----------------------|-------------| | ||
| | `GCORE_PERMANENT_API_TOKEN` | Permanent API tokene (https://gcorelabs.com/blog/permanent-api-token-explained/) | | ||
|
|
||
| The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. | ||
| More information [here](/lego/dns/#configuration-and-credentials). | ||
|
|
||
|
|
||
| ## Additional Configuration | ||
|
|
||
| | Environment Variable Name | Description | | ||
| |--------------------------------|-------------| | ||
| | `GCORE_HTTP_TIMEOUT` | API request timeout | | ||
| | `GCORE_POLLING_INTERVAL` | Time between DNS propagation check | | ||
| | `GCORE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | | ||
| | `GCORE_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](/lego/dns/#configuration-and-credentials). | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## More information | ||
|
|
||
| - [API documentation](https://dnsapi.gcorelabs.com/docs#tag/zonesV2) | ||
|
|
||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
| <!-- providers/dns/gcore/gcore.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| package gcore | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "strings" | ||
| "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/gcore/internal" | ||
| ) | ||
|
|
||
| const ( | ||
| defaultPropagationTimeout = 360 * time.Second | ||
| defaultPollingInterval = 20 * time.Second | ||
| ) | ||
|
|
||
| // Environment variables names. | ||
| const ( | ||
| envNamespace = "GCORE_" | ||
|
|
||
| EnvPermanentAPIToken = envNamespace + "PERMANENT_API_TOKEN" | ||
|
|
||
| EnvTTL = envNamespace + "TTL" | ||
| EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT" | ||
| EnvPollingInterval = envNamespace + "POLLING_INTERVAL" | ||
| EnvHTTPTimeout = envNamespace + "HTTP_TIMEOUT" | ||
| ) | ||
|
|
||
| // Config for DNSProvider. | ||
| type Config struct { | ||
| APIToken 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, defaultPropagationTimeout), | ||
| PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, defaultPollingInterval), | ||
| HTTPClient: &http.Client{ | ||
| Timeout: env.GetOrDefaultSecond(EnvHTTPTimeout, 10*time.Second), | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // DNSProvider an implementation of challenge.Provider contract. | ||
| type DNSProvider struct { | ||
| config *Config | ||
| client *internal.Client | ||
| } | ||
|
|
||
| // NewDNSProvider returns an instance of DNSProvider configured for G-Core Labs DNS API. | ||
| func NewDNSProvider() (*DNSProvider, error) { | ||
| values, err := env.Get(EnvPermanentAPIToken) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("gcore: %w", err) | ||
| } | ||
|
|
||
| config := NewDefaultConfig() | ||
| config.APIToken = values[EnvPermanentAPIToken] | ||
|
|
||
| return NewDNSProviderConfig(config) | ||
| } | ||
|
|
||
| // NewDNSProviderConfig return a DNSProvider instance configured for G-Core Labs DNS API. | ||
| func NewDNSProviderConfig(config *Config) (*DNSProvider, error) { | ||
| if config == nil { | ||
| return nil, errors.New("gcore: the configuration of the DNS provider is nil") | ||
| } | ||
|
|
||
| if config.APIToken == "" { | ||
| return nil, errors.New("gcore: incomplete credentials provided") | ||
| } | ||
|
|
||
| client := internal.NewClient(config.APIToken) | ||
|
|
||
| if config.HTTPClient != nil { | ||
| client.HTTPClient = config.HTTPClient | ||
| } | ||
|
|
||
| return &DNSProvider{ | ||
| config: config, | ||
| client: client, | ||
| }, nil | ||
| } | ||
|
|
||
| // Present creates a TXT record to fulfill the dns-01 challenge. | ||
| func (d *DNSProvider) Present(domain, _, keyAuth string) error { | ||
| fqdn, value := dns01.GetRecord(domain, keyAuth) | ||
|
|
||
| ctx := context.Background() | ||
|
|
||
| zone, err := d.guessZone(ctx, fqdn) | ||
| if err != nil { | ||
| return fmt.Errorf("gcore: %w", err) | ||
| } | ||
|
|
||
| err = d.client.AddRRSet(ctx, zone, dns01.UnFqdn(fqdn), value, d.config.TTL) | ||
| if err != nil { | ||
| return fmt.Errorf("gcore: add txt record: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // CleanUp removes the record matching the specified parameters. | ||
| func (d *DNSProvider) CleanUp(domain, _, keyAuth string) error { | ||
| fqdn, _ := dns01.GetRecord(domain, keyAuth) | ||
|
|
||
| ctx := context.Background() | ||
|
|
||
| zone, err := d.guessZone(ctx, fqdn) | ||
| if err != nil { | ||
| return fmt.Errorf("gcore: %w", err) | ||
| } | ||
|
|
||
| err = d.client.DeleteRRSet(ctx, zone, dns01.UnFqdn(fqdn)) | ||
| if err != nil { | ||
| return fmt.Errorf("gcore: remove txt record: %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 (d *DNSProvider) Timeout() (timeout, interval time.Duration) { | ||
| return d.config.PropagationTimeout, d.config.PollingInterval | ||
| } | ||
|
|
||
| func (d *DNSProvider) guessZone(ctx context.Context, fqdn string) (string, error) { | ||
| var lastErr error | ||
|
|
||
| for _, zone := range extractAllZones(fqdn) { | ||
| dnsZone, err := d.client.GetZone(ctx, zone) | ||
| if err == nil { | ||
| return dnsZone.Name, nil | ||
| } | ||
|
|
||
| lastErr = err | ||
| } | ||
|
|
||
| return "", fmt.Errorf("zone %q not found: %w", fqdn, lastErr) | ||
| } | ||
|
|
||
| func extractAllZones(fqdn string) []string { | ||
| parts := strings.Split(dns01.UnFqdn(fqdn), ".") | ||
| if len(parts) < 3 { | ||
| return nil | ||
| } | ||
|
|
||
| var zones []string | ||
| for i := 1; i < len(parts)-1; i++ { | ||
| zones = append(zones, strings.Join(parts[i:], ".")) | ||
| } | ||
|
|
||
| return zones | ||
| } |
Oops, something went wrong.