Référence de la classe JCryptCipherMcrypt

Graphe d'héritage de JCryptCipherMcrypt:

Graphe de collaboration de JCryptCipherMcrypt:

Liste de tous les membres

Fonctions membres publiques
	__construct ()
	decrypt ($data, JCryptKey $key)
	encrypt ($data, JCryptKey $key)
	generateKey (array $options=array())
	pbkdf2 ($p, $s, $kl, $c=10000, $a= 'sha256')

Attributs protégés
	$type
	$mode
	$keyType

---

Description détaillée

Définition à la ligne 19 du fichier mcrypt.php.

---

Documentation des constructeurs et destructeur

JCryptCipherMcrypt::__construct

(

)

Constructor.

Depuis:

12.1

Exceptions:

RuntimeException

Définition à la ligne 47 du fichier mcrypt.php.

        {
                if (!is_callable('mcrypt_encrypt'))
                {
                        throw new RuntimeException('The mcrypt extension is not available.');
                }
        }

---

Documentation des fonctions membres

JCryptCipherMcrypt::decrypt	(		$data,
		JCryptKey	$key
	)

Method to decrypt a data string.

Paramètres:

string	$data	The encrypted string to decrypt.
JCryptKey	$key	The key object to use for decryption.

Renvoie:

string The decrypted data string.

Depuis:

12.1

Implémente JCryptCipher.

Définition à la ligne 65 du fichier mcrypt.php.

        {
                // Validate key.
                if ($key->type != $this->keyType)
                {
                        throw new InvalidArgumentException('Invalid key of type: ' . $key->type . '.  Expected ' . $this->keyType . '.');
                }

                // Decrypt the data.
                $decrypted = trim(mcrypt_decrypt($this->type, $key->private, $data, $this->mode, $key->public));

                return $decrypted;
        }

JCryptCipherMcrypt::encrypt	(		$data,
		JCryptKey	$key
	)

Method to encrypt a data string.

Paramètres:

string	$data	The data string to encrypt.
JCryptKey	$key	The key object to use for encryption.

Renvoie:

string The encrypted data string.

Depuis:

12.1

Implémente JCryptCipher.

Définition à la ligne 89 du fichier mcrypt.php.

        {
                // Validate key.
                if ($key->type != $this->keyType)
                {
                        throw new InvalidArgumentException('Invalid key of type: ' . $key->type . '.  Expected ' . $this->keyType . '.');
                }

                // Encrypt the data.
                $encrypted = mcrypt_encrypt($this->type, $key->private, $data, $this->mode, $key->public);

                return $encrypted;
        }

JCryptCipherMcrypt::generateKey

(

array

$options = array()

)

Method to generate a new encryption key object.

Paramètres:

array

$options

Key generation options.

Renvoie:

JCryptKey

Depuis:

12.1

Implémente JCryptCipher.

Définition à la ligne 112 du fichier mcrypt.php.

        {
                // Create the new encryption key object.
                $key = new JCryptKey($this->keyType);

                // Generate an initialisation vector based on the algorithm.
                $key->public = mcrypt_create_iv(mcrypt_get_iv_size($this->type, $this->mode));

                // Get the salt and password setup.
                $salt = (isset($options['salt'])) ? $options['salt'] : substr(pack("h*", md5(mt_rand())), 0, 16);
                $password = (isset($options['password'])) ? $options['password'] : 'J00ml4R0ck$!';

                // Generate the derived key.
                $key->private = $this->pbkdf2($password, $salt, mcrypt_get_key_size($this->type, $this->mode));

                return $key;
        }

JCryptCipherMcrypt::pbkdf2	(		$p,
			$s,
			$kl,
			$c = 10000,
			$a = 'sha256'
	)

PBKDF2 Implementation for deriving keys.

Paramètres:

string	$p	Password
string	$s	Salt
integer	$kl	Key length
integer	$c	Iteration count
string	$a	Hash algorithm

Renvoie:

string The derived key.

Voir également:

http://en.wikipedia.org/wiki/PBKDF2

http://www.ietf.org/rfc/rfc2898.txt

Depuis:

12.1

Définition à la ligne 145 du fichier mcrypt.php.

        {
                // Hash length.
                $hl = strlen(hash($a, null, true));

                // Key blocks to compute.
                $kb = ceil($kl / $hl);

                // Derived key.
                $dk = '';

                // Create the key.
                for ($block = 1; $block <= $kb; $block++)
                {
                        // Initial hash for this block.
                        $ib = $b = hash_hmac($a, $s . pack('N', $block), $p, true);

                        // Perform block iterations.
                        for ($i = 1; $i < $c; $i++)
                        {
                                $ib ^= ($b = hash_hmac($a, $b, $p, true));
                        }

                        // Append the iterated block.
                        $dk .= $ib;
                }

                // Return derived key of correct length.
                return substr($dk, 0, $kl);
        }

---

Documentation des données membres

JCryptCipherMcrypt::$keyType

protected

Réimplémentée dans JCryptCipher3Des, JCryptCipherBlowfish, et JCryptCipherRijndael256.

Définition à la ligne 39 du fichier mcrypt.php.

JCryptCipherMcrypt::$mode

protected

Réimplémentée dans JCryptCipher3Des, JCryptCipherBlowfish, et JCryptCipherRijndael256.

Définition à la ligne 33 du fichier mcrypt.php.

JCryptCipherMcrypt::$type

protected

Réimplémentée dans JCryptCipher3Des, JCryptCipherBlowfish, et JCryptCipherRijndael256.

Définition à la ligne 26 du fichier mcrypt.php.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• jplatform-13.1/joomla/crypt/cipher/mcrypt.php