traefik/vendor/github.com/xenolf/lego/providers/dns/gcloud/googlecloud.go

240 lines
6.6 KiB
Go
Raw Normal View History

2018-05-31 07:30:04 +00:00
// Package gcloud implements a DNS provider for solving the DNS-01
2017-02-07 21:33:23 +00:00
// challenge using Google Cloud DNS.
2018-05-31 07:30:04 +00:00
package gcloud
2017-02-07 21:33:23 +00:00
import (
2018-05-31 07:30:04 +00:00
"encoding/json"
2018-09-17 13:16:03 +00:00
"errors"
2017-02-07 21:33:23 +00:00
"fmt"
2017-10-31 09:42:03 +00:00
"io/ioutil"
2018-09-17 13:16:03 +00:00
"net/http"
2017-02-07 21:33:23 +00:00
"os"
"time"
2018-05-31 07:30:04 +00:00
"github.com/xenolf/lego/acme"
2018-09-17 13:16:03 +00:00
"github.com/xenolf/lego/platform/config/env"
2017-02-07 21:33:23 +00:00
"golang.org/x/net/context"
"golang.org/x/oauth2/google"
"google.golang.org/api/dns/v1"
)
2018-09-17 13:16:03 +00:00
// Config is used to configure the creation of the DNSProvider
type Config struct {
Project 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("GCE_TTL", 120),
PropagationTimeout: env.GetOrDefaultSecond("GCE_PROPAGATION_TIMEOUT", 180*time.Second),
PollingInterval: env.GetOrDefaultSecond("GCE_POLLING_INTERVAL", 5*time.Second),
}
}
2017-02-07 21:33:23 +00:00
// DNSProvider is an implementation of the DNSProvider interface.
type DNSProvider struct {
2018-09-17 13:16:03 +00:00
config *Config
client *dns.Service
2017-02-07 21:33:23 +00:00
}
2018-09-17 13:16:03 +00:00
// NewDNSProvider returns a DNSProvider instance configured for Google Cloud DNS.
// Project name must be passed in the environment variable: GCE_PROJECT.
// A Service Account file can be passed in the environment variable: GCE_SERVICE_ACCOUNT_FILE
2017-02-07 21:33:23 +00:00
func NewDNSProvider() (*DNSProvider, error) {
2017-10-31 09:42:03 +00:00
if saFile, ok := os.LookupEnv("GCE_SERVICE_ACCOUNT_FILE"); ok {
2018-05-31 07:30:04 +00:00
return NewDNSProviderServiceAccount(saFile)
2017-10-31 09:42:03 +00:00
}
2018-07-03 10:44:04 +00:00
2018-05-31 07:30:04 +00:00
project := os.Getenv("GCE_PROJECT")
2017-02-07 21:33:23 +00:00
return NewDNSProviderCredentials(project)
}
2018-09-17 13:16:03 +00:00
// NewDNSProviderCredentials uses the supplied credentials
// to return a DNSProvider instance configured for Google Cloud DNS.
2017-02-07 21:33:23 +00:00
func NewDNSProviderCredentials(project string) (*DNSProvider, error) {
if project == "" {
2018-09-17 13:16:03 +00:00
return nil, fmt.Errorf("googlecloud: project name missing")
2017-02-07 21:33:23 +00:00
}
client, err := google.DefaultClient(context.Background(), dns.NdevClouddnsReadwriteScope)
if err != nil {
2018-09-17 13:16:03 +00:00
return nil, fmt.Errorf("googlecloud: unable to get Google Cloud client: %v", err)
2017-02-07 21:33:23 +00:00
}
2018-09-17 13:16:03 +00:00
config := NewDefaultConfig()
config.Project = project
config.HTTPClient = client
return NewDNSProviderConfig(config)
2017-02-07 21:33:23 +00:00
}
2018-09-17 13:16:03 +00:00
// NewDNSProviderServiceAccount uses the supplied service account JSON file
// to return a DNSProvider instance configured for Google Cloud DNS.
2018-05-31 07:30:04 +00:00
func NewDNSProviderServiceAccount(saFile string) (*DNSProvider, error) {
2017-10-31 09:42:03 +00:00
if saFile == "" {
2018-09-17 13:16:03 +00:00
return nil, fmt.Errorf("googlecloud: Service Account file missing")
2017-10-31 09:42:03 +00:00
}
dat, err := ioutil.ReadFile(saFile)
if err != nil {
2018-09-17 13:16:03 +00:00
return nil, fmt.Errorf("googlecloud: unable to read Service Account file: %v", err)
2017-10-31 09:42:03 +00:00
}
2018-05-31 07:30:04 +00:00
// read project id from service account file
var datJSON struct {
ProjectID string `json:"project_id"`
}
err = json.Unmarshal(dat, &datJSON)
if err != nil || datJSON.ProjectID == "" {
2018-09-17 13:16:03 +00:00
return nil, fmt.Errorf("googlecloud: project ID not found in Google Cloud Service Account file")
2018-05-31 07:30:04 +00:00
}
project := datJSON.ProjectID
2017-10-31 09:42:03 +00:00
conf, err := google.JWTConfigFromJSON(dat, dns.NdevClouddnsReadwriteScope)
if err != nil {
2018-09-17 13:16:03 +00:00
return nil, fmt.Errorf("googlecloud: unable to acquire config: %v", err)
2017-10-31 09:42:03 +00:00
}
2018-05-31 07:30:04 +00:00
client := conf.Client(context.Background())
2017-10-31 09:42:03 +00:00
2018-09-17 13:16:03 +00:00
config := NewDefaultConfig()
config.Project = project
config.HTTPClient = client
return NewDNSProviderConfig(config)
}
// NewDNSProviderConfig return a DNSProvider instance configured for Google Cloud DNS.
func NewDNSProviderConfig(config *Config) (*DNSProvider, error) {
if config == nil {
return nil, errors.New("googlecloud: the configuration of the DNS provider is nil")
}
svc, err := dns.New(config.HTTPClient)
2017-10-31 09:42:03 +00:00
if err != nil {
2018-09-17 13:16:03 +00:00
return nil, fmt.Errorf("googlecloud: unable to create Google Cloud DNS service: %v", err)
2017-10-31 09:42:03 +00:00
}
2018-09-17 13:16:03 +00:00
return &DNSProvider{config: config, client: svc}, nil
2017-10-31 09:42:03 +00:00
}
2017-02-07 21:33:23 +00:00
// Present creates a TXT record to fulfil the dns-01 challenge.
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) Present(domain, token, keyAuth string) error {
2018-09-17 13:16:03 +00:00
fqdn, value, _ := acme.DNS01Record(domain, keyAuth)
2017-02-07 21:33:23 +00:00
2018-07-03 10:44:04 +00:00
zone, err := d.getHostedZone(domain)
2017-02-07 21:33:23 +00:00
if err != nil {
2018-09-17 13:16:03 +00:00
return fmt.Errorf("googlecloud: %v", err)
2017-02-07 21:33:23 +00:00
}
2018-09-21 16:38:02 +00:00
// Look for existing records.
existing, err := d.findTxtRecords(zone, fqdn)
if err != nil {
return fmt.Errorf("googlecloud: %v", err)
}
2017-02-07 21:33:23 +00:00
rec := &dns.ResourceRecordSet{
Name: fqdn,
Rrdatas: []string{value},
2018-09-17 13:16:03 +00:00
Ttl: int64(d.config.TTL),
2017-02-07 21:33:23 +00:00
Type: "TXT",
}
2018-09-21 16:38:02 +00:00
change := &dns.Change{}
2018-07-23 15:30:03 +00:00
if len(existing) > 0 {
2017-02-07 21:33:23 +00:00
// Attempt to delete the existing records when adding our new one.
2018-07-23 15:30:03 +00:00
change.Deletions = existing
2018-09-21 16:38:02 +00:00
// Append existing TXT record data to the new TXT record data
for _, value := range existing {
rec.Rrdatas = append(rec.Rrdatas, value.Rrdatas...)
}
2017-02-07 21:33:23 +00:00
}
2018-09-21 16:38:02 +00:00
change.Additions = []*dns.ResourceRecordSet{rec}
2018-09-17 13:16:03 +00:00
chg, err := d.client.Changes.Create(d.config.Project, zone, change).Do()
2017-02-07 21:33:23 +00:00
if err != nil {
2018-09-17 13:16:03 +00:00
return fmt.Errorf("googlecloud: %v", err)
2017-02-07 21:33:23 +00:00
}
// wait for change to be acknowledged
for chg.Status == "pending" {
time.Sleep(time.Second)
2018-09-17 13:16:03 +00:00
chg, err = d.client.Changes.Get(d.config.Project, zone, chg.Id).Do()
2017-02-07 21:33:23 +00:00
if err != nil {
2018-09-17 13:16:03 +00:00
return fmt.Errorf("googlecloud: %v", err)
2017-02-07 21:33:23 +00:00
}
}
return nil
}
// CleanUp removes the TXT record matching the specified parameters.
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
2018-05-31 07:30:04 +00:00
fqdn, _, _ := acme.DNS01Record(domain, keyAuth)
2017-02-07 21:33:23 +00:00
2018-07-03 10:44:04 +00:00
zone, err := d.getHostedZone(domain)
2017-02-07 21:33:23 +00:00
if err != nil {
2018-09-17 13:16:03 +00:00
return fmt.Errorf("googlecloud: %v", err)
2017-02-07 21:33:23 +00:00
}
2018-07-03 10:44:04 +00:00
records, err := d.findTxtRecords(zone, fqdn)
2017-02-07 21:33:23 +00:00
if err != nil {
2018-09-17 13:16:03 +00:00
return fmt.Errorf("googlecloud: %v", err)
2017-02-07 21:33:23 +00:00
}
2018-07-23 15:30:03 +00:00
if len(records) == 0 {
return nil
2017-02-07 21:33:23 +00:00
}
2018-07-23 15:30:03 +00:00
2018-09-17 13:16:03 +00:00
_, err = d.client.Changes.Create(d.config.Project, zone, &dns.Change{Deletions: records}).Do()
2018-09-21 16:38:02 +00:00
if err != nil {
return fmt.Errorf("googlecloud: %v", err)
}
return nil
2017-02-07 21:33:23 +00:00
}
// Timeout customizes the timeout values used by the ACME package for checking
// DNS record validity.
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
2018-09-17 13:16:03 +00:00
return d.config.PropagationTimeout, d.config.PollingInterval
2017-02-07 21:33:23 +00:00
}
// getHostedZone returns the managed-zone
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) getHostedZone(domain string) (string, error) {
2018-05-31 07:30:04 +00:00
authZone, err := acme.FindZoneByFqdn(acme.ToFqdn(domain), acme.RecursiveNameservers)
2017-02-07 21:33:23 +00:00
if err != nil {
return "", err
}
2018-07-03 10:44:04 +00:00
zones, err := d.client.ManagedZones.
2018-09-17 13:16:03 +00:00
List(d.config.Project).
2017-02-07 21:33:23 +00:00
DnsName(authZone).
Do()
if err != nil {
2018-09-17 13:16:03 +00:00
return "", fmt.Errorf("API call failed: %v", err)
2017-02-07 21:33:23 +00:00
}
if len(zones.ManagedZones) == 0 {
2018-09-17 13:16:03 +00:00
return "", fmt.Errorf("no matching domain found for domain %s", authZone)
2017-02-07 21:33:23 +00:00
}
return zones.ManagedZones[0].Name, nil
}
2018-07-03 10:44:04 +00:00
func (d *DNSProvider) findTxtRecords(zone, fqdn string) ([]*dns.ResourceRecordSet, error) {
2018-09-17 13:16:03 +00:00
recs, err := d.client.ResourceRecordSets.List(d.config.Project, zone).Name(fqdn).Type("TXT").Do()
2017-02-07 21:33:23 +00:00
if err != nil {
return nil, err
}
2018-07-23 15:30:03 +00:00
return recs.Rrsets, nil
2017-02-07 21:33:23 +00:00
}