lexik/jwt-authentication-bundle

This bundle provides JWT authentication for your Symfony REST API

v3.1.0 2024-07-03 20:49 UTC

Requires

• php: >=8.2
• ext-openssl: *
• lcobucci/clock: ^3.0
• lcobucci/jwt: ^5.0
• symfony/config: ^6.4|^7.0
• symfony/dependency-injection: ^6.4|^7.0
• symfony/deprecation-contracts: ^2.4|^3.0
• symfony/event-dispatcher: ^6.4|^7.0
• symfony/http-foundation: ^6.4|^7.0
• symfony/http-kernel: ^6.4|^7.0
• symfony/property-access: ^6.4|^7.0
• symfony/security-bundle: ^6.4|^7.0
• symfony/translation-contracts: ^1.0|^2.0|^3.0

Requires (Dev)

• api-platform/core: ^3.0
• symfony/browser-kit: ^6.4|^7.0
• symfony/console: ^6.4|^7.0
• symfony/dom-crawler: ^6.4|^7.0
• symfony/filesystem: ^6.4|^7.0
• symfony/framework-bundle: ^6.4|^7.0
• symfony/phpunit-bridge: ^6.4|^7.0
• symfony/var-dumper: ^6.4|^7.0
• symfony/yaml: ^6.4|^7.0

Suggests

• gesdinet/jwt-refresh-token-bundle: Implements a refresh token system over Json Web Tokens in Symfony
• spomky-labs/lexik-jose-bridge: Provides a JWT Token encoder with encryption support

MIT

• Jeremy Barthe
• Nicolas Cabot
• Cedric Girard
• Dev Lexik
• Robin Chalas
• Lexik Community

• symfony
• rest
• api
• Authentication
• bundle
• jwt
• JWS

README

This bundle provides JWT (Json Web Token) authentication for your Symfony API.

It is compatible (and tested) with PHP > 8.2 up to 8.4 and Symfony > 6.4 up to 7.2.

Documentation

The bulk of the documentation is stored in the Resources/doc directory of this bundle:

• Getting started
  • Prerequisites
  • Installation
  • Configuration
  • Usage
  • Notes
• Further documentation
  • Configuration reference
  • Data customization and validation
  • Functional testing
  • Working with CORS requests
  • JWT encoder service customization
  • Extending Authenticator
  • Creating JWT tokens programmatically
  • A database-less user provider
  • Accessing the authenticated JWT token
  • Invalidate token on logout

Community Support

Please consider opening a question on StackOverflow using the lexikjwtauthbundle tag, it is the official support platform for this bundle.

Github Issues are dedicated to bug reports and feature requests.

Contributing

See the CONTRIBUTING file.

Sponsoring

Huge thanks to Blackfire and JetBrains for providing this project with free open-source licenses.

If you or your company use this package, please consider sponsoring its maintenance and development.

Upgrading from 1.x

Please see the UPGRADE file.

Credits

• Robin Chalas
• Lexik [e-mail]
• All contributors

License

This bundle is under the MIT license.
For the whole copyright, see the LICENSE file distributed with this source code.