<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.rnp.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'rnp.constants.php',
    1 => 'Predefined Constants',
    2 => 'Predefined Constants',
  ),
  'up' => 
  array (
    0 => 'book.rnp.php',
    1 => 'Rnp',
  ),
  'prev' => 
  array (
    0 => 'rnp.installation.php',
    1 => 'Installation',
  ),
  'next' => 
  array (
    0 => 'rnp.examples.php',
    1 => 'Examples',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/rnp/constants.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="rnp.constants" class="appendix">
 <h1 class="title">Predefined Constants</h1>

 <p class="simpara">
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
</p>
 <dl>
  
   <dt id="constant.rnp-keystore-gpg">
    <strong><code><a href="rnp.constants.php#constant.rnp-keystore-gpg">RNP_KEYSTORE_GPG</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Keystore format &quot;GPG&quot;.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-keystore-kbx">
    <strong><code><a href="rnp.constants.php#constant.rnp-keystore-kbx">RNP_KEYSTORE_KBX</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Keystore format &quot;KBX&quot;. For public keys only.
     A keybox is a file format used to store public keys along with meta information and indices.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-keystore-g10">
    <strong><code><a href="rnp.constants.php#constant.rnp-keystore-g10">RNP_KEYSTORE_G10</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Keystore format &quot;G10&quot;. For private keys.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-load-save-public-keys">
    <strong><code><a href="rnp.constants.php#constant.rnp-load-save-public-keys">RNP_LOAD_SAVE_PUBLIC_KEYS</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Load or save public keys only. Can be OR-ed with <strong><code><a href="rnp.constants.php#constant.rnp-load-save-secret-keys">RNP_LOAD_SAVE_SECRET_KEYS</a></code></strong>
     to load both public and private keys to the FFI context or save them from the context.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-load-save-secret-keys">
    <strong><code><a href="rnp.constants.php#constant.rnp-load-save-secret-keys">RNP_LOAD_SAVE_SECRET_KEYS</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Load or save secret keys only. Can be OR-ed with <strong><code><a href="rnp.constants.php#constant.rnp-load-save-public-keys">RNP_LOAD_SAVE_PUBLIC_KEYS</a></code></strong>
     to load both public and private keys to the FFI context or save them from the context.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-load-save-permissive">
    <strong><code><a href="rnp.constants.php#constant.rnp-load-save-permissive">RNP_LOAD_SAVE_PERMISSIVE</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Allows to ignore bad signature/key/subkey packets during key import.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-load-save-single">
    <strong><code><a href="rnp.constants.php#constant.rnp-load-save-single">RNP_LOAD_SAVE_SINGLE</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     If set, only the first key will be loaded.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-load-save-base64">
    <strong><code><a href="rnp.constants.php#constant.rnp-load-save-base64">RNP_LOAD_SAVE_BASE64</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Allow import of base64-encoded keys (autocrypt ones).
    </span>
   </dd>
  
  
   <dt id="constant.rnp-feature-symm-alg">
    <strong><code><a href="rnp.constants.php#constant.rnp-feature-symm-alg">RNP_FEATURE_SYMM_ALG</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     List available symmetric encryption algorithms.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-feature-aead-alg">
    <strong><code><a href="rnp.constants.php#constant.rnp-feature-aead-alg">RNP_FEATURE_AEAD_ALG</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     List available AEAD algorithms.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-feature-prot-mode">
    <strong><code><a href="rnp.constants.php#constant.rnp-feature-prot-mode">RNP_FEATURE_PROT_MODE</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     List available protection modes.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-feature-pk-alg">
    <strong><code><a href="rnp.constants.php#constant.rnp-feature-pk-alg">RNP_FEATURE_PK_ALG</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     List available public key algorithms.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-feature-hash-alg">
    <strong><code><a href="rnp.constants.php#constant.rnp-feature-hash-alg">RNP_FEATURE_HASH_ALG</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     List available hash algorithms.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-feature-comp-alg">
    <strong><code><a href="rnp.constants.php#constant.rnp-feature-comp-alg">RNP_FEATURE_COMP_ALG</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     List available compression algorithms.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-feature-curve">
    <strong><code><a href="rnp.constants.php#constant.rnp-feature-curve">RNP_FEATURE_CURVE</a></code></strong>
    (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     List available elliptic curves.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-dump-mpi">
    <strong><code><a href="rnp.constants.php#constant.rnp-dump-mpi">RNP_DUMP_MPI</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Dump MPI (Multi-precision integer) values.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-dump-raw">
    <strong><code><a href="rnp.constants.php#constant.rnp-dump-raw">RNP_DUMP_RAW</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Dump raw packet contents as well.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-dump-grip">
    <strong><code><a href="rnp.constants.php#constant.rnp-dump-grip">RNP_DUMP_GRIP</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Dump key fingerprints and grips.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-json-dump-mpi">
    <strong><code><a href="rnp.constants.php#constant.rnp-json-dump-mpi">RNP_JSON_DUMP_MPI</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Dump MPI (Multi-precision integer) values.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-json-dump-raw">
    <strong><code><a href="rnp.constants.php#constant.rnp-json-dump-raw">RNP_JSON_DUMP_RAW</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Dump raw packet contents as well.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-json-dump-grip">
    <strong><code><a href="rnp.constants.php#constant.rnp-json-dump-grip">RNP_JSON_DUMP_GRIP</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Dump key fingerprints and grips.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-encrypt-nowrap">
    <strong><code><a href="rnp.constants.php#constant.rnp-encrypt-nowrap">RNP_ENCRYPT_NOWRAP</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Allows encryption of signed message. Message is not wrapped
     into literal data packet.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-key-export-armored">
    <strong><code><a href="rnp.constants.php#constant.rnp-key-export-armored">RNP_KEY_EXPORT_ARMORED</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Enable ASCII-armoring of exported data.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-key-export-public">
    <strong><code><a href="rnp.constants.php#constant.rnp-key-export-public">RNP_KEY_EXPORT_PUBLIC</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Export public key.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-key-export-secret">
    <strong><code><a href="rnp.constants.php#constant.rnp-key-export-secret">RNP_KEY_EXPORT_SECRET</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Export secret key.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-key-export-subkeys">
    <strong><code><a href="rnp.constants.php#constant.rnp-key-export-subkeys">RNP_KEY_EXPORT_SUBKEYS</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     If primary key is being exported, all subkeys will be exported too.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-key-export-base64">
    <strong><code><a href="rnp.constants.php#constant.rnp-key-export-base64">RNP_KEY_EXPORT_BASE64</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Export base64-encoded autocrypt key instead of binary.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-key-remove-public">
    <strong><code><a href="rnp.constants.php#constant.rnp-key-remove-public">RNP_KEY_REMOVE_PUBLIC</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Remove public key.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-key-remove-secret">
    <strong><code><a href="rnp.constants.php#constant.rnp-key-remove-secret">RNP_KEY_REMOVE_SECRET</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     Remove secret key.
    </span>
   </dd>
  
  
   <dt id="constant.rnp-key-remove-subkeys">
    <strong><code><a href="rnp.constants.php#constant.rnp-key-remove-subkeys">RNP_KEY_REMOVE_SUBKEYS</a></code></strong>
    (<span class="type"><a href="language.types.integer.php" class="type integer">integer</a></span>)
   </dt>
   <dd>
    <span class="simpara">
     If primary key is being deleted, all of its subkeys will be removed too.
    </span>
   </dd>
  
 </dl>
</div>
<?php manual_footer($setup); ?>