authv3connect

Documentation

Index

• Constants
• func NewAuthorizationHandler(svc AuthorizationHandler, opts ...connect.HandlerOption) (string, http.Handler)
• type AuthorizationClient
  • func NewAuthorizationClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AuthorizationClient
• type AuthorizationHandler
• type UnimplementedAuthorizationHandler
  • func (UnimplementedAuthorizationHandler) Check(context.Context, *connect.Request[v3.CheckRequest]) (*connect.Response[v3.CheckResponse], error)

Constants

const (
	// AuthorizationCheckProcedure is the fully-qualified name of the Authorization's Check RPC.
	AuthorizationCheckProcedure = "/envoy.service.auth.v3.Authorization/Check"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

const (
	// AuthorizationName is the fully-qualified name of the Authorization service.
	AuthorizationName = "envoy.service.auth.v3.Authorization"
)

Functions

func NewAuthorizationHandler

func NewAuthorizationHandler(svc AuthorizationHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewAuthorizationHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type AuthorizationClient

type AuthorizationClient interface {
	// Performs authorization check based on the attributes associated with the
	// incoming request, and returns status `OK` or not `OK`.
	Check(context.Context, *connect.Request[v3.CheckRequest]) (*connect.Response[v3.CheckResponse], error)
}

AuthorizationClient is a client for the envoy.service.auth.v3.Authorization service.

func NewAuthorizationClient

func NewAuthorizationClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AuthorizationClient

NewAuthorizationClient constructs a client for the envoy.service.auth.v3.Authorization service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type AuthorizationHandler

type AuthorizationHandler interface {
	// Performs authorization check based on the attributes associated with the
	// incoming request, and returns status `OK` or not `OK`.
	Check(context.Context, *connect.Request[v3.CheckRequest]) (*connect.Response[v3.CheckResponse], error)
}

AuthorizationHandler is an implementation of the envoy.service.auth.v3.Authorization service.

type UnimplementedAuthorizationHandler

type UnimplementedAuthorizationHandler struct{}

UnimplementedAuthorizationHandler returns CodeUnimplemented from all methods.

func (UnimplementedAuthorizationHandler) Check

func (UnimplementedAuthorizationHandler) Check(context.Context, *connect.Request[v3.CheckRequest]) (*connect.Response[v3.CheckResponse], error)