logical

Jan 9, 2025

Changes in this version

+ const EventMetadataPath

+ const RotationOperation

type PluginEnvironment

+ VaultBuildDate *timestamppb.Timestamp

+ func (x *PluginEnvironment) GetVaultBuildDate() *timestamppb.Timestamp

type Request

+ RotationEntryName string

type Response

+ func ErrorResponseWithData(data interface{}, text string, vargs ...interface{}) *Response

type StaticSystemView

+ func (d StaticSystemView) DeregisterRotationJob(_ context.Context, _ string) (err error)

+ func (d StaticSystemView) RegisterRotationJob(_ context.Context, _ *rotation.RotationJob) (rotationID string, err error)

type SystemView

+ DeregisterRotationJob func(ctx context.Context, rotationID string) error

+ RegisterRotationJob func(ctx context.Context, job *rotation.RotationJob) (rotationID string, err error)

May 23, 2024

Changes in this version

type Auth

+ HTTPRequestPriority *uint8

type ClientTokenSource

+ func ClientTokenSourceString(s string) (ClientTokenSource, error)

+ func ClientTokenSourceValues() []ClientTokenSource

+ func (i ClientTokenSource) IsAClientTokenSource() bool

+ func (i ClientTokenSource) String() string

+ type CtxKeyInFlightRequestPriority struct

+ func (c CtxKeyInFlightRequestPriority) String() string

+ type CtxKeyInFlightTraceID struct

+ func (c CtxKeyInFlightTraceID) String() string

type KeyUsage

+ func KeyUsageString(s string) (KeyUsage, error)

+ func KeyUsageValues() []KeyUsage

+ func (i KeyUsage) IsAKeyUsage() bool

+ func (i KeyUsage) String() string

type TokenType

+ func TokenTypeString(s string) (TokenType, error)

+ func TokenTypeValues() []TokenType

+ func (i TokenType) IsATokenType() bool

Apr 11, 2024

Changes in this version

+ var ErrInvalidToken = errors.New("invalid token")

Mar 13, 2024

Changes in this version

+ func CreateContextRedactionSettings(parent context.Context, redactVersion, redactAddresses, redactClusterName bool) context.Context

+ func CtxRedactionSettingsValue(ctx context.Context) (redactVersion, redactAddresses, redactClusterName, ok bool)

Feb 8, 2024

Changes in this version

+ const PluginVersion_Version_FullMethodName

+ var ErrNotFound = errors.New("not found")

+ func ContextDisableReplicationStatusEndpointsValue(ctx context.Context) (value, ok bool)

+ func ContextOriginalBodyValue(ctx context.Context) (io.ReadCloser, bool)

+ func ContextOriginalRequestPathValue(ctx context.Context) (value string, ok bool)

+ func CreateContextDisableReplicationStatusEndpoints(parent context.Context, value bool) context.Context

+ func CreateContextOriginalBody(parent context.Context, body io.ReadCloser) context.Context

+ func CreateContextOriginalRequestPath(parent context.Context, value string) context.Context

type ClientTokenSource

+ const ClientTokenFromInternalAuth

+ type CtxKeyDisableRequestLimiter struct

+ func (c CtxKeyDisableRequestLimiter) String() string

+ type DelegatedAuthErrorHandler func(ctx context.Context, initiatingRequest, authRequest *Request, ...) (*Response, error)

type ExtendedSystemView

+ GetPinnedPluginVersion func(ctx context.Context, pluginType consts.PluginType, pluginName string) (*pluginutil.PinnedVersion, error)

type LogInput

+ func (l *LogInput) BexprDatum(namespace string) *LogInputBexpr

+ func (l *LogInput) Clone() (*LogInput, error)

+ type LogInputBexpr struct

+ MountPoint string

+ MountType string

+ Namespace string

+ Operation string

+ Path string

+ type MockEvent struct

+ Event *EventData

+ Type EventType

+ type MockEventSender struct

+ Events []MockEvent

+ Stopped bool

+ func NewMockEventSender() *MockEventSender

+ func (m *MockEventSender) SendEvent(_ context.Context, eventType EventType, event *EventData) error

+ func (m *MockEventSender) Stop()

type Paths

+ Binary []string

+ Limited []string

type Request

+ ChrootNamespace string

+ PathLimited bool

+ RequestLimiterDisabled bool

+ type RequestDelegatedAuthError struct

+ func NewDelegatedAuthenticationRequest(mountAccessor, path string, data map[string]interface{}, ...) *RequestDelegatedAuthError

+ func (d *RequestDelegatedAuthError) AuthErrorHandler() DelegatedAuthErrorHandler

+ func (d *RequestDelegatedAuthError) Data() map[string]interface{}

+ func (d *RequestDelegatedAuthError) Error() string

+ func (d *RequestDelegatedAuthError) MountAccessor() string

+ func (d *RequestDelegatedAuthError) Path() string

type StaticSystemView

+ func (d StaticSystemView) GenerateIdentityToken(_ context.Context, _ *pluginutil.IdentityTokenRequest) (*pluginutil.IdentityTokenResponse, error)

type SystemView

+ GenerateIdentityToken func(ctx context.Context, req *pluginutil.IdentityTokenRequest) (*pluginutil.IdentityTokenResponse, error)

+ type WellKnownSystemView interface

+ DeregisterWellKnownRedirect func(ctx context.Context, src string) bool

+ RequestWellKnownRedirect func(ctx context.Context, src, dest string) error

Oct 9, 2023

Changes in this version

+ func AbortableScanView(ctx context.Context, view ClearableView, cb func(path string) (cont bool)) error

type EventReceived

+ func (x *EventReceived) BexprDatum() any

+ type EventReceivedBexpr struct

+ DataPath string

+ EventType string

+ Namespace string

+ Operation string

+ SourcePluginMount string

type HTTPResponse

+ MountType string

type Response

+ MountType string

Sep 5, 2023

Changes in this version

+ const EventMetadataDataPath

+ const EventMetadataModified

+ const EventMetadataOperation

+ func SendEvent(ctx context.Context, sender EventSender, eventType string, ...) error

+ type CtxKeyRequestRole struct

+ func (c CtxKeyRequestRole) String() string

type EventSender

+ SendEvent func(ctx context.Context, eventType EventType, event *EventData) error

type ExtendedSystemView

+ APILockShouldBlockRequest func() (bool, error)

type StaticSystemView

+ APILockShouldBlockRequestVal bool

+ func (d StaticSystemView) APILockShouldBlockRequest() (bool, error)

May 26, 2023

Changes in this version

+ type ACMEBillingSystemView interface

+ CreateActivityCountEventForIdentifiers func(ctx context.Context, identifiers []string) error

type PolicyInfo

+ NamespacePath string

type Request

+ ForwardedFrom string

Apr 7, 2023

Changes in this version

+ const HeaderOperation

type EventReceived

+ func (x *EventReceived) ID() string

type Request

+ func (r *Request) MountClass() string

+ func (r *Request) MountIsExternalPlugin() bool

+ func (r *Request) MountRunningSha256() string

+ func (r *Request) MountRunningVersion() string

+ func (r *Request) SetMountClass(mountClass string)

+ func (r *Request) SetMountIsExternalPlugin(mountIsExternalPlugin bool)

+ func (r *Request) SetMountRunningSha256(mountRunningSha256 string)

+ func (r *Request) SetMountRunningVersion(mountRunningVersion string)

Feb 9, 2023

Changes in this version

+ const PBPWFClusterSentinel

+ var File_sdk_logical_event_proto protoreflect.FileDescriptor

type BackendConfig

+ EventsSender EventSender

+ type EventData struct

+ EntityIds []string

+ Id string

+ Metadata []byte

+ Note string

+ func NewEvent() (*EventData, error)

+ func (*EventData) Descriptor() ([]byte, []int)

+ func (*EventData) ProtoMessage()

+ func (x *EventData) GetEntityIds() []string

+ func (x *EventData) GetId() string

+ func (x *EventData) GetMetadata() []byte

+ func (x *EventData) GetNote() string

+ func (x *EventData) ID() string

+ func (x *EventData) ProtoReflect() protoreflect.Message

+ func (x *EventData) Reset()

+ func (x *EventData) String() string

+ type EventPluginInfo struct

+ MountAccessor string

+ MountClass string

+ MountPath string

+ Plugin string

+ PluginVersion string

+ Version string

+ func (*EventPluginInfo) Descriptor() ([]byte, []int)

+ func (*EventPluginInfo) ProtoMessage()

+ func (x *EventPluginInfo) GetMountAccessor() string

+ func (x *EventPluginInfo) GetMountClass() string

+ func (x *EventPluginInfo) GetMountPath() string

+ func (x *EventPluginInfo) GetPlugin() string

+ func (x *EventPluginInfo) GetPluginVersion() string

+ func (x *EventPluginInfo) GetVersion() string

+ func (x *EventPluginInfo) ProtoReflect() protoreflect.Message

+ func (x *EventPluginInfo) Reset()

+ func (x *EventPluginInfo) String() string

+ type EventReceived struct

+ Event *EventData

+ EventType string

+ Namespace string

+ PluginInfo *EventPluginInfo

+ Timestamp *timestamppb.Timestamp

+ func (*EventReceived) Descriptor() ([]byte, []int)

+ func (*EventReceived) ProtoMessage()

+ func (x *EventReceived) GetEvent() *EventData

+ func (x *EventReceived) GetEventType() string

+ func (x *EventReceived) GetNamespace() string

+ func (x *EventReceived) GetPluginInfo() *EventPluginInfo

+ func (x *EventReceived) GetTimestamp() *timestamppb.Timestamp

+ func (x *EventReceived) ProtoReflect() protoreflect.Message

+ func (x *EventReceived) Reset()

+ func (x *EventReceived) String() string

+ type EventSender interface

+ Send func(ctx context.Context, eventType EventType, event *EventData) error

+ type EventType string

type KeyUsage

+ const KeyUsageGenerateRandom

type MFAMethodID

+ Name string

+ func (x *MFAMethodID) GetName() string

type ManagedEncryptingKey

+ Decrypt func(ctx context.Context, ciphertext []byte, options ...wrapping.Option) ([]byte, error)

+ Encrypt func(ctx context.Context, plaintext []byte, options ...wrapping.Option) ([]byte, error)

type Paths

+ WriteForwardedStorage []string

type StaticSystemView

+ ClusterUUID string

+ func (d StaticSystemView) ClusterID(ctx context.Context) (string, error)

type StatusHeaderResponseWriter

+ func (w *StatusHeaderResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error)

type SystemView

+ ClusterID func(ctx context.Context) (string, error)

Dec 21, 2022

Changes in this version

+ type ManagedKeyRandomSource interface

+ GetRandomBytes func(ctx context.Context, count int) ([]byte, error)

+ type ManagedKeyRandomSourceConsumer func(context.Context, ManagedKeyRandomSource) error

type ManagedKeySystemView

+ WithManagedMACKeyByName func(ctx context.Context, keyName, backendUUID string, f ManagedMACKeyConsumer) error

+ WithManagedMACKeyByUUID func(ctx context.Context, keyUUID, backendUUID string, f ManagedMACKeyConsumer) error

+ type ManagedMACKey interface

+ MAC func(ctx context.Context, algorithm string, data []byte) ([]byte, error)

+ type ManagedMACKeyConsumer func(context.Context, ManagedMACKey) error

type StaticSystemView

+ VersionString string

type SystemView

+ VaultVersion func(context.Context) (string, error)

Oct 31, 2022

Changes in this version

+ var ErrInvalidCredentials = errors.New("invalid credentials")

+ func RespondErrorAndData(w http.ResponseWriter, status int, data interface{}, err error)

Sep 20, 2022

Changes in this version

+ var EmptyPluginVersion = PluginVersion

+ var File_sdk_logical_version_proto protoreflect.FileDescriptor

+ var PluginVersion_ServiceDesc = grpc.ServiceDesc

+ func RegisterPluginVersionServer(s grpc.ServiceRegistrar, srv PluginVersionServer)

+ type Empty struct

+ func (*Empty) Descriptor() ([]byte, []int)

+ func (*Empty) ProtoMessage()

+ func (x *Empty) ProtoReflect() protoreflect.Message

+ func (x *Empty) Reset()

+ func (x *Empty) String() string

+ type Externaler interface

+ IsExternal func() bool

+ type ManagedEncryptingKey interface

+ GetAEAD func(iv []byte) (cipher.AEAD, error)

+ type ManagedEncryptingKeyConsumer func(context.Context, ManagedEncryptingKey) error

type ManagedKeySystemView

+ WithManagedEncryptingKeyByName func(ctx context.Context, keyName, backendUUID string, ...) error

+ WithManagedEncryptingKeyByUUID func(ctx context.Context, keyUuid, backendUUID string, ...) error

+ type PluginVersion struct

+ Version string

+ type PluginVersionClient interface

+ Version func(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*VersionReply, error)

+ func NewPluginVersionClient(cc grpc.ClientConnInterface) PluginVersionClient

+ type PluginVersionServer interface

+ Version func(context.Context, *Empty) (*VersionReply, error)

+ type PluginVersioner interface

+ PluginVersion func() PluginVersion

type StaticSystemView

+ func (d StaticSystemView) ListVersionedPlugins(_ context.Context, _ consts.PluginType) ([]pluginutil.VersionedPlugin, error)

+ func (d StaticSystemView) LookupPluginVersion(_ context.Context, _ string, _ consts.PluginType, _ string) (*pluginutil.PluginRunner, error)

type SystemView

+ ListVersionedPlugins func(ctx context.Context, pluginType consts.PluginType) ([]pluginutil.VersionedPlugin, error)

+ LookupPluginVersion func(ctx context.Context, pluginName string, pluginType consts.PluginType, ...) (*pluginutil.PluginRunner, error)

+ type UnimplementedPluginVersionServer struct

+ func (UnimplementedPluginVersionServer) Version(context.Context, *Empty) (*VersionReply, error)

+ type UnsafePluginVersionServer interface

+ type VersionReply struct

+ PluginVersion string

+ func (*VersionReply) Descriptor() ([]byte, []int)

+ func (*VersionReply) ProtoMessage()

+ func (x *VersionReply) GetPluginVersion() string

+ func (x *VersionReply) ProtoReflect() protoreflect.Message

+ func (x *VersionReply) Reset()

+ func (x *VersionReply) String() string

Jul 14, 2022

Changes in this version

+ const ResolveRoleOperation

type Response

+ func ResolveRoleResponse(roleName string) (*Response, error)

May 25, 2022

Changes in this version

type Auth

+ EntityCreated bool

+ PolicyResults *PolicyResults

type PluginEnvironment

+ VaultVersionMetadata string

+ VaultVersionPrerelease string

+ func (x *PluginEnvironment) GetVaultVersionMetadata() string

+ func (x *PluginEnvironment) GetVaultVersionPrerelease() string

+ type PolicyInfo struct

+ Name string

+ NamespaceId string

+ Type string

+ type PolicyResults struct

+ Allowed bool

+ GrantingPolicies []PolicyInfo

Feb 25, 2022

Changes in this version

type Auth

+ MFARequirement *MFARequirement

type Connection

+ RemotePort int

+ type CtxKeyInFlightRequestID struct

+ func (c CtxKeyInFlightRequestID) String() string

+ type CustomHeader struct

+ Name string

+ Value string

type HTTPAuth

+ MFARequirement *MFARequirement

+ NumUses int

+ type KeyUsage int

+ const KeyUsageDecrypt

+ const KeyUsageEncrypt

+ const KeyUsageSign

+ const KeyUsageUnwrap

+ const KeyUsageVerify

+ const KeyUsageWrap

+ type MFAConstraintAny struct

+ Any []*MFAMethodID

+ func (*MFAConstraintAny) Descriptor() ([]byte, []int)

+ func (*MFAConstraintAny) ProtoMessage()

+ func (x *MFAConstraintAny) GetAny() []*MFAMethodID

+ func (x *MFAConstraintAny) ProtoReflect() protoreflect.Message

+ func (x *MFAConstraintAny) Reset()

+ func (x *MFAConstraintAny) String() string

+ type MFAMethodID struct

+ ID string

+ Type string

+ UsesPasscode bool

+ func (*MFAMethodID) Descriptor() ([]byte, []int)

+ func (*MFAMethodID) ProtoMessage()

+ func (x *MFAMethodID) GetID() string

+ func (x *MFAMethodID) GetType() string

+ func (x *MFAMethodID) GetUsesPasscode() bool

+ func (x *MFAMethodID) ProtoReflect() protoreflect.Message

+ func (x *MFAMethodID) Reset()

+ func (x *MFAMethodID) String() string

+ type MFARequirement struct

+ MFAConstraints map[string]*MFAConstraintAny

+ MFARequestID string

+ func (*MFARequirement) Descriptor() ([]byte, []int)

+ func (*MFARequirement) ProtoMessage()

+ func (x *MFARequirement) GetMFAConstraints() map[string]*MFAConstraintAny

+ func (x *MFARequirement) GetMFARequestID() string

+ func (x *MFARequirement) ProtoReflect() protoreflect.Message

+ func (x *MFARequirement) Reset()

+ func (x *MFARequirement) String() string

+ type ManagedAsymmetricKey interface

+ GetPublicKey func(ctx context.Context) (crypto.PublicKey, error)

+ type ManagedKey interface

+ AllowsAll func(usages []KeyUsage) bool

+ Name func() string

+ Present func(ctx context.Context) (bool, error)

+ UUID func() string

+ type ManagedKeyConsumer func(context.Context, ManagedKey) error

+ type ManagedKeyLifecycle interface

+ GenerateKey func(ctx context.Context) (string, error)

+ type ManagedKeySystemView interface

+ WithManagedKeyByName func(ctx context.Context, keyName, mountPoint string, f ManagedKeyConsumer) error

+ WithManagedKeyByUUID func(ctx context.Context, keyUuid, mountPoint string, f ManagedKeyConsumer) error

+ WithManagedSigningKeyByName func(ctx context.Context, keyName, mountPoint string, f ManagedSigningKeyConsumer) error

+ WithManagedSigningKeyByUUID func(ctx context.Context, keyUuid, mountPoint string, f ManagedSigningKeyConsumer) error

+ type ManagedSigningKey interface

+ GetSigner func(context.Context) (crypto.Signer, error)

+ Sign func(ctx context.Context, value []byte, randomSource io.Reader, ...) ([]byte, error)

+ Verify func(ctx context.Context, signature, value []byte, opts crypto.SignerOpts) (bool, error)

+ type ManagedSigningKeyConsumer func(context.Context, ManagedSigningKey) error

type Request

+ InboundSSCToken string

type StaticSystemView

+ func (d StaticSystemView) NewPluginClient(ctx context.Context, config pluginutil.PluginClientConfig) (pluginutil.PluginClient, error)

+ type StatusHeaderResponseWriter struct

+ StatusCode int

+ func NewStatusHeaderResponseWriter(w http.ResponseWriter, h map[string][]*CustomHeader) *StatusHeaderResponseWriter

+ func (w *StatusHeaderResponseWriter) Header() http.Header

+ func (w *StatusHeaderResponseWriter) Wrapped() http.ResponseWriter

+ func (w *StatusHeaderResponseWriter) Write(buf []byte) (int, error)

+ func (w *StatusHeaderResponseWriter) WriteHeader(statusCode int)

type SystemView

+ NewPluginClient func(ctx context.Context, config pluginutil.PluginClientConfig) (pluginutil.PluginClient, error)

type TokenEntry

+ ExternalID string

+ func (te *TokenEntry) CreateClientID() (string, bool)

type TokenType

+ const ClientIDTWEDelimiter

+ const SortedPoliciesTWEDelimiter

+ type WrappingResponseWriter interface

+ Wrapped func() http.ResponseWriter

Oct 27, 2021

Changes in this version

+ const HTTPCacheControlHeader

+ const HTTPPragmaHeader

+ const HTTPWWWAuthenticateHeader

+ const PatchOperation

+ var ErrPathFunctionalityRemoved = errors.New("functionality on this path has been removed")

type Alias

+ CustomMetadata map[string]string

+ Local bool

+ func (x *Alias) GetCustomMetadata() map[string]string

+ func (x *Alias) GetLocal() bool

type Request

+ ClientID string

type TokenEntry

+ InlinePolicy string

+ InternalMeta map[string]string

+ NoIdentityPolicies bool

+ func (te *TokenEntry) IsRoot() bool

Jul 13, 2021

Changes in this version

+ var ErrMissingRequiredState = errors.New("required index state not present")

+ var ErrUnrecoverable = errors.New("unrecoverable error")

type Request

+ func (r *Request) RequiredState() []string

+ func (r *Request) SetRequiredState(state []string)

Mar 30, 2021

Changes in this version

+ var ErrLeaseCountQuotaExceeded = errors.New("lease count quota exceeded")

+ var ErrRateLimitQuotaExceeded = errors.New("rate limit quota exceeded")

+ var File_sdk_logical_identity_proto protoreflect.FileDescriptor

+ var File_sdk_logical_plugin_proto protoreflect.FileDescriptor

+ func IndexStateContext(ctx context.Context, state *WALState) context.Context

type Alias

+ ID string

+ NamespaceID string

+ func (x *Alias) GetID() string

+ func (x *Alias) GetNamespaceID() string

+ func (x *Alias) ProtoReflect() protoreflect.Message

type Entity

+ NamespaceID string

+ func (x *Entity) GetNamespaceID() string

+ func (x *Entity) ProtoReflect() protoreflect.Message

+ type Group struct

+ ID string

+ Metadata map[string]string

+ Name string

+ NamespaceID string

+ func (*Group) Descriptor() ([]byte, []int)

+ func (*Group) ProtoMessage()

+ func (x *Group) GetID() string

+ func (x *Group) GetMetadata() map[string]string

+ func (x *Group) GetName() string

+ func (x *Group) GetNamespaceID() string

+ func (x *Group) ProtoReflect() protoreflect.Message

+ func (x *Group) Reset()

+ func (x *Group) String() string

type InmemStorage

+ func (s *InmemStorage) FailDelete(fail bool) *InmemStorage

+ func (s *InmemStorage) FailGet(fail bool) *InmemStorage

+ func (s *InmemStorage) FailList(fail bool) *InmemStorage

+ func (s *InmemStorage) FailPut(fail bool) *InmemStorage

+ type PasswordGenerator func() (password string, err error)

+ type PasswordPolicy interface

+ Generate func(context.Context, io.Reader) (string, error)

type PluginEnvironment

+ func (x *PluginEnvironment) ProtoReflect() protoreflect.Message

type Request

+ HTTPRequest *http.Request

+ func (r *Request) Clone() (*Request, error)

+ func (r *Request) ResponseState() *WALState

+ func (r *Request) SetResponseState(w *WALState)

type StaticSystemView

+ GroupsVal []*Group

+ PasswordPolicies map[string]PasswordGenerator

+ func (d *StaticSystemView) DeletePasswordPolicy(name string) (existed bool)

+ func (d *StaticSystemView) SetPasswordPolicy(name string, generator PasswordGenerator)

+ func (d StaticSystemView) GeneratePasswordFromPolicy(ctx context.Context, policyName string) (password string, err error)

+ func (d StaticSystemView) GroupsForEntity(entityID string) ([]*Group, error)

type SystemView

+ GeneratePasswordFromPolicy func(ctx context.Context, policyName string) (password string, err error)

+ GroupsForEntity func(entityID string) ([]*Group, error)

type TokenType

+ func (t *TokenType) UnmarshalJSON(b []byte) error

+ type WALState struct

+ ClusterID string

+ LocalIndex uint64

+ ReplicatedIndex uint64

+ func IndexStateFromContext(ctx context.Context) *WALState

Jul 25, 2019

Changes in this version

+ const HTTPRawCacheControl

+ func ClearViewWithLogging(ctx context.Context, view ClearableView, logger hclog.Logger) error

+ type Auditor interface

+ AuditRequest func(ctx context.Context, input *LogInput) error

+ AuditResponse func(ctx context.Context, input *LogInput) error

type Auth

+ NoDefaultPolicy bool

type Backend

+ Initialize func(context.Context, *InitializationRequest) error

type Entity

+ Disabled bool

+ func (m *Entity) GetDisabled() bool

+ type ExtendedSystemView interface

+ Auditor func() Auditor

+ ForwardGenericRequest func(context.Context, *Request) (*Response, error)

+ type HTTPResponseWriter struct

+ func NewHTTPResponseWriter(w io.Writer) *HTTPResponseWriter

+ func (rw *HTTPResponseWriter) Write(bytes []byte) (int, error)

+ func (rw *HTTPResponseWriter) Written() bool

+ type InitializationRequest struct

+ Storage Storage

type Request

+ RequestReader io.ReadCloser

+ ResponseWriter *HTTPResponseWriter

type StaticSystemView

+ func (d StaticSystemView) Auditor() Auditor

+ func (d StaticSystemView) ForwardGenericRequest(ctx context.Context, req *Request) (*Response, error)

May 15, 2019

Changes in this version

+ type LogInput struct

+ Auth *Auth

+ NonHMACReqDataKeys []string

+ NonHMACRespDataKeys []string

+ OuterErr error

+ Request interface{}

+ Response interface{}

+ Type string

+ type MarshalOptions struct

+ ValueHasher func(string) string

+ type OptMarshaler interface

+ MarshalJSONWithOptions func(*MarshalOptions) ([]byte, error)

May 8, 2019

Changes in this version

+ func CollectKeysWithPrefix(ctx context.Context, view ClearableView, prefix string) ([]string, error)

Apr 15, 2019

Changes in this version

+ const AliasLookaheadOperation

+ const CreateOperation

+ const DeleteOperation

+ const HTTPContentType

+ const HTTPRawBody

+ const HTTPRawBodyAlreadyJSONDecoded

+ const HTTPStatusCode

+ const HelpOperation

+ const ListOperation

+ const ReadOperation

+ const RenewOperation

+ const RevokeOperation

+ const RollbackOperation

+ const UpdateOperation

+ var ErrInvalidRequest = errors.New("invalid request")

+ var ErrMultiAuthzPending = errors.New("request needs further approval")

+ var ErrPerfStandbyPleaseForward = errors.New("please forward to the active node")

+ var ErrPermissionDenied = errors.New("permission denied")

+ var ErrReadOnly = errors.New("cannot write to readonly storage")

+ var ErrRelativePath = errors.New("relative paths not supported")

+ var ErrSetupReadOnly = errors.New("cannot write to storage during setup")

+ var ErrUnsupportedOperation = errors.New("unsupported operation")

+ var ErrUnsupportedPath = errors.New("unsupported path")

+ var ErrUpstreamRateLimited = errors.New("upstream rate limited")

+ func AdjustErrorStatusCode(status *int, err error)

+ func ClearView(ctx context.Context, view ClearableView) error

+ func CollectKeys(ctx context.Context, view ClearableView) ([]string, error)

+ func RespondError(w http.ResponseWriter, status int, err error)

+ func RespondErrorCommon(req *Request, resp *Response, err error) (int, error)

+ func ScanView(ctx context.Context, view ClearableView, cb func(path string)) error

+ func TestStorage(t testing.T, s Storage)

+ type Alias struct

+ Metadata map[string]string

+ MountAccessor string

+ MountType string

+ Name string

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ func (*Alias) Descriptor() ([]byte, []int)

+ func (*Alias) ProtoMessage()

+ func (m *Alias) GetMetadata() map[string]string

+ func (m *Alias) GetMountAccessor() string

+ func (m *Alias) GetMountType() string

+ func (m *Alias) GetName() string

+ func (m *Alias) Reset()

+ func (m *Alias) String() string

+ func (m *Alias) XXX_DiscardUnknown()

+ func (m *Alias) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *Alias) XXX_Merge(src proto.Message)

+ func (m *Alias) XXX_Size() int

+ func (m *Alias) XXX_Unmarshal(b []byte) error

+ type Auth struct

+ Accessor string

+ Alias *Alias

+ BoundCIDRs []*sockaddr.SockAddrMarshaler

+ ClientToken string

+ CreationPath string

+ DisplayName string

+ EntityID string

+ ExplicitMaxTTL time.Duration

+ ExternalNamespacePolicies map[string][]string

+ GroupAliases []*Alias

+ IdentityPolicies []string

+ InternalData map[string]interface{}

+ Metadata map[string]string

+ NumUses int

+ Orphan bool

+ Period time.Duration

+ Policies []string

+ TokenPolicies []string

+ TokenType TokenType

+ func (a *Auth) GoString() string

+ type Authz struct

+ AuthorizationTime time.Time

+ Token string

+ type Backend interface

+ Cleanup func(context.Context)

+ HandleExistenceCheck func(context.Context, *Request) (bool, bool, error)

+ HandleRequest func(context.Context, *Request) (*Response, error)

+ InvalidateKey func(context.Context, string)

+ Logger func() log.Logger

+ Setup func(context.Context, *BackendConfig) error

+ SpecialPaths func() *Paths

+ System func() SystemView

+ Type func() BackendType

+ type BackendConfig struct

+ BackendUUID string

+ Config map[string]string

+ Logger log.Logger

+ StorageView Storage

+ System SystemView

+ func TestBackendConfig() *BackendConfig

+ type BackendType uint32

+ const TypeCredential

+ const TypeLogical

+ const TypeUnknown

+ func (b BackendType) String() string

+ type ClearableView interface

+ Delete func(context.Context, string) error

+ List func(context.Context, string) ([]string, error)

+ type ClientTokenSource uint32

+ const ClientTokenFromAuthzHeader

+ const ClientTokenFromVaultHeader

+ const NoClientToken

+ type Connection struct

+ ConnState *tls.ConnectionState

+ RemoteAddr string

+ type ControlGroup struct

+ Approved bool

+ Authorizations []*Authz

+ NamespaceID string

+ RequestTime time.Time

+ type Entity struct

+ Aliases []*Alias

+ ID string

+ Metadata map[string]string

+ Name string

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ func (*Entity) Descriptor() ([]byte, []int)

+ func (*Entity) ProtoMessage()

+ func (m *Entity) GetAliases() []*Alias

+ func (m *Entity) GetID() string

+ func (m *Entity) GetMetadata() map[string]string

+ func (m *Entity) GetName() string

+ func (m *Entity) Reset()

+ func (m *Entity) String() string

+ func (m *Entity) XXX_DiscardUnknown()

+ func (m *Entity) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *Entity) XXX_Merge(src proto.Message)

+ func (m *Entity) XXX_Size() int

+ func (m *Entity) XXX_Unmarshal(b []byte) error

+ type Factory func(context.Context, *BackendConfig) (Backend, error)

+ type HTTPAuth struct

+ Accessor string

+ ClientToken string

+ EntityID string

+ IdentityPolicies []string

+ LeaseDuration int

+ Metadata map[string]string

+ Orphan bool

+ Policies []string

+ Renewable bool

+ TokenPolicies []string

+ TokenType string

+ type HTTPCodedError interface

+ Code func() int

+ Error func() string

+ func CodedError(status int, msg string) HTTPCodedError

+ type HTTPResponse struct

+ Auth *HTTPAuth

+ Data map[string]interface{}

+ Headers map[string][]string

+ LeaseDuration int

+ LeaseID string

+ Renewable bool

+ RequestID string

+ Warnings []string

+ WrapInfo *HTTPWrapInfo

+ func LogicalResponseToHTTPResponse(input *Response) *HTTPResponse

+ type HTTPSysInjector struct

+ Response *HTTPResponse

+ func (h HTTPSysInjector) MarshalJSON() ([]byte, error)

+ type HTTPWrapInfo struct

+ Accessor string

+ CreationPath string

+ CreationTime string

+ TTL int

+ Token string

+ WrappedAccessor string

+ type InmemStorage struct

+ func (s *InmemStorage) Delete(ctx context.Context, key string) error

+ func (s *InmemStorage) Get(ctx context.Context, key string) (*StorageEntry, error)

+ func (s *InmemStorage) List(ctx context.Context, prefix string) ([]string, error)

+ func (s *InmemStorage) Put(ctx context.Context, entry *StorageEntry) error

+ func (s *InmemStorage) Underlying() *inmem.InmemBackend

+ type KeyNotFoundError struct

+ Err error

+ func (e *KeyNotFoundError) Error() string

+ func (e *KeyNotFoundError) WrappedErrors() []error

+ type LeaseOptions struct

+ Increment time.Duration

+ IssueTime time.Time

+ MaxTTL time.Duration

+ Renewable bool

+ TTL time.Duration

+ func (l *LeaseOptions) ExpirationTime() time.Time

+ func (l *LeaseOptions) LeaseEnabled() bool

+ func (l *LeaseOptions) LeaseTotal() time.Duration

+ type LogicalStorage struct

+ func NewLogicalStorage(underlying physical.Backend) *LogicalStorage

+ func (s *LogicalStorage) Delete(ctx context.Context, key string) error

+ func (s *LogicalStorage) Get(ctx context.Context, key string) (*StorageEntry, error)

+ func (s *LogicalStorage) List(ctx context.Context, prefix string) ([]string, error)

+ func (s *LogicalStorage) Put(ctx context.Context, entry *StorageEntry) error

+ func (s *LogicalStorage) Underlying() physical.Backend

+ type MFACreds map[string][]string

+ type Operation string

+ type Paths struct

+ LocalStorage []string

+ Root []string

+ SealWrapStorage []string

+ Unauthenticated []string

+ type PluginEnvironment struct

+ VaultVersion string

+ XXX_NoUnkeyedLiteral struct{}

+ XXX_sizecache int32

+ XXX_unrecognized []byte

+ func (*PluginEnvironment) Descriptor() ([]byte, []int)

+ func (*PluginEnvironment) ProtoMessage()

+ func (m *PluginEnvironment) GetVaultVersion() string

+ func (m *PluginEnvironment) Reset()

+ func (m *PluginEnvironment) String() string

+ func (m *PluginEnvironment) XXX_DiscardUnknown()

+ func (m *PluginEnvironment) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

+ func (m *PluginEnvironment) XXX_Merge(src proto.Message)

+ func (m *PluginEnvironment) XXX_Size() int

+ func (m *PluginEnvironment) XXX_Unmarshal(b []byte) error

+ type ReplicationCodedError struct

+ Code int

+ Msg string

+ func (r *ReplicationCodedError) Error() string

+ type Request struct

+ Auth *Auth

+ ClientToken string

+ ClientTokenAccessor string

+ ClientTokenRemainingUses int

+ ClientTokenSource ClientTokenSource

+ Connection *Connection

+ ControlGroup *ControlGroup

+ Data map[string]interface{}

+ DisplayName string

+ EntityID string

+ Headers map[string][]string

+ ID string

+ MFACreds MFACreds

+ MountAccessor string

+ MountPoint string

+ MountType string

+ Operation Operation

+ Path string

+ PolicyOverride bool

+ ReplicationCluster string

+ Secret *Secret

+ Storage Storage

+ Unauthenticated bool

+ WrapInfo *RequestWrapInfo

+ func RenewAuthRequest(path string, auth *Auth, data map[string]interface{}) *Request

+ func RenewRequest(path string, secret *Secret, data map[string]interface{}) *Request

+ func RevokeRequest(path string, secret *Secret, data map[string]interface{}) *Request

+ func RollbackRequest(path string) *Request

+ func TestRequest(t testing.T, op Operation, path string) *Request

+ func (r *Request) Get(key string) interface{}

+ func (r *Request) GetString(key string) string

+ func (r *Request) GoString() string

+ func (r *Request) LastRemoteWAL() uint64

+ func (r *Request) SentinelGet(key string) (interface{}, error)

+ func (r *Request) SentinelKeys() []string

+ func (r *Request) SetLastRemoteWAL(last uint64)

+ func (r *Request) SetTokenEntry(te *TokenEntry)

+ func (r *Request) TokenEntry() *TokenEntry

+ type RequestWrapInfo struct

+ Format string

+ SealWrap bool

+ TTL time.Duration

+ func (r *RequestWrapInfo) SentinelGet(key string) (interface{}, error)

+ func (r *RequestWrapInfo) SentinelKeys() []string

+ type Response struct

+ Auth *Auth

+ Data map[string]interface{}

+ Headers map[string][]string

+ Redirect string

+ Secret *Secret

+ Warnings []string

+ WrapInfo *wrapping.ResponseWrapInfo

+ func ErrorResponse(text string, vargs ...interface{}) *Response

+ func HTTPResponseToLogicalResponse(input *HTTPResponse) *Response

+ func HelpResponse(text string, seeAlso []string, oapiDoc interface{}) *Response

+ func ListResponse(keys []string) *Response

+ func ListResponseWithInfo(keys []string, keyInfo map[string]interface{}) *Response

+ func RespondWithStatusCode(resp *Response, req *Request, code int) (*Response, error)

+ func (r *Response) AddWarning(warning string)

+ func (r *Response) Error() error

+ func (r *Response) IsError() bool

+ type Secret struct

+ InternalData map[string]interface{}

+ LeaseID string

+ func (s *Secret) GoString() string

+ func (s *Secret) Validate() error

+ type StaticSystemView struct

+ CachingDisabledVal bool

+ DefaultLeaseTTLVal time.Duration

+ EnableMlock bool

+ EntityVal *Entity

+ Features license.Features

+ LocalMountVal bool

+ MaxLeaseTTLVal time.Duration

+ PluginEnvironment *PluginEnvironment

+ Primary bool

+ ReplicationStateVal consts.ReplicationState

+ SudoPrivilegeVal bool

+ TaintedVal bool

+ VaultVersion string

+ func TestSystemView() *StaticSystemView

+ func (d StaticSystemView) CachingDisabled() bool

+ func (d StaticSystemView) DefaultLeaseTTL() time.Duration

+ func (d StaticSystemView) EntityInfo(entityID string) (*Entity, error)

+ func (d StaticSystemView) HasFeature(feature license.Features) bool

+ func (d StaticSystemView) LocalMount() bool

+ func (d StaticSystemView) LookupPlugin(_ context.Context, _ string, _ consts.PluginType) (*pluginutil.PluginRunner, error)

+ func (d StaticSystemView) MaxLeaseTTL() time.Duration

+ func (d StaticSystemView) MlockEnabled() bool

+ func (d StaticSystemView) PluginEnv(_ context.Context) (*PluginEnvironment, error)

+ func (d StaticSystemView) ReplicationState() consts.ReplicationState

+ func (d StaticSystemView) ResponseWrapData(_ context.Context, data map[string]interface{}, ttl time.Duration, jwt bool) (*wrapping.ResponseWrapInfo, error)

+ func (d StaticSystemView) SudoPrivilege(_ context.Context, path string, token string) bool

+ func (d StaticSystemView) Tainted() bool

+ type StatusBadRequest struct

+ Err string

+ func (s *StatusBadRequest) Error() string

+ type Storage interface

+ Delete func(context.Context, string) error

+ Get func(context.Context, string) (*StorageEntry, error)

+ List func(context.Context, string) ([]string, error)

+ Put func(context.Context, *StorageEntry) error

+ type StorageEntry struct

+ Key string

+ SealWrap bool

+ Value []byte

+ func StorageEntryJSON(k string, v interface{}) (*StorageEntry, error)

+ func (e *StorageEntry) DecodeJSON(out interface{}) error

+ type StorageView struct

+ func NewStorageView(storage Storage, prefix string) *StorageView

+ func (s *StorageView) Delete(ctx context.Context, key string) error

+ func (s *StorageView) ExpandKey(suffix string) string

+ func (s *StorageView) Get(ctx context.Context, key string) (*StorageEntry, error)

+ func (s *StorageView) List(ctx context.Context, prefix string) ([]string, error)

+ func (s *StorageView) Prefix() string

+ func (s *StorageView) Put(ctx context.Context, entry *StorageEntry) error

+ func (s *StorageView) SanityCheck(key string) error

+ func (s *StorageView) SubView(prefix string) *StorageView

+ func (s *StorageView) TruncateKey(full string) string

+ type SystemView interface

+ CachingDisabled func() bool

+ DefaultLeaseTTL func() time.Duration

+ EntityInfo func(entityID string) (*Entity, error)

+ HasFeature func(feature license.Features) bool

+ LocalMount func() bool

+ LookupPlugin func(context.Context, string, consts.PluginType) (*pluginutil.PluginRunner, error)

+ MaxLeaseTTL func() time.Duration

+ MlockEnabled func() bool

+ PluginEnv func(context.Context) (*PluginEnvironment, error)

+ ReplicationState func() consts.ReplicationState

+ ResponseWrapData func(ctx context.Context, data map[string]interface{}, ttl time.Duration, jwt bool) (*wrapping.ResponseWrapInfo, error)

+ SudoPrivilege func(ctx context.Context, path string, token string) bool

+ Tainted func() bool

+ type TokenEntry struct

+ Accessor string

+ BoundCIDRs []*sockaddr.SockAddrMarshaler

+ CreationTime int64

+ CreationTimeDeprecated int64

+ CubbyholeID string

+ DisplayName string

+ DisplayNameDeprecated string

+ EntityID string

+ ExplicitMaxTTL time.Duration

+ ExplicitMaxTTLDeprecated time.Duration

+ ID string

+ Meta map[string]string

+ NamespaceID string

+ NumUses int

+ NumUsesDeprecated int

+ Parent string

+ Path string

+ Period time.Duration

+ Policies []string

+ Role string

+ TTL time.Duration

+ Type TokenType

+ func (te *TokenEntry) SentinelGet(key string) (interface{}, error)

+ func (te *TokenEntry) SentinelKeys() []string

+ type TokenType uint8

+ const TokenTypeBatch

+ const TokenTypeDefault

+ const TokenTypeDefaultBatch

+ const TokenTypeDefaultService

+ const TokenTypeService

+ func (t TokenType) String() string