publicv1alphaconnect

Documentation

Index

• Constants
• func NewKeysServiceHandler(svc KeysServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type KeysServiceClient
  • func NewKeysServiceClient(httpClient connect_go.HTTPClient, baseURL string, ...) KeysServiceClient
• type KeysServiceHandler
• type UnimplementedKeysServiceHandler
  • func (UnimplementedKeysServiceHandler) GetPublicKeys(context.Context, *connect_go.Request[v1alpha.GetPublicKeysRequest]) (*connect_go.Response[v1alpha.GetPublicKeysResponse], error)

Constants

const (
	// KeysServiceGetPublicKeysProcedure is the fully-qualified name of the KeysService's GetPublicKeys
	// RPC.
	KeysServiceGetPublicKeysProcedure = "/blocky.authz.public.v1alpha.KeysService/GetPublicKeys"
)

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 (
	// KeysServiceName is the fully-qualified name of the KeysService service.
	KeysServiceName = "blocky.authz.public.v1alpha.KeysService"
)

Functions

func NewKeysServiceHandler

func NewKeysServiceHandler(svc KeysServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewKeysServiceHandler 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 KeysServiceClient

type KeysServiceClient interface {
	// Returns the public keys used to verify tokens and signatures.
	// The keys are returned in the JWK format as defined in RFC 7517.
	// The order of the keys determines the order in which they are used.
	GetPublicKeys(context.Context, *connect_go.Request[v1alpha.GetPublicKeysRequest]) (*connect_go.Response[v1alpha.GetPublicKeysResponse], error)
}

KeysServiceClient is a client for the blocky.authz.public.v1alpha.KeysService service.

func NewKeysServiceClient

func NewKeysServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) KeysServiceClient

NewKeysServiceClient constructs a client for the blocky.authz.public.v1alpha.KeysService 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 KeysServiceHandler

type KeysServiceHandler interface {
	// Returns the public keys used to verify tokens and signatures.
	// The keys are returned in the JWK format as defined in RFC 7517.
	// The order of the keys determines the order in which they are used.
	GetPublicKeys(context.Context, *connect_go.Request[v1alpha.GetPublicKeysRequest]) (*connect_go.Response[v1alpha.GetPublicKeysResponse], error)
}

KeysServiceHandler is an implementation of the blocky.authz.public.v1alpha.KeysService service.

type UnimplementedKeysServiceHandler

type UnimplementedKeysServiceHandler struct{}

UnimplementedKeysServiceHandler returns CodeUnimplemented from all methods.

func (UnimplementedKeysServiceHandler) GetPublicKeys

func (UnimplementedKeysServiceHandler) GetPublicKeys(context.Context, *connect_go.Request[v1alpha.GetPublicKeysRequest]) (*connect_go.Response[v1alpha.GetPublicKeysResponse], error)