phpsoftbox/auth

There is no license information available for the latest version (dev-master) of this package.

Auth component for the PhpSoftBox framework

dev-master 2026-02-06 12:35 UTC

Requires

• php: ^8.4
• phpsoftbox/session: dev-master
• psr/container: ^2.0
• psr/http-message: ^2.0
• psr/http-server-handler: ^1.0
• psr/http-server-middleware: ^1.0

Requires (Dev)

• phpsoftbox/database: dev-master
• phpsoftbox/http-message: dev-master
• phpunit/phpunit: ^11.2

Unknown License

README

Компонент аутентификации для Application.

Middleware

use PhpSoftBox\Auth\Middleware\AuthMiddleware;
use PhpSoftBox\Auth\Manager\AuthManager;
use PhpSoftBox\Auth\Guard\SessionGuard;
use PhpSoftBox\Auth\Guard\TokenGuard;
use PhpSoftBox\Auth\Provider\ArrayUserProvider;
use PhpSoftBox\Auth\Provider\ArrayTokenProvider;
use PhpSoftBox\Session\Session;
use PhpSoftBox\Session\ArraySessionStore;

$users = new ArrayUserProvider([
    ['id' => 1, 'email' => '[e-mail]', 'password_hash' => password_hash('secret', PASSWORD_DEFAULT)],
]);

$tokens = new ArrayTokenProvider([
    'token-123' => 1,
]);

$auth = new AuthManager([
    'web' => new SessionGuard(new Session(new ArraySessionStore()), $users),
    'api' => new TokenGuard($tokens, $users),
], defaultGuard: 'web');

$middleware = new AuthMiddleware($auth, guardName: 'web');

Guard

use PhpSoftBox\Auth\Guard\CallbackGuard;

$guard = new CallbackGuard(fn ($request) => $request->getAttribute('user'));

SessionGuard (web)

use PhpSoftBox\Auth\Provider\ArrayUserProvider;
use PhpSoftBox\Auth\Guard\SessionGuard;
use PhpSoftBox\Session\Session;
use PhpSoftBox\Session\ArraySessionStore;

$users = new ArrayUserProvider([
    ['id' => 1, 'email' => '[e-mail]', 'password_hash' => password_hash('secret', PASSWORD_DEFAULT)],
], loginFields: ['email']);

$session = new Session(new ArraySessionStore());
$guard = new SessionGuard($session, $users);

$guard->attempt(['email' => '[e-mail]', 'password' => 'secret']);

TokenGuard (api)

use PhpSoftBox\Auth\Guard\TokenGuard;
use PhpSoftBox\Auth\Token\BearerTokenExtractor;
use PhpSoftBox\Auth\Provider\ArrayTokenProvider;
use PhpSoftBox\Auth\Provider\ArrayUserProvider;

$users = new ArrayUserProvider([
    ['id' => 1, 'email' => '[e-mail]', 'password_hash' => password_hash('secret', PASSWORD_DEFAULT)],
]);

$tokens = new ArrayTokenProvider([
    'token-123' => 1,
]);

$guard = new TokenGuard($tokens, $users, new BearerTokenExtractor());

Валидация по SMS (OTP)

use PhpSoftBox\Auth\Otp\InMemoryOtpValidator;
use PhpSoftBox\Auth\Credentials\OtpCredentialsValidator;
use PhpSoftBox\Auth\Provider\ArrayUserProvider;

$otp = new InMemoryOtpValidator(maxAttempts: 5);
$otp->setCode('79001234567', '1234');

$users = new ArrayUserProvider(
    users: [
        ['id' => 1, 'phone_number' => '79001234567'],
    ],
    loginFields: ['phone_number'],
    validators: [new OtpCredentialsValidator($otp, credentialKey: 'sms_code', identifierField: 'phone_number')],
);

$user = $users->retrieveByCredentials(['phone_number' => '79001234567', 'sms_code' => '1234']);

Guard для разных URL

use PhpSoftBox\Auth\Middleware\AuthMiddleware;
use PhpSoftBox\Application\Application;
use PhpSoftBox\Router\RouteCollector;

$app = new Application($router, container: $container);

$app->alias('auth.web', new AuthMiddleware($auth, guardName: 'web'));
$app->alias('auth.api', new AuthMiddleware($auth, guardName: 'api'));

$app->middlewareGroup('web', ['auth.web']);
$app->middlewareGroup('api', ['auth.api']);

$routes = new RouteCollector();
$routes->group('/users', static function (RouteCollector $routes): void {
    $routes->get('/{id}', [UserController::class, 'show']);
}, ['web']);

$routes->group('/api', static function (RouteCollector $routes): void {
    $routes->get('/users/{id}', [UserController::class, 'show']);
}, ['api']);

Провайдеры

• ArrayUserProvider / FileUserProvider — пользователи из массива/файла.
• ArrayTokenProvider / FileTokenProvider — токены из массива/файла.
• DatabaseUserProvider / DatabaseTokenProvider — адаптеры для phpsoftbox/database (опционально, через require-dev).