rnp-op-encrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<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>Encrypt message</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>
      Message to be encrypted.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>recipient_keys_fp</parameter></term>
    <listitem>
     <para>
      Array with fingerprints of recipient's keys. At least one key must be present.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      An associative array with options.
     </para>
     <informaltable>
      <tgroup cols="2">
       <thead>
        <row>
         <entry>Key</entry>
         <entry>Data type</entry>
         <entry>&Description;</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry><literal>"compression_alg"</literal></entry>
         <entry>string</entry>
         <entry>Compression algorithm. Both
	   <literal>"compression_alg"</literal> and <literal>"compression_level"</literal>
	   must be set in order to enable data compression.
	 </entry>
        </row>
        <row>
         <entry><literal>"compression_level"</literal></entry>
         <entry>integer</entry>
         <entry>Compression level, 0-9. 0 disables compression.</entry>
        </row>
        <row>
         <entry><literal>"armor"</literal></entry>
         <entry>boolean</entry>
         <entry>Enable ASCII-armored output. Disabled by default.</entry>
        </row>
        <row>
         <entry><literal>"add_signature"</literal></entry>
         <entry>boolean</entry>
         <entry>Encrypted message will be also signed.</entry>
        </row>
        <row>
         <entry><literal>"hash"</literal></entry>
         <entry>string</entry>
         <entry>Set hash algorithm used during signature calculation. "add_signature" option should be set to &true;</entry>
        </row>
        <row>
         <entry><literal>"creation_time"</literal></entry>
         <entry>integer</entry>
         <entry>Set signature creation time in seconds since Jan, 1 1970 UTC. By default current time is used.</entry>
        </row>
        <row>
         <entry><literal>"expiration_time"</literal></entry>
         <entry>integer</entry>
         <entry>Set signature expiration time in seconds since the creation time. 0 value is used to mark
          signature as non-expiring (default value).</entry>
        </row>
        <row>
         <entry><literal>"password"</literal></entry>
         <entry>string</entry>
         <entry>Add password which is used to encrypt data.</entry>
        </row>
        <row>
         <entry><literal>"cipher"</literal></entry>
         <entry>string</entry>
         <entry>
          Set symmetric encryption algorithm. Possible values are "IDEA", "TRIPLEDES",
	  "CAST5", "BLOWFISH", "AES128", "AES192", "AES256", "TWOFISH", "CAMELLIA128",
          "CAMELLIA192", "CAMELLIA256", "SM4".
	 </entry>
        </row>
        <row>
         <entry><literal>"aead"</literal></entry>
         <entry>string</entry>
         <entry>
          Set AEAD mode algorithm. Possible values are "None" to disable AEAD, "EAX", "OCB".
	 </entry>
        </row>
        <row>
         <entry><literal>"aead_bits"</literal></entry>
         <entry>integer</entry>
         <entry>Set chunk length for AEAD mode via number of chunk size bits. Must be between 0 to 56.</entry>
        </row>
        <row>
         <entry><literal>"flags"</literal></entry>
         <entry>integer</entry>
         <entry>
          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.
         </entry>
        </row>
        <row>
         <entry><literal>"file_name"</literal></entry>
         <entry>string</entry>
         <entry>Set the internally stored file name for the data being encrypted. Special value _CONSOLE may be used to mark message
          as 'for your eyes only', i.e. it should not be stored anywhere but only displayed
          to the receiver. Default is the empty string.</entry>
        </row>
        <row>
         <entry><literal>"file_mtime"</literal></entry>
         <entry>integer</entry>
         <entry>Set input file modification date in seconds since Jan, 1 1970 UTC.</entry>
        </row>
       </tbody>
      </tgroup>
     </informaltable>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Encrypted data on success&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
-->