manager

Documentation

Overview

Package manager contains an identity manager responsible for refreshing sessions and creating users.

Index

• func FromOAuthToken(token *session.OAuthToken) *oauth2.Token
• func ToOAuthToken(token *oauth2.Token) *session.OAuthToken
• type Authenticator
• type Manager
  • func New(options ...Option) *Manager
  • func (mgr *Manager) GetDataBrokerServiceClient() databroker.DataBrokerServiceClient
  • func (mgr *Manager) Run(ctx context.Context) error
  • func (mgr *Manager) RunLeased(ctx context.Context) error
  • func (mgr *Manager) UpdateConfig(options ...Option)
• type Option
  • func WithAuthenticator(authenticator Authenticator) Option
  • func WithDataBrokerClient(dataBrokerClient databroker.DataBrokerServiceClient) Option
  • func WithEventManager(mgr *events.Manager) Option
  • func WithNow(now func() time.Time) Option
  • func WithSessionRefreshCoolOffDuration(dur time.Duration) Option
  • func WithSessionRefreshGracePeriod(dur time.Duration) Option
• type Session
  • func (s Session) NextRefresh() time.Time
  • func (s *Session) UnmarshalJSON(data []byte) error
• type User
  • func (u User) NextRefresh() time.Time
  • func (u *User) UnmarshalJSON(data []byte) error

Functions

func FromOAuthToken

func FromOAuthToken(token *session.OAuthToken) *oauth2.Token

FromOAuthToken converts a session oauth token to oauth2.Token.

func ToOAuthToken

func ToOAuthToken(token *oauth2.Token) *session.OAuthToken

ToOAuthToken converts an oauth2.Token to a session oauth token.

Types

type Authenticator

type Authenticator interface {
	Refresh(context.Context, *oauth2.Token, identity.State) (*oauth2.Token, error)
	Revoke(context.Context, *oauth2.Token) error
	UpdateUserInfo(context.Context, *oauth2.Token, interface{}) error
}

Authenticator is an identity.Provider with only the methods needed by the manager.

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

A Manager refreshes identity information using session and user data.

func New

func New(
	options ...Option,
) *Manager

New creates a new identity manager.

func (*Manager) GetDataBrokerServiceClient

func (mgr *Manager) GetDataBrokerServiceClient() databroker.DataBrokerServiceClient

GetDataBrokerServiceClient gets the databroker client.

func (*Manager) Run

func (mgr *Manager) Run(ctx context.Context) error

Run runs the manager. This method blocks until an error occurs or the given context is canceled.

func (*Manager) RunLeased

func (mgr *Manager) RunLeased(ctx context.Context) error

RunLeased runs the identity manager when a lease is acquired.

func (*Manager) UpdateConfig

func (mgr *Manager) UpdateConfig(options ...Option)

UpdateConfig updates the manager with the new options.

type Option

type Option func(*config)

An Option customizes the configuration used for the identity manager.

func WithAuthenticator

func WithAuthenticator(authenticator Authenticator) Option

WithAuthenticator sets the authenticator in the config.

func WithDataBrokerClient

func WithDataBrokerClient(dataBrokerClient databroker.DataBrokerServiceClient) Option

WithDataBrokerClient sets the databroker client in the config.

func WithEventManager

func WithEventManager(mgr *events.Manager) Option

WithEventManager passes an event manager to record events

func WithNow

func WithNow(now func() time.Time) Option

WithNow customizes the time.Now function used by the manager.

func WithSessionRefreshCoolOffDuration

func WithSessionRefreshCoolOffDuration(dur time.Duration) Option

WithSessionRefreshCoolOffDuration sets the session refresh cool-off duration used by the manager.

func WithSessionRefreshGracePeriod

func WithSessionRefreshGracePeriod(dur time.Duration) Option

WithSessionRefreshGracePeriod sets the session refresh grace period used by the manager.

type Session

type Session struct {
	*session.Session
	// contains filtered or unexported fields
}

A Session is a session managed by the Manager.

func (Session) NextRefresh

func (s Session) NextRefresh() time.Time

NextRefresh returns the next time the session needs to be refreshed.

func (*Session) UnmarshalJSON

func (s *Session) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals json data into the session object.

type User

type User struct {
	*user.User
	// contains filtered or unexported fields
}

A User is a user managed by the Manager.

func (User) NextRefresh

func (u User) NextRefresh() time.Time

NextRefresh returns the next time the user information needs to be refreshed.

func (*User) UnmarshalJSON

func (u *User) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals json data into the user object.