grpc_auth2

Documentation

Index

• func StreamServerInterceptor(authFunc AuthWithRequestFunc) grpc.StreamServerInterceptor
• func UnaryServerInterceptor(authFunc AuthWithRequestFunc) grpc.UnaryServerInterceptor
• type AuthWithRequestFunc
• type ServiceAuthFuncAttached

Functions

func StreamServerInterceptor

func StreamServerInterceptor(authFunc AuthWithRequestFunc) grpc.StreamServerInterceptor

StreamServerInterceptor returns a new unary server interceptors that performs per-request auth.

func UnaryServerInterceptor

func UnaryServerInterceptor(authFunc AuthWithRequestFunc) grpc.UnaryServerInterceptor

UnaryServerInterceptor returns a new unary server interceptors that performs per-request auth.

Types

type AuthWithRequestFunc

type AuthWithRequestFunc func(ctx context.Context, req interface{}) (context.Context, error)

AuthFunc is the pluggable function that performs authentication.

The passed in `Context` will contain the gRPC metadata.MD object (for header-based authentication) and the peer.Peer information that can contain transport-based credentials (e.g. `credentials.AuthInfo`).

The returned context will be propagated to handlers, allowing user changes to `Context`. However, please make sure that the `Context` returned is a child `Context` of the one passed in.

If error is returned, its `grpc.Code()` will be returned to the user as well as the verbatim message. Please make sure you use `codes.Unauthenticated` (lacking auth) and `codes.PermissionDenied` (authed, but lacking perms) appropriately.

type ServiceAuthFuncAttached

type ServiceAuthFuncAttached interface {
	AuthFuncAttached(ctx context.Context, fullMethodName string) (context.Context, error)
}

ServiceAuthFuncOverride allows a given gRPC service implementation to override the global `AuthFunc`.

If a service implements the AuthFuncOverride method, it takes precedence over the `AuthFunc` method, and will be called instead of AuthFunc for all method invocations within that service.