auth

Documentation

Index

• Constants
• Variables
• func CanAdd[T TAuthable](a OpAuth, u T, rulesets ...RuleSet) error
• func CanCache[T TAuthable](a OpAuth, u T, field string, cache string, rulesets ...RuleSet) error
• func CanDelete[T TAuthable](a OpAuth, u T, rulesets ...RuleSet) error
• func CanUpdate[T TAuthable](a OpAuth, u T, field string, value any, rulesets ...RuleSet) error
• func CanView[T TAuthable](a OpAuth, u T, field string, value any, rulesets ...RuleSet) error
• func Init(rules map[RuleSet]string, adminRole string) error
• func UID(a *Authorizator) string
• type Authorizator
  • func NewAuthorizator(uid, role string) *Authorizator
• type IAuthenticate
• type IUser
• type OpAuth
• type Operant
• type Options
• type RuleSet
  • func (r RuleSet) String() string
• type TAuthable
• type TokenType

Constants

const (
	Interfaces = iota
	Controllers
	Doors
	Cards
	Groups
	Events
	Logs
	Users
)

Variables

var ErrDoNotCache = errors.New("not cacheable")

var ErrUnauthorised = errors.New("not authorised")

var GRULES embed.FS

Functions

func CanAdd

func CanAdd[T TAuthable](a OpAuth, u T, rulesets ...RuleSet) error

func CanCache

func CanCache[T TAuthable](a OpAuth, u T, field string, cache string, rulesets ...RuleSet) error

func CanDelete

func CanDelete[T TAuthable](a OpAuth, u T, rulesets ...RuleSet) error

func CanUpdate

func CanUpdate[T TAuthable](a OpAuth, u T, field string, value any, rulesets ...RuleSet) error

func CanView

func CanView[T TAuthable](a OpAuth, u T, field string, value any, rulesets ...RuleSet) error

func Init

func Init(rules map[RuleSet]string, adminRole string) error

func UID

func UID(a *Authorizator) string

Types

type Authorizator

type Authorizator struct {
	OpAuth
	// contains filtered or unexported fields
}

func NewAuthorizator

func NewAuthorizator(uid, role string) *Authorizator

type IAuthenticate

type IAuthenticate interface {
	Preauthenticate() (string, error)
	Authenticate(uid, pwd string) (string, error)
	Validate(uid, pwd string) error
	Verify(tokenType TokenType, token string) error
	Authenticated(token string) (string, string, string, error)
	Invalidate(tokenType TokenType, token string) error
	Options(uid, role string) Options
	AdminRole() string
}

type IUser

type IUser interface {
	Password() ([]byte, string)
	OTPKey() string
	Role() string
	Locked() bool
	IsDeleted() bool
}

type OpAuth

type OpAuth interface {
	CanView(o Operant, field string, value any, rulesets ...RuleSet) error
	CanAdd(o Operant, rulesets ...RuleSet) error
	CanUpdate(o Operant, field string, value any, rulesets ...RuleSet) error
	CanDelete(o Operant, rulesets ...RuleSet) error
	CanCache(o Operant, field string, cache string, rulesets ...RuleSet) error
}

type Operant

type Operant interface {
	AsRuleEntity() (string, any)
	CacheKey() string
}

type Options

type Options struct {
	OTP struct {
		Allowed bool
		Enabled bool
	}
}

type RuleSet

type RuleSet int

func (RuleSet) String

func (r RuleSet) String() string

type TAuthable

type TAuthable interface {
	AsRuleEntity() (string, any)
	CacheKey() string
}

type TokenType

type TokenType int

const (
	Login   TokenType = iota // 0
	Session                  // 1
)