Merge pull request #266 from leoralph/main

Add config to set auth cookie key name

Author: Messhias

CHANGELOG.md

@@ -10,6 +10,7 @@ You can find and compare releases at the GitHub release page.
 
 ### Added
 - Fixes #259 - Can't logout with an expired token
+- Add `cookie_key_name` config to customize cookie name for authentication
 
 ### Removed
 

config/config.php

@@ -254,6 +254,17 @@
 
     'decrypt_cookies' => false,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Cookie key name
+    |--------------------------------------------------------------------------
+    |
+    | Specify the cookie key name that you would like to use for the cookie token.
+    |
+    */
+
+    'cookie_key_name' => 'token',
+
     /*
     |--------------------------------------------------------------------------
     | Providers

docs/quick-start.md

@@ -221,4 +221,18 @@ There are a number of ways to send the token via http:
 
 **Cookies**
 
+By default, you can send a token via a cookie. You can customize the cookie name within the `jwt.cookie_name` configuration.
+
+```php
+// config/jwt.php
+
+return [
+    // ...
+    'cookie_name' => 'token',
+    // ...
+];
+```
+
+When making requests, the token will be automatically read from the specified cookie, the default key name is `token`.
+
 **Laravel route parameter**

src/Providers/JWT/Lcobucci.php

@@ -71,7 +71,7 @@ public function __construct(
         $secret,
         $algo,
         array $keys,
-        $config = null
+        $config = null,
     ) {
         parent::__construct($secret, $algo, $keys);
         $this->generateConfig($config);

src/Providers/LaravelServiceProvider.php

@@ -34,9 +34,13 @@ public function boot()
 
         $this->extendAuthGuard();
 
+        $config = $this->app->make('config');
+
         $this->app['tymon.jwt.parser']->addParser([
             new RouteParams(),
-            new Cookies($this->app->make('config')->get('jwt.decrypt_cookies')),
+            (new Cookies(
+                $config->get('jwt.decrypt_cookies'),
+            ))->setKey($config->get('jwt.cookie_key_name', 'token')),
         ]);
 
         if (isset($_SERVER['LARAVEL_OCTANE'])) {

tests/DefaultConfigValuesTest.php

@@ -109,4 +109,9 @@ public function testProvidersShouldBeSet()
         $this->assertEquals(AuthIlluminate::class, $this->configuration['providers']['auth']);
         $this->assertEquals(StorageIlluminate::class, $this->configuration['providers']['storage']);
     }
+
+    public function testCookieKeyNameShouldBeSet()
+    {
+        $this->assertEquals('token', $this->configuration['cookie_key_name']);
+    }
 }