iamreflect

Documentation

Index

• func ValidateLongRunningOperationsAuthorization(authorization *iamv1.LongRunningOperationsAuthorization) error
• func ValidateMethodAuthorizationOptions(methodAuthorization *iamv1.MethodAuthorizationOptions, ...) error
• func ValidatePredefinedRoles(roles *iamv1.PredefinedRoles) error
• type IAMDescriptor
  • func NewIAMDescriptor(service protoreflect.ServiceDescriptor, files *protoregistry.Files) (*IAMDescriptor, error)
  • func (d *IAMDescriptor) FindMethodAuthorizationOptionsByRequest(request proto.Message) (*iamv1.MethodAuthorizationOptions, bool)
  • func (d *IAMDescriptor) ResolvePermissionByRequestAndResource(request proto.Message, resource string) (string, bool)

Functions

func ValidateLongRunningOperationsAuthorization

func ValidateLongRunningOperationsAuthorization(authorization *iamv1.LongRunningOperationsAuthorization) error

ValidateLongRunningOperationsAuthorization checks that a long-running operations authorization annotation is valid.

func ValidateMethodAuthorizationOptions

func ValidateMethodAuthorizationOptions(
	methodAuthorization *iamv1.MethodAuthorizationOptions,
	method protoreflect.MethodDescriptor,
	files *protoregistry.Files,
) error

func ValidatePredefinedRoles

func ValidatePredefinedRoles(roles *iamv1.PredefinedRoles) error

ValidatePredefinedRoles validates a set of predefined roles.

Types

type IAMDescriptor

type IAMDescriptor struct {
	// PredefinedRoles are the service's predefined IAM roles.
	PredefinedRoles *iamv1.PredefinedRoles
	// LongRunningOperationsAuthorization is the service's configuration for authorization of long-running operations.
	LongRunningOperationsAuthorization *iamv1.LongRunningOperationsAuthorization
	// MethodAuthorizationOptions is a mapping from full method name to the method's authorization options.
	MethodAuthorizationOptions map[protoreflect.FullName]*iamv1.MethodAuthorizationOptions
	// RequestAuthorizationOptions is a mapping from full request name to the method's authorization options.
	RequestAuthorizationOptions map[protoreflect.FullName]*iamv1.MethodAuthorizationOptions
}

IAMDescriptor represents an RPC service's IAM specification.

func NewIAMDescriptor

func NewIAMDescriptor(service protoreflect.ServiceDescriptor, files *protoregistry.Files) (*IAMDescriptor, error)

NewIAMDescriptor creates a new IAMDescriptor from the provided service descriptor. Uses the provided files to resolve resource name patterns.

func (*IAMDescriptor) FindMethodAuthorizationOptionsByRequest

func (d *IAMDescriptor) FindMethodAuthorizationOptionsByRequest(
	request proto.Message,
) (*iamv1.MethodAuthorizationOptions, bool)

func (*IAMDescriptor) ResolvePermissionByRequestAndResource

func (d *IAMDescriptor) ResolvePermissionByRequestAndResource(
	request proto.Message,
	resource string,
) (string, bool)