PHPackages yiisoft/auth-jwt - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. yiisoft/auth-jwt ActiveLibrary[Framework](/categories/framework) yiisoft/auth-jwt ================ Yii auth JWT method 2.1.0(1y ago)345.0k↓38.9%9[1 issues](https://github.com/yiisoft/auth-jwt/issues)BSD-3-ClausePHPPHP ^8.1CI passing Since Feb 11Pushed 3mo ago15 watchersCompare [ Source](https://github.com/yiisoft/auth-jwt)[ Packagist](https://packagist.org/packages/yiisoft/auth-jwt)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/sponsors/yiisoft)[ OpenCollective](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-auth-jwt/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (3)Dependencies (14)Versions (9)Used By (0) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii Auth JWT ============ [](#yii-auth-jwt) [![Latest Stable Version](https://camo.githubusercontent.com/8541ab1a7f170658a88288068fb6fe4605c4ffd40709ca1fa79fcfb49a6fbdd2/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f617574682d6a77742f76)](https://packagist.org/packages/yiisoft/auth-jwt)[![Total Downloads](https://camo.githubusercontent.com/e8d01f55fcfa0d2b6ab07ce08d6f20c72923373c368cdf59a1a81efea31bcaef/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f617574682d6a77742f646f776e6c6f616473)](https://packagist.org/packages/yiisoft/auth-jwt)[![Build status](https://github.com/yiisoft/auth-jwt/actions/workflows/build.yml/badge.svg)](https://github.com/yiisoft/auth-jwt/actions/workflows/build.yml)[![Code Coverage](https://camo.githubusercontent.com/c75a95514788c1611a35e76b7d5ac5925fc3b34abd4facd657de793542d3891f/68747470733a2f2f636f6465636f762e696f2f67682f796969736f66742f617574682d6a77742f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/yiisoft/auth-jwt)[![Mutation testing badge](https://camo.githubusercontent.com/f5e75715884c74d7bd71cf505a41debac5192147cd7d5f57eee7772a5836fb7f/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246617574682d6a77742532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/auth-jwt/master)[![static analysis](https://github.com/yiisoft/auth-jwt/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/auth-jwt/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/e2261e5e03be05d1cf80c035f3488cb7b960e6af6c9fd88748b0d845ce3cc80a/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f617574682d6a77742f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/auth-jwt)[![psalm-level](https://camo.githubusercontent.com/66eb14a75001a84f415e4470e7a263215c595671447d891d47a786ab4c1e657d/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f617574682d6a77742f6c6576656c2e737667)](https://shepherd.dev/github/yiisoft/auth-jwt) The package provides [JWT authentication](https://tools.ietf.org/html/rfc7519) method for [Yii Auth](https://github.com/yiisoft/auth/). Requirements ------------ [](#requirements) - PHP 8.1 or higher. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/auth-jwt ``` General usage ------------- [](#general-usage) ### Configuring within Yii [](#configuring-within-yii) 1. Set JWT parameters in your `params.php` config file: ``` 'yiisoft/auth-jwt' => [ 'algorithms' => [ // your signature algorithms ], 'serializers' => [ // your token serializers ], 'key' => [ 'secret' => 'your-secret', 'file' => 'your-certificate-file', ], ], ``` 2. Setup definitions, required for `\Yiisoft\Auth\Middleware\Authentication` middleware in a config, for example, in `config/web/auth.php`: ``` /** @var array $params */ use Yiisoft\Auth\Jwt\TokenManagerInterface; use Yiisoft\Auth\Jwt\TokenManager; use Yiisoft\Auth\AuthenticationMethodInterface; use Yiisoft\Auth\Jwt\JwtMethod; return [ KeyFactoryInterface::class => [ 'class' => FromSecret::class, '__construct()' => [ $params['yiisoft/auth-jwt']['key']['secret'] ], ], AuthenticationMethodInterface::class => JwtMethod::class, ]; ``` > Note: Don't forget to declare your implementations of `\Yiisoft\Auth\IdentityInterface` and `\Yiisoft\Auth\IdentityRepositoryInterface`. 3. Use `Yiisoft\Auth\Middleware\Authentication` middleware. Read more about middlewares in the [middleware guide](https://github.com/yiisoft/docs/blob/master/guide/en/structure/middleware.md). ### Configuring independently [](#configuring-independently) You can configure `Authentication` middleware manually: ``` /** @var \Yiisoft\Auth\IdentityRepositoryInterface $identityRepository */ $identityRepository = getIdentityRepository(); $tokenRepository = $container->get(\Yiisoft\Auth\Jwt\TokenRepositoryInterface::class); $authenticationMethod = new \Yiisoft\Auth\Jwt\JwtMethod($identityRepository, $tokenRepository); $middleware = new \Yiisoft\Auth\Middleware\Authentication( $authenticationMethod, $responseFactory, // PSR-17 ResponseFactoryInterface. $failureHandler // Optional, \Yiisoft\Auth\Handler\AuthenticationFailureHandler by default. ); ``` Documentation ------------- [](#documentation) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). License ------- [](#license) The Yii Auth JWT is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). Support the project ------------------- [](#support-the-project) [![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft) Follow updates -------------- [](#follow-updates) [![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack) ### Health Score 50 — FairBetter than 96% of packages Maintenance59 Moderate activity, may be stable Popularity36 Limited adoption so far Community28 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor3 3 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~214 days Recently: every ~306 days Total 7 Last Release 636d ago Major Versions 1.0.3 → 2.0.02023-02-13 PHP version history (2 changes)1.0.0PHP ^7.4|^8.0 2.1.0PHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe) ![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark) ![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire) ![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol) --- Top Contributors [![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (31 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (17 commits)")[![rustamwin](https://avatars.githubusercontent.com/u/16498265?v=4)](https://github.com/rustamwin "rustamwin (10 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (9 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (8 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (5 commits)")[![dependabot-preview[bot]](https://avatars.githubusercontent.com/in/2141?v=4)](https://github.com/dependabot-preview[bot] "dependabot-preview[bot] (5 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (4 commits)")[![arogachev](https://avatars.githubusercontent.com/u/8326201?v=4)](https://github.com/arogachev "arogachev (4 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (3 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (3 commits)")[![mspirkov](https://avatars.githubusercontent.com/u/63721828?v=4)](https://github.com/mspirkov "mspirkov (2 commits)")[![strorch](https://avatars.githubusercontent.com/u/23340907?v=4)](https://github.com/strorch "strorch (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![eluhr](https://avatars.githubusercontent.com/u/13000805?v=4)](https://github.com/eluhr "eluhr (1 commits)")[![wiperawa](https://avatars.githubusercontent.com/u/14181470?v=4)](https://github.com/wiperawa "wiperawa (1 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)") --- Tags authauthenticationhacktoberfestjwt-authenticationmiddlewarepsr-15yii3jwtmiddlewareauthpsr-15 ### Code Quality TestsPHPUnit Static AnalysisPsalm, Rector Type Coverage Yes ### Embed Badge ![Health badge](/badges/yiisoft-auth-jwt/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-auth-jwt/health.svg)](https://phpackages.com/packages/yiisoft-auth-jwt) ``` ### Alternatives [cakephp/authentication Authentication plugin for CakePHP 1153.6M67](/packages/cakephp-authentication)[tuupola/slim-basic-auth PSR-7 and PSR-15 HTTP Basic Authentication Middleware 4442.0M26](/packages/tuupola-slim-basic-auth)[jimtools/jwt-auth PSR-15 JWT Authentication middleware, A replacement for tuupola/slim-jwt-auth 20142.3k3](/packages/jimtools-jwt-auth)[yiisoft/auth Yii auth 37170.6k4](/packages/yiisoft-auth)[cakephp/authorization Authorization abstraction layer plugin for CakePHP 742.2M34](/packages/cakephp-authorization)[yiisoft/csrf Yii CSRF Protection Library 27253.1k10](/packages/yiisoft-csrf) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)