mcrypt-get-iv-size.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e41806c30bf6975e452c0d4ce35ab0984c2fa68c Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.mcrypt-get-iv-size" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mcrypt_get_iv_size</refname>
  <refpurpose>Retourne la taille du VI utilisé par un couple chiffrement/mode</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  &warn.deprecated.function-7-1-0.removed-7-2-0;
 </refsynopsisdiv>

 <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>
   <function>mcrypt_get_iv_size</function> retourne la taille du
   vecteur d'initialisation (VI). Si l'algorithme n'utilise
   pas de vecteur d'initialisation, zéro est retourné.
  </para>
  <para>
   Il est plus utile d'utiliser la fonction <function>mcrypt_enc_get_iv_size</function>,
   car elle utilise la ressource retournée par <function>mcrypt_module_open</function>.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>cipher</parameter></term>
     <listitem>
      &mcrypt.parameter.cipher;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      &mcrypt.parameter.mode;
      <para>
       IV est ignoré en mode ECB sachant que ce mode ne le demande pas.
       Vous devez avoir le même IV (point de départ) lors du chiffrement
       et du déchiffrement, sinon, votre chiffrage échouera.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la taille du vecteur d'initialisation (IV), en octets. 
   En cas d'erreur, la fonction retourne &false;. Si le vecteur d'initialisation
   est inutile, 0 est retourné.
  </para>
 </refsect1>
  
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>mcrypt_get_iv_size</function></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:"~/.phpdoc/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
-->