PHP Class Webiny\Component\Crypt\Bridge\Webiny\Crypt

This is a simple class providing the basic cryptographic methods. The class uses a combination of three different seeds for providing randomness: - MCRYPT_DEV_URANDOM, - mt_rand - microtime For mixing seeds we use a basic combination of mt_rand, shuffle and str_shuffle Password hashing and validation if done using nativ password_hash and password_verify methods. Encoding and decoding is done using mcrypt methods. Notice: This class will provide the neccessary security for most your day-to-day operations, like storing and verifying passwords, generating medium strenght random numbers and strings, and also basic medium encryption and decryption. The library has been tested, but not reviewd by a security expert. If you have any suggestions or improvements to report, feel free to open an issue. If you require a more advanced random library, with higher strenght random generator, we suggest you use https://github.com/ircmaxell/RandomLib.
Inheritance: implements Webiny\Component\Crypt\Bridge\CryptInterface
Afficher le fichier Open project: Webiny/Framework Class Usage Examples

Méthodes publiques

Méthode Description
__construct ( string $passwordAlgo, string $cipherMode, string $cipherBlock ) Base constructor
createPasswordHash ( string $password ) : string Creates a hash from the given $password string.
decrypt ( string $string, string $key ) : string Decrypt a string that has been encrypted with the 'encrypt' method.
encrypt ( string $string, string $key ) : string Encrypt the given $string using a cypher and the secret $key
generateHardReadableString ( integer $length ) : string Generates a random string with a lot of 'noise' (special characters).
generateRandomInt ( integer $min = 1, integer $max = PHP_INT_MAX ) : integer Generates a random integer between the given $min and $max values.
generateRandomString ( integer $length, string $chars = '' ) : string Generates a random string using the defined character set.
generateUserReadableString ( integer $length ) : string Generates a random string, but without using special characters that are hard to read.
verifyPasswordHash ( string $password, string $hash ) : boolean Verify if the given $hash matches the given $password.

Private Methods

Méthode Description
generator ( integer $size ) : string A simple seed generator that uses mcrypt_create_iv (MCRYPT_DEV_URANDOM).
getKeyHash ( string $key ) : string Generates a hash from the given key. The has length is determined by the cipher mode and cipher block.
hkdf ( $key, string $digest = 'sha512', $salt = null, $length = null, string $info = '' ) : string HKDF https://gist.github.com/narfbg/8793435
strLen ( $str )
subStr ( $str, $start, $len = null ) : string Helper function for substr.

Method Details

__construct() public méthode

Base constructor
public __construct ( string $passwordAlgo, string $cipherMode, string $cipherBlock )
$passwordAlgo string Password hashing algorithm.
$cipherMode string Cipher mode.
$cipherBlock string Cipher block size.

createPasswordHash() public méthode

The hashing algorithm used depends on your config.
public createPasswordHash ( string $password ) : string
$password string String you wish to hash.
Résultat string Hash of the given string.

decrypt() public méthode

In order to decrypt the string correctly, you must provide the same secret key that was used for the encryption process.
public decrypt ( string $string, string $key ) : string
$string string The string you want to decrypt.
$key string The secret key that was used to encrypt the $string.
Résultat string Decrypted string.

encrypt() public méthode

Encrypt the given $string using a cypher and the secret $key
public encrypt ( string $string, string $key ) : string
$string string The string you want to encrypt.
$key string The secret key that will be used to encrypt the string.
Résultat string Encrypted string.

generateHardReadableString() public méthode

Use this method to generate API keys, salts and similar.
public generateHardReadableString ( integer $length ) : string
$length integer Length of the random string.
Résultat string Random string with the given $length.

generateRandomInt() public méthode

Generates a random integer between the given $min and $max values.
public generateRandomInt ( integer $min = 1, integer $max = PHP_INT_MAX ) : integer
$min integer Lower limit.
$max integer Upper limit
Résultat integer Random number between $min and $max.

generateRandomString() public méthode

If $chars param is empty, the string will be generated using numbers, letters and special characters.
public generateRandomString ( integer $length, string $chars = '' ) : string
$length integer Length of the generated string.
$chars string A string containing a list of chars that will be uses for generating the random string.
Résultat string Random string with the given $length containing only the provided set of $chars.

generateUserReadableString() public méthode

This method is ok to use for generating random user passwords. (which, of course, should be changed after first login).
public generateUserReadableString ( integer $length ) : string
$length integer Length of the random string.
Résultat string Random string with the given $length.

verifyPasswordHash() public méthode

Verify if the given $hash matches the given $password.
public verifyPasswordHash ( string $password, string $hash ) : boolean
$password string Original, un-hashed, password.
$hash string Hash string to which the check should be made
Résultat boolean True if $password matches the $hash, otherwise false is returned.