grpcutil

Documentation

Overview

Package grpcutil contains functions for interacting with gRPC.

Index

• Constants
• func AttachMetadataInterceptors(md metadata.MD) (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor)
• func GetTypeURL(msg proto.Message) string
• func JWTFromGRPCRequest(ctx context.Context) (rawjwt string, ok bool)
• func NewGRPCClientConn(ctx context.Context, opts *Options, other ...grpc.DialOption) (*grpc.ClientConn, error)
• func RequireSignedJWT(ctx context.Context, key []byte) error
• func SessionIDFromGRPCRequest(ctx context.Context) (sessionID string, ok bool)
• func StreamRequireSignedJWT(key string) grpc.StreamServerInterceptor
• func UnaryRequireSignedJWT(key string) grpc.UnaryServerInterceptor
• func WithOutgoingJWT(ctx context.Context, rawjwt string) context.Context
• func WithOutgoingSessionID(ctx context.Context, sessionID string) context.Context
• func WithStreamSignedJWT(getKey func() []byte) grpc.StreamClientInterceptor
• func WithUnarySignedJWT(getKey func() []byte) grpc.UnaryClientInterceptor
• type Options

Constants

const JWTMetadataKey = "jwt"

JWTMetadataKey is the key in the metadata.

const MetadataKeyEnvoyVersion = "x-envoy-version"

MetadataKeyEnvoyVersion is the gRPC metadata key used for the envoy version.

const MetadataKeyPomeriumVersion = "x-pomerium-version"

MetadataKeyPomeriumVersion is the gRPC metadata key used for the pomerium version.

const SessionIDMetadataKey = "sessionid"

SessionIDMetadataKey is the key in the metadata.

Functions

func AttachMetadataInterceptors

func AttachMetadataInterceptors(md metadata.MD) (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor)

AttachMetadataInterceptors returns unary and server stream interceptors that attach metadata to the response.

func GetTypeURL

func GetTypeURL(msg proto.Message) string

GetTypeURL gets the TypeURL for a protobuf message.

func JWTFromGRPCRequest

func JWTFromGRPCRequest(ctx context.Context) (rawjwt string, ok bool)

JWTFromGRPCRequest returns the JWT from the gRPC request.

func NewGRPCClientConn

func NewGRPCClientConn(ctx context.Context, opts *Options, other ...grpc.DialOption) (*grpc.ClientConn, error)

NewGRPCClientConn returns a new gRPC pomerium service client connection.

func RequireSignedJWT

func RequireSignedJWT(ctx context.Context, key []byte) error

RequireSignedJWT requires a JWT in the gRPC metadata and that it be signed by the given key.

func SessionIDFromGRPCRequest

func SessionIDFromGRPCRequest(ctx context.Context) (sessionID string, ok bool)

SessionIDFromGRPCRequest returns the session id from the gRPC request.

func StreamRequireSignedJWT

func StreamRequireSignedJWT(key string) grpc.StreamServerInterceptor

StreamRequireSignedJWT requires a JWT in the gRPC metadata and that it be signed by the base64-encoded key.

func UnaryRequireSignedJWT

func UnaryRequireSignedJWT(key string) grpc.UnaryServerInterceptor

UnaryRequireSignedJWT requires a JWT in the gRPC metadata and that it be signed by the base64-encoded key.

func WithOutgoingJWT

func WithOutgoingJWT(ctx context.Context, rawjwt string) context.Context

WithOutgoingJWT appends a metadata header for the JWT to a context.

func WithOutgoingSessionID

func WithOutgoingSessionID(ctx context.Context, sessionID string) context.Context

WithOutgoingSessionID appends a metadata header for the session ID to a context.

func WithStreamSignedJWT

func WithStreamSignedJWT(getKey func() []byte) grpc.StreamClientInterceptor

WithStreamSignedJWT returns a StreamClientInterceptor that adds a JWT to requests.

func WithUnarySignedJWT

func WithUnarySignedJWT(getKey func() []byte) grpc.UnaryClientInterceptor

WithUnarySignedJWT returns a UnaryClientInterceptor that adds a JWT to requests.

Types

type Options

type Options struct {
	// Address is the location of the service.  e.g. "service.corp.example:8443"
	Address *url.URL
	// OverrideCertificateName overrides the server name used to verify the hostname on the
	// returned certificates from the server. gRPC internals also use it to override the virtual
	// hosting name if it is set.
	OverrideCertificateName string
	// CA specifies the base64 encoded TLS certificate authority to use.
	CA string
	// CAFile specifies the TLS certificate authority file to use.
	CAFile string
	// RequestTimeout specifies the timeout for individual RPC calls
	RequestTimeout time.Duration
	// ClientDNSRoundRobin enables or disables DNS resolver based load balancing
	ClientDNSRoundRobin bool

	// InsecureSkipVerify skips destination hostname and ca check
	InsecureSkipVerify bool

	// ServiceName specifies the service name for telemetry exposition
	ServiceName string

	// SignedJWTKey is the JWT key to use for signing a JWT attached to metadata.
	SignedJWTKey []byte
}

Options contains options for connecting to a pomerium rpc service.