• Home
• yii
• base
• Security

PHP Class yii\base\Security

In particular, Security supports the following features: - Encryption/decryption: Security::encryptByKey, Security::decryptByKey, Security::encryptByPassword and Security::decryptByPassword - Key derivation using standard algorithms: Security::pbkdf2 and Security::hkdf - Data tampering prevention: Security::hashData and Security::validateData - Password validation: Security::generatePasswordHash and Security::validatePassword > Note: this class requires 'OpenSSL' PHP extension for random key/string generation on Windows and for encryption/decryption on all platforms. For the highest security level PHP version >= 5.5.0 is recommended. For more details and usage information on Security, see the guide article on security. Show file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$allowedCiphers		Look-up table of block sizes and key sizes for each supported OpenSSL cipher. In each element, the key is one of the ciphers supported by OpenSSL (@see openssl_get_cipher_methods()). The value is an array of two integers, the first is the cipher's block size in bytes and the second is the key size in bytes. > Warning: All OpenSSL ciphers that we recommend are in the default value, i.e. AES in CBC mode. > Note: Yii's encryption protocol uses the same size for cipher key, HMAC signature key and key derivation salt.
$authKeyInfo		HKDF info value for derivation of message authentication key.
$cipher		The cipher to use for encryption and decryption.
$derivationIterations		derivation iterations count. Set as high as possible to hinder dictionary password attacks.
$kdfHash		Hash algorithm for key derivation. Recommend sha256, sha384 or sha512.
$macHash		Hash algorithm for message authentication. Recommend sha256, sha384 or sha512.
$passwordHashCost		Default cost used for password hashing. Allowed value is between 4 and 31.
$passwordHashStrategy		strategy, which should be used to generate password hash. Available strategies: - 'password_hash' - use of PHP password_hash() function with PASSWORD_DEFAULT algorithm. This option is recommended, but it requires PHP version >= 5.5.0 - 'crypt' - use PHP crypt() function.

Public Methods

Method	Description
compareString ( string $expected, string $actual ) : boolean	Performs string comparison using timing attack resistant approach.
decryptByKey ( string $data, string $inputKey, string $info = null ) : boolean | string	Verifies and decrypts data encrypted with Security::encryptByKey.
decryptByPassword ( string $data, string $password ) : boolean | string	Verifies and decrypts data encrypted with Security::encryptByPassword.
encryptByKey ( string $data, string $inputKey, string $info = null ) : string	Encrypts data using a cryptographic key.
encryptByPassword ( string $data, string $password ) : string	Encrypts data using a password.
generatePasswordHash ( string $password, integer $cost = null ) : string	Generates a secure hash from a password and a random salt.
generateRandomKey ( integer $length = 32 ) : string	Generates specified number of random bytes.
generateRandomString ( integer $length = 32 ) : string	Generates a random string of specified length.
hashData ( string $data, string $key, boolean $rawHash = false ) : string	Prefixes data with a keyed hash value so that it can later be detected if it is tampered.
hkdf ( string $algo, string $inputKey, string $salt = null, string $info = null, integer $length ) : string	Derives a key from the given input key using the standard HKDF algorithm.
pbkdf2 ( string $algo, string $password, string $salt, integer $iterations, integer $length ) : string	Derives a key from the given password using the standard PBKDF2 algorithm.
validateData ( string $data, string $key, boolean $rawHash = false ) : string	Validates if the given data is tampered.
validatePassword ( string $password, string $hash ) : boolean	Verifies a password against a hash.

Protected Methods

Method	Description
decrypt ( string $data, boolean $passwordBased, string $secret, string $info ) : boolean | string	Decrypts data.
encrypt ( string $data, boolean $passwordBased, string $secret, string $info ) : string	Encrypts data.
generateSalt ( integer $cost = 13 ) : string	Generates a salt that can be used to generate a password hash.

Method Details

Property Details