sysPass/lib/SP/Core/Crypt/SecureKeyCookie.php

<?php
/**
 * sysPass
 *
 * @author    nuxsmin
 * @link      https://syspass.org
 * @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
 *
 * This file is part of sysPass.
 *
 * sysPass is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * sysPass is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 *  along with sysPass.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace SP\Core\Crypt;

use Defuse\Crypto\Exception\CryptoException;
use Defuse\Crypto\Key;
use SP\Http\Request;

/**
 * Class SecureKeyCookie
 *
 * @package SP\Core\Crypt
 */
final class SecureKeyCookie extends Cookie
{
    /**
     * Nombre de la cookie
     */
    const COOKIE_NAME = 'SYSPASS_SK';
    /**
     * Llave usada para encriptar los datos
     *
     * @var Key
     */
    private $securedKey;
    /**
     * @var string
     */
    private $cypher;

    /**
     * @param Request $request
     *
     * @return SecureKeyCookie
     */
    public static function factory(Request $request)
    {
        $self = new self(self::COOKIE_NAME, $request);
        $self->cypher = $self->getCypher();

        return $self;
    }

    /**
     * Devolver la llave de cifrado para los datos de la cookie
     *
     * @return string
     */
    public function getCypher()
    {
        return sha1($this->request->getHeader('User-Agent') . $this->request->getClientAddress());
    }

    /**
     * Obtener una llave de encriptación
     *
     * @return Key|false|string
     */
    public function getKey()
    {
        $cookie = $this->getCookie();

        if ($cookie !== false) {
            $data = $this->getCookieData($cookie, $this->cypher);

            if ($data !== false) {
                /** @var Vault $vault */
                $vault = unserialize($data, ['allowed_classes' => Vault::class]);

                if ($vault !== false
                    && ($vault instanceof Vault) === true
                ) {
                    try {
                        $this->securedKey = Key::loadFromAsciiSafeString($vault->getData($this->cypher));

                        return $this->securedKey;
                    } catch (CryptoException $e) {
                        logger($e->getMessage(), 'EXCEPTION');
                    }

                    return false;
                }
            } else {
                logger('Cookie verification error', 'ERROR');
            }
        } elseif (($this->securedKey instanceof Key) === true) {
            return $this->securedKey;
        }

        return $this->saveKey() ? $this->securedKey : false;
    }

    /**
     * Guardar una llave de encriptación
     *
     * @return Key|false
     */
    public function saveKey()
    {
        try {
            if ($this->setCookie($this->sign($this->generateSecuredData()->getSerialized(), $this->cypher)) === false) {
                logger('Could not generate session\'s key cookie', 'ERROR');

                unset($this->securedKey);

                return false;
            }

            logger('Generating a new session\'s key cookie');

            return true;
        } catch (CryptoException $e) {
            logger($e->getMessage(), 'EXCEPTION');
        }

        return false;
    }

    /**
     * @return Vault
     * @throws CryptoException
     * @throws \Defuse\Crypto\Exception\EnvironmentIsBrokenException
     */
    public function generateSecuredData()
    {
        $this->securedKey = Key::createNewRandomKey();

        return (new Vault())
            ->saveData($this->securedKey->saveToAsciiSafeString(), $this->cypher);
    }

    /**
     * @return Key
     */
    public function getSecuredKey()
    {
        return $this->securedKey;
    }
}