Documentation ¶
Index ¶
- Constants
- func ClearFqdnCache()
- func FindPrimaryNsByFqdn(fqdn string) (string, error)
- func FindPrimaryNsByFqdnCustom(fqdn string, nameservers []string) (string, error)
- func FindZoneByFqdn(fqdn string) (string, error)
- func FindZoneByFqdnCustom(fqdn string, nameservers []string) (string, error)
- func GetRecord(domain, keyAuth string) (fqdn string, value string)
- func ParseNameservers(servers []string) []string
- func ToFqdn(name string) string
- func UnFqdn(name string) string
- type Challenge
- type ChallengeOption
- func AddDNSTimeout(timeout time.Duration) ChallengeOption
- func AddPreCheck(preCheck PreCheckFunc) ChallengeOption
- func AddRecursiveNameservers(nameservers []string) ChallengeOption
- func CondOption(condition bool, opt ChallengeOption) ChallengeOption
- func DisableCompletePropagationRequirement() ChallengeOption
- func WrapPreCheck(wrap WrapPreCheckFunc) ChallengeOption
- type DNSProviderManual
- type PreCheckFunc
- type ValidateFunc
- type WrapPreCheckFunc
Constants ¶
const ( // DefaultPropagationTimeout default propagation timeout DefaultPropagationTimeout = 60 * time.Second // DefaultPollingInterval default polling interval DefaultPollingInterval = 2 * time.Second // DefaultTTL default TTL DefaultTTL = 120 )
Variables ¶
This section is empty.
Functions ¶
func ClearFqdnCache ¶
func ClearFqdnCache()
ClearFqdnCache clears the cache of fqdn to zone mappings. Primarily used in testing.
func FindPrimaryNsByFqdn ¶
FindPrimaryNsByFqdn determines the primary nameserver of the zone apex for the given fqdn by recursing up the domain labels until the nameserver returns a SOA record in the answer section.
func FindPrimaryNsByFqdnCustom ¶
FindPrimaryNsByFqdnCustom determines the primary nameserver of the zone apex for the given fqdn by recursing up the domain labels until the nameserver returns a SOA record in the answer section.
func FindZoneByFqdn ¶
FindZoneByFqdn determines the zone apex for the given fqdn by recursing up the domain labels until the nameserver returns a SOA record in the answer section.
func FindZoneByFqdnCustom ¶
FindZoneByFqdnCustom determines the zone apex for the given fqdn by recursing up the domain labels until the nameserver returns a SOA record in the answer section.
func ParseNameservers ¶
Types ¶
type Challenge ¶
type Challenge struct {
// contains filtered or unexported fields
}
Challenge implements the dns-01 challenge
func NewChallenge ¶
func NewChallenge(core *api.Core, validate ValidateFunc, provider challenge.Provider, opts ...ChallengeOption) *Challenge
func (*Challenge) CleanUp ¶
func (c *Challenge) CleanUp(authz acme.Authorization) error
CleanUp cleans the challenge.
type ChallengeOption ¶
func AddDNSTimeout ¶
func AddDNSTimeout(timeout time.Duration) ChallengeOption
func AddPreCheck ¶
func AddPreCheck(preCheck PreCheckFunc) ChallengeOption
AddPreCheck Allow to define checks before notifying ACME that the DNS challenge is ready. Deprecated: use WrapPreCheck instead.
func AddRecursiveNameservers ¶
func AddRecursiveNameservers(nameservers []string) ChallengeOption
func CondOption ¶
func CondOption(condition bool, opt ChallengeOption) ChallengeOption
CondOption Conditional challenge option.
func DisableCompletePropagationRequirement ¶
func DisableCompletePropagationRequirement() ChallengeOption
func WrapPreCheck ¶
func WrapPreCheck(wrap WrapPreCheckFunc) ChallengeOption
WrapPreCheck Allow to define checks before notifying ACME that the DNS challenge is ready.
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.
type PreCheckFunc ¶
PreCheckFunc checks DNS propagation before notifying ACME that the DNS challenge is ready.
type ValidateFunc ¶
type WrapPreCheckFunc ¶
type WrapPreCheckFunc func(domain, fqdn, value string, check PreCheckFunc) (bool, error)
WrapPreCheckFunc wraps a PreCheckFunc in order to do extra operations before or after the main check, put it in a loop, etc.