php/archived-doc-en
1
0
Fork 0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

mcrypt : fix XML by converting para to simpara tags via script

Browse Source
This commit is contained in:
Gina Peter Banyard
2026-01-19 03:13:21 +00:00
parent 6126b024cb
commit e849a6c422
37 changed files with 294 additions and 305 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
reference/mcrypt/book.xml
View File

@@ -1,10 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<book xml:id="book.mcrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.mcrypt">
<?phpdoc extension-membership="pecl" ?>
<title>Mcrypt</title>
<!-- {{{ preface -->
<preface xml:id="intro.mcrypt">
&reftitle.intro;
@@ -22,29 +21,28 @@
</warning>
<note>
<para>
<simpara>
&pecl.moved-ver;7.2.0.
</para>
</simpara>
</note>
<para>
<simpara>
This is an interface to the mcrypt library, which supports a wide
variety of block algorithms such as DES, TripleDES, Blowfish
(default), 3-WAY, SAFER-SK64, SAFER-SK128, TWOFISH, TEA, RC2 and
GOST in CBC, OFB, CFB and ECB cipher modes. Additionally, it
supports RC6 and IDEA which are considered "non-free".
CFB/OFB are 8bit by default.
</para>
</simpara>
</preface>
<!-- }}} -->
&reference.mcrypt.setup;
&reference.mcrypt.constants;
&reference.mcrypt.ciphers;
&reference.mcrypt.reference;
</book>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -65,4 +63,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

43
reference/mcrypt/ciphers.xml
View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="mcrypt.ciphers" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<appendix xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="mcrypt.ciphers">
<title>Mcrypt ciphers</title>
<para>
Here is a list of ciphers which are currently supported by the mcrypt
@@ -13,49 +12,49 @@
call to <function>mcrypt_module_open</function>.
<itemizedlist>
<listitem><simpara>MCRYPT_3DES</simpara></listitem>
<listitem><simpara>MCRYPT_ARCFOUR_IV (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_ARCFOUR (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_ARCFOUR_IV (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_ARCFOUR (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_BLOWFISH</simpara></listitem>
<listitem><simpara>MCRYPT_CAST_128</simpara></listitem>
<listitem><simpara>MCRYPT_CAST_256</simpara></listitem>
<listitem><simpara>MCRYPT_CRYPT</simpara></listitem>
<listitem><simpara>MCRYPT_DES</simpara></listitem>
<listitem><simpara>MCRYPT_DES_COMPAT (libmcrypt 2.2.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_ENIGMA (libmcrypt > 2.4.x only, alias for MCRYPT_CRYPT)</simpara></listitem>
<listitem><simpara>MCRYPT_ENIGMA (libmcrypt &gt; 2.4.x only, alias for MCRYPT_CRYPT)</simpara></listitem>
<listitem><simpara>MCRYPT_GOST</simpara></listitem>
<listitem><simpara>MCRYPT_IDEA (non-free)</simpara></listitem>
<listitem><simpara>MCRYPT_LOKI97 (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_MARS (libmcrypt > 2.4.x only, non-free)</simpara></listitem>
<listitem><simpara>MCRYPT_PANAMA (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RIJNDAEL_128 (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RIJNDAEL_192 (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RIJNDAEL_256 (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_LOKI97 (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_MARS (libmcrypt &gt; 2.4.x only, non-free)</simpara></listitem>
<listitem><simpara>MCRYPT_PANAMA (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RIJNDAEL_128 (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RIJNDAEL_192 (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RIJNDAEL_256 (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RC2</simpara></listitem>
<listitem><simpara>MCRYPT_RC4 (libmcrypt 2.2.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RC6 (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RC6 (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RC6_128 (libmcrypt 2.2.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RC6_192 (libmcrypt 2.2.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_RC6_256 (libmcrypt 2.2.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_SAFER64</simpara></listitem>
<listitem><simpara>MCRYPT_SAFER128</simpara></listitem>
<listitem><simpara>MCRYPT_SAFERPLUS (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_SERPENT(libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_SAFERPLUS (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_SERPENT(libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_SERPENT_128 (libmcrypt 2.2.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_SERPENT_192 (libmcrypt 2.2.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_SERPENT_256 (libmcrypt 2.2.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_SKIPJACK (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_SKIPJACK (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_TEAN (libmcrypt 2.2.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_THREEWAY</simpara></listitem>
<listitem><simpara>MCRYPT_TRIPLEDES (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_TWOFISH (for older mcrypt 2.x versions, or mcrypt > 2.4.x )</simpara></listitem>
<listitem><simpara>MCRYPT_TRIPLEDES (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_TWOFISH (for older mcrypt 2.x versions, or mcrypt &gt; 2.4.x )</simpara></listitem>
<listitem><simpara>MCRYPT_TWOFISH128 (TWOFISHxxx are available in newer 2.x versions, but not in the 2.4.x versions)</simpara></listitem>
<listitem><simpara>MCRYPT_TWOFISH192</simpara></listitem>
<listitem><simpara>MCRYPT_TWOFISH256</simpara></listitem>
<listitem><simpara>MCRYPT_WAKE (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_XTEA (libmcrypt > 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_WAKE (libmcrypt &gt; 2.4.x only)</simpara></listitem>
<listitem><simpara>MCRYPT_XTEA (libmcrypt &gt; 2.4.x only)</simpara></listitem>
</itemizedlist>
</para>
<para>
<simpara>
You must (in <constant>CFB</constant> and <constant>OFB</constant> mode)
or can (in <constant>CBC</constant> mode) supply an
initialization vector (IV) to the respective cipher function. The
@@ -66,9 +65,8 @@
Alternatively, you can transmit the IV together with the encrypted
data (see chapter 9.3 of &book.applied.cryptography; for a
discussion of this topic).
</para>
</simpara>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -89,4 +87,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

11
reference/mcrypt/configure.xml
View File

@@ -1,16 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="mcrypt.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="mcrypt.installation">
&reftitle.install;
<para>
<simpara>
&pecl.moved-ver;7.2.0
</para>
<para>
</simpara>
<simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;mcrypt">&url.pecl.package;mcrypt</link>.
</para>
</simpara>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

24
reference/mcrypt/functions/mcrypt-create-iv.xml
View File

@@ -22,15 +22,15 @@
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>source</parameter><initializer>MCRYPT_DEV_URANDOM</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Creates an initialization vector (IV) from a random source.
</para>
<para>
</simpara>
<simpara>
The IV is only meant to give an alternative seed to the encryption
routines. This IV does not need to be secret at all, though it can be
desirable. You even can send it along with your ciphertext without
losing security.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -39,15 +39,15 @@
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
<simpara>
The size of the IV.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem>
<para>
<simpara>
The source of the IV. The source can be
<constant>MCRYPT_RAND</constant> (system random number generator),
<constant>MCRYPT_DEV_RANDOM</constant> (read data from
@@ -55,11 +55,11 @@
<constant>MCRYPT_DEV_URANDOM</constant> (read data from
<filename>/dev/urandom</filename>). Prior to 5.3.0,
<constant>MCRYPT_RAND</constant> was the only one supported on Windows.
</para>
<para>
</simpara>
<simpara>
Note that the default value of this parameter was
<constant>MCRYPT_DEV_RANDOM</constant> prior to PHP 5.6.0.
</para>
</simpara>
<note>
<simpara>
Note that <constant>MCRYPT_DEV_RANDOM</constant> may block until more
@@ -73,9 +73,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the initialization vector, or &false; on error.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

16
reference/mcrypt/functions/mcrypt-decrypt.xml
View File

@@ -18,9 +18,9 @@
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Decrypts the <parameter>data</parameter> and returns the unencrypted data.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -34,20 +34,20 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
The key with which the data was encrypted. If the provided key size is
not supported by the cipher, the function will emit a warning and return &false;
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
The data that will be decrypted with the given <parameter>cipher</parameter>
and <parameter>mode</parameter>. If the size of the data is not n * blocksize,
the data will be padded with '<literal>\0</literal>'.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -67,9 +67,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the decrypted data as a string &return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

12
reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml
View File

@@ -16,9 +16,9 @@
<type>string</type><methodname>mcrypt_enc_get_algorithms_name</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function returns the name of the algorithm.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,9 +27,9 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the name of the opened algorithm as a string.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

12
reference/mcrypt/functions/mcrypt-enc-get-block-size.xml
View File

@@ -14,9 +14,9 @@
<type>int</type><methodname>mcrypt_enc_get_block_size</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the blocksize of the opened algorithm.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,18 +24,18 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the block size of the specified algorithm in bytes.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml
View File

@@ -14,11 +14,11 @@
<type>int</type><methodname>mcrypt_enc_get_iv_size</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function returns the size of the IV of the algorithm specified by the
encryption descriptor in bytes. An IV is used in cbc, cfb and ofb modes,
and in some algorithms in stream mode.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -26,18 +26,18 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the size of the IV, or 0 if the IV is ignored by the algorithm.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/mcrypt/functions/mcrypt-enc-get-key-size.xml
View File

@@ -14,9 +14,9 @@
<type>int</type><methodname>mcrypt_enc_get_key_size</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the maximum supported key size of the algorithm in bytes.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,18 +24,18 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the maximum supported key size of the algorithm in bytes.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml
View File

@@ -14,9 +14,9 @@
<type>string</type><methodname>mcrypt_enc_get_modes_name</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function returns the name of the mode.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,18 +24,18 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the name as a string.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;

12
reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml
View File

@@ -16,9 +16,9 @@
<type>array</type><methodname>mcrypt_enc_get_supported_key_sizes</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the supported key sizes of the opened algorithm.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,9 +27,9 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,13 +37,13 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array with the key sizes supported by the algorithm
specified by the encryption descriptor. If it returns an empty
array then all key sizes between 1 and
<function>mcrypt_enc_get_key_size</function> are supported by the
algorithm.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

12
reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml
View File

@@ -14,10 +14,10 @@
<type>bool</type><methodname>mcrypt_enc_is_block_algorithm_mode</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Tells whether the algorithm of the opened mode works on blocks (e.g.
&false; for stream, and &true; for cbc, cfb, ofb)..
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,19 +25,19 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if the mode is for use with block algorithms, otherwise it
returns &false;.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml
View File

@@ -14,9 +14,9 @@
<type>bool</type><methodname>mcrypt_enc_is_block_algorithm</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Tells whether the algorithm of the opened mode is a block algorithm.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,19 +24,19 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if the algorithm is a block algorithm or &false; if it is
a stream one.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml
View File

@@ -14,10 +14,10 @@
<type>bool</type><methodname>mcrypt_enc_is_block_mode</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Tells whether the opened mode outputs blocks (e.g. &true; for cbc and ecb,
and &false; for cfb and stream).
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,19 +25,19 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns &true; if the mode outputs blocks of bytes,
or &false; if it outputs just bytes.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/mcrypt/functions/mcrypt-enc-self-test.xml
View File

@@ -14,10 +14,10 @@
<type>int</type><methodname>mcrypt_enc_self_test</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function runs the self test on the algorithm specified by the
descriptor <parameter>td</parameter>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,18 +25,18 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns <literal>0</literal> on success and a negative &integer; on failure.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/mcrypt/functions/mcrypt-encrypt.xml
View File

@@ -20,9 +20,9 @@
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>iv</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Encrypts the data and returns it.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -37,24 +37,24 @@
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
The key with which the data will be encrypted. If the provided key size is
not supported by the cipher, the function will emit a warning and return &false;
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
The data that will be encrypted with the given <parameter>cipher</parameter>
and <parameter>mode</parameter>. If the size of the data is not n * blocksize,
the data will be padded with '<literal>\0</literal>'.
</para>
<para>
</simpara>
<simpara>
The returned crypttext can be larger than the size of the data that was
given by <parameter>data</parameter>.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -74,9 +74,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the encrypted data as a string &return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

12
reference/mcrypt/functions/mcrypt-generic-deinit.xml
View File

@@ -14,13 +14,13 @@
<type>bool</type><methodname>mcrypt_generic_deinit</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function terminates encryption specified by the encryption
descriptor (<parameter>td</parameter>). It clears all buffers, but does
not close the module. You need to call
<function>mcrypt_module_close</function> yourself. (But PHP does this for
you at the end of the script.)
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,9 +29,9 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -39,9 +39,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

20
reference/mcrypt/functions/mcrypt-generic-init.xml
View File

@@ -16,11 +16,11 @@
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>iv</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
You need to call this function before every call to
<function>mcrypt_generic</function> or
<function>mdecrypt_generic</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -28,25 +28,25 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<para>
<simpara>
The maximum length of the key should be the one obtained by calling
<function>mcrypt_enc_get_key_size</function> and every value smaller
than this is legal.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>iv</parameter></term>
<listitem>
<para>
<simpara>
The IV should normally have the size of the algorithms block size, but
you must obtain the size by calling
<function>mcrypt_enc_get_iv_size</function>. IV is ignored in ECB. IV
@@ -54,20 +54,20 @@
random and unique (but not secret). The same IV must be used for
encryption/decryption. If you do not want to use it you should set it
to zeros, but this is not recommended.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The function returns a negative value on error: -3 when the key length
was incorrect, -4 when there was a memory allocation problem and any
other return value is an unknown error. If an error occurs a warning will
be displayed accordingly. &false; is returned if incorrect parameters
were passed.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

28
reference/mcrypt/functions/mcrypt-generic.xml
View File

@@ -15,14 +15,14 @@
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function encrypts data. The data is padded with "<literal>\0</literal>"
to make sure the length of the data is n * blocksize. This
function returns the encrypted data. Note that the length
of the returned string can in fact be longer than the input,
due to the padding of the data.
</para>
<para>
</simpara>
<simpara>
If you want to store the encrypted data in a database make sure to store
the entire string as returned by mcrypt_generic, or the string will not
entirely decrypt properly. If your original string is 10 characters long
@@ -31,14 +31,14 @@
blocksize), you would need at least 16 characters in your database field.
Note the string returned by <function>mdecrypt_generic</function> will be
16 characters as well...use rtrim($str, "\0") to remove the padding.
</para>
<para>
</simpara>
<simpara>
If you are for example storing the data in a MySQL database remember that
varchar fields automatically have trailing spaces removed during
insertion. As encrypted data can end in a space (ASCII 32), the data will
be damaged by this removal. Store data in a tinyblob/tinytext (or
larger) field instead.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -47,24 +47,24 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
<para>
</simpara>
<simpara>
The encryption handle should always be initialized with
<function>mcrypt_generic_init</function> with a key and an IV before
calling this function. Where the encryption is done, you should free the
encryption buffers by calling <function>mcrypt_generic_deinit</function>.
See <function>mcrypt_module_open</function> for an example.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
The data to encrypt.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -72,9 +72,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the encrypted data.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

20
reference/mcrypt/functions/mcrypt-get-block-size.xml
View File

@@ -19,20 +19,20 @@
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The first prototype is when linked against libmcrypt 2.2.x, the
second when linked against libmcrypt 2.4.x or 2.5.x.
</para>
<para>
</simpara>
<simpara>
<function>mcrypt_get_block_size</function> is used to get the
size of a block of the specified <parameter>cipher</parameter> (in
combination with an encryption mode).
</para>
<para>
</simpara>
<simpara>
It is more useful to use the <function>mcrypt_enc_get_block_size</function>
function as this uses the resource returned by
<function>mcrypt_module_open</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -55,19 +55,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the algorithm block size in bytes &return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mcrypt_get_block_size</function> example</title>
<para>
<simpara>
This example shows how to use this function when linked against libmcrypt
2.4.x and 2.5.x.
</para>
</simpara>
<programlisting role="php">
<![CDATA[
<?php

12
reference/mcrypt/functions/mcrypt-get-cipher-name.xml
View File

@@ -18,16 +18,16 @@
<type>string</type><methodname>mcrypt_get_cipher_name</methodname>
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>mcrypt_get_cipher_name</function> is used to get the
name of the specified cipher.
</para>
<para>
</simpara>
<simpara>
<function>mcrypt_get_cipher_name</function> takes the cipher
number as an argument (libmcrypt 2.2.x) or takes the cipher name
as an argument (libmcrypt 2.4.x or higher) and returns the name of the cipher
or &false;, if the cipher does not exist.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -43,10 +43,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
This function returns the name of the cipher or &false; if the cipher does
not exist.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

16
reference/mcrypt/functions/mcrypt-get-iv-size.xml
View File

@@ -15,15 +15,15 @@
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the size of the IV belonging to a specific
<parameter>cipher</parameter>/<parameter>mode</parameter> combination.
</para>
<para>
</simpara>
<simpara>
It is more useful to use the <function>mcrypt_enc_get_iv_size</function>
function as this uses the resource returned by
<function>mcrypt_module_open</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -39,11 +39,11 @@
<term><parameter>mode</parameter></term>
<listitem>
&mcrypt.parameter.mode;
<para>
<simpara>
The IV is ignored in ECB mode as this mode does not require it. You will
need to have the same IV (think: starting point) both at encryption and
decryption stages, otherwise your encryption will fail.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,11 +51,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the size of the Initialization Vector (IV) in bytes. On error the
function returns &false;. If the IV is ignored in the specified cipher/mode
combination zero is returned.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

20
reference/mcrypt/functions/mcrypt-get-key-size.xml
View File

@@ -19,19 +19,19 @@
<methodparam><type>string</type><parameter>cipher</parameter></methodparam>
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
The first prototype is when linked against libmcrypt 2.2.x, the
second when linked against libmcrypt 2.4.x or 2.5.x.
</para>
<para>
</simpara>
<simpara>
<function>mcrypt_get_key_size</function> is used to get the size
of a key of the specified <parameter>cipher</parameter> (in
combination with an encryption mode).
</para>
<para>
</simpara>
<simpara>
It is more useful to use the <function>mcrypt_enc_get_key_size</function>
function as this uses the resource returned by <function>mcrypt_module_open</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -54,10 +54,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the maximum supported key size of the algorithm in bytes
&return.falseforfailure;.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -71,10 +71,10 @@
?>
]]>
</programlisting>
<para>
<simpara>
The example above shows how to use this function when
linked against libmcrypt 2.4.x or 2.5.x.
</para>
</simpara>
&example.outputs;
<screen>
<![CDATA[

12
reference/mcrypt/functions/mcrypt-list-algorithms.xml
View File

@@ -14,10 +14,10 @@
<type>array</type><methodname>mcrypt_list_algorithms</methodname>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter><initializer>ini_get("mcrypt.algorithms_dir")</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the list of all supported algorithms in the
<parameter>lib_dir</parameter> parameter.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,11 +26,11 @@
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
<simpara>
Specifies the directory where all algorithms are located. If not
specified, the value of the <literal>mcrypt.algorithms_dir</literal>
&php.ini; directive is used.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +38,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array with all the supported algorithms.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

16
reference/mcrypt/functions/mcrypt-list-modes.xml
View File

@@ -14,10 +14,10 @@
<type>array</type><methodname>mcrypt_list_modes</methodname>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter><initializer>ini_get("mcrypt.modes_dir")</initializer></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the list of all supported modes in the
<parameter>lib_dir</parameter> parameter.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,11 +26,11 @@
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
<simpara>
Specifies the directory where all modes are located. If not
specified, the value of the <literal>mcrypt.modes_dir</literal>
&php.ini; directive is used.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +38,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array with all the supported modes.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -58,13 +58,13 @@
?>
]]>
</programlisting>
<para>
<simpara>
The example above will produce a list with all supported
algorithms in the default mode directory. If it is not set
with the <literal>mcrypt.modes_dir</literal> &php.ini;
directive, the default directory of mcrypt is used (which
is <filename>/usr/local/lib/libmcrypt</filename>).
</para>
</simpara>
</example>
</refsect1>
</refentry>

12
reference/mcrypt/functions/mcrypt-module-close.xml
View File

@@ -14,9 +14,9 @@
<type>bool</type><methodname>mcrypt_module_close</methodname>
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Closes the specified encryption handle.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -24,18 +24,18 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
The encryption descriptor.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
&return.success;
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;

16
reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml
View File

@@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>algorithm</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the blocksize of the specified algorithm.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,27 +25,27 @@
<varlistentry>
<term><parameter>algorithm</parameter></term>
<listitem>
<para>
<simpara>
The algorithm name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
<simpara>
This optional parameter can contain the location where the mode module
is on the system.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns the block size of the algorithm specified in bytes.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml
View File

@@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>algorithm</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Gets the maximum supported keysize of the opened mode.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -25,28 +25,28 @@
<varlistentry>
<term><parameter>algorithm</parameter></term>
<listitem>
<para>
<simpara>
The algorithm name.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
<simpara>
This optional parameter can contain the location where the mode module
is on the system.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
This function returns the maximum supported key size of the
algorithm specified in bytes.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml
View File

@@ -15,12 +15,12 @@
<methodparam><type>string</type><parameter>algorithm</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Returns an array with the key sizes supported by the specified algorithm.
If it returns an empty array then all key sizes between 1 and
<function>mcrypt_module_get_algo_key_size</function> are supported by the
algorithm.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -28,18 +28,18 @@
<varlistentry>
<term><parameter>algorithm</parameter></term>
<listitem>
<para>
<simpara>
The algorithm to be used.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
<simpara>
The optional <parameter>lib_dir</parameter> parameter can contain the
location where the algorithm module is on the system.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,12 +47,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns an array with the key sizes supported by the specified algorithm.
If it returns an empty array then all key sizes between 1 and
<function>mcrypt_module_get_algo_key_size</function> are supported by the
algorithm.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

16
reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml
View File

@@ -15,11 +15,11 @@
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function returns &true; if the mode is for use with block
algorithms, otherwise it returns &false;. (e.g. &false; for stream, and
&true; for cbc, cfb, ofb).
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -27,18 +27,18 @@
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
<simpara>
The mode to check.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
<simpara>
The optional <parameter>lib_dir</parameter> parameter can contain the
location where the algorithm module is on the system.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,11 +46,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
This function returns &true; if the mode is for use with block
algorithms, otherwise it returns &false;. (e.g. &false; for stream, and
&true; for cbc, cfb, ofb).
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

16
reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml
View File

@@ -15,10 +15,10 @@
<methodparam><type>string</type><parameter>algorithm</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function returns &true; if the specified algorithm is a block
algorithm, or &false; if it is a stream one.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,18 +27,18 @@
<varlistentry>
<term><parameter>algorithm</parameter></term>
<listitem>
<para>
<simpara>
The algorithm to check.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
<simpara>
The optional <parameter>lib_dir</parameter> parameter can contain the
location where the algorithm module is on the system.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,10 +46,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
This function returns &true; if the specified algorithm is a block
algorithm, or &false; if it is a stream one.
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

12
reference/mcrypt/functions/mcrypt-module-is-block-mode.xml
View File

@@ -15,11 +15,11 @@
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function returns &true; if the mode outputs blocks of bytes or
&false; if it outputs just bytes. (e.g. &true; for cbc and ecb, and
&false; for cfb and stream).
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -34,10 +34,10 @@
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
<simpara>
The optional <parameter>lib_dir</parameter> parameter can contain the
location where the algorithm module is on the system.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,11 +45,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
This function returns &true; if the mode outputs blocks of bytes or
&false; if it outputs just bytes. (e.g. &true; for cbc and ecb, and
&false; for cfb and stream).
</para>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

20
reference/mcrypt/functions/mcrypt-module-open.xml
View File

@@ -17,12 +17,12 @@
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
<methodparam><type>string</type><parameter>mode_directory</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
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. <literal>"twofish"</literal> or is
one of the <constant>MCRYPT_ciphername</constant> constants. The module is closed by calling
<function>mcrypt_module_close</function>.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -37,14 +37,14 @@
<varlistentry>
<term><parameter>algorithm_directory</parameter></term>
<listitem>
<para>
<simpara>
The <parameter>algorithm_directory</parameter> parameter is used to locate
the encryption module. When you supply a directory name, it is used. When
you set it to an empty string (<literal>""</literal>), the value set by the
<literal>mcrypt.algorithms_dir</literal> &php.ini; directive is used. When
it is not set, the default directory that is used is the one that was compiled
into libmcrypt (usually <filename>/usr/local/lib/libmcrypt</filename>).
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
@@ -56,14 +56,14 @@
<varlistentry>
<term><parameter>mode_directory</parameter></term>
<listitem>
<para>
<simpara>
The <parameter>mode_directory</parameter> parameter is used to locate
the encryption module. When you supply a directory name, it is used. When
you set it to an empty string (<literal>""</literal>), the value set by the
<literal>mcrypt.modes_dir</literal> &php.ini; directive is used. When
it is not set, the default directory that is used is the one that was compiled-in
into libmcrypt (usually <filename>/usr/local/lib/libmcrypt</filename>).
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -71,9 +71,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Normally it returns an encryption descriptor, or &false; on error.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -91,13 +91,13 @@
]]>
</programlisting>
</example>
<para>
<simpara>
The first line in the example above will try to open the <literal>DES</literal> cipher from
the default directory and the <literal>ECB</literal> 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>
</simpara>
<example>
<title>Using <function>mcrypt_module_open</function> in encryption</title>

12
reference/mcrypt/functions/mcrypt-module-self-test.xml
View File

@@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>algorithm</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>lib_dir</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function runs the self test on the algorithm specified.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -32,10 +32,10 @@
<varlistentry>
<term><parameter>lib_dir</parameter></term>
<listitem>
<para>
<simpara>
The optional <parameter>lib_dir</parameter> parameter can contain the
location where the algorithm module is on the system.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,10 +43,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
The function returns &true; if the self test succeeds, or &false; when it
fails.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">

24
reference/mcrypt/functions/mdecrypt-generic.xml
View File

@@ -15,11 +15,11 @@
<methodparam><type>resource</type><parameter>td</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
This function decrypts data. Note that the length of the returned string
can in fact be longer than the unencrypted string, due to the padding of
the data.
</para>
</simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,18 +28,18 @@
<varlistentry>
<term><parameter>td</parameter></term>
<listitem>
<para>
<simpara>
An encryption descriptor returned by
<function>mcrypt_module_open</function>
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
<simpara>
Encrypted data.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,9 +47,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
Returns decrypted string.
</para>
</simpara>
</refsect1>
<refsect1 role="examples">
@@ -94,20 +94,20 @@
]]>
</programlisting>
</example>
<para>
<simpara>
The example above shows how to check if the data before the encryption is
the same as the data after the decryption. It is very important to
reinitialize the encryption buffer with
<function>mcrypt_generic_init</function> before you try to decrypt the
data.
</para>
<para>
</simpara>
<simpara>
The decryption handle should always be initialized with
<function>mcrypt_generic_init</function> with a key and an IV before
calling this function. Where the encryption is done, you should free the
encryption buffers by calling <function>mcrypt_generic_deinit</function>.
See <function>mcrypt_module_open</function> for an example.
</para>
</simpara>
</refsect1>
<refsect1 role="seealso">

8
reference/mcrypt/ini.xml
View File

@@ -42,12 +42,12 @@
<type>string</type>
</term>
<listitem>
<para>
<simpara>
The directory that contains the algorithms. Defaults to the directories
compiled within libmcrypt, which is typically
<emphasis>/usr/local/lib/libmcrypt</emphasis>. See
<function>mcrypt_list_algorithms</function> for additional details.
</para>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="ini.mcrypt.modes-dir">
@@ -56,12 +56,12 @@
<type>string</type>
</term>
<listitem>
<para>
<simpara>
The directory that contains the modes. Defaults to the directories
compiled within libmcrypt, which is typically
<emphasis>/usr/local/lib/libmcrypt</emphasis>. See
<function>mcrypt_list_modes</function> for additional details.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>

24
reference/mcrypt/setup.xml
View File

@@ -1,33 +1,31 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="mcrypt.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="mcrypt.setup">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="mcrypt.requirements">
&reftitle.required;
<para>
<simpara>
These functions work using <link xlink:href="&url.mcrypt;">mcrypt</link>.
To use it, download <filename>libmcrypt-x.x.tar.gz</filename> from <link
xlink:href="&url.mcrypt;">&url.mcrypt;</link> and follow the included
To use it, download <filename>libmcrypt-x.x.tar.gz</filename> from <link xlink:href="&url.mcrypt;">&url.mcrypt;</link> and follow the included
installation instructions.
</para>
</simpara>
<simpara>
libmcrypt Version 2.5.6 or greater is required.
</simpara>
<para>
<simpara>
Windows users will find the library is the PHP 5.2 Windows binaries release.
PHP 5.3 Windows binaries uses the static version of the MCrypt library, no
DLL are needed.
</para>
<para>
</simpara>
<simpara>
If you linked against libmcrypt 2.4.x or higher, the following additional
block algorithms are supported: CAST, LOKI97, RIJNDAEL, SAFERPLUS,
SERPENT and the following stream ciphers: ENIGMA (crypt), PANAMA, RC4 and
WAKE. With libmcrypt 2.4.x or higher another cipher mode is also
available; nOFB.
</para>
</simpara>
</section>
<!-- }}} -->
@@ -42,14 +40,13 @@
<!-- {{{ Resources -->
<section xml:id="mcrypt.resources">
&reftitle.resources;
<para>
<simpara>
<function>mcrypt_module_open</function> returns an encryption descriptor.
</para>
</simpara>
</section>
<!-- }}} -->
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -70,4 +67,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->