Merge pull request #1 from HawkBitPhp/feature/jwt

Remove core hashing and serialisation logic with more secure jwt

Author: mbunge

composer.json

@@ -17,7 +17,8 @@
     }
   ],
   "require": {
-    "php": ">=7.0"
+    "php": ">=7.0",
+    "firebase/php-jwt": "~5.0"
   },
   "require-dev": {
     "phpunit/phpunit": "~6.0"

src/AbstractDataStream.php

@@ -11,34 +11,44 @@ abstract class AbstractDataStream implements DataStream
      */
     private $raw;
 
-    /**
-     * @var \Hawkbit\DataStream\Hasher|null
-     */
-    private $hasher;
     /**
      * @var \Hawkbit\DataStream\Compressor|null
      */
     private $compressor;
+
+    /**
+     * @var mixed
+     */
+    private $data;
     /**
-     * @var \Hawkbit\DataStream\Serializer|null
+     * @var \Hawkbit\DataStream\JwtConfig|null
      */
-    private $serializer;
+    private $jwtConfig;
 
     /**
      * DataStream constructor.
      *
      * @param $data
-     * @param \Hawkbit\DataStream\Serializer|null $serializer
-     * @param \Hawkbit\DataStream\Hasher|null $hasher
+     * @param \Hawkbit\DataStream\JwtConfig|null $jwtConfig
      * @param \Hawkbit\DataStream\Compressor|null $compressor
      */
-    public function __construct($data, Serializer $serializer = null, Hasher $hasher = null, Compressor $compressor =
-    null)
+    public function __construct($data, JwtConfig $jwtConfig = null,  Compressor $compressor = null)
     {
         $this->raw = $data;
-        $this->hasher = $hasher ?? new Adler32Hasher();
         $this->compressor = $compressor ?? new DeflateCompressor();
-        $this->serializer = $serializer ?? new JsonSerializer();
+        $this->jwtConfig = $jwtConfig ?? new JwtConfig();
+        $this->data = $this->decorateData($data);
+    }
+
+    /**
+     * Decorate input data to desired result
+     *
+     * @param $data
+     *
+     * @return mixed
+     */
+    protected function decorateData($data){
+        return $data;
     }
 
     /**
@@ -50,11 +60,11 @@ public function getRaw()
     }
 
     /**
-     * @return \Hawkbit\DataStream\Hasher|null
+     * @return mixed
      */
-    public function getHasher()
+    public function getData()
     {
-        return $this->hasher;
+        return $this->data;
     }
 
     /**
@@ -66,18 +76,10 @@ public function getCompressor()
     }
 
     /**
-     * @return \Hawkbit\DataStream\Serializer|null
-     */
-    public function getSerializer()
-    {
-        return $this->serializer;
-    }
-
-    /**
-     * @return string
+     * @return \Hawkbit\DataStream\JwtConfig|null
      */
-    public function __toString(): string
+    public function getJwtConfig()
     {
-        return $this->getData();
+        return $this->jwtConfig;
     }
 }

src/Adler32Hasher.php

@@ -4,6 +4,8 @@
 namespace Hawkbit\DataStream;
 
 
+use Firebase\JWT\JWT;
+
 interface DataStream
 {
 
@@ -15,12 +17,10 @@ interface DataStream
      * DataStream constructor.
      *
      * @param $data
-     * @param \Hawkbit\DataStream\Serializer|null $serializer
-     * @param \Hawkbit\DataStream\Hasher|null $hasher
+     * @param \Hawkbit\DataStream\JwtConfig|null $jwtConfig
      * @param \Hawkbit\DataStream\Compressor|null $compressor
      */
-    public function __construct($data, Serializer $serializer = null, Hasher $hasher = null, Compressor $compressor =
-    null);
+    public function __construct($data, JwtConfig $jwtConfig = null, Compressor $compressor = null);
 
     /**
      * get raw data
@@ -36,24 +36,5 @@ public function getRaw();
      */
     public function getData();
 
-    /**
-     * Get MD5 Hash fingerprint
-     *
-     * @return string
-     */
-    public function getFingerprint(): string;
-
-    /**
-     * Get expiration for data
-     *
-     * @return int
-     */
-    public function getExpirationTime(): int;
-
-    /**
-     * @return string
-     */
-    public function __toString(): string;
-
 
 }

src/DataStream.php

@@ -4,95 +4,37 @@
 namespace Hawkbit\DataStream;
 
 
+use Firebase\JWT\JWT;
+
 class InputStream extends AbstractDataStream implements DataStream
 {
 
     /**
-     * @var string
-     */
-    private $fingerPrint;
-
-    /**
-     * @var int
-     */
-    private $expirationTime;
-
-    /**
-     * @var mixed
-     */
-    private $data;
-
-    /**
-     * DataStream constructor.
+     * Load data from compressed jwt
      *
      * @param $data
-     * @param \Hawkbit\DataStream\Serializer|null $serializer
-     * @param \Hawkbit\DataStream\Hasher|null $hasher
-     * @param \Hawkbit\DataStream\Compressor|null $compressor
-     */
-    public function __construct($data, Serializer $serializer = null, Hasher $hasher = null, Compressor $compressor = null)
-    {
-        parent::__construct($data, $serializer, $hasher, $compressor);
-        $this->data = $this->parse();
-    }
-
-
-    /**
-     * Get converted data
      *
      * @return mixed
      */
-    public function getData()
+    protected function decorateData($data)
     {
-        return $this->data;
-    }
-
-    /**
-     * Get MD5 Hash fingerprint
-     *
-     * @return string
-     */
-    public function getFingerprint(): string
-    {
-        return $this->fingerPrint;
-    }
-
-    /**
-     * Get expiration for data
-     *
-     * @return int
-     */
-    public function getExpirationTime(): int
-    {
-        return $this->expirationTime;
-    }
-
-    private function parse()
-    {
-
-        // hex data
-        $stream = base64_decode($this->getRaw());
-
-        // get binary representation
-        $bin = @$this->getCompressor()->uncompress($stream);
 
-        $data = explode(DataStream::MESSAGE_ESCAPE_STRING, $bin, 3);
+        // load jwt config
+        $config = $this->getJwtConfig();
 
-        $this->fingerPrint = $data[0];
-        $this->expirationTime = (int)$data[1];
-        $payload = $data[2];
+        // compressed jwt
+        $compressed = base64_decode($data);
 
-        if ($this->getHasher()->hash($payload) !== $this->getFingerprint())
-        {
-            throw new \RuntimeException('Data are not equal!');
-        }
+        // get inflated jwt
+        $jwt = $this->getCompressor()->uncompress($compressed);
+        $secret = $config->getSecret();
+        $alg = $config->getAlg();
 
-        if (time() > $this->getExpirationTime())
-        {
-            throw new \RuntimeException('Data transfer expired!');
-        }
+        // decode data
+        $payload = JWT::decode($jwt, $secret, [$alg]);
 
-        // transform to json
-        return $this->getSerializer()->unserialize($payload);
+        // return payload data
+        // workaround to get always assoc arrays instead of objects
+        return json_decode(json_encode($payload->data), true);
     }
 }