interceptors

Documentation

Index

• Constants
• func NewClientAuth(uuid, token string, opts ...Option) *clientInterceptor
• type Authenticator
• type Claims
• type ClientInterceptor
• type Interceptor
• type Option
  • func WithBearerToken(bearer string) Option

Constants

const (
	// TokenHeader in outbound metadata for an authorization token
	TokenHeader = "authorization"
	// IDHeader in an outbound metadata for a client ID
	IDHeader = "uuid"
	// BearerHeader in an outbound metadata for a bearer token (typically a JWT)
	BearerHeader = "bearer"
)

Functions

func NewClientAuth

func NewClientAuth(uuid, token string, opts ...Option) *clientInterceptor

NewClientAuth for outbound authenticated connections

Types

type Authenticator

type Authenticator interface {
	Auth(ctx context.Context) error
	ValidateClientToken(ctx context.Context) (Claims, error)
}

Authenticator Auth-s the initial connection then allows validation at any point of the stream

type Claims

type Claims map[string]interface{}

Claims contain information about the VerifiedClientToken

type ClientInterceptor

type ClientInterceptor interface {
	credentials.PerRPCCredentials
	Interceptor
}

type Interceptor

type Interceptor interface {
	Stream() grpc.StreamClientInterceptor
	Unary() grpc.UnaryClientInterceptor
}

type Option

type Option func(opt *option)

func WithBearerToken

func WithBearerToken(bearer string) Option

WithBearerToken to skip the API Token auth