cloudflare

Documentation

Overview

Package cloudflare implements a DNS provider for solving the DNS-01 challenge using cloudflare DNS.

Index

• Constants
• type DNSProvider
  • func NewDNSProvider() (*DNSProvider, error)
  • func NewDNSProviderCredentials(email, key string) (*DNSProvider, error)
  • func (c *DNSProvider) CleanUp(domain, token, keyAuth string) error
  • func (c *DNSProvider) Present(domain, token, keyAuth string) error
  • func (c *DNSProvider) Timeout() (timeout, interval time.Duration)

Constants

const CloudFlareAPIURL = "https://api.cloudflare.com/client/v4"

CloudFlareAPIURL represents the API endpoint to call. TODO: Unexport?

Types

type DNSProvider

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

DNSProvider is an implementation of the acme.ChallengeProvider interface

func NewDNSProvider

func NewDNSProvider() (*DNSProvider, error)

NewDNSProvider returns a DNSProvider instance configured for cloudflare. Credentials must be passed in the environment variables: CLOUDFLARE_EMAIL and CLOUDFLARE_API_KEY.

func NewDNSProviderCredentials

func NewDNSProviderCredentials(email, key string) (*DNSProvider, error)

NewDNSProviderCredentials uses the supplied credentials to return a DNSProvider instance configured for cloudflare.

func (*DNSProvider) CleanUp

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

CleanUp removes the TXT record matching the specified parameters

func (*DNSProvider) Present

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

Present creates a TXT record to fulfil the dns-01 challenge

func (*DNSProvider) Timeout

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

Timeout returns the timeout and interval to use when checking for DNS propagation. Adjusting here to cope with spikes in propagation times.