The security library handles basic security measures such as providing methods for hashing and encrypting data.
The encryption features offered by Security rely on the deprecated
mcrypt extension. If you are using PHP>=7.1 you will need to install
mcrypt via PECL.
Encrypts/Decrypts text using the given key:
// Encrypt your text with my_key $secret = Security::cipher('hello world', 'my_key'); // Later decrypt your text $nosecret = Security::cipher($secret, 'my_key');
cipher() uses a weak XOR cipher and should not be used.
It is only included for backwards compatibility.
rijndael($text, $key, $mode)¶
Encrypts/Decrypts text using the rijndael-256 cipher. This requires the mcrypt extension to be installed:
// Encrypt some data. $encrypted = Security::rijndael('a secret', Configure::read('Security.key'), 'encrypt'); // Later decrypt it. $decrypted = Security::rijndael($encrypted, Configure::read('Security.key'), 'decrypt');
rijndael() can be used to store data you need to decrypt later, like the
contents of cookies. It should never be used to store passwords.
Instead you should use the one way hashing methods provided by
New in version 2.2:
Security::rijndael() was added in 2.2.
encrypt($text, $key, $hmacSalt = null)¶
$text using AES-256. The
$key should be a value with a
lots of variance in the data, much like a good password. The returned result
will be the encrypted value with an HMAC checksum.
This method should never be used to store passwords. Instead you should
use the one way hashing methods provided by
An example use would be:
// Assuming key is stored somewhere it can be re-used for // decryption later. $key = 'wt1U5MACWJFTXGenFoZoiLwQGrLgdbHA'; $result = Security::encrypt($value, $key);
Encrypted values can be decrypted using
New in version 2.5.
decrypt($cipher, $key, $hmacSalt = null)¶
Decrypt a previously encrypted value. The
parameters must match the values used to encrypt or decryption will fail. An
example use would be:
// Assuming key is stored somewhere it can be re-used for // decryption later. $key = 'wt1U5MACWJFTXGenFoZoiLwQGrLgdbHA'; $cipher = $user['User']['secrets']; $result = Security::decrypt($cipher, $key);
If the value cannot be decrypted due to changes in the key or HMAC salt
false will be returned.
New in version 2.5.
hash($string, $type = NULL, $salt = false)¶
Create a hash from a string using given method or fallback to next
available method. If
$salt is set to true, the applications salt
value will be used:
// Using the application's salt value $sha1 = Security::hash('CakePHP Framework', 'sha1', true); // Using a custom salt value $md5 = Security::hash('CakePHP Framework', 'md5', 'my-salt'); // Using the default hash algorithm $hash = Security::hash('CakePHP Framework');
hash() also supports other secure hashing algorithms like bcrypt. When
using bcrypt, you should be mindful of the slightly different usage.
Creating an initial hash works the same as other algorithms:
// Create a hash using bcrypt Security::setHash('blowfish'); $hash = Security::hash('CakePHP Framework');
Unlike other hash types comparing plain text values to hashed values should be done as follows:
// $storedPassword, is a previously generated bcrypt hash. $newHash = Security::hash($newPassword, 'blowfish', $storedPassword);
When comparing values hashed with bcrypt, the original hash should be
provided as the
$salt parameter. This allows bcrypt to reuse the same
cost and salt values, allowing the generated hash to return the same
resulting hash, given the same input value.
Changed in version 2.3: Support for bcrypt was added in 2.3
Sets the default hash method for the Security object. This affects all objects using Security::hash().