cs3

Documentation

Index

• type CS3Backend
  • func NewCS3Backend(c *config.Config, tlsConfig *tls.Config, gatewayURI string, ...) (*CS3Backend, error)
  • func (b *CS3Backend) DestroySession(ctx context.Context, sessionRef *string) error
  • func (b *CS3Backend) GetUser(ctx context.Context, userEntryID string, sessionRef *string, ...) (backends.UserFromBackend, error)
  • func (b *CS3Backend) Logon(ctx context.Context, audience, username, password string) (bool, *string, *string, backends.UserFromBackend, error)
  • func (b *CS3Backend) Name() string
  • func (b *CS3Backend) RefreshSession(ctx context.Context, userID string, sessionRef *string, ...) error
  • func (b *CS3Backend) ResolveUserByUsername(ctx context.Context, username string) (backends.UserFromBackend, error)
  • func (b *CS3Backend) RunWithContext(ctx context.Context) error
  • func (b *CS3Backend) ScopesMeta() *scopes.Scopes
  • func (b *CS3Backend) ScopesSupported() []string
  • func (b *CS3Backend) UserClaims(userID string, authorizedScopes map[string]bool) map[string]interface{}

Types

type CS3Backend

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

CS3 Backend holds the data for the CS3 identifier backend

func NewCS3Backend

func NewCS3Backend(
	c *config.Config,
	tlsConfig *tls.Config,
	gatewayURI string,
	machineAuthAPIKey string,
	insecure bool,
) (*CS3Backend, error)

NewCS3Backend creates a new CS3 backend identifier backend

func (*CS3Backend) DestroySession

func (b *CS3Backend) DestroySession(ctx context.Context, sessionRef *string) error

DestroySession implements the Backend interface providing destroy CS3 session.

func (*CS3Backend) GetUser

func (b *CS3Backend) GetUser(ctx context.Context, userEntryID string, sessionRef *string, requestedScopes map[string]bool) (backends.UserFromBackend, error)

GetUser implements the Backend interface, providing user meta data retrieval for the user specified by the userID. Requests are bound to the provided context.

func (*CS3Backend) Logon

func (b *CS3Backend) Logon(ctx context.Context, audience, username, password string) (bool, *string, *string, backends.UserFromBackend, error)

Logon implements the Backend interface, enabling Logon with user name and password as provided. Requests are bound to the provided context.

func (*CS3Backend) Name

func (b *CS3Backend) Name() string

Name implements the Backend interface.

func (*CS3Backend) RefreshSession

func (b *CS3Backend) RefreshSession(ctx context.Context, userID string, sessionRef *string, claims map[string]interface{}) error

RefreshSession implements the Backend interface.

func (*CS3Backend) ResolveUserByUsername

func (b *CS3Backend) ResolveUserByUsername(ctx context.Context, username string) (backends.UserFromBackend, error)

ResolveUserByUsername implements the Backend interface, providing lookup for user by providing the username. Requests are bound to the provided context.

func (*CS3Backend) RunWithContext

func (b *CS3Backend) RunWithContext(ctx context.Context) error

RunWithContext implements the Backend interface.

func (*CS3Backend) ScopesMeta

func (b *CS3Backend) ScopesMeta() *scopes.Scopes

ScopesMeta implements the Backend interface, providing meta data for supported scopes.

func (*CS3Backend) ScopesSupported

func (b *CS3Backend) ScopesSupported() []string

ScopesSupported implements the Backend interface, providing supported scopes when running this backend.

func (*CS3Backend) UserClaims

func (b *CS3Backend) UserClaims(userID string, authorizedScopes map[string]bool) map[string]interface{}

UserClaims implements the Backend interface, providing user specific claims for the user specified by the userID.