accesstypes

README

accesstypes

The accesstypes package provides types used by the access package and other dependent packages.

Documentation

Overview

package accesstypes provides types for permissions, roles, and domains types for the access package

Index

• Constants
• type Domain
  • func UnmarshalDomain(domain string) Domain
  • func (d Domain) Marshal() string
• type Enforcer
• type Field
• type Permission
  • func UnmarshalPermission(permission string) Permission
  • func (p Permission) Marshal() string
• type PermissionDetail
• type PermissionScope
• type ResolvedPermissions
• type ResolvedResourcePermissions
• type ResolvedTagPermissions
• type Resource
  • func UnmarshalResource(resource string) Resource
  • func (r Resource) Marshal() string
  • func (r Resource) ResourceAndTag() (Resource, Tag)
  • func (r Resource) ResourceWithTag(tag Tag) Resource
• type Role
  • func UnmarshalRole(role string) Role
  • func (r Role) Marshal() string
• type RoleCollection
• type RolePermissionCollection
• type Tag
• type TagPermissions
• type User
  • func UnmarshalUser(user string) User
  • func (u User) Marshal() string
• type UserPermissionCollection

Constants

const GlobalDomain = Domain("global")

GlobalDomain is the domain used when a permission is applied at the Global level instead of to a specific domain.

const GlobalResource = Resource("global")

GlobalResource is the resource used when a permission is applied to the entire application, (i.e. Global level) instead of to a specific resource.

const NoopUser = "noop"

NoopUser is the user assigned to an empty role in casbin to ensure the role can be enumerated if no one else is assigned

Types

type Domain

type Domain string

func UnmarshalDomain

func UnmarshalDomain(domain string) Domain

func (Domain) Marshal

func (d Domain) Marshal() string

type Enforcer

type Enforcer interface {
	RequireResources(ctx context.Context, user User, domain Domain, perms Permission, resources ...Resource) (ok bool, missing []Resource, err error)
}

type Field

type Field string

type Permission

type Permission string

const (
	NullPermission Permission = ""
	Create         Permission = "Create"
	Read           Permission = "Read"
	List           Permission = "List"
	Update         Permission = "Update"
	Delete         Permission = "Delete"
)

func UnmarshalPermission

func UnmarshalPermission(permission string) Permission

func (Permission) Marshal

func (p Permission) Marshal() string

type PermissionDetail

type PermissionDetail struct {
	Description string
	Scope       PermissionScope
}

type PermissionScope

type PermissionScope string

const (
	GlobalPermissionScope PermissionScope = "global"
	DomainPermissionScope PermissionScope = "domain"
)

type ResolvedPermissions

type ResolvedPermissions struct {
	Resources ResolvedResourcePermissions
	Tags      ResolvedTagPermissions
}

type ResolvedResourcePermissions

type ResolvedResourcePermissions map[Domain]map[Resource]map[Permission]bool

type ResolvedTagPermissions

type ResolvedTagPermissions map[Domain]map[Resource]map[Tag]map[Permission]bool

type Resource

type Resource string

func UnmarshalResource

func UnmarshalResource(resource string) Resource

func (Resource) Marshal

func (r Resource) Marshal() string

func (Resource) ResourceAndTag

func (r Resource) ResourceAndTag() (Resource, Tag)

func (Resource) ResourceWithTag

func (r Resource) ResourceWithTag(tag Tag) Resource

type Role

type Role string

func UnmarshalRole

func UnmarshalRole(role string) Role

func (Role) Marshal

func (r Role) Marshal() string

type RoleCollection

type RoleCollection map[Domain][]Role

type RolePermissionCollection

type RolePermissionCollection map[Permission][]Resource

type Tag

type Tag string

type TagPermissions

type TagPermissions map[Tag][]Permission

type User

type User string

User represents a user in the authorization system

func UnmarshalUser

func UnmarshalUser(user string) User

func (User) Marshal

func (u User) Marshal() string

type UserPermissionCollection

type UserPermissionCollection map[Domain]map[Resource][]Permission