iamauthz

Documentation

Overview

Package iamauthz provides primitives for performing IAM request authorization.

Index

• func Authorize(ctx context.Context)
• func RequireStreamAuthorization(_ interface{}, _ grpc.ServerStream, _ *grpc.StreamServerInfo, ...) error
• func RequireUnaryAuthorization(ctx context.Context, req interface{}, _ *grpc.UnaryServerInfo, ...) (interface{}, error)
• func WithAuthorization(ctx context.Context) context.Context

Functions

func Authorize

func Authorize(ctx context.Context)

Authorize marks the current request as processed by an authorization check. WithAuthorization must have been called on the context for the call to be effective.

Authorize should be called at the start of an authorization check, to ensure that any errors resulting from the authorization check itself are forwarded to the caller.

func RequireStreamAuthorization

func RequireStreamAuthorization(
	_ interface{},
	_ grpc.ServerStream,
	_ *grpc.StreamServerInfo,
	_ grpc.StreamHandler,
) error

RequireStreamAuthorization is a grpc.StreamServerInterceptor that aborts all incoming streams, pending implementation of stream support in this package.

func RequireUnaryAuthorization

func RequireUnaryAuthorization(
	ctx context.Context,
	req interface{},
	_ *grpc.UnaryServerInfo,
	handler grpc.UnaryHandler,
) (interface{}, error)

RequireUnaryAuthorization is a grpc.UnaryServerInterceptor that requires authorization to be performed on all incoming requests.

To mark the request as processed by authorization checks, the method implementing authorization should call Authorize on the request context as soon as authorization starts.

func WithAuthorization

func WithAuthorization(ctx context.Context) context.Context

WithAuthorization adds authorization to the current request context.