Custom encryption key when using ConfigKey

cakephp · Apr 26, 2016 · 6751ae7 · 6751ae7
1 parent 21012cc
commit 6751ae7
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 8 deletions.
diff --git a/src/Controller/Component/CookieComponent.php b/src/Controller/Component/CookieComponent.php
@@ -252,7 +252,7 @@ protected function _load($key)
         $cookie = $this->request->cookies[$first];
         $config = $this->configKey($first);
         $this->_loaded[$first] = true;
-        $this->_values[$first] = $this->_decrypt($cookie, $config['encryption']);
+        $this->_values[$first] = $this->_decrypt($cookie, $config['encryption'], $config['key']);
     }
 
     /**
@@ -310,7 +310,7 @@ protected function _write($name, $value)
 
         $this->_response->cookie([
             'name' => $name,
-            'value' => $this->_encrypt($value, $config['encryption']),
+            'value' => $this->_encrypt($value, $config['encryption'], $config['key']),
             'expire' => $expires->format('U'),
             'path' => $config['path'],
             'domain' => $config['domain'],

diff --git a/src/Utility/CookieCryptTrait.php b/src/Utility/CookieCryptTrait.php
@@ -97,15 +97,15 @@ protected function _checkCipher($encrypt)
      * @param string|bool $mode Encryption mode
      * @return string decrypted string
      */
-    protected function _decrypt($values, $mode)
+    protected function _decrypt($values, $mode, $key = null)
     {
         if (is_string($values)) {
-            return $this->_decode($values, $mode);
+            return $this->_decode($values, $mode, $key);
         }
 
         $decrypted = [];
         foreach ($values as $name => $value) {
-            $decrypted[$name] = $this->_decode($value, $mode);
+            $decrypted[$name] = $this->_decode($value, $mode, $key);
         }
         return $decrypted;
     }
@@ -117,19 +117,22 @@ protected function _decrypt($values, $mode)
      * @param string|false $encrypt The encryption cipher to use.
      * @return string Decoded value.
      */
-    protected function _decode($value, $encrypt)
+    protected function _decode($value, $encrypt, $key)
     {
         if (!$encrypt) {
             return $this->_explode($value);
         }
         $this->_checkCipher($encrypt);
         $prefix = 'Q2FrZQ==.';
         $value = base64_decode(substr($value, strlen($prefix)));
+        if (!isset($key)) {
+            $key = $this->_getCookieEncryptionKey();
+        }
         if ($encrypt === 'rijndael') {
-            $value = Security::rijndael($value, $this->_getCookieEncryptionKey(), 'decrypt');
+            $value = Security::rijndael($value, $key, 'decrypt');
         }
         if ($encrypt === 'aes') {
-            $value = Security::decrypt($value, $this->_getCookieEncryptionKey());
+            $value = Security::decrypt($value, $key);
         }
         return $this->_explode($value);
     }

diff --git a/tests/TestCase/Controller/Component/CookieComponentTest.php b/tests/TestCase/Controller/Component/CookieComponentTest.php
@@ -362,6 +362,45 @@ public function testWriteMulitMixedEncryption()
         $this->assertContains('Q2FrZQ==.', $result['value']);
     }
 
+    /**
+     * Test writing with a custom encryption key using ConfigKey
+     *
+     * @return void
+     */
+    public function testWriteConfigKeyWithCustomEncryptionKey()
+    {
+        $name = 'sampleCookieTest';
+        $value = 'some data';
+        $encryption = 'aes';
+        $prefix = "Q2FrZQ==.";
+        $key = 'justanotherencryptionkeyjustanotherencryptionkey';
+
+        $this->Cookie->configKey($name, compact('key', 'encryption'));
+        $this->Cookie->write($name, $value);
+
+        $cookie = $this->Controller->response->cookie($name);
+
+        $this->assertEquals($value, Security::decrypt(base64_decode(substr($cookie['value'], strlen($prefix))), $key));
+    }
+
+    /**
+     * Test reading with a custom encryption key using ConfigKey
+     *
+     * @return void
+     */
+    public function testReadConfigKeyWithCustomEncryptionKey()
+    {
+        $name = 'sampleCookieTest';
+        $value = 'some data';
+        $encryption = 'aes';
+        $key = 'justanotherencryptionkeyjustanotherencryptionkey';
+
+        $this->Cookie->configKey($name, compact('key', 'encryption'));
+        $this->Cookie->write($name, $value);
+
+        $this->assertEquals('some data', $this->Cookie->read($name));
+    }
+
     /**
      * test delete with httpOnly
      *