mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
6bbf2e651d
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@283822 c90b9560-bf6c-de11-be94-00142212c4b1
115 lines
3.2 KiB
XML
115 lines
3.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.mcrypt-get-iv-size" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>mcrypt_get_iv_size</refname>
|
|
<refpurpose>Returns the size of the IV belonging to a specific cipher/mode combination</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>mcrypt_get_iv_size</methodname>
|
|
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Gets the size of the IV belonging to a specific
|
|
<parameter>cipher</parameter>/<parameter>mode</parameter> combination.
|
|
</para>
|
|
<para>
|
|
It is more useful to use the <function>mcrypt_enc_get_iv_size</function>
|
|
function as this uses the resource returned by
|
|
<function>mcrypt_module_open</function>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>cipher</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of the <literal>MCRYPT_ciphername</literal> constants of the name
|
|
of the algorithm as string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>mode</parameter> is one of the MCRYPT_MODE_modename constants
|
|
or one of "ecb", "cbc", "cfb", "ofb", "nofb" or "stream". 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.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the size of the Initialisation Vector (IV) in bytes. On error the
|
|
function returns &false;. If the IV is ignored in the specified cipher/mode
|
|
combination zero is returned.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>mcrypt_get_iv_size</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
echo mcrypt_get_iv_size(MCRYPT_CAST_256, MCRYPT_MODE_CFB) . "\n";
|
|
|
|
echo mcrypt_get_iv_size('des', 'ecb') . "\n";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>mcrypt_get_block_size</function></member>
|
|
<member><function>mcrypt_enc_get_iv_size</function></member>
|
|
<member><function>mcrypt_create_iv</function></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|