-
-
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
9 changed files
with
443 additions
and
25 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| --- | ||
| title: "Civo" | ||
| date: 2019-03-03T16:39:46+01:00 | ||
| draft: false | ||
| slug: civo | ||
| dnsprovider: | ||
| since: "v4.9.0" | ||
| code: "civo" | ||
| url: "https://civo.com" | ||
| --- | ||
|
|
||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
| <!-- providers/dns/civo/civo.toml --> | ||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
|
|
||
|
|
||
| Configuration for [Civo](https://civo.com). | ||
|
|
||
|
|
||
| <!--more--> | ||
|
|
||
| - Code: `civo` | ||
| - Since: v4.9.0 | ||
|
|
||
|
|
||
| Here is an example bash command using the Civo provider: | ||
|
|
||
| ```bash | ||
| CIVO_TOKEN=xxxxxx \ | ||
| lego --email you@example.com --dns civo --domains my.example.org run | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Credentials | ||
|
|
||
| | Environment Variable Name | Description | | ||
| |-----------------------|-------------| | ||
| | `CIVO_TOKEN` | Authentication token | | ||
|
|
||
| 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 | | ||
| |--------------------------------|-------------| | ||
| | `CIVO_POLLING_INTERVAL` | Time between DNS propagation check | | ||
| | `CIVO_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation | | ||
| | `CIVO_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://www.civo.com/api/dns) | ||
|
|
||
| <!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. --> | ||
| <!-- providers/dns/civo/civo.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,176 @@ | ||
| // Package civo implements a DNS provider for solving the DNS-01 challenge using CIVO. | ||
| package civo | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/civo/civogo" | ||
| "github.com/go-acme/lego/v4/challenge/dns01" | ||
| "github.com/go-acme/lego/v4/platform/config/env" | ||
| ) | ||
|
|
||
| const ( | ||
| minTTL = 600 | ||
| defaultPollingInterval = 30 * time.Second | ||
| defaultPropagationTimeout = 300 * time.Second | ||
| ) | ||
|
|
||
| // Environment variables names. | ||
| const ( | ||
| envNamespace = "CIVO_" | ||
|
|
||
| EnvAPIToken = envNamespace + "TOKEN" | ||
|
|
||
| EnvTTL = envNamespace + "TTL" | ||
| EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT" | ||
| EnvPollingInterval = envNamespace + "POLLING_INTERVAL" | ||
| ) | ||
|
|
||
| // Config is used to configure the creation of the DNSProvider. | ||
| type Config struct { | ||
| ProjectID string | ||
| Token string | ||
| PropagationTimeout time.Duration | ||
| PollingInterval time.Duration | ||
| TTL int | ||
| } | ||
|
|
||
| // NewDefaultConfig returns a default configuration for the DNSProvider. | ||
| func NewDefaultConfig() *Config { | ||
| return &Config{ | ||
| TTL: env.GetOrDefaultInt(EnvTTL, minTTL), | ||
| PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, defaultPropagationTimeout), | ||
| PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, defaultPollingInterval), | ||
| } | ||
| } | ||
|
|
||
| // DNSProvider implements the challenge.Provider interface. | ||
| type DNSProvider struct { | ||
| config *Config | ||
| client *civogo.Client | ||
| } | ||
|
|
||
| // NewDNSProvider returns a DNSProvider instance configured for CIVO. | ||
| // Credentials must be passed in the environment variables: API_TOKEN. | ||
| func NewDNSProvider() (*DNSProvider, error) { | ||
| values, err := env.Get(EnvAPIToken) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("civo: %w", err) | ||
| } | ||
|
|
||
| config := NewDefaultConfig() | ||
| config.Token = values[EnvAPIToken] | ||
|
|
||
| return NewDNSProviderConfig(config) | ||
| } | ||
|
|
||
| // NewDNSProviderConfig return a DNSProvider instance configured for CIVO. | ||
| func NewDNSProviderConfig(config *Config) (*DNSProvider, error) { | ||
| if config == nil { | ||
| return nil, errors.New("civo: the configuration of the DNS provider is nil") | ||
| } | ||
|
|
||
| if config.Token == "" { | ||
| return nil, errors.New("civo: credentials missing") | ||
| } | ||
|
|
||
| if config.TTL < minTTL { | ||
| config.TTL = minTTL | ||
| } | ||
|
|
||
| // Create a Civo client - DNS is region independent, we can use any region | ||
| client, err := civogo.NewClient(config.Token, "LON1") | ||
| if err != nil { | ||
| return nil, fmt.Errorf("civo: %w", err) | ||
| } | ||
|
|
||
| return &DNSProvider{config: config, client: client}, nil | ||
| } | ||
|
|
||
| // Present creates a TXT record to fulfill the dns-01 challenge. | ||
| func (d *DNSProvider) Present(domain, token, keyAuth string) error { | ||
| fqdn, value := dns01.GetRecord(domain, keyAuth) | ||
|
|
||
| zone, err := getZone(fqdn) | ||
| if err != nil { | ||
| return fmt.Errorf("civo: failed to find zone: fqdn=%s: %w", fqdn, err) | ||
| } | ||
|
|
||
| dnsDomain, err := d.client.GetDNSDomain(zone) | ||
| if err != nil { | ||
| return fmt.Errorf("civo: %w", err) | ||
| } | ||
|
|
||
| _, err = d.client.CreateDNSRecord(dnsDomain.ID, &civogo.DNSRecordConfig{ | ||
| Name: extractRecordName(fqdn, zone), | ||
| Value: value, | ||
| Type: civogo.DNSRecordTypeTXT, | ||
| TTL: d.config.TTL, | ||
| }) | ||
| if err != nil { | ||
| return fmt.Errorf("civo: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // CleanUp removes the TXT record matching the specified parameters. | ||
| func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error { | ||
| fqdn, value := dns01.GetRecord(domain, keyAuth) | ||
|
|
||
| zone, err := getZone(fqdn) | ||
| if err != nil { | ||
| return fmt.Errorf("civo: failed to find zone: fqdn=%s: %w", fqdn, err) | ||
| } | ||
|
|
||
| dnsDomain, err := d.client.GetDNSDomain(zone) | ||
| if err != nil { | ||
| return fmt.Errorf("civo: %w", err) | ||
| } | ||
|
|
||
| dnsRecords, err := d.client.ListDNSRecords(dnsDomain.ID) | ||
| if err != nil { | ||
| return fmt.Errorf("civo: %w", err) | ||
| } | ||
|
|
||
| var dnsRecord civogo.DNSRecord | ||
| for _, entry := range dnsRecords { | ||
| if entry.Name == extractRecordName(fqdn, zone) && entry.Value == value { | ||
| dnsRecord = entry | ||
| break | ||
| } | ||
| } | ||
|
|
||
| _, err = d.client.DeleteDNSRecord(&dnsRecord) | ||
| if err != nil { | ||
| return fmt.Errorf("civo: %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 getZone(fqdn string) (string, error) { | ||
| authZone, err := dns01.FindZoneByFqdn(fqdn) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
|
|
||
| return dns01.UnFqdn(authZone), nil | ||
| } | ||
|
|
||
| func extractRecordName(fqdn, zone string) string { | ||
| name := dns01.UnFqdn(fqdn) | ||
| if idx := strings.Index(name, "."+zone); idx != -1 { | ||
| return name[:idx] | ||
| } | ||
| return name | ||
| } |
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,21 @@ | ||
| Name = "Civo" | ||
| Description = '''''' | ||
| URL = "https://civo.com" | ||
| Code = "civo" | ||
| Since = "v4.9.0" | ||
|
|
||
| Example = ''' | ||
| CIVO_TOKEN=xxxxxx \ | ||
| lego --email you@example.com --dns civo --domains my.example.org run | ||
| ''' | ||
|
|
||
| [Configuration] | ||
| [Configuration.Credentials] | ||
| CIVO_TOKEN = "Authentication token" | ||
| [Configuration.Additional] | ||
| CIVO_POLLING_INTERVAL = "Time between DNS propagation check" | ||
| CIVO_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation" | ||
| CIVO_TTL = "The TTL of the TXT record used for the DNS challenge" | ||
|
|
||
| [Links] | ||
| API = "https://www.civo.com/api/dns" |
Oops, something went wrong.