max_age parameter marked as deprecated + CS fix

Spomky · Spomky · commit 2bb295665857 · 2018-08-21T14:56:58.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.phpunit.result.cache
 .travis/phar-private.pem
 jose.phar
 jose.phar.pubkey
diff --git a/src/Bundle/JoseFramework/DependencyInjection/Configuration.php b/src/Bundle/JoseFramework/DependencyInjection/Configuration.php
@@ -44,6 +44,7 @@ public function getConfigTreeBuilder()
     {
         $treeBuilder = new TreeBuilder();
         $rootNode = $treeBuilder->root($this->alias);
+        $rootNode->setDeprecated('The child node "%node%" at path "%path%" is deprecated and will be removed on v2.x. It has no effect anymore. Please refer to https://github.com/symfony/symfony/pull/25699');
 
         foreach ($this->sources as $source) {
             $source->getNodeDefinition($rootNode);
diff --git a/src/Bundle/JoseFramework/DependencyInjection/Source/KeyManagement/JWKUriSource.php b/src/Bundle/JoseFramework/DependencyInjection/Source/KeyManagement/JWKUriSource.php
@@ -66,6 +66,7 @@ public function getNodeDefinition(NodeDefinition $node)
             ->integerNode('max_age')
             ->info('When share, this value indicates how many seconds the HTTP client should keep the key in cache. Default is 21600 = 6 hours.')
             ->defaultValue(21600)
+            ->setDeprecated()
             ->end()
             ->arrayNode('tags')
             ->info('A list of tags to be associated to the service.')
diff --git a/src/Bundle/JoseFramework/Tests/TestBundle/DependencyInjection/TestExtension.php b/src/Bundle/JoseFramework/Tests/TestBundle/DependencyInjection/TestExtension.php
@@ -44,7 +44,6 @@ public function prepend(ContainerBuilder $container)
         ConfigurationHelper::addKeyUri($container, 'jwkset2', [
             'id' => 'jose.key_set.jwkset2',
             'path' => '/2.jwkset',
-            'max_age' => 3600,
         ]);
         ConfigurationHelper::addClaimChecker($container, 'checker2', ['exp', 'iat', 'nbf', 'custom_checker'], true);
         ConfigurationHelper::addHeaderChecker($container, 'checker2', ['custom_checker'], true);
diff --git a/src/Bundle/JoseFramework/Tests/config/config_test.yml b/src/Bundle/JoseFramework/Tests/config/config_test.yml
@@ -161,7 +161,6 @@ jose:
         jwkset1:
             id: 'jose.key_set.jwkset1'
             path: '/1.jwkset'
-            max_age: 100
 
 httplug:
     profiling: false
diff --git a/src/Component/Checker/Tests/Stub/OtherToken.php b/src/Component/Checker/Tests/Stub/OtherToken.php
@@ -34,8 +34,6 @@ class OtherToken implements JWT
 
     /**
      * Token constructor.
-     *
-     * @param null|string $payload
      */
     private function __construct(?string $payload, array $protectedHeader, array $unprotectedHeader)
     {
@@ -44,9 +42,6 @@ private function __construct(?string $payload, array $protectedHeader, array $un
         $this->unprotectedHeader = $unprotectedHeader;
     }
 
-    /**
-     * @param null|string $payload
-     */
     public static function create(?string $payload, array $protectedHeader = [], array $unprotectedHeader = []): self
     {
         return new self($payload, $protectedHeader, $unprotectedHeader);
diff --git a/src/Component/Checker/Tests/Stub/Token.php b/src/Component/Checker/Tests/Stub/Token.php
@@ -34,8 +34,6 @@ class Token implements JWT
 
     /**
      * Token constructor.
-     *
-     * @param null|string $payload
      */
     private function __construct(?string $payload, array $protectedHeader, array $unprotectedHeader)
     {
@@ -45,8 +43,6 @@ private function __construct(?string $payload, array $protectedHeader, array $un
     }
 
     /**
-     * @param null|string $payload
-     *
      * @return Token
      */
     public static function create(?string $payload, array $protectedHeader = [], array $unprotectedHeader = []): self
diff --git a/src/Component/Console/JKULoaderCommand.php b/src/Component/Console/JKULoaderCommand.php
@@ -28,8 +28,6 @@ final class JKULoaderCommand extends ObjectOutputCommand
 
     /**
      * JKULoaderCommand constructor.
-     *
-     * @param null|string $name
      */
     public function __construct(JKUFactory $jkuFactory, JsonConverter $jsonConverter, ?string $name = null)
     {
diff --git a/src/Component/Console/X5ULoaderCommand.php b/src/Component/Console/X5ULoaderCommand.php
@@ -28,8 +28,6 @@ final class X5ULoaderCommand extends ObjectOutputCommand
 
     /**
      * X5ULoaderCommand constructor.
-     *
-     * @param null|string $name
      */
     public function __construct(X5UFactory $x5uFactory, JsonConverter $jsonConverter, ?string $name = null)
     {
diff --git a/src/Component/Core/JWKSet.php b/src/Component/Core/JWKSet.php
@@ -245,8 +245,6 @@ private function canKeyBeUsedFor(string $type, JWK $key)
     }
 
     /**
-     * @param null|Algorithm $algorithm
-     *
      * @return bool|int
      */
     private function canKeyBeUsedWithAlgorithm(?Algorithm $algorithm, JWK $key)
diff --git a/src/Component/Encryption/JWE.php b/src/Component/Encryption/JWE.php
@@ -64,9 +64,6 @@ class JWE implements JWT
 
     /**
      * JWE constructor.
-     *
-     * @param null|string $aad
-     * @param null|string $encodedSharedProtectedHeader
      */
     private function __construct(string $ciphertext, string $iv, string $tag, ?string $aad = null, array $sharedHeader = [], array $sharedProtectedHeader = [], ?string $encodedSharedProtectedHeader = null, array $recipients = [])
     {
@@ -83,9 +80,6 @@ private function __construct(string $ciphertext, string $iv, string $tag, ?strin
     /**
      * Creates a new JWE object.
      *
-     * @param null|string $aad
-     * @param null|string $encodedSharedProtectedHeader
-     *
      * @return JWE
      */
     public static function create(string $ciphertext, string $iv, string $tag, ?string $aad = null, array $sharedHeader = [], array $sharedProtectedHeader = [], ?string $encodedSharedProtectedHeader = null, array $recipients = []): self
diff --git a/src/Component/Encryption/JWEDecrypter.php b/src/Component/Encryption/JWEDecrypter.php
@@ -167,9 +167,6 @@ private function checkJWKSet(JWKSet $jwkset)
         }
     }
 
-    /**
-     * @return null|string
-     */
     private function decryptCEK(Algorithm $key_encryption_algorithm, ContentEncryptionAlgorithm $content_encryption_algorithm, JWK $key, Recipient $recipient, array $completeHeader): ?string
     {
         if ($key_encryption_algorithm instanceof DirectEncryption) {
diff --git a/src/Component/Encryption/JWELoader.php b/src/Component/Encryption/JWELoader.php
@@ -73,8 +73,6 @@ public function getSerializerManager(): JWESerializerManager
      * This method will try to load and decrypt the given token using a JWK.
      * If succeeded, the methods will populate the $recipient variable and returns the JWE.
      *
-     * @param null|int $recipient
-     *
      * @throws \Exception
      */
     public function loadAndDecryptWithKey(string $token, JWK $key, ?int &$recipient): JWE
@@ -88,8 +86,6 @@ public function loadAndDecryptWithKey(string $token, JWK $key, ?int &$recipient)
      * This method will try to load and decrypt the given token using a JWKSet.
      * If succeeded, the methods will populate the $recipient variable and returns the JWE.
      *
-     * @param null|int $recipient
-     *
      * @throws \Exception
      */
     public function loadAndDecryptWithKeySet(string $token, JWKSet $keyset, ?int &$recipient): JWE
diff --git a/src/Component/Encryption/Recipient.php b/src/Component/Encryption/Recipient.php
@@ -30,8 +30,6 @@ class Recipient
 
     /**
      * Recipient constructor.
-     *
-     * @param null|string $encryptedKey
      */
     private function __construct(array $header, ?string $encryptedKey)
     {
@@ -43,8 +41,6 @@ private function __construct(array $header, ?string $encryptedKey)
      * Creates a recipient.
      * The creation of this object is meant to be used by the library, not by third party applications.
      *
-     * @param null|string $encryptedKey
-     *
      * @return Recipient
      */
     public static function create(array $header, ?string $encryptedKey): self
@@ -88,8 +84,6 @@ public function hasHeaderParameter(string $key): bool
 
     /**
      * Returns the encrypted key.
-     *
-     * @return null|string
      */
     public function getEncryptedKey(): ?string
     {
diff --git a/src/Component/Encryption/Util/RSACrypt.php b/src/Component/Encryption/Util/RSACrypt.php
@@ -32,9 +32,6 @@ class RSACrypt
      */
     public const ENCRYPTION_PKCS1 = 2;
 
-    /**
-     * @param null|string $hash
-     */
     public static function encrypt(RSAKey $key, string $data, int $mode, ?string $hash = null): string
     {
         switch ($mode) {
@@ -47,9 +44,6 @@ public static function encrypt(RSAKey $key, string $data, int $mode, ?string $ha
         }
     }
 
-    /**
-     * @param null|string $hash
-     */
     public static function decrypt(RSAKey $key, string $plaintext, int $mode, ?string $hash = null): string
     {
         switch ($mode) {
diff --git a/src/Component/KeyManagement/JWKFactory.php b/src/Component/KeyManagement/JWKFactory.php
@@ -288,8 +288,6 @@ public static function createFromKeySet(JWKSet $jwkset, $index): JWK
     /**
      * This method will try to load a PKCS#12 file and convert it into a public key.
      *
-     * @param null|string $secret
-     *
      * @throws \Exception
      */
     public static function createFromPKCS12CertificateFile(string $file, ?string $secret = '', array $additional_values = []): JWK
@@ -332,8 +330,6 @@ public static function createFromX509Resource($res, array $additional_values = [
      * This method will try to load and convert a key file into a JWK object.
      * If the key is encrypted, the password must be set.
      *
-     * @param null|string $password
-     *
      * @throws \Exception
      */
     public static function createFromKeyFile(string $file, ?string $password = null, array $additional_values = []): JWK
@@ -348,8 +344,6 @@ public static function createFromKeyFile(string $file, ?string $password = null,
      * This method will try to load and convert a key into a JWK object.
      * If the key is encrypted, the password must be set.
      *
-     * @param null|string $password
-     *
      * @throws \Exception
      */
     public static function createFromKey(string $key, ?string $password = null, array $additional_values = []): JWK
diff --git a/src/Component/KeyManagement/KeyConverter/KeyConverter.php b/src/Component/KeyManagement/KeyConverter/KeyConverter.php
@@ -82,8 +82,6 @@ public static function loadKeyFromX509Resource($res): array
     }
 
     /**
-     * @param null|string $password
-     *
      * @throws \Exception
      */
     public static function loadFromKeyFile(string $file, ?string $password = null): array
@@ -94,8 +92,6 @@ public static function loadFromKeyFile(string $file, ?string $password = null):
     }
 
     /**
-     * @param null|string $password
-     *
      * @throws \Exception
      */
     public static function loadFromKey(string $key, ?string $password = null): array
@@ -108,8 +104,6 @@ public static function loadFromKey(string $key, ?string $password = null): array
     }
 
     /**
-     * @param null|string $password
-     *
      * @throws \Exception
      */
     private static function loadKeyFromDER(string $der, ?string $password = null): array
@@ -120,8 +114,6 @@ private static function loadKeyFromDER(string $der, ?string $password = null): a
     }
 
     /**
-     * @param null|string $password
-     *
      * @throws \Exception
      */
     private static function loadKeyFromPEM(string $pem, ?string $password = null): array
@@ -220,8 +212,7 @@ public static function loadFromX5C(array $x5c): array
     }
 
     /**
-     * @param string[]    $matches
-     * @param null|string $password
+     * @param string[] $matches
      */
     private static function decodePem(string $pem, array $matches, ?string $password = null): string
     {
diff --git a/src/Component/Signature/JWSLoader.php b/src/Component/Signature/JWSLoader.php
@@ -73,9 +73,6 @@ public function getSerializerManager(): JWSSerializerManager
      * This method will try to load and verify the token using the given key.
      * It returns a JWS and will populate the $signature variable in case of success, otherwise an exception is thrown.
      *
-     * @param null|int    $signature
-     * @param null|string $payload
-     *
      * @throws \Exception
      */
     public function loadAndVerifyWithKey(string $token, JWK $key, ?int &$signature, ?string $payload = null): JWS
@@ -89,9 +86,6 @@ public function loadAndVerifyWithKey(string $token, JWK $key, ?int &$signature,
      * This method will try to load and verify the token using the given key set.
      * It returns a JWS and will populate the $signature variable in case of success, otherwise an exception is thrown.
      *
-     * @param null|int    $signature
-     * @param null|string $payload
-     *
      * @throws \Exception
      */
     public function loadAndVerifyWithKeySet(string $token, JWKSet $keyset, ?int &$signature, ?string $payload = null): JWS
@@ -113,9 +107,6 @@ public function loadAndVerifyWithKeySet(string $token, JWKSet $keyset, ?int &$si
         throw new \Exception('Unable to load and verify the token.');
     }
 
-    /**
-     * @param null|string $payload
-     */
     private function processSignature(JWS $jws, JWKSet $keyset, int $signature, ?string $payload): bool
     {
         try {
diff --git a/src/Component/Signature/JWSVerifier.php b/src/Component/Signature/JWSVerifier.php
@@ -47,8 +47,6 @@ public function getSignatureAlgorithmManager(): AlgorithmManager
      * This method will try to verify the JWS object using the given key and for the given signature.
      * It returns true if the signature is verified, otherwise false.
      *
-     * @param null|string $detachedPayload
-     *
      * @return bool true if the verification of the signature succeeded, else false
      */
     public function verifyWithKey(JWS $jws, JWK $jwk, int $signature, ?string $detachedPayload = null): bool
@@ -79,9 +77,6 @@ public function verifyWithKeySet(JWS $jws, JWKSet $jwkset, int $signature, ?stri
         return $this->verifySignature($jws, $jwkset, $signature, $detachedPayload);
     }
 
-    /**
-     * @param null|string $detachedPayload
-     */
     private function verifySignature(JWS $jws, JWKSet $jwkset, Signature $signature, ?string $detachedPayload = null): bool
     {
         $input = $this->getInputToVerify($jws, $signature, $detachedPayload);
@@ -138,9 +133,6 @@ private function checkJWKSet(JWKSet $jwkset)
         }
     }
 
-    /**
-     * @param null|string $detachedPayload
-     */
     private function checkPayload(JWS $jws, ?string $detachedPayload = null)
     {
         if (null !== $detachedPayload && !empty($jws->getPayload())) {
diff --git a/src/Component/Signature/Serializer/JSONGeneralSerializer.php b/src/Component/Signature/Serializer/JSONGeneralSerializer.php
@@ -145,11 +145,6 @@ private function processHeaders(array $signature): array
         return [$encodedProtectedHeader, $protectedHeader, $header];
     }
 
-    /**
-     * @param null|string $rawPayload
-     *
-     * @return null|string
-     */
     private function processPayload(?string $rawPayload, ?bool $isPayloadEncoded): ?string
     {
         if (null === $rawPayload) {
diff --git a/src/Component/Signature/Signature.php b/src/Component/Signature/Signature.php
@@ -37,8 +37,6 @@ class Signature
 
     /**
      * Signature constructor.
-     *
-     * @param null|string $encodedProtectedHeader
      */
     private function __construct(string $signature, array $protectedHeader, ?string $encodedProtectedHeader, array $header)
     {
@@ -78,8 +76,6 @@ public function getHeader(): array
 
     /**
      * The protected header associated with the signature.
-     *
-     * @return null|string
      */
     public function getEncodedProtectedHeader(): ?string
     {
diff --git a/src/Component/Signature/Tests/ForeignJWTTest.php b/src/Component/Signature/Tests/ForeignJWTTest.php
@@ -26,6 +26,7 @@ class ForeignJWTTest extends SignatureTest
      * The following test uses an assertion created with another library.
      * This assertion is valid if verified with the JWK.
      */
+
     /**
      * @test
      */
diff --git a/src/EncryptionAlgorithm/ContentEncryption/AESCBC/AESCBCHS.php b/src/EncryptionAlgorithm/ContentEncryption/AESCBC/AESCBCHS.php
@@ -50,9 +50,6 @@ public function decryptContent(string $data, string $cek, string $iv, ?string $a
         return $plaintext;
     }
 
-    /**
-     * @param null|string $aad
-     */
     protected function calculateAuthenticationTag(string $encrypted_data, string $cek, string $iv, ?string $aad, string $encoded_header): string
     {
         $calculated_aad = $encoded_header;
diff --git a/src/EncryptionAlgorithm/KeyEncryption/RSA/RSA.php b/src/EncryptionAlgorithm/KeyEncryption/RSA/RSA.php
@@ -57,8 +57,5 @@ protected function checkKey(JWK $key)
 
     abstract protected function getEncryptionMode(): int;
 
-    /**
-     * @return null|string
-     */
     abstract protected function getHashAlgorithm(): ?string;
 }

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+.phpunit.result.cache`
`1`	`2`	`.travis/phar-private.pem`
`2`	`3`	`jose.phar`
`3`	`4`	`jose.phar.pubkey`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ public function getConfigTreeBuilder()`
`44`	`44`	`{`
`45`	`45`	`$treeBuilder = new TreeBuilder();`
`46`	`46`	`$rootNode = $treeBuilder->root($this->alias);`
	`47`	`+ $rootNode->setDeprecated('The child node "%node%" at path "%path%" is deprecated and will be removed on v2.x. It has no effect anymore. Please refer to https://github.com/symfony/symfony/pull/25699');`
`47`	`48`
`48`	`49`	`foreach ($this->sources as $source) {`
`49`	`50`	`$source->getNodeDefinition($rootNode);`
Original file line number	Diff line number	Diff line change
`@@ -34,8 +34,6 @@ class OtherToken implements JWT`
`34`	`34`
`35`	`35`	`/**`
`36`	`36`	`* Token constructor.`
`37`		`- *`
`38`		`- * @param null\|string $payload`
`39`	`37`	`*/`
`40`	`38`	`private function __construct(?string $payload, array $protectedHeader, array $unprotectedHeader)`
`41`	`39`	`{`
`@@ -44,9 +42,6 @@ private function __construct(?string $payload, array $protectedHeader, array $un`
`44`	`42`	`$this->unprotectedHeader = $unprotectedHeader;`
`45`	`43`	`}`
`46`	`44`
`47`		`- /**`
`48`		`- * @param null\|string $payload`
`49`		`- */`
`50`	`45`	`public static function create(?string $payload, array $protectedHeader = [], array $unprotectedHeader = []): self`
`51`	`46`	`{`
`52`	`47`	`return new self($payload, $protectedHeader, $unprotectedHeader);`
Original file line number	Diff line number	Diff line change
`@@ -28,8 +28,6 @@ final class JKULoaderCommand extends ObjectOutputCommand`
`28`	`28`
`29`	`29`	`/**`
`30`	`30`	`* JKULoaderCommand constructor.`
`31`		`- *`
`32`		`- * @param null\|string $name`
`33`	`31`	`*/`
`34`	`32`	`public function __construct(JKUFactory $jkuFactory, JsonConverter $jsonConverter, ?string $name = null)`
`35`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,8 +28,6 @@ final class X5ULoaderCommand extends ObjectOutputCommand`
`28`	`28`
`29`	`29`	`/**`
`30`	`30`	`* X5ULoaderCommand constructor.`
`31`		`- *`
`32`		`- * @param null\|string $name`
`33`	`31`	`*/`
`34`	`32`	`public function __construct(X5UFactory $x5uFactory, JsonConverter $jsonConverter, ?string $name = null)`
`35`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -245,8 +245,6 @@ private function canKeyBeUsedFor(string $type, JWK $key)`
`245`	`245`	`}`
`246`	`246`
`247`	`247`	`/**`
`248`		`- * @param null\|Algorithm $algorithm`
`249`		`- *`
`250`	`248`	`* @return bool\|int`
`251`	`249`	`*/`
`252`	`250`	`private function canKeyBeUsedWithAlgorithm(?Algorithm $algorithm, JWK $key)`