interceptor

Documentation

Index

• Constants
• Variables
• func ForwardedByGrpcGateway(ctx context.Context) bool
• func GenJournalID() string
• func QueryUnescape(uri string) string
• type ClientInterceptor
  • func NewClientInterceptor(sign Sign, logger *zap.Logger, marshalJournal bool, notify notifyHandler) *ClientInterceptor
  • func (c *ClientInterceptor) StreamInterceptor(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, ...) (stream grpc.ClientStream, err error)
  • func (c *ClientInterceptor) UnaryInterceptor(ctx context.Context, method string, req, reply interface{}, ...) (err error)
• type GatewayInterceptor
  • func NewGatewayInterceptor(logger *zap.Logger, marshalJournal bool, notify notifyHandler) *GatewayInterceptor
  • func (g *GatewayInterceptor) UnaryInterceptor(ctx context.Context, method string, req, reply interface{}, ...) (err error)
• type MessageValidator
• type Payload
• type ServerInterceptor
  • func NewServerInterceptor(logger *zap.Logger, enablePrometheus, marshalJournal bool, ...) *ServerInterceptor
  • func (s *ServerInterceptor) StreamInterceptor(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, ...) (err error)
  • func (s *ServerInterceptor) UnaryInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (resp interface{}, err error)
• type SessionUserinfo
• type Sign
• type SignatureIdentifier

Constants

const (
	// JournalID a random id used by log journal
	JournalID = "journal-id"
	// Authorization used by auth, both gateway and grpc
	Authorization = "authorization"
	// ProxyAuthorization used by signature, both gateway and grpc
	ProxyAuthorization = "proxy-authorization"
	// MixAuthorization used by signature, both gateway and grpc
	MixAuthorization = "mix-authorization"
	// Date GMT format
	Date = "date"
	// Method http.XXXMethod
	Method = "method"
	// URI url encoded
	URI = "uri"
	// Body string body
	Body = "body"
	// XForwardedFor forwarded for
	XForwardedFor = "x-forwarded-for"
	// XForwardedHost forwarded host
	XForwardedHost = "x-forwarded-host"
)

Variables

var FileDescriptor = &fileDescriptor{
	options: make(map[string]protoreflect.ProtoMessage),
}

FileDescriptor protobuf file descriptor

var MetricsError = prometheus.NewHistogramVec(prometheus.HistogramOpts{
	Namespace: namespace,
	Subsystem: subsystem,
	Name:      "error",
	Help:      "error(s) alert",
	Buckets:   []float64{0.1, 0.3, 0.5, 0.7, 0.9, 1.1},
}, []string{"method", "code", "message", "journal_id"})

MetricsError metrics for alertmanager

var MetricsRequestCost = prometheus.NewHistogramVec(prometheus.HistogramOpts{
	Namespace: namespace,
	Subsystem: subsystem,
	Name:      "requestcost",
	Help:      "[ok] request(s) cost seconds",
	Buckets:   []float64{0.1, 0.3, 0.5, 0.7, 0.9, 1.1},
}, []string{"method"})

MetricsRequestCost metrics for ok request cost

var Validator = &validator{
	auth:         make(map[string]userinfoHandler),
	proxyAuth:    make(map[string]signatureHandler),
	whitelisting: make(map[string]whitelistingHandler),
}

Validator authorization & proxy_authorization validator

Functions

func ForwardedByGrpcGateway

func ForwardedByGrpcGateway(ctx context.Context) bool

ForwardedByGrpcGateway whether forwarded by grpc gateway

func GenJournalID

func GenJournalID() string

func QueryUnescape

func QueryUnescape(uri string) string

Types

type ClientInterceptor

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

ClientInterceptor the client's interceptor

func NewClientInterceptor

func NewClientInterceptor(sign Sign, logger *zap.Logger, marshalJournal bool, notify notifyHandler) *ClientInterceptor

NewClientInterceptor create a client interceptor

func (*ClientInterceptor) StreamInterceptor

func (c *ClientInterceptor) StreamInterceptor(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, streamer grpc.Streamer, opts ...grpc.CallOption) (stream grpc.ClientStream, err error)

StreamInterceptor a interceptor for client stream operations

func (*ClientInterceptor) UnaryInterceptor

func (c *ClientInterceptor) UnaryInterceptor(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) (err error)

UnaryInterceptor a interceptor for client unary operations

type GatewayInterceptor

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

GatewayInterceptor the gateway's interceptor

func NewGatewayInterceptor

func NewGatewayInterceptor(logger *zap.Logger, marshalJournal bool, notify notifyHandler) *GatewayInterceptor

NewGatewayInterceptor create a gateway interceptor

func (*GatewayInterceptor) UnaryInterceptor

func (g *GatewayInterceptor) UnaryInterceptor(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) (err error)

UnaryInterceptor a interceptor for gateway unary operations

type MessageValidator

type MessageValidator interface {
	Valid() error
}

MessageValidator generated by bluekaki/pkg/protoc-gen-message-validator

type Payload

type Payload interface {
	JournalID() string
	ForwardedByGrpcGateway() bool
	Service() string
	Date() string
	Method() string
	URI() string
	Body() string
	// contains filtered or unexported methods
}

Payload rest or grpc payload

type ServerInterceptor

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

ServerInterceptor the server's interceptor

func NewServerInterceptor

func NewServerInterceptor(logger *zap.Logger, enablePrometheus, marshalJournal bool, notify notifyHandler) *ServerInterceptor

NewServerInterceptor create a server interceptor

func (*ServerInterceptor) StreamInterceptor

func (s *ServerInterceptor) StreamInterceptor(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) (err error)

StreamInterceptor a interceptor for server stream operations

func (*ServerInterceptor) UnaryInterceptor

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

UnaryInterceptor a interceptor for server unary operations

type SessionUserinfo

type SessionUserinfo struct{}

SessionUserinfo mark userinfo in context

type Sign

type Sign func(fullMethod string, message []byte) (auth, date string, err error)

Sign signs the message

type SignatureIdentifier

type SignatureIdentifier struct{}

SignatureIdentifier mark identifier in context