iamregistry

Documentation

Overview

Package iamregistry provides data structures for resolving IAM roles and permissions.

Index

• func ValidateRoles(roles *iamv1.Roles) *errdetails.BadRequest
• type ResourcePermissions
  • func NewResourcePermissions(resourcePermissions *iamv1.ResourcePermissions, ...) (*ResourcePermissions, error)
  • func (r *ResourcePermissions) FindPermissionByResourceName(name string) (string, bool)
• type Roles
  • func NewRoles(roles *iamv1.Roles) (*Roles, error)
  • func (r *Roles) Count() int
  • func (r *Roles) FindRoleByName(name string) (*admin.Role, bool)
  • func (r *Roles) RangeRoles(fn func(*admin.Role) bool)
  • func (r *Roles) RangeRolesByPermission(permission string, fn func(*admin.Role) bool)
  • func (r *Roles) RoleHasPermission(name, permission string) bool

Functions

func ValidateRoles

func ValidateRoles(roles *iamv1.Roles) *errdetails.BadRequest

ValidateRoles validates a set of predefined roles.

Types

type ResourcePermissions

type ResourcePermissions struct {
	// contains filtered or unexported fields
}

ResourcePermissions contain a mapping from resource types to permissions.

func NewResourcePermissions

func NewResourcePermissions(
	resourcePermissions *iamv1.ResourcePermissions,
	resources []*annotations.ResourceDescriptor,
) (*ResourcePermissions, error)

NewResourcePermissions creates a mapping of resource types to permissions.

func (*ResourcePermissions) FindPermissionByResourceName

func (r *ResourcePermissions) FindPermissionByResourceName(name string) (string, bool)

FindPermissionByResourceName looks up a permission by resource name.

type Roles

type Roles struct {
	// contains filtered or unexported fields
}

Roles are a set of roles.

func NewRoles

func NewRoles(roles *iamv1.Roles) (*Roles, error)

NewRoles creates a set of Roles from a pre-defined roles annotation.

func (*Roles) Count

func (r *Roles) Count() int

Count returns a count of the roles.

func (*Roles) FindRoleByName

func (r *Roles) FindRoleByName(name string) (*admin.Role, bool)

FindRoleByName looks up a role by resource name.

func (*Roles) RangeRoles

func (r *Roles) RangeRoles(fn func(*admin.Role) bool)

RangeRoles iterates over all registered roles while f returns true. The iteration order is undefined.

func (*Roles) RangeRolesByPermission

func (r *Roles) RangeRolesByPermission(permission string, fn func(*admin.Role) bool)

RangeRolesByPermission iterates over all registered roles with the provided permission while f returns true. The iteration order is undefined, and permissions with wildcards are not allowed.

func (*Roles) RoleHasPermission

func (r *Roles) RoleHasPermission(name, permission string) bool

RoleHasPermission checks whether the role with the provided name has the provided permission.