php-cache · Nyholm · Nov 9, 2016 · Jul 31, 2016 · Aug 1, 2016 · Aug 5, 2016
diff --git a/composer.json b/composer.json
@@ -29,6 +29,7 @@
         "symfony/options-resolver": "^2.7 || ^3.0"
     },
     "require-dev": {
+        "defuse/php-encryption":   "^2.0",
         "phpunit/phpunit":         "^4.0 || ^5.1",
         "mockery/mockery":         "^0.9",
         "cache/integration-tests": "^0.11",

diff --git a/src/Adapter/Common/CacheItem.php b/src/Adapter/Common/CacheItem.php
@@ -161,13 +161,19 @@ public function expiresAfter($time)
         return $this;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function getTags()
     {
         $this->initialize();
 
         return $this->tags;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function addTag($tag)
     {
         $this->initialize();
@@ -177,6 +183,9 @@ public function addTag($tag)
         return $this;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function setTags(array $tags)
     {
         $this->initialize();

diff --git a/src/Encryption/.github/PULL_REQUEST_TEMPLATE.md b/src/Encryption/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,5 @@
+This is a READ ONLY repository. 
+
+Please make your pull request to https://github.com/php-cache/cache
+
+Thank you for contributing. 
diff --git a/src/Encryption/.gitignore b/src/Encryption/.gitignore
@@ -0,0 +1,2 @@
+composer.lock
+vendor
diff --git a/src/Encryption/.travis.yml b/src/Encryption/.travis.yml
@@ -0,0 +1,22 @@
+language: php
+sudo: false
+
+matrix:
+    include:
+      - php: 7.0
+
+cache:
+    directories:
+      - "$HOME/.composer/cache"
+
+install:
+    - composer update
+
+script:
+    - ./vendor/bin/phpunit --coverage-clover=coverage.xml
+
+after_success:
+    - pip install --user codecov && codecov
+
+notifications:
+    email: false
diff --git a/src/Encryption/Changelog.md b/src/Encryption/Changelog.md
@@ -0,0 +1,7 @@
+# Change Log
+
+The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release. 
+
+## UNRELEASED
+
+
diff --git a/src/Encryption/EncryptedCachePool.php b/src/Encryption/EncryptedCachePool.php
@@ -0,0 +1,137 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015-2016 Aaron Scherer <aequasi@gmail.com>, Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+
+namespace Cache\Encryption;
+
+use Defuse\Crypto\Key;
+use Psr\Cache\CacheItemInterface;
+use Psr\Cache\CacheItemPoolInterface;
+
+/**
+ * Wrapps a CacheItemInterface with EncryptedItemDecorator.
+ *
+ * @author Daniel Bannert <d.bannert@anolilab.de>
+ */
+class EncryptedCachePool implements CacheItemPoolInterface
+{
+    /**
+     * @type CacheItemPoolInterface
+     */
+    private $cachePool;
+
+    /**
+     * @type Key
+     */
+    private $key;
+
+    /**
+     * @param CacheItemPoolInterface $cachePool
+     * @param Key                    $key
+     */
+    public function __construct(CacheItemPoolInterface $cachePool, Key $key)
+    {
+        $this->cachePool = $cachePool;
+        $this->key       = $key;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getItem($key)
+    {
+        $item = $this->cachePool->getItem($key);
+
+        if (!($item instanceof EncryptedItemDecorator)) {
+            return new EncryptedItemDecorator($item, $this->key);
+        }
+
+        return $item;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getItems(array $keys = [])
+    {
+        return array_map(function (CacheItemInterface $inner) {
+            if (!($inner instanceof EncryptedItemDecorator)) {
+                return new EncryptedItemDecorator($inner, $this->key);
+            }
+
+            return $inner;
+        }, $this->cachePool->getItems($keys));
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function hasItem($key)
+    {
+        return $this->cachePool->hasItem($key);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function clear()
+    {
+        return $this->cachePool->clear();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function deleteItem($key)
+    {
+        return $this->cachePool->deleteItem($key);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function deleteItems(array $keys)
+    {
+        return $this->cachePool->deleteItems($keys);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function save(CacheItemInterface $item)
+    {
+        if (!($item instanceof EncryptedItemDecorator)) {
+            $item = new EncryptedItemDecorator($item, $this->key);
+        }
+
+        return $this->cachePool->save($item);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function saveDeferred(CacheItemInterface $item)
+    {
+        if (!($item instanceof EncryptedItemDecorator)) {
+            $item = new EncryptedItemDecorator($item, $this->key);
+        }
+
+        return $this->cachePool->saveDeferred($item);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function commit()
+    {
+        return $this->cachePool->commit();
+    }
+}
diff --git a/src/Encryption/EncryptedItemDecorator.php b/src/Encryption/EncryptedItemDecorator.php
@@ -0,0 +1,179 @@
+<?php
+
+/*
+ * This file is part of php-cache organization.
+ *
+ * (c) 2015-2016 Aaron Scherer <aequasi@gmail.com>, Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+
+namespace Cache\Encryption;
+
+use Cache\Adapter\Common\HasExpirationDateInterface;
+use Cache\Taggable\TaggableItemInterface;
+use Defuse\Crypto\Crypto;
+use Defuse\Crypto\Key;
+use Psr\Cache\CacheItemInterface;
+
+/**
+ * Encrypt and Decrypt all the stored items.
+ *
+ * @author Daniel Bannert <d.bannert@anolilab.de>
+ */
+class EncryptedItemDecorator implements CacheItemInterface, HasExpirationDateInterface, TaggableItemInterface
+{
+    /**
+     * @type CacheItemInterface
+     */
+    private $cacheItem;
+
+    /**
+     * @type Key
+     */
+    private $key;
+
+    /**
+     * @param CacheItemInterface $cacheItem
+     * @param Key                $key
+     */
+    public function __construct(CacheItemInterface $cacheItem, Key $key)
+    {
+        $this->cacheItem = $cacheItem;
+        $this->key       = $key;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getKey()
+    {
+        return $this->cacheItem->getKey();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function set($value)
+    {
+        $type = gettype($value);
+
+        if ($type === 'object') {
+            $value = serialize($value);
+        }
+
+        $json = json_encode(['type' => $type, 'value' => $value]);
+
+        $this->cacheItem->set(Crypto::encrypt($json, $this->key));
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function get()
+    {
+        if (!$this->isHit()) {
+            return;
+        }
+
+        $item = json_decode(Crypto::decrypt($this->cacheItem->get(), $this->key), true);
+
+        return $this->transform($item);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isHit()
+    {
+        return $this->cacheItem->isHit();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getExpirationDate()
+    {
+        return $this->cacheItem->getExpirationDate();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function expiresAt($expiration)
+    {
+        $this->cacheItem->expiresAt($expiration);
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function expiresAfter($time)
+    {
+        $this->cacheItem->expiresAfter($time);
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTags()
+    {
+        return $this->cacheItem->getTags();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function addTag($tag)
+    {
+        $this->cacheItem->addTag($tag);
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function setTags(array $tags)
+    {
+        $this->cacheItem->setTags($tags);
+
+        return $this;
+    }
+
+    /**
+     * Creating a copy of the orginal CacheItemInterface object.
+     */
+    public function __clone()
+    {
+        $this->cacheItem = clone $this->cacheItem;
+    }
+
+    /**
+     * Transfrom value back to it orginal type.
+     *
+     * @param array $item
+     *
+     * @return mixed
+     */
+    private function transform(array $item)
+    {
+        if ($item['type'] === 'object') {
+            return unserialize($item['value']);
+        }
+
+        $value = $item['value'];
+
+        settype($value, $item['type']);
+
+        return $value;
+    }
+}