accesstypes

package

v0.2.3 Latest Latest Go to latest Published: Sep 23, 2024 License: MIT Imports: 4 Imported by: 11

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cccteam/ccc

Links

Open Source Insights

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) IsValid() bool
- func (d Domain) Marshal() string
type Permission
- func UnmarshalPermission(permission string) Permission
- func (p Permission) IsValid() bool
- func (p Permission) Marshal() string
type PermissionDetail
type PermissionScope
type Resource
- func UnmarshalResource(resource string) Resource
- func (d Resource) IsValid() bool
- func (d Resource) Marshal() string
type Role
- func UnmarshalRole(role string) Role
- func (r Role) IsValid() bool
- func (r Role) Marshal() string
type RoleCollection
type RolePermissionCollection
- func (r RolePermissionCollection) Permissions() []Permission
type User
- func UnmarshalUser(user string) User
- func (u User) IsValid() bool
- func (u User) Marshal() string
type UserPermissionCollection
- func (p UserPermissionCollection) DomainPermissions(domains ...Domain) map[Domain][]Permission
- func (p UserPermissionCollection) Domains() []Domain
- func (p UserPermissionCollection) GlobalPermissions() map[Domain][]Permission

Constants ¶

View Source

const GlobalDomain = Domain("global")

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

View Source

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.

View Source

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Domain ¶

type Domain string

func UnmarshalDomain ¶

func UnmarshalDomain(domain string) Domain

func (Domain) IsValid ¶

func (d Domain) IsValid() bool

func (Domain) Marshal ¶

func (d Domain) Marshal() string

type Permission ¶

type Permission string

func UnmarshalPermission ¶

func UnmarshalPermission(permission string) Permission

func (Permission) IsValid ¶

func (p Permission) IsValid() bool

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 Resource ¶

type Resource string

func UnmarshalResource ¶

func UnmarshalResource(resource string) Resource

func (Resource) IsValid ¶

func (d Resource) IsValid() bool

func (Resource) Marshal ¶

func (d Resource) Marshal() string

type Role ¶

type Role string

func UnmarshalRole ¶

func UnmarshalRole(role string) Role

func (Role) IsValid ¶

func (r Role) IsValid() bool

func (Role) Marshal ¶

func (r Role) Marshal() string

type RoleCollection ¶

type RoleCollection map[Domain][]Role

type RolePermissionCollection ¶

type RolePermissionCollection map[Permission][]Resource

func (RolePermissionCollection) Permissions ¶

func (r RolePermissionCollection) Permissions() []Permission

type User ¶

type User string

User represents a user in the authorization system

func UnmarshalUser ¶

func UnmarshalUser(user string) User

func (User) IsValid ¶

func (u User) IsValid() bool

func (User) Marshal ¶

func (u User) Marshal() string

type UserPermissionCollection ¶

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

func (UserPermissionCollection) DomainPermissions ¶

func (p UserPermissionCollection) DomainPermissions(domains ...Domain) map[Domain][]Permission

func (UserPermissionCollection) Domains ¶

func (p UserPermissionCollection) Domains() []Domain

func (UserPermissionCollection) GlobalPermissions ¶

func (p UserPermissionCollection) GlobalPermissions() map[Domain][]Permission

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL