grpcclientidentity

Documentation

Overview

Package grpcclientidentity makes the client identity provided by github.com/zrepl/zrepl/daemon/transport/serve.{AuthenticatedListener,AuthConn} available to gRPC service handlers.

This goal is achieved through the combination of custom gRPC transport credentials and two interceptors (i.e. middleware).

For gRPC clients, the TransportCredentials + Dialer can be used to construct a gRPC client (grpc.ClientConn) that uses a github.com/zrepl/zrepl/daemon/transport/connect.Connecter to connect to a server.

The adaptors exposed by this package must be used together, and panic if they are not. See package grpchelper for a more restrictive but safe example on how the adaptors should be composed.

Index

• func NewInterceptors(logger Logger, clientIdentityKey interface{}, interceptor Interceptor) (unary grpc.UnaryServerInterceptor, stream grpc.StreamServerInterceptor)
• func NewTransportCredentials(log Logger) credentials.TransportCredentials
• type ContextInterceptorData
• type GRPCDialFunction
  • func NewDialer(logger Logger, connecter transport.Connecter) GRPCDialFunction
• type Interceptor
• type Logger

Functions

func NewInterceptors

func NewInterceptors(logger Logger, clientIdentityKey interface{}, interceptor Interceptor) (unary grpc.UnaryServerInterceptor, stream grpc.StreamServerInterceptor)

func NewTransportCredentials

func NewTransportCredentials(log Logger) credentials.TransportCredentials

Use on both sides as ServerOption or ClientOption.

Types

type ContextInterceptorData

type ContextInterceptorData interface {
	FullMethod() string
	ClientIdentity() string
}

type GRPCDialFunction

type GRPCDialFunction = func(string, time.Duration) (net.Conn, error)

func NewDialer

func NewDialer(logger Logger, connecter transport.Connecter) GRPCDialFunction

type Interceptor

type Interceptor = func(ctx context.Context, data ContextInterceptorData, handler func(ctx context.Context))

type Logger

type Logger = logger.Logger