CookieJar.php

Go to the documentation of this file.

<?php
class Slim_Http_CookieJar {
 
    protected $_secret = '';
 
    protected $_algorithm = MCRYPT_RIJNDAEL_256;
 
    protected $_mode = MCRYPT_MODE_CBC;
 
    protected $_cryptModule = null;
 
    protected $_highConfidentiality = true;
 
    protected $_ssl = false;
 
    protected $_cookies = array();
 
    public function __construct( $secret, $config = null ) {
        if ( empty($secret) ) {
            throw new Exception('You must provide a secret key');
        }
        $this->_secret = $secret;
        if ( $config !== null && !is_array($config) ) {
            throw new Exception('Config must be an array');
        }
        if ( is_array($config) ) {
            if ( isset($config['high_confidentiality']) ) {
                $this->_highConfidentiality = $config['high_confidentiality'];
            }
            if ( isset($config['mcrypt_algorithm']) ) {
                $this->_algorithm = $config['mcrypt_algorithm'];
            }
            if ( isset($config['mcrypt_mode']) ) {
                $this->_mode = $config['mcrypt_mode'];
            }
            if ( isset($config['enable_ssl']) ) {
                $this->_ssl = $config['enable_ssl'];
            }
        }
        if ( extension_loaded('mcrypt') ) {
            $this->_cryptModule = mcrypt_module_open($this->_algorithm, '', $this->_mode, '');
            if ( $this->_cryptModule === false ) {
                throw new Exception('Error while loading mcrypt module');
            }
        }
    }
 
    public function getHighConfidentiality() {
        return $this->_highConfidentiality;
    }
 
    public function setHighConfidentiality( $enable ) {
        $this->_highConfidentiality = (bool)$enable;
        return $this;
    }
 
    public function getSSL() {
        return $this->_ssl;
    }
 
    public function setSSL( $enable ) {
        $this->_ssl = (bool)$enable;
        return $this;
    }
 
    public function getResponseCookies() {
        return $this->_cookies;
    }
 
    public function getResponseCookie( $cookiename ) {
        return isset($this->_cookies[$cookiename]) ? $this->_cookies[$cookiename] : null;
    }
 
    public function setCookie( $cookiename, $value, $username, $expire = 0, $path = '/', $domain = '', $secure = false, $httponly = null ) {
        $secureValue = extension_loaded('mcrypt') ? $this->_secureCookieValue($value, $username, $expire) : $value;
        $this->setClassicCookie($cookiename, $secureValue, $expire, $path, $domain, $secure, $httponly);
    }
 
    public function deleteCookie( $name, $path = '/', $domain = '', $secure = false, $httponly = null ) {
        $expire = 315554400; /* 1980-01-01 */
        $this->_cookies[$name] = new Slim_Http_Cookie($name, '', $expire, $path, $domain, $secure, $httponly);
        //setcookie($name, '', $expire, $path, $domain, $secure, $httponly);
    }
 
    public function getCookieValue( $cookiename, $deleteIfInvalid = true ) {
        if ( $this->cookieExists($cookiename) ) {
            if ( extension_loaded('mcrypt') ) {
                $cookieValues = explode('|', $_COOKIE[$cookiename]);
                if ( (count($cookieValues) === 4) && ($cookieValues[1] == 0 || $cookieValues[1] >= time()) ) {
                    $key = hash_hmac('sha1', $cookieValues[0] . $cookieValues[1], $this->_secret);
                    $cookieData = base64_decode($cookieValues[2]);
                    if ( $cookieData !== '' && $this->getHighConfidentiality() ) {
                        $data = $this->_decrypt($cookieData, $key, md5($cookieValues[1]));
                    } else {
                        $data = $cookieData;
                    }
                    if ( $this->_ssl && isset($_SERVER['SSL_SESSION_ID']) ) {
                        $verifKey = hash_hmac('sha1', $cookieValues[0] . $cookieValues[1] . $data . $_SERVER['SSL_SESSION_ID'], $key);
                    } else {
                        $verifKey = hash_hmac('sha1', $cookieValues[0] . $cookieValues[1] . $data, $key);
                    }
                    if ( $verifKey == $cookieValues[3] ) {
                        return $data;
                    }
                }
            } else {
                return $_COOKIE[$cookiename];
            }
        }
        if ( $deleteIfInvalid ) {
            $this->deleteCookie($cookiename);
        }
        return false;
    }
 
    public function setClassicCookie( $cookiename, $value, $expire = 0, $path = '/', $domain = '', $secure = false, $httponly = null ) {
        /* httponly option is only available for PHP version >= 5.2 */
        if ( $httponly === null ) {
            $this->_cookies[$cookiename] = new Slim_Http_Cookie($cookiename, $value, $expire, $path, $domain, $secure);
            //setcookie($cookiename, $value, $expire, $path, $domain, $secure);
        } else {
            $this->_cookies[$cookiename] = new Slim_Http_Cookie($cookiename, $value, $expire, $path, $domain, $secure, $httponly);
            //setcookie($cookiename, $value, $expire, $path, $domain, $secure, $httponly);
        }
    }
 
    public function cookieExists($cookiename) {
        return isset($_COOKIE[$cookiename]);
    }
 
    protected function _secureCookieValue( $value, $username, $expire ) {
        if ( is_string($expire) ) {
            $expire = strtotime($expire);
        }
        $key = hash_hmac('sha1', $username . $expire, $this->_secret);
        if ( $value !== '' && $this->getHighConfidentiality() ) {
            $encryptedValue = base64_encode($this->_encrypt($value, $key, md5($expire)));
        } else {
            $encryptedValue = base64_encode($value);
        }
        if ( $this->_ssl && isset($_SERVER['SSL_SESSION_ID']) ) {
            $verifKey = hash_hmac('sha1', $username . $expire . $value . $_SERVER['SSL_SESSION_ID'], $key);
        } else {
            $verifKey = hash_hmac('sha1', $username . $expire . $value, $key);
        }
        $result = array($username, $expire, $encryptedValue, $verifKey);
        return implode('|', $result);
    }
 
    protected function _encrypt( $data, $key, $iv ) {
        $iv = $this->_validateIv($iv);
        $key = $this->_validateKey($key);
        mcrypt_generic_init($this->_cryptModule, $key, $iv);
        $res = @mcrypt_generic($this->_cryptModule, $data);
        mcrypt_generic_deinit($this->_cryptModule);
        return $res;
    }
 
    protected function _decrypt( $data, $key, $iv ) {
        $iv = $this->_validateIv($iv);
        $key = $this->_validateKey($key);
        mcrypt_generic_init($this->_cryptModule, $key, $iv);
        $decryptedData = mdecrypt_generic($this->_cryptModule, $data);
        $res = str_replace("\x0", '', $decryptedData);
        mcrypt_generic_deinit($this->_cryptModule);
        return $res;
    }
 
    protected function _validateIv($iv) {
        $ivSize = mcrypt_enc_get_iv_size($this->_cryptModule);
        if ( strlen($iv) > $ivSize ) {
            $iv = substr($iv, 0, $ivSize);
        }
        return $iv;
    }
 
    protected function _validateKey($key) {
        $keySize = mcrypt_enc_get_key_size($this->_cryptModule);
        if ( strlen($key) > $keySize ) {
            $key = substr($key, 0, $keySize);
        }
        return $key;
    }
 
}