account

Documentation

Index

• Constants
• type ACL
  • func NewACL() *ACL
• type ACLFlag
• type Group
• type User
  • func CheckAuth(r *http.Request) (*User, error)
  • func (user *User) CanReadObject(userObject *UserObject) bool
  • func (user *User) CanWriteObject(userObject *UserObject) bool
  • func (user *User) GroupIDs() []uuid.UUID
  • func (user *User) InjectReadAuth(DB *gorm.DB) *gorm.DB
• type UserObject
  • func (userObject *UserObject) BeforeCreate(db *gorm.DB) error

Constants

const (
	CreatorsGroupName    string = "creators"
	AdminsGroupName      string = "admin"
	SuperAdminsGroupName string = "super-admin"
	PlayersGroupName     string = "players"
)

Types

type ACL

type ACL struct {
	Owner  ACLFlag
	Group  ACLFlag
	Others ACLFlag
}

var DefaultPermissions *ACL = NewACL()

func NewACL

func NewACL() *ACL

type ACLFlag

type ACLFlag uint8

const (
	ACLNone      ACLFlag = 0
	ACLRead      ACLFlag = 1
	ACLReadWrite ACLFlag = 2
)

type Group

type Group struct {
	model.Base
	Name   string `gorm:"unique,uniqueIndex" json:"name"`
	Admins []User `gorm:"many2many:group_admins," json:"-"`
}

type User

type User struct {
	model.Base
	Email          string `gorm:"unique;uniqueIndex"`
	Name           string
	Groups         []Group `gorm:"many2many:user_groups;"`
	AdminOfGroups  []Group `gorm:"many2many:group_admins;"`
	Domain         string  //Likely just to be part of the email
	LastIdProvider string
}

func CheckAuth

func CheckAuth(r *http.Request) (*User, error)

func (*User) CanReadObject

func (user *User) CanReadObject(userObject *UserObject) bool

func (*User) CanWriteObject

func (user *User) CanWriteObject(userObject *UserObject) bool

func (*User) GroupIDs

func (user *User) GroupIDs() []uuid.UUID

func (*User) InjectReadAuth

func (user *User) InjectReadAuth(DB *gorm.DB) *gorm.DB

type UserObject

type UserObject struct {
	model.Base
	OwnerID     uuid.UUID `json:"ownerId"`
	Owner       User      `json:"-"` //Gorm should use the field above to create an association by foreign key.
	GroupID     uuid.UUID `json:"-"`
	Group       Group     `json:"group"`
	Permissions ACL       `gorm:"embedded;embeddedPrefix:acl_"`
}

func (*UserObject) BeforeCreate

func (userObject *UserObject) BeforeCreate(db *gorm.DB) error