PHP 8 Support (#269)

* bump JWT
* Add PHP 8 build
* Remove PHP CS fixer for now
* Allow PHPUnit 9
* Fix static keyword
* Locked to jwt 3.4|4.0, and fixed tests to use toString()

Co-authored-by: Chris Tankersley <[email protected]>

Author: driesvints

.github/workflows/build.yml

@@ -8,8 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: [ '7.2', '7.3', '7.4' ]
-    continue-on-error: ${{ matrix.php == '8.0' }}
+        php: [ '7.2', '7.3', '7.4', '8.0' ]
     name: PHP ${{ matrix.php }} Test
 
     steps:

composer.json

@@ -21,19 +21,18 @@
     "ext-json": "*",
     "ext-mbstring": "*",
     "laminas/laminas-diactoros": "^2.4",
-    "lcobucci/jwt": "^3.3",
+    "lcobucci/jwt": "^3.4|^4.0",
     "composer/package-versions-deprecated": "^1.11",
     "psr/container": "^1.0",
     "psr/http-client-implementation": "^1.0",
     "vonage/nexmo-bridge": "^0.1.0"
   },
   "require-dev": {
-    "friendsofphp/php-cs-fixer": "^2.16",
     "guzzlehttp/guzzle": ">=6",
     "helmich/phpunit-json-assert": "^3.3",
     "php-http/mock-client": "^1.4",
     "phpstan/phpstan": "^0.12",
-    "phpunit/phpunit": "^8.5",
+    "phpunit/phpunit": "^8.5|^9.4",
     "roave/security-advisories": "dev-latest",
     "squizlabs/php_codesniffer": "^3.5",
     "softcreatr/jsonpath": "^0.6.4"

src/Client.php

@@ -205,9 +205,9 @@ public function __construct(CredentialsInterface $credentials, $options = [], ?C
                 static function (
                     int $errno,
                     string $errstr,
-                    string $errfile,
-                    int $errline,
-                    array $errorcontext
+                    string $errfile = null,
+                    int $errline = null,
+                    array $errorcontext = null
                 ) {
                     return true;
                 },
@@ -478,14 +478,14 @@ public function send(RequestInterface $request): ResponseInterface
             if ($this->needsKeypairAuthentication($request)) {
                 $token = $this->credentials->get(Keypair::class)->generateJwt();
 
-                $request = $request->withHeader('Authorization', 'Bearer ' . $token);
+                $request = $request->withHeader('Authorization', 'Bearer ' . $token->toString());
             } else {
                 $request = self::authRequest($request, $this->credentials->get(Basic::class));
             }
         } elseif ($this->credentials instanceof Keypair) {
             $token = $this->credentials->generateJwt();
 
-            $request = $request->withHeader('Authorization', 'Bearer ' . $token);
+            $request = $request->withHeader('Authorization', 'Bearer ' . $token->toString());
         } elseif ($this->credentials instanceof SignatureSecret) {
             $request = self::signRequest($request, $this->credentials);
         } elseif ($this->credentials instanceof Basic) {

src/Client/Credentials/Keypair.php

@@ -11,8 +11,9 @@
 
 namespace Vonage\Client\Credentials;
 
-use Lcobucci\JWT\Builder;
+use Lcobucci\JWT\Configuration;
 use Lcobucci\JWT\Signer\Key;
+use Lcobucci\JWT\Signer\Key\InMemory;
 use Lcobucci\JWT\Signer\Rsa\Sha256;
 use Lcobucci\JWT\Token;
 use Vonage\Application\Application;
@@ -31,11 +32,6 @@ class Keypair extends AbstractCredentials
      */
     protected $key;
 
-    /**
-     * @var Sha256
-     */
-    protected $signer;
-
     public function __construct($privateKey, $application = null)
     {
         $this->credentials['key'] = $privateKey;
@@ -48,12 +44,13 @@ public function __construct($privateKey, $application = null)
             $this->credentials['application'] = $application;
         }
 
-        $this->key = new Key($privateKey);
-        $this->signer = new Sha256();
+        $this->key = InMemory::plainText($privateKey);
     }
 
     public function generateJwt(array $claims = []): Token
     {
+        $config = Configuration::forSymmetricSigner(new Sha256(), $this->key);
+
         $exp = time() + 60;
         $iat = time();
         $jti = base64_encode((string)mt_rand());
@@ -76,13 +73,13 @@ public function generateJwt(array $claims = []): Token
             unset($claims['jti']);
         }
 
-        $builder = new Builder();
-        $builder->issuedAt($iat)
-            ->expiresAt($exp)
+        $builder = $config->builder();
+        $builder->issuedAt((new \DateTimeImmutable())->setTimestamp($iat))
+            ->expiresAt((new \DateTimeImmutable())->setTimestamp($exp))
             ->identifiedBy($jti);
 
         if (isset($claims['nbf'])) {
-            $builder->canOnlyBeUsedAfter($claims['nbf']);
+            $builder->canOnlyBeUsedAfter((new \DateTimeImmutable())->setTimestamp($claims['nbf']));
 
             unset($claims['nbf']);
         }
@@ -97,6 +94,6 @@ public function generateJwt(array $claims = []): Token
             }
         }
 
-        return $builder->getToken($this->signer, $this->key);
+        return $builder->getToken($config->signer(), $config->signingKey());
     }
 }

src/Client/Signature.php

@@ -65,7 +65,7 @@ public function __construct(array $params, $secret, $signatureMethod)
         $signed = [];
 
         foreach ($this->signed as $key => $value) {
-            $signed[$key] = str_replace(["&", "="], "_", $value);
+            $signed[$key] = str_replace(["&", "="], "_", (string) $value);
         }
 
         //create base string

src/Entity/CollectionTrait.php

@@ -69,9 +69,9 @@ trait CollectionTrait
      */
     protected $filter;
 
-    abstract public function getCollectionName(): string;
+    abstract public static function getCollectionName(): string;
 
-    abstract public function getCollectionPath(): string;
+    abstract public static function getCollectionPath(): string;
 
     /**
      * @param $data
@@ -84,7 +84,7 @@ abstract public function hydrateEntity($data, $id);
      */
     public function current()
     {
-        return $this->hydrateEntity($this->page['_embedded'][$this->getCollectionName()][$this->current], $this->key());
+        return $this->hydrateEntity($this->page['_embedded'][static::getCollectionName()][$this->current], $this->key());
     }
 
     /**
@@ -103,8 +103,8 @@ public function next(): void
     public function key()
     {
         return
-            $this->page['_embedded'][$this->getCollectionName()][$this->current]['id'] ??
-            $this->page['_embedded'][$this->getCollectionName()][$this->current]['uuid'] ??
+            $this->page['_embedded'][static::getCollectionName()][$this->current]['id'] ??
+            $this->page['_embedded'][static::getCollectionName()][$this->current]['uuid'] ??
             $this->current;
     }
 
@@ -119,12 +119,12 @@ public function valid(): bool
         }
 
         //all hal collections have an `_embedded` object, we expect there to be a property matching the collection name
-        if (!isset($this->page['_embedded'][$this->getCollectionName()])) {
+        if (!isset($this->page['_embedded'][static::getCollectionName()])) {
             return false;
         }
 
         //if we have a page with no items, we've gone beyond the end of the collection
-        if (!count($this->page['_embedded'][$this->getCollectionName()])) {
+        if (!count($this->page['_embedded'][static::getCollectionName()])) {
             return false;
         }
 
@@ -134,7 +134,7 @@ public function valid(): bool
         }
 
         //if our current index is past the current page, fetch the next page if possible and reset the index
-        if (!isset($this->page['_embedded'][$this->getCollectionName()][$this->current])) {
+        if (!isset($this->page['_embedded'][static::getCollectionName()][$this->current])) {
             if (isset($this->page['_links']['next'])) {
                 $this->fetchPage($this->page['_links']['next']['href']);
                 $this->current = 0;
@@ -153,7 +153,7 @@ public function valid(): bool
      */
     public function rewind(): void
     {
-        $this->fetchPage($this->getCollectionPath());
+        $this->fetchPage(static::getCollectionPath());
     }
 
     /**

test/Client/Credentials/KeypairTest.php

@@ -57,7 +57,7 @@ public function testDefaultJWT(): void
         $credentials = new Keypair($this->key, $this->application);
 
         //could use the JWT object, but hope to remove as a dependency
-        $jwt = (string)$credentials->generateJwt();
+        $jwt = (string)$credentials->generateJwt()->toString();
 
         [$header, $payload] = $this->decodeJWT($jwt);
 
@@ -84,7 +84,7 @@ public function testAdditionalClaims(): void
         ];
 
         $jwt = $credentials->generateJwt($claims);
-        [, $payload] = $this->decodeJWT($jwt);
+        [, $payload] = $this->decodeJWT($jwt->toString());
 
         $this->assertArrayHasKey('arbitrary', $payload);
         $this->assertEquals($claims['arbitrary'], $payload['arbitrary']);