dns01

Documentation

Index

• Constants
• func ExtractSubDomain(domain, zone string) (string, error)
• func FindZoneByFqdn(fqdn string) (string, error)
• func FindZoneByFqdnCustom(fqdn string, ns []string) (string, error)
• func GetRecord(domain, keyAuth string) (fqdn, value string)
• func ToFqdn(name string) string
• func UnFqdn(name string) string
• type ChallengeInfo
  • func GetChallengeInfo(domain, keyAuth string) ChallengeInfo
• type DNSProviderManual
  • func NewDNSProviderManual() (*DNSProviderManual, error)
  • func (*DNSProviderManual) CleanUp(domain, token, keyAuth string) error
  • func (*DNSProviderManual) Present(domain, token, keyAuth string) error
  • func (d *DNSProviderManual) Sequential() time.Duration

Constants

const (
	// DefaultPropagationTimeout default propagation timeout.
	DefaultPropagationTimeout = 60 * time.Second

	// DefaultPollingInterval default polling interval.
	DefaultPollingInterval = 2 * time.Second

	// DefaultTTL default TTL.
	DefaultTTL = 120
)

Functions

func ExtractSubDomain

func ExtractSubDomain(domain, zone string) (string, error)

ExtractSubDomain extracts the subdomain part from a domain and a zone.

func FindZoneByFqdn

func FindZoneByFqdn(fqdn string) (string, error)

FindZoneByFqdn is used by Lego DNS providers to determine the domain

func FindZoneByFqdnCustom

func FindZoneByFqdnCustom(fqdn string, ns []string) (string, error)

FindZoneByFqdnCustom is used by Lego DNS providers to determine the domain

func GetRecord

func GetRecord(domain, keyAuth string) (fqdn, value string)

GetRecord returns a DNS record which will fulfill the `dns-01` challenge. Modified to function for non ACME domain validations Deprecated: use GetChallengeInfo instead.

func ToFqdn

func ToFqdn(name string) string

ToFqdn converts the name into a fqdn appending a trailing dot.

func UnFqdn

func UnFqdn(name string) string

UnFqdn converts the fqdn into a name removing the trailing dot.

Types

type ChallengeInfo

type ChallengeInfo struct {
	// FQDN is the full-qualified challenge domain (i.e. `_acme-challenge.[domain].`)
	FQDN string

	// EffectiveFQDN contains the resulting FQDN after the CNAMEs resolutions.
	EffectiveFQDN string

	// Value contains the value for the TXT record.
	Value string
}

ChallengeInfo contains the information use to create the TXT record.

func GetChallengeInfo

func GetChallengeInfo(domain, keyAuth string) ChallengeInfo

GetChallengeInfo returns information used to create a DNS record which will fulfill the `dns-01` challenge.

type DNSProviderManual

type DNSProviderManual struct{}

DNSProviderManual is an implementation of the ChallengeProvider interface.

func NewDNSProviderManual

func NewDNSProviderManual() (*DNSProviderManual, error)

NewDNSProviderManual returns a DNSProviderManual instance.

func (*DNSProviderManual) CleanUp

func (*DNSProviderManual) CleanUp(domain, token, keyAuth string) error

CleanUp prints instructions for manually removing the TXT record.

func (*DNSProviderManual) Present

func (*DNSProviderManual) Present(domain, token, keyAuth string) error

Present prints instructions for manually creating the TXT record.

func (*DNSProviderManual) Sequential

func (d *DNSProviderManual) Sequential() time.Duration

Sequential All DNS challenges for this provider will be resolved sequentially. Returns the interval between each iteration.