openssl_decrypt
openssl_decrypt
(PHP 5 >= 5.3.0, PHP 7)
openssl_decrypt — Decrypts data
Description
string openssl_decrypt ( string $data , string $method , string $key [, int $options = 0 [, string $iv = "" [, string $tag = "" [, string $aad = "" ]]]] )
Takes a raw or base64 encoded string and decrypts it using a given method and key.
This function is currently not documented; only its argument list is available.
Parameters
-
data
-
The data.
-
method
-
The cipher method.
-
key
-
The key.
-
options
-
options
can be one ofOPENSSL_RAW_DATA
,OPENSSL_ZERO_PADDING
. -
iv
-
A non-NULL Initialization Vector.
-
tag
-
The authentication tag in AEAD cipher mode. If it is incorrect, the authentication fails and the function returns
FALSE
. -
aad
-
Additional authentication data.
Return Values
The decrypted string on success or FALSE
on failure.
Errors/Exceptions
Emits an E_WARNING
level error if an unknown cipher algorithm is passed via the method
parameter.
Emits an E_WARNING
level error if an empty value is passed in via the iv
parameter.
Changelog
Version | Description |
---|---|
5.3.3 | The iv parameter was added. |
5.4.0 | The raw_output was changed to options . |
7.1.0 | The tag and aad parameters were added. |
See Also
- openssl_encrypt() - Encrypts data
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/function.openssl-decrypt.php