Documentation
¶
Index ¶
Constants ¶
const ( // HTTP01 is the "http-01" ACME challenge https://www.rfc-editor.org/rfc/rfc8555.html#section-8.3 // Note: ChallengePath returns the URL path to fulfill this challenge. HTTP01 = Type("http-01") // DNS01 is the "dns-01" ACME challenge https://www.rfc-editor.org/rfc/rfc8555.html#section-8.4 // Note: GetRecord returns a DNS record which will fulfill this challenge. DNS01 = Type("dns-01") // DNSPersist01 is the "dns-persist-01" ACME challenge https://datatracker.ietf.org/doc/draft-ietf-acme-dns-persist. DNSPersist01 = Type("dns-persist-01") // TLSALPN01 is the "tls-alpn-01" ACME challenge https://www.rfc-editor.org/rfc/rfc8737.html TLSALPN01 = Type("tls-alpn-01") )
Variables ¶
This section is empty.
Functions ¶
func FindChallenge ¶
func GetTargetedDomain ¶
func GetTargetedDomain(authz acme.Authorization) string
Types ¶
type NetworkStack ¶
type NetworkStack int
const ( DualStack NetworkStack = iota IPv4Only IPv6Only )
func (NetworkStack) Network ¶
func (s NetworkStack) Network(proto string) string
type PersistentProvider ¶
type PersistentProvider interface {
Persist(ctx context.Context, fqdn, value string) error
Timeout() (timeout, interval time.Duration)
}
PersistentProvider enables implementing a custom challenge provider of DNS-PERSISTENT-01. IMPORTANT: this interface is experimental and may change without notice.
type Provider ¶
type Provider interface {
Present(ctx context.Context, domain, token, keyAuth string) error
CleanUp(ctx context.Context, domain, token, keyAuth string) error
}
Provider enables implementing a custom challenge provider. Present presents the solution to a challenge available to be solved. CleanUp will be called by the challenge if Present ends in a non-error state.
type ProviderTimeout ¶
ProviderTimeout allows for implementing a Provider where an unusually long timeout is required when waiting for an ACME challenge to be satisfied, such as when checking for DNS record propagation. If an implementor of a Provider provides a Timeout method, then the return values of the Timeout method will be used when appropriate by the acme package. The interval value is the time between checks.
The default values used for timeout and interval are 60 seconds and 2 seconds respectively. These are used when no Timeout method is defined for the Provider.