Crypt Class Reference

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

Protected Attributes
	$_cipher
	$_mode
	$_initVector

Detailed Description

Class encapsulates cryptographic algorithm

@api

Deprecated:

Since

100.0.2

Definition at line 18 of file Crypt.php.

Constructor & Destructor Documentation

__construct()

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

Constructor

Parameters

string	$key	Secret encryption key. It's unsafe to store encryption key in memory, so no getter for key exists.
string	$cipher	Cipher algorithm (one of the MCRYPT_ciphername constants)
string	$mode	Mode of cipher algorithm (MCRYPT_MODE_modeabbr constants)
string | bool	$initVector	Initial vector to fill algorithm blocks. TRUE generates a random initial vector. FALSE fills initial vector with zero bytes to not use it.

Exceptions

Definition at line 54 of file Crypt.php.

      {
        if (true === $initVector) {
            // @codingStandardsIgnoreStart
            $handle = @mcrypt_module_open($cipher, '', $mode, '');
            $initVectorSize = @mcrypt_enc_get_iv_size($handle);
            // @codingStandardsIgnoreEnd

            /* Generate a random vector from human-readable characters */
            $allowedCharacters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
            $initVector = '';
            for ($i = 0; $i < $initVectorSize; $i++) {
                $initVector .= $allowedCharacters[rand(0, strlen($allowedCharacters) - 1)];
            }
            // @codingStandardsIgnoreStart
            @mcrypt_generic_deinit($handle);
            @mcrypt_module_close($handle);
            // @codingStandardsIgnoreEnd
        }

        $this->mcrypt = new \Magento\Framework\Encryption\Adapter\Mcrypt(
            $key,
            $cipher,
            $mode,
            $initVector === false ? null : $initVector
        );
    }

Member Function Documentation

decrypt()

decrypt

(

$data

)

Decrypt a data

Parameters

string

$data

String to decrypt

Returns

string

Definition at line 137 of file Crypt.php.

    {
        return $this->mcrypt->decrypt($data);
    }

encrypt()

encrypt

(

$data

)

Encrypt a data

Parameters

string

$data

String to encrypt

Returns

string

Definition at line 122 of file Crypt.php.

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

getCipher()

getCipher

(

)

Retrieve a name of currently used cryptographic algorithm

Returns

string

Definition at line 91 of file Crypt.php.

    {
        return $this->mcrypt->getCipher();
    }

getInitVector()

getInitVector

(

)

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

Returns

string

Definition at line 111 of file Crypt.php.

    {
        return $this->mcrypt->getInitVector();
    }

getMode()

getMode

(

)

Mode in which cryptographic algorithm is running

Returns

string

Definition at line 101 of file Crypt.php.

    {
        return $this->mcrypt->getMode();
    }

Field Documentation

$_cipher

$_cipher

protected

Definition at line 23 of file Crypt.php.

$_initVector

$_initVector

protected

Definition at line 33 of file Crypt.php.

$_mode

$_mode

protected

Definition at line 28 of file Crypt.php.

---

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

• vendor/magento/framework/Encryption/Crypt.php