<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.rnp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'uk',
  ),
  'this' => 
  array (
    0 => 'function.rnp-op-encrypt.php',
    1 => 'rnp_op_encrypt',
    2 => 'Encrypt message',
  ),
  'up' => 
  array (
    0 => 'ref.rnp.php',
    1 => 'Rnp Функції',
  ),
  'prev' => 
  array (
    0 => 'function.rnp-locate-key.php',
    1 => 'rnp_locate_key',
  ),
  'next' => 
  array (
    0 => 'function.rnp-op-generate-key.php',
    1 => 'rnp_op_generate_key',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/rnp/functions/rnp-op-encrypt.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.rnp-op-encrypt" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">rnp_op_encrypt</h1>
  <p class="verinfo">(PECL rnp &gt;= 0.1.1)</p><p class="refpurpose"><span class="refname">rnp_op_encrypt</span> &mdash; <span class="dc-title">Encrypt message</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.rnp-op-encrypt-description">
  <h3 class="title">Опис</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>rnp_op_encrypt</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.rnpffi.php" class="type RnpFFI">RnpFFI</a></span> <code class="parameter">$ffi</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$message</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$recipient_keys_fp</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = ?</span></span><br>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">

  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.rnp-op-encrypt-parameters">
  <h3 class="title">Параметри</h3>
  <dl>
   
    <dt><code class="parameter">ffi</code></dt>
    <dd>
     <p class="para">
      Об&#039;єкт FFI, якого повертає rnp_ffi_create.
     </p>
    </dd>
   
   
    <dt><code class="parameter">message</code></dt>
    <dd>
     <p class="para">
      Message to be encrypted.
     </p>
    </dd>
   
   
    <dt><code class="parameter">recipient_keys_fp</code></dt>
    <dd>
     <p class="para">
      Array with fingerprints of recipient&#039;s keys. At least one key must be present.
     </p>
    </dd>
   
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <p class="para">
      An associative array with options.
     </p>
     <table class="doctable informaltable">
      
       <thead>
        <tr>
         <th>Key</th>
         <th>Data type</th>
         <th>Опис</th>
        </tr>

       </thead>

       <tbody class="tbody">
        <tr>
         <td><code class="literal">&quot;compression_alg&quot;</code></td>
         <td>string</td>
         <td>Compression algorithm. Both
	   <code class="literal">&quot;compression_alg&quot;</code> and <code class="literal">&quot;compression_level&quot;</code>
	   must be set in order to enable data compression.
	 </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;compression_level&quot;</code></td>
         <td>integer</td>
         <td>Compression level, 0-9. 0 disables compression.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;armor&quot;</code></td>
         <td>boolean</td>
         <td>Enable ASCII-armored output. Disabled by default.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;add_signature&quot;</code></td>
         <td>boolean</td>
         <td>Encrypted message will be also signed.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;hash&quot;</code></td>
         <td>string</td>
         <td>Set hash algorithm used during signature calculation. &quot;add_signature&quot; option should be set to <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong></td>
        </tr>

        <tr>
         <td><code class="literal">&quot;creation_time&quot;</code></td>
         <td>integer</td>
         <td>Set signature creation time in seconds since Jan, 1 1970 UTC. By default current time is used.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;expiration_time&quot;</code></td>
         <td>integer</td>
         <td>Set signature expiration time in seconds since the creation time. 0 value is used to mark
          signature as non-expiring (default value).</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;password&quot;</code></td>
         <td>string</td>
         <td>Add password which is used to encrypt data.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;cipher&quot;</code></td>
         <td>string</td>
         <td>
          Set symmetric encryption algorithm. Possible values are &quot;IDEA&quot;, &quot;TRIPLEDES&quot;,
	  &quot;CAST5&quot;, &quot;BLOWFISH&quot;, &quot;AES128&quot;, &quot;AES192&quot;, &quot;AES256&quot;, &quot;TWOFISH&quot;, &quot;CAMELLIA128&quot;,
          &quot;CAMELLIA192&quot;, &quot;CAMELLIA256&quot;, &quot;SM4&quot;.
	 </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;aead&quot;</code></td>
         <td>string</td>
         <td>
          Set AEAD mode algorithm. Possible values are &quot;None&quot; to disable AEAD, &quot;EAX&quot;, &quot;OCB&quot;.
	 </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;aead_bits&quot;</code></td>
         <td>integer</td>
         <td>Set chunk length for AEAD mode via number of chunk size bits. Must be between 0 to 56.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;flags&quot;</code></td>
         <td>integer</td>
         <td>
          Set additional encryption flags. Supported flags: RNP_ENCRYPT_NOWRAP - do not wrap the data in a literal data packet. This
          would allow to encrypt already signed data.
         </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;file_name&quot;</code></td>
         <td>string</td>
         <td>Set the internally stored file name for the data being encrypted. Special value _CONSOLE may be used to mark message
          as &#039;for your eyes only&#039;, i.e. it should not be stored anywhere but only displayed
          to the receiver. Default is the empty string.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;file_mtime&quot;</code></td>
         <td>integer</td>
         <td>Set input file modification date in seconds since Jan, 1 1970 UTC.</td>
        </tr>

       </tbody>
      
     </table>

    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.rnp-op-encrypt-returnvalues">
  <h3 class="title">Значення, що повертаються</h3>
  <p class="para">
   Encrypted data on success або <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> в разі помилки.
  </p>
 </div>



</div><?php manual_footer($setup); ?>