Class Security
Security Library contains utility methods related to security
Property Summary
-
$_instance protected static
objectThe crypto implementation to use.
-
$_salt protected static
stringThe HMAC salt to use for encryption and decryption routines
-
$hashType public static
stringDefault hash method. If
$typeparam forSecurity::hash()is not specified this value is used. Defaults to 'sha1'.
Method Summary
-
_checkKey() protected static
Check the encryption key for proper length.
-
_constantEquals() protected static
A timing attack resistant comparison that prefers native PHP implementations.
-
decrypt() public static
Decrypt a value using AES-256.
-
encrypt() public static
Encrypt a value using AES-256.
-
engine() public static
Get the crypto implementation based on the loaded extensions.
-
hash() public static
Create a hash from string using given method.
-
rijndael() public static
Encrypts/Decrypts a text using the given key using rijndael method.
-
salt() public static
Gets or sets the HMAC salt to be used for encryption/decryption routines.
-
setHash() public static
Sets the default hash method for the Security object. This affects all objects using Security::hash().
Method Detail
_checkKey() ¶ protected static
_checkKey(string $key, string $method): voidCheck the encryption key for proper length.
Parameters
-
string$key Key to check.
-
string$method The method the key is being checked for.
Returns
voidThrows
InvalidArgumentExceptionWhen key length is not 256 bit/32 bytes
_constantEquals() ¶ protected static
_constantEquals(string $hmac, string $compare): boolA timing attack resistant comparison that prefers native PHP implementations.
Parameters
-
string$hmac The hmac from the ciphertext being decrypted.
-
string$compare The comparison hmac.
Returns
boolSee Also
decrypt() ¶ public static
decrypt(string $cipher, string $key, string|null $hmacSalt = null): stringDecrypt a value using AES-256.
Parameters
-
string$cipher The ciphertext to decrypt.
-
string$key The 256 bit/32 byte key to use as a cipher key.
-
string|null$hmacSalt optional The salt to use for the HMAC process. Leave null to use Security.salt.
Returns
stringDecrypted data. Any trailing null bytes will be removed.
Throws
InvalidArgumentExceptionOn invalid data or key.
encrypt() ¶ public static
encrypt(string $plain, string $key, string|null $hmacSalt = null): stringEncrypt a value using AES-256.
Caveat You cannot properly encrypt/decrypt data with trailing null bytes. Any trailing null bytes will be removed on decryption due to how PHP pads messages with nulls prior to encryption.
Parameters
-
string$plain The value to encrypt.
-
string$key The 256 bit/32 byte key to use as a cipher key.
-
string|null$hmacSalt optional The salt to use for the HMAC process. Leave null to use Security.salt.
Returns
stringEncrypted data.
Throws
InvalidArgumentExceptionOn invalid data or key.
engine() ¶ public static
engine(object $instance = null): objectGet the crypto implementation based on the loaded extensions.
You can use this method to forcibly decide between mcrypt/openssl/custom implementations.
Parameters
-
object$instance optional The crypto instance to use.
Returns
objectCrypto instance.
Throws
InvalidArgumentExceptionWhen no compatible crypto extension is available.
hash() ¶ public static
hash(string $string, string|null $type = null, mixed $salt = false): stringCreate a hash from string using given method.
Parameters
-
string$string String to hash
-
string|null$type optional Hashing algo to use (i.e. sha1, sha256 etc.). Can be any valid algo included in list returned by hash_algos(). If no value is passed the type specified by
Security::$hashTypeis used.-
mixed$salt optional If true, automatically prepends the application's salt value to $string (Security.salt).
Returns
stringHash
Links
rijndael() ¶ public static
rijndael(string $text, string $key, string $operation): stringEncrypts/Decrypts a text using the given key using rijndael method.
Parameters
-
string$text Encrypted string to decrypt, normal string to encrypt
-
string$key Key to use as the encryption key for encrypted data.
-
string$operation Operation to perform, encrypt or decrypt
Returns
stringEncrypted/Decrypted string
Throws
InvalidArgumentExceptionWhen there are errors.
salt() ¶ public static
salt(string|null $salt = null): stringGets or sets the HMAC salt to be used for encryption/decryption routines.
Parameters
-
string|null$salt optional The salt to use for encryption routines. If null returns current salt.
Returns
stringThe currently configured salt
setHash() ¶ public static
setHash(string $hash): voidSets the default hash method for the Security object. This affects all objects using Security::hash().
Parameters
-
string$hash Method to use (sha1/sha256/md5 etc.)
Returns
voidSee Also
Property Detail
$hashType ¶ public static
Default hash method. If $type param for Security::hash() is not specified
this value is used. Defaults to 'sha1'.
Type
string