(PHP 5 >= 5.3.0, PHP 7)
openssl_decrypt — Decrypts data
$data
, string $method
, string $key
[, int $options = 0
[, string $iv = ""
[, string $tag = ""
[, string $aad = ""
]]]] ) : stringTakes a raw or base64 encoded string and decrypts it using a given method and key.
dataThe encrypted message to be decrypted.
methodThe cipher method. For a list of available cipher methods, use openssl_get_cipher_methods().
keyThe key.
options
options can be one of
OPENSSL_RAW_DATA,
OPENSSL_ZERO_PADDING.
ivA non-NULL Initialization Vector.
tag
The authentication tag in AEAD cipher mode. If it is incorrect, the authentication fails and the function returns FALSE.
The length of the tag is not checked by the function.
It is the caller's responsibility to ensure that the length of the tag
matches the length of the tag retrieved when openssl_encrypt()
has been called. Otherwise the decryption may succeed if the given tag only
matches the start of the proper tag.
aadAdditional authentication data.
The decrypted string on success or FALSE on failure.
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.
| Version | Description |
|---|---|
| 7.1.0 | The tag and aad parameters were added. |
| 5.4.0 |
The raw_output was changed to options.
|
| 5.3.3 |
The iv parameter was added.
|