Mcrypt Class Reference

Inheritance diagram for Mcrypt:

Public Member Functions
	__construct (string $key, string $cipher=MCRYPT_BLOWFISH, string $mode=MCRYPT_MODE_ECB, string $initVector=null)
	__destruct ()
	getCipher ()
	getMode ()
	getInitVector ()
	getHandle ()
	encrypt (string $data)
	decrypt (string $data)

Detailed Description

Mcrypt adapter for decrypting values using legacy ciphers

Definition at line 14 of file Mcrypt.php.

Constructor & Destructor Documentation

__construct()

__construct	(	string	$key,
		string	$cipher = MCRYPT_BLOWFISH,
		string	$mode = MCRYPT_MODE_ECB,
		string	$initVector = null
	)

Mcrypt constructor.

Parameters

string	$key
string	$cipher
string	$mode
string	$initVector

Exceptions

Definition at line 46 of file Mcrypt.php.

      {
        $this->cipher = $cipher;
        $this->mode = $mode;
        // @codingStandardsIgnoreLine
        $this->handle = @mcrypt_module_open($cipher, '', $mode, '');
        try {
            // @codingStandardsIgnoreLine
            $maxKeySize = @mcrypt_enc_get_key_size($this->handle);
            if (strlen($key) > $maxKeySize) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    new \Magento\Framework\Phrase('Key must not exceed %1 bytes.', [$maxKeySize])
                );
            }
            // @codingStandardsIgnoreLine
            $initVectorSize = @mcrypt_enc_get_iv_size($this->handle);
            if (null === $initVector) {
                /* Set vector to zero bytes to not use it */
                $initVector = str_repeat("\0", $initVectorSize);
            } elseif (!is_string($initVector) || strlen($initVector) != $initVectorSize) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    new \Magento\Framework\Phrase(
                        'Init vector must be a string of %1 bytes.',
                        [$initVectorSize]
                    )
                );
            }
            $this->initVector = $initVector;
        } catch (\Exception $e) {
            // @codingStandardsIgnoreLine
            @mcrypt_module_close($this->handle);
            throw new \Magento\Framework\Exception\LocalizedException(new \Magento\Framework\Phrase($e->getMessage()));
        }
        // @codingStandardsIgnoreLine
        @mcrypt_generic_init($this->handle, $key, $initVector);
    }

__destruct()

__destruct

(

)

Destructor frees allocated resources

Definition at line 90 of file Mcrypt.php.

    {
        // @codingStandardsIgnoreStart
        @mcrypt_generic_deinit($this->handle);
        @mcrypt_module_close($this->handle);
        // @codingStandardsIgnoreEnd
    }

Member Function Documentation

decrypt()

decrypt

(

string

$data

)

Decrypt a string

Parameters

string

$data

Returns

string

Implements EncryptionAdapterInterface.

Definition at line 160 of file Mcrypt.php.

                                         : string
    {
        if (strlen($data) == 0) {
            return $data;
        }
        // @codingStandardsIgnoreLine
        $data = @mdecrypt_generic($this->handle, $data);
        /*
         * Returned string can in fact be longer than the unencrypted string due to the padding of the data
         * @link http://www.php.net/manual/en/function.mdecrypt-generic.php
         */
        $data = rtrim($data, "\0");
        return $data;
    }

encrypt()

encrypt

(

string

$data

)

Encrypt a string

Parameters

string

$data

String to encrypt

Returns

string

Exceptions

Implements EncryptionAdapterInterface.

Definition at line 145 of file Mcrypt.php.

                                         : string
    {
        if (strlen($data) == 0) {
            return $data;
        }
        // @codingStandardsIgnoreLine
        return @mcrypt_generic($this->getHandle(), $data);
    }

getCipher()

getCipher

(

)

Retrieve a name of currently used cryptographic algorithm

Returns

string

Definition at line 103 of file Mcrypt.php.

                               : string
    {
        return $this->cipher;
    }

getHandle()

getHandle

(

)

Get the current mcrypt handle

Returns

resource

Definition at line 133 of file Mcrypt.php.

    {
        return $this->handle;
    }

getInitVector()

getInitVector

(

)

Retrieve an actual value of initial vector that has been used to initialize a cipher

Returns

string

Definition at line 123 of file Mcrypt.php.

                                   : ?string
    {
        return $this->initVector;
    }

getMode()

getMode

(

)

Mode in which cryptographic algorithm is running

Returns

string

Definition at line 113 of file Mcrypt.php.

                             : string
    {
        return $this->mode;
    }

---

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

• vendor/magento/framework/Encryption/Adapter/Mcrypt.php