gandiv5

Documentation

Overview

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

Index

• type DNSProvider
  • func NewDNSProvider() (*DNSProvider, error)
  • func NewDNSProviderCredentials(apiKey string) (*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)

Types

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 NewDNSProviderCredentials

func NewDNSProviderCredentials(apiKey string) (*DNSProvider, error)

NewDNSProviderCredentials uses the supplied credentials to 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.