security

Documentation

Index

• Variables
• type CustomGatekeeper
• type Gatekeeper
• type Permission
  • func Perm(action, resource string) (p Permission)
  • func (p Permission) Action() string
  • func (p Permission) HasAction() bool
  • func (p Permission) HasResource() bool
  • func (p Permission) HasWildcard() bool
  • func (p Permission) IsZero() bool
  • func (p1 Permission) Match(p2 Permission) Permission
  • func (p Permission) Resource() string
  • func (p *Permission) SetAction(action string)
  • func (p *Permission) SetResource(resource string)
  • func (p Permission) String() string
• type Policy
• type PolicyData
• type PolicyKey
• type PolicyStore
  • func (s *PolicyStore) AddPolicies(policies iter.Seq[PolicyData]) (err error)
  • func (s *PolicyStore) AddPoliciesSlice(policies []PolicyData) (err error)
  • func (s *PolicyStore) AddPolicy(role string, perm Permission, prio int64, cond ...any) (err error)
  • func (s *PolicyStore) Get(roles []string, perm Permission) (cond unsafe.Pointer, err error)
  • func (s *PolicyStore) GetType(perm Permission) (typ reflect.Type, ok bool)
  • func (s *PolicyStore) Has(roles []string, perm Permission) bool
  • func (s *PolicyStore) IteratePermissions(inPolicy ...bool) iter.Seq[Permission]
  • func (s *PolicyStore) IteratePolicies() iter.Seq2[PolicyKey, Policy]
  • func (s *PolicyStore) Register(perm Permission, typ reflect.Type) (err error)
  • func (s *PolicyStore) Remove(role string, perm Permission)
• type RolesGatekeeper

Variables

var (
	ErrInvalidAuthToken = errors.NewError("INVALID_TOKEN", "Invalid authentication token", 401)
	ErrInvalidAuthCode  = errors.NewError("INVALID_CODE", "Invalid authentication code", 401)
	ErrAccessDenied     = errors.NewFrozenError("ACCESS_DENIED", "Access denied", 403)
)

Types

type CustomGatekeeper

type CustomGatekeeper interface {
	Gatekeeper

	// Policy is always a pointer to the route's policy.
	HandleSecurity(c *fasthttp.RequestCtx, perm Permission, policy any) error
}

type Gatekeeper

type Gatekeeper interface {

	// Describes the security scheme. This is a general description about how to authenticate
	// in the application.
	SecurityScheme() openapi.SecurityScheme

	// Describes the security requirement per route based on its permission tag (if any).
	SecurityRequirement(perm Permission) openapi.SecurityRequirement

	// Handler that always will be called exactly one (1) time at the beginning of any request,
	// regardless permission or policy. Good for e.g. setting a user value on the context.
	PreRequest(c *fasthttp.RequestCtx) error

	// Whether permission tags on routes is optional.
	OptionalPermTag() bool
}

type Permission

type Permission string

func Perm

func Perm(action, resource string) (p Permission)

func (Permission) Action

func (p Permission) Action() string

func (Permission) HasAction

func (p Permission) HasAction() bool

func (Permission) HasResource

func (p Permission) HasResource() bool

func (Permission) HasWildcard

func (p Permission) HasWildcard() bool

func (Permission) IsZero

func (p Permission) IsZero() bool

func (Permission) Match

func (p1 Permission) Match(p2 Permission) Permission

func (Permission) Resource

func (p Permission) Resource() string

func (*Permission) SetAction

func (p *Permission) SetAction(action string)

func (*Permission) SetResource

func (p *Permission) SetResource(resource string)

func (Permission) String

func (p Permission) String() string

type Policy

type Policy struct {
	Prio int64
	Cond []byte
}

type PolicyData

type PolicyData struct {
	Role string
	Perm Permission
	Prio int64
	Cond any
}

type PolicyKey

type PolicyKey struct {
	Role string
	Perm Permission
}

type PolicyStore

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

func (*PolicyStore) AddPolicies

func (s *PolicyStore) AddPolicies(policies iter.Seq[PolicyData]) (err error)

func (*PolicyStore) AddPoliciesSlice

func (s *PolicyStore) AddPoliciesSlice(policies []PolicyData) (err error)

func (*PolicyStore) AddPolicy

func (s *PolicyStore) AddPolicy(role string, perm Permission, prio int64, cond ...any) (err error)

func (*PolicyStore) Get

func (s *PolicyStore) Get(roles []string, perm Permission) (cond unsafe.Pointer, err error)

func (*PolicyStore) GetType

func (s *PolicyStore) GetType(perm Permission) (typ reflect.Type, ok bool)

func (*PolicyStore) Has

func (s *PolicyStore) Has(roles []string, perm Permission) bool

func (*PolicyStore) IteratePermissions

func (s *PolicyStore) IteratePermissions(inPolicy ...bool) iter.Seq[Permission]

func (*PolicyStore) IteratePolicies

func (s *PolicyStore) IteratePolicies() iter.Seq2[PolicyKey, Policy]

func (*PolicyStore) Register

func (s *PolicyStore) Register(perm Permission, typ reflect.Type) (err error)

func (*PolicyStore) Remove

func (s *PolicyStore) Remove(role string, perm Permission)

type RolesGatekeeper

type RolesGatekeeper interface {
	Gatekeeper

	// Returns the roles that a particular HTTP request has. Will only be called on routes with
	// a permission requirement set.
	UserRoles(c *fasthttp.RequestCtx) (roles []string, err error)
}