sodium-crypto-stream-xchacha20-xor-ic.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d76a7fe17dd2488e47d664a8ab38e161b13ac843 Maintainer: mumumu Status: ready -->
<refentry xml:id="function.sodium-crypto-stream-xchacha20-xor-ic" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sodium_crypto_stream_xchacha20_xor_ic</refname>
  <refpurpose>nonce と秘密鍵を使ってメッセージを暗号化する(認証なし)</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>sodium_crypto_stream_xchacha20_xor_ic</methodname>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>message</parameter></methodparam>
   <methodparam><type>string</type><parameter>nonce</parameter></methodparam>
   <methodparam><type>int</type><parameter>counter</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter></methodparam>
  </methodsynopsis>
  <para>
   この関数は、<function>sodium_crypto_stream_xchacha20_xor</function>
   に似ていますが、ブロックカウンタの初期値を非ゼロの値に設定する機能が追加されています。
   これによって、以前の値を計算せずに直接任意のブロックにアクセスすることができます。
  </para>

  <caution>
   <para>
    この暗号化処理は認証を行いませんし、
    選択暗号文攻撃(chosen-ciphertext attack) を防ぐことができません。
    必ず暗号化されたテキストを認証コードと組み合わせるようにして下さい。
    たとえば、
    <function>sodium_crypto_aead_xchacha20poly1305_ietf_encrypt</function>
    や
    <function>sodium_crypto_auth</function> を使うことが考えられます。
   </para>
  </caution>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>message</parameter></term>
    <listitem>
     <para>
      暗号化するメッセージ。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>nonce</parameter></term>
    <listitem>
     <para>
      24バイトの nonce。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>counter</parameter></term>
    <listitem>
     <para>
      ブロックカウンタの初期値。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>key</parameter></term>
    <listitem>
     <para>
      暗号化キー。
      <function>sodium_crypto_stream_xchacha20_keygen</function> で生成されたものです。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   暗号化されたメッセージを返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>sodium_crypto_stream_xchacha20_xor_ic</function> の例</title>
   <programlisting role="php">
<![CDATA[
<?php
$n2 = random_bytes(SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES);
$left  = str_repeat("\x01", 64);
$right = str_repeat("\xfe", 64);

// All at once:
$stream7_unified = sodium_crypto_stream_xchacha20_xor($left . $right, $n2, $key);

// Piecewise, with initial counter:
$stream7_left  = sodium_crypto_stream_xchacha20_xor_ic($left, $n2, 0, $key);
$stream7_right = sodium_crypto_stream_xchacha20_xor_ic($right, $n2, 1, $key);
$stream7_concat = $stream7_left . $stream7_right;

var_dump(strlen($stream7_concat));
var_dump($stream7_unified === $stream7_concat);
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
int(128)
bool(true)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sodium_crypto_stream_xchacha20_xor</function></member>
   </simplelist>
  </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
-->