Docs For Class JCryptCipherMcrypt

Description

Implements interfaces:

JCryptCipher

JCrypt cipher for mcrypt algorithm encryption, decryption and key generation.

abstract:
since: 12.1

Located in /libraries/joomla/crypt/cipher/mcrypt.php (line 19)

Direct descendents

Class	Description
JCryptCipher3Des	JCrypt cipher for Triple DES encryption, decryption and key generation.
JCryptCipherBlowfish	JCrypt cipher for Blowfish encryption, decryption and key generation.
JCryptCipherRijndael256	JCrypt cipher for Rijndael 256 encryption, decryption and key generation.

Variable Summary

string $keyType

integer $mode

integer $type

Method Summary

JCryptCipherMcrypt __construct ()

string decrypt (string $data, JCryptKey $key)

string encrypt (string $data, JCryptKey $key)

JCryptKey generateKey ([array $options = array()])

string pbkdf2 (string $p, string $s, integer $kl, [integer $c = 10000], [string $a = 'sha256'])

Variables

string $keyType (line 39)

var: The JCrypt key type for validation.
since: 12.1
access: protected

Redefined in descendants as:

integer $mode (line 33)

var: The mcrypt block cipher mode.
see: http://www.php.net/manual/en/mcrypt.constants.php
since: 12.1
access: protected

Redefined in descendants as:

integer $type (line 26)

var: The mcrypt cipher constant.
see: http://www.php.net/manual/en/mcrypt.ciphers.php
since: 12.1
access: protected

Redefined in descendants as:

Methods

Constructor __construct (line 47)

Constructor.

since: 12.1
throws: RuntimeException
access: public

JCryptCipherMcrypt __construct ()

decrypt (line 65)

Method to decrypt a data string.

return: The decrypted data string.
since: 12.1
access: public

string decrypt (string $data, JCryptKey $key)

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

Implementation of:

JCryptCipher::decrypt(): Method to decrypt a data string.

encrypt (line 89)

Method to encrypt a data string.

return: The encrypted data string.
since: 12.1
access: public

string encrypt (string $data, JCryptKey $key)

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

Implementation of:

JCryptCipher::encrypt(): Method to encrypt a data string.

generateKey (line 112)

Method to generate a new encryption key object.

since: 12.1
access: public

JCryptKey generateKey ([array $options = array()])

array $options: Key generation options.

Implementation of:

JCryptCipher::generateKey(): Method to generate a new encryption key[/pair] object.

pbkdf2 (line 145)

PBKDF2 Implementation for deriving keys.

return: The derived key.
see: http://en.wikipedia.org/wiki/PBKDF2
see: http://www.ietf.org/rfc/rfc2898.txt
since: 12.1
access: public

string pbkdf2 (string $p, string $s, integer $kl, [integer $c = 10000], [string $a = 'sha256'])

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