T15656 custom jwt

CHANGELOG-5.0.md

@@ -3,6 +3,9 @@
 ## Changed
 - Adjusted the constructor for `Phalcon\Storage\Adapter\*` and `Phalcon\Cache\Adapter\*` to allow an empty key prefix to be set if needed. [#15480](https://github.com/phalcon/cphalcon/issues/15480)
 
+## Added
+- Added `Phalcon\Security\JWT\Builder::addClaim` for custom JWT claims. [#15656](https://github.com/phalcon/cphalcon/issues/15656)
+
 # [5.0.0alpha5](https://github.com/phalcon/cphalcon/releases/tag/v5.0.0alpha5) (2021-09-09)
 
 ## Changed

phalcon/Security/JWT/Builder.zep

@@ -88,6 +88,21 @@ class Builder
         return this;
     }
 
+    /**
+     * Adds a custom claim
+     *
+     * @param string $name
+     * @param mixed  $value
+     *
+     * @return Builder
+     */
+    public function addClaim(string! name, var value) -> <Builder>
+    {
+        this->claims->set(name, value);
+
+        return this;
+    }
+
     /**
      * @return array|string
      */

tests/unit/Security/JWT/Builder/AddClaimCest.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * This file is part of the Phalcon Framework.
+ *
+ * For the full copyright and license information, please view the LICENSE.md
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Phalcon\Test\Unit\Security\JWT\Builder;
+
+use Phalcon\Security\JWT\Builder;
+use Phalcon\Security\JWT\Signer\Hmac;
+use UnitTester;
+
+class AddClaimCest
+{
+    /**
+     * Unit Tests Phalcon\Security\JWT\Builder :: addClaim()
+     *
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
+     */
+    public function securityJWTBuilderAddClaim(UnitTester $I)
+    {
+        $I->wantToTest('Security\JWT\Builder - addClaim()');
+
+        $signer  = new Hmac();
+        $builder = new Builder($signer);
+
+        $I->assertEmpty($builder->getClaims());
+
+        $builder
+            ->setId('this is an id')
+            ->addClaim('username', 'Phalcon')
+            ->addClaim('email', '[email protected]')
+        ;
+
+        $expected = [
+            'email'    => '[email protected]',
+            'jti'      => 'this is an id',
+            'username' => 'Phalcon',
+        ];
+        $actual   = $builder->getClaims();
+        $I->assertCount(3, $actual);
+        $I->assertEquals($expected, $actual);
+    }
+}

tests/unit/Security/JWT/Builder/ConstructCest.php

@@ -20,7 +20,8 @@ class ConstructCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: __construct()
      *
-     * @since  2019-12-19
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderConstruct(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetClaimsCest.php

@@ -20,6 +20,7 @@ class GetClaimsCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getClaims()
      *
+     * @author Phalcon Team <[email protected]>
      * @since  2019-12-22
      */
     public function securityJWTBuilderGetClaims(UnitTester $I)

tests/unit/Security/JWT/Builder/GetHeadersCest.php

@@ -20,7 +20,8 @@ class GetHeadersCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getHeaders()
      *
-     * @since  2019-12-19
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetHeaders(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetSetAudienceCest.php

@@ -21,7 +21,8 @@ class GetSetAudienceCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getAudience()/setAudience()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetSetAudience(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetSetContentTypeCest.php

@@ -20,7 +20,8 @@ class GetSetContentTypeCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getContentType()/setContentType()
      *
-     * @since  2019-12-19
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetSetContentType(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetSetExpirationTimeCest.php

@@ -22,7 +22,8 @@ class GetSetExpirationTimeCest
      * Unit Tests Phalcon\Security\JWT\Builder ::
      * getExpirationTime()/setExpirationTime()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetSetExpirationTime(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetSetIdCest.php

@@ -20,7 +20,8 @@ class GetSetIdCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getId()/setId()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetSetId(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetSetIssuedAtCest.php

@@ -20,7 +20,8 @@ class GetSetIssuedAtCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getIssuedAt()/setIssuedAt()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetSetIssuedAt(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetSetIssuerCest.php

@@ -20,7 +20,8 @@ class GetSetIssuerCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getIssuer()/setIssuer()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetSetIssuer(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetSetNotBeforeCest.php

@@ -21,7 +21,8 @@ class GetSetNotBeforeCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getNotBefore()/setNotBefore()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetSetNotBefore(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetSetPassphraseCest.php

@@ -24,7 +24,9 @@ class GetSetPassphraseCest
      *
      * @throws ValidatorException
      * @throws UnsupportedAlgorithmException
-     * @since  2019-12-19
+     *
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetSetPassphrase(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetSetSubjectCest.php

@@ -20,7 +20,8 @@ class GetSetSubjectCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getSubject()/setSubject()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetSetSubject(UnitTester $I)
     {

tests/unit/Security/JWT/Builder/GetTokenCest.php

@@ -25,7 +25,8 @@ class GetTokenCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: getToken()
      *
-     * @since  2019-12-19
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderGetToken(UnitTester $I)
     {
@@ -71,9 +72,9 @@ public function securityJWTBuilderGetTokenException(UnitTester $I)
                 'Invalid passphrase (empty)'
             ),
             function () {
-                $signer  = new Hmac();
+                $signer = new Hmac();
                 $builder = new Builder($signer);
-                $token   = $builder->getToken();
+                $token = $builder->getToken();
             }
         );
     }

tests/unit/Security/JWT/Builder/InitCest.php

@@ -20,7 +20,8 @@ class InitCest
     /**
      * Unit Tests Phalcon\Security\JWT\Builder :: init()
      *
-     * @since  2019-12-19
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTBuilderInit(UnitTester $I)
     {

tests/unit/Security/JWT/Signer/Hmac/ConstructCest.php

@@ -20,7 +20,8 @@ class ConstructCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\Hmac :: __construct()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTSignerHmacConstruct(UnitTester $I)
     {

tests/unit/Security/JWT/Signer/Hmac/GetAlgHeaderCest.php

@@ -19,7 +19,8 @@ class GetAlgHeaderCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\Hmac :: getAlgHeader()
      *
-     * @since  2019-12-19
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTSignerHmacGetAlgHeader(UnitTester $I)
     {

tests/unit/Security/JWT/Signer/Hmac/GetAlgorithmCest.php

@@ -19,7 +19,8 @@ class GetAlgorithmCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\Hmac :: getAlgorithm()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTSignerHmacGetAlgorithm(UnitTester $I)
     {

tests/unit/Security/JWT/Signer/Hmac/SignCest.php

@@ -21,7 +21,8 @@ class SignCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\Hmac :: sign()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTSignerHmacSign(UnitTester $I)
     {

tests/unit/Security/JWT/Signer/Hmac/VerifyCest.php

@@ -21,7 +21,8 @@ class VerifyCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\Hmac :: verify()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTSignerHmacVerify(UnitTester $I)
     {

tests/unit/Security/JWT/Signer/None/ConstructCest.php

@@ -19,7 +19,8 @@ class ConstructCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\None :: __construct()
      *
-     * @since  2019-12-15
+     * @author Phalcon Team <[email protected]>
+     * @since  2019-12-22
      */
     public function securityJWTSignerNoneConstruct(UnitTester $I)
     {

tests/unit/Security/JWT/Signer/None/GetAlgHeaderCest.php

@@ -19,6 +19,7 @@ class GetAlgHeaderCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\None :: getAlgHeader()
      *
+     * @author Phalcon Team <[email protected]>
      * @since  2019-12-22
      */
     public function securityJWTSignerNoneGetAlgHeader(UnitTester $I)

tests/unit/Security/JWT/Signer/None/GetAlgorithmCest.php

@@ -19,6 +19,7 @@ class GetAlgorithmCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\None :: getAlgorithm()
      *
+     * @author Phalcon Team <[email protected]>
      * @since  2019-12-22
      */
     public function securityJWTSignerNoneGetAlgorithm(UnitTester $I)

tests/unit/Security/JWT/Signer/None/SignCest.php

@@ -19,6 +19,7 @@ class SignCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\None :: sign()
      *
+     * @author Phalcon Team <[email protected]>
      * @since  2019-12-22
      */
     public function securityJWTSignerNoneSign(UnitTester $I)

tests/unit/Security/JWT/Signer/None/VerifyCest.php

@@ -19,6 +19,7 @@ class VerifyCest
     /**
      * Unit Tests Phalcon\Security\JWT\Signer\None :: verify()
      *
+     * @author Phalcon Team <[email protected]>
      * @since  2019-12-22
      */
     public function securityJWTSignerNoneVerify(UnitTester $I)

tests/unit/Security/JWT/Token/Item/ConstructCest.php

@@ -19,6 +19,7 @@ class ConstructCest
     /**
      * Unit Tests Phalcon\Security\JWT\Token\Item :: __construct()
      *
+     * @author Phalcon Team <[email protected]>
      * @since  2019-12-22
      */
     public function securityJWTTokenItemConstruct(UnitTester $I)

tests/unit/Security/JWT/Token/Item/GetCest.php

@@ -19,6 +19,7 @@ class GetCest
     /**
      * Unit Tests Phalcon\Security\JWT\Token\Item :: get()
      *
+     * @author Phalcon Team <[email protected]>
      * @since  2019-12-22
      */
     public function securityJWTTokenItemGet(UnitTester $I)

tests/unit/Security/JWT/Token/Item/HasCest.php

@@ -19,6 +19,7 @@ class HasCest
     /**
      * Unit Tests Phalcon\Security\JWT\Token\Item :: has()
      *
+     * @author Phalcon Team <[email protected]>
      * @since  2019-12-22
      */
     public function securityJWTTokenItemHas(UnitTester $I)

tests/unit/Security/JWT/Token/Item/UnderscoreCallCest.php

@@ -19,6 +19,7 @@ class UnderscoreCallCest
     /**
      * Unit Tests Phalcon\Security\JWT\Token\Item :: __call()
      *
+     * @author Phalcon Team <[email protected]>
      * @since  2019-12-22
      */
     public function securityJWTTokenItemUnderscoreCall(UnitTester $I)