sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 16:38:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added docs for parameters of openssl_encrypt and openssl_decrypt introduced in https://wiki.php.net/rfc/openssl_aead

Browse source 
-- 
Provided by anonymous 77751 (me@jiripudil.cz)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@341653 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2017-01-12 18:31:07 +00:00
parent 38f81d5579
commit 6b6201edd9
2 changed files with 53 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
reference/openssl/functions/openssl-decrypt.xml
View file

@ -16,6 +16,8 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>iv</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>tag</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>aad</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
Takes a raw or base64 encoded string and decrypts it using a given method and key.
@ -71,6 +73,22 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
The authentication tag in AEAD cipher mode. If it is incorrect, the authentication fails and the function returns &false;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>aad</parameter></term>
<listitem>
<para>
Additional authentication data.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@ -117,6 +135,10 @@
The <parameter>raw_output</parameter> was changed to <parameter>options</parameter>.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>The <parameter>tag</parameter> and <parameter>aad</parameter> parameters were added.</entry>
</row>
</tbody>
</tgroup>
</informaltable>

31
reference/openssl/functions/openssl-encrypt.xml
View file

@ -16,6 +16,9 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>iv</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter role="reference">tag</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>aad</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>tag_length</parameter><initializer>16</initializer></methodparam>
</methodsynopsis>
<para>
Encrypts given data with given method and key, returns a raw
@ -69,6 +72,30 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tag</parameter></term>
<listitem>
<para>
The authentication tag passed by reference when using AEAD cipher mode (GCM or CCM).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>aad</parameter></term>
<listitem>
<para>
Additional authentication data.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tag_length</parameter></term>
<listitem>
<para>
The length of the authentication <parameter>tag</parameter>. Its value can be between 4 and 16 for GCM mode.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
@ -115,6 +142,10 @@
The <parameter>raw_output</parameter> was changed to <parameter>options</parameter>.
</entry>
</row>
<row>
<entry>7.1.0</entry>
<entry>The <parameter>tag</parameter>, <parameter>aad</parameter> and <parameter>tag_length</parameter> parameters were added.</entry>
</row>
</tbody>
</tgroup>
</informaltable>