archived-doc-fr/reference/mcrypt/functions/mcrypt-module-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e849a6c4225bd992474793ec6983df7898cae0be Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-open">
 <refnamediv>
  <refname>mcrypt_module_open</refname>
  <refpurpose>Ouvre le module de l'algorithme et du mode à utiliser</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  &warn.deprecated.function-7-1-0.removed-7-2-0;
 </refsynopsisdiv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>mcrypt_module_open</methodname>
   <methodparam><type>string</type><parameter>algorithm</parameter></methodparam>
   <methodparam><type>string</type><parameter>algorithm_directory</parameter></methodparam>
   <methodparam><type>string</type><parameter>mode</parameter></methodparam>
   <methodparam><type>string</type><parameter>mode_directory</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   <function>mcrypt_module_open</function> ouvre le module de l'algorithme
   et du mode à utiliser. Le nom de l'algorithme est spécifié par le paramètre
   <parameter>algorithm</parameter> (par exemple : <literal>"twofish"</literal>),
   ou bien une des constantes <constant>MCRYPT_ciphername</constant>. La bibliothèque est refermée
   en appelant <function>mcrypt_module_close</function>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>algorithm</parameter></term>
    <listitem>
     &mcrypt.parameter.cipher;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>algorithm_directory</parameter></term>
    <listitem>
     <simpara>
      Le paramètre <parameter>algorithm_directory</parameter> est utilisé
      pour localiser le module de cryptage. Lorsqu'on spécifie un
      nom de dossier, il sera utilisé. Si on spécifie une chaîne vide
      (<literal>""</literal>), la valeur définie dans la directive
      <literal>mcrypt.algorithms_dir</literal> du fichier &php.ini; sera
      utilisée. Lorsqu'elle n'est pas définie, le dossier par défaut utilisé
      sera celui dans lequel se trouve la bibliothèque libmcrypt
      (habituellement, <filename>/usr/local/lib/libmcrypt</filename>).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>mode</parameter></term>
    <listitem>
     &mcrypt.parameter.mode;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>mode_directory</parameter></term>
    <listitem>
     <simpara>
      Le paramètre <parameter>mode_directory</parameter> est utilisé pour localiser
      le module de cryptage. Si un nom de dossier est spécifié, il sera utilisé.
      Lorsqu'on spécifie une chaîne vide (<literal>""</literal>), la valeur
      de la directive <literal>mcrypt.modes_dir</literal> du fichier &php.ini;
      sera utilisée. Si elle n'est pas définie, le dossier par défaut utilisé
      sera celui dans lequel se trouve la bibliothèque libmcrypt
      (habituellement <filename>/usr/local/lib/libmcrypt</filename>).
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Normalement, cette fonction retourne un descripteur de cryptage, ou
   &false; si une erreur survient.
  </simpara>
 </refsect1>


 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>mcrypt_module_open</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$td = mcrypt_module_open(MCRYPT_DES, '',
    MCRYPT_MODE_ECB, '/usr/lib/mcrypt-modes');

$td = mcrypt_module_open('rijndael-256', '', 'ofb', '');
?>
]]>
   </programlisting>
  </example>
  <simpara>
   La première ligne de l'exemple ci-dessus va essayer d'ouvrir le chiffrement
   <literal>DES</literal>, dans le dossier par défaut, et le mode <literal>ECB</literal> dans le dossier
   <filename>/usr/lib/mcrypt-modes</filename>. Le second exemple utilise
   les chaînes comme nom pour le chiffrement et le mode. Cela ne fonctionne
   que si l'extension est compilée avec libmcrypt 2.4.x ou 2.5.x.
  </simpara>
  <example>
   <title>Utilisation de <function>mcrypt_module_open</function> pour chiffrer</title>
   <programlisting role="php">
<![CDATA[
<?php
/* Charge un chiffrement */
$td = mcrypt_module_open('rijndael-256', '', 'ofb', '');

/* Crée le VI et détermine la taille de la clé */
$iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_DEV_RANDOM);
$ks = mcrypt_enc_get_key_size($td);

/* Crée la clé (exemple uniquement : MD5 n'est pas un bon algorithme de hachage pour cela) */
$key = substr(hash('md5', 'very secret key'), 0, $ks);

/* Initialise le chiffrement */
mcrypt_generic_init($td, $key, $iv);

/* Chiffre les données */
$encrypted = mcrypt_generic($td, 'This is very important data');

/* Libère le gestionnaire de chiffrement */
mcrypt_generic_deinit($td);

/* Initialise le module de chiffrement pour le déchiffrement */
mcrypt_generic_init($td, $key, $iv);

/* Déchiffre les données */
$decrypted = mdecrypt_generic($td, $encrypted);

/* Libère le gestionnaire de déchiffrement, et ferme le module */
mcrypt_generic_deinit($td);
mcrypt_module_close($td);

/* Affiche la chaîne */
echo trim($decrypted)."\n";
?>
]]>
   </programlisting>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>mcrypt_module_close</function></member>
   <member><function>mcrypt_generic</function></member>
   <member><function>mdecrypt_generic</function></member>
   <member><function>mcrypt_generic_init</function></member>
   <member><function>mcrypt_generic_deinit</function></member>
  </simplelist>
 </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
-->