# Packages
Package storagetest provides utilities to assist in testing caddytls.Storage implementations.
# Functions
CacheManagedCertificate loads the certificate for domain into the cache, flagging it as Managed and, if onDemand is true, as "OnDemand" (meaning that it was obtained or loaded during a TLS handshake).
DeleteOldStapleFiles deletes cached OCSP staples that have expired.
FileStorageCreator creates a new Storage instance backed by the local disk.
HostQualifies returns true if the hostname alone appears eligible for automatic HTTPS.
HTTPChallengeHandler proxies challenge requests to ACME client if the request path starts with challengeBasePath.
MakeTLSConfig reduces configs into a single tls.Config.
QualifiesForManagedTLS returns true if c qualifies for for managed TLS (but not on-demand TLS specifically).
RegisterConfigGetter registers fn as the way to get a Config for server type serverType.
RegisterDNSProvider registers provider by name for solving the ACME DNS challenge.
RenewManagedCertificates renews managed certificates.
Revoke revokes the certificate for host via ACME protocol.
RotateSessionTicketKeys rotates the TLS session ticket keys on cfg every TicketRotateInterval.
SetDefaultTLSParams sets the default TLS cipher suites, protocol versions, and server preferences of a server.Config if they were not previously set (it does not overwrite; only fills in missing values).
UpdateOCSPStaples updates the OCSP stapling in all eligible, cached certificates.
# Constants
DefaultHTTPAlternatePort is the port on which the ACME client will open a listener and solve the HTTP challenge.
HTTPChallengePort is the officially designated port for the HTTP challenge.
NumTickets is how many tickets to hold and consider to decrypt TLS sessions.
OCSPInterval is how often to check if OCSP stapling needs updating.
RenewDurationBefore is how long before expiration to renew certificates.
RenewInterval is how often to check certificates for renewal.
TicketRotateInterval is how often to generate new ticket for TLS PFS encryption.
TLSSNIChallengePort is the officially designated port for the TLS-SNI challenge.
# Variables
Agreed indicates whether user has agreed to the Let's Encrypt SA.
DefaultCAUrl is the default URL to the CA's ACME directory endpoint.
DefaultEmail represents the Let's Encrypt account email to use if none provided.
DefaultKeyType is used as the type of key for new certificates when no other key type is specified.
ErrStorageNotFound is returned by Storage implementations when data is expected to be present but is not.
# Structs
ACMEClient is an acme.Client with custom state attached.
Certificate is a tls.Certificate with associated metadata tacked on.
Config describes how TLS should be configured and used.
OnDemandState contains some state relevant for providing on-demand TLS.
SiteData contains persisted items pertaining to an individual site.
User represents a Let's Encrypt user account.
UserData contains persisted items pertaining to a user.
# Interfaces
ConfigHolder is any type that has a Config; it presumably is connected to a hostname and port on which it is serving.
Storage is an interface abstracting all storage used by Caddy's TLS subsystem.
# Type aliases
ConfigGetter gets a Config keyed by key.
DNSProviderConstructor is a function that takes credentials and returns a type that can solve the ACME DNS challenges.
FileStorage is a root directory and facilitates forming file paths derived from it.
StorageCreator is a function type that is used in the Config to instantiate a new Storage instance.