lego/providers/dns/gcloud/googlecloud.go

368 lines
10 KiB
Go
Raw Normal View History

// Package gcloud implements a DNS provider for solving the DNS-01 challenge using Google Cloud DNS.
package gcloud
import (
"encoding/json"
"errors"
"fmt"
"io/ioutil"
"net/http"
2018-12-21 23:53:05 +00:00
"strconv"
"time"
"cloud.google.com/go/compute/metadata"
2020-09-02 01:20:01 +00:00
"github.com/go-acme/lego/v4/challenge/dns01"
"github.com/go-acme/lego/v4/log"
"github.com/go-acme/lego/v4/platform/config/env"
"github.com/go-acme/lego/v4/platform/wait"
"golang.org/x/net/context"
"golang.org/x/oauth2/google"
"google.golang.org/api/dns/v1"
2018-12-21 23:53:05 +00:00
"google.golang.org/api/googleapi"
2019-04-12 18:37:29 +00:00
"google.golang.org/api/option"
)
2019-01-02 19:45:17 +00:00
const (
changeStatusDone = "done"
)
// Environment variables names.
const (
envNamespace = "GCE_"
EnvServiceAccount = envNamespace + "SERVICE_ACCOUNT"
EnvProject = envNamespace + "PROJECT"
EnvAllowPrivateZone = envNamespace + "ALLOW_PRIVATE_ZONE"
EnvDebug = envNamespace + "DEBUG"
EnvTTL = envNamespace + "TTL"
EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
EnvPollingInterval = envNamespace + "POLLING_INTERVAL"
)
2020-05-08 17:35:25 +00:00
// Config is used to configure the creation of the DNSProvider.
type Config struct {
2018-12-21 23:53:05 +00:00
Debug bool
Project string
AllowPrivateZone bool
PropagationTimeout time.Duration
PollingInterval time.Duration
TTL int
HTTPClient *http.Client
}
2020-05-08 17:35:25 +00:00
// NewDefaultConfig returns a default configuration for the DNSProvider.
func NewDefaultConfig() *Config {
return &Config{
Debug: env.GetOrDefaultBool(EnvDebug, false),
AllowPrivateZone: env.GetOrDefaultBool(EnvAllowPrivateZone, false),
TTL: env.GetOrDefaultInt(EnvTTL, dns01.DefaultTTL),
PropagationTimeout: env.GetOrDefaultSecond(EnvPropagationTimeout, 180*time.Second),
PollingInterval: env.GetOrDefaultSecond(EnvPollingInterval, 5*time.Second),
}
}
2020-05-08 17:35:25 +00:00
// DNSProvider implements the challenge.Provider interface.
type DNSProvider struct {
config *Config
client *dns.Service
}
// NewDNSProvider returns a DNSProvider instance configured for Google Cloud DNS.
// By default, the project name is auto-detected by using the metadata service,
// it can be overridden using the GCE_PROJECT environment variable.
// A Service Account can be passed in the environment variable: GCE_SERVICE_ACCOUNT
2020-05-08 17:35:25 +00:00
// or by specifying the keyfile location: GCE_SERVICE_ACCOUNT_FILE.
func NewDNSProvider() (*DNSProvider, error) {
// Use a service account file if specified via environment variable.
if saKey := env.GetOrFile(EnvServiceAccount); len(saKey) > 0 {
return NewDNSProviderServiceAccountKey([]byte(saKey))
}
// Use default credentials.
project := env.GetOrDefaultString(EnvProject, autodetectProjectID())
return NewDNSProviderCredentials(project)
}
// NewDNSProviderCredentials uses the supplied credentials
// to return a DNSProvider instance configured for Google Cloud DNS.
func NewDNSProviderCredentials(project string) (*DNSProvider, error) {
if project == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("googlecloud: project name missing")
}
client, err := google.DefaultClient(context.Background(), dns.NdevClouddnsReadwriteScope)
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("googlecloud: unable to get Google Cloud client: %w", err)
}
config := NewDefaultConfig()
config.Project = project
config.HTTPClient = client
return NewDNSProviderConfig(config)
}
// NewDNSProviderServiceAccountKey uses the supplied service account JSON
// to return a DNSProvider instance configured for Google Cloud DNS.
func NewDNSProviderServiceAccountKey(saKey []byte) (*DNSProvider, error) {
if len(saKey) == 0 {
2020-02-27 18:14:46 +00:00
return nil, errors.New("googlecloud: Service Account is missing")
}
// If GCE_PROJECT is non-empty it overrides the project in the service
// account file.
project := env.GetOrDefaultString(EnvProject, "")
if project == "" {
// read project id from service account file
var datJSON struct {
ProjectID string `json:"project_id"`
}
err := json.Unmarshal(saKey, &datJSON)
if err != nil || datJSON.ProjectID == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("googlecloud: project ID not found in Google Cloud Service Account file")
}
project = datJSON.ProjectID
}
conf, err := google.JWTConfigFromJSON(saKey, dns.NdevClouddnsReadwriteScope)
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("googlecloud: unable to acquire config: %w", err)
}
2018-05-30 17:53:04 +00:00
client := conf.Client(context.Background())
config := NewDefaultConfig()
config.Project = project
config.HTTPClient = client
return NewDNSProviderConfig(config)
}
// NewDNSProviderServiceAccount uses the supplied service account JSON file
// to return a DNSProvider instance configured for Google Cloud DNS.
func NewDNSProviderServiceAccount(saFile string) (*DNSProvider, error) {
if saFile == "" {
2020-02-27 18:14:46 +00:00
return nil, errors.New("googlecloud: Service Account file missing")
}
saKey, err := ioutil.ReadFile(saFile)
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("googlecloud: unable to read Service Account file: %w", err)
}
return NewDNSProviderServiceAccountKey(saKey)
}
// 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")
}
2019-04-12 18:37:29 +00:00
if config.HTTPClient == nil {
2020-02-27 18:14:46 +00:00
return nil, errors.New("googlecloud: unable to create Google Cloud DNS service: client is nil")
2019-04-12 18:37:29 +00:00
}
2019-04-12 18:37:29 +00:00
svc, err := dns.NewService(context.Background(), option.WithHTTPClient(config.HTTPClient))
if err != nil {
2020-02-27 18:14:46 +00:00
return nil, fmt.Errorf("googlecloud: unable to create Google Cloud DNS service: %w", err)
}
return &DNSProvider{config: config, client: svc}, 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 := d.getHostedZone(fqdn)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("googlecloud: %w", err)
}
// Look for existing records.
2018-12-21 23:53:05 +00:00
existingRrSet, err := d.findTxtRecords(zone, fqdn)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("googlecloud: %w", err)
}
2018-12-21 23:53:05 +00:00
for _, rrSet := range existingRrSet {
var rrd []string
for _, rr := range rrSet.Rrdatas {
data := mustUnquote(rr)
rrd = append(rrd, data)
if data == value {
log.Printf("skip: the record already exists: %s", value)
return nil
}
}
rrSet.Rrdatas = rrd
}
// Attempt to delete the existing records before adding the new one.
if len(existingRrSet) > 0 {
if err = d.applyChanges(zone, &dns.Change{Deletions: existingRrSet}); err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("googlecloud: %w", err)
2018-12-21 23:53:05 +00:00
}
}
rec := &dns.ResourceRecordSet{
Name: fqdn,
Rrdatas: []string{value},
Ttl: int64(d.config.TTL),
Type: "TXT",
}
2018-12-21 23:53:05 +00:00
// Append existing TXT record data to the new TXT record data
for _, rrSet := range existingRrSet {
for _, rr := range rrSet.Rrdatas {
if rr != value {
2019-01-02 19:45:17 +00:00
rec.Rrdatas = append(rec.Rrdatas, rr)
2018-12-21 23:53:05 +00:00
}
}
}
2018-12-21 23:53:05 +00:00
change := &dns.Change{
Additions: []*dns.ResourceRecordSet{rec},
}
2018-12-21 23:53:05 +00:00
if err = d.applyChanges(zone, change); err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("googlecloud: %w", err)
}
2018-12-21 23:53:05 +00:00
return nil
}
func (d *DNSProvider) applyChanges(zone string, change *dns.Change) error {
if d.config.Debug {
data, _ := json.Marshal(change)
log.Printf("change (Create): %s", string(data))
}
chg, err := d.client.Changes.Create(d.config.Project, zone, change).Do()
if err != nil {
2018-12-21 23:53:05 +00:00
if v, ok := err.(*googleapi.Error); ok {
if v.Code == http.StatusNotFound {
return nil
}
}
data, _ := json.Marshal(change)
2020-02-27 18:14:46 +00:00
return fmt.Errorf("failed to perform changes [zone %s, change %s]: %w", zone, string(data), err)
}
2019-01-02 19:45:17 +00:00
if chg.Status == changeStatusDone {
2018-12-21 23:53:05 +00:00
return nil
}
chgID := chg.Id
// wait for change to be acknowledged
2018-12-21 23:53:05 +00:00
return wait.For("apply change", 30*time.Second, 3*time.Second, func() (bool, error) {
if d.config.Debug {
data, _ := json.Marshal(change)
log.Printf("change (Get): %s", string(data))
}
2018-12-21 23:53:05 +00:00
chg, err = d.client.Changes.Get(d.config.Project, zone, chgID).Do()
if err != nil {
2018-12-21 23:53:05 +00:00
data, _ := json.Marshal(change)
2020-02-27 18:14:46 +00:00
return false, fmt.Errorf("failed to get changes [zone %s, change %s]: %w", zone, string(data), err)
}
2019-01-02 19:45:17 +00:00
if chg.Status == changeStatusDone {
2018-12-21 23:53:05 +00:00
return true, nil
}
return false, fmt.Errorf("status: %s", chg.Status)
})
}
// CleanUp removes the TXT record matching the specified parameters.
func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error {
fqdn, _ := dns01.GetRecord(domain, keyAuth)
zone, err := d.getHostedZone(fqdn)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("googlecloud: %w", err)
}
records, err := d.findTxtRecords(zone, fqdn)
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("googlecloud: %w", err)
}
if len(records) == 0 {
return nil
}
_, err = d.client.Changes.Create(d.config.Project, zone, &dns.Change{Deletions: records}).Do()
if err != nil {
2020-02-27 18:14:46 +00:00
return fmt.Errorf("googlecloud: %w", err)
}
return nil
}
2016-03-19 16:53:16 +00:00
// Timeout customizes the timeout values used by the ACME package for checking
// DNS record validity.
func (d *DNSProvider) Timeout() (timeout, interval time.Duration) {
return d.config.PropagationTimeout, d.config.PollingInterval
}
2020-05-08 17:35:25 +00:00
// getHostedZone returns the managed-zone.
func (d *DNSProvider) getHostedZone(domain string) (string, error) {
authZone, err := dns01.FindZoneByFqdn(dns01.ToFqdn(domain))
if err != nil {
return "", err
}
zones, err := d.client.ManagedZones.
List(d.config.Project).
DnsName(authZone).
Do()
if err != nil {
2020-02-27 18:14:46 +00:00
return "", fmt.Errorf("API call failed: %w", err)
}
if len(zones.ManagedZones) == 0 {
return "", fmt.Errorf("no matching domain found for domain %s", authZone)
}
2019-04-12 18:37:29 +00:00
for _, z := range zones.ManagedZones {
if z.Visibility == "public" || z.Visibility == "" || (z.Visibility == "private" && d.config.AllowPrivateZone) {
2019-04-12 18:37:29 +00:00
return z.Name, nil
}
}
if d.config.AllowPrivateZone {
return "", fmt.Errorf("no public or private zone found for domain %s", authZone)
}
2019-04-12 18:37:29 +00:00
return "", fmt.Errorf("no public zone found for domain %s", authZone)
}
func (d *DNSProvider) findTxtRecords(zone, fqdn string) ([]*dns.ResourceRecordSet, error) {
recs, err := d.client.ResourceRecordSets.List(d.config.Project, zone).Name(fqdn).Type("TXT").Do()
if err != nil {
return nil, err
}
return recs.Rrsets, nil
}
2018-12-21 23:53:05 +00:00
func mustUnquote(raw string) string {
clean, err := strconv.Unquote(raw)
if err != nil {
return raw
}
return clean
}
func autodetectProjectID() string {
if pid, err := metadata.ProjectID(); err == nil {
return pid
}
return ""
}