mrperms

Documentation

Index

• type AccessControl
• type AccessControlOptions
• type AccessRights
• type AppSection
  • func NewAppSection(opts AppSectionOptions) AppSection
• type AppSectionOptions
• type RoleAccessControl
  • func NewAccessControl(opts AccessControlOptions) (*RoleAccessControl, error)
  • func (a *RoleAccessControl) CheckPermission(rolesIDs []uint16, name string) bool
  • func (a *RoleAccessControl) CheckPrivilege(rolesIDs []uint16, name string) bool
  • func (a *RoleAccessControl) GuestRole() string
  • func (a *RoleAccessControl) HasPermission(name string) bool
  • func (a *RoleAccessControl) HasPrivilege(name string) bool
  • func (a *RoleAccessControl) NewAccessRights(roles ...string) AccessRights
  • func (a *RoleAccessControl) RegisteredPermissions() []string
  • func (a *RoleAccessControl) RegisteredPrivileges() []string
  • func (a *RoleAccessControl) RegisteredRoles() []string

Types

type AccessControl

type AccessControl interface {
	NewAccessRights(members ...string) AccessRights
	HasPrivilege(name string) bool
	HasPermission(name string) bool
}

type AccessControlOptions

type AccessControlOptions struct {
	RolesDirPath  string
	RolesFileType string
	Roles         []string
	Privileges    []string
	Permissions   []string
	GuestRole     string // optional
}

type AccessRights

type AccessRights interface {
	IsGuestAccess() bool
	CheckPrivilege(name string) bool
	CheckPermission(name string) bool
}

type AppSection

type AppSection interface {
	Caption() string
	Path(actionPath string) string
	Privilege() string
	Secret() string
	Audience() string
}

func NewAppSection

func NewAppSection(opts AppSectionOptions) AppSection

type AppSectionOptions

type AppSectionOptions struct {
	Caption      string
	RootPath     string
	Privilege    string
	AuthSecret   string
	AuthAudience string
}

type RoleAccessControl

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

func NewAccessControl

func NewAccessControl(opts AccessControlOptions) (*RoleAccessControl, error)

func (*RoleAccessControl) CheckPermission

func (a *RoleAccessControl) CheckPermission(rolesIDs []uint16, name string) bool

func (*RoleAccessControl) CheckPrivilege

func (a *RoleAccessControl) CheckPrivilege(rolesIDs []uint16, name string) bool

func (*RoleAccessControl) GuestRole

func (a *RoleAccessControl) GuestRole() string

func (*RoleAccessControl) HasPermission

func (a *RoleAccessControl) HasPermission(name string) bool

func (*RoleAccessControl) HasPrivilege

func (a *RoleAccessControl) HasPrivilege(name string) bool

func (*RoleAccessControl) NewAccessRights

func (a *RoleAccessControl) NewAccessRights(roles ...string) AccessRights

func (*RoleAccessControl) RegisteredPermissions

func (a *RoleAccessControl) RegisteredPermissions() []string

func (*RoleAccessControl) RegisteredPrivileges

func (a *RoleAccessControl) RegisteredPrivileges() []string

func (*RoleAccessControl) RegisteredRoles

func (a *RoleAccessControl) RegisteredRoles() []string