package
1.19.0
Repository: https://github.com/hashicorp/vault.git
Documentation: pkg.go.dev

# Functions

AuditedHeadersKey returns the key at which audit header configuration is stored.
ConvertToExternalError handles converting an audit related error that was generated in Vault and should appear as-is in the server logs, to an error that can be returned to calling clients (via the API/CLI).
HasInvalidOptions is used to determine if a non-Enterprise version of Vault is being used when supplying options that contain options exclusive to Enterprise.
NewBroker initializes a broker, which can be used to perform audit logging.
NewFileBackend provides a wrapper to support the expectation elsewhere in Vault that all audit backends can be created via a factory that returns an interface (Backend).
NewHeadersConfig should be used to create HeadersConfig.
NewNoopAudit should be used to create a NoopAudit as it handles creation of a predictable salt and wraps eventlogger nodes so information can be retrieved on what they've seen or formatted.
NewSocketBackend provides a means to create socket backend audit devices that satisfy the Factory pattern expected elsewhere in Vault.
NewSyslogBackend provides a wrapper to support the expectation elsewhere in Vault that all audit backends can be created via a factory that returns an interface (Backend).
NoopAuditFactory should be used when the test needs a way to access bytes that have been formatted by the pipeline during audit requests.
Deprecated: TestNoopAudit only exists to allow legacy tests to continue working.

# Constants

AuditedHeadersSubPath is the path used to create a sub view within storage.
Audit subtypes.
Audit subtypes.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrExternalOptions should be used to represent an error related to invalid configuration provided to Vault (i.e.
ErrInternal should be used to represent an unexpected error that occurred within the audit system.
ErrInvalidParameter should be used to represent an error in which the internal audit system is receiving invalid parameters from other parts of Vault which should have already been validated.

# Structs

BackendConfig contains configuration parameters used in the factory func to instantiate audit backends.
Broker represents an audit broker which performs actions such as registering/de-registering backends and logging audit entries for a request or response.
Event is the audit event.
HeadersConfig is used by the Audit Broker to write only approved headers to the audit logs.
NoopAudit only exists to allow legacy tests to continue working.

# Interfaces

Auditor interface describes methods which can be used to perform auditing.
Backend interface must be implemented for an audit mechanism to be made available.
HeaderFormatter is an interface defining the methods of the vault.HeadersConfig structure needed in this package.
Registrar interface describes a means to register and deregister audit devices.
Salter is an interface that provides a way to obtain a Salt for hashing.

# Type aliases

Factory is the factory function to create an audit backend.