refactor(actions): centralize POST/CSRF guard flow
This commit is contained in:
@@ -4,6 +4,9 @@ use MintyPHP\Http\Input\FormErrors;
|
||||
use MintyPHP\Http\Input\RequestInput;
|
||||
use MintyPHP\Http\Input\RequestInputFactory;
|
||||
use MintyPHP\Http\Request;
|
||||
use MintyPHP\Router;
|
||||
use MintyPHP\Service\Access\AuthorizationDecision;
|
||||
use MintyPHP\Session;
|
||||
use MintyPHP\Support\Flash;
|
||||
|
||||
function requestInput(): RequestInput
|
||||
@@ -38,6 +41,92 @@ function flashFormErrors(FormErrors $errors, ?string $scope = null, string $keyP
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforce POST request method for mutation actions.
|
||||
*
|
||||
* Browser requests are redirected to $redirect.
|
||||
* Optional JSON mode returns 405 with a JSON error payload.
|
||||
*/
|
||||
function actionRequirePost(
|
||||
string $redirect,
|
||||
bool $jsonAware = false,
|
||||
string $jsonError = 'method_not_allowed'
|
||||
): bool {
|
||||
if (requestInput()->isMethod('POST')) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($jsonAware && Request::wantsJson()) {
|
||||
header('Allow: POST');
|
||||
http_response_code(405);
|
||||
Router::json(['error' => trim($jsonError) !== '' ? trim($jsonError) : 'method_not_allowed']);
|
||||
return false;
|
||||
}
|
||||
|
||||
Router::redirect($redirect);
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enforce CSRF protection for POST actions.
|
||||
*
|
||||
* Returns false after responding/redirecting when token validation fails.
|
||||
*/
|
||||
function actionRequireCsrf(
|
||||
string $redirect,
|
||||
?string $flashScope = null,
|
||||
string $flashKeyPrefix = 'csrf_expired',
|
||||
bool $jsonAware = false,
|
||||
string $jsonError = 'csrf',
|
||||
bool $flashOnFailure = true
|
||||
): bool {
|
||||
if (Session::checkCsrfToken()) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($jsonAware && Request::wantsJson()) {
|
||||
http_response_code(400);
|
||||
Router::json(['error' => trim($jsonError) !== '' ? trim($jsonError) : 'csrf']);
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($flashOnFailure) {
|
||||
$errorBag = formErrors();
|
||||
$errorBag->addGlobal(t('Form expired, please try again'));
|
||||
flashFormErrors($errorBag, $flashScope ?? $redirect, $flashKeyPrefix);
|
||||
}
|
||||
|
||||
Router::redirect($redirect);
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle authorization decisions consistently for JSON and browser requests.
|
||||
*/
|
||||
function actionAllowOrDeny(
|
||||
AuthorizationDecision $decision,
|
||||
string $redirect = 'error/forbidden',
|
||||
bool $jsonAware = true
|
||||
): bool {
|
||||
if ($decision->isAllowed()) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if ($jsonAware && Request::wantsJson()) {
|
||||
http_response_code($decision->status());
|
||||
Router::json(['error' => $decision->error()]);
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($redirect === 'error/forbidden') {
|
||||
Router::redirect('error/forbidden?url=' . urlencode(Request::pathWithQuery()));
|
||||
return false;
|
||||
}
|
||||
|
||||
Router::redirect($redirect);
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Consume and remove flash messages matching any provided scope.
|
||||
*
|
||||
|
||||
@@ -18,8 +18,11 @@ if (!$decision->isAllowed()) {
|
||||
Guard::deny();
|
||||
}
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/settings');
|
||||
if (!actionRequirePost('admin/settings')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf('admin/settings', 'admin/settings', 'favicon_upload')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -3,7 +3,6 @@
|
||||
use MintyPHP\Http\SessionStoreInterface;
|
||||
use MintyPHP\Router;
|
||||
use MintyPHP\Service\Access\SettingsAuthorizationPolicy;
|
||||
use MintyPHP\Session;
|
||||
use MintyPHP\Support\Flash;
|
||||
use MintyPHP\Support\Guard;
|
||||
|
||||
@@ -19,16 +18,11 @@ if (!$decision->isAllowed()) {
|
||||
Guard::deny();
|
||||
}
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/settings');
|
||||
if (!actionRequirePost('admin/settings')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$errorBag = formErrors();
|
||||
if (!Session::checkCsrfToken()) {
|
||||
$errorBag->addGlobal(t('Form expired, please try again'));
|
||||
flashFormErrors($errorBag, 'admin/settings', 'settings_favicon_delete');
|
||||
Router::redirect('admin/settings');
|
||||
if (!actionRequireCsrf('admin/settings', 'admin/settings', 'settings_favicon_delete')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -18,8 +18,11 @@ if (!$decision->isAllowed()) {
|
||||
Guard::deny();
|
||||
}
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/settings');
|
||||
if (!actionRequirePost('admin/settings')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf('admin/settings', 'admin/settings', 'logo_upload')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -3,7 +3,6 @@
|
||||
use MintyPHP\Http\SessionStoreInterface;
|
||||
use MintyPHP\Router;
|
||||
use MintyPHP\Service\Access\SettingsAuthorizationPolicy;
|
||||
use MintyPHP\Session;
|
||||
use MintyPHP\Support\Flash;
|
||||
use MintyPHP\Support\Guard;
|
||||
|
||||
@@ -19,16 +18,11 @@ if (!$decision->isAllowed()) {
|
||||
Guard::deny();
|
||||
}
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/settings');
|
||||
if (!actionRequirePost('admin/settings')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$errorBag = formErrors();
|
||||
if (!Session::checkCsrfToken()) {
|
||||
$errorBag->addGlobal(t('Form expired, please try again'));
|
||||
flashFormErrors($errorBag, 'admin/settings', 'settings_logo_delete');
|
||||
Router::redirect('admin/settings');
|
||||
if (!actionRequireCsrf('admin/settings', 'admin/settings', 'settings_logo_delete')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -18,8 +18,12 @@ if (!$decision->isAllowed()) {
|
||||
Guard::deny();
|
||||
}
|
||||
|
||||
if (requestInput()->method() !== 'POST') {
|
||||
Router::redirect('admin/settings');
|
||||
if (!actionRequirePost('admin/settings')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf('admin/settings', 'admin/settings', 'user_lifecycle_run')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$errorBag = formErrors();
|
||||
|
||||
@@ -11,8 +11,11 @@ Guard::requireLogin();
|
||||
$authorizationService = app(\MintyPHP\Service\Access\AuthorizationService::class);
|
||||
$tenantAvatarService = app(\MintyPHP\Service\Tenant\TenantAvatarService::class);
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/tenants');
|
||||
if (!actionRequirePost('admin/tenants')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf('admin/tenants', 'admin/tenants', 'tenant_avatar')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -11,8 +11,11 @@ Guard::requireLogin();
|
||||
$authorizationService = app(\MintyPHP\Service\Access\AuthorizationService::class);
|
||||
$tenantAvatarService = app(\MintyPHP\Service\Tenant\TenantAvatarService::class);
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/tenants');
|
||||
if (!actionRequirePost('admin/tenants')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf('admin/tenants', 'admin/tenants', 'tenant_avatar_delete')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -11,8 +11,11 @@ Guard::requireLogin();
|
||||
$authorizationService = app(\MintyPHP\Service\Access\AuthorizationService::class);
|
||||
$tenantFaviconService = app(\MintyPHP\Service\Tenant\TenantFaviconService::class);
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/tenants');
|
||||
if (!actionRequirePost('admin/tenants')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf('admin/tenants', 'admin/tenants', 'tenant_favicon')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -11,8 +11,11 @@ Guard::requireLogin();
|
||||
$authorizationService = app(\MintyPHP\Service\Access\AuthorizationService::class);
|
||||
$tenantFaviconService = app(\MintyPHP\Service\Tenant\TenantFaviconService::class);
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/tenants');
|
||||
if (!actionRequirePost('admin/tenants')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf('admin/tenants', 'admin/tenants', 'tenant_favicon_delete')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -4,7 +4,6 @@ use MintyPHP\Http\Request;
|
||||
use MintyPHP\Http\SessionStoreInterface;
|
||||
use MintyPHP\Router;
|
||||
use MintyPHP\Service\Access\UserAuthorizationPolicy;
|
||||
use MintyPHP\Session;
|
||||
use MintyPHP\Support\Guard;
|
||||
|
||||
$session = app(SessionStoreInterface::class)->all();
|
||||
@@ -12,24 +11,20 @@ Guard::requireLogin();
|
||||
$authorizationService = app(\MintyPHP\Service\Access\AuthorizationService::class);
|
||||
$userAccountService = app(\MintyPHP\Service\User\UserAccountService::class);
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/users');
|
||||
if (!actionRequirePost('admin/users')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf(
|
||||
'admin/users',
|
||||
'admin/users',
|
||||
'user_activate',
|
||||
jsonAware: true
|
||||
)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$errorBag = formErrors();
|
||||
if (!Session::checkCsrfToken()) {
|
||||
if (Request::wantsJson()) {
|
||||
http_response_code(400);
|
||||
Router::json(['error' => 'csrf']);
|
||||
return;
|
||||
}
|
||||
$errorBag->addGlobal(t('Form expired, please try again'));
|
||||
flashFormErrors($errorBag, 'admin/users', 'user_activate');
|
||||
Router::redirect('admin/users');
|
||||
return;
|
||||
}
|
||||
|
||||
$uuid = trim((string) ($id ?? ''));
|
||||
$currentUserId = (int) ($session['user']['id'] ?? 0);
|
||||
$user = $uuid !== '' ? $userAccountService->findByUuid($uuid) : null;
|
||||
@@ -38,13 +33,7 @@ $decision = $authorizationService->authorize(UserAuthorizationPolicy::ABILITY_AD
|
||||
'actor_user_id' => $currentUserId,
|
||||
'target_user_id' => $userId,
|
||||
]);
|
||||
if (!$decision->isAllowed()) {
|
||||
if (Request::wantsJson()) {
|
||||
http_response_code($decision->status());
|
||||
Router::json(['error' => $decision->error()]);
|
||||
return;
|
||||
}
|
||||
Router::redirect('error/forbidden?url=' . urlencode(Request::pathWithQuery()));
|
||||
if (!actionAllowOrDeny($decision)) {
|
||||
return;
|
||||
}
|
||||
$result = $userAccountService->setActiveByUuid($uuid, true, $currentUserId);
|
||||
|
||||
@@ -12,8 +12,11 @@ $authorizationService = app(\MintyPHP\Service\Access\AuthorizationService::class
|
||||
$userAccountService = app(\MintyPHP\Service\User\UserAccountService::class);
|
||||
$userAvatarService = app(\MintyPHP\Service\User\UserAvatarService::class);
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin');
|
||||
if (!actionRequirePost('admin')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf('admin', 'admin', 'user_avatar_upload')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -12,8 +12,11 @@ $authorizationService = app(\MintyPHP\Service\Access\AuthorizationService::class
|
||||
$userAccountService = app(\MintyPHP\Service\User\UserAccountService::class);
|
||||
$userAvatarService = app(\MintyPHP\Service\User\UserAvatarService::class);
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin');
|
||||
if (!actionRequirePost('admin')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf('admin', 'admin', 'user_avatar_delete')) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
@@ -11,8 +11,16 @@ Guard::requireLogin();
|
||||
$authorizationService = app(\MintyPHP\Service\Access\AuthorizationService::class);
|
||||
$userAccountService = app(\MintyPHP\Service\User\UserAccountService::class);
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/users');
|
||||
if (!actionRequirePost('admin/users')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf(
|
||||
'admin/users',
|
||||
'admin/users',
|
||||
'user_deactivate',
|
||||
jsonAware: true
|
||||
)) {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -25,13 +33,7 @@ $decision = $authorizationService->authorize(UserAuthorizationPolicy::ABILITY_AD
|
||||
'actor_user_id' => $currentUserId,
|
||||
'target_user_id' => $userId,
|
||||
]);
|
||||
if (!$decision->isAllowed()) {
|
||||
if (Request::wantsJson()) {
|
||||
http_response_code($decision->status());
|
||||
Router::json(['error' => $decision->error()]);
|
||||
return;
|
||||
}
|
||||
Router::redirect('error/forbidden?url=' . urlencode(Request::pathWithQuery()));
|
||||
if (!actionAllowOrDeny($decision)) {
|
||||
return;
|
||||
}
|
||||
$result = $userAccountService->setActiveByUuid($uuid, false, $currentUserId);
|
||||
|
||||
@@ -12,8 +12,16 @@ Guard::requireLogin();
|
||||
$authorizationService = app(\MintyPHP\Service\Access\AuthorizationService::class);
|
||||
$userAccountService = app(\MintyPHP\Service\User\UserAccountService::class);
|
||||
|
||||
if ((requestInput()->method()) !== 'POST') {
|
||||
Router::redirect('admin/users');
|
||||
if (!actionRequirePost('admin/users')) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!actionRequireCsrf(
|
||||
'admin/users',
|
||||
'admin/users',
|
||||
'user_delete',
|
||||
jsonAware: true
|
||||
)) {
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -26,13 +34,7 @@ $decision = $authorizationService->authorize(UserAuthorizationPolicy::ABILITY_AD
|
||||
'actor_user_id' => $currentUserId,
|
||||
'target_user_id' => $userId,
|
||||
]);
|
||||
if (!$decision->isAllowed()) {
|
||||
if (Request::wantsJson()) {
|
||||
http_response_code($decision->status());
|
||||
Router::json(['error' => $decision->error()]);
|
||||
return;
|
||||
}
|
||||
Router::redirect('error/forbidden?url=' . urlencode(Request::pathWithQuery()));
|
||||
if (!actionAllowOrDeny($decision)) {
|
||||
return;
|
||||
}
|
||||
$result = $userAccountService->deleteByUuid($uuid, $currentUserId);
|
||||
|
||||
@@ -44,7 +44,7 @@ class PostEndpointCsrfContractTest extends TestCase
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!str_contains($content, 'checkCsrfToken')) {
|
||||
if (!str_contains($content, 'checkCsrfToken') && !str_contains($content, 'actionRequireCsrf(')) {
|
||||
$missing[] = $relativePath;
|
||||
}
|
||||
}
|
||||
@@ -72,6 +72,8 @@ class PostEndpointCsrfContractTest extends TestCase
|
||||
private function handlesPostData(string $content): bool
|
||||
{
|
||||
return str_contains($content, "isMethod('POST')")
|
||||
|| str_contains($content, "requestInput()->method()")
|
||||
|| str_contains($content, "(requestInput()->method())")
|
||||
|| str_contains($content, 'hasBody(')
|
||||
|| str_contains($content, 'bodyAll()')
|
||||
|| preg_match('/->body\(/', $content) === 1;
|
||||
|
||||
Reference in New Issue
Block a user