php-doc-ru/reference/rnp/functions/rnp-op-encrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 79bc1248b2295d9c9f0837d1ddcaea9d7c2853a7 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.rnp-op-encrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>rnp_op_encrypt</refname>
  <refpurpose>Шифрует сообщение</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>rnp_op_encrypt</methodname>
   <methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam>
   <methodparam><type>string</type><parameter>message</parameter></methodparam>
   <methodparam><type>array</type><parameter>recipient_keys_fp</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>

  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>ffi</parameter></term>
    <listitem>
     <para>
      &rnp.parameter.ffi-description;
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>message</parameter></term>
    <listitem>
     <para>
      Сообщение, которое необходимо зашифровать.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>recipient_keys_fp</parameter></term>
    <listitem>
     <para>
      Массив с отпечатками ключей получателя. Должен присутствовать хотя бы один ключ.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      Ассоциативный массив с опциями.
     </para>
     <informaltable>
      <tgroup cols="2">
       <thead>
        <row>
         <entry>Ключ</entry>
         <entry>Тип данных</entry>
         <entry>&Description;</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry><literal>"compression_alg"</literal></entry>
         <entry>string</entry>
         <entry>Алгоритм сжатия. Для включения сжатия данных
          должны быть заданы как <literal>"compression_alg"</literal>, так и <literal>"compression_level"</literal>.
         </entry>
        </row>
        <row>
         <entry><literal>"compression_level"</literal></entry>
         <entry>integer</entry>
         <entry>Уровень сжатия, 0-9. 0 отключает сжатие.</entry>
        </row>
        <row>
         <entry><literal>"armor"</literal></entry>
         <entry>boolean</entry>
         <entry>Включает ASCII-защищённый вывод. По умолчанию отключён.</entry>
        </row>
        <row>
         <entry><literal>"add_signature"</literal></entry>
         <entry>boolean</entry>
         <entry>Зашифрованное сообщение будет также подписано.</entry>
        </row>
        <row>
         <entry><literal>"hash"</literal></entry>
         <entry>string</entry>
         <entry>Устанавливает хеш-алгоритм, используемый при вычислении подписи. Опции "add_signature" должно быть установлено значение &true;.</entry>
        </row>
        <row>
         <entry><literal>"creation_time"</literal></entry>
         <entry>integer</entry>
         <entry>Устанавливает время создания подписи в секундах с 1 января 1970 года по Гринвичу. По умолчанию используется текущее время.</entry>
        </row>
        <row>
         <entry><literal>"expiration_time"</literal></entry>
         <entry>integer</entry>
         <entry>Устанавливает время истечения срока действия подписи в секундах с момента создания. Значение 0 используется для пометки подписи как не истекающей (значение по умолчанию).</entry>
        </row>
        <row>
         <entry><literal>"password"</literal></entry>
         <entry>string</entry>
         <entry>Добавляет пароль, который используется для шифрования данных.</entry>
        </row>
        <row>
         <entry><literal>"cipher"</literal></entry>
         <entry>string</entry>
         <entry>
          Устанавливает алгоритм симметричного шифрования. Возможные значения: "IDEA", "TRIPLEDES",
          "CAST5", "BLOWFISH", "AES128", "AES192", "AES256", "TWOFISH", "CAMELLIA128",
          "CAMELLIA192", "CAMELLIA256", "SM4".
         </entry>
        </row>
        <row>
         <entry><literal>"aead"</literal></entry>
         <entry>string</entry>
         <entry>
          Устанавливает алгоритм режима AEAD. Возможные значения: "None" для отключения AEAD, "EAX", "OCB".
         </entry>
        </row>
        <row>
         <entry><literal>"aead_bits"</literal></entry>
         <entry>integer</entry>
         <entry>Устанавливает длину ячейки для режима AEAD через количество битов размера ячейки. Должно быть от 0 до 56.</entry>
        </row>
        <row>
         <entry><literal>"flags"</literal></entry>
         <entry>integer</entry>
         <entry>
          Устанавливает дополнительные флаги шифрования. Поддерживаемые флаги:
          RNP_ENCRYPT_NOWRAP - не заворачивать данные в литеральный пакет данных.
          Это позволит шифровать уже подписанные данные.
         </entry>
        </row>
        <row>
         <entry><literal>"file_name"</literal></entry>
         <entry>string</entry>
         <entry>
          Устанавливает внутреннее имя файла для шифруемых данных.
          Специальное значение _CONSOLE может использоваться для пометки сообщения
          как "только для ваших глаз", т.е. оно не должно нигде храниться,
          а только отображаться получателю. По умолчанию используется пустая строка.
         </entry>
        </row>
        <row>
         <entry><literal>"file_mtime"</literal></entry>
         <entry>integer</entry>
         <entry>Устанавливает дату модификации входного файла в секундах с 1 января 1970 года по Гринвичу.</entry>
        </row>
       </tbody>
      </tgroup>
     </informaltable>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Зашифрованные данные в случае успешного выполнения&return.falseforfailure;.
  </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:"~/.phpdoc/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
-->