principal

Documentation

Index

• func All(subject security.Subject, ps ...security.Principal) bool
• func Any(subject security.Subject, ps ...security.Principal) bool
• func Find[T security.Principal](subject security.Subject) []T
• func First[T security.Principal](subject security.Subject) (p T, ok bool)
• func Parse[T StringPrincipal](val any) []security.Principal
• type Email
  • func (e *Email) InitWithTag(tag reflect.StructTag) error
  • func (e Email) Name() string
• type Entitlement
  • func (e *Entitlement) InitWithTag(tag reflect.StructTag) error
  • func (e Entitlement) Name() string
• type Group
  • func (g *Group) InitWithTag(tag reflect.StructTag) error
  • func (g Group) Name() string
• type Id
  • func (i *Id) InitWithTag(tag reflect.StructTag) error
  • func (i Id) Name() string
• type Role
  • func (r *Role) InitWithTag(tag reflect.StructTag) error
  • func (r Role) Name() string
• type StringPrincipal
• type User
  • func (u *User) InitWithTag(tag reflect.StructTag) error
  • func (u User) Name() string

Functions

func All

func All(subject security.Subject, ps ...security.Principal) bool

All returns true if the security.Subject possess all security.Principal's.

func Any

func Any(subject security.Subject, ps ...security.Principal) bool

Any returns true if the security.Subject possess any security.Principal's.

func Find

func Find[T security.Principal](subject security.Subject) []T

Find returns each security.Principal of the specified type.

func First

func First[T security.Principal](subject security.Subject) (p T, ok bool)

First returns the first security.Principal of the specified type.

func Parse

func Parse[T StringPrincipal](val any) []security.Principal

Types

type Email

type Email string

Email is used to hold the email address of the subject. i.e. johm.doe@domain.com

func (*Email) InitWithTag

func (e *Email) InitWithTag(tag reflect.StructTag) error

func (Email) Name

func (e Email) Name() string

type Entitlement

type Entitlement string

Entitlement refers to the rights and privileges granted to a user or a group. i.e. createWidget

func (*Entitlement) InitWithTag

func (e *Entitlement) InitWithTag(tag reflect.StructTag) error

func (Entitlement) Name

func (e Entitlement) Name() string

type Group

type Group string

Group organizes users having common capabilities. i.e. admin

func (*Group) InitWithTag

func (g *Group) InitWithTag(tag reflect.StructTag) error

func (Group) Name

func (g Group) Name() string

type Id

type Id string

Id represents the identity of a subject. i.e. user

func (*Id) InitWithTag

func (i *Id) InitWithTag(tag reflect.StructTag) error

func (Id) Name

func (i Id) Name() string

type Role

type Role string

Role represents a certain level of authorization. i.e. operator

func (*Role) InitWithTag

func (r *Role) InitWithTag(tag reflect.StructTag) error

func (Role) Name

func (r Role) Name() string

type StringPrincipal

type StringPrincipal interface {
	~string
	security.Principal
}

StringPrincipal is a generic constraint for string based security.Principal.

type User

type User string

User identifies a username or account name. i.e. test1

func (*User) InitWithTag

func (u *User) InitWithTag(tag reflect.StructTag) error

func (User) Name

func (u User) Name() string