php-doc-en/reference/openssl/functions/openssl-public-encrypt.xml

63 lines
2.2 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/openssl.xml, last change in rev 1.19 -->
<refentry id="function.openssl-public-encrypt">
<refnamediv>
<refname>openssl_public_encrypt</refname>
<refpurpose>Encrypts data with public key </refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>openssl_public_encrypt</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>string</type><parameter>&amp;crypted</parameter></methodparam>
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>padding</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>openssl_public_encrypt</function> encrypts <parameter>data</parameter>
with public <parameter>key</parameter> and stores the result into
<parameter>crypted</parameter>. Encrypted data can be decrypted via
<methodname>openssl_private_decrypt</methodname>. <parameter>padding</parameter>
defaults to OPENSSL_PKCS1_PADDING, but can also be one of
OPENSSL_SSLV23_PADDING, OPENSSL_PKCS1_OAEP_PADDING,
OPENSSL_NO_PADDING.
</para>
<para>
&return.success;
</para>
<para>
This function can be used e.g. to encrypt message which can be then read
only by owner of the private key. It can be also used to store secure data
in database.
</para>
<para>
See also <function>openssl_private_decrypt</function> and
<function>openssl_private_encrypt</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
-->