import "github.com/hashicorp/vault/vendor/github.com/hashicorp/vault-plugin-secrets-kv"
backend.go delete_version_after.go passthrough.go path_config.go path_data.go path_delete.go path_destroy.go path_metadata.go types.pb.go upgrade.go
Factory will return a logical backend of type versionedKVBackend or PassthroughBackend based on the config passed in.
func LeaseSwitchedPassthroughBackend(ctx context.Context, conf *logical.BackendConfig, leases bool) (logical.Backend, error)
LeaseSwitchedPassthroughBackend returns a PassthroughBackend with leases switched on or off
func LeasedPassthroughBackendFactory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)
LeasedPassthroughBackendFactory returns a PassthroughBackend with leases switched on
func PassthroughBackendFactory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)
PassthroughBackendFactory returns a PassthroughBackend with leases switched off
Factory returns a new backend as logical.Backend.
type Configuration struct { MaxVersions uint32 `protobuf:"varint,1,opt,name=max_versions,json=maxVersions,proto3" json:"max_versions,omitempty"` CasRequired bool `protobuf:"varint,2,opt,name=cas_required,json=casRequired,proto3" json:"cas_required,omitempty"` DeleteVersionAfter *duration.Duration `protobuf:"bytes,3,opt,name=delete_version_after,json=deleteVersionAfter,proto3" json:"delete_version_after,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
If values are added to this, be sure to update the config() function
func (*Configuration) Descriptor() ([]byte, []int)
func (c *Configuration) DisableDeleteVersionAfter()
DisableDeleteVersionAfter disables DeleteVersionAfter.
func (m *Configuration) GetCasRequired() bool
func (m *Configuration) GetDeleteVersionAfter() *duration.Duration
func (m *Configuration) GetMaxVersions() uint32
func (c *Configuration) IsDeleteVersionAfterDisabled() bool
IsDeleteVersionAfterDisabled returns true if DeleteVersionAfter is disabled.
func (*Configuration) ProtoMessage()
func (m *Configuration) Reset()
func (c *Configuration) ResetDeleteVersionAfter()
ResetDeleteVersionAfter resets the DeleteVersionAfter to the default value.
func (m *Configuration) String() string
func (m *Configuration) XXX_DiscardUnknown()
func (m *Configuration) XXX_Merge(src proto.Message)
func (m *Configuration) XXX_Size() int
func (m *Configuration) XXX_Unmarshal(b []byte) error
type KeyMetadata struct { // Key is the key for this entry Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Versions is the map of versionID -> VersionMetadata. // Useful when listing all versions. Versions map[uint64]*VersionMetadata `protobuf:"bytes,2,rep,name=versions,proto3" json:"versions,omitempty" protobuf_key:"varint,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` // CurrentVersion is the latest version of the value CurrentVersion uint64 `protobuf:"varint,3,opt,name=current_version,json=currentVersion,proto3" json:"current_version,omitempty"` // OldestVersion is the oldest version of the value. OldestVersion uint64 `protobuf:"varint,4,opt,name=oldest_version,json=oldestVersion,proto3" json:"oldest_version,omitempty"` // Created time is when the metadata was created. CreatedTime *timestamp.Timestamp `protobuf:"bytes,5,opt,name=created_time,json=createdTime,proto3" json:"created_time,omitempty"` // Updated time was the last time the metadata version // was updated. UpdatedTime *timestamp.Timestamp `protobuf:"bytes,6,opt,name=updated_time,json=updatedTime,proto3" json:"updated_time,omitempty"` // MaxVersions specifies how many versions to keep around. // If empty value, defaults to the configured Max // for the mount. MaxVersions uint32 `protobuf:"varint,7,opt,name=max_versions,json=maxVersions,proto3" json:"max_versions,omitempty"` // CasRequired specifies if the cas parameter is // required for this key CasRequired bool `protobuf:"varint,8,opt,name=cas_required,json=casRequired,proto3" json:"cas_required,omitempty"` // DeleteVersionAfter specifies how long to keep versions around. If // empty value, defaults to the configured delete_version_after for the // mount. DeleteVersionAfter *duration.Duration `protobuf:"bytes,9,opt,name=delete_version_after,json=deleteVersionAfter,proto3" json:"delete_version_after,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (k *KeyMetadata) AddVersion(createdTime, deletionTime *timestamp.Timestamp, configMaxVersions uint32) (*VersionMetadata, uint64)
AddVersion adds a version to the key metadata and moves the sliding window of max versions. It returns the newly added version and the version to delete from storage.
func (*KeyMetadata) Descriptor() ([]byte, []int)
func (m *KeyMetadata) GetCasRequired() bool
func (m *KeyMetadata) GetCreatedTime() *timestamp.Timestamp
func (m *KeyMetadata) GetCurrentVersion() uint64
func (m *KeyMetadata) GetDeleteVersionAfter() *duration.Duration
func (m *KeyMetadata) GetKey() string
func (m *KeyMetadata) GetMaxVersions() uint32
func (m *KeyMetadata) GetOldestVersion() uint64
func (m *KeyMetadata) GetUpdatedTime() *timestamp.Timestamp
func (m *KeyMetadata) GetVersions() map[uint64]*VersionMetadata
func (*KeyMetadata) ProtoMessage()
func (m *KeyMetadata) Reset()
func (m *KeyMetadata) String() string
func (m *KeyMetadata) XXX_DiscardUnknown()
func (m *KeyMetadata) XXX_Merge(src proto.Message)
func (m *KeyMetadata) XXX_Size() int
func (m *KeyMetadata) XXX_Unmarshal(b []byte) error
type Passthrough interface {
// contains filtered or unexported methods
}
PassthroughBackend is used storing secrets directly into the physical backend. The secrets are encrypted in the durable storage and custom TTL information can be specified, but otherwise this backend doesn't do anything fancy.
func (b *PassthroughBackend) GeneratesLeases() bool
type UpgradeInfo struct { // Started time is when the upgrade was started. StartedTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=started_time,json=startedTime,proto3" json:"started_time,omitempty"` // done is set to true once the backend has been successfully // upgraded. Done bool `protobuf:"varint,2,opt,name=done,proto3" json:"done,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*UpgradeInfo) Descriptor() ([]byte, []int)
func (m *UpgradeInfo) GetDone() bool
func (m *UpgradeInfo) GetStartedTime() *timestamp.Timestamp
func (*UpgradeInfo) ProtoMessage()
func (m *UpgradeInfo) Reset()
func (m *UpgradeInfo) String() string
func (m *UpgradeInfo) XXX_DiscardUnknown()
func (m *UpgradeInfo) XXX_Merge(src proto.Message)
func (m *UpgradeInfo) XXX_Size() int
func (m *UpgradeInfo) XXX_Unmarshal(b []byte) error
type Version struct { // Data is a JSON object with string keys that // represents the user supplied data. Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"` // CreatedTime is when the version was created. CreatedTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=created_time,json=createdTime,proto3" json:"created_time,omitempty"` // DeletionTime is the time this version becomes invalid. // Set to Now() to delete the version before the configured // deletion time. DeletionTime *timestamp.Timestamp `protobuf:"bytes,3,opt,name=deletion_time,json=deletionTime,proto3" json:"deletion_time,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
type VersionMetadata struct { // CreatedTime is when the version was created. CreatedTime *timestamp.Timestamp `protobuf:"bytes,1,opt,name=created_time,json=createdTime,proto3" json:"created_time,omitempty"` // DeletionTime is the time this version becomes invalid. // Set to Now() to delete the version before the configured // delete time. DeletionTime *timestamp.Timestamp `protobuf:"bytes,2,opt,name=deletion_time,json=deletionTime,proto3" json:"deletion_time,omitempty"` // Destroyed is used to specify this version is // a has been removed and the underlying data deleted. Destroyed bool `protobuf:"varint,3,opt,name=destroyed,proto3" json:"destroyed,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*VersionMetadata) Descriptor() ([]byte, []int)
func (m *VersionMetadata) GetCreatedTime() *timestamp.Timestamp
func (m *VersionMetadata) GetDeletionTime() *timestamp.Timestamp
func (m *VersionMetadata) GetDestroyed() bool
func (*VersionMetadata) ProtoMessage()
func (m *VersionMetadata) Reset()
func (m *VersionMetadata) String() string
func (m *VersionMetadata) XXX_DiscardUnknown()
func (m *VersionMetadata) XXX_Merge(src proto.Message)
func (m *VersionMetadata) XXX_Size() int
func (m *VersionMetadata) XXX_Unmarshal(b []byte) error
Package kv imports 26 packages (graph). Updated 2020-07-07. Refresh now. Tools for package owners.