PHPackages robbickel/phalcon-jwt-auth-php5 - 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. robbickel/phalcon-jwt-auth-php5 ActiveLibrary robbickel/phalcon-jwt-auth-php5 =============================== A simple JWT middleware for Phalcon Micro to handle stateless authentication, cloned from https://github.com/dmkit/phalcon-jwt-auth and made compatible with php5 05PHP Since Dec 24Pushed 8y ago1 watchersCompare [ Source](https://github.com/RobBickel/phalcon-jwt-auth-php5)[ Packagist](https://packagist.org/packages/robbickel/phalcon-jwt-auth-php5)[ RSS](/packages/robbickel-phalcon-jwt-auth-php5/feed)WikiDiscussions master Synced 2mo ago READMEChangelogDependenciesVersions (1)Used By (0) phalcon-jwt-auth ================ [](#phalcon-jwt-auth) A simple JWT middleware for Phalcon Micro to handle stateless authentication. Installation ------------ [](#installation) ``` $ composer require robbickel/phalcon-jwt-auth-php5 ``` or in your composer.json ``` { "require": { "robbickel/phalcon-jwt-auth-php5" : "dev-master" } } ``` then run ``` $ composer update ``` Usage ----- [](#usage) ### Configuration - Loading the config service [](#configuration---loading-the-config-service) in config.ini or in any config file ``` [jwtAuth] ; JWT Secret Key secretKey = 923753F2317FC1EE5B52DF23951B ; JWT default Payload ;; expiry time in minutes payload[exp] = 1440 payload[iss] = phalcon-jwt-auth-php5 ; Micro Applications do not have a controller or dispatcher ; so to know the resource being called we have to check the actual URL. ; If you want to disable the middleware on certain routes or resource: ;; index ignoreUri[] = / ;; regex pattern with http methods ignoreUri[] = regex:/application/ ignoreUri[] = regex:/users/:POST,PUT ;; literal strings ignoreUri[] = /auth/user:POST,PUT ignoreUri[] = /auth/application ``` in bootstrap or index file ``` use Phalcon\Mvc\Micro; use Phalcon\Config\Adapter\Ini as ConfigIni; use Phalcon\Di\FactoryDefault; use Dmkit\Phalcon\Auth\Middleware\Micro as AuthMicro; // set default services $di = new FactoryDefault(); /** * IMPORTANT: * You must set "config" service that will load the configuration file. */ $config = new ConfigIni( APP_PATH . "app/config/config.ini"); $di->set( "config", function () use($config) { return $config; } ); $app = new Micro($di); // AUTH MICRO $auth = new AuthMicro($app); $app->handle(); ``` ### Configuration - Don't want to use a config file? then pass the config instead [](#configuration---dont-want-to-use-a-config-file-then-pass-the-config-instead) in bootstrap or index file ``` use Phalcon\Mvc\Micro; use Phalcon\Config\Adapter\Ini as ConfigIni; use Phalcon\Di\FactoryDefault; use Dmkit\Phalcon\Auth\Middleware\Micro as AuthMicro; $loader = new Loader(); $loader->registerFiles( [ __DIR__ . '/vendor/autoload.php' ] ); $loader->register(); // set default services $di = new FactoryDefault(); $app = new Micro($di); // SETUP THE CONFIG $authConfig = [ 'secretKey' => '923753F2317FC1EE5B52DF23951B1', 'payload' => [ 'exp' => 1440, 'iss' => 'phalcon-jwt-auth-php5' ], 'ignoreUri' => [ '/', 'regex:/application/', 'regex:/users/:POST,PUT', '/auth/user:POST,PUT', '/auth/application' ] ]; // AUTH MICRO $auth = new AuthMicro($app, $authConfig); $app->handle(); ``` ### Authentication [](#authentication) To make authenticated requests via http, you will need to set an authorization headers as follows: ``` Authorization: Bearer {yourtokenhere} ``` or pass the token as a query string ``` ?_token={yourtokenhere} ``` ### Callbacks [](#callbacks) By default if the authentication fails, the middleware will stop the execution of routes and will immediately return a response of 401 Unauthorized. If you want to add your own handler: ``` $auth->onUnauthorized(function($authMicro, $app) { $response = $app["response"]; $response->setStatusCode(401, 'Unauthorized'); $response->setContentType("application/json"); // to get the error messages $response->setContent(json_encode([$authMicro->getMessages()[0]])); $response->send(); // return false to stop the execution return false; }); ``` If you want an additional checking on the authentication, like intentionally expiring a token based on the payload issued date, you may do so: ``` $auth->onCheck(function($auth) { // to get the payload $data = $auth->data(); if($data['iat'] data() ); print_r( $app->getDI()->get('auth')->data('email') ); // in your contoller print_r( $this->auth->data() ); ``` If you want to change the service name: ``` AuthMicro::$diName = 'jwtAuth'; ``` ### Creating a token [](#creating-a-token) In your controller or route handler ``` $payload = [ 'sub' => $user->id, 'email' => $user->email, 'username' => $user->username, 'role' => 'admin', 'iat' => time(), ]; $token = $this->auth->make($payload); ``` ### Accessing the authenticated user / data [](#accessing-the-authenticated-user--data) In your controller or route handler ``` echo $this->auth->id(); // will look for sub or id payload echo $this->auth->data(); // return all payload echo $this->auth->data('email'); ``` ### Extending [](#extending) If you want to add your own middleware or play around: ``` Dmkit\Phalcon\Auth\Auth.php and its adapters - does all the authentication Dmkit\Phalcon\Auth\TokenGetter\TokenGetter.php and its adapters - does the parsing or getting of token ``` ### JWT [](#jwt) Phalcon JWT Auth uses the Firebase JWT library. To learn more about it and JSON Web Tokens in general, visit: ### Tests [](#tests) Install PHPUnit ``` $ phpunit --configuration phpunit.xml.dist PHPUnit 5.6.5 by Sebastian Bergmann and contributors. ......["missing token"].["members option"].["members put"].["members put"].["Expired token"].["members post"].... 15 / 15 (100%) Time: 73 ms, Memory: 10.00MB OK (15 tests, 27 assertions) ``` ### Health Score 20 — LowBetter than 14% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity4 Limited adoption so far Community7 Small or concentrated contributor base Maturity41 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/84b455cf279267179a602cccbdc76b8111b831ea4801390fb0c026cdf1c6db12?d=identicon)[RobBickel](/maintainers/RobBickel) --- Top Contributors [![RobBickel](https://avatars.githubusercontent.com/u/2607457?v=4)](https://github.com/RobBickel "RobBickel (13 commits)") ### Embed Badge ![Health badge](/badges/robbickel-phalcon-jwt-auth-php5/health.svg) ``` [![Health](https://phpackages.com/badges/robbickel-phalcon-jwt-auth-php5/health.svg)](https://phpackages.com/packages/robbickel-phalcon-jwt-auth-php5) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)