package
0.0.0-20250220232038-fb2fd8af7512
Repository: https://github.com/letsencrypt/boulder.git
Documentation: pkg.go.dev

# Packages

# Functions

AuditPanic catches and logs panics, then exits with exit code 1.
AvailableConfigValidators returns a list of Boulder component names for which a *ConfigValidator has been registered.
CatchSignals blocks until a SIGTERM, SIGINT, or SIGHUP is received, then executes the given callback.
Clock functions similarly to clock.New(), but the returned value can be changed using the FAKECLOCK environment variable if the 'integration' build flag is set.
Fail raises a panic with a special type that causes `AuditPanic` to audit log the provided message and then exit nonzero (without printing a stack trace).
FailOnError calls Fail if the provided error is non-nil.
LookupConfigValidator constructs an instance of the *ConfigValidator for the given Boulder component name.
NewLogger creates a logger object with the provided settings, sets it as the global logger, and returns it.
NewOpenTelemetry sets up our OpenTelemetry tracing It returns a graceful shutdown function to be deferred.
ReadConfigFile takes a file path as an argument and attempts to unmarshal the content of the file into a struct containing a configuration of a boulder component.
RegisterCommand registers a subcommand and its corresponding config validator.
StatsAndLogging sets up an AuditLogger, Prometheus Registerer, and OpenTelemetry tracing.
ValidateJSONConfig takes a *ConfigValidator and an io.Reader containing a JSON representation of a config.
ValidateYAMLConfig takes a *ConfigValidator and an io.Reader containing a YAML representation of a config.
VersionString produces a friendly Application version string.
WaitForSignal blocks until a SIGTERM, SIGINT, or SIGHUP is received.

# Structs

DBConfig defines how to connect to a database.
DNSProvider contains the configuration for a DNS provider in the bdns package which supports dynamic reloading of its backends.
GRPCClientConfig contains the information necessary to setup a gRPC client connection.
GRPCServerConfig contains the information needed to start a gRPC server.
GRPCServiceConfig contains the information needed to configure a gRPC service.
HMACKeyConfig specifies a path to a file containing a hexadecimal-encoded HMAC key.
HostnamePolicyConfig specifies a file from which to load a policy regarding what hostnames to issue for.
OpenTelemetryConfig configures tracing via OpenTelemetry.
OpenTelemetryHTTPConfig configures the otelhttp server tracing.
PAConfig specifies how a policy authority should connect to its database, what policies it should enforce, and what challenges it should offer.
PasswordConfig contains a path to a file containing a password.
ServiceConfig contains config items that are common to all our services, to be embedded in other config structs.
ServiceDomain contains the service and domain name the gRPC or bdns provider will use to construct a SRV DNS query to lookup backends.
SyslogConfig defines the config for syslogging.
TLSConfig represents certificates and a key for authenticated TLS.