Zend_Filter_Encrypt_Mcrypt Class Reference

Inheritance diagram for Zend_Filter_Encrypt_Mcrypt:

Public Member Functions
	__construct ($options)
	getEncryption ()
	setEncryption ($options)
	getVector ()
	setVector ($vector=null)
	getCompression ()
	setCompression ($compression)
	encrypt ($value)
	decrypt ($value)
	toString ()

Protected Member Functions
	_openCipher ()
	_closeCipher ($cipher)
	_initCipher ($cipher)
	_srand ()

Protected Attributes
	$_encryption
	$_compression

Static Protected Attributes
static	$_srandCalled = false

Detailed Description

Definition at line 38 of file Mcrypt.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options

)

Class constructor

Parameters

string | array | Zend_Config

$options

Cryption Options

Definition at line 74 of file Mcrypt.php.

    {
        if (!extension_loaded('mcrypt')) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('This filter needs the mcrypt extension');
        }

        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        } elseif (is_string($options)) {
            $options = array('key' => $options);
        } elseif (!is_array($options)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Invalid options argument provided to filter');
        }

        if (array_key_exists('compression', $options)) {
            $this->setCompression($options['compression']);
            unset($options['compress']);
        }

        $this->setEncryption($options);
    }

Member Function Documentation

_closeCipher()

_closeCipher (   $cipher )

protected

Close a cipher

Parameters

resource

$cipher

Cipher to close

Returns

Zend_Filter_Encrypt_Mcrypt

Definition at line 314 of file Mcrypt.php.

    {
        mcrypt_module_close($cipher);

        return $this;
    }

_initCipher()

_initCipher (   $cipher )

protected

Initialises the cipher with the set key

Parameters

resource

$cipher

Exceptions

Definition at line 328 of file Mcrypt.php.

    {
        $key = $this->_encryption['key'];

        $keysizes = mcrypt_enc_get_supported_key_sizes($cipher);
        if (empty($keysizes) || ($this->_encryption['salt'] == true)) {
            $this->_srand();
            $keysize = mcrypt_enc_get_key_size($cipher);
            $key     = substr(md5($key), 0, $keysize);
        } else if (!in_array(strlen($key), $keysizes)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('The given key has a wrong size for the set algorithm');
        }

        $result = mcrypt_generic_init($cipher, $key, $this->_encryption['vector']);
        if ($result < 0) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Mcrypt could not be initialize with the given setting');
        }

        return $this;
    }

_openCipher()

_openCipher ( )

protected

Open a cipher

Exceptions

Zend_Filter_Exception

When the cipher can not be opened

Returns

resource Returns the opened cipher

Definition at line 292 of file Mcrypt.php.

    {
        $cipher = mcrypt_module_open(
            $this->_encryption['algorithm'],
            $this->_encryption['algorithm_directory'],
            $this->_encryption['mode'],
            $this->_encryption['mode_directory']);

        if ($cipher === false) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Mcrypt can not be opened with your settings');
        }

        return $cipher;
    }

_srand()

_srand ( )

protected

_srand() interception

See also

ZF-8742

Definition at line 356 of file Mcrypt.php.

    {
        if (version_compare(PHP_VERSION, '5.3.0', '>=')) {
            return;
        }
        if (!self::$_srandCalled) {
            srand(Zend_Crypt_Math::randInteger(0, PHP_INT_MAX));
            self::$_srandCalled = true;
        }
    }

decrypt()

decrypt

(

$value

)

Defined by Zend_Filter_Interface

Decrypts $value with the defined settings

Parameters

string

$value

Content to decrypt

Returns

string The decrypted content

Implements Zend_Filter_Encrypt_Interface.

Definition at line 258 of file Mcrypt.php.

    {
        $cipher = $this->_openCipher();
        $this->_initCipher($cipher);
        $decrypted = mdecrypt_generic($cipher, $value);
        mcrypt_generic_deinit($cipher);
        $this->_closeCipher($cipher);

        // decompress after decryption
        if (!empty($this->_compression)) {
            #require_once 'Zend/Filter/Decompress.php';
            $decompress = new Zend_Filter_Decompress($this->_compression);
            $decrypted  = $decompress->filter($decrypted);
        }

        return $decrypted;
    }

encrypt()

encrypt

(

$value

)

Defined by Zend_Filter_Interface

Encrypts $value with the defined settings

Parameters

string

$value

The content to encrypt

Returns

string The encrypted content

Implements Zend_Filter_Encrypt_Interface.

Definition at line 232 of file Mcrypt.php.

    {
        // compress prior to encryption
        if (!empty($this->_compression)) {
            #require_once 'Zend/Filter/Compress.php';
            $compress = new Zend_Filter_Compress($this->_compression);
            $value    = $compress->filter($value);
        }

        $cipher  = $this->_openCipher();
        $this->_initCipher($cipher);
        $encrypted = mcrypt_generic($cipher, $value);
        mcrypt_generic_deinit($cipher);
        $this->_closeCipher($cipher);

        return $encrypted;
    }

getCompression()

getCompression

(

)

Returns the compression

Returns

array

Definition at line 203 of file Mcrypt.php.

    {
        return $this->_compression;
    }

getEncryption()

getEncryption

(

)

Returns the set encryption options

Returns

array

Definition at line 103 of file Mcrypt.php.

    {
        return $this->_encryption;
    }

getVector()

getVector

(

)

Returns the set vector

Returns

string

Definition at line 158 of file Mcrypt.php.

    {
        return $this->_encryption['vector'];
    }

setCompression()

setCompression

(

$compression

)

Sets a internal compression for values to encrypt

Parameters

string | array

$compression

Returns

Zend_Filter_Encrypt_Mcrypt

Definition at line 214 of file Mcrypt.php.

    {
        if (is_string($this->_compression)) {
            $compression = array('adapter' => $compression);
        }

        $this->_compression = $compression;
        return $this;
    }

setEncryption()

setEncryption

(

$options

)

Sets new encryption options

Parameters

string | array

$options

Encryption options

Returns

Zend_Filter_File_Encryption

Definition at line 114 of file Mcrypt.php.

    {
        if (is_string($options)) {
            $options = array('key' => $options);
        }

        if (!is_array($options)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('Invalid options argument provided to filter');
        }

        $options = $options + $this->getEncryption();
        $algorithms = mcrypt_list_algorithms($options['algorithm_directory']);
        if (!in_array($options['algorithm'], $algorithms)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception("The algorithm '{$options['algorithm']}' is not supported");
        }

        $modes = mcrypt_list_modes($options['mode_directory']);
        if (!in_array($options['mode'], $modes)) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception("The mode '{$options['mode']}' is not supported");
        }

        if (!mcrypt_module_self_test($options['algorithm'], $options['algorithm_directory'])) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('The given algorithm can not be used due an internal mcrypt problem');
        }

        if (!isset($options['vector'])) {
            $options['vector'] = null;
        }

        $this->_encryption = $options;
        $this->setVector($options['vector']);

        return $this;
    }

setVector()

setVector

(

$vector = null

)

Sets the initialization vector

Parameters

string

$vector

(Optional) Vector to set

Returns

Zend_Filter_Encrypt_Mcrypt

Definition at line 169 of file Mcrypt.php.

    {
        $cipher = $this->_openCipher();
        $size   = mcrypt_enc_get_iv_size($cipher);
        if (empty($vector)) {
            $this->_srand();
            if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN' && version_compare(PHP_VERSION, '5.3.0', '<')) {
                $method = MCRYPT_RAND;
            } else {
                if (file_exists('/dev/urandom') || (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN')) {
                    $method = MCRYPT_DEV_URANDOM;
                } elseif (file_exists('/dev/random')) {
                    $method = MCRYPT_DEV_RANDOM;
                } else {
                    $method = MCRYPT_RAND;
                }
            }
            $vector = mcrypt_create_iv($size, $method);
        } else if (strlen($vector) != $size) {
            #require_once 'Zend/Filter/Exception.php';
            throw new Zend_Filter_Exception('The given vector has a wrong size for the set algorithm');
        }

        $this->_encryption['vector'] = $vector;
        $this->_closeCipher($cipher);

        return $this;
    }

toString()

toString

(

)

Returns the adapter name

Returns

string

Definition at line 281 of file Mcrypt.php.

    {
        return 'Mcrypt';
    }

Field Documentation

$_compression

$_compression

protected

Definition at line 65 of file Mcrypt.php.

$_encryption

$_encryption

protected

Initial value:

= array(
        'key'                 => 'ZendFramework',
        'algorithm'           => 'blowfish',
        'algorithm_directory' => '',
        'mode'                => 'cbc',
        'mode_directory'      => '',
        'vector'              => null,
        'salt'                => false
    )

Definitions for encryption array( 'key' => encryption key string 'algorithm' => algorithm to use 'algorithm_directory' => directory where to find the algorithm 'mode' => encryption mode to use 'modedirectory' => directory where to find the mode )

Definition at line 50 of file Mcrypt.php.

$_srandCalled

$_srandCalled = false

staticprotected

Definition at line 67 of file Mcrypt.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Filter/Encrypt/Mcrypt.php