2019-01-07 17:30:06 +00:00
|
|
|
// Package nifcloud implements a DNS provider for solving the DNS-01 challenge using NIFCLOUD DNS.
|
2018-07-03 10:44:04 +00:00
|
|
|
package nifcloud
|
|
|
|
|
|
|
|
import (
|
2018-09-17 13:16:03 +00:00
|
|
|
"errors"
|
2018-07-03 10:44:04 +00:00
|
|
|
"fmt"
|
|
|
|
"net/http"
|
|
|
|
"time"
|
|
|
|
|
2019-01-07 17:30:06 +00:00
|
|
|
"github.com/xenolf/lego/providers/dns/nifcloud/internal"
|
|
|
|
|
|
|
|
"github.com/xenolf/lego/challenge/dns01"
|
2018-07-03 10:44:04 +00:00
|
|
|
"github.com/xenolf/lego/platform/config/env"
|
2019-01-07 17:30:06 +00:00
|
|
|
"github.com/xenolf/lego/platform/wait"
|
2018-07-03 10:44:04 +00:00
|
|
|
)
|
|
|
|
|
2018-09-17 13:16:03 +00:00
|
|
|
// Config is used to configure the creation of the DNSProvider
|
|
|
|
type Config struct {
|
|
|
|
BaseURL string
|
|
|
|
AccessKey string
|
|
|
|
SecretKey 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{
|
2019-01-07 17:30:06 +00:00
|
|
|
TTL: env.GetOrDefaultInt("NIFCLOUD_TTL", dns01.DefaultTTL),
|
|
|
|
PropagationTimeout: env.GetOrDefaultSecond("NIFCLOUD_PROPAGATION_TIMEOUT", dns01.DefaultPropagationTimeout),
|
|
|
|
PollingInterval: env.GetOrDefaultSecond("NIFCLOUD_POLLING_INTERVAL", dns01.DefaultPollingInterval),
|
2018-09-17 13:16:03 +00:00
|
|
|
HTTPClient: &http.Client{
|
|
|
|
Timeout: env.GetOrDefaultSecond("NIFCLOUD_HTTP_TIMEOUT", 30*time.Second),
|
|
|
|
},
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2018-07-03 10:44:04 +00:00
|
|
|
// DNSProvider implements the acme.ChallengeProvider interface
|
|
|
|
type DNSProvider struct {
|
2019-01-07 17:30:06 +00:00
|
|
|
client *internal.Client
|
2018-09-17 13:16:03 +00:00
|
|
|
config *Config
|
2018-07-03 10:44:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewDNSProvider returns a DNSProvider instance configured for the NIFCLOUD DNS service.
|
2018-09-17 13:16:03 +00:00
|
|
|
// Credentials must be passed in the environment variables:
|
|
|
|
// NIFCLOUD_ACCESS_KEY_ID and NIFCLOUD_SECRET_ACCESS_KEY.
|
2018-07-03 10:44:04 +00:00
|
|
|
func NewDNSProvider() (*DNSProvider, error) {
|
|
|
|
values, err := env.Get("NIFCLOUD_ACCESS_KEY_ID", "NIFCLOUD_SECRET_ACCESS_KEY")
|
|
|
|
if err != nil {
|
2018-09-17 13:16:03 +00:00
|
|
|
return nil, fmt.Errorf("nifcloud: %v", err)
|
2018-07-03 10:44:04 +00:00
|
|
|
}
|
|
|
|
|
2018-09-17 13:16:03 +00:00
|
|
|
config := NewDefaultConfig()
|
2018-10-10 14:28:04 +00:00
|
|
|
config.BaseURL = env.GetOrFile("NIFCLOUD_DNS_ENDPOINT")
|
2018-09-17 13:16:03 +00:00
|
|
|
config.AccessKey = values["NIFCLOUD_ACCESS_KEY_ID"]
|
|
|
|
config.SecretKey = values["NIFCLOUD_SECRET_ACCESS_KEY"]
|
2018-07-03 10:44:04 +00:00
|
|
|
|
2018-09-17 13:16:03 +00:00
|
|
|
return NewDNSProviderConfig(config)
|
2018-07-03 10:44:04 +00:00
|
|
|
}
|
|
|
|
|
2018-09-17 13:16:03 +00:00
|
|
|
// NewDNSProviderConfig return a DNSProvider instance configured for NIFCLOUD.
|
|
|
|
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
|
|
|
|
if config == nil {
|
|
|
|
return nil, errors.New("nifcloud: the configuration of the DNS provider is nil")
|
|
|
|
}
|
|
|
|
|
2019-01-07 17:30:06 +00:00
|
|
|
client, err := internal.NewClient(config.AccessKey, config.SecretKey)
|
2018-10-15 07:40:02 +00:00
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("nifcloud: %v", err)
|
|
|
|
}
|
2018-07-03 10:44:04 +00:00
|
|
|
|
2018-09-17 13:16:03 +00:00
|
|
|
if config.HTTPClient != nil {
|
|
|
|
client.HTTPClient = config.HTTPClient
|
|
|
|
}
|
|
|
|
|
|
|
|
if len(config.BaseURL) > 0 {
|
|
|
|
client.BaseURL = config.BaseURL
|
|
|
|
}
|
|
|
|
|
|
|
|
return &DNSProvider{client: client, config: config}, nil
|
2018-07-03 10:44:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Present creates a TXT record using the specified parameters
|
|
|
|
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
|
2019-01-07 17:30:06 +00:00
|
|
|
fqdn, value := dns01.GetRecord(domain, keyAuth)
|
2018-09-17 13:16:03 +00:00
|
|
|
|
|
|
|
err := d.changeRecord("CREATE", fqdn, value, domain, d.config.TTL)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("nifcloud: %v", err)
|
|
|
|
}
|
|
|
|
return err
|
2018-07-03 10:44:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// CleanUp removes the TXT record matching the specified parameters
|
|
|
|
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
|
2019-01-07 17:30:06 +00:00
|
|
|
fqdn, value := dns01.GetRecord(domain, keyAuth)
|
2018-09-17 13:16:03 +00:00
|
|
|
|
|
|
|
err := d.changeRecord("DELETE", fqdn, value, domain, d.config.TTL)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("nifcloud: %v", err)
|
|
|
|
}
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
|
|
|
// 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
|
2018-07-03 10:44:04 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func (d *DNSProvider) changeRecord(action, fqdn, value, domain string, ttl int) error {
|
2019-01-07 17:30:06 +00:00
|
|
|
name := dns01.UnFqdn(fqdn)
|
2018-07-03 10:44:04 +00:00
|
|
|
|
2019-01-07 17:30:06 +00:00
|
|
|
reqParams := internal.ChangeResourceRecordSetsRequest{
|
|
|
|
XMLNs: internal.XMLNs,
|
|
|
|
ChangeBatch: internal.ChangeBatch{
|
2018-07-03 10:44:04 +00:00
|
|
|
Comment: "Managed by Lego",
|
2019-01-07 17:30:06 +00:00
|
|
|
Changes: internal.Changes{
|
|
|
|
Change: []internal.Change{
|
2018-07-03 10:44:04 +00:00
|
|
|
{
|
|
|
|
Action: action,
|
2019-01-07 17:30:06 +00:00
|
|
|
ResourceRecordSet: internal.ResourceRecordSet{
|
2018-07-03 10:44:04 +00:00
|
|
|
Name: name,
|
|
|
|
Type: "TXT",
|
|
|
|
TTL: ttl,
|
2019-01-07 17:30:06 +00:00
|
|
|
ResourceRecords: internal.ResourceRecords{
|
|
|
|
ResourceRecord: []internal.ResourceRecord{
|
2018-07-03 10:44:04 +00:00
|
|
|
{
|
|
|
|
Value: value,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
resp, err := d.client.ChangeResourceRecordSets(domain, reqParams)
|
|
|
|
if err != nil {
|
|
|
|
return fmt.Errorf("failed to change NIFCLOUD record set: %v", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
statusID := resp.ChangeInfo.ID
|
|
|
|
|
2019-01-07 17:30:06 +00:00
|
|
|
return wait.For("nifcloud", 120*time.Second, 4*time.Second, func() (bool, error) {
|
2018-07-03 10:44:04 +00:00
|
|
|
resp, err := d.client.GetChange(statusID)
|
|
|
|
if err != nil {
|
|
|
|
return false, fmt.Errorf("failed to query NIFCLOUD DNS change status: %v", err)
|
|
|
|
}
|
|
|
|
return resp.ChangeInfo.Status == "INSYNC", nil
|
|
|
|
})
|
|
|
|
}
|