grpc

Documentation

Index

• func CtxWithIncomingToken(ctx context.Context, token string) context.Context
• func CtxWithToken(ctx context.Context, token string) context.Context
• func ErrToStatus(err error) *status.Status
• func ForwardErrorf(code codes.Code, formatter string, args ...interface{}) error
• func ForwardFromError(code codes.Code, err error) error
• func IsContextCanceled(err error) bool
• func IsContextDeadlineExceeded(err error) bool
• func NewOAuthAccess(getTokenFunc OAuthGetTokenFunc) credentials.PerRPCCredentials
• func OwnerFromOutgoingTokenMD(ctx context.Context, ownerClaim string) (string, error)
• func OwnerFromTokenMD(ctx context.Context, ownerClaim string) (string, error)
• func ParseOwnerFromJwtToken(ownerClaim, rawJwtToken string) (string, error)
• func StreamServerInterceptor(intercept Interceptor) grpc.StreamServerInterceptor
• func StreamServerInterceptorOption(intercept Interceptor) grpc.ServerOption
• func SubjectFromTokenMD(ctx context.Context) (string, error)
• func TokenFromMD(ctx context.Context) (string, error)
• func TokenFromOutgoingMD(ctx context.Context) (string, error)
• func UnaryServerInterceptor(intercept Interceptor) grpc.UnaryServerInterceptor
• func UnaryServerInterceptorOption(intercept Interceptor) grpc.ServerOption
• type AuthInterceptors
  • func MakeAuthInterceptors(authFunc Interceptor, whiteListedMethods ...string) AuthInterceptors
  • func MakeJWTInterceptors(keyCache *jwt.KeyCache, claims ClaimsFunc, whiteListedMethods ...string) AuthInterceptors
  • func (f AuthInterceptors) Stream() grpc.StreamServerInterceptor
  • func (f AuthInterceptors) Unary() grpc.UnaryServerInterceptor
• type Claims
• type ClaimsFunc
• type Interceptor
  • func ValidateJWT(keyCache *jwt.KeyCache, claims ClaimsFunc) Interceptor
  • func ValidateJWTWithValidator(validator Validator, claims ClaimsFunc) Interceptor
• type Iterator
  • func NewIterator(stream grpc.ClientStream, err error) *Iterator
  • func (it *Iterator) Close()
  • func (it *Iterator) Next(v interface{}) bool
• type OAuthGetTokenFunc
• type Validator

Functions

func CtxWithIncomingToken

func CtxWithIncomingToken(ctx context.Context, token string) context.Context

CtxWithIncomingToken stores token to ctx of response.

func CtxWithToken

func CtxWithToken(ctx context.Context, token string) context.Context

CtxWithToken stores token to ctx of request.

func ErrToStatus

func ErrToStatus(err error) *status.Status

func ForwardErrorf

func ForwardErrorf(code codes.Code, formatter string, args ...interface{}) error

ForwardErrorf tries to unwrap args as error with GRPCStatus() and forward original code and details.

func ForwardFromError

func ForwardFromError(code codes.Code, err error) error

ForwardFromError tries to unwrap err as GRPCStatus() and forward original code and details.

func IsContextCanceled

func IsContextCanceled(err error) bool

func IsContextDeadlineExceeded

func IsContextDeadlineExceeded(err error) bool

func NewOAuthAccess

func NewOAuthAccess(getTokenFunc OAuthGetTokenFunc) credentials.PerRPCCredentials

NewOAuthAccess constructs the PerRPCCredentials using a given token.

func OwnerFromOutgoingTokenMD

func OwnerFromOutgoingTokenMD(ctx context.Context, ownerClaim string) (string, error)

OwnerFromOutgoingTokenMD extracts ownerClaim from token stored by CtxWithToken.

func OwnerFromTokenMD

func OwnerFromTokenMD(ctx context.Context, ownerClaim string) (string, error)

OwnerFromTokenMD is a helper function for extracting the ownerClaim from the :authorization gRPC metadata of the request.

func ParseOwnerFromJwtToken

func ParseOwnerFromJwtToken(ownerClaim, rawJwtToken string) (string, error)

func StreamServerInterceptor

func StreamServerInterceptor(intercept Interceptor) grpc.StreamServerInterceptor

StreamServerInterceptor returns a new unary server interceptors that performs per-request auth.

func StreamServerInterceptorOption

func StreamServerInterceptorOption(intercept Interceptor) grpc.ServerOption

func SubjectFromTokenMD

func SubjectFromTokenMD(ctx context.Context) (string, error)

SubjectFromTokenMD is a helper function for extracting the sub claim from the :authorization gRPC metadata of the request.

func TokenFromMD

func TokenFromMD(ctx context.Context) (string, error)

TokenFromMD is a helper function for extracting the :authorization header from the gRPC metadata of the request.

func TokenFromOutgoingMD

func TokenFromOutgoingMD(ctx context.Context) (string, error)

TokenFromOutgoingMD extracts token stored by CtxWithToken.

func UnaryServerInterceptor

func UnaryServerInterceptor(intercept Interceptor) grpc.UnaryServerInterceptor

UnaryServerInterceptor returns a new unary server interceptors that performs per-request auth.

func UnaryServerInterceptorOption

func UnaryServerInterceptorOption(intercept Interceptor) grpc.ServerOption

Types

type AuthInterceptors

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

func MakeAuthInterceptors

func MakeAuthInterceptors(authFunc Interceptor, whiteListedMethods ...string) AuthInterceptors

func MakeJWTInterceptors

func MakeJWTInterceptors(keyCache *jwt.KeyCache, claims ClaimsFunc, whiteListedMethods ...string) AuthInterceptors

func (AuthInterceptors) Stream

func (f AuthInterceptors) Stream() grpc.StreamServerInterceptor

func (AuthInterceptors) Unary

func (f AuthInterceptors) Unary() grpc.UnaryServerInterceptor

type Claims

type Claims = interface{ Valid() error }

type ClaimsFunc

type ClaimsFunc = func(ctx context.Context, method string) Claims

type Interceptor

type Interceptor = func(ctx context.Context, method string) (context.Context, error)

func ValidateJWT

func ValidateJWT(keyCache *jwt.KeyCache, claims ClaimsFunc) Interceptor

func ValidateJWTWithValidator

func ValidateJWTWithValidator(validator Validator, claims ClaimsFunc) Interceptor

type Iterator

type Iterator struct {
	Err error
	// contains filtered or unexported fields
}

func NewIterator

func NewIterator(stream grpc.ClientStream, err error) *Iterator

func (*Iterator) Close

func (it *Iterator) Close()

func (*Iterator) Next

func (it *Iterator) Next(v interface{}) bool

type OAuthGetTokenFunc

type OAuthGetTokenFunc = func(ctx context.Context) (*oauth2.Token, error)

type Validator

type Validator interface {
	ParseWithClaims(token string, claims extJwt.Claims) error
}