Security: WebFiori/docs

Security

security.md

Security & Authorization

WebFiori provides a layered security system combining authentication state management, role-based access control (RBAC), attribute-based access control (ABAC), and declarative annotations for endpoint protection.

Components Overview

ComponentPackageRole
SecurityContextwebfiori/httpHolds current authenticated user for the request
SecurityPrincipalwebfiori/httpInterface for user objects
#[RequiresAuth]webfiori/httpAnnotation: endpoint requires authentication
#[PreAuthorize]webfiori/httpAnnotation: expression-based access control
Accesswebfiori/frameworkRBAC role/permission definitions
AccessManagerwebfiori/frameworkRBAC + ABAC policy evaluation
AuthorizeMiddlewarewebfiori/frameworkMiddleware for permission checks

SecurityPrincipal

Implement this interface on your user class:

<?phpnamespaceApp\Domain;
useWebFiori\Http\SecurityPrincipal;
class User implements SecurityPrincipal {
publicfunction__construct(
publicint$id,
publicstring$name,
publicstring$role
) {
}
publicfunctiongetAuthorities(): array {
returnmatch ($this->role) {
'admin' => ['users.manage', 'orders.manage', 'orders.view'],
'customer' => ['orders.create', 'orders.view'],
default => []
};
}
publicfunctiongetId(): int|string {
return$this->id;
}
publicfunctiongetName(): string {
return$this->name;
}
publicfunctiongetRoles(): array {
return [$this->role];
}
publicfunctionisActive(): bool {
returntrue;
}
}

SecurityContext

Set the current user during request processing (typically in middleware):

useWebFiori\Http\SecurityContext;
// Set authenticated user
SecurityContext::setCurrentUser($user);
// Check authentication
SecurityContext::isAuthenticated(); // true if user is set and active// Get current user$user = SecurityContext::getCurrentUser();
// Check roles and authorities
SecurityContext::hasRole('admin');
SecurityContext::hasAuthority('orders.manage');
// Clear (e.g., on logout)
SecurityContext::clear();

Declarative Annotations

#[RequiresAuth]

Requires the user to be authenticated. Can be placed on a class (all methods) or individual methods:

useWebFiori\Http\Annotations\RequiresAuth;
useWebFiori\Http\Annotations\RestController;
#[RestController('orders', 'Order API')]
#[RequiresAuth] // All methods require authenticationclass OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
// ...
}

#[PreAuthorize]

Evaluates a security expression before the method executes:

useWebFiori\Http\Annotations\PreAuthorize;
// Single role check
#[PreAuthorize("hasRole('admin')")]
publicfunctiondeleteUser(): array { ... }
// Single authority check
#[PreAuthorize("hasAuthority('orders.manage')")]
publicfunctionshipOrder(): array { ... }
// Multiple roles (any)
#[PreAuthorize("hasAnyRole('admin', 'moderator')")]
publicfunctionbanUser(): array { ... }
// Combined with AND
#[PreAuthorize("isAuthenticated() && hasAuthority('reports.view')")]
publicfunctiongetReport(): array { ... }
// Combined with OR
#[PreAuthorize("hasRole('admin') || hasAuthority('orders.manage')")]
publicfunctioncancelOrder(): array { ... }

Supported expressions:

ExpressionMeaning
hasRole('ROLE')User has the specified role
hasAnyRole('R1', 'R2')User has any of the listed roles
hasAuthority('PERM')User has the specified authority/permission
hasAnyAuthority('P1', 'P2')User has any of the listed authorities
isAuthenticated()User is authenticated and active
permitAll()Always allows access

Combine with && (AND) and || (OR).

#[AllowAnonymous]

Skips all authentication checks for a method:

#[AllowAnonymous]
publicfunctiongetPublicData(): array { ... }

RBAC with Access

Define roles and their permissions during initialization:

useWebFiori\Framework\Access;
// Define roles with permissions
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('staff', ['orders.view', 'orders.update', 'orders.ship']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel',
'orders.update', 'orders.ship', 'orders.manage']);
// Assign role to user (for storage-backed scenarios)
Access::assignRoleToUser($userId, 'customer');

Permission and group IDs can contain letters (A-Z, a-z), digits (0-9), underscores (_), dots (.), and dashes (-). Dots and dashes are useful as namespace separators (e.g., orders.create, billing-read).

Role Inheritance

Roles can inherit permissions from a parent role:

Access::role('manager', ['reports.view'])->inherits('staff');
// manager now has: reports.view + all staff permissions

Checking Permissions

// Pass user object — reads roles from getRoles() if no internal mapping exists
Access::can($user, 'orders.cancel');
// Pass user ID — uses roles from assignRoleToUser() or storage
Access::can(42, 'orders.cancel');

Storage Backends

By default, roles are stored in memory. For persistence across requests, use a storage backend:

BackendClassUse Case
In-memoryInMemoryAccessStorageTesting, stateless APIs
File-basedFileAccessStorageSimple deployments
DatabaseDatabaseAccessStorageProduction with DB
useWebFiori\Framework\AccessManager;
useWebFiori\Framework\Storage\DatabaseAccessStorage;
$manager = newAccessManager(newDatabaseAccessStorage($connectionName));
$manager->loadFromStorage(); // load roles/permissions from DB

To persist changes:

$manager->saveToStorage();

ABAC with Policies

Policies add resource-level rules on top of RBAC. A policy is evaluated only after the RBAC check passes.

Creating a Policy

Create policy classes under App/Policies/:

<?phpnamespaceApp\Policies;
useApp\Domain\Order;
class OrderCancelPolicy {
publicfunctiongetPermission(): string {
return'orders.cancel';
}
publicfunctionevaluate($user, ?object$resource = null): bool {
if ($resource === null || !$resourceinstanceof Order) {
returnfalse;
}
// Only pending orders can be cancelledif ($resource->status !== 'pending') {
returnfalse;
}
// Admin can cancel any pending orderif (in_array('admin', $user->getRoles())) {
returntrue;
}
// Customers can only cancel their own ordersreturn$user->getId() === $resource->userId;
}
}

Registering Policies

useApp\Policies\OrderCancelPolicy;
useWebFiori\Framework\Access;
Access::registerPolicy(newOrderCancelPolicy());

Using Policies

Pass the resource as the third argument to can():

$order = $orderRepo->findById($id);
if (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('You cannot cancel this order.');
}

The evaluation flow:

  1. RBAC check: Does the user's role have the orders.cancel permission? If no → denied.
  2. Policy check: Does OrderCancelPolicy::evaluate($user, $order) return true? If no → denied.
  3. Both pass → allowed.

Putting It Together

A typical setup in App/Ini/Privileges.php:

<?phpnamespaceApp\Ini;
useApp\Policies\OrderCancelPolicy;
useApp\Policies\OrderViewPolicy;
useWebFiori\Framework\Access;
class Privileges {
publicstaticfunctioninitialize() {
// RBAC
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel', 'orders.manage']);
// ABAC
Access::registerPolicy(newOrderViewPolicy());
Access::registerPolicy(newOrderCancelPolicy());
}
}

A middleware that loads the user into SecurityContext:

<?phpnamespaceApp\Middleware;
useWebFiori\Framework\Access;
useWebFiori\Framework\Middleware\AbstractMiddleware;
useWebFiori\Http\SecurityContext;
class SecurityContextLoader extends AbstractMiddleware {
publicfunctionbefore(Request$request, Response$response) {
$userId = SessionsManager::get('user-id');
if ($userId === null) {
SecurityContext::clear();
return;
}
$user = $this->loadUser($userId);
if ($user !== null && $user->isActive()) {
SecurityContext::setCurrentUser($user);
Access::assignRoleToUser($user->getId(), $user->role);
}
}
}

A service using both annotations and Access::can():

#[RestController('orders', 'Order API')]
#[RequiresAuth]
class OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
#[DeleteMapping]
#[PreAuthorize("hasAuthority('orders.cancel')")]
publicfunctioncancelOrder(?int$id = null): array {
$order = $this->repo->findById($id);
$user = SecurityContext::getCurrentUser();
// ABAC: policy checks ownership + statusif (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('Cannot cancel this order.');
}
$order->status = 'cancelled';
$this->repo->save($order);
return [$order];
}
}

There aren't any published security advisories

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Security: WebFiori/docs

Security

security.md

Security & Authorization

WebFiori provides a layered security system combining authentication state management, role-based access control (RBAC), attribute-based access control (ABAC), and declarative annotations for endpoint protection.

Components Overview

ComponentPackageRole
SecurityContextwebfiori/httpHolds current authenticated user for the request
SecurityPrincipalwebfiori/httpInterface for user objects
#[RequiresAuth]webfiori/httpAnnotation: endpoint requires authentication
#[PreAuthorize]webfiori/httpAnnotation: expression-based access control
Accesswebfiori/frameworkRBAC role/permission definitions
AccessManagerwebfiori/frameworkRBAC + ABAC policy evaluation
AuthorizeMiddlewarewebfiori/frameworkMiddleware for permission checks

SecurityPrincipal

Implement this interface on your user class:

<?phpnamespaceApp\Domain;
useWebFiori\Http\SecurityPrincipal;
class User implements SecurityPrincipal {
publicfunction__construct(
publicint$id,
publicstring$name,
publicstring$role
) {
}
publicfunctiongetAuthorities(): array {
returnmatch ($this->role) {
'admin' => ['users.manage', 'orders.manage', 'orders.view'],
'customer' => ['orders.create', 'orders.view'],
default => []
};
}
publicfunctiongetId(): int|string {
return$this->id;
}
publicfunctiongetName(): string {
return$this->name;
}
publicfunctiongetRoles(): array {
return [$this->role];
}
publicfunctionisActive(): bool {
returntrue;
}
}

SecurityContext

Set the current user during request processing (typically in middleware):

useWebFiori\Http\SecurityContext;
// Set authenticated user
SecurityContext::setCurrentUser($user);
// Check authentication
SecurityContext::isAuthenticated(); // true if user is set and active// Get current user$user = SecurityContext::getCurrentUser();
// Check roles and authorities
SecurityContext::hasRole('admin');
SecurityContext::hasAuthority('orders.manage');
// Clear (e.g., on logout)
SecurityContext::clear();

Declarative Annotations

#[RequiresAuth]

Requires the user to be authenticated. Can be placed on a class (all methods) or individual methods:

useWebFiori\Http\Annotations\RequiresAuth;
useWebFiori\Http\Annotations\RestController;
#[RestController('orders', 'Order API')]
#[RequiresAuth] // All methods require authenticationclass OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
// ...
}

#[PreAuthorize]

Evaluates a security expression before the method executes:

useWebFiori\Http\Annotations\PreAuthorize;
// Single role check
#[PreAuthorize("hasRole('admin')")]
publicfunctiondeleteUser(): array { ... }
// Single authority check
#[PreAuthorize("hasAuthority('orders.manage')")]
publicfunctionshipOrder(): array { ... }
// Multiple roles (any)
#[PreAuthorize("hasAnyRole('admin', 'moderator')")]
publicfunctionbanUser(): array { ... }
// Combined with AND
#[PreAuthorize("isAuthenticated() && hasAuthority('reports.view')")]
publicfunctiongetReport(): array { ... }
// Combined with OR
#[PreAuthorize("hasRole('admin') || hasAuthority('orders.manage')")]
publicfunctioncancelOrder(): array { ... }

Supported expressions:

ExpressionMeaning
hasRole('ROLE')User has the specified role
hasAnyRole('R1', 'R2')User has any of the listed roles
hasAuthority('PERM')User has the specified authority/permission
hasAnyAuthority('P1', 'P2')User has any of the listed authorities
isAuthenticated()User is authenticated and active
permitAll()Always allows access

Combine with && (AND) and || (OR).

#[AllowAnonymous]

Skips all authentication checks for a method:

#[AllowAnonymous]
publicfunctiongetPublicData(): array { ... }

RBAC with Access

Define roles and their permissions during initialization:

useWebFiori\Framework\Access;
// Define roles with permissions
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('staff', ['orders.view', 'orders.update', 'orders.ship']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel',
'orders.update', 'orders.ship', 'orders.manage']);
// Assign role to user (for storage-backed scenarios)
Access::assignRoleToUser($userId, 'customer');

Permission and group IDs can contain letters (A-Z, a-z), digits (0-9), underscores (_), dots (.), and dashes (-). Dots and dashes are useful as namespace separators (e.g., orders.create, billing-read).

Role Inheritance

Roles can inherit permissions from a parent role:

Access::role('manager', ['reports.view'])->inherits('staff');
// manager now has: reports.view + all staff permissions

Checking Permissions

// Pass user object — reads roles from getRoles() if no internal mapping exists
Access::can($user, 'orders.cancel');
// Pass user ID — uses roles from assignRoleToUser() or storage
Access::can(42, 'orders.cancel');

Storage Backends

By default, roles are stored in memory. For persistence across requests, use a storage backend:

BackendClassUse Case
In-memoryInMemoryAccessStorageTesting, stateless APIs
File-basedFileAccessStorageSimple deployments
DatabaseDatabaseAccessStorageProduction with DB
useWebFiori\Framework\AccessManager;
useWebFiori\Framework\Storage\DatabaseAccessStorage;
$manager = newAccessManager(newDatabaseAccessStorage($connectionName));
$manager->loadFromStorage(); // load roles/permissions from DB

To persist changes:

$manager->saveToStorage();

ABAC with Policies

Policies add resource-level rules on top of RBAC. A policy is evaluated only after the RBAC check passes.

Creating a Policy

Create policy classes under App/Policies/:

<?phpnamespaceApp\Policies;
useApp\Domain\Order;
class OrderCancelPolicy {
publicfunctiongetPermission(): string {
return'orders.cancel';
}
publicfunctionevaluate($user, ?object$resource = null): bool {
if ($resource === null || !$resourceinstanceof Order) {
returnfalse;
}
// Only pending orders can be cancelledif ($resource->status !== 'pending') {
returnfalse;
}
// Admin can cancel any pending orderif (in_array('admin', $user->getRoles())) {
returntrue;
}
// Customers can only cancel their own ordersreturn$user->getId() === $resource->userId;
}
}

Registering Policies

useApp\Policies\OrderCancelPolicy;
useWebFiori\Framework\Access;
Access::registerPolicy(newOrderCancelPolicy());

Using Policies

Pass the resource as the third argument to can():

$order = $orderRepo->findById($id);
if (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('You cannot cancel this order.');
}

The evaluation flow:

  1. RBAC check: Does the user's role have the orders.cancel permission? If no → denied.
  2. Policy check: Does OrderCancelPolicy::evaluate($user, $order) return true? If no → denied.
  3. Both pass → allowed.

Putting It Together

A typical setup in App/Ini/Privileges.php:

<?phpnamespaceApp\Ini;
useApp\Policies\OrderCancelPolicy;
useApp\Policies\OrderViewPolicy;
useWebFiori\Framework\Access;
class Privileges {
publicstaticfunctioninitialize() {
// RBAC
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel', 'orders.manage']);
// ABAC
Access::registerPolicy(newOrderViewPolicy());
Access::registerPolicy(newOrderCancelPolicy());
}
}

A middleware that loads the user into SecurityContext:

<?phpnamespaceApp\Middleware;
useWebFiori\Framework\Access;
useWebFiori\Framework\Middleware\AbstractMiddleware;
useWebFiori\Http\SecurityContext;
class SecurityContextLoader extends AbstractMiddleware {
publicfunctionbefore(Request$request, Response$response) {
$userId = SessionsManager::get('user-id');
if ($userId === null) {
SecurityContext::clear();
return;
}
$user = $this->loadUser($userId);
if ($user !== null && $user->isActive()) {
SecurityContext::setCurrentUser($user);
Access::assignRoleToUser($user->getId(), $user->role);
}
}
}

A service using both annotations and Access::can():

#[RestController('orders', 'Order API')]
#[RequiresAuth]
class OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
#[DeleteMapping]
#[PreAuthorize("hasAuthority('orders.cancel')")]
publicfunctioncancelOrder(?int$id = null): array {
$order = $this->repo->findById($id);
$user = SecurityContext::getCurrentUser();
// ABAC: policy checks ownership + statusif (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('Cannot cancel this order.');
}
$order->status = 'cancelled';
$this->repo->save($order);
return [$order];
}
}

There aren't any published security advisories

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Security: WebFiori/docs

Security

security.md

Security & Authorization

WebFiori provides a layered security system combining authentication state management, role-based access control (RBAC), attribute-based access control (ABAC), and declarative annotations for endpoint protection.

Components Overview

ComponentPackageRole
SecurityContextwebfiori/httpHolds current authenticated user for the request
SecurityPrincipalwebfiori/httpInterface for user objects
#[RequiresAuth]webfiori/httpAnnotation: endpoint requires authentication
#[PreAuthorize]webfiori/httpAnnotation: expression-based access control
Accesswebfiori/frameworkRBAC role/permission definitions
AccessManagerwebfiori/frameworkRBAC + ABAC policy evaluation
AuthorizeMiddlewarewebfiori/frameworkMiddleware for permission checks

SecurityPrincipal

Implement this interface on your user class:

<?phpnamespaceApp\Domain;
useWebFiori\Http\SecurityPrincipal;
class User implements SecurityPrincipal {
publicfunction__construct(
publicint$id,
publicstring$name,
publicstring$role
) {
}
publicfunctiongetAuthorities(): array {
returnmatch ($this->role) {
'admin' => ['users.manage', 'orders.manage', 'orders.view'],
'customer' => ['orders.create', 'orders.view'],
default => []
};
}
publicfunctiongetId(): int|string {
return$this->id;
}
publicfunctiongetName(): string {
return$this->name;
}
publicfunctiongetRoles(): array {
return [$this->role];
}
publicfunctionisActive(): bool {
returntrue;
}
}

SecurityContext

Set the current user during request processing (typically in middleware):

useWebFiori\Http\SecurityContext;
// Set authenticated user
SecurityContext::setCurrentUser($user);
// Check authentication
SecurityContext::isAuthenticated(); // true if user is set and active// Get current user$user = SecurityContext::getCurrentUser();
// Check roles and authorities
SecurityContext::hasRole('admin');
SecurityContext::hasAuthority('orders.manage');
// Clear (e.g., on logout)
SecurityContext::clear();

Declarative Annotations

#[RequiresAuth]

Requires the user to be authenticated. Can be placed on a class (all methods) or individual methods:

useWebFiori\Http\Annotations\RequiresAuth;
useWebFiori\Http\Annotations\RestController;
#[RestController('orders', 'Order API')]
#[RequiresAuth] // All methods require authenticationclass OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
// ...
}

#[PreAuthorize]

Evaluates a security expression before the method executes:

useWebFiori\Http\Annotations\PreAuthorize;
// Single role check
#[PreAuthorize("hasRole('admin')")]
publicfunctiondeleteUser(): array { ... }
// Single authority check
#[PreAuthorize("hasAuthority('orders.manage')")]
publicfunctionshipOrder(): array { ... }
// Multiple roles (any)
#[PreAuthorize("hasAnyRole('admin', 'moderator')")]
publicfunctionbanUser(): array { ... }
// Combined with AND
#[PreAuthorize("isAuthenticated() && hasAuthority('reports.view')")]
publicfunctiongetReport(): array { ... }
// Combined with OR
#[PreAuthorize("hasRole('admin') || hasAuthority('orders.manage')")]
publicfunctioncancelOrder(): array { ... }

Supported expressions:

ExpressionMeaning
hasRole('ROLE')User has the specified role
hasAnyRole('R1', 'R2')User has any of the listed roles
hasAuthority('PERM')User has the specified authority/permission
hasAnyAuthority('P1', 'P2')User has any of the listed authorities
isAuthenticated()User is authenticated and active
permitAll()Always allows access

Combine with && (AND) and || (OR).

#[AllowAnonymous]

Skips all authentication checks for a method:

#[AllowAnonymous]
publicfunctiongetPublicData(): array { ... }

RBAC with Access

Define roles and their permissions during initialization:

useWebFiori\Framework\Access;
// Define roles with permissions
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('staff', ['orders.view', 'orders.update', 'orders.ship']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel',
'orders.update', 'orders.ship', 'orders.manage']);
// Assign role to user (for storage-backed scenarios)
Access::assignRoleToUser($userId, 'customer');

Permission and group IDs can contain letters (A-Z, a-z), digits (0-9), underscores (_), dots (.), and dashes (-). Dots and dashes are useful as namespace separators (e.g., orders.create, billing-read).

Role Inheritance

Roles can inherit permissions from a parent role:

Access::role('manager', ['reports.view'])->inherits('staff');
// manager now has: reports.view + all staff permissions

Checking Permissions

// Pass user object — reads roles from getRoles() if no internal mapping exists
Access::can($user, 'orders.cancel');
// Pass user ID — uses roles from assignRoleToUser() or storage
Access::can(42, 'orders.cancel');

Storage Backends

By default, roles are stored in memory. For persistence across requests, use a storage backend:

BackendClassUse Case
In-memoryInMemoryAccessStorageTesting, stateless APIs
File-basedFileAccessStorageSimple deployments
DatabaseDatabaseAccessStorageProduction with DB
useWebFiori\Framework\AccessManager;
useWebFiori\Framework\Storage\DatabaseAccessStorage;
$manager = newAccessManager(newDatabaseAccessStorage($connectionName));
$manager->loadFromStorage(); // load roles/permissions from DB

To persist changes:

$manager->saveToStorage();

ABAC with Policies

Policies add resource-level rules on top of RBAC. A policy is evaluated only after the RBAC check passes.

Creating a Policy

Create policy classes under App/Policies/:

<?phpnamespaceApp\Policies;
useApp\Domain\Order;
class OrderCancelPolicy {
publicfunctiongetPermission(): string {
return'orders.cancel';
}
publicfunctionevaluate($user, ?object$resource = null): bool {
if ($resource === null || !$resourceinstanceof Order) {
returnfalse;
}
// Only pending orders can be cancelledif ($resource->status !== 'pending') {
returnfalse;
}
// Admin can cancel any pending orderif (in_array('admin', $user->getRoles())) {
returntrue;
}
// Customers can only cancel their own ordersreturn$user->getId() === $resource->userId;
}
}

Registering Policies

useApp\Policies\OrderCancelPolicy;
useWebFiori\Framework\Access;
Access::registerPolicy(newOrderCancelPolicy());

Using Policies

Pass the resource as the third argument to can():

$order = $orderRepo->findById($id);
if (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('You cannot cancel this order.');
}

The evaluation flow:

  1. RBAC check: Does the user's role have the orders.cancel permission? If no → denied.
  2. Policy check: Does OrderCancelPolicy::evaluate($user, $order) return true? If no → denied.
  3. Both pass → allowed.

Putting It Together

A typical setup in App/Ini/Privileges.php:

<?phpnamespaceApp\Ini;
useApp\Policies\OrderCancelPolicy;
useApp\Policies\OrderViewPolicy;
useWebFiori\Framework\Access;
class Privileges {
publicstaticfunctioninitialize() {
// RBAC
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel', 'orders.manage']);
// ABAC
Access::registerPolicy(newOrderViewPolicy());
Access::registerPolicy(newOrderCancelPolicy());
}
}

A middleware that loads the user into SecurityContext:

<?phpnamespaceApp\Middleware;
useWebFiori\Framework\Access;
useWebFiori\Framework\Middleware\AbstractMiddleware;
useWebFiori\Http\SecurityContext;
class SecurityContextLoader extends AbstractMiddleware {
publicfunctionbefore(Request$request, Response$response) {
$userId = SessionsManager::get('user-id');
if ($userId === null) {
SecurityContext::clear();
return;
}
$user = $this->loadUser($userId);
if ($user !== null && $user->isActive()) {
SecurityContext::setCurrentUser($user);
Access::assignRoleToUser($user->getId(), $user->role);
}
}
}

A service using both annotations and Access::can():

#[RestController('orders', 'Order API')]
#[RequiresAuth]
class OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
#[DeleteMapping]
#[PreAuthorize("hasAuthority('orders.cancel')")]
publicfunctioncancelOrder(?int$id = null): array {
$order = $this->repo->findById($id);
$user = SecurityContext::getCurrentUser();
// ABAC: policy checks ownership + statusif (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('Cannot cancel this order.');
}
$order->status = 'cancelled';
$this->repo->save($order);
return [$order];
}
}

There aren't any published security advisories

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Security: WebFiori/docs

Security

security.md

Security & Authorization

WebFiori provides a layered security system combining authentication state management, role-based access control (RBAC), attribute-based access control (ABAC), and declarative annotations for endpoint protection.

Components Overview

ComponentPackageRole
SecurityContextwebfiori/httpHolds current authenticated user for the request
SecurityPrincipalwebfiori/httpInterface for user objects
#[RequiresAuth]webfiori/httpAnnotation: endpoint requires authentication
#[PreAuthorize]webfiori/httpAnnotation: expression-based access control
Accesswebfiori/frameworkRBAC role/permission definitions
AccessManagerwebfiori/frameworkRBAC + ABAC policy evaluation
AuthorizeMiddlewarewebfiori/frameworkMiddleware for permission checks

SecurityPrincipal

Implement this interface on your user class:

<?phpnamespaceApp\Domain;
useWebFiori\Http\SecurityPrincipal;
class User implements SecurityPrincipal {
publicfunction__construct(
publicint$id,
publicstring$name,
publicstring$role
) {
}
publicfunctiongetAuthorities(): array {
returnmatch ($this->role) {
'admin' => ['users.manage', 'orders.manage', 'orders.view'],
'customer' => ['orders.create', 'orders.view'],
default => []
};
}
publicfunctiongetId(): int|string {
return$this->id;
}
publicfunctiongetName(): string {
return$this->name;
}
publicfunctiongetRoles(): array {
return [$this->role];
}
publicfunctionisActive(): bool {
returntrue;
}
}

SecurityContext

Set the current user during request processing (typically in middleware):

useWebFiori\Http\SecurityContext;
// Set authenticated user
SecurityContext::setCurrentUser($user);
// Check authentication
SecurityContext::isAuthenticated(); // true if user is set and active// Get current user$user = SecurityContext::getCurrentUser();
// Check roles and authorities
SecurityContext::hasRole('admin');
SecurityContext::hasAuthority('orders.manage');
// Clear (e.g., on logout)
SecurityContext::clear();

Declarative Annotations

#[RequiresAuth]

Requires the user to be authenticated. Can be placed on a class (all methods) or individual methods:

useWebFiori\Http\Annotations\RequiresAuth;
useWebFiori\Http\Annotations\RestController;
#[RestController('orders', 'Order API')]
#[RequiresAuth] // All methods require authenticationclass OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
// ...
}

#[PreAuthorize]

Evaluates a security expression before the method executes:

useWebFiori\Http\Annotations\PreAuthorize;
// Single role check
#[PreAuthorize("hasRole('admin')")]
publicfunctiondeleteUser(): array { ... }
// Single authority check
#[PreAuthorize("hasAuthority('orders.manage')")]
publicfunctionshipOrder(): array { ... }
// Multiple roles (any)
#[PreAuthorize("hasAnyRole('admin', 'moderator')")]
publicfunctionbanUser(): array { ... }
// Combined with AND
#[PreAuthorize("isAuthenticated() && hasAuthority('reports.view')")]
publicfunctiongetReport(): array { ... }
// Combined with OR
#[PreAuthorize("hasRole('admin') || hasAuthority('orders.manage')")]
publicfunctioncancelOrder(): array { ... }

Supported expressions:

ExpressionMeaning
hasRole('ROLE')User has the specified role
hasAnyRole('R1', 'R2')User has any of the listed roles
hasAuthority('PERM')User has the specified authority/permission
hasAnyAuthority('P1', 'P2')User has any of the listed authorities
isAuthenticated()User is authenticated and active
permitAll()Always allows access

Combine with && (AND) and || (OR).

#[AllowAnonymous]

Skips all authentication checks for a method:

#[AllowAnonymous]
publicfunctiongetPublicData(): array { ... }

RBAC with Access

Define roles and their permissions during initialization:

useWebFiori\Framework\Access;
// Define roles with permissions
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('staff', ['orders.view', 'orders.update', 'orders.ship']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel',
'orders.update', 'orders.ship', 'orders.manage']);
// Assign role to user (for storage-backed scenarios)
Access::assignRoleToUser($userId, 'customer');

Permission and group IDs can contain letters (A-Z, a-z), digits (0-9), underscores (_), dots (.), and dashes (-). Dots and dashes are useful as namespace separators (e.g., orders.create, billing-read).

Role Inheritance

Roles can inherit permissions from a parent role:

Access::role('manager', ['reports.view'])->inherits('staff');
// manager now has: reports.view + all staff permissions

Checking Permissions

// Pass user object — reads roles from getRoles() if no internal mapping exists
Access::can($user, 'orders.cancel');
// Pass user ID — uses roles from assignRoleToUser() or storage
Access::can(42, 'orders.cancel');

Storage Backends

By default, roles are stored in memory. For persistence across requests, use a storage backend:

BackendClassUse Case
In-memoryInMemoryAccessStorageTesting, stateless APIs
File-basedFileAccessStorageSimple deployments
DatabaseDatabaseAccessStorageProduction with DB
useWebFiori\Framework\AccessManager;
useWebFiori\Framework\Storage\DatabaseAccessStorage;
$manager = newAccessManager(newDatabaseAccessStorage($connectionName));
$manager->loadFromStorage(); // load roles/permissions from DB

To persist changes:

$manager->saveToStorage();

ABAC with Policies

Policies add resource-level rules on top of RBAC. A policy is evaluated only after the RBAC check passes.

Creating a Policy

Create policy classes under App/Policies/:

<?phpnamespaceApp\Policies;
useApp\Domain\Order;
class OrderCancelPolicy {
publicfunctiongetPermission(): string {
return'orders.cancel';
}
publicfunctionevaluate($user, ?object$resource = null): bool {
if ($resource === null || !$resourceinstanceof Order) {
returnfalse;
}
// Only pending orders can be cancelledif ($resource->status !== 'pending') {
returnfalse;
}
// Admin can cancel any pending orderif (in_array('admin', $user->getRoles())) {
returntrue;
}
// Customers can only cancel their own ordersreturn$user->getId() === $resource->userId;
}
}

Registering Policies

useApp\Policies\OrderCancelPolicy;
useWebFiori\Framework\Access;
Access::registerPolicy(newOrderCancelPolicy());

Using Policies

Pass the resource as the third argument to can():

$order = $orderRepo->findById($id);
if (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('You cannot cancel this order.');
}

The evaluation flow:

  1. RBAC check: Does the user's role have the orders.cancel permission? If no → denied.
  2. Policy check: Does OrderCancelPolicy::evaluate($user, $order) return true? If no → denied.
  3. Both pass → allowed.

Putting It Together

A typical setup in App/Ini/Privileges.php:

<?phpnamespaceApp\Ini;
useApp\Policies\OrderCancelPolicy;
useApp\Policies\OrderViewPolicy;
useWebFiori\Framework\Access;
class Privileges {
publicstaticfunctioninitialize() {
// RBAC
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel', 'orders.manage']);
// ABAC
Access::registerPolicy(newOrderViewPolicy());
Access::registerPolicy(newOrderCancelPolicy());
}
}

A middleware that loads the user into SecurityContext:

<?phpnamespaceApp\Middleware;
useWebFiori\Framework\Access;
useWebFiori\Framework\Middleware\AbstractMiddleware;
useWebFiori\Http\SecurityContext;
class SecurityContextLoader extends AbstractMiddleware {
publicfunctionbefore(Request$request, Response$response) {
$userId = SessionsManager::get('user-id');
if ($userId === null) {
SecurityContext::clear();
return;
}
$user = $this->loadUser($userId);
if ($user !== null && $user->isActive()) {
SecurityContext::setCurrentUser($user);
Access::assignRoleToUser($user->getId(), $user->role);
}
}
}

A service using both annotations and Access::can():

#[RestController('orders', 'Order API')]
#[RequiresAuth]
class OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
#[DeleteMapping]
#[PreAuthorize("hasAuthority('orders.cancel')")]
publicfunctioncancelOrder(?int$id = null): array {
$order = $this->repo->findById($id);
$user = SecurityContext::getCurrentUser();
// ABAC: policy checks ownership + statusif (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('Cannot cancel this order.');
}
$order->status = 'cancelled';
$this->repo->save($order);
return [$order];
}
}

There aren't any published security advisories

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Security: WebFiori/docs

Security

security.md

Security & Authorization

WebFiori provides a layered security system combining authentication state management, role-based access control (RBAC), attribute-based access control (ABAC), and declarative annotations for endpoint protection.

Components Overview

ComponentPackageRole
SecurityContextwebfiori/httpHolds current authenticated user for the request
SecurityPrincipalwebfiori/httpInterface for user objects
#[RequiresAuth]webfiori/httpAnnotation: endpoint requires authentication
#[PreAuthorize]webfiori/httpAnnotation: expression-based access control
Accesswebfiori/frameworkRBAC role/permission definitions
AccessManagerwebfiori/frameworkRBAC + ABAC policy evaluation
AuthorizeMiddlewarewebfiori/frameworkMiddleware for permission checks

SecurityPrincipal

Implement this interface on your user class:

<?phpnamespaceApp\Domain;
useWebFiori\Http\SecurityPrincipal;
class User implements SecurityPrincipal {
publicfunction__construct(
publicint$id,
publicstring$name,
publicstring$role
) {
}
publicfunctiongetAuthorities(): array {
returnmatch ($this->role) {
'admin' => ['users.manage', 'orders.manage', 'orders.view'],
'customer' => ['orders.create', 'orders.view'],
default => []
};
}
publicfunctiongetId(): int|string {
return$this->id;
}
publicfunctiongetName(): string {
return$this->name;
}
publicfunctiongetRoles(): array {
return [$this->role];
}
publicfunctionisActive(): bool {
returntrue;
}
}

SecurityContext

Set the current user during request processing (typically in middleware):

useWebFiori\Http\SecurityContext;
// Set authenticated user
SecurityContext::setCurrentUser($user);
// Check authentication
SecurityContext::isAuthenticated(); // true if user is set and active// Get current user$user = SecurityContext::getCurrentUser();
// Check roles and authorities
SecurityContext::hasRole('admin');
SecurityContext::hasAuthority('orders.manage');
// Clear (e.g., on logout)
SecurityContext::clear();

Declarative Annotations

#[RequiresAuth]

Requires the user to be authenticated. Can be placed on a class (all methods) or individual methods:

useWebFiori\Http\Annotations\RequiresAuth;
useWebFiori\Http\Annotations\RestController;
#[RestController('orders', 'Order API')]
#[RequiresAuth] // All methods require authenticationclass OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
// ...
}

#[PreAuthorize]

Evaluates a security expression before the method executes:

useWebFiori\Http\Annotations\PreAuthorize;
// Single role check
#[PreAuthorize("hasRole('admin')")]
publicfunctiondeleteUser(): array { ... }
// Single authority check
#[PreAuthorize("hasAuthority('orders.manage')")]
publicfunctionshipOrder(): array { ... }
// Multiple roles (any)
#[PreAuthorize("hasAnyRole('admin', 'moderator')")]
publicfunctionbanUser(): array { ... }
// Combined with AND
#[PreAuthorize("isAuthenticated() && hasAuthority('reports.view')")]
publicfunctiongetReport(): array { ... }
// Combined with OR
#[PreAuthorize("hasRole('admin') || hasAuthority('orders.manage')")]
publicfunctioncancelOrder(): array { ... }

Supported expressions:

ExpressionMeaning
hasRole('ROLE')User has the specified role
hasAnyRole('R1', 'R2')User has any of the listed roles
hasAuthority('PERM')User has the specified authority/permission
hasAnyAuthority('P1', 'P2')User has any of the listed authorities
isAuthenticated()User is authenticated and active
permitAll()Always allows access

Combine with && (AND) and || (OR).

#[AllowAnonymous]

Skips all authentication checks for a method:

#[AllowAnonymous]
publicfunctiongetPublicData(): array { ... }

RBAC with Access

Define roles and their permissions during initialization:

useWebFiori\Framework\Access;
// Define roles with permissions
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('staff', ['orders.view', 'orders.update', 'orders.ship']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel',
'orders.update', 'orders.ship', 'orders.manage']);
// Assign role to user (for storage-backed scenarios)
Access::assignRoleToUser($userId, 'customer');

Permission and group IDs can contain letters (A-Z, a-z), digits (0-9), underscores (_), dots (.), and dashes (-). Dots and dashes are useful as namespace separators (e.g., orders.create, billing-read).

Role Inheritance

Roles can inherit permissions from a parent role:

Access::role('manager', ['reports.view'])->inherits('staff');
// manager now has: reports.view + all staff permissions

Checking Permissions

// Pass user object — reads roles from getRoles() if no internal mapping exists
Access::can($user, 'orders.cancel');
// Pass user ID — uses roles from assignRoleToUser() or storage
Access::can(42, 'orders.cancel');

Storage Backends

By default, roles are stored in memory. For persistence across requests, use a storage backend:

BackendClassUse Case
In-memoryInMemoryAccessStorageTesting, stateless APIs
File-basedFileAccessStorageSimple deployments
DatabaseDatabaseAccessStorageProduction with DB
useWebFiori\Framework\AccessManager;
useWebFiori\Framework\Storage\DatabaseAccessStorage;
$manager = newAccessManager(newDatabaseAccessStorage($connectionName));
$manager->loadFromStorage(); // load roles/permissions from DB

To persist changes:

$manager->saveToStorage();

ABAC with Policies

Policies add resource-level rules on top of RBAC. A policy is evaluated only after the RBAC check passes.

Creating a Policy

Create policy classes under App/Policies/:

<?phpnamespaceApp\Policies;
useApp\Domain\Order;
class OrderCancelPolicy {
publicfunctiongetPermission(): string {
return'orders.cancel';
}
publicfunctionevaluate($user, ?object$resource = null): bool {
if ($resource === null || !$resourceinstanceof Order) {
returnfalse;
}
// Only pending orders can be cancelledif ($resource->status !== 'pending') {
returnfalse;
}
// Admin can cancel any pending orderif (in_array('admin', $user->getRoles())) {
returntrue;
}
// Customers can only cancel their own ordersreturn$user->getId() === $resource->userId;
}
}

Registering Policies

useApp\Policies\OrderCancelPolicy;
useWebFiori\Framework\Access;
Access::registerPolicy(newOrderCancelPolicy());

Using Policies

Pass the resource as the third argument to can():

$order = $orderRepo->findById($id);
if (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('You cannot cancel this order.');
}

The evaluation flow:

  1. RBAC check: Does the user's role have the orders.cancel permission? If no → denied.
  2. Policy check: Does OrderCancelPolicy::evaluate($user, $order) return true? If no → denied.
  3. Both pass → allowed.

Putting It Together

A typical setup in App/Ini/Privileges.php:

<?phpnamespaceApp\Ini;
useApp\Policies\OrderCancelPolicy;
useApp\Policies\OrderViewPolicy;
useWebFiori\Framework\Access;
class Privileges {
publicstaticfunctioninitialize() {
// RBAC
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel', 'orders.manage']);
// ABAC
Access::registerPolicy(newOrderViewPolicy());
Access::registerPolicy(newOrderCancelPolicy());
}
}

A middleware that loads the user into SecurityContext:

<?phpnamespaceApp\Middleware;
useWebFiori\Framework\Access;
useWebFiori\Framework\Middleware\AbstractMiddleware;
useWebFiori\Http\SecurityContext;
class SecurityContextLoader extends AbstractMiddleware {
publicfunctionbefore(Request$request, Response$response) {
$userId = SessionsManager::get('user-id');
if ($userId === null) {
SecurityContext::clear();
return;
}
$user = $this->loadUser($userId);
if ($user !== null && $user->isActive()) {
SecurityContext::setCurrentUser($user);
Access::assignRoleToUser($user->getId(), $user->role);
}
}
}

A service using both annotations and Access::can():

#[RestController('orders', 'Order API')]
#[RequiresAuth]
class OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
#[DeleteMapping]
#[PreAuthorize("hasAuthority('orders.cancel')")]
publicfunctioncancelOrder(?int$id = null): array {
$order = $this->repo->findById($id);
$user = SecurityContext::getCurrentUser();
// ABAC: policy checks ownership + statusif (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('Cannot cancel this order.');
}
$order->status = 'cancelled';
$this->repo->save($order);
return [$order];
}
}

There aren't any published security advisories

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Security: WebFiori/docs

Security

security.md

Security & Authorization

WebFiori provides a layered security system combining authentication state management, role-based access control (RBAC), attribute-based access control (ABAC), and declarative annotations for endpoint protection.

Components Overview

ComponentPackageRole
SecurityContextwebfiori/httpHolds current authenticated user for the request
SecurityPrincipalwebfiori/httpInterface for user objects
#[RequiresAuth]webfiori/httpAnnotation: endpoint requires authentication
#[PreAuthorize]webfiori/httpAnnotation: expression-based access control
Accesswebfiori/frameworkRBAC role/permission definitions
AccessManagerwebfiori/frameworkRBAC + ABAC policy evaluation
AuthorizeMiddlewarewebfiori/frameworkMiddleware for permission checks

SecurityPrincipal

Implement this interface on your user class:

<?phpnamespaceApp\Domain;
useWebFiori\Http\SecurityPrincipal;
class User implements SecurityPrincipal {
publicfunction__construct(
publicint$id,
publicstring$name,
publicstring$role
) {
}
publicfunctiongetAuthorities(): array {
returnmatch ($this->role) {
'admin' => ['users.manage', 'orders.manage', 'orders.view'],
'customer' => ['orders.create', 'orders.view'],
default => []
};
}
publicfunctiongetId(): int|string {
return$this->id;
}
publicfunctiongetName(): string {
return$this->name;
}
publicfunctiongetRoles(): array {
return [$this->role];
}
publicfunctionisActive(): bool {
returntrue;
}
}

SecurityContext

Set the current user during request processing (typically in middleware):

useWebFiori\Http\SecurityContext;
// Set authenticated user
SecurityContext::setCurrentUser($user);
// Check authentication
SecurityContext::isAuthenticated(); // true if user is set and active// Get current user$user = SecurityContext::getCurrentUser();
// Check roles and authorities
SecurityContext::hasRole('admin');
SecurityContext::hasAuthority('orders.manage');
// Clear (e.g., on logout)
SecurityContext::clear();

Declarative Annotations

#[RequiresAuth]

Requires the user to be authenticated. Can be placed on a class (all methods) or individual methods:

useWebFiori\Http\Annotations\RequiresAuth;
useWebFiori\Http\Annotations\RestController;
#[RestController('orders', 'Order API')]
#[RequiresAuth] // All methods require authenticationclass OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
// ...
}

#[PreAuthorize]

Evaluates a security expression before the method executes:

useWebFiori\Http\Annotations\PreAuthorize;
// Single role check
#[PreAuthorize("hasRole('admin')")]
publicfunctiondeleteUser(): array { ... }
// Single authority check
#[PreAuthorize("hasAuthority('orders.manage')")]
publicfunctionshipOrder(): array { ... }
// Multiple roles (any)
#[PreAuthorize("hasAnyRole('admin', 'moderator')")]
publicfunctionbanUser(): array { ... }
// Combined with AND
#[PreAuthorize("isAuthenticated() && hasAuthority('reports.view')")]
publicfunctiongetReport(): array { ... }
// Combined with OR
#[PreAuthorize("hasRole('admin') || hasAuthority('orders.manage')")]
publicfunctioncancelOrder(): array { ... }

Supported expressions:

ExpressionMeaning
hasRole('ROLE')User has the specified role
hasAnyRole('R1', 'R2')User has any of the listed roles
hasAuthority('PERM')User has the specified authority/permission
hasAnyAuthority('P1', 'P2')User has any of the listed authorities
isAuthenticated()User is authenticated and active
permitAll()Always allows access

Combine with && (AND) and || (OR).

#[AllowAnonymous]

Skips all authentication checks for a method:

#[AllowAnonymous]
publicfunctiongetPublicData(): array { ... }

RBAC with Access

Define roles and their permissions during initialization:

useWebFiori\Framework\Access;
// Define roles with permissions
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('staff', ['orders.view', 'orders.update', 'orders.ship']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel',
'orders.update', 'orders.ship', 'orders.manage']);
// Assign role to user (for storage-backed scenarios)
Access::assignRoleToUser($userId, 'customer');

Permission and group IDs can contain letters (A-Z, a-z), digits (0-9), underscores (_), dots (.), and dashes (-). Dots and dashes are useful as namespace separators (e.g., orders.create, billing-read).

Role Inheritance

Roles can inherit permissions from a parent role:

Access::role('manager', ['reports.view'])->inherits('staff');
// manager now has: reports.view + all staff permissions

Checking Permissions

// Pass user object — reads roles from getRoles() if no internal mapping exists
Access::can($user, 'orders.cancel');
// Pass user ID — uses roles from assignRoleToUser() or storage
Access::can(42, 'orders.cancel');

Storage Backends

By default, roles are stored in memory. For persistence across requests, use a storage backend:

BackendClassUse Case
In-memoryInMemoryAccessStorageTesting, stateless APIs
File-basedFileAccessStorageSimple deployments
DatabaseDatabaseAccessStorageProduction with DB
useWebFiori\Framework\AccessManager;
useWebFiori\Framework\Storage\DatabaseAccessStorage;
$manager = newAccessManager(newDatabaseAccessStorage($connectionName));
$manager->loadFromStorage(); // load roles/permissions from DB

To persist changes:

$manager->saveToStorage();

ABAC with Policies

Policies add resource-level rules on top of RBAC. A policy is evaluated only after the RBAC check passes.

Creating a Policy

Create policy classes under App/Policies/:

<?phpnamespaceApp\Policies;
useApp\Domain\Order;
class OrderCancelPolicy {
publicfunctiongetPermission(): string {
return'orders.cancel';
}
publicfunctionevaluate($user, ?object$resource = null): bool {
if ($resource === null || !$resourceinstanceof Order) {
returnfalse;
}
// Only pending orders can be cancelledif ($resource->status !== 'pending') {
returnfalse;
}
// Admin can cancel any pending orderif (in_array('admin', $user->getRoles())) {
returntrue;
}
// Customers can only cancel their own ordersreturn$user->getId() === $resource->userId;
}
}

Registering Policies

useApp\Policies\OrderCancelPolicy;
useWebFiori\Framework\Access;
Access::registerPolicy(newOrderCancelPolicy());

Using Policies

Pass the resource as the third argument to can():

$order = $orderRepo->findById($id);
if (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('You cannot cancel this order.');
}

The evaluation flow:

  1. RBAC check: Does the user's role have the orders.cancel permission? If no → denied.
  2. Policy check: Does OrderCancelPolicy::evaluate($user, $order) return true? If no → denied.
  3. Both pass → allowed.

Putting It Together

A typical setup in App/Ini/Privileges.php:

<?phpnamespaceApp\Ini;
useApp\Policies\OrderCancelPolicy;
useApp\Policies\OrderViewPolicy;
useWebFiori\Framework\Access;
class Privileges {
publicstaticfunctioninitialize() {
// RBAC
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel', 'orders.manage']);
// ABAC
Access::registerPolicy(newOrderViewPolicy());
Access::registerPolicy(newOrderCancelPolicy());
}
}

A middleware that loads the user into SecurityContext:

<?phpnamespaceApp\Middleware;
useWebFiori\Framework\Access;
useWebFiori\Framework\Middleware\AbstractMiddleware;
useWebFiori\Http\SecurityContext;
class SecurityContextLoader extends AbstractMiddleware {
publicfunctionbefore(Request$request, Response$response) {
$userId = SessionsManager::get('user-id');
if ($userId === null) {
SecurityContext::clear();
return;
}
$user = $this->loadUser($userId);
if ($user !== null && $user->isActive()) {
SecurityContext::setCurrentUser($user);
Access::assignRoleToUser($user->getId(), $user->role);
}
}
}

A service using both annotations and Access::can():

#[RestController('orders', 'Order API')]
#[RequiresAuth]
class OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
#[DeleteMapping]
#[PreAuthorize("hasAuthority('orders.cancel')")]
publicfunctioncancelOrder(?int$id = null): array {
$order = $this->repo->findById($id);
$user = SecurityContext::getCurrentUser();
// ABAC: policy checks ownership + statusif (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('Cannot cancel this order.');
}
$order->status = 'cancelled';
$this->repo->save($order);
return [$order];
}
}

There aren't any published security advisories

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Security: WebFiori/docs

Security

security.md

Security & Authorization

WebFiori provides a layered security system combining authentication state management, role-based access control (RBAC), attribute-based access control (ABAC), and declarative annotations for endpoint protection.

Components Overview

ComponentPackageRole
SecurityContextwebfiori/httpHolds current authenticated user for the request
SecurityPrincipalwebfiori/httpInterface for user objects
#[RequiresAuth]webfiori/httpAnnotation: endpoint requires authentication
#[PreAuthorize]webfiori/httpAnnotation: expression-based access control
Accesswebfiori/frameworkRBAC role/permission definitions
AccessManagerwebfiori/frameworkRBAC + ABAC policy evaluation
AuthorizeMiddlewarewebfiori/frameworkMiddleware for permission checks

SecurityPrincipal

Implement this interface on your user class:

<?phpnamespaceApp\Domain;
useWebFiori\Http\SecurityPrincipal;
class User implements SecurityPrincipal {
publicfunction__construct(
publicint$id,
publicstring$name,
publicstring$role
) {
}
publicfunctiongetAuthorities(): array {
returnmatch ($this->role) {
'admin' => ['users.manage', 'orders.manage', 'orders.view'],
'customer' => ['orders.create', 'orders.view'],
default => []
};
}
publicfunctiongetId(): int|string {
return$this->id;
}
publicfunctiongetName(): string {
return$this->name;
}
publicfunctiongetRoles(): array {
return [$this->role];
}
publicfunctionisActive(): bool {
returntrue;
}
}

SecurityContext

Set the current user during request processing (typically in middleware):

useWebFiori\Http\SecurityContext;
// Set authenticated user
SecurityContext::setCurrentUser($user);
// Check authentication
SecurityContext::isAuthenticated(); // true if user is set and active// Get current user$user = SecurityContext::getCurrentUser();
// Check roles and authorities
SecurityContext::hasRole('admin');
SecurityContext::hasAuthority('orders.manage');
// Clear (e.g., on logout)
SecurityContext::clear();

Declarative Annotations

#[RequiresAuth]

Requires the user to be authenticated. Can be placed on a class (all methods) or individual methods:

useWebFiori\Http\Annotations\RequiresAuth;
useWebFiori\Http\Annotations\RestController;
#[RestController('orders', 'Order API')]
#[RequiresAuth] // All methods require authenticationclass OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
// ...
}

#[PreAuthorize]

Evaluates a security expression before the method executes:

useWebFiori\Http\Annotations\PreAuthorize;
// Single role check
#[PreAuthorize("hasRole('admin')")]
publicfunctiondeleteUser(): array { ... }
// Single authority check
#[PreAuthorize("hasAuthority('orders.manage')")]
publicfunctionshipOrder(): array { ... }
// Multiple roles (any)
#[PreAuthorize("hasAnyRole('admin', 'moderator')")]
publicfunctionbanUser(): array { ... }
// Combined with AND
#[PreAuthorize("isAuthenticated() && hasAuthority('reports.view')")]
publicfunctiongetReport(): array { ... }
// Combined with OR
#[PreAuthorize("hasRole('admin') || hasAuthority('orders.manage')")]
publicfunctioncancelOrder(): array { ... }

Supported expressions:

ExpressionMeaning
hasRole('ROLE')User has the specified role
hasAnyRole('R1', 'R2')User has any of the listed roles
hasAuthority('PERM')User has the specified authority/permission
hasAnyAuthority('P1', 'P2')User has any of the listed authorities
isAuthenticated()User is authenticated and active
permitAll()Always allows access

Combine with && (AND) and || (OR).

#[AllowAnonymous]

Skips all authentication checks for a method:

#[AllowAnonymous]
publicfunctiongetPublicData(): array { ... }

RBAC with Access

Define roles and their permissions during initialization:

useWebFiori\Framework\Access;
// Define roles with permissions
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('staff', ['orders.view', 'orders.update', 'orders.ship']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel',
'orders.update', 'orders.ship', 'orders.manage']);
// Assign role to user (for storage-backed scenarios)
Access::assignRoleToUser($userId, 'customer');

Permission and group IDs can contain letters (A-Z, a-z), digits (0-9), underscores (_), dots (.), and dashes (-). Dots and dashes are useful as namespace separators (e.g., orders.create, billing-read).

Role Inheritance

Roles can inherit permissions from a parent role:

Access::role('manager', ['reports.view'])->inherits('staff');
// manager now has: reports.view + all staff permissions

Checking Permissions

// Pass user object — reads roles from getRoles() if no internal mapping exists
Access::can($user, 'orders.cancel');
// Pass user ID — uses roles from assignRoleToUser() or storage
Access::can(42, 'orders.cancel');

Storage Backends

By default, roles are stored in memory. For persistence across requests, use a storage backend:

BackendClassUse Case
In-memoryInMemoryAccessStorageTesting, stateless APIs
File-basedFileAccessStorageSimple deployments
DatabaseDatabaseAccessStorageProduction with DB
useWebFiori\Framework\AccessManager;
useWebFiori\Framework\Storage\DatabaseAccessStorage;
$manager = newAccessManager(newDatabaseAccessStorage($connectionName));
$manager->loadFromStorage(); // load roles/permissions from DB

To persist changes:

$manager->saveToStorage();

ABAC with Policies

Policies add resource-level rules on top of RBAC. A policy is evaluated only after the RBAC check passes.

Creating a Policy

Create policy classes under App/Policies/:

<?phpnamespaceApp\Policies;
useApp\Domain\Order;
class OrderCancelPolicy {
publicfunctiongetPermission(): string {
return'orders.cancel';
}
publicfunctionevaluate($user, ?object$resource = null): bool {
if ($resource === null || !$resourceinstanceof Order) {
returnfalse;
}
// Only pending orders can be cancelledif ($resource->status !== 'pending') {
returnfalse;
}
// Admin can cancel any pending orderif (in_array('admin', $user->getRoles())) {
returntrue;
}
// Customers can only cancel their own ordersreturn$user->getId() === $resource->userId;
}
}

Registering Policies

useApp\Policies\OrderCancelPolicy;
useWebFiori\Framework\Access;
Access::registerPolicy(newOrderCancelPolicy());

Using Policies

Pass the resource as the third argument to can():

$order = $orderRepo->findById($id);
if (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('You cannot cancel this order.');
}

The evaluation flow:

  1. RBAC check: Does the user's role have the orders.cancel permission? If no → denied.
  2. Policy check: Does OrderCancelPolicy::evaluate($user, $order) return true? If no → denied.
  3. Both pass → allowed.

Putting It Together

A typical setup in App/Ini/Privileges.php:

<?phpnamespaceApp\Ini;
useApp\Policies\OrderCancelPolicy;
useApp\Policies\OrderViewPolicy;
useWebFiori\Framework\Access;
class Privileges {
publicstaticfunctioninitialize() {
// RBAC
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel', 'orders.manage']);
// ABAC
Access::registerPolicy(newOrderViewPolicy());
Access::registerPolicy(newOrderCancelPolicy());
}
}

A middleware that loads the user into SecurityContext:

<?phpnamespaceApp\Middleware;
useWebFiori\Framework\Access;
useWebFiori\Framework\Middleware\AbstractMiddleware;
useWebFiori\Http\SecurityContext;
class SecurityContextLoader extends AbstractMiddleware {
publicfunctionbefore(Request$request, Response$response) {
$userId = SessionsManager::get('user-id');
if ($userId === null) {
SecurityContext::clear();
return;
}
$user = $this->loadUser($userId);
if ($user !== null && $user->isActive()) {
SecurityContext::setCurrentUser($user);
Access::assignRoleToUser($user->getId(), $user->role);
}
}
}

A service using both annotations and Access::can():

#[RestController('orders', 'Order API')]
#[RequiresAuth]
class OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
#[DeleteMapping]
#[PreAuthorize("hasAuthority('orders.cancel')")]
publicfunctioncancelOrder(?int$id = null): array {
$order = $this->repo->findById($id);
$user = SecurityContext::getCurrentUser();
// ABAC: policy checks ownership + statusif (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('Cannot cancel this order.');
}
$order->status = 'cancelled';
$this->repo->save($order);
return [$order];
}
}

There aren't any published security advisories

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Security: WebFiori/docs

Security

security.md

Security & Authorization

WebFiori provides a layered security system combining authentication state management, role-based access control (RBAC), attribute-based access control (ABAC), and declarative annotations for endpoint protection.

Components Overview

ComponentPackageRole
SecurityContextwebfiori/httpHolds current authenticated user for the request
SecurityPrincipalwebfiori/httpInterface for user objects
#[RequiresAuth]webfiori/httpAnnotation: endpoint requires authentication
#[PreAuthorize]webfiori/httpAnnotation: expression-based access control
Accesswebfiori/frameworkRBAC role/permission definitions
AccessManagerwebfiori/frameworkRBAC + ABAC policy evaluation
AuthorizeMiddlewarewebfiori/frameworkMiddleware for permission checks

SecurityPrincipal

Implement this interface on your user class:

<?phpnamespaceApp\Domain;
useWebFiori\Http\SecurityPrincipal;
class User implements SecurityPrincipal {
publicfunction__construct(
publicint$id,
publicstring$name,
publicstring$role
) {
}
publicfunctiongetAuthorities(): array {
returnmatch ($this->role) {
'admin' => ['users.manage', 'orders.manage', 'orders.view'],
'customer' => ['orders.create', 'orders.view'],
default => []
};
}
publicfunctiongetId(): int|string {
return$this->id;
}
publicfunctiongetName(): string {
return$this->name;
}
publicfunctiongetRoles(): array {
return [$this->role];
}
publicfunctionisActive(): bool {
returntrue;
}
}

SecurityContext

Set the current user during request processing (typically in middleware):

useWebFiori\Http\SecurityContext;
// Set authenticated user
SecurityContext::setCurrentUser($user);
// Check authentication
SecurityContext::isAuthenticated(); // true if user is set and active// Get current user$user = SecurityContext::getCurrentUser();
// Check roles and authorities
SecurityContext::hasRole('admin');
SecurityContext::hasAuthority('orders.manage');
// Clear (e.g., on logout)
SecurityContext::clear();

Declarative Annotations

#[RequiresAuth]

Requires the user to be authenticated. Can be placed on a class (all methods) or individual methods:

useWebFiori\Http\Annotations\RequiresAuth;
useWebFiori\Http\Annotations\RestController;
#[RestController('orders', 'Order API')]
#[RequiresAuth] // All methods require authenticationclass OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
// ...
}

#[PreAuthorize]

Evaluates a security expression before the method executes:

useWebFiori\Http\Annotations\PreAuthorize;
// Single role check
#[PreAuthorize("hasRole('admin')")]
publicfunctiondeleteUser(): array { ... }
// Single authority check
#[PreAuthorize("hasAuthority('orders.manage')")]
publicfunctionshipOrder(): array { ... }
// Multiple roles (any)
#[PreAuthorize("hasAnyRole('admin', 'moderator')")]
publicfunctionbanUser(): array { ... }
// Combined with AND
#[PreAuthorize("isAuthenticated() && hasAuthority('reports.view')")]
publicfunctiongetReport(): array { ... }
// Combined with OR
#[PreAuthorize("hasRole('admin') || hasAuthority('orders.manage')")]
publicfunctioncancelOrder(): array { ... }

Supported expressions:

ExpressionMeaning
hasRole('ROLE')User has the specified role
hasAnyRole('R1', 'R2')User has any of the listed roles
hasAuthority('PERM')User has the specified authority/permission
hasAnyAuthority('P1', 'P2')User has any of the listed authorities
isAuthenticated()User is authenticated and active
permitAll()Always allows access

Combine with && (AND) and || (OR).

#[AllowAnonymous]

Skips all authentication checks for a method:

#[AllowAnonymous]
publicfunctiongetPublicData(): array { ... }

RBAC with Access

Define roles and their permissions during initialization:

useWebFiori\Framework\Access;
// Define roles with permissions
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('staff', ['orders.view', 'orders.update', 'orders.ship']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel',
'orders.update', 'orders.ship', 'orders.manage']);
// Assign role to user (for storage-backed scenarios)
Access::assignRoleToUser($userId, 'customer');

Permission and group IDs can contain letters (A-Z, a-z), digits (0-9), underscores (_), dots (.), and dashes (-). Dots and dashes are useful as namespace separators (e.g., orders.create, billing-read).

Role Inheritance

Roles can inherit permissions from a parent role:

Access::role('manager', ['reports.view'])->inherits('staff');
// manager now has: reports.view + all staff permissions

Checking Permissions

// Pass user object — reads roles from getRoles() if no internal mapping exists
Access::can($user, 'orders.cancel');
// Pass user ID — uses roles from assignRoleToUser() or storage
Access::can(42, 'orders.cancel');

Storage Backends

By default, roles are stored in memory. For persistence across requests, use a storage backend:

BackendClassUse Case
In-memoryInMemoryAccessStorageTesting, stateless APIs
File-basedFileAccessStorageSimple deployments
DatabaseDatabaseAccessStorageProduction with DB
useWebFiori\Framework\AccessManager;
useWebFiori\Framework\Storage\DatabaseAccessStorage;
$manager = newAccessManager(newDatabaseAccessStorage($connectionName));
$manager->loadFromStorage(); // load roles/permissions from DB

To persist changes:

$manager->saveToStorage();

ABAC with Policies

Policies add resource-level rules on top of RBAC. A policy is evaluated only after the RBAC check passes.

Creating a Policy

Create policy classes under App/Policies/:

<?phpnamespaceApp\Policies;
useApp\Domain\Order;
class OrderCancelPolicy {
publicfunctiongetPermission(): string {
return'orders.cancel';
}
publicfunctionevaluate($user, ?object$resource = null): bool {
if ($resource === null || !$resourceinstanceof Order) {
returnfalse;
}
// Only pending orders can be cancelledif ($resource->status !== 'pending') {
returnfalse;
}
// Admin can cancel any pending orderif (in_array('admin', $user->getRoles())) {
returntrue;
}
// Customers can only cancel their own ordersreturn$user->getId() === $resource->userId;
}
}

Registering Policies

useApp\Policies\OrderCancelPolicy;
useWebFiori\Framework\Access;
Access::registerPolicy(newOrderCancelPolicy());

Using Policies

Pass the resource as the third argument to can():

$order = $orderRepo->findById($id);
if (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('You cannot cancel this order.');
}

The evaluation flow:

  1. RBAC check: Does the user's role have the orders.cancel permission? If no → denied.
  2. Policy check: Does OrderCancelPolicy::evaluate($user, $order) return true? If no → denied.
  3. Both pass → allowed.

Putting It Together

A typical setup in App/Ini/Privileges.php:

<?phpnamespaceApp\Ini;
useApp\Policies\OrderCancelPolicy;
useApp\Policies\OrderViewPolicy;
useWebFiori\Framework\Access;
class Privileges {
publicstaticfunctioninitialize() {
// RBAC
Access::role('customer', ['orders.create', 'orders.view', 'orders.cancel']);
Access::role('admin', ['orders.create', 'orders.view', 'orders.cancel', 'orders.manage']);
// ABAC
Access::registerPolicy(newOrderViewPolicy());
Access::registerPolicy(newOrderCancelPolicy());
}
}

A middleware that loads the user into SecurityContext:

<?phpnamespaceApp\Middleware;
useWebFiori\Framework\Access;
useWebFiori\Framework\Middleware\AbstractMiddleware;
useWebFiori\Http\SecurityContext;
class SecurityContextLoader extends AbstractMiddleware {
publicfunctionbefore(Request$request, Response$response) {
$userId = SessionsManager::get('user-id');
if ($userId === null) {
SecurityContext::clear();
return;
}
$user = $this->loadUser($userId);
if ($user !== null && $user->isActive()) {
SecurityContext::setCurrentUser($user);
Access::assignRoleToUser($user->getId(), $user->role);
}
}
}

A service using both annotations and Access::can():

#[RestController('orders', 'Order API')]
#[RequiresAuth]
class OrderService extends WebService {
publicfunctionisAuthorized(): bool {
return SecurityContext::isAuthenticated();
}
#[DeleteMapping]
#[PreAuthorize("hasAuthority('orders.cancel')")]
publicfunctioncancelOrder(?int$id = null): array {
$order = $this->repo->findById($id);
$user = SecurityContext::getCurrentUser();
// ABAC: policy checks ownership + statusif (!Access::can($user, 'orders.cancel', $order)) {
thrownewForbiddenException('Cannot cancel this order.');
}
$order->status = 'cancelled';
$this->repo->save($order);
return [$order];
}
}

There aren't any published security advisories