Files
api/services/nginx/app/routes/moduleVirkDataRoute.php
T
OpenClaw 51a87655d6 feat(auth): add scope-based access control to all existing routes (TRU-149)
Adds a scope-based access control layer to all 81 existing API routes.
Sits alongside existing session-cookie auth (does not replace it).

What this PR does:
- Audits every existing route and documents required scope per route
  (see documentation/auth/route-scope-audit.md)
- Adds classes/auth/scope.php with 10 scope constants and role→scope defaults
- Adds classes/auth/scope_middleware.php with requireScope/requireAnyScope/requireRole
- Applies require*() calls to all 81 existing routes
- Adds ScopeMiddlewareTest (unit, 178 lines) and RouteScopeTest (integration, 212 lines)

Coexistence note:
This branch's classes/auth/scope.php is a stub that will be replaced
by classes/auth/scope_registry.php (from TRU-145 / PR #396) when that
PR merges first. The two have compatible APIs.

Refs: TRU-149
2026-08-17 11:43:13 +00:00

64 lines
2.2 KiB
PHP

<?php
namespace routes;
use classes\authentication;
use classes\fxratesapi;
use classes\response;
use classes\router;
use classes\virkdata;
use objects\currency_conversion_rates_o;
use objects\logs_o;
use traits\route_t;
use app\auth\Scope;
use app\auth\ScopeMiddleware;
class moduleVirkDataRoute
{
use route_t;
public function run(): void
{
global /** @var response $response */
/** @var router $router */
$router, $response;
/** Modules > VirkData > search > GET */
$this->get('/modules/virkdata/search', function () {
ScopeMiddleware::requireScope(Scope::CUSTOMER_READ, '/modules/virkdata/search');
global $response;
$this->requirePermission('modules_virkdata_search');
$user = (new authentication())->get_user();
if ($user) {
self::requireParameters(['search']);
self::requireType('search', self::type_string());
self::requireMinLength('search', 3);
self::requireMaxLength('search', 100);
(new logs_o())->add('modules_virkdata', 'global', 1, $user->id, 'MODULES_VIRKDATA', 'User accessed searched for a company');
$result = (new virkdata())->getCompanyInformation(
self::getParameter('search'),
'',
[]
);
// Check if the result is an error
if (isset($result->message)) {
(new logs_o())->add('modules_virkdata', 'global', 1, $user->id, 'MODULES_VIRKDATA', 'User accessed the conversion rate and got an error');
$response->error($result->message, 400);
}
$res = $result->asArray();
// Response
$response->success($res);
} else {
(new logs_o())->add('modules_virkdata', 'global', 1, 0, 'MODULES_VIRKDATA', 'User accessed the conversion rate without being logged in');
$response->error('Invalid session', 400);
}
},
[
'modules_virkdata_rate' => 'Update conversion rates using the VIRKDATA',
]
);
}
}