package
0.10.14
Repository: https://github.com/comp500/caddy.git
Documentation: pkg.go.dev

# Packages

Package storagetest provides utilities to assist in testing caddytls.Storage implementations.

# Functions

DeleteOldStapleFiles deletes cached OCSP staples that have expired.
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, if the HTTP challenge is not disabled, and if we are known to be obtaining a certificate for the name.
MakeTLSConfig makes a tls.Config from configs.
NewConfig returns a new Config with a pointer to the instance's certificate cache.
NewFileStorage is a StorageConstructor function that creates a new Storage instance backed by the local disk.
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.
RegisterStorageProvider registers provider by name for storing tls data.
RenewManagedCertificates renews managed certificates, including ones loaded on-demand.
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

CertCacheInstStorageKey is the name of the key for accessing the certificate storage on the *caddy.Instance.
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 according to the ACME spec.
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.
RenewDurationBeforeAtStartup is how long before expiration to require a renewed certificate when the process is first starting up (see #1680).
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 according to the ACME spec.

# 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.
DisableHTTPChallenge will disable all HTTP challenges.
DisableTLSSNIChallenge will disable all TLS-SNI challenges.
Map of supported ciphers, used only for parsing config.
Map of supported protocols.

# Structs

ACMEClient is a wrapper over acme.Client with some custom state attached.
Certificate is a tls.Certificate with associated metadata tacked on.
Config describes how TLS should be configured and used.
FileStorage facilitates forming file paths derived from a root directory.
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.
ErrNotExist is returned by Storage implementations when a resource is not found.
Locker provides support for mutual exclusion.
Storage is an interface abstracting all storage used by Caddy's TLS subsystem.
Waiter is a type that can block until a storage lock is released.

# Type aliases

ChallengeProvider defines an own type that should be used in Caddy plugins over acme.ChallengeProvider.
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.
StorageConstructor is a function type that is used in the Config to instantiate a new Storage instance.