php-doc-en/reference/mcrypt/functions/mcrypt-decrypt.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mcrypt.xml, last change in rev 1.7 -->
  <refentry id="function.mcrypt-decrypt">
   <refnamediv>
    <refname>mcrypt_decrypt</refname>
    <refpurpose>Decrypts crypttext with given parameters</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>mcrypt_decrypt</methodname>
      <methodparam><type>string</type><parameter>cipher</parameter></methodparam>
      <methodparam><type>string</type><parameter>key</parameter></methodparam>
      <methodparam><type>string</type><parameter>data</parameter></methodparam>
      <methodparam><type>string</type><parameter>mode</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>mcrypt_decrypt</function> decrypts the data
     and returns the unencrypted data.
    </para>
    <para>
     <parameter>Cipher</parameter> is one of the MCRYPT_ciphername
     constants of the name of the algorithm as string.
    </para>
    <para>
     <parameter>Key</parameter> is the key with which the data
     is encrypted. If it's smaller that the required keysize, it
     is padded with '<literal>\0</literal>'.
    </para>
    <para>
     <parameter>Data</parameter> is the data that will be decrypted
     with the given cipher and mode. If the size of the data is not
     n * blocksize, the data will be padded with '<literal>\0</literal>'.
    </para>
    <para>
     <parameter>Mode</parameter> is one of the MCRYPT_MODE_modename
     constants of one of "ecb", "cbc", "cfb", "ofb", "nofb" or 
     "stream".
    </para>
    <para>
     The <parameter>IV</parameter> parameter is used for the
     initialisation in CBC, CFB, OFB modes, and in some algorithms
     in STREAM mode. If you do not supply an IV, while it is needed
     for an algorithm, the function issues a warning and uses an
     IV with all bytes set to '<literal>\0</literal>'.
    </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
-->