[DOC-CVS] [doc-en] master: mcrypt: fix XML to remove useless wrapping para tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-19T03:23:33Z
Commit: https://github.com/php/doc-en/commit/6126b024cb929b12ea29d9676671e4dde342f03d
Raw diff: https://github.com/php/doc-en/commit/6126b024cb929b12ea29d9676671e4dde342f03d.diff
mcrypt: fix XML to remove useless wrapping para tags via script
Changed paths:
M reference/mcrypt/functions/mcrypt-create-iv.xml
M reference/mcrypt/functions/mcrypt-decrypt.xml
M reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml
M reference/mcrypt/functions/mcrypt-enc-get-block-size.xml
M reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml
M reference/mcrypt/functions/mcrypt-enc-get-key-size.xml
M reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml
M reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml
M reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml
M reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml
M reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml
M reference/mcrypt/functions/mcrypt-enc-self-test.xml
M reference/mcrypt/functions/mcrypt-encrypt.xml
M reference/mcrypt/functions/mcrypt-generic-deinit.xml
M reference/mcrypt/functions/mcrypt-generic-init.xml
M reference/mcrypt/functions/mcrypt-generic.xml
M reference/mcrypt/functions/mcrypt-get-block-size.xml
M reference/mcrypt/functions/mcrypt-get-cipher-name.xml
M reference/mcrypt/functions/mcrypt-get-iv-size.xml
M reference/mcrypt/functions/mcrypt-get-key-size.xml
M reference/mcrypt/functions/mcrypt-list-algorithms.xml
M reference/mcrypt/functions/mcrypt-list-modes.xml
M reference/mcrypt/functions/mcrypt-module-close.xml
M reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml
M reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml
M reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml
M reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml
M reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml
M reference/mcrypt/functions/mcrypt-module-is-block-mode.xml
M reference/mcrypt/functions/mcrypt-module-open.xml
M reference/mcrypt/functions/mcrypt-module-self-test.xml
M reference/mcrypt/functions/mdecrypt-generic.xml
M reference/mcrypt/ini.xml
Diff:
diff --git a/reference/mcrypt/functions/mcrypt-create-iv.xml b/reference/mcrypt/functions/mcrypt-create-iv.xml
index 55647a03483e..22d4fa332939 100644
--- a/reference/mcrypt/functions/mcrypt-create-iv.xml
+++ b/reference/mcrypt/functions/mcrypt-create-iv.xml
@@ -1,11 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-create-iv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.mcrypt-create-iv">
<refnamediv>
<refname>mcrypt_create_iv</refname>
<refpurpose>Creates an initialization vector (IV) from a random source</refpurpose>
</refnamediv>
-
+
<refsynopsisdiv>
<warning>
&warn.deprecated.function.7-1-0.removed.7-2-0.alternatives;
@@ -14,7 +14,7 @@
</simplelist>
</warning>
</refsynopsisdiv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -35,42 +35,40 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>size</parameter></term>
- <listitem>
- <para>
- The size of the IV.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>source</parameter></term>
- <listitem>
- <para>
- 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
- <filename>/dev/random</filename>) and
- <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>
- Note that the default value of this parameter was
- <constant>MCRYPT_DEV_RANDOM</constant> prior to PHP 5.6.0.
- </para>
- <note>
- <simpara>
- Note that <constant>MCRYPT_DEV_RANDOM</constant> may block until more
- entropy is available.
- </simpara>
- </note>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>size</parameter></term>
+ <listitem>
+ <para>
+ The size of the IV.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>source</parameter></term>
+ <listitem>
+ <para>
+ 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
+ <filename>/dev/random</filename>) and
+ <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>
+ Note that the default value of this parameter was
+ <constant>MCRYPT_DEV_RANDOM</constant> prior to PHP 5.6.0.
+ </para>
+ <note>
+ <simpara>
+ Note that <constant>MCRYPT_DEV_RANDOM</constant> may block until more
+ entropy is available.
+ </simpara>
+ </note>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -82,34 +80,29 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_create_iv</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_create_iv</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$size = mcrypt_get_iv_size(MCRYPT_CAST_256, MCRYPT_MODE_CFB);
$iv = mcrypt_create_iv($size, MCRYPT_DEV_RANDOM);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><link xlink:href="&url.mcrypt.iv;">&url.mcrypt.iv;</link></member>
- <member><link xlink:href="&url.mcrypt.bcm;">&url.mcrypt.bcm;</link></member>
- <member>Chapter 9.3 of &book.applied.cryptography;</member>
- <member><function>random_bytes</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><link xlink:href="&url.mcrypt.iv;">&url.mcrypt.iv;</link></member>
+ <member><link xlink:href="&url.mcrypt.bcm;">&url.mcrypt.bcm;</link></member>
+ <member>Chapter 9.3 of &book.applied.cryptography;</member>
+ <member><function>random_bytes</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-decrypt.xml b/reference/mcrypt/functions/mcrypt-decrypt.xml
index d7f0a7c97062..8ba82d74dfb7 100644
--- a/reference/mcrypt/functions/mcrypt-decrypt.xml
+++ b/reference/mcrypt/functions/mcrypt-decrypt.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-decrypt" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-decrypt">
<refnamediv>
<refname>mcrypt_decrypt</refname>
<refpurpose>Decrypts crypttext with given parameters</refpurpose>
@@ -24,49 +24,47 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>cipher</parameter></term>
- <listitem>
- &mcrypt.parameter.cipher;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- &mcrypt.parameter.mode;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iv</parameter></term>
- <listitem>
- &mcrypt.parameter.iv.strict;
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>cipher</parameter></term>
+ <listitem>
+ &mcrypt.parameter.cipher;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ &mcrypt.parameter.mode;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>iv</parameter></term>
+ <listitem>
+ &mcrypt.parameter.iv.strict;
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -76,14 +74,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_encrypt</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_encrypt</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml
index 4179cb93f5ac..52d8d66eae4c 100644
--- a/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-get-algorithms-name.xml
@@ -1,15 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-get-algorithms-name" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-get-algorithms-name">
<refnamediv>
<refname>mcrypt_enc_get_algorithms_name</refname>
<refpurpose>Returns the name of the opened algorithm</refpurpose>
</refnamediv>
-
+
<refsynopsisdiv>
&warn.deprecated.function-7-1-0.removed-7-2-0;
</refsynopsisdiv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -23,18 +23,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -46,10 +44,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_enc_get_algorithms_name</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_enc_get_algorithms_name</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$td = mcrypt_module_open(MCRYPT_CAST_256, '', MCRYPT_MODE_CFB, '');
@@ -59,19 +56,17 @@ $td = mcrypt_module_open('cast-256', '', MCRYPT_MODE_CFB, '');
echo mcrypt_enc_get_algorithms_name($td). "\n";
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
CAST-256
CAST-256
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml
index 5e5b6c6e6452..69c918c2fe17 100644
--- a/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-get-block-size.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-get-block-size" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-get-block-size">
<refnamediv>
<refname>mcrypt_enc_get_block_size</refname>
<refpurpose>Returns the blocksize of the opened algorithm</refpurpose>
@@ -20,18 +20,16 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -40,7 +38,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml
index e1354a051029..7d18a193cd38 100644
--- a/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-get-iv-size.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-get-iv-size" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-get-iv-size">
<refnamediv>
<refname>mcrypt_enc_get_iv_size</refname>
<refpurpose>Returns the size of the IV of the opened algorithm</refpurpose>
@@ -22,18 +22,16 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -42,7 +40,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml b/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml
index 5cf8c52b4090..9855ced0cddc 100644
--- a/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-get-key-size.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-get-key-size" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-get-key-size">
<refnamediv>
<refname>mcrypt_enc_get_key_size</refname>
<refpurpose>Returns the maximum supported keysize of the opened mode</refpurpose>
@@ -20,18 +20,16 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -40,7 +38,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml b/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml
index 3acbe817d6dc..a3f2e3c55f9a 100644
--- a/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-get-modes-name.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-get-modes-name" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-get-modes-name">
<refnamediv>
<refname>mcrypt_enc_get_modes_name</refname>
<refpurpose>Returns the name of the opened mode</refpurpose>
@@ -20,18 +20,16 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -41,10 +39,9 @@
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_enc_get_modes_name</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_enc_get_modes_name</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$td = mcrypt_module_open (MCRYPT_CAST_256, '', MCRYPT_MODE_CFB, '');
@@ -54,19 +51,17 @@ $td = mcrypt_module_open ('cast-256', '', 'ecb', '');
echo mcrypt_enc_get_modes_name($td). "\n";
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
CFB
ECB
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml
index efdcf0563bd5..5246a04aa665 100644
--- a/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-get-supported-key-sizes.xml
@@ -1,15 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-get-supported-key-sizes" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-get-supported-key-sizes">
<refnamediv>
<refname>mcrypt_enc_get_supported_key_sizes</refname>
<refpurpose>Returns an array with the supported keysizes of the opened algorithm</refpurpose>
</refnamediv>
-
+
<refsynopsisdiv>
&warn.deprecated.function-7-1-0.removed-7-2-0;
</refsynopsisdiv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -23,18 +23,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -50,19 +48,18 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_enc_get_supported_key_sizes</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_enc_get_supported_key_sizes</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$td = mcrypt_module_open('rijndael-256', '', 'ecb', '');
var_dump(mcrypt_enc_get_supported_key_sizes($td));
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
array(3) {
[0]=>
@@ -73,12 +70,10 @@ array(3) {
int(32)
}
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml
index 5c0b0f8507fe..2da576a3247c 100644
--- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm-mode.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-is-block-algorithm-mode" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-is-block-algorithm-mode">
<refnamediv>
<refname>mcrypt_enc_is_block_algorithm_mode</refname>
<refpurpose>Checks whether the encryption of the opened mode works on blocks</refpurpose>
@@ -21,18 +21,16 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -42,7 +40,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml
index 77e9da9eed22..45a0eb49a605 100644
--- a/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-is-block-algorithm.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-is-block-algorithm" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-is-block-algorithm">
<refnamediv>
<refname>mcrypt_enc_is_block_algorithm</refname>
<refpurpose>Checks whether the algorithm of the opened mode is a block algorithm</refpurpose>
@@ -20,18 +20,16 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -41,7 +39,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml
index 99faf0a72059..2627bc05a96d 100644
--- a/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-is-block-mode.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-is-block-mode" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-is-block-mode">
<refnamediv>
<refname>mcrypt_enc_is_block_mode</refname>
<refpurpose>Checks whether the opened mode outputs blocks</refpurpose>
@@ -21,18 +21,16 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -42,7 +40,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-enc-self-test.xml b/reference/mcrypt/functions/mcrypt-enc-self-test.xml
index 744551d0b029..c01547d80e87 100644
--- a/reference/mcrypt/functions/mcrypt-enc-self-test.xml
+++ b/reference/mcrypt/functions/mcrypt-enc-self-test.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-enc-self-test" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-enc-self-test">
<refnamediv>
<refname>mcrypt_enc_self_test</refname>
<refpurpose>Runs a self test on the opened module</refpurpose>
@@ -21,18 +21,16 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -41,7 +39,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-encrypt.xml b/reference/mcrypt/functions/mcrypt-encrypt.xml
index 231d7aced49b..a8f65438d709 100644
--- a/reference/mcrypt/functions/mcrypt-encrypt.xml
+++ b/reference/mcrypt/functions/mcrypt-encrypt.xml
@@ -1,15 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-encrypt" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-encrypt">
<refnamediv>
<refname>mcrypt_encrypt</refname>
<refpurpose>Encrypts plaintext with given parameters</refpurpose>
</refnamediv>
-
+
<refsynopsisdiv>
&warn.deprecated.function-7-1-0.removed-7-2-0;
</refsynopsisdiv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -27,51 +27,49 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>cipher</parameter></term>
- <listitem>
- &mcrypt.parameter.cipher;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- 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>
- The returned crypttext can be larger than the size of the data that was
- given by <parameter>data</parameter>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- &mcrypt.parameter.mode;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iv</parameter></term>
- <listitem>
- &mcrypt.parameter.iv.strict;
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>cipher</parameter></term>
+ <listitem>
+ &mcrypt.parameter.cipher;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ The returned crypttext can be larger than the size of the data that was
+ given by <parameter>data</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ &mcrypt.parameter.mode;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>iv</parameter></term>
+ <listitem>
+ &mcrypt.parameter.iv.strict;
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -83,10 +81,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_encrypt</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_encrypt</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
# --- ENCRYPTION ---
@@ -95,20 +92,20 @@
# convert a string into a key
# key is specified using hexadecimal
$key = pack('H*', "bcb04b7e103a0cd8b54763051cef08bc55abe029fdebae5e1d417e2ffb2a00a3");
-
+
# show key size use either 16, 24 or 32 byte keys for AES-128, 192
# and 256 respectively
$key_size = strlen($key);
echo "Key size: " . $key_size . "\n";
-
+
$plaintext = "This string was AES-256 / CBC / ZeroBytePadding encrypted.";
# create a random IV to use with CBC encoding
$iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_128, MCRYPT_MODE_CBC);
$iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
-
+
# creates a cipher text compatible with AES (Rijndael block size = 128)
- # to keep the text confidential
+ # to keep the text confidential
# only suitable for encoded input that never ends with value 00h
# (because of default zero padding)
$ciphertext = mcrypt_encrypt(MCRYPT_RIJNDAEL_128, $key,
@@ -116,7 +113,7 @@
# prepend the IV for it to be available for decryption
$ciphertext = $iv . $ciphertext;
-
+
# encode the resulting cipher text so it can be represented by a string
$ciphertext_base64 = base64_encode($ciphertext);
@@ -126,48 +123,44 @@
# Resulting cipher text has no integrity or authenticity added
# and is not protected against padding oracle attacks.
-
+
# --- DECRYPTION ---
-
+
$ciphertext_dec = base64_decode($ciphertext_base64);
-
+
# retrieves the IV, iv_size should be created using mcrypt_get_iv_size()
$iv_dec = substr($ciphertext_dec, 0, $iv_size);
-
+
# retrieves the cipher text (everything except the $iv_size in the front)
$ciphertext_dec = substr($ciphertext_dec, $iv_size);
# may remove 00h valued characters from end of plain text
$plaintext_dec = mcrypt_decrypt(MCRYPT_RIJNDAEL_128, $key,
$ciphertext_dec, MCRYPT_MODE_CBC, $iv_dec);
-
+
echo $plaintext_dec . "\n";
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
Key size: 32
ENJW8mS2KaJoNB5E5CoSAAu0xARgsR1bdzFWpEn+poYw45q+73az5kYi4j+0haevext1dGrcW8Qi59txfCBV8BBj3bzRP3dFCp3CPQSJ8eU=
This string was AES-256 / CBC / ZeroBytePadding encrypted.
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_decrypt</function></member>
- <member><function>mcrypt_module_open</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_decrypt</function></member>
+ <member><function>mcrypt_module_open</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-generic-deinit.xml b/reference/mcrypt/functions/mcrypt-generic-deinit.xml
index 1fb61d5afa1a..8fb5e65d8c75 100644
--- a/reference/mcrypt/functions/mcrypt-generic-deinit.xml
+++ b/reference/mcrypt/functions/mcrypt-generic-deinit.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id='function.mcrypt-generic-deinit' xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-generic-deinit">
<refnamediv>
<refname>mcrypt_generic_deinit</refname>
<refpurpose>This function deinitializes an encryption module</refpurpose>
@@ -25,18 +25,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -48,16 +46,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_module_open</function></member>
- <member><function>mcrypt_generic_init</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_module_open</function></member>
+ <member><function>mcrypt_generic_init</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-generic-init.xml b/reference/mcrypt/functions/mcrypt-generic-init.xml
index 4e2543992253..6b36b59b2632 100644
--- a/reference/mcrypt/functions/mcrypt-generic-init.xml
+++ b/reference/mcrypt/functions/mcrypt-generic-init.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-generic-init" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-generic-init">
<refnamediv>
<refname>mcrypt_generic_init</refname>
<refpurpose>This function initializes all buffers needed for encryption</refpurpose>
@@ -24,42 +24,40 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>key</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>iv</parameter></term>
- <listitem>
- <para>
- 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
- MUST exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>key</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>iv</parameter></term>
+ <listitem>
+ <para>
+ 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
+ MUST exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -73,14 +71,11 @@
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_module_open</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_module_open</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-generic.xml b/reference/mcrypt/functions/mcrypt-generic.xml
index a3e47b6ce9e4..5dd445b83bb7 100644
--- a/reference/mcrypt/functions/mcrypt-generic.xml
+++ b/reference/mcrypt/functions/mcrypt-generic.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-generic" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-generic">
<refnamediv>
<refname>mcrypt_generic</refname>
<refpurpose>This function encrypts data</refpurpose>
@@ -43,33 +43,31 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- <para>
- 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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- The data to encrypt.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ The data to encrypt.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -81,17 +79,14 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mdecrypt_generic</function></member>
- <member><function>mcrypt_generic_init</function></member>
- <member><function>mcrypt_generic_deinit</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mdecrypt_generic</function></member>
+ <member><function>mcrypt_generic_init</function></member>
+ <member><function>mcrypt_generic_deinit</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-get-block-size.xml b/reference/mcrypt/functions/mcrypt-get-block-size.xml
index 2434ca8cfd21..f3917f614954 100644
--- a/reference/mcrypt/functions/mcrypt-get-block-size.xml
+++ b/reference/mcrypt/functions/mcrypt-get-block-size.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-get-block-size" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-get-block-size">
<refnamediv>
<refname>mcrypt_get_block_size</refname>
<refpurpose>Gets the block size of the specified cipher</refpurpose>
@@ -37,22 +37,20 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>cipher</parameter></term>
- <listitem>
- &mcrypt.parameter.cipher;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- &mcrypt.parameter.mode;
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>cipher</parameter></term>
+ <listitem>
+ &mcrypt.parameter.cipher;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ &mcrypt.parameter.mode;
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -64,14 +62,13 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_get_block_size</function> example</title>
- <para>
- This example shows how to use this function when linked against libmcrypt
- 2.4.x and 2.5.x.
- </para>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_get_block_size</function> example</title>
+ <para>
+ This example shows how to use this function when linked against libmcrypt
+ 2.4.x and 2.5.x.
+ </para>
+ <programlisting role="php">
<![CDATA[
<?php
@@ -79,24 +76,20 @@ echo mcrypt_get_block_size('tripledes', 'ecb'); // 8
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_get_key_size</function></member>
- <member><function>mcrypt_enc_get_block_size</function></member>
- <member><function>mcrypt_encrypt</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_get_key_size</function></member>
+ <member><function>mcrypt_enc_get_block_size</function></member>
+ <member><function>mcrypt_encrypt</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml b/reference/mcrypt/functions/mcrypt-get-cipher-name.xml
index e15ccb74e92e..c8d725100327 100644
--- a/reference/mcrypt/functions/mcrypt-get-cipher-name.xml
+++ b/reference/mcrypt/functions/mcrypt-get-cipher-name.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-get-cipher-name" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-get-cipher-name">
<refnamediv>
<refname>mcrypt_get_cipher_name</refname>
<refpurpose>Gets the name of the specified cipher</refpurpose>
@@ -31,16 +31,14 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>cipher</parameter></term>
- <listitem>
- &mcrypt.parameter.cipher;
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>cipher</parameter></term>
+ <listitem>
+ &mcrypt.parameter.cipher;
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -53,10 +51,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_get_cipher_name</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_get_cipher_name</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$cipher = MCRYPT_TripleDES;
@@ -64,18 +61,16 @@
echo mcrypt_get_cipher_name($cipher);
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
3DES
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-get-iv-size.xml b/reference/mcrypt/functions/mcrypt-get-iv-size.xml
index e73a64f9e297..6829547132c2 100644
--- a/reference/mcrypt/functions/mcrypt-get-iv-size.xml
+++ b/reference/mcrypt/functions/mcrypt-get-iv-size.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-get-iv-size" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-get-iv-size">
<refnamediv>
<refname>mcrypt_get_iv_size</refname>
<refpurpose>Returns the size of the IV belonging to a specific cipher/mode combination</refpurpose>
@@ -16,7 +16,7 @@
<methodparam><type>string</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
- Gets the size of the IV belonging to a specific
+ Gets the size of the IV belonging to a specific
<parameter>cipher</parameter>/<parameter>mode</parameter> combination.
</para>
<para>
@@ -25,30 +25,28 @@
<function>mcrypt_module_open</function>.
</para>
</refsect1>
-
+
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>cipher</parameter></term>
- <listitem>
- &mcrypt.parameter.cipher;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- &mcrypt.parameter.mode;
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>cipher</parameter></term>
+ <listitem>
+ &mcrypt.parameter.cipher;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ &mcrypt.parameter.mode;
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -62,10 +60,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_get_iv_size</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_get_iv_size</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
echo mcrypt_get_iv_size(MCRYPT_CAST_256, MCRYPT_MODE_CFB) . "\n";
@@ -73,24 +70,20 @@
echo mcrypt_get_iv_size('des', 'ecb') . "\n";
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_get_block_size</function></member>
- <member><function>mcrypt_enc_get_iv_size</function></member>
- <member><function>mcrypt_create_iv</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_get_block_size</function></member>
+ <member><function>mcrypt_enc_get_iv_size</function></member>
+ <member><function>mcrypt_create_iv</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-get-key-size.xml b/reference/mcrypt/functions/mcrypt-get-key-size.xml
index afbd4f7466c1..3eef471360f2 100644
--- a/reference/mcrypt/functions/mcrypt-get-key-size.xml
+++ b/reference/mcrypt/functions/mcrypt-get-key-size.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-get-key-size" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-get-key-size">
<refnamediv>
<refname>mcrypt_get_key_size</refname>
<refpurpose>Gets the key size of the specified cipher</refpurpose>
@@ -36,22 +36,20 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>cipher</parameter></term>
- <listitem>
- &mcrypt.parameter.cipher;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- &mcrypt.parameter.mode;
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>cipher</parameter></term>
+ <listitem>
+ &mcrypt.parameter.cipher;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ &mcrypt.parameter.mode;
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -64,42 +62,37 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_get_key_size</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_get_key_size</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
echo mcrypt_get_key_size('tripledes', 'ecb');
?>
]]>
- </programlisting>
- <para>
- The example above shows how to use this function when
- linked against libmcrypt 2.4.x or 2.5.x.
- </para>
- &example.outputs;
- <screen>
+ </programlisting>
+ <para>
+ The example above shows how to use this function when
+ linked against libmcrypt 2.4.x or 2.5.x.
+ </para>
+ &example.outputs;
+ <screen>
<![CDATA[
24
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_get_block_size</function></member>
- <member><function>mcrypt_enc_get_key_size</function></member>
- <member><function>mcrypt_encrypt</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_get_block_size</function></member>
+ <member><function>mcrypt_enc_get_key_size</function></member>
+ <member><function>mcrypt_encrypt</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-list-algorithms.xml b/reference/mcrypt/functions/mcrypt-list-algorithms.xml
index 18fa9683935f..83f9e5eb5aaf 100644
--- a/reference/mcrypt/functions/mcrypt-list-algorithms.xml
+++ b/reference/mcrypt/functions/mcrypt-list-algorithms.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-list-algorithms" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-list-algorithms">
<refnamediv>
<refname>mcrypt_list_algorithms</refname>
<refpurpose>Gets an array of all supported ciphers</refpurpose>
@@ -22,20 +22,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>lib_dir</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>lib_dir</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -47,19 +45,18 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_list_algorithms</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_list_algorithms</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$algorithms = mcrypt_list_algorithms();
print_r($algorithms);
?>
]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
+ </programlisting>
+ &example.outputs.similar;
+ <screen>
<![CDATA[
Array
(
@@ -84,12 +81,10 @@ Array
[18] => tripledes
)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-list-modes.xml b/reference/mcrypt/functions/mcrypt-list-modes.xml
index 1c927a91697a..d1a52a6463f0 100644
--- a/reference/mcrypt/functions/mcrypt-list-modes.xml
+++ b/reference/mcrypt/functions/mcrypt-list-modes.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-list-modes" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-list-modes">
<refnamediv>
<refname>mcrypt_list_modes</refname>
<refpurpose>Gets an array of all supported modes</refpurpose>
@@ -22,20 +22,18 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>lib_dir</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>lib_dir</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -47,10 +45,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_list_modes</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_list_modes</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
$modes = mcrypt_list_modes();
@@ -60,19 +57,17 @@
}
?>
]]>
- </programlisting>
- <para>
- 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>
- </example>
- </para>
+ </programlisting>
+ <para>
+ 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>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-module-close.xml b/reference/mcrypt/functions/mcrypt-module-close.xml
index f772887e421d..286fa59da6b1 100644
--- a/reference/mcrypt/functions/mcrypt-module-close.xml
+++ b/reference/mcrypt/functions/mcrypt-module-close.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id='function.mcrypt-module-close' xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-close">
<refnamediv>
<refname>mcrypt_module_close</refname>
<refpurpose>Closes the mcrypt module</refpurpose>
@@ -20,18 +20,16 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- The encryption descriptor.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ The encryption descriptor.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -41,14 +39,11 @@
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_module_open</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_module_open</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml
index 622fd6dc0adb..ce2398ee3d47 100644
--- a/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml
+++ b/reference/mcrypt/functions/mcrypt-module-get-algo-block-size.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-module-get-algo-block-size" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-get-algo-block-size">
<refnamediv>
<refname>mcrypt_module_get_algo_block_size</refname>
<refpurpose>Returns the blocksize of the specified algorithm</refpurpose>
@@ -21,27 +21,25 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>algorithm</parameter></term>
- <listitem>
- <para>
- The algorithm name.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lib_dir</parameter></term>
- <listitem>
- <para>
- This optional parameter can contain the location where the mode module
- is on the system.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>algorithm</parameter></term>
+ <listitem>
+ <para>
+ The algorithm name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>lib_dir</parameter></term>
+ <listitem>
+ <para>
+ This optional parameter can contain the location where the mode module
+ is on the system.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -50,7 +48,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml b/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml
index e8d5609ddebd..e81517bd3a06 100644
--- a/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml
+++ b/reference/mcrypt/functions/mcrypt-module-get-algo-key-size.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-module-get-algo-key-size" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-get-algo-key-size">
<refnamediv>
<refname>mcrypt_module_get_algo_key_size</refname>
<refpurpose>Returns the maximum supported keysize of the opened mode</refpurpose>
@@ -21,27 +21,25 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>algorithm</parameter></term>
- <listitem>
- <para>
- The algorithm name.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lib_dir</parameter></term>
- <listitem>
- <para>
- This optional parameter can contain the location where the mode module
- is on the system.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>algorithm</parameter></term>
+ <listitem>
+ <para>
+ The algorithm name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>lib_dir</parameter></term>
+ <listitem>
+ <para>
+ This optional parameter can contain the location where the mode module
+ is on the system.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
@@ -51,7 +49,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml b/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml
index 781600ca3e71..99fed72db3bf 100644
--- a/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml
+++ b/reference/mcrypt/functions/mcrypt-module-get-supported-key-sizes.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-module-get-supported-key-sizes" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-get-supported-key-sizes">
<refnamediv>
<refname>mcrypt_module_get_supported_key_sizes</refname>
<refpurpose>Returns an array with the supported keysizes of the opened algorithm</refpurpose>
@@ -24,27 +24,25 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>algorithm</parameter></term>
- <listitem>
- <para>
- The algorithm to be used.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lib_dir</parameter></term>
- <listitem>
- <para>
- The optional <parameter>lib_dir</parameter> parameter can contain the
- location where the algorithm module is on the system.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>algorithm</parameter></term>
+ <listitem>
+ <para>
+ The algorithm to be used.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>lib_dir</parameter></term>
+ <listitem>
+ <para>
+ The optional <parameter>lib_dir</parameter> parameter can contain the
+ location where the algorithm module is on the system.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -59,14 +57,11 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_enc_get_supported_key_sizes</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_enc_get_supported_key_sizes</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml
index eef05df38cbc..a4b4eac71c97 100644
--- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml
+++ b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm-mode.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-module-is-block-algorithm-mode" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-is-block-algorithm-mode">
<refnamediv>
<refname>mcrypt_module_is_block_algorithm_mode</refname>
<refpurpose>Returns if the specified module is a block algorithm or not</refpurpose>
@@ -23,27 +23,25 @@
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- <para>
- The mode to check.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lib_dir</parameter></term>
- <listitem>
- <para>
- The optional <parameter>lib_dir</parameter> parameter can contain the
- location where the algorithm module is on the system.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ The mode to check.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>lib_dir</parameter></term>
+ <listitem>
+ <para>
+ The optional <parameter>lib_dir</parameter> parameter can contain the
+ location where the algorithm module is on the system.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -55,7 +53,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml
index ed7ccf2522a1..a57137c69bd0 100644
--- a/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml
+++ b/reference/mcrypt/functions/mcrypt-module-is-block-algorithm.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-module-is-block-algorithm" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-is-block-algorithm">
<refnamediv>
<refname>mcrypt_module_is_block_algorithm</refname>
<refpurpose>This function checks whether the specified algorithm is a block algorithm</refpurpose>
@@ -23,27 +23,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>algorithm</parameter></term>
- <listitem>
- <para>
- The algorithm to check.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lib_dir</parameter></term>
- <listitem>
- <para>
- The optional <parameter>lib_dir</parameter> parameter can contain the
- location where the algorithm module is on the system.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>algorithm</parameter></term>
+ <listitem>
+ <para>
+ The algorithm to check.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>lib_dir</parameter></term>
+ <listitem>
+ <para>
+ The optional <parameter>lib_dir</parameter> parameter can contain the
+ location where the algorithm module is on the system.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,7 +52,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml b/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml
index 6135607ec5bf..cd3564709261 100644
--- a/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml
+++ b/reference/mcrypt/functions/mcrypt-module-is-block-mode.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-module-is-block-mode" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-is-block-mode">
<refnamediv>
<refname>mcrypt_module_is_block_mode</refname>
<refpurpose>Returns if the specified mode outputs blocks or not</refpurpose>
@@ -24,25 +24,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- &mcrypt.parameter.mode;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lib_dir</parameter></term>
- <listitem>
- <para>
- The optional <parameter>lib_dir</parameter> parameter can contain the
- location where the algorithm module is on the system.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ &mcrypt.parameter.mode;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>lib_dir</parameter></term>
+ <listitem>
+ <para>
+ The optional <parameter>lib_dir</parameter> parameter can contain the
+ location where the algorithm module is on the system.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,7 +52,6 @@
</para>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-module-open.xml b/reference/mcrypt/functions/mcrypt-module-open.xml
index 7d45a6d226ee..41bf8573dba0 100644
--- a/reference/mcrypt/functions/mcrypt-module-open.xml
+++ b/reference/mcrypt/functions/mcrypt-module-open.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-module-open" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml: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>
@@ -27,48 +27,46 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>algorithm</parameter></term>
- <listitem>
- &mcrypt.parameter.cipher;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>algorithm_directory</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- &mcrypt.parameter.mode;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode_directory</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>algorithm</parameter></term>
+ <listitem>
+ &mcrypt.parameter.cipher;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>algorithm_directory</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ &mcrypt.parameter.mode;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode_directory</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -80,10 +78,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_module_open</function> Examples</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_module_open</function> Examples</title>
+ <programlisting role="php">
<![CDATA[
<?php
$td = mcrypt_module_open(MCRYPT_DES, '',
@@ -92,9 +89,8 @@
$td = mcrypt_module_open('rijndael-256', '', 'ofb', '');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
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
@@ -103,10 +99,9 @@
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">
+ <example>
+ <title>Using <function>mcrypt_module_open</function> in encryption</title>
+ <programlisting role="php">
<![CDATA[
<?php
/* Open the cipher */
@@ -143,25 +138,21 @@
echo trim($decrypted) . "\n";
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_module_close</function></member>
- <member><function>mcrypt_generic</function></member>
- <member><function>mdecrypt_generic</function></member>
- <member><function>mcrypt_generic_init</function></member>
- <member><function>mcrypt_generic_deinit</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_module_close</function></member>
+ <member><function>mcrypt_generic</function></member>
+ <member><function>mdecrypt_generic</function></member>
+ <member><function>mcrypt_generic_init</function></member>
+ <member><function>mcrypt_generic_deinit</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mcrypt-module-self-test.xml b/reference/mcrypt/functions/mcrypt-module-self-test.xml
index 9abe4a0588ce..f300fe457b21 100644
--- a/reference/mcrypt/functions/mcrypt-module-self-test.xml
+++ b/reference/mcrypt/functions/mcrypt-module-self-test.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mcrypt-module-self-test" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mcrypt-module-self-test">
<refnamediv>
<refname>mcrypt_module_self_test</refname>
<refpurpose>This function runs a self test on the specified module</refpurpose>
@@ -22,25 +22,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>algorithm</parameter></term>
- <listitem>
- &mcrypt.parameter.cipher;
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>lib_dir</parameter></term>
- <listitem>
- <para>
- The optional <parameter>lib_dir</parameter> parameter can contain the
- location where the algorithm module is on the system.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>algorithm</parameter></term>
+ <listitem>
+ &mcrypt.parameter.cipher;
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>lib_dir</parameter></term>
+ <listitem>
+ <para>
+ The optional <parameter>lib_dir</parameter> parameter can contain the
+ location where the algorithm module is on the system.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -53,29 +51,26 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mcrypt_module_self_test</function> example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mcrypt_module_self_test</function> example</title>
+ <programlisting role="php">
<![CDATA[
<?php
var_dump(mcrypt_module_self_test(MCRYPT_RIJNDAEL_128)) . "\n";
var_dump(mcrypt_module_self_test(MCRYPT_BOGUS_CYPHER));
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
bool(true)
bool(false)
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/functions/mdecrypt-generic.xml b/reference/mcrypt/functions/mdecrypt-generic.xml
index ef529b8d16db..061a781a152e 100644
--- a/reference/mcrypt/functions/mdecrypt-generic.xml
+++ b/reference/mcrypt/functions/mdecrypt-generic.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<refentry xml:id="function.mdecrypt-generic" xmlns="http://docbook.org/ns/docbook">
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.mdecrypt-generic">
<refnamediv>
<refname>mdecrypt_generic</refname>
<refpurpose>Decrypts data</refpurpose>
@@ -24,27 +24,25 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>td</parameter></term>
- <listitem>
- <para>
- An encryption descriptor returned by
- <function>mcrypt_module_open</function>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>data</parameter></term>
- <listitem>
- <para>
- Encrypted data.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>td</parameter></term>
+ <listitem>
+ <para>
+ An encryption descriptor returned by
+ <function>mcrypt_module_open</function>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>data</parameter></term>
+ <listitem>
+ <para>
+ Encrypted data.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -56,10 +54,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>mdecrypt_generic</function> Example</title>
- <programlisting role="php">
+ <example>
+ <title><function>mdecrypt_generic</function> Example</title>
+ <programlisting role="php">
<![CDATA[
<?php
/* Data */
@@ -95,9 +92,8 @@
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
<para>
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
@@ -116,16 +112,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mcrypt_generic</function></member>
- <member><function>mcrypt_generic_init</function></member>
- <member><function>mcrypt_generic_deinit</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mcrypt_generic</function></member>
+ <member><function>mcrypt_generic_init</function></member>
+ <member><function>mcrypt_generic_deinit</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/mcrypt/ini.xml b/reference/mcrypt/ini.xml
index 42f54a297b37..c52a0d90920e 100644
--- a/reference/mcrypt/ini.xml
+++ b/reference/mcrypt/ini.xml
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<section xml:id="mcrypt.configuration" xmlns="http://docbook.org/ns/docbook">
+<section xmlns="http://docbook.org/ns/docbook" xml:id="mcrypt.configuration">
&reftitle.runtime;
&extension.runtime;
<para>
@@ -20,13 +20,13 @@
<entry><link linkend="ini.mcrypt.algorithms-dir">mcrypt.algorithms_dir</link></entry>
<entry>&null;</entry>
<entry><constant>INI_ALL</constant></entry>
- <entry></entry>
+ <entry/>
</row>
<row>
<entry><link linkend="ini.mcrypt.modes-dir">mcrypt.modes_dir</link></entry>
<entry>&null;</entry>
<entry><constant>INI_ALL</constant></entry>
- <entry></entry>
+ <entry/>
</row>
</tbody>
</tgroup>
@@ -35,41 +35,38 @@
</para>
&ini.descriptions.title;
- <para>
- <variablelist>
- <varlistentry xml:id="ini.mcrypt.algorithms-dir">
- <term>
- <parameter>mcrypt.algorithms_dir</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- <varlistentry xml:id="ini.mcrypt.modes-dir">
- <term>
- <parameter>mcrypt.modes_dir</parameter>
- <type>string</type>
- </term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry xml:id="ini.mcrypt.algorithms-dir">
+ <term>
+ <parameter>mcrypt.algorithms_dir</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ <varlistentry xml:id="ini.mcrypt.modes-dir">
+ <term>
+ <parameter>mcrypt.modes_dir</parameter>
+ <type>string</type>
+ </term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</section>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -90,4 +87,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-