php-doc-en/reference/openssl/functions/openssl-private-decrypt.xml
Jakub Vrana 03470a1d03 No longer experimental
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@191005 c90b9560-bf6c-de11-be94-00142212c4b1
2005-07-19 13:41:16 +00:00

63 lines
2.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/openssl.xml, last change in rev 1.19 -->
<refentry id="function.openssl-private-decrypt">
<refnamediv>
<refname>openssl_private_decrypt</refname>
<refpurpose>Decrypts data with private key </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>openssl_private_decrypt</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>string</type><parameter role="reference">decrypted</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>padding</parameter></methodparam>
</methodsynopsis>
<para>
<function>openssl_private_decrypt</function> decrypts
<parameter>data</parameter> that was previous encrypted via
<function>openssl_public_encrypt</function> and stores the result into
<parameter>decrypted</parameter>. <parameter>key</parameter> must be the
private key corresponding that was used to encrypt the
data. <parameter>padding</parameter> defaults to
<constant>OPENSSL_PKCS1_PADDING</constant>, but can also be one of
<constant>OPENSSL_SSLV23_PADDING</constant>,
<constant>OPENSSL_PKCS1_OAEP_PADDING</constant>,
<constant>OPENSSL_NO_PADDING</constant>.
</para>
<para>
&return.success;
</para>
<para>
You can use this function e.g. to decrypt data which were supposed only to
you.
</para>
<para>
See also <function>openssl_public_encrypt</function> and
<function>openssl_public_decrypt</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->