<?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 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.rnp-op-encrypt.php',
    1 => 'rnp_op_encrypt',
    2 => 'Шифрует сообщение',
  ),
  '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' => 'ru',
    '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">Шифрует сообщение</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="simpara">

  </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>
     <span class="simpara">
      FFI-объект, который возвращает функция <span class="function"><a href="function.rnp-ffi-create.php" class="function">rnp_ffi_create()</a></span>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">message</code></dt>
    <dd>
     <span class="simpara">
      Сообщение, которое необходимо зашифровать.
     </span>
    </dd>
   
   
    <dt><code class="parameter">recipient_keys_fp</code></dt>
    <dd>
     <span class="simpara">
      Массив с отпечатками ключей получателя. Должен присутствовать хотя бы один ключ.
     </span>
    </dd>
   
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <span class="simpara">
      Ассоциативный массив с опциями.
     </span>
     <table class="doctable informaltable">
      
       <thead>
        <tr>
         <th>Ключ</th>
         <th>Тип данных</th>
         <th>Описание</th>
        </tr>

       </thead>

       <tbody class="tbody">
        <tr>
         <td><code class="literal">&quot;compression_alg&quot;</code></td>
         <td>string</td>
         <td>Алгоритм сжатия. Для включения сжатия данных
          должны быть заданы как <code class="literal">&quot;compression_alg&quot;</code>, так и <code class="literal">&quot;compression_level&quot;</code>.
         </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;compression_level&quot;</code></td>
         <td>integer</td>
         <td>Уровень сжатия, 0-9. 0 отключает сжатие.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;armor&quot;</code></td>
         <td>boolean</td>
         <td>Включает ASCII-защищённый вывод. По умолчанию отключён.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;add_signature&quot;</code></td>
         <td>boolean</td>
         <td>Зашифрованное сообщение будет также подписано.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;hash&quot;</code></td>
         <td>string</td>
         <td>Устанавливает хеш-алгоритм, используемый при вычислении подписи. Опции &quot;add_signature&quot; должно быть установлено значение <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>Устанавливает время создания подписи в секундах с 1 января 1970 года по Гринвичу. По умолчанию используется текущее время.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;expiration_time&quot;</code></td>
         <td>integer</td>
         <td>Устанавливает время истечения срока действия подписи в секундах с момента создания. Значение 0 используется для пометки подписи как не истекающей (значение по умолчанию).</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;password&quot;</code></td>
         <td>string</td>
         <td>Добавляет пароль, который используется для шифрования данных.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;cipher&quot;</code></td>
         <td>string</td>
         <td>
          Устанавливает алгоритм симметричного шифрования. Возможные значения: &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>
          Устанавливает алгоритм режима AEAD. Возможные значения: &quot;None&quot; для отключения AEAD, &quot;EAX&quot;, &quot;OCB&quot;.
         </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;aead_bits&quot;</code></td>
         <td>integer</td>
         <td>Устанавливает длину ячейки для режима AEAD через количество битов размера ячейки. Должно быть от 0 до 56.</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;flags&quot;</code></td>
         <td>integer</td>
         <td>
          Устанавливает дополнительные флаги шифрования. Поддерживаемые флаги:
          RNP_ENCRYPT_NOWRAP - не заворачивать данные в литеральный пакет данных.
          Это позволит шифровать уже подписанные данные.
         </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;file_name&quot;</code></td>
         <td>string</td>
         <td>
          Устанавливает внутреннее имя файла для шифруемых данных.
          Специальное значение _CONSOLE может использоваться для пометки сообщения
          как &quot;только для ваших глаз&quot;, т.е. оно не должно нигде храниться,
          а только отображаться получателю. По умолчанию используется пустая строка.
         </td>
        </tr>

        <tr>
         <td><code class="literal">&quot;file_mtime&quot;</code></td>
         <td>integer</td>
         <td>Устанавливает дату модификации входного файла в секундах с 1 января 1970 года по Гринвичу.</td>
        </tr>

       </tbody>
      
     </table>

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


 <div class="refsect1 returnvalues" id="refsect1-function.rnp-op-encrypt-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="simpara">
   Зашифрованные данные в случае успешного выполнения или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникла ошибка.
  </p>
 </div>


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