2002-04-15 00:12:54 +00:00
|
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
2002-04-17 06:45:35 +00:00
|
|
|
<!-- $Revision: 1.2 $ -->
|
2002-04-15 00:12:54 +00:00
|
|
|
<!-- 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>This function 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 library is closed by calling
|
|
|
|
|
<function>mcrypt_module_close</function>, but there is no need
|
|
|
|
|
to call that function if <function>mcrypt_generic_end</function>
|
|
|
|
|
is called. 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 directory are used that are
|
|
|
|
|
compiled in into libmcrypt (usally /usr/local/lib/libmcrypt).
|
|
|
|
|
</para>
|
|
|
|
|
<para>
|
|
|
|
|
<example>
|
|
|
|
|
<title><function>mcrypt_module_open</function> Example</title>
|
|
|
|
|
<programlisting role="php">
|
|
|
|
|
<![CDATA[
|
|
|
|
|
<?php
|
|
|
|
|
$td = mcrypt_module_open (MCRYPT_DES, "", MCRYPT_MODE_ECB, "/usr/lib/mcrypt-modes");
|
|
|
|
|
?>
|
|
|
|
|
]]>
|
|
|
|
|
</programlisting>
|
|
|
|
|
<para>
|
|
|
|
|
The above example will try to open the DES cipher
|
|
|
|
|
from the default directory and the EBC mode from the directory
|
|
|
|
|
<filename>/usr/lib/mcrypt-modes</filename>.
|
|
|
|
|
</para>
|
|
|
|
|
</example>
|
|
|
|
|
</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
|
|
|
|
|
-->
|
