2.0.0: Migrate from tymon/jwt to PHP-Open-Source-Saver/jwt-auth. Support >=PHP8.0 and October CMS v3.

Author: FlusherDock1

Plugin.php

@@ -20,7 +20,7 @@
 use ReaZzon\JWTAuth\Classes\Events\UserModelHandler;
 
 use System\Classes\PluginManager;
-use Tymon\JWTAuth\Providers\LaravelServiceProvider;
+use PHPOpenSourceSaver\JWTAuth\Providers\LaravelServiceProvider;
 
 /**
  * JWTAuth Plugin Information File
@@ -136,7 +136,8 @@ private function registerJWT(): void
             $guard = new JWTGuard(
                 $app['tymon.jwt'],
                 new UserProvider(app(UserPluginResolverContract::class)->getModel()),
-                $app['request']
+                $app['request'],
+                new \October\Rain\Events\Dispatcher()
             );
 
             $app->refresh('request', $guard, 'setRequest');

classes/UserPluginResolver.php

@@ -6,7 +6,7 @@
 use Model;
 use ReaZzon\JWTAuth\Classes\Contracts\Plugin;
 use System\Classes\PluginManager;
-use Tymon\JWTAuth\Contracts\JWTSubject;
+use PHPOpenSourceSaver\JWTAuth\Contracts\JWTSubject;
 use October\Rain\Support\Traits\Singleton;
 use October\Rain\Auth\Manager as AuthManager;
 use ReaZzon\JWTAuth\Classes\Contracts\UserPluginResolver as UserPluginResolverContract;

classes/behaviors/UserSubjectBehavior.php

@@ -3,7 +3,7 @@
 namespace ReaZzon\JWTAuth\Classes\Behaviors;
 
 use October\Rain\Database\ModelBehavior;
-use Tymon\JWTAuth\Contracts\JWTSubject;
+use PHPOpenSourceSaver\JWTAuth\Contracts\JWTSubject;
 
 /**
  * Class UserSubjectBehavior

classes/contracts/Plugin.php

@@ -3,7 +3,7 @@
 
 namespace ReaZzon\JWTAuth\Classes\Contracts;
 
-use Tymon\JWTAuth\Contracts\JWTSubject;
+use PHPOpenSourceSaver\JWTAuth\Contracts\JWTSubject;
 use Model;
 
 /**

classes/contracts/UserPluginResolver.php

@@ -4,7 +4,7 @@
 namespace ReaZzon\JWTAuth\Classes\Contracts;
 
 use October\Rain\Auth\Manager as AuthManager;
-use Tymon\JWTAuth\Contracts\JWTSubject;
+use PHPOpenSourceSaver\JWTAuth\Contracts\JWTSubject;
 use Model;
 
 /**

classes/guards/JWTGuard.php

@@ -3,8 +3,8 @@
 use Illuminate\Contracts\Auth\Authenticatable;
 use October\Rain\Auth\Models\User;
 use ReaZzon\JWTAuth\Classes\Contracts\UserPluginResolver;
-use Tymon\JWTAuth\Contracts\JWTSubject;
-use Tymon\JWTAuth\JWTGuard as JWTGuardBase;
+use PHPOpenSourceSaver\JWTAuth\Contracts\JWTSubject;
+use PHPOpenSourceSaver\JWTAuth\JWTGuard as JWTGuardBase;
 use ReaZzon\JWTAuth\Classes\Behaviors\UserSubjectBehavior;
 
 /**

classes/resolvers/BuddiesPlugin.php

@@ -11,7 +11,7 @@
 use Lovata\Toolbox\Models\Settings;
 use Lovata\Buddies\Models\User as BuddiesUserModel;
 use ReaZzon\JWTAuth\Models\BuddiesSettings;
-use Tymon\JWTAuth\Contracts\JWTSubject;
+use PHPOpenSourceSaver\JWTAuth\Contracts\JWTSubject;
 use ReaZzon\JWTAuth\Classes\Contracts\Plugin;
 use ReaZzon\JWTAuth\Classes\Exception\PluginModelResolverException;
 

classes/resolvers/RainlabPlugin.php

@@ -6,7 +6,7 @@
 use RainLab\User\Models\User as RainlabUserModel;
 use ReaZzon\JWTAuth\Classes\Contracts\Plugin;
 use ReaZzon\JWTAuth\Classes\Exception\PluginModelResolverException;
-use Tymon\JWTAuth\Contracts\JWTSubject;
+use PHPOpenSourceSaver\JWTAuth\Contracts\JWTSubject;
 use Model;
 
 /**

composer.json

@@ -6,12 +6,12 @@
         "php": ">=7.4",
         "ext-json": "*",
         "composer/installers": "~1.0",
-        "tymon/jwt-auth": "1.0.2"
+        "php-open-source-saver/jwt-auth": "1.4.2"
     },
     "extra": {
         "laravel": {
             "dont-discover": [
-                "tymon/jwt-auth"
+                "php-open-source-saver/jwt-auth"
             ]
         }
     }

config/jwt.php

@@ -1,13 +1,5 @@
 <?php
 
-/*
- * This file is part of jwt-auth.
- *
- * (c) Sean Tymon <[email protected]>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
 return [
     /*
     |--------------------------------------------------------------------------
@@ -22,7 +14,9 @@
     | since RSA and ECDSA use a private/public key combo (See below).
     |
     */
+
     'secret' => env('JWT_SECRET'),
+
     /*
     |--------------------------------------------------------------------------
     | JWT Authentication Keys
@@ -39,6 +33,7 @@
     | RS256, RS384 & RS512 / ES256, ES384 & ES512 will use the keys below.
     |
     */
+
     'keys' => [
         /*
         |--------------------------------------------------------------------------
@@ -50,7 +45,9 @@
         | E.g. 'file://path/to/public/key'
         |
         */
+
         'public' => env('JWT_PUBLIC_KEY'),
+
         /*
         |--------------------------------------------------------------------------
         | Private Key
@@ -61,7 +58,9 @@
         | E.g. 'file://path/to/private/key'
         |
         */
+
         'private' => env('JWT_PRIVATE_KEY'),
+
         /*
         |--------------------------------------------------------------------------
         | Passphrase
@@ -70,8 +69,10 @@
         | The passphrase for your private key. Can be null if none set.
         |
         */
+
         'passphrase' => env('JWT_PASSPHRASE'),
     ],
+
     /*
     |--------------------------------------------------------------------------
     | JWT time to live
@@ -87,6 +88,7 @@
     | Notice: If you set this to null you should remove 'exp' element from 'required_claims' list.
     |
     */
+
     'ttl' => env('JWT_TTL', 60),
 
     /*
@@ -105,6 +107,7 @@
     | systems in place to revoke the token if necessary.
     |
     */
+
     'refresh_ttl' => env('JWT_REFRESH_TTL', 20160),
 
     /*
@@ -118,7 +121,9 @@
     | for possible values.
     |
     */
+
     'algo' => env('JWT_ALGO', 'HS256'),
+
     /*
     |--------------------------------------------------------------------------
     | Required Claims
@@ -129,6 +134,7 @@
     | present in the payload.
     |
     */
+
     'required_claims' => [
         'iss',
         'iat',
@@ -137,6 +143,7 @@
         'sub',
         'jti',
     ],
+
     /*
     |--------------------------------------------------------------------------
     | Persistent Claims
@@ -149,10 +156,12 @@
     | Note: If a claim does not exist then it will be ignored.
     |
     */
+
     'persistent_claims' => [
         // 'foo',
         // 'bar',
     ],
+
     /*
     |--------------------------------------------------------------------------
     | Lock Subject
@@ -169,7 +178,9 @@
     | a little on token size.
     |
     */
+
     'lock_subject' => true,
+
     /*
     |--------------------------------------------------------------------------
     | Leeway
@@ -184,7 +195,9 @@
     | Specify in seconds - only if you know you need it.
     |
     */
+
     'leeway' => env('JWT_LEEWAY', 0),
+
     /*
     |--------------------------------------------------------------------------
     | Blacklist Enabled
@@ -194,7 +207,9 @@
     | If you do not want or need this functionality, then set this to false.
     |
     */
+
     'blacklist_enabled' => env('JWT_BLACKLIST_ENABLED', true),
+
     /*
     | -------------------------------------------------------------------------
     | Blacklist Grace Period
@@ -207,7 +222,20 @@
     | Set grace period in seconds to prevent parallel request failure.
     |
     */
+
     'blacklist_grace_period' => env('JWT_BLACKLIST_GRACE_PERIOD', 0),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Show blacklisted token option
+    |--------------------------------------------------------------------------
+    |
+    | Specify if you want to show black listed token exception on the laravel logs.
+    |
+    */
+
+    'show_black_list_exception' => env('JWT_SHOW_BLACKLIST_EXCEPTION', 0),
+
     /*
     |--------------------------------------------------------------------------
     | Cookies encryption
@@ -223,7 +251,9 @@
     | Set it to true if you want to decrypt cookies.
     |
     */
+
     'decrypt_cookies' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Providers
@@ -232,6 +262,7 @@
     | Specify the various providers used throughout the package.
     |
     */
+
     'providers' => [
         /*
         |--------------------------------------------------------------------------
@@ -241,7 +272,9 @@
         | Specify the provider that is used to create and decode the tokens.
         |
         */
-        'jwt' => Tymon\JWTAuth\Providers\JWT\Lcobucci::class,
+
+        'jwt' => PHPOpenSourceSaver\JWTAuth\Providers\JWT\Lcobucci::class,
+
         /*
         |--------------------------------------------------------------------------
         | Authentication Provider
@@ -250,7 +283,9 @@
         | Specify the provider that is used to authenticate users.
         |
         */
-        'auth' => Tymon\JWTAuth\Providers\Auth\Illuminate::class,
+
+        'auth' => PHPOpenSourceSaver\JWTAuth\Providers\Auth\Illuminate::class,
+
         /*
         |--------------------------------------------------------------------------
         | Storage Provider
@@ -259,6 +294,7 @@
         | Specify the provider that is used to store tokens in the blacklist.
         |
         */
-        'storage' => Tymon\JWTAuth\Providers\Storage\Illuminate::class,
+
+        'storage' => PHPOpenSourceSaver\JWTAuth\Providers\Storage\Illuminate::class,
     ],
 ];

http/middlewares/ResolveUser.php

@@ -3,10 +3,10 @@
 namespace ReaZzon\JWTAuth\Http\Middlewares;
 
 use ReaZzon\JWTAuth\Classes\Guards\JWTGuard;
-use Tymon\JWTAuth\Exceptions\JWTException;
-use Tymon\JWTAuth\Exceptions\UserNotDefinedException;
-use Tymon\JWTAuth\Exceptions\TokenBlacklistedException;
-use Tymon\JWTAuth\Exceptions\TokenExpiredException;
+use PHPOpenSourceSaver\JWTAuth\Exceptions\JWTException;
+use PHPOpenSourceSaver\JWTAuth\Exceptions\UserNotDefinedException;
+use PHPOpenSourceSaver\JWTAuth\Exceptions\TokenBlacklistedException;
+use PHPOpenSourceSaver\JWTAuth\Exceptions\TokenExpiredException;
 
 /**
  * Class ResolveUser

updates/version.yaml

@@ -1 +1,2 @@
 1.0.1: First version of JWTAuth
+2.0.0: Migrate from tymon/jwt to PHP-Open-Source-Saver/jwt-auth. Support >=PHP8.0 and October CMS v3.