php-doc-en/reference/sodium/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<appendix xml:id="sodium.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.constants;
 &extension.constants;
 <para>
  <variablelist>
   <varlistentry xml:id="constant.sodium-library-version">
    <term>
     <constant>SODIUM_LIBRARY_VERSION</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-library-major-version">
    <term>
     <constant>SODIUM_LIBRARY_MAJOR_VERSION</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-library-minor-version">
    <term>
     <constant>SODIUM_LIBRARY_MINOR_VERSION</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-aes256gcm-keybytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-aes256gcm-nsecbytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_AES256GCM_NSECBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-aes256gcm-npubbytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-aes256gcm-abytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_AES256GCM_ABYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-chacha20poly1305-keybytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-chacha20poly1305-nsecbytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NSECBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-chacha20poly1305-npubbytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NPUBBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-chacha20poly1305-abytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-chacha20poly1305-ietf-keybytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-chacha20poly1305-ietf-nsecbytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NSECBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-chacha20poly1305-ietf-npubbytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-aead-chacha20poly1305-ietf-abytes">
    <term>
     <constant>SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-auth-bytes">
    <term>
     <constant>SODIUM_CRYPTO_AUTH_BYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-auth-keybytes">
    <term>
     <constant>SODIUM_CRYPTO_AUTH_KEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-box-sealbytes">
    <term>
     <constant>SODIUM_CRYPTO_BOX_SEALBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-box-secretkeybytes">
    <term>
     <constant>SODIUM_CRYPTO_BOX_SECRETKEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-box-publickeybytes">
    <term>
     <constant>SODIUM_CRYPTO_BOX_PUBLICKEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-box-keypairbytes">
    <term>
     <constant>SODIUM_CRYPTO_BOX_KEYPAIRBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-box-macbytes">
    <term>
     <constant>SODIUM_CRYPTO_BOX_MACBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-box-noncebytes">
    <term>
     <constant>SODIUM_CRYPTO_BOX_NONCEBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-box-seedbytes">
    <term>
     <constant>SODIUM_CRYPTO_BOX_SEEDBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-kdf-bytes-min">
    <term>
     <constant>SODIUM_CRYPTO_KDF_BYTES_MIN</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-kdf-bytes-max">
    <term>
     <constant>SODIUM_CRYPTO_KDF_BYTES_MAX</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-kdf-contextbytes">
    <term>
     <constant>SODIUM_CRYPTO_KDF_CONTEXTBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-kdf-keybytes">
    <term>
     <constant>SODIUM_CRYPTO_KDF_KEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-kx-seedbytes">
    <term>
     <constant>SODIUM_CRYPTO_KX_SEEDBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-kx-sessionkeybytes">
    <term>
     <constant>SODIUM_CRYPTO_KX_SESSIONKEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-kx-publickeybytes">
    <term>
     <constant>SODIUM_CRYPTO_KX_PUBLICKEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-kx-secretkeybytes">
    <term>
     <constant>SODIUM_CRYPTO_KX_SECRETKEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-kx-keypairbytes">
    <term>
     <constant>SODIUM_CRYPTO_KX_KEYPAIRBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-generichash-bytes">
    <term>
     <constant>SODIUM_CRYPTO_GENERICHASH_BYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-generichash-bytes-min">
    <term>
     <constant>SODIUM_CRYPTO_GENERICHASH_BYTES_MIN</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-generichash-bytes-max">
    <term>
     <constant>SODIUM_CRYPTO_GENERICHASH_BYTES_MAX</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-generichash-keybytes">
    <term>
     <constant>SODIUM_CRYPTO_GENERICHASH_KEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-generichash-keybytes-min">
    <term>
     <constant>SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-generichash-keybytes-max">
    <term>
     <constant>SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-alg-argon2i13">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_ALG_ARGON2I13</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-alg-argon2id13">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-alg-default">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_ALG_DEFAULT</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-saltbytes">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_SALTBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-strprefix">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_STRPREFIX</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-opslimit-interactive">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-memlimit-interactive">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-opslimit-moderate">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-memlimit-moderate">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-opslimit-sensitive">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-memlimit-sensitive">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-scryptsalsa208sha256-saltbytes">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_SALTBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-scryptsalsa208sha256-strprefix">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_STRPREFIX</constant>
     (<type>string</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-scryptsalsa208sha256-opslimit-interactive">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_INTERACTIVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-scryptsalsa208sha256-memlimit-interactive">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_INTERACTIVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-scryptsalsa208sha256-opslimit-sensitive">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_SENSITIVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-pwhash-scryptsalsa208sha256-memlimit-sensitive">
    <term>
     <constant>SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_SENSITIVE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-scalarmult-bytes">
    <term>
     <constant>SODIUM_CRYPTO_SCALARMULT_BYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-scalarmult-scalarbytes">
    <term>
     <constant>SODIUM_CRYPTO_SCALARMULT_SCALARBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-shorthash-bytes">
    <term>
     <constant>SODIUM_CRYPTO_SHORTHASH_BYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-shorthash-keybytes">
    <term>
     <constant>SODIUM_CRYPTO_SHORTHASH_KEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-secretbox-keybytes">
    <term>
     <constant>SODIUM_CRYPTO_SECRETBOX_KEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-secretbox-macbytes">
    <term>
     <constant>SODIUM_CRYPTO_SECRETBOX_MACBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-secretbox-noncebytes">
    <term>
     <constant>SODIUM_CRYPTO_SECRETBOX_NONCEBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-sign-bytes">
    <term>
     <constant>SODIUM_CRYPTO_SIGN_BYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-sign-seedbytes">
    <term>
     <constant>SODIUM_CRYPTO_SIGN_SEEDBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-sign-publickeybytes">
    <term>
     <constant>SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-sign-secretkeybytes">
    <term>
     <constant>SODIUM_CRYPTO_SIGN_SECRETKEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-sign-keypairbytes">
    <term>
     <constant>SODIUM_CRYPTO_SIGN_KEYPAIRBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-stream-noncebytes">
    <term>
     <constant>SODIUM_CRYPTO_STREAM_NONCEBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.sodium-crypto-stream-keybytes">
    <term>
     <constant>SODIUM_CRYPTO_STREAM_KEYBYTES</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>
</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
-->