Merge pull request Strobotti#2 from Strobotti/formatting

Formatting code and other tweaks

Author: Strobotti

.gitignore

@@ -1,5 +1,8 @@
 .idea
+.DS_Store
 .phpunit.result.cache
 composer.lock
 vendor
 coverage.xml
+clover.xml
+.php_cs.cache

.php_cs.php

@@ -0,0 +1,18 @@
+<?php
+
+return \PhpCsFixer\Config::create()
+    ->setFinder(\PhpCsFixer\Finder::create()->in(__DIR__ . '/src'))
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PhpCsFixer' => true,
+        '@PhpCsFixer:risky' => true,
+        '@PHP71Migration' => true,
+        '@PHP71Migration:risky' => true,
+        '@DoctrineAnnotation' => true,
+        '@PHPUnit60Migration:risky' => true,
+        'native_function_invocation' => true,
+        'header_comment' => ['header' => ''],
+        'method_chaining_indentation' => false,
+        'php_unit_test_class_requires_covers' => false,
+    ])
+    ;

.travis.yml

@@ -3,8 +3,7 @@ language: php
 php:
   - 7.2
   - 7.3
-
-sudo: false
+  - 7.4
 
 before_script:
   - composer install

Makefile

@@ -0,0 +1,8 @@
+test-unit:
+	./vendor/bin/phpunit
+
+php-cs-fixer:
+	./vendor/bin/php-cs-fixer fix --show-progress dots --dry-run --config .php_cs.php
+
+php-cs-fixer-fix:
+	./vendor/bin/php-cs-fixer fix --show-progress dots --config .php_cs.php

README.md

@@ -1,5 +1,7 @@
 # php-jwk
 
+[![codecov](https://codecov.io/gh/Strobotti/php-jwk/branch/master/graph/badge.svg)](https://codecov.io/gh/Strobotti/php-jwk)
+
 A small PHP library to handle JWKs (Json Web Keys)
 
 This library helps to create json web key sets from PEM and is also able to pull out PEMs from json web key sets.
@@ -18,7 +20,7 @@ composer require strobotti/php-jwk
 
 ## Example usage
 
-See full example [here](blob/master/examples/full-flow.php).
+See full example [here](examples/full-flow.php).
 
 ### Create a key-object from PEM
 

composer.json

@@ -12,6 +12,8 @@
   "license": "MIT",
   "require": {
     "php": ">=7.2.0",
+    "ext-json": "*",
+    "ext-openssl": "*",
     "phpseclib/phpseclib": "^2.0"
   },
   "autoload": {
@@ -25,6 +27,7 @@
     }
   },
   "require-dev": {
-    "phpunit/phpunit": "^8.0"
+    "phpunit/phpunit": "^8.0",
+    "friendsofphp/php-cs-fixer": "^2.16"
   }
 }

src/Key/AbstractKey.php

@@ -5,10 +5,11 @@
 namespace Strobotti\JWK\Key;
 
 /**
- * @package Strobotti\JWK
  * @author  Juha Jantunen <[email protected]>
  * @license https://opensource.org/licenses/MIT MIT
- * @link    https://github.com/Strobotti/php-jwk
+ *
+ * @see    https://github.com/Strobotti/php-jwk
+ * @since 1.0.0
  */
 abstract class AbstractKey implements KeyInterface
 {
@@ -40,8 +41,20 @@ abstract class AbstractKey implements KeyInterface
      */
     private $alg;
 
+    /**
+     * @since 1.0.0
+     *
+     * @return false|string
+     */
+    public function __toString()
+    {
+        return \json_encode($this->jsonSerialize(), JSON_PRETTY_PRINT);
+    }
+
     /**
      * {@inheritdoc}
+     *
+     * @since 1.0.0
      */
     public function getKeyType(): string
     {
@@ -50,6 +63,8 @@ public function getKeyType(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @since 1.0.0
      */
     public function getKeyId(): string
     {
@@ -58,6 +73,8 @@ public function getKeyId(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @since 1.0.0
      */
     public function getPublicKeyUse(): string
     {
@@ -66,26 +83,18 @@ public function getPublicKeyUse(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @since 1.0.0
      */
     public function getAlgorithm(): string
     {
         return $this->alg;
     }
 
     /**
-     * @param string $kty
+     * Returns an array presentation of the key.
      *
-     * @return self
-     */
-    protected function setKeyType(string $kty): self
-    {
-        $this->kty = $kty;
-
-        return $this;
-    }
-
-    /**
-     * Returns an array presentation of the key
+     * @since 1.0.0
      *
      * @return array An assoc to be passed to json_encode
      */
@@ -105,10 +114,7 @@ public function jsonSerialize(): array
     }
 
     /**
-     * @param string            $json
-     * @param KeyInterface|null $prototype
-     *
-     * @return KeyInterface
+     * @since 1.0.0
      */
     public static function createFromJSON(string $json, KeyInterface $prototype = null): KeyInterface
     {
@@ -136,10 +142,12 @@ public static function createFromJSON(string $json, KeyInterface $prototype = nu
     }
 
     /**
-     * @return false|string
+     * @since 1.0.0
      */
-    public function __toString()
+    protected function setKeyType(string $kty): self
     {
-        return json_encode($this->jsonSerialize(), JSON_PRETTY_PRINT);
+        $this->kty = $kty;
+
+        return $this;
     }
 }

src/Key/KeyInterface.php

@@ -5,10 +5,11 @@
 namespace Strobotti\JWK\Key;
 
 /**
- * @package Strobotti\JWK
  * @author  Juha Jantunen <[email protected]>
  * @license https://opensource.org/licenses/MIT MIT
- * @link    https://github.com/Strobotti/php-jwk
+ *
+ * @see    https://github.com/Strobotti/php-jwk
+ * @since 1.0.0
  *
  * @method array jsonSerialize()
  */
@@ -24,35 +25,39 @@ interface KeyInterface extends \JsonSerializable
     public const ALGORITHM_RS256 = 'RS256';
 
     /**
-     * Gets the key type, ie. the value of the `kty` field
+     * Converts this key to a string.
+     *
+     * @since 1.0.0
      *
-     * @return string
+     * @return bool|string
+     */
+    public function __toString();
+
+    /**
+     * Gets the key type, ie. the value of the `kty` field.
+     *
+     * @since 1.0.0
      */
     public function getKeyType(): string;
 
     /**
-     * Gets the key id, ie. the value of the `kid` field
+     * Gets the key id, ie. the value of the `kid` field.
      *
-     * @return null|string
+     * @since 1.0.0
      */
     public function getKeyId(): ?string;
 
     /**
-     * Gets the public key use, ie. the value of the `use` field
+     * Gets the public key use, ie. the value of the `use` field.
      *
-     * @return string
+     * @since 1.0.0
      */
     public function getPublicKeyUse(): string;
 
     /**
-     * Gets the cryptographic algorithm used to sign the key, ie. the value of the `alg` field
+     * Gets the cryptographic algorithm used to sign the key, ie. the value of the `alg` field.
      *
-     * @return string
+     * @since 1.0.0
      */
     public function getAlgorithm(): string;
-
-    /**
-     * @return string|bool
-     */
-    public function __toString();
 }

src/Key/Rsa.php

@@ -5,10 +5,11 @@
 namespace Strobotti\JWK\Key;
 
 /**
- * @package Strobotti\JWK
  * @author  Juha Jantunen <[email protected]>
  * @license https://opensource.org/licenses/MIT MIT
- * @link    https://github.com/Strobotti/php-jwk
+ *
+ * @see    https://github.com/Strobotti/php-jwk
+ * @since 1.0.0
  */
 class Rsa extends AbstractKey
 {
@@ -37,7 +38,7 @@ public function __construct()
     /**
      * Returns the exponent for the RSA public key.
      *
-     * @return string
+     * @since 1.0.0
      */
     public function getExponent(): string
     {
@@ -47,7 +48,7 @@ public function getExponent(): string
     /**
      * Returns the modulus for the RSA public key.
      *
-     * @return string
+     * @since 1.0.0
      */
     public function getModulus(): string
     {
@@ -56,6 +57,8 @@ public function getModulus(): string
 
     /**
      * {@inheritdoc}
+     *
+     * @since 1.0.0
      */
     public function jsonSerialize(): array
     {
@@ -69,11 +72,13 @@ public function jsonSerialize(): array
     /**
      * {@inheritdoc}
      *
+     * @since 1.0.0
+     *
      * @return self
      */
     public static function createFromJSON(string $json, KeyInterface $prototype = null): KeyInterface
     {
-        if (!$prototype instanceof Rsa) {
+        if (!$prototype instanceof self) {
             $prototype = new static();
         }
 

src/KeyConverter.php

@@ -7,14 +7,16 @@
 use phpseclib\Crypt\RSA;
 use phpseclib\Math\BigInteger;
 use Strobotti\JWK\Key\KeyInterface;
+use Strobotti\JWK\Key\Rsa as RsaKey;
 use Strobotti\JWK\Util\Base64UrlConverter;
 use Strobotti\JWK\Util\Base64UrlConverterInterface;
 
 /**
- * @package Strobotti\JWK
  * @author  Juha Jantunen <[email protected]>
  * @license https://opensource.org/licenses/MIT MIT
- * @link    https://github.com/Strobotti/php-jwk
+ *
+ * @see    https://github.com/Strobotti/php-jwk
+ * @since 1.0.0
  */
 class KeyConverter
 {
@@ -32,18 +34,15 @@ public function __construct()
     }
 
     /**
-     * @param KeyInterface $key
-     *
-     * @return string
+     * @since 1.0.0
      */
     public function keyToPem(KeyInterface $key): string
     {
-        if (!$key instanceof \Strobotti\JWK\Key\Rsa) {
+        if (!$key instanceof RsaKey) {
             throw new \InvalidArgumentException();
         }
 
-        /** @var \Strobotti\JWK\Key\Rsa $key */
-
+        /** @var RsaKey $key */
         $rsa = new RSA();
 
         $modulus = $this->base64UrlConverter->decode($key->getModulus(), true);