php8.5
Home/ Manual/ mcrypt / functions/ mcrypt_get_iv_size

mcrypt_get_iv_size

PHP function Edit on GitHub ✎

(PHP 4 >= 4.0.2, PHP 5, PHP 7 < 7.2.0, PECL mcrypt >= 1.0.0)

Returns the size of the IV belonging to a specific cipher/mode combination

Removed-7-2-0

Description

mcrypt_get_iv_size(string $cipher, string $mode): int

Gets the size of the IV belonging to a specific cipher/mode combination.

It is more useful to use the mcrypt_enc_get_iv_size() function as this uses the resource returned by mcrypt_module_open().

Parameters

cipher

Cipher

mode

Mode

The IV is ignored in ECB mode as this mode does not require it. You will need to have the same IV (think: starting point) both at encryption and decryption stages, otherwise your encryption will fail.

Return Values

Returns the size of the Initialization Vector (IV) in bytes. On error the function returns false. If the IV is ignored in the specified cipher/mode combination zero is returned.

Examples

mcrypt_get_iv_size() Example

php
<?php
    echo mcrypt_get_iv_size(MCRYPT_CAST_256, MCRYPT_MODE_CFB) . "\n";

    echo mcrypt_get_iv_size('des', 'ecb') . "\n";
?>

See Also

Source: reference/mcrypt/functions/mcrypt-get-iv-size.xml · from the official PHP manual (php/doc-en)