sodium-crypto-aead-chacha20poly1305-ietf-decrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14e3e35ca0c82b3b5fb3fd71b9dd70e9eb250ab1 Maintainer: joshuaruesweg Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.sodium-crypto-aead-chacha20poly1305-ietf-decrypt">
 <refnamediv>
  <refname>sodium_crypto_aead_chacha20poly1305_ietf_decrypt</refname>
  <refpurpose>Überprüft, ob der Chiffriertext ein gültiges Tag enthält</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>sodium_crypto_aead_chacha20poly1305_ietf_decrypt</methodname>
   <methodparam><type>string</type><parameter>ciphertext</parameter></methodparam>
   <methodparam><type>string</type><parameter>additional_data</parameter></methodparam>
   <methodparam><type>string</type><parameter>nonce</parameter></methodparam>
   <methodparam><type>string</type><parameter>key</parameter></methodparam>
  </methodsynopsis>
  <para>
   Verschlüsselt und authentifiziert eine Nachricht mit ChaCha20-Poly1305
   (IETF-Variante).
  </para>
  <para>
   Die IETF-Variante verwendet 96-Bit-Nonces und interne 32-Bit Zähler anstelle
   von 64-Bit für beides.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>ciphertext</parameter></term>
    <listitem>
     <para>
      Muss das von der Funktion
      <function>sodium_crypto_aead_chacha20poly1305_ietf_encrypt</function>
      bereitgestellte Format haben (Chiffretext und Tag, verknüpft).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>additional_data</parameter></term>
    <listitem>
     <para>
      Zusätzliche, zu authentifizierende Daten. Diese Daten werden weder
      verschlüsselt, noch an den Chiffriertext angehängt.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>nonce</parameter></term>
    <listitem>
     <para>
      Eine Nummer, die nur einmal pro Nachricht verwendet werden darf;
      12 Bytes lang.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>key</parameter></term>
    <listitem>
     <para>
      Schlüssel für die Entschlüsselung (256-bit).
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Gibt im Erfolgsfall den Klartext zurück. &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
-->