archived-doc-en/reference/rnp/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<appendix xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="rnp.constants">
 &reftitle.constants;
 &extension.constants;
 <variablelist>
  <varlistentry xml:id="constant.rnp-keystore-gpg">
   <term>
    <constant>RNP_KEYSTORE_GPG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Keystore format "GPG".
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-keystore-kbx">
   <term>
    <constant>RNP_KEYSTORE_KBX</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Keystore format "KBX". For public keys only.
     A keybox is a file format used to store public keys along with meta information and indices.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-keystore-g10">
   <term>
    <constant>RNP_KEYSTORE_G10</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Keystore format "G10". For private keys.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-load-save-public-keys">
   <term>
    <constant>RNP_LOAD_SAVE_PUBLIC_KEYS</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Load or save public keys only. Can be OR-ed with <constant>RNP_LOAD_SAVE_SECRET_KEYS</constant>
     to load both public and private keys to the FFI context or save them from the context.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-load-save-secret-keys">
   <term>
    <constant>RNP_LOAD_SAVE_SECRET_KEYS</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Load or save secret keys only. Can be OR-ed with <constant>RNP_LOAD_SAVE_PUBLIC_KEYS</constant>
     to load both public and private keys to the FFI context or save them from the context.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-load-save-permissive">
   <term>
    <constant>RNP_LOAD_SAVE_PERMISSIVE</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Allows to ignore bad signature/key/subkey packets during key import.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-load-save-single">
   <term>
    <constant>RNP_LOAD_SAVE_SINGLE</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     If set, only the first key will be loaded.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-load-save-base64">
   <term>
    <constant>RNP_LOAD_SAVE_BASE64</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Allow import of base64-encoded keys (autocrypt ones).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-feature-symm-alg">
   <term>
    <constant>RNP_FEATURE_SYMM_ALG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     List available symmetric encryption algorithms.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-feature-aead-alg">
   <term>
    <constant>RNP_FEATURE_AEAD_ALG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     List available AEAD algorithms.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-feature-prot-mode">
   <term>
    <constant>RNP_FEATURE_PROT_MODE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     List available protection modes.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-feature-pk-alg">
   <term>
    <constant>RNP_FEATURE_PK_ALG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     List available public key algorithms.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-feature-hash-alg">
   <term>
    <constant>RNP_FEATURE_HASH_ALG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     List available hash algorithms.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-feature-comp-alg">
   <term>
    <constant>RNP_FEATURE_COMP_ALG</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     List available compression algorithms.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-feature-curve">
   <term>
    <constant>RNP_FEATURE_CURVE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     List available elliptic curves.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-dump-mpi">
   <term>
    <constant>RNP_DUMP_MPI</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Dump MPI (Multi-precision integer) values.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-dump-raw">
   <term>
    <constant>RNP_DUMP_RAW</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Dump raw packet contents as well.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-dump-grip">
   <term>
    <constant>RNP_DUMP_GRIP</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Dump key fingerprints and grips.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-json-dump-mpi">
   <term>
    <constant>RNP_JSON_DUMP_MPI</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Dump MPI (Multi-precision integer) values.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-json-dump-raw">
   <term>
    <constant>RNP_JSON_DUMP_RAW</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Dump raw packet contents as well.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-json-dump-grip">
   <term>
    <constant>RNP_JSON_DUMP_GRIP</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Dump key fingerprints and grips.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-encrypt-nowrap">
   <term>
    <constant>RNP_ENCRYPT_NOWRAP</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Allows encryption of signed message. Message is not wrapped
     into literal data packet.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-key-export-armored">
   <term>
    <constant>RNP_KEY_EXPORT_ARMORED</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Enable ASCII-armoring of exported data.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-key-export-public">
   <term>
    <constant>RNP_KEY_EXPORT_PUBLIC</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Export public key.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-key-export-secret">
   <term>
    <constant>RNP_KEY_EXPORT_SECRET</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Export secret key.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-key-export-subkeys">
   <term>
    <constant>RNP_KEY_EXPORT_SUBKEYS</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     If primary key is being exported, all subkeys will be exported too.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-key-export-base64">
   <term>
    <constant>RNP_KEY_EXPORT_BASE64</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Export base64-encoded autocrypt key instead of binary.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-key-remove-public">
   <term>
    <constant>RNP_KEY_REMOVE_PUBLIC</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Remove public key.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-key-remove-secret">
   <term>
    <constant>RNP_KEY_REMOVE_SECRET</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     Remove secret key.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.rnp-key-remove-subkeys">
   <term>
    <constant>RNP_KEY_REMOVE_SUBKEYS</constant>
    (<type>integer</type>)
   </term>
   <listitem>
    <simpara>
     If primary key is being deleted, all of its subkeys will be removed too.
    </simpara>
   </listitem>
  </varlistentry>
 </variablelist>
</appendix>
<!-- 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
-->