grpcutil

Documentation

Overview

Package grpcutil contains functions for interacting with gRPC.

Index

• Constants
• func AttachMetadataInterceptors(md metadata.MD) (grpc.UnaryServerInterceptor, grpc.StreamServerInterceptor)
• func GetPeerAddr(ctx context.Context) string
• func GetTypeURL(msg proto.Message) string
• func JWTFromGRPCRequest(ctx context.Context) (rawjwt string, ok bool)
• 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(key []byte) grpc.StreamClientInterceptor
• func WithUnarySignedJWT(key []byte) grpc.UnaryClientInterceptor

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 GetPeerAddr

func GetPeerAddr(ctx context.Context) string

GetPeerAddr returns the peer address.

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 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(key []byte) grpc.StreamClientInterceptor

WithStreamSignedJWT returns a StreamClientInterceptor that adds a JWT to requests.

func WithUnarySignedJWT

func WithUnarySignedJWT(key []byte) grpc.UnaryClientInterceptor

WithUnarySignedJWT returns a UnaryClientInterceptor that adds a JWT to requests.