Mage_Core_Model_Encryption Class Reference

List of all members.

Public Member Functions
	setHelper ($helper)
	getHash ($password, $salt=false)
	hash ($data)
	validateHash ($password, $hash)
	encrypt ($data)
	decrypt ($data)
	validateKey ($key)
Protected Member Functions
	_getCrypt ($key=null)
Protected Attributes
	$_crypt
	$_helper

---

Detailed Description

Definition at line 34 of file Encryption.php.

---

Member Function Documentation

_getCrypt

(

$

key = null

)

[protected]

Instantiate crypt model

Parameters:

string

$key

Returns:

Varien_Crypt_Mcrypt

Definition at line 114 of file Encryption.php.

    {
        if (!$this->_crypt) {
            if (null === $key) {
                $key = (string)Mage::getConfig()->getNode('global/crypt/key');
            }
            $this->_crypt = Varien_Crypt::factory()->init($key);
        }
        return $this->_crypt;
    }

decrypt

(

$

data

)

Decrypt a string

Parameters:

string

$data

Returns:

string

Definition at line 142 of file Encryption.php.

    {
        return str_replace("\x0", '', trim($this->_getCrypt()->decrypt(base64_decode((string)$data))));
    }

encrypt

(

$

data

)

Encrypt a string

Parameters:

string

$data

Returns:

string

Definition at line 131 of file Encryption.php.

    {
        return base64_encode($this->_getCrypt()->encrypt((string)$data));
    }

getHash	(	$	password,
		$	salt = false
	)

Generate a [salted] hash.

$salt can be: false - a random will be generated integer - a random with specified length will be generated string

Parameters:

	string	$password
	mixed	$salt

Returns:

string

Definition at line 69 of file Encryption.php.

    {
        if (is_integer($salt)) {
            $salt = $this->_helper->getRandomString($salt);
        }
        return $salt === false ? $this->hash($password) : $this->hash($salt . $password) . ':' . $salt;
    }

hash

(

$

data

)

Hash a string

Parameters:

string

$data

Returns:

string

Definition at line 83 of file Encryption.php.

    {
        return md5($data);
    }

setHelper

(

$

helper

)

Set helper instance

Parameters:

Mage_Core_Helper_Data

$helper

Returns:

Mage_Core_Model_Encryption

Definition at line 51 of file Encryption.php.

    {
        $this->_helper = $helper;
        return $this;
    }

validateHash	(	$	password,
		$	hash
	)

Validate hash against hashing method (with or without salt)

Parameters:

	string	$password
	string	$hash

Returns:

bool

Exceptions:

Exception

Definition at line 96 of file Encryption.php.

    {
        $hashArr = explode(':', $hash);
        switch (count($hashArr)) {
            case 1:
                return $this->hash($password) === $hash;
            case 2:
                return $this->hash($hashArr[1] . $password) === $hashArr[0];
        }
        Mage::throwException('Invalid hash.');
    }

validateKey

(

$

key

)

Return crypt model, instantiate if it is empty

Parameters:

string

$key

Returns:

Varien_Crypt_Mcrypt

Definition at line 153 of file Encryption.php.

    {
        return $this->_getCrypt($key);
    }

---

Member Data Documentation

$_crypt [protected]

Definition at line 39 of file Encryption.php.

$_helper [protected]

Definition at line 43 of file Encryption.php.

---

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

• app/code/core/Mage/Core/Model/Encryption.php