package
0.11.6
Repository: https://github.com/puppetlabs/vault.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

AdjustErrorStatusCode adjusts the status that will be sent in error conditions in a way that can be shared across http's respondError and other locations.
ClearView is used to delete all the keys in a view.
No description provided by the author
CollectKeys is used to collect all the keys in a view.
ErrorResponse is used to format an error response.
HelpResponse is used to format a help response.
No description provided by the author
ListResponse is used to format a response to a list operation.
ListResponseWithInfo is used to format a response to a list operation and return the keys as well as a map with corresponding key info.
This logic was pulled from the http package so that it can be used for encoding wrapped responses as well.
RenewAuthRequest creates the structure of the renew request for an auth.
RenewRequest creates the structure of the renew request.
RespondErrorCommon pulls most of the functionality from http's respondErrorCommon and some of http's handleLogical and makes it available to both the http package and elsewhere.
RespondWithStatusCode takes a response and converts it to a raw response with the provided Status Code.
RevokeRequest creates the structure of the revoke request.
RollbackRequest creates the structure of the revoke request.
ScanView is used to scan all the keys in a view iteratively.
StorageEntryJSON creates a StorageEntry with a JSON-encoded value.
No description provided by the author
TestRequest is a helper to create a purely in-memory Request struct.
TestStorage is a helper that can be used from unit tests to verify the behavior of a Storage impl.
No description provided by the author

# Constants

No description provided by the author
The operations below are called per path.
No description provided by the author
No description provided by the author
HTTPContentType can be specified in the Data field of a Response so that the HTTP front end can specify a custom Content-Type associated with the HTTPRawBody.
HTTPRawBody is the raw content of the HTTP body that goes with the HTTPContentType.
For unwrapping we may need to know whether the value contained in the raw body is already JSON-unmarshaled.
HTTPStatusCode is the response code of the HTTP body that goes with the HTTPContentType.
No description provided by the author
No description provided by the author
No description provided by the author
The operations below are called globally, the path is less relevant.
No description provided by the author
The these are the types of backends that can be derived from logical.Backend.
The these are the types of backends that can be derived from logical.Backend.
This is also the zero-value for BackendType.
No description provided by the author

# Variables

ErrInvalidRequest is returned if the request is invalid.
ErrMultiAuthzPending is returned if the the request needs more authorizations.
ErrPermissionDenied is returned if the client is not authorized.
ErrReadOnly is returned when a backend does not support writing.
ErrSetupReadOnly is returned when a write operation is attempted on a storage while the backend is still being setup.
ErrUnsupportedOperation is returned if the operation is not supported by the logical backend.
ErrUnsupportedPath is returned if the path is not supported by the logical backend.
ErrUpstreamRateLimited is returned when Vault receives a rate limited response from an upstream.

# Structs

No description provided by the author
Auth is the resulting authentication information that is part of Response for credential backends.
BackendConfig is provided to the factory to initialize the backend.
Connection represents the connection information for a request.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
InmemStorage implements Storage and stores all data in memory.
No description provided by the author
LeaseOptions is an embeddable struct to capture common lease settings between a Secret and Auth.
Paths is the structure of special paths that is used for SpecialPaths.
No description provided by the author
This is a new type declared to not cause potential compatibility problems if the logic around the CodedError changes; in particular for logical request paths it is basically ignored, and changing that behavior might cause unforseen issues.
Request is a struct that stores the parameters and context of a request being made to Vault.
RequestWrapInfo is a struct that stores information about desired response and seal wrapping behavior.
Response is a struct that stores the response of a request.
Secret represents the secret part of a response.
No description provided by the author
Struct to identify user input errors.
StorageEntry is the entry for an item in a Storage implementation.
TokenEntry is used to represent a given token.

# Interfaces

Backend interface must be implemented to be "mountable" at a given path.
No description provided by the author
No description provided by the author
Storage is the way that logical backends are able read/write data.
SystemView exposes system configuration information in a safe way for logical backends to consume.

# Type aliases

BackendType is the type of backend that is being implemented.
Factory is the factory function to create a logical backend.
No description provided by the author
Operation is an enum that is used to specify the type of request being made.