<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <HTML ><HEAD ><TITLE >mcrypt_module_open</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK REL="HOME" TITLE="Manual do PHP" HREF="index.html"><LINK REL="UP" TITLE="Mcrypt Encryption Functions" HREF="ref.mcrypt.html"><LINK REL="PREVIOUS" TITLE="mcrypt_module_is_block_mode" HREF="function.mcrypt-module-is-block-mode.html"><LINK REL="NEXT" TITLE="mcrypt_module_self_test" HREF="function.mcrypt-module-self-test.html"><META HTTP-EQUIV="Content-type" CONTENT="text/html; charset=UTF-8"></HEAD ><BODY CLASS="refentry" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >Manual do PHP</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="function.mcrypt-module-is-block-mode.html" ACCESSKEY="P" >Anterior</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="function.mcrypt-module-self-test.html" ACCESSKEY="N" >Próxima</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><H1 ><A NAME="function.mcrypt-module-open" ></A >mcrypt_module_open</H1 ><DIV CLASS="refnamediv" ><A NAME="AEN112309" ></A ><P > (PHP 4 >= 4.0.2, PHP 5)</P >mcrypt_module_open -- Opens the module of the algorithm and the mode to be used</DIV ><DIV CLASS="refsect1" ><A NAME="AEN112312" ></A ><H2 >Description</H2 >resource <B CLASS="methodname" >mcrypt_module_open</B > ( string algorithm, string algorithm_directory, string mode, string mode_directory )<BR ></BR ><P > This function opens the module of the algorithm and the mode to be used. The name of the algorithm is specified in algorithm, e.g. "twofish" or is one of the MCRYPT_ciphername constants. The module is closed by calling <A HREF="function.mcrypt-module-close.html" ><B CLASS="function" >mcrypt_module_close()</B ></A >. Normally it returns an encryption descriptor, or <TT CLASS="constant" ><B >FALSE</B ></TT > on error. </P ><P > The <CODE CLASS="parameter" >algorithm_directory</CODE > and <CODE CLASS="parameter" >mode_directory</CODE > 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 <CODE CLASS="parameter" >mcrypt.algorithms_dir</CODE > or <CODE CLASS="parameter" >mcrypt.modes_dir</CODE > ini-directive is used. When these are not set, the default directories that are used are the ones that were compiled in into libmcrypt (usually /usr/local/lib/libmcrypt). </P ><P > <TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" CLASS="EXAMPLE" ><TR ><TD ><DIV CLASS="example" ><A NAME="AEN112338" ></A ><P ><B >Exemplo 1. <B CLASS="function" >mcrypt_module_open()</B > examples</B ></P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" CELLPADDING="5" ><TR ><TD ><code><font color="#000000"> <font color="#0000BB"><?php<br /> $td </font><font color="#007700">= </font><font color="#0000BB">mcrypt_module_open</font><font color="#007700">(</font><font color="#0000BB">MCRYPT_DES</font><font color="#007700">, </font><font color="#DD0000">''</font><font color="#007700">,<br /> </font><font color="#0000BB">MCRYPT_MODE_ECB</font><font color="#007700">, </font><font color="#DD0000">'/usr/lib/mcrypt-modes'</font><font color="#007700">);<br /><br /> </font><font color="#0000BB">$td </font><font color="#007700">= </font><font color="#0000BB">mcrypt_module_open</font><font color="#007700">(</font><font color="#DD0000">'rijndael-256'</font><font color="#007700">, </font><font color="#DD0000">''</font><font color="#007700">, </font><font color="#DD0000">'ofb'</font><font color="#007700">, </font><font color="#DD0000">''</font><font color="#007700">);<br /></font><font color="#0000BB">?></font> </font> </code></TD ></TR ></TABLE ></DIV ></TD ></TR ></TABLE > </P ><P > 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 <TT CLASS="filename" >/usr/lib/mcrypt-modes</TT >. 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. </P ><P > <TABLE WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" CLASS="EXAMPLE" ><TR ><TD ><DIV CLASS="example" ><A NAME="AEN112345" ></A ><P ><B >Exemplo 2. Using <B CLASS="function" >mcrypt_module_open()</B > in encryption</B ></P ><TABLE BORDER="0" BGCOLOR="#E0E0E0" CELLPADDING="5" ><TR ><TD ><code><font color="#000000"> <font color="#0000BB"><?php<br /> </font><font color="#FF8000">/* Open the cipher */<br /> </font><font color="#0000BB">$td </font><font color="#007700">= </font><font color="#0000BB">mcrypt_module_open</font><font color="#007700">(</font><font color="#DD0000">'rijndael-256'</font><font color="#007700">, </font><font color="#DD0000">''</font><font color="#007700">, </font><font color="#DD0000">'ofb'</font><font color="#007700">, </font><font color="#DD0000">''</font><font color="#007700">);<br /><br /> </font><font color="#FF8000">/* Create the IV and determine the keysize length, used MCRYPT_RAND<br /> * on Windows instead */<br /> </font><font color="#0000BB">$iv </font><font color="#007700">= </font><font color="#0000BB">mcrypt_create_iv</font><font color="#007700">(</font><font color="#0000BB">mcrypt_enc_get_iv_size</font><font color="#007700">(</font><font color="#0000BB">$td</font><font color="#007700">), </font><font color="#0000BB">MCRYPT_DEV_RANDOM</font><font color="#007700">);<br /> </font><font color="#0000BB">$ks </font><font color="#007700">= </font><font color="#0000BB">mcrypt_enc_get_key_size</font><font color="#007700">(</font><font color="#0000BB">$td</font><font color="#007700">);<br /><br /> </font><font color="#FF8000">/* Create key */<br /> </font><font color="#0000BB">$key </font><font color="#007700">= </font><font color="#0000BB">substr</font><font color="#007700">(</font><font color="#0000BB">md5</font><font color="#007700">(</font><font color="#DD0000">'very secret key'</font><font color="#007700">), </font><font color="#0000BB">0</font><font color="#007700">, </font><font color="#0000BB">$ks</font><font color="#007700">);<br /><br /> </font><font color="#FF8000">/* Intialize encryption */<br /> </font><font color="#0000BB">mcrypt_generic_init</font><font color="#007700">(</font><font color="#0000BB">$td</font><font color="#007700">, </font><font color="#0000BB">$key</font><font color="#007700">, </font><font color="#0000BB">$iv</font><font color="#007700">);<br /><br /> </font><font color="#FF8000">/* Encrypt data */<br /> </font><font color="#0000BB">$encrypted </font><font color="#007700">= </font><font color="#0000BB">mcrypt_generic</font><font color="#007700">(</font><font color="#0000BB">$td</font><font color="#007700">, </font><font color="#DD0000">'This is very important data'</font><font color="#007700">);<br /><br /> </font><font color="#FF8000">/* Terminate encryption handler */<br /> </font><font color="#0000BB">mcrypt_generic_deinit</font><font color="#007700">(</font><font color="#0000BB">$td</font><font color="#007700">);<br /><br /> </font><font color="#FF8000">/* Initialize encryption module for decryption */<br /> </font><font color="#0000BB">mcrypt_generic_init</font><font color="#007700">(</font><font color="#0000BB">$td</font><font color="#007700">, </font><font color="#0000BB">$key</font><font color="#007700">, </font><font color="#0000BB">$iv</font><font color="#007700">);<br /><br /> </font><font color="#FF8000">/* Decrypt encrypted string */<br /> </font><font color="#0000BB">$decrypted </font><font color="#007700">= </font><font color="#0000BB">mdecrypt_generic</font><font color="#007700">(</font><font color="#0000BB">$td</font><font color="#007700">, </font><font color="#0000BB">$encrypted</font><font color="#007700">);<br /><br /> </font><font color="#FF8000">/* Terminate decryption handle and close module */<br /> </font><font color="#0000BB">mcrypt_generic_deinit</font><font color="#007700">(</font><font color="#0000BB">$td</font><font color="#007700">);<br /> </font><font color="#0000BB">mcrypt_module_close</font><font color="#007700">(</font><font color="#0000BB">$td</font><font color="#007700">);<br /><br /> </font><font color="#FF8000">/* Show string */<br /> </font><font color="#007700">echo </font><font color="#0000BB">trim</font><font color="#007700">(</font><font color="#0000BB">$decrypted</font><font color="#007700">) . </font><font color="#DD0000">"\n"</font><font color="#007700">;<br /></font><font color="#0000BB">?></font> </font> </code></TD ></TR ></TABLE ></DIV ></TD ></TR ></TABLE > </P ><P > 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 <TT CLASS="filename" >/usr/lib/mcrypt-modes</TT >. 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. </P ><P > See also <A HREF="function.mcrypt-module-close.html" ><B CLASS="function" >mcrypt_module_close()</B ></A >, <A HREF="function.mcrypt-generic.html" ><B CLASS="function" >mcrypt_generic()</B ></A >, <A HREF="function.mdecrypt-generic.html" ><B CLASS="function" >mdecrypt_generic()</B ></A >, <A HREF="function.mcrypt-generic-init.html" ><B CLASS="function" >mcrypt_generic_init()</B ></A >, and <A HREF="function.mcrypt-generic-deinit.html" ><B CLASS="function" >mcrypt_generic_deinit()</B ></A >. </P ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="function.mcrypt-module-is-block-mode.html" ACCESSKEY="P" >Anterior</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Principal</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="function.mcrypt-module-self-test.html" ACCESSKEY="N" >Próxima</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >mcrypt_module_is_block_mode</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="ref.mcrypt.html" ACCESSKEY="U" >Acima</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >mcrypt_module_self_test</TD ></TR ></TABLE ></DIV ></BODY ></HTML >