Class: Crypt_Blowfish_MCrypt

Source Location: /Crypt_Blowfish-1.1.0RC2/Blowfish/MCrypt.php

Class Overview

Crypt_Blowfish
   |
   --Crypt_Blowfish_MCrypt

Example using the factory method in CBC mode and forcing using the MCrypt library.

Author(s):

Philippe Jausions <jausions at php.net>
Matthew Fonda <mfonda at php.net>

Version:

1.1.0RC2

Copyright:

2005-2008 Matthew Fonda

Methods

Inherited Variables

Class: Crypt_Blowfish

Crypt_Blowfish::$_block_size
Crypt_Blowfish::$_iv
Crypt_Blowfish::$_iv_size
Crypt_Blowfish::$_key_size

Inherited Methods

Class: Crypt_Blowfish

Crypt_Blowfish::Crypt_Blowfish(): Crypt_Blowfish Constructor Initializes the Crypt_Blowfish object (in EBC mode), and sets the secret key
Crypt_Blowfish::decrypt(): Decrypts an encrypted string
Crypt_Blowfish::encrypt(): Encrypts a string
Crypt_Blowfish::factory(): Crypt_Blowfish object factory
Crypt_Blowfish::getBlockSize(): Returns the algorithm's block size
Crypt_Blowfish::getIVSize(): Returns the algorithm's IV size
Crypt_Blowfish::getMaxKeySize(): Returns the algorithm's maximum key size
Crypt_Blowfish::init(): Deprecated init method - init is now a private method and has been replaced with _init
Crypt_Blowfish::isReady(): Deprecated isReady method
Crypt_Blowfish::setKey(): Sets the secret key The key must be non-zero, and less than or equal to 56 characters (bytes) in length.

Class Details

[line 53]
Example using the factory method in CBC mode and forcing using the MCrypt library.

 $bf =& Crypt_Blowfish::factory('cbc', null, null, CRYPT_BLOWFISH_MCRYPT);

 if (PEAR::isError($bf)) {
     echo $bf->getMessage();
     exit;
 }
 $iv = 'abc123+=';
 $key = 'My secret key';
 $bf->setKey($key, $iv);
 $encrypted = $bf->encrypt('this is some example plain text');
 $bf->setKey($key, $iv);
 $plaintext = $bf->decrypt($encrypted);
 echo "plain text: $plaintext";

Author: Philippe Jausions <jausions@php.net>
Author: Matthew Fonda <mfonda@php.net>
Version: 1.1.0RC2
Copyright: 2005-2008 Matthew Fonda
Link: http://pear.php.net/package/Crypt_Blowfish
Since: 1.1.0
License: New BSD

[ Top ]

Method Detail

Crypt_Blowfish_MCrypt (Constructor) [line 72]

Crypt_Blowfish_MCrypt Crypt_Blowfish_MCrypt(
[string
$key = null], [string
$mode = 'ecb'], [string
$iv = null])

Crypt_Blowfish Constructor Initializes the Crypt_Blowfish object, and sets the secret key

Access: public

Parameters:

string	`$key`	—
string	`$mode`	—	operating mode 'ecb', 'cbc'...
string	`$iv`	—	initialization vector

[ Top ]

decrypt [line 128]

string|PEAR_Error decrypt(
string
$cipherText)

Decrypts an encrypted string

The value was padded with NUL characters when encrypted. You may need to trim the result or cast its type.

Return: Returns plain text on success, or PEAR_Error on failure
Access: public

Overrides Crypt_Blowfish::decrypt() (Decrypts an encrypted string)

Parameters:

string $cipherText —

[ Top ]

encrypt [line 107]

string|PEAR_Error encrypt(
string
$plainText)

Encrypts a string

Value is padded with NUL characters prior to encryption. You may need to trim or cast the type when you decrypt.

Return: Returns cipher text on success, or PEAR_Error on failure
Access: public

Overrides Crypt_Blowfish::encrypt() (Encrypts a string)

Parameters:

string $plainText — string of characters/bytes to encrypt

[ Top ]

setKey [line 150]

boolean|PEAR_Error setKey(
string
$key, [string
$iv = null])

Sets the secret key The key must be non-zero, and less than or equal to 56 characters (bytes) in length.

If you are making use of the PHP mcrypt extension, you must call this method before each encrypt() and decrypt() call.

Return: Returns TRUE on success, PEAR_Error on failure
Access: public

Overrides Crypt_Blowfish::setKey() (Sets the secret key The key must be non-zero, and less than or equal to 56 characters (bytes) in length.)

Parameters:

string	`$key`	—
string	`$iv`	—	8-char initialization vector (required for CBC mode)

[ Top ]