framework

package

Go to main page

Versions in this module

v0

v0.14.1

Jan 9, 2025

Changes in this version

type Backend

+ RotateCredential func(context.Context, *logical.Request) error

v0.14.0

Sep 10, 2024

v0.13.0

May 23, 2024

v0.12.0

Apr 11, 2024

v0.11.1

Mar 13, 2024

v0.11.0

Feb 8, 2024

v0.10.2

Oct 9, 2023

v0.10.1

Oct 9, 2023

v0.10.0

Sep 5, 2023

v0.9.2

Jul 25, 2023

Changes in this version

+ var OASStdRespListOK = &OASResponse

+ var OASStdSchemaStandardListResponse = &OASSchema

type Backend

+ func (b *Backend) WriteSafeReplicationState() bool

type OASSchema

+ AdditionalProperties interface{}

v0.9.1

May 26, 2023

Changes in this version

type DisplayAttributes

+ Description string

v0.9.0

Apr 7, 2023

Changes in this version

type DisplayAttributes

+ OperationPrefix string

+ OperationSuffix string

+ OperationVerb string

type PathOperation

+ DisplayAttrs *DisplayAttributes

v0.8.1

Feb 10, 2023

v0.8.0

Feb 9, 2023

Changes in this version

+ var ErrNoEvents = errors.New("no event sender configured")

type Backend

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

v0.7.0

Jan 13, 2023

Changes in this version

type FieldData

+ func (d *FieldData) ValidateStrict() error

v0.6.2

Dec 21, 2022

Changes in this version

type OASRequestBody

+ Required bool

type Response

+ Fields map[string]*FieldSchema

v0.6.1

Oct 31, 2022

v0.6.0

Sep 20, 2022

Changes in this version

type Backend

+ RunningVersion string

+ func (b *Backend) PluginVersion() logical.PluginVersion

type Path

+ TakesArbitraryInput bool

v0.5.3

Jul 14, 2022

v0.5.2

Jun 13, 2022

v0.5.1

Jun 9, 2022

v0.5.0

May 25, 2022

Changes in this version

+ type OASComponents struct

+ Schemas map[string]*OASSchema

type OASDocument

+ Components OASComponents

type OASSchema

+ Ref string

v0.4.1

Feb 25, 2022

v0.4.0

Feb 25, 2022

v0.3.0

Oct 27, 2021

Changes in this version

+ func HandlePatchOperation(input *FieldData, resource map[string]interface{}, ...) ([]byte, error)

+ type PatchPreprocessorFunc func(map[string]interface{}) (map[string]interface{}, error)

v0.2.1

Jul 13, 2021

Changes in this version

type FieldType

+ const TypeInt64

v0.2.0

Mar 30, 2021

Changes in this version

+ func PopulateIdentityTemplate(tpl string, entityID string, sysView logical.SystemView) (string, error)

+ func ValidateIdentityTemplate(tpl string) (bool, error)

type Backend

+ func (b *Backend) GetRandomReader() io.Reader

type DisplayAttributes

+ EditType string

+ ItemType string

type FieldType

+ const TypeFloat

+ const TypeTime

type OperationFunc

+ func GlobListFilter(fieldName string, callback OperationFunc) OperationFunc

type OperationProperties

+ ForwardPerformanceSecondary bool

+ ForwardPerformanceStandby bool

type PathOperation

+ ForwardPerformanceSecondary bool

+ ForwardPerformanceStandby bool

v0.1.13

Jul 25, 2019

v0.1.12

Jul 25, 2019

Changes in this version

type Backend

+ InitializeFunc InitializeFunc

+ func (b *Backend) Initialize(ctx context.Context, req *logical.InitializationRequest) error

+ type DisplayAttributes struct

+ Action string

+ Group string

+ Name string

+ Navigation bool

+ Sensitive bool

+ Value interface{}

type FieldSchema

+ DisplayAttrs *DisplayAttributes

type FieldType

+ const TypeSignedDurationSecond

+ type InitializeFunc func(context.Context, *logical.InitializationRequest) error

type OASPathItem

+ DisplayAttrs *DisplayAttributes

+ DisplayNavigation bool

type OASSchema

+ DisplayAttrs *DisplayAttributes

+ DisplayGroup string

type OperationProperties

+ DisplayAttrs *DisplayAttributes

type Path

+ DisplayAttrs *DisplayAttributes

v0.1.11

May 15, 2019

v0.1.10

May 8, 2019

v0.1.9

Apr 15, 2019

v0.1.8

Apr 15, 2019

Changes in this version

+ const OASVersion

+ const WALPrefix

+ var OASStdRespNoContent = &OASResponse

+ var OASStdRespOK = &OASResponse

+ func CalculateTTL(sysView logical.SystemView, ...) (ttl time.Duration, warnings []string, errors error)

+ func DeleteWAL(ctx context.Context, s logical.Storage, id string) error

+ func GenericNameRegex(name string) string

+ func GenericNameWithAtRegex(name string) string

+ func ListWAL(ctx context.Context, s logical.Storage) ([]string, error)

+ func MatchAllRegex(name string) string

+ func OptionalParamRegex(name string) string

+ func PutWAL(ctx context.Context, s logical.Storage, kind string, data interface{}) (string, error)

+ func TestBackendRoutes(t *testing.T, b *Backend, rs []string)

+ type Backend struct

+ AuthRenew OperationFunc

+ BackendType logical.BackendType

+ Clean CleanupFunc

+ Help string

+ Invalidate InvalidateFunc

+ Paths []*Path

+ PathsSpecial *logical.Paths

+ PeriodicFunc periodicFunc

+ Secrets []*Secret

+ WALRollback WALRollbackFunc

+ WALRollbackMinAge time.Duration

+ func (b *Backend) Cleanup(ctx context.Context)

+ func (b *Backend) HandleExistenceCheck(ctx context.Context, req *logical.Request) (checkFound bool, exists bool, err error)

+ func (b *Backend) HandleRequest(ctx context.Context, req *logical.Request) (*logical.Response, error)

+ func (b *Backend) InvalidateKey(ctx context.Context, key string)

+ func (b *Backend) Logger() log.Logger

+ func (b *Backend) Route(path string) *Path

+ func (b *Backend) Secret(k string) *Secret

+ func (b *Backend) Setup(ctx context.Context, config *logical.BackendConfig) error

+ func (b *Backend) SpecialPaths() *logical.Paths

+ func (b *Backend) System() logical.SystemView

+ func (b *Backend) Type() logical.BackendType

+ type CleanupFunc func(context.Context)

+ type ExistenceFunc func(context.Context, *logical.Request, *FieldData) (bool, error)

+ type FieldData struct

+ Raw map[string]interface{}

+ Schema map[string]*FieldSchema

+ func (d *FieldData) Get(k string) interface{}

+ func (d *FieldData) GetDefaultOrZero(k string) interface{}

+ func (d *FieldData) GetFirst(k ...string) (interface{}, bool)

+ func (d *FieldData) GetOk(k string) (interface{}, bool)

+ func (d *FieldData) GetOkErr(k string) (interface{}, bool, error)

+ func (d *FieldData) Validate() error

+ type FieldSchema struct

+ AllowedValues []interface{}

+ Default interface{}

+ Deprecated bool

+ Description string

+ DisplayName string

+ DisplaySensitive bool

+ DisplayValue interface{}

+ Query bool

+ Required bool

+ Type FieldType

+ func (s *FieldSchema) DefaultOrZero() interface{}

+ type FieldType uint

+ const TypeBool

+ const TypeCommaIntSlice

+ const TypeCommaStringSlice

+ const TypeDurationSecond

+ const TypeHeader

+ const TypeInt

+ const TypeInvalid

+ const TypeKVPairs

+ const TypeLowerCaseString

+ const TypeMap

+ const TypeNameString

+ const TypeSlice

+ const TypeString

+ const TypeStringSlice

+ func (t FieldType) String() string

+ func (t FieldType) Zero() interface{}

+ type InvalidateFunc func(context.Context, string)

+ type OASContent map[string]*OASMediaTypeObject

+ type OASDocument struct

+ Info OASInfo

+ Paths map[string]*OASPathItem

+ Version string

+ func NewOASDocument() *OASDocument

+ func NewOASDocumentFromMap(input map[string]interface{}) (*OASDocument, error)

+ func (d *OASDocument) CreateOperationIDs(context string)

+ type OASInfo struct

+ Description string

+ License OASLicense

+ Title string

+ Version string

+ type OASLicense struct

+ Name string

+ URL string

+ type OASMediaTypeObject struct

+ Schema *OASSchema

+ type OASOperation struct

+ Deprecated bool

+ Description string

+ OperationID string

+ Parameters []OASParameter

+ RequestBody *OASRequestBody

+ Responses map[int]*OASResponse

+ Summary string

+ Tags []string

+ func NewOASOperation() *OASOperation

+ type OASParameter struct

+ Deprecated bool

+ Description string

+ In string

+ Name string

+ Required bool

+ Schema *OASSchema

+ type OASPathItem struct

+ CreateSupported bool

+ Delete *OASOperation

+ Description string

+ Get *OASOperation

+ Parameters []OASParameter

+ Post *OASOperation

+ Sudo bool

+ Unauthenticated bool

+ type OASRequestBody struct

+ Content OASContent

+ Description string

+ type OASResponse struct

+ Content OASContent

+ Description string

+ type OASSchema struct

+ Default interface{}

+ Deprecated bool

+ Description string

+ DisplayName string

+ DisplaySensitive bool

+ DisplayValue interface{}

+ Enum []interface{}

+ Example interface{}

+ Format string

+ Items *OASSchema

+ Pattern string

+ Properties map[string]*OASSchema

+ Required []string

+ Type string

+ type OperationFunc func(context.Context, *logical.Request, *FieldData) (*logical.Response, error)

+ func LeaseExtend(backendIncrement, backendMax time.Duration, systemView logical.SystemView) OperationFunc

+ type OperationHandler interface

+ Handler func() OperationFunc

+ Properties func() OperationProperties

+ type OperationProperties struct

+ Deprecated bool

+ Description string

+ Examples []RequestExample

+ Responses map[int][]Response

+ Summary string

+ Unpublished bool

+ type Path struct

+ Callbacks map[logical.Operation]OperationFunc

+ Deprecated bool

+ ExistenceCheck ExistenceFunc

+ FeatureRequired license.Features

+ Fields map[string]*FieldSchema

+ HelpDescription string

+ HelpSynopsis string

+ Operations map[logical.Operation]OperationHandler

+ Pattern string

+ func PathAppend(paths ...[]*Path) []*Path

+ type PathMap struct

+ CaseSensitive bool

+ Name string

+ Prefix string

+ Salt *saltpkg.Salt

+ SaltFunc func(context.Context) (*saltpkg.Salt, error)

+ Schema map[string]*FieldSchema

+ func (p *PathMap) Delete(ctx context.Context, s logical.Storage, k string) error

+ func (p *PathMap) Get(ctx context.Context, s logical.Storage, k string) (map[string]interface{}, error)

+ func (p *PathMap) List(ctx context.Context, s logical.Storage, prefix string) ([]string, error)

+ func (p *PathMap) Paths() []*Path

+ func (p *PathMap) Put(ctx context.Context, s logical.Storage, k string, v map[string]interface{}) error

+ type PathOperation struct

+ Callback OperationFunc

+ Deprecated bool

+ Description string

+ Examples []RequestExample

+ Responses map[int][]Response

+ Summary string

+ Unpublished bool

+ func (p *PathOperation) Handler() OperationFunc

+ func (p *PathOperation) Properties() OperationProperties

+ type PathStruct struct

+ HelpDescription string

+ HelpSynopsis string

+ Name string

+ Path string

+ Read bool

+ Schema map[string]*FieldSchema

+ func (p *PathStruct) Delete(ctx context.Context, s logical.Storage) error

+ func (p *PathStruct) Get(ctx context.Context, s logical.Storage) (map[string]interface{}, error)

+ func (p *PathStruct) Paths() []*Path

+ func (p *PathStruct) Put(ctx context.Context, s logical.Storage, v map[string]interface{}) error

+ type PolicyMap struct

+ DefaultKey string

+ PolicyKey string

+ func (p *PolicyMap) Policies(ctx context.Context, s logical.Storage, names ...string) ([]string, error)

+ type RequestExample struct

+ Data map[string]interface{}

+ Description string

+ Response *Response

+ type Response struct

+ Description string

+ Example *logical.Response

+ MediaType string

+ type Secret struct

+ DefaultDuration time.Duration

+ Fields map[string]*FieldSchema

+ Renew OperationFunc

+ Revoke OperationFunc

+ Type string

+ func (s *Secret) HandleRenew(ctx context.Context, req *logical.Request) (*logical.Response, error)

+ func (s *Secret) HandleRevoke(ctx context.Context, req *logical.Request) (*logical.Response, error)

+ func (s *Secret) Renewable() bool

+ func (s *Secret) Response(data, internal map[string]interface{}) *logical.Response

+ type WALEntry struct

+ CreatedAt int64

+ Data interface{}

+ ID string

+ Kind string

+ func GetWAL(ctx context.Context, s logical.Storage, id string) (*WALEntry, error)

+ type WALRollbackFunc func(context.Context, *logical.Request, string, interface{}) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL