Merge pull request #9 from coudenysj/jwt-token-exp

Add support for the JWT exp payload
eljam · Jun 27, 2018 · cec479a · cec479a
2 parents b61b2e7 + 8643312
commit cec479a
Show file tree

Hide file tree

Showing 5 changed files with 133 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -138,6 +138,16 @@ $jwtManager = new JwtManager(
 );
 ```
 
+## Authorization Header Type
+
+Some endpoints use different Authorization header types (Bearer, JWT, etc...).
+
+The default is Bearer, but another type can be supplied in the middleware:
+
+```php
+$stack->push(new JwtMiddleware($jwtManager, 'JWT'));
+```
+
 ## Cached token
 
 To avoid too many calls between multiple request, there is a cache system.
@@ -161,3 +171,5 @@ $jwtManager = new JwtManager(
         'expire_key' => 'expires_in', # default is expires_in if not set
     ]
 );
+
+The bundle natively supports the [exp field](https://tools.ietf.org/html/rfc7519.html#section-4.1.4) in the JWT payload.
diff --git a/Tests/JwtMiddlewareTest.php b/Tests/JwtMiddlewareTest.php
@@ -39,7 +39,7 @@ public function testJwtAuthorizationHeader()
             function (RequestInterface $request) {
                 $this->assertTrue($request->hasHeader('Authorization'));
                 $this->assertSame(
-                    sprintf(JwtMiddleware::AUTH_BEARER, 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'),
+                    'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
                     $request->getHeader('Authorization')[0]
                 );
 
@@ -53,4 +53,42 @@ function (RequestInterface $request) {
         $client = new Client(['handler' => $handler]);
         $client->get('http://api.example.com/api/ping');
     }
+
+    /**
+     * testJwtAuthorizationHeaderType.
+     */
+    public function testJwtAuthorizationHeaderType()
+    {
+        $authMockHandler = new MockHandler([
+            new Response(
+                200,
+                ['Content-Type' => 'application/json'],
+                json_encode(['token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'])
+            ),
+        ]);
+
+        $authClient = new Client(['handler' => $authMockHandler]);
+        $jwtManager = new JwtManager(
+            $authClient,
+            (new HttpBasicAuthStrategy(['username' => 'test', 'password' => 'test']))
+        );
+
+        $mockHandler = new MockHandler([
+            function (RequestInterface $request) {
+                $this->assertTrue($request->hasHeader('Authorization'));
+                $this->assertSame(
+                    'JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
+                    $request->getHeader('Authorization')[0]
+                );
+
+                return new Response(200, [], json_encode(['data' => 'pong']));
+            },
+        ]);
+
+        $handler = HandlerStack::create($mockHandler);
+        $handler->push(new JwtMiddleware($jwtManager, 'JWT'));
+
+        $client = new Client(['handler' => $handler]);
+        $client->get('http://api.example.com/api/ping');
+    }
 }
diff --git a/Tests/Manager/JwtManagerTest.php b/Tests/Manager/JwtManagerTest.php
@@ -212,4 +212,67 @@ function (RequestInterface $request) {
         $this->assertInstanceOf(JwtToken::class, $token);
         $this->assertEquals('1453720507', $token->getToken());
     }
+
+    public function testGetTokenShouldUseTheCachedTokenIfItIsValidBasedOnExpField()
+    {
+        $jwtToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9'
+            . '.eyJleHAiOiIzMjUwMzY4MDAwMCJ9'
+            . '.k4YJmJooaa9B4pAM_U8Pi-4ss6RdKFtj9iQqLIAndVA';
+
+        $mockHandler = new MockHandler(
+            [
+                function (RequestInterface $request) use ($jwtToken) {
+
+                    $this->assertTrue($request->hasHeader('timeout'));
+                    $this->assertEquals(
+                        3,
+                        $request->getHeaderLine('timeout')
+                    );
+
+                    return new Response(
+                        200,
+                        ['Content-Type' => 'application/json'],
+                        json_encode(['token' => $jwtToken])
+                    );
+                },
+                function (RequestInterface $request) {
+
+                    $this->assertTrue($request->hasHeader('timeout'));
+                    $this->assertEquals(
+                        3,
+                        $request->getHeaderLine('timeout')
+                    );
+
+                    return new Response(
+                        200,
+                        ['Content-Type' => 'application/json'],
+                        json_encode(['token' => uniqid('token', true)])
+                    );
+                },
+            ]
+        );
+
+        $handler = HandlerStack::create($mockHandler);
+
+        $authClient = new Client([
+            'handler' => $handler,
+        ]);
+
+        $authStrategy = new QueryAuthStrategy(['username' => 'admin', 'password' => 'admin']);
+
+        $jwtManager = new JwtManager(
+            $authClient,
+            $authStrategy,
+            ['token_url' => '/api/token', 'timeout' => 3]
+        );
+        $token = $jwtManager->getJwtToken();
+
+        $this->assertInstanceOf(JwtToken::class, $token);
+        $this->assertEquals($jwtToken, $token->getToken());
+
+        $token = $jwtManager->getJwtToken();
+
+        $this->assertInstanceOf(JwtToken::class, $token);
+        $this->assertEquals($jwtToken, $token->getToken());
+    }
 }
diff --git a/src/JwtMiddleware.php b/src/JwtMiddleware.php
@@ -10,23 +10,30 @@
  */
 class JwtMiddleware
 {
-    const AUTH_BEARER = 'Bearer %s';
-
     /**
      * $JwtManager.
      *
      * @var JwtManager
      */
     protected $jwtManager;
 
+    /**
+     * The Authorization Header Type (defaults to Bearer)
+     *
+     * @var string
+     */
+    protected $authorizationHeaderType;
+
     /**
      * Constructor.
      *
      * @param JwtManager $jwtManager
+     * @param string $authorizationHeaderType
      */
-    public function __construct(JwtManager $jwtManager)
+    public function __construct(JwtManager $jwtManager, $authorizationHeaderType = 'Bearer')
     {
         $this->jwtManager = $jwtManager;
+        $this->authorizationHeaderType = $authorizationHeaderType;
     }
 
     /**
@@ -48,9 +55,10 @@ public function __invoke(callable $handler)
             $manager
         ) {
             $token = $manager->getJwtToken()->getToken();
+
             return $handler($request->withHeader(
                 'Authorization',
-                sprintf(self::AUTH_BEARER, $token)
+                sprintf('%s %s', $this->authorizationHeaderType, $token)
             ), $options);
         };
     }

diff --git a/src/Manager/JwtManager.php b/src/Manager/JwtManager.php
@@ -94,6 +94,13 @@ public function getJwtToken()
 
         if ($expiresIn) {
             $expiration = new \DateTime('now + ' . $expiresIn . ' seconds');
+        } elseif (count($jwtParts = explode('.', $body[$this->options['token_key']])) === 3
+            && is_array($payload = json_decode(base64_decode($jwtParts[1]), true))
+            // https://tools.ietf.org/html/rfc7519.html#section-4.1.4
+            && array_key_exists('exp', $payload)
+        ) {
+            // Manually process the payload part to avoid having to drag in a new library
+            $expiration = new \DateTime('@' . $payload['exp']);
         } else {
             $expiration = null;
         }