permission

package module

Go to main page

Versions in this module

v0

v0.4.2

Sep 18, 2026

Changes in this version

type MembersPageData

+ Search string

v0.4.1

Sep 17, 2026

v0.4.0

Sep 9, 2026

v0.3.0

Sep 7, 2026

Changes in this version

type Effective

+ func (e Effective) Actions() []security.Action

type Resolution

+ Actions []security.Action

v0.2.3

Sep 6, 2026

v0.2.2

Sep 6, 2026

v0.2.1

Sep 6, 2026

v0.2.0

Sep 5, 2026

Changes in this version

+ const ActionKeyPrefix

+ const CommandAssign

+ const CommandCreateGroup

+ const CommandForget

+ const CommandGive

+ const CommandGrant

+ const CommandRevoke

+ const CommandShow

+ const CommandUnassign

+ const DomainKeyPrefix

+ const FallbackLocale

+ const PermissionGrantDirect

+ const PermissionRevokeDirect

+ const SelectorAlternative

+ const SelectorSeparator

+ const SelectorWildcard

+ const TranslationGroup

+ const UserActionsTable

+ const ViewMembers

+ var ErrBootstrapped = errors.New(...)

+ var ErrInvalidMember = errors.New("permission: a member was named by an identifier that cannot be one")

+ var ErrNoMatch = errors.New("permission: the selector matches no action in the catalogue")

+ var ErrTooMany = errors.New("permission: the write names more than one request may")

+ func Lines(locale string) translation.Lines

+ func Locales() []string

+ func UserActions(db *data.DB) *model.Model[UserAction]

+ type BootstrapRequest struct

+ Actions []security.Action

+ Description string

+ Members []string

+ Name string

+ Slug string

+ func (r BootstrapRequest) Validate() validation.Errors

type Catalogue

+ func (c Catalogue) Match(selector string) ([]security.Action, error)

type CataloguePageData

+ Labels Labels

type Config

+ Listeners []Listener

+ Translator *translation.Translator

type Effective

+ Direct []security.Action

type EffectiveGrant

+ Direct bool

+ type Event struct

+ Actions []security.Action

+ ActorID string

+ At time.Time

+ GroupID string

+ GroupSlug string

+ Kind EventKind

+ Members []string

+ Tenant string

+ UserID string

+ Version int64

+ type EventKind string

+ const ActionsAttached

+ const ActionsDetached

+ const GroupCreated

+ const GroupDeleted

+ const GroupUpdated

+ const MembersAttached

+ const MembersDetached

type GroupPageData

+ Labels Labels

type GroupsPageData

+ Labels Labels

+ type Labels struct

+ Locale string

+ func (l Labels) Action(action security.Action) string

+ func (l Labels) Domain(name string) string

+ func (l Labels) T(key string) string

+ type Listener func(context.Context, Event)

type MatrixPageData

+ Labels Labels

+ type MemberPage struct

+ Items []MemberRef

+ Next string

type MemberPageData

+ Labels Labels

+ Sections []ActionSection

+ type MemberQuery struct

+ Cursor string

+ Group string

+ Limit int

+ type MemberRef struct

+ Direct int

+ Groups []GroupRef

+ UserID string

+ type MembersPageData struct

+ Group string

+ Groups []GroupRef

+ Labels Labels

+ Members []MemberRef

+ Next string

+ Prefix string

type Module

+ func (m *Module) Commands() []console.Command

+ func (m *Module) Labels(locale string) Labels

+ func (m *Module) Require(actions ...security.Action) fhttp.Middleware

+ func (m *Module) Service() *PermissionService

type PermissionService

+ func (s *PermissionService) Bootstrap(ctx context.Context, tenant string, in BootstrapRequest) (*Group, error)

+ func (s *PermissionService) DirectActionsOf(ctx context.Context, actor security.Subject, userID string) ([]security.Action, error)

+ func (s *PermissionService) ListMembers(ctx context.Context, actor security.Subject, q MemberQuery) (MemberPage, error)

+ func (s *PermissionService) PreviewDirectActions(ctx context.Context, actor security.Subject, userID string, ...) (Change, error)

+ func (s *PermissionService) Refresh(ctx context.Context, actor security.Subject) (int64, error)

+ func (s *PermissionService) SetDirectActions(ctx context.Context, actor security.Subject, userID string, ...) (Change, error)

type SummaryPageData

+ Labels Labels

+ Target string

+ type UserAction struct

+ Action string

+ ID string

+ TenantID string

+ UserID string

+ type UserActionPolicy struct

+ func (UserActionPolicy) Can(_ context.Context, s security.Subject, a security.Action, record UserAction) error

v0.1.0

Sep 5, 2026

Changes in this version

+ const DefaultCacheSize

+ const DefaultPageSize

+ const DefaultPrefix

+ const GroupActionsTable

+ const GroupUsersTable

+ const GroupsTable

+ const MaxBulkSize

+ const MaxDescriptionLength

+ const MaxNameLength

+ const MaxPageSize

+ const MaxSlugLength

+ const PermissionAssign

+ const PermissionCreate

+ const PermissionDelete

+ const PermissionGrant

+ const PermissionList

+ const PermissionResolve

+ const PermissionRevoke

+ const PermissionUnassign

+ const PermissionUpdate

+ const PermissionView

+ const PublishCommand

+ const VersionsTable

+ const ViewCatalogue

+ const ViewGroupsIndex

+ const ViewGroupsShow

+ const ViewMatrix

+ const ViewMember

+ const ViewSummary

+ var ErrLastMember = errors.New("permission: a system group cannot be left without a member")

+ var ErrNotFound = errors.New("permission: record not found")

+ var ErrSlugTaken = errors.New("permission: a group with this slug already exists")

+ var ErrUnknownAction = errors.New("permission: the action is not in the catalogue")

+ func Actions() []security.Action

+ func GroupActions(db *data.DB) *model.Model[GroupAction]

+ func GroupUsers(db *data.DB) *model.Model[GroupUser]

+ func Groups(db *data.DB) *model.Model[Group]

+ func PublishedPaths() []string

+ func Versions(db *data.DB) *model.Model[Version]

+ func ViewNames() []string

+ func ViewPackages() []string

+ type ActionChoice struct

+ Action security.Action

+ Held bool

+ type ActionPolicy struct

+ func (ActionPolicy) Can(_ context.Context, s security.Subject, a security.Action, record GroupAction) error

+ type ActionSection struct

+ Choices []ActionChoice

+ Domain string

+ type Catalogue struct

+ func NewCatalogue(actions ...security.Action) (Catalogue, error)

+ func (c Catalogue) All() []security.Action

+ func (c Catalogue) Domains() []Domain

+ func (c Catalogue) Has(action security.Action) bool

+ func (c Catalogue) Len() int

+ type CatalogueDomain struct

+ Entries []CatalogueEntry

+ Name string

+ type CatalogueEntry struct

+ Action security.Action

+ Groups []GroupRef

+ type CataloguePageData struct

+ Domains []CatalogueDomain

+ Prefix string

+ type CatalogueView struct

+ Domains []CatalogueDomain

+ type Change struct

+ Added []string

+ Removed []string

+ Unchanged []string

+ func (c Change) Empty() bool

+ type Config struct

+ Actions []security.Action

+ CacheSize int

+ PageSize int

+ Prefix string

+ Tenant string

+ func (c Config) Validate() error

+ type CreateGroupRequest struct

+ Description string

+ Name string

+ Slug string

+ System bool

+ func (r CreateGroupRequest) Validate() validation.Errors

+ type Domain struct

+ Actions []security.Action

+ Name string

+ type Effective struct

+ Grants []EffectiveGrant

+ Groups []GroupRef

+ UserID string

+ func (e Effective) Roles() []string

+ type EffectiveGrant struct

+ Action security.Action

+ Groups []GroupRef

+ type Group struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ IsSystem bool

+ Name string

+ Slug string

+ TenantID string

+ UpdatedAt time.Time

+ type GroupAction struct

+ Action string

+ GroupID string

+ ID string

+ TenantID string

+ type GroupPage struct

+ Items []GroupRef

+ Next string

+ type GroupPageData struct

+ Description string

+ Group GroupRef

+ Members []string

+ Prefix string

+ Sections []ActionSection

+ System bool

+ type GroupPolicy struct

+ func (GroupPolicy) Can(_ context.Context, s security.Subject, a security.Action, record Group) error

+ type GroupQuery struct

+ Cursor string

+ Limit int

+ Search string

+ type GroupRef struct

+ ID string

+ Name string

+ Slug string

+ type GroupUser struct

+ GroupID string

+ ID string

+ TenantID string

+ UserID string

+ type GroupsPageData struct

+ Groups []GroupRef

+ Next string

+ Prefix string

+ Rejected validation.Errors

+ Search string

+ type MatrixCell struct

+ Action security.Action

+ Held bool

+ type MatrixPageData struct

+ Matrix MatrixView

+ Prefix string

+ Search string

+ type MatrixRow struct

+ Cells []MatrixCell

+ Group GroupRef

+ System bool

+ type MatrixView struct

+ Actions []security.Action

+ Domains []Domain

+ Next string

+ Rows []MatrixRow

+ type MemberPageData struct

+ Effective Effective

+ Prefix string

+ type MembershipPolicy struct

+ func (MembershipPolicy) Can(_ context.Context, s security.Subject, a security.Action, record GroupUser) error

+ type Module struct

+ func New(cfg Config, db *data.DB, sessions *security.SessionStore, csrf *security.CSRF) (*Module, error)

+ func (m *Module) Boot(context.Context) error

+ func (m *Module) Migrations() []foundation.Migration

+ func (m *Module) Name() string

+ func (m *Module) Publishes() []foundation.Publication

+ func (m *Module) Roles() fhttp.Middleware

+ func (m *Module) Routes(r *fhttp.Router)

+ type PermissionService struct

+ func NewPermissionService(db *data.DB, catalogue Catalogue) *PermissionService

+ func (s *PermissionService) ActionsOf(ctx context.Context, actor security.Subject, groupID string) ([]security.Action, error)

+ func (s *PermissionService) Catalogue() Catalogue

+ func (s *PermissionService) CreateGroup(ctx context.Context, actor security.Subject, in CreateGroupRequest) (*Group, error)

+ func (s *PermissionService) DeleteGroup(ctx context.Context, actor security.Subject, id string) error

+ func (s *PermissionService) EffectiveFor(ctx context.Context, actor security.Subject, userID string) (Effective, error)

+ func (s *PermissionService) FindGroup(ctx context.Context, actor security.Subject, id string) (*Group, error)

+ func (s *PermissionService) ListGroups(ctx context.Context, actor security.Subject, q GroupQuery) (GroupPage, error)

+ func (s *PermissionService) MembersOf(ctx context.Context, actor security.Subject, groupID string) ([]string, error)

+ func (s *PermissionService) PreviewActions(ctx context.Context, actor security.Subject, groupID string, ...) (Change, error)

+ func (s *PermissionService) PreviewMembers(ctx context.Context, actor security.Subject, groupID string, wanted []string) (Change, error)

+ func (s *PermissionService) ResolveOwn(ctx context.Context, actor security.Subject) (Resolution, error)

+ func (s *PermissionService) SetActions(ctx context.Context, actor security.Subject, groupID string, ...) (Change, error)

+ func (s *PermissionService) SetMembers(ctx context.Context, actor security.Subject, groupID string, wanted []string) (Change, error)

+ func (s *PermissionService) UpdateGroup(ctx context.Context, actor security.Subject, id string, in UpdateGroupRequest) (*Group, error)

+ func (s *PermissionService) Version(ctx context.Context, actor security.Subject) (int64, error)

+ func (s *PermissionService) ViewCatalogue(ctx context.Context, actor security.Subject) (CatalogueView, error)

+ func (s *PermissionService) ViewMatrix(ctx context.Context, actor security.Subject, q GroupQuery) (MatrixView, error)

+ type Resolution struct

+ Groups []GroupRef

+ Roles []string

+ Version int64

+ type Resolver struct

+ func NewResolver(service *PermissionService, limit int) *Resolver

+ func (r *Resolver) Forget()

+ func (r *Resolver) Resolve(ctx context.Context, subject security.Subject) ([]string, error)

+ type SummaryPageData struct

+ Change Change

+ Fields []string

+ Group GroupRef

+ Kind string

+ Prefix string

+ type UpdateGroupRequest struct

+ Description string

+ Name string

+ func (r UpdateGroupRequest) Validate() validation.Errors

+ type Version struct

+ TenantID string

+ Version int64

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