jimtools/jwt-auth

Drop in replacement for tuupola/slim-jwt-auth

2.0.0 2024-09-27 20:10 UTC

Requires

• php: ~8.1|~8.2|~8.3
• firebase/php-jwt: ^6.0
• psr/http-message: ^2.0
• psr/http-server-middleware: ^1.0

Requires (Dev)

• equip/dispatch: ^2.0
• friendsofphp/php-cs-fixer: ^3.52
• laminas/laminas-diactoros: ^3.3
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.0|^11.0
• rector/rector: ^1.1

Replaces

• tuupola/slim-jwt-auth: *

MIT

• James Read

• json
• middleware
• auth
• jwt
• psr-7
• psr-15

README

This package is a PSR-15 compliant JSON Web Token authentication middleware, which take a JWT from the headers or cookies.

use JimTools\JwtAuth\Decoder\FirebaseDecoder;
use JimTools\JwtAuth\Middleware\JwtAuthentication;
use JimTools\JwtAuth\Exceptions\AuthorizationException;
use JimTools\JwtAuth\Options;
use JimTools\JwtAuth\Secret;
use Psr\Http\Message\ResponseInterface as Response;
use Psr\Http\Message\ServerRequestInterface as Request;
use Slim\Factory\AppFactory;

require './vendor/autoload.php';

$app = AppFactory::create();
$app->addErrorMiddleware(false, false, false)
    ->setErrorHandler(AuthorizationException::class, new MyErrorHandler());

$middleware = new JwtAuthentication(
    new Options(),
    new FirebaseDecoder(new Secret('tooManySecrets', 'HS256'))
);

$app->get('/protected', static function (Request $request, Response $response, array $args) {
    $response->getBody()->write('you will need a token');
    return $response;
})->addMiddleware($middleware);

$app->run();

Note

For documentation on v1.x which is conpatiable with tuupola/slim-jwt-auth see 1.x

Install

The recommended way to install packages is through composer.

composer require jimtools/jwt-auth

Documentation

GitHub issues are used for only to discuss bugs and new features, for support please use GitHub discussions.

• Documentation
• Support
• Bugs

Security

If you discover any security-related issues, please email [e-mail] instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.