tokenstorage

Documentation

Index

• type DefaultTokenStorage
  • func (s *DefaultTokenStorage) Delete(ctx context.Context, owner *api.SPIAccessToken) error
  • func (s *DefaultTokenStorage) Get(ctx context.Context, owner *api.SPIAccessToken) (*api.Token, error)
  • func (s *DefaultTokenStorage) Initialize(ctx context.Context) error
  • func (s *DefaultTokenStorage) Store(ctx context.Context, owner *api.SPIAccessToken, token *api.Token) error
• type NotifyingTokenStorage
  • func (n NotifyingTokenStorage) Delete(ctx context.Context, owner *api.SPIAccessToken) error
  • func (n NotifyingTokenStorage) Get(ctx context.Context, owner *api.SPIAccessToken) (token *api.Token, err error)
  • func (n NotifyingTokenStorage) Initialize(ctx context.Context) error
  • func (n NotifyingTokenStorage) Store(ctx context.Context, owner *api.SPIAccessToken, token *api.Token) error
• type TestTokenStorage
  • func (t TestTokenStorage) Delete(ctx context.Context, owner *api.SPIAccessToken) error
  • func (t TestTokenStorage) Get(ctx context.Context, owner *api.SPIAccessToken) (*api.Token, error)
  • func (t TestTokenStorage) Initialize(ctx context.Context) error
  • func (t TestTokenStorage) Store(ctx context.Context, owner *api.SPIAccessToken, token *api.Token) error
• type TokenStorage
  • func NewJSONSerializingTokenStorage(secretStorage secretstorage.SecretStorage) TokenStorage

Types

type DefaultTokenStorage

type DefaultTokenStorage struct {
	// SecretStorage is the underlying storage that handled the storing of the tokens. This must be initialized explicitly
	// before it is used in this token storage instance.
	SecretStorage secretstorage.TypedSecretStorage[api.SPIAccessToken, api.Token]
}

DefaultTokenStorage is the default implementation of the TokenStorage interface that uses the underlying SecretStorage for actually storing the data. It honors the original behavior of the TokenStorage interface that used to return nil instead of throwing NotFoundError when encountering non-existent records in Get and Delete.

func (*DefaultTokenStorage) Delete

func (s *DefaultTokenStorage) Delete(ctx context.Context, owner *api.SPIAccessToken) error

Delete implements TokenStorage

func (*DefaultTokenStorage) Get

func (s *DefaultTokenStorage) Get(ctx context.Context, owner *api.SPIAccessToken) (*api.Token, error)

Get implements TokenStorage

func (*DefaultTokenStorage) Initialize

func (s *DefaultTokenStorage) Initialize(ctx context.Context) error

Initialize implements TokenStorage. It is a noop in the case of the DefaultTokenStorage.

func (*DefaultTokenStorage) Store

func (s *DefaultTokenStorage) Store(ctx context.Context, owner *api.SPIAccessToken, token *api.Token) error

Store implements TokenStorage

type NotifyingTokenStorage

type NotifyingTokenStorage struct {
	// Client is the kubernetesclient client to use to create the v1beta1.SPIAccessTokenDataUpdate objects.
	ClientFactory kubernetesclient.K8sClientFactory

	// TokenStorage is the token storage to delegate the actual storage operations to.
	TokenStorage TokenStorage
}

NotifyingTokenStorage is a wrapper around TokenStorage that also automatically creates the v1beta1.SPIAccessTokenDataUpdate objects.

func (NotifyingTokenStorage) Delete

func (n NotifyingTokenStorage) Delete(ctx context.Context, owner *api.SPIAccessToken) error

func (NotifyingTokenStorage) Get

func (n NotifyingTokenStorage) Get(ctx context.Context, owner *api.SPIAccessToken) (token *api.Token, err error)

func (NotifyingTokenStorage) Initialize

func (n NotifyingTokenStorage) Initialize(ctx context.Context) error

func (NotifyingTokenStorage) Store

func (n NotifyingTokenStorage) Store(ctx context.Context, owner *api.SPIAccessToken, token *api.Token) error

type TestTokenStorage

type TestTokenStorage struct {
	InitializeImpl func(context.Context) error
	StoreImpl      func(context.Context, *api.SPIAccessToken, *api.Token) error
	GetImpl        func(ctx context.Context, token *api.SPIAccessToken) (*api.Token, error)
	DeleteImpl     func(context.Context, *api.SPIAccessToken) error
}

func (TestTokenStorage) Delete

func (t TestTokenStorage) Delete(ctx context.Context, owner *api.SPIAccessToken) error

func (TestTokenStorage) Get

func (t TestTokenStorage) Get(ctx context.Context, owner *api.SPIAccessToken) (*api.Token, error)

func (TestTokenStorage) Initialize

func (t TestTokenStorage) Initialize(ctx context.Context) error

func (TestTokenStorage) Store

func (t TestTokenStorage) Store(ctx context.Context, owner *api.SPIAccessToken, token *api.Token) error

type TokenStorage

type TokenStorage interface {
	Initialize(ctx context.Context) error
	Store(ctx context.Context, owner *api.SPIAccessToken, token *api.Token) error
	Get(ctx context.Context, owner *api.SPIAccessToken) (*api.Token, error)
	Delete(ctx context.Context, owner *api.SPIAccessToken) error
}

TokenStorage is an interface similar to SecretStorage that has historically been used to work with tokens. New storage types are built on top of secretstorage.TypedSecretStorage that provides the same interface generically.

func NewJSONSerializingTokenStorage

func NewJSONSerializingTokenStorage(secretStorage secretstorage.SecretStorage) TokenStorage

NewJSONSerializingTokenStorage is a convenience function to construct a TokenStorage instance based on the provided SecretStorage and serializing the data to JSON for persistence. The returned object is an instance of DefaultTokenStorage. NOTE that the provided secret storage MUST BE initialized before this call.