README
¶
Auth 
Provides a high level pluggable abstraction for authentication and authorisation.
Interface
Simplify authentication with an interface that just returns true or false based on the current RPC context or session id. Optionally returns the session information for further examination.
Granular role based authorisation and control is needed at large scale for access management. Goes beyond just, does this person have an authenticated session. Should they be allowed to access the given resource.
Management of auth/roles should be offloaded to a service to minimise code changes in each individual service. Should ideally be embedded as middleware in requests handlers and initialised when registering a handler.
// Auth handles client side validation of authentication
// The client does not actually handle authentication itself.
// This could be an oauth2 provider, openid, basic auth, etc.
type Auth interface {
Authorized(ctx context.Context, req Request) (*Token, error)
Introspect(ctx context.Context) (*Token, error)
Revoke(t *Token) error
Token() (*Token, error)
String() string
}
func NewAuth(opts ...Option) Auth {
return newOS(opts...)
}
## Supported Backends
- Auth service (Oauth2)
Documentation
¶
Overview ¶
Package auth is an interface for authentication and authorization.
Index ¶
- Variables
- func ClientWrapper(a Auth) client.Wrapper
- func ContextWithToken(ctx context.Context, t *Token) context.Context
- func HandlerWrapper(a Auth) server.HandlerWrapper
- func HeaderWithToken(hd map[string]string, t *Token) map[string]string
- func NewContext(ctx context.Context, c Auth) context.Context
- type Auth
- type Option
- type Options
- type Request
- type Token
Constants ¶
This section is empty.
Variables ¶
var (
ErrInvalidToken = errors.New("invalid token")
)
Functions ¶
func ClientWrapper ¶
func HandlerWrapper ¶
func HandlerWrapper(a Auth) server.HandlerWrapper
Types ¶
type Auth ¶
type Auth interface {
// Check if authorised
Authorized(ctx context.Context, req Request) (*Token, error)
// Retrieve token from context
Introspect(ctx context.Context) (*Token, error)
// Revoke a token
Revoke(t *Token) error
// Retrieve client token
Token() (*Token, error)
String() string
}
Auth handles client side validation of authentication The client does not actually handle authentication itself. This could be an oauth2 provider, openid, basic auth, etc.
Source Files
Directories