security

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 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 string

type Policy struct {
	Prio int64
	Cond []byte
}

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

type PolicyKey struct {
	Role string
	Perm Permission
}

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

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)
}