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

# Functions

CalculateTTL takes all the user-specified, backend, and system inputs and calculates a TTL for a lease.
DeleteWAL commits the WAL entry with the given ID.
Helper which returns a generic regex string for creating endpoint patterns that are identified by the given name in the backends.
GenericNameWithAtRegex returns a generic regex that allows alphanumeric characters along with -, .
GetWAL reads a specific entry from the WAL.
GlobListFilter wraps an OperationFunc with an optional filter which excludes listed entries which don't match a glob style pattern.
HandlePatchOperation acts as an abstraction for performing JSON merge patch operations (see https://datatracker.ietf.org/doc/html/rfc7396) for HTTP PATCH requests.
LeaseExtend is left for backwards compatibility for plugins.
ListWAL lists all the entries in the WAL.
Helper which returns a regex string for capturing an entire endpoint path as the given name.
NewOASDocument returns an empty OpenAPI document.
NewOASDocumentFromMap builds an OASDocument from an existing map version of a document.
NewOASOperation creates an empty OpenAPI Operations object.
Helper which returns a regex string for optionally accepting the a field from the API URL.
PathAppend is a helper for appending lists of paths into a single list.
PopulateIdentityTemplate takes a template string, an entity ID, and an instance of system view.
PutWAL writes some data to the WAL.
TestBackendRoutes is a helper to test that all the given routes will route properly in the backend.
ValidateIdentityTemplate takes a template string and returns if the string is a valid identity template.

# Constants

OpenAPI specification (OAS): https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md.
No description provided by the author
TypeCommaIntSlice is a helper for TypeSlice that returns a sanitized slice of Ints.
TypeCommaStringSlice is a helper for TypeSlice that returns a sanitized slice of strings and also supports parsing a comma-separated list in a string field.
TypeDurationSecond represent as seconds, this can be either an integer or go duration format string (e.g.
TypeFloat parses both float32 and float64 values.
TypeHeader is a helper for sending request headers through to Vault.
No description provided by the author
No description provided by the author
No description provided by the author
TypeKVPairs allows you to represent the data as a map or a list of equal sign delimited key pairs.
TypeLowerCaseString is a helper for TypeString that returns a lowercase version of the provided string.
No description provided by the author
TypeNameString represents a name that is URI safe and follows specific rules.
TypeSignedDurationSecond represents a positive or negative duration as seconds, this can be either an integer or go duration format string (e.g.
TypeSlice represents a slice of any type.
No description provided by the author
TypeStringSlice is a helper for TypeSlice that returns a sanitized slice of strings.
TypeTime represents absolute time.
WALPrefix is the prefix within Storage where WAL entries will be written.

# Variables

ErrNoEvents is returned when attempting to send an event, but when the event sender was not passed in during `backend.Setup()`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Backend is an implementation of logical.Backend that allows the implementer to code a backend using a much more programmer-friendly framework that handles a lot of the routing and validation for you.
No description provided by the author
FieldData is the structure passed to the callback to handle a path containing the populated parameters for fields.
FieldSchema is a basic schema to describe the format of a path field.
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
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
No description provided by the author
OperationProperties describes an operation for documentation, help text, and other clients.
Path is a single path that the backend responds to.
DEPRECATED: Don't use this.
PathOperation is a concrete implementation of OperationHandler.
PathStruct can be used to generate a path that stores a struct in the storage.
DEPRECATED: Don't use this.
RequestExample is example of request data.
Response describes and optional demonstrations an operation response.
Secret is a type of secret that can be returned from a backend.
No description provided by the author

# Interfaces

OperationHandler defines and describes a specific operation handler.

# Type aliases

CleanupFunc is the callback for backend unload.
ExistenceFunc is the callback called for an existence check on a path.
FieldType is the enum of types that a field can be.
InitializeFunc is the callback, which if set, will be invoked via Initialize() just after a plugin has been mounted.
InvalidateFunc is the callback for backend key invalidation.
No description provided by the author
OperationFunc is the callback called for an operation on a path.
PatchPreprocessorFunc is used by HandlePatchOperation in order to shape the input as defined by request handler prior to JSON marshaling.
WALRollbackFunc is the callback for rollbacks.