php-doc-en/reference/mcrypt/functions/mcrypt-module-open.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
  <refentry id="function.mcrypt-module-open">
   <refnamediv>
    <refname>mcrypt_module_open</refname>
    <refpurpose>Opens the module of the algorithm and the mode to be used</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <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>
    <para>
     This function opens the module of the algorithm and the mode to be used.
     The name of the algorithm is specified in algorithm, eg. "twofish" or is
     one of the MCRYPT_ciphername constants.  The module is closed by calling
     <function>mcrypt_module_close</function>. Normally it returns an
     encryption descriptor, or &false; on error.
    </para>
    <para>
     The <parameter>algorithm_directory</parameter> and
     <parameter>mode_directory</parameter> are used to locate the encryption
     modules. When you supply a directory name, it is used.  When you set one
     of these to the empty string (""), the value set by the
     <parameter>mcrypt.algorithms_dir</parameter> or
     <parameter>mcrypt.modes_dir</parameter> ini-directive is used.  When
     these are not set, the default directories that are used are the ones
     that were compiled in into libmcrypt (usally /usr/local/lib/libmcrypt).
    </para>
    <para>
     <example>
      <title><function>mcrypt_module_open</function> examples</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>
    </para>
    <para>
     The first line in the example above will try to open the DES cipher from
     the default directory and the EBC mode from the directory
     <filename>/usr/lib/mcrypt-modes</filename>. The second example uses
     strings as name for the cipher an dmode, this only works when the
     extension is linked against libmcrypt 2.4.x or 2.5.x.
    </para>
    <para>
     <example>
      <title>Using <function>mcrypt_module_open</function> in encryption</title>
      <programlisting role="php">
<![CDATA[
<?php
    /* Open the cipher */
    $td = mcrypt_module_open ('rijndael-256', '', 'ofb', '');

    /* Create the IV and determine the keysize length */
    $iv = mcrypt_create_iv (mcrypt_enc_get_iv_size($td), MCRYPT_DEV_RANDOM);
    $ks = mcrypt_enc_get_key_size ($td);

    /* Create key */
    $key = substr (md5 ('very secret key'), 0, $ks);

    /* Intialize encryption */
    mcrypt_generic_init ($td, $key, $iv);

    /* Encrypt data */
    $encrypted = mcrypt_generic ($td, 'This is very important data');

    /* Terminate encryption handler */
    mcrypt_generic_deinit ($td);

    /* Initialize encryption module for decryption */
    mcrypt_generic_init ($td, $key, $iv);

    /* Decrypt encrypted string */
    $decrypted = mdecrypt_generic ($td, $encrypted);

    /* Terminate decryption handle and close module */
    mcrypt_generic_deinit ($td);
    mcrypt_module_close ($td);

    /* Show string */
    echo trim ($decrypted)."\n";
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     The first line in the example above will try to open the DES cipher from
     the default directory and the EBC mode from the directory
     <filename>/usr/lib/mcrypt-modes</filename>. The second example uses
     strings as name for the cipher and mode, this only works when the
     extension is linked against libmcrypt 2.4.x or 2.5.x.
    </para>
    <para>
     See also 
     <function>mcrypt_module_close</function>,
     <function>mcrypt_generic</function>,
     <function>mdecrypt_generic</function>,
     <function>mcrypt_generic_init</function>, and
     <function>mcrypt_generic_deinit</function>.
    </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
-->