auth

Documentation

Index

• Constants
• Variables
• func AlwaysAllowFunc() bool
• type Config
• type Interceptor
  • func NewAuthInterceptor(jwtManager *Manager, policyClient *policyclient.Client) *Interceptor
  • func (interceptor *Interceptor) Stream() grpc.StreamServerInterceptor
  • func (interceptor *Interceptor) Unary() grpc.UnaryServerInterceptor
• type Manager
  • func NewJWTManager(secretKey string, tokenDuration time.Duration) *Manager
  • func (manager *Manager) Generate(user *user.User) (string, error)
  • func (manager *Manager) Verify(accessToken string) (*UserClaims, error)
• type StreamClaimInjector
  • func (s StreamClaimInjector) Context() context.Context
• type UserClaims

Constants

const KeyClaim claim = "claim"

Variables

var ErrInvalidToken = errors.New("invalid token claims")

var ErrUnexpectedSigningToken = errors.New("unexpected token signing method")

Functions

func AlwaysAllowFunc

func AlwaysAllowFunc() bool

Types

type Config

type Config struct {
	Secret           string `default:"changeme"`
	TimeoutInSeconds uint64 `default:"86400"`
}

type Interceptor

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

func NewAuthInterceptor

func NewAuthInterceptor(jwtManager *Manager, policyClient *policyclient.Client) *Interceptor

NewAuthInterceptor returns an instance of Interceptor. It takes in Manager struct, and policyClient as input. Policy Client allows to dynamically change authorization policies.

func (*Interceptor) Stream

func (interceptor *Interceptor) Stream() grpc.StreamServerInterceptor

Custom Stream interceptor that adds claim extraction and authorization

func (*Interceptor) Unary

func (interceptor *Interceptor) Unary() grpc.UnaryServerInterceptor

Custom Unary( interceptor that adds claim extraction and authorization

type Manager

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

func NewJWTManager

func NewJWTManager(secretKey string, tokenDuration time.Duration) *Manager

func (*Manager) Generate

func (manager *Manager) Generate(user *user.User) (string, error)

Generate creates user claim based on passed user parameter, and encodes it to JWT token.

func (*Manager) Verify

func (manager *Manager) Verify(accessToken string) (*UserClaims, error)

Verify ensures that the token provided by the client is valid, after which it extracts the claims and returns them.

type StreamClaimInjector

type StreamClaimInjector struct {
	grpc.ServerStream
	Claims *UserClaims
}

Custom Stream that allows embedding of user claims for stream grpc (Similar to what describe in: https://stackoverflow.com/questions/60982406/how-to-safely-add-values-to-grpc-serverstream-in-interceptor)

func (StreamClaimInjector) Context

func (s StreamClaimInjector) Context() context.Context

type UserClaims

type UserClaims struct {
	jwt.RegisteredClaims
	Username string `json:"username"`
	TeamID   string `json:"team_id"`
	Role     string `json:"role"`
}

UserClaims represents contents of JWT token.