Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > f800694edefe91adea2624f711a41a2d > files > 5022

php-manual-en-5.5.7-1.mga4.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Encrypts data with private key</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.openssl-private-decrypt.html">openssl_private_decrypt</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.openssl-public-decrypt.html">openssl_public_decrypt</a></div>
 <div class="up"><a href="ref.openssl.html">OpenSSL Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.openssl-private-encrypt" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">openssl_private_encrypt</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">openssl_private_encrypt</span> &mdash; <span class="dc-title">Encrypts data with private key </span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.openssl-private-encrypt-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="type">bool</span> <span class="methodname"><strong>openssl_private_encrypt</strong></span>
    ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter reference">&$crypted</code></span>
   , <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$key</code></span>
   [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$padding</code><span class="initializer"> = OPENSSL_PKCS1_PADDING</span></span>
  ] )</div>

  <p class="para rdfs-comment">
    <span class="function"><strong>openssl_private_encrypt()</strong></span> encrypts <em><code class="parameter">data</code></em>
   with private <em><code class="parameter">key</code></em> and stores the result into
   <em><code class="parameter">crypted</code></em>. Encrypted data can be decrypted via
    <span class="function"><a href="function.openssl-public-decrypt.html" class="function">openssl_public_decrypt()</a></span>. 
  </p>
  <p class="para">
   This function can be used e.g. to sign data (or its hash) to prove that it
   is not written by someone else.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.openssl-private-encrypt-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>

    <dt>

     <span class="term"><em><code class="parameter">data</code></em></span>
     <dd>

      <p class="para">
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">crypted</code></em></span>
     <dd>

      <p class="para">
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">key</code></em></span>
     <dd>

      <p class="para">
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">padding</code></em></span>
     <dd>

      <p class="para">
       <em><code class="parameter">padding</code></em> can be one of
       <strong><code>OPENSSL_PKCS1_PADDING</code></strong>,
       <strong><code>OPENSSL_NO_PADDING</code></strong>.
      </p>
     </dd>

    </dt>

   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.openssl-private-encrypt-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.openssl-private-encrypt-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"> <span class="function"><a href="function.openssl-public-encrypt.html" class="function" rel="rdfs-seeAlso">openssl_public_encrypt()</a> - Encrypts data with public key</span></li>
    <li class="member"> <span class="function"><a href="function.openssl-public-decrypt.html" class="function" rel="rdfs-seeAlso">openssl_public_decrypt()</a> - Decrypts data with public key</span></li>
   </ul>
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="function.openssl-private-decrypt.html">openssl_private_decrypt</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="function.openssl-public-decrypt.html">openssl_public_decrypt</a></div>
 <div class="up"><a href="ref.openssl.html">OpenSSL Functions</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>