grpcauth

Documentation

Index

• func InterceptAPIKey(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (resp interface{}, err error)
• func NewAPIKeyInterceptor() grpc.UnaryServerInterceptor
• type APIKeyCredentials
  • func NewAPIKeyCredentials(apikey string) *APIKeyCredentials
  • func (creds *APIKeyCredentials) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
  • func (creds *APIKeyCredentials) RequireTransportSecurity() bool

Functions

func InterceptAPIKey

func InterceptAPIKey(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (resp interface{}, err error)

InterceptAPIKey reads apikey from requests and puts the value into the context.

func NewAPIKeyInterceptor

func NewAPIKeyInterceptor() grpc.UnaryServerInterceptor

NewAPIKeyInterceptor creates instance of apikey interceptor

Types

type APIKeyCredentials

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

APIKeyCredentials implements grpc/credentials.PerRPCCredentials for authenticating with the grpc server.

func NewAPIKeyCredentials

func NewAPIKeyCredentials(apikey string) *APIKeyCredentials

NewAPIKeyCredentials returns a new APIKeyCredentials

func (*APIKeyCredentials) GetRequestMetadata

func (creds *APIKeyCredentials) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)

GetRequestMetadata gets the current request metadata, refreshing tokens if required.

func (*APIKeyCredentials) RequireTransportSecurity

func (creds *APIKeyCredentials) RequireTransportSecurity() bool

RequireTransportSecurity indicates whether the credentials requires transport security.