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

documenting openssl encrypt/decrypt

Browse source 
https://bugs.php.net/bug.php?id=71817


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343016 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mark Jones 2017-09-06 20:12:43 +00:00
parent dfb5e6fa03
commit 5b848aeb03
2 changed files with 64 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -23,8 +23,6 @@
Takes a raw or base64 encoded string and decrypts it using a given method and key.
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
@ -35,7 +33,7 @@
<term><parameter>data</parameter></term>
<listitem>
<para>
The data.
The encrypted message to be decrypted.
</para>
</listitem>
</varlistentry>
@ -43,7 +41,8 @@
<term><parameter>method</parameter></term>
<listitem>
<para>
The cipher method.
The cipher method. For a list of available cipher methods, use
<function>openssl_get_cipher_methods</function>.
</para>
</listitem>
</varlistentry>

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

@ -34,7 +34,7 @@
<term><parameter>data</parameter></term>
<listitem>
<para>
The data.
The plaintext message data to be encrypted.
</para>
</listitem>
</varlistentry>
@ -151,6 +151,66 @@
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>AES Authenticated Encryption in GCM mode example for PHP 7.1+</title>
<programlisting role="php">
<![CDATA[
<?php
//$key should have been previously generated in a cryptographically safe way, like openssl_random_pseudo_bytes
$plaintext = "message to be encrypted";
$cipher = "aes-128-gcm";
if (in_array($cipher, openssl_get_cipher_methods()))
{
$ivlen = openssl_cipher_iv_length($cipher);
$iv = openssl_random_pseudo_bytes($ivlen);
$ciphertext = openssl_encrypt($plaintext, $cipher, $key, $options=0, $iv, $tag);
//store $cipher, $iv, and $tag for decryption later
$original_plaintext = openssl_decrypt($ciphertext, $cipher, $key, $options=0, $iv, $tag);
echo $original_plaintext."\n";
}
?>
]]>
</programlisting>
</example>
<example>
<title>AES Authenticated Encryption example for PHP 5.6+</title>
<programlisting role="php">
<![CDATA[
<?php
//$key previously generated safely, ie: openssl_random_pseudo_bytes
$plaintext = "message to be encrypted";
$ivlen = openssl_cipher_iv_length($cipher="AES-128-CBC");
$iv = openssl_random_pseudo_bytes($ivlen);
$ciphertext_raw = openssl_encrypt($plaintext, $cipher, $key, $options=OPENSSL_RAW_DATA, $iv);
$hmac = hash_hmac('sha256', $ciphertext_raw, $key, $as_binary=true);
$ciphertext = base64_encode( $iv.$hmac.$ciphertext_raw );
//decrypt later....
$c = base64_decode($ciphertext);
$ivlen = openssl_cipher_iv_length($cipher="AES-128-CBC");
$iv = substr($c, 0, $ivlen);
$hmac = substr($c, $ivlen, $sha2len=32);
$ciphertext_raw = substr($c, $ivlen+$sha2len);
$original_plaintext = openssl_decrypt($ciphertext_raw, $cipher, $key, $options=OPENSSL_RAW_DATA, $iv);
$calcmac = hash_hmac('sha256', $ciphertext_raw, $key, $as_binary=true);
if (hash_equals($hmac, $calcmac))//PHP 5.6+ timing attack safe comparison
{
echo $original_plaintext."\n";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>