gandiv5

Documentation

Overview

Package gandiv5 implements a DNS provider for solving the DNS-01 challenge using Gandi LiveDNS api.

Index

• type Config
  • func NewDefaultConfig() *Config
• type DNSProvider
  • func NewDNSProvider() (*DNSProvider, error)
  • func NewDNSProviderConfig(config *Config) (*DNSProvider, error)
  • func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error
  • func (d *DNSProvider) Present(domain, token, keyAuth string) error
  • func (d *DNSProvider) Timeout() (timeout, interval time.Duration)
• type Record

Types

type Config

type Config struct {
	BaseURL            string
	APIKey             string
	PropagationTimeout time.Duration
	PollingInterval    time.Duration
	TTL                int
	HTTPClient         *http.Client
}

Config is used to configure the creation of the DNSProvider

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig returns a default configuration for the DNSProvider

type DNSProvider

type DNSProvider struct {
	// contains filtered or unexported fields
}

DNSProvider is an implementation of the acme.ChallengeProviderTimeout interface that uses Gandi's LiveDNS API to manage TXT records for a domain.

func NewDNSProvider

func NewDNSProvider() (*DNSProvider, error)

NewDNSProvider returns a DNSProvider instance configured for Gandi. Credentials must be passed in the environment variable: GANDIV5_API_KEY.

func NewDNSProviderConfig

func NewDNSProviderConfig(config *Config) (*DNSProvider, error)

NewDNSProviderConfig return a DNSProvider instance configured for Gandi.

func (*DNSProvider) CleanUp

func (d *DNSProvider) CleanUp(domain, token, keyAuth string) error

CleanUp removes the TXT record matching the specified parameters.

func (*DNSProvider) Present

func (d *DNSProvider) Present(domain, token, keyAuth string) error

Present creates a TXT record using the specified parameters.

func (*DNSProvider) Timeout

func (d *DNSProvider) Timeout() (timeout, interval time.Duration)

Timeout returns the values (20*time.Minute, 20*time.Second) which are used by the acme package as timeout and check interval values when checking for DNS record propagation with Gandi.

type Record

type Record struct {
	RRSetTTL    int      `json:"rrset_ttl"`
	RRSetValues []string `json:"rrset_values"`
	RRSetName   string   `json:"rrset_name,omitempty"`
	RRSetType   string   `json:"rrset_type,omitempty"`
}

Record TXT record representation