<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sodium.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.sodium-crypto-secretstream-xchacha20poly1305-push.php',
    1 => 'sodium_crypto_secretstream_xchacha20poly1305_push',
    2 => 'ストリーミングAPI で安全に復号できるように、データのチャンクを暗号化する',
  ),
  'up' => 
  array (
    0 => 'ref.sodium.php',
    1 => 'Sodium 関数',
  ),
  'prev' => 
  array (
    0 => 'function.sodium-crypto-secretstream-xchacha20poly1305-pull.php',
    1 => 'sodium_crypto_secretstream_xchacha20poly1305_pull',
  ),
  'next' => 
  array (
    0 => 'function.sodium-crypto-secretstream-xchacha20poly1305-rekey.php',
    1 => 'sodium_crypto_secretstream_xchacha20poly1305_rekey',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/sodium/functions/sodium-crypto-secretstream-xchacha20poly1305-push.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.sodium-crypto-secretstream-xchacha20poly1305-push" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">sodium_crypto_secretstream_xchacha20poly1305_push</h1>
  <p class="verinfo">(PHP 7 &gt;= 7.2.0, PHP 8)</p><p class="refpurpose"><span class="refname">sodium_crypto_secretstream_xchacha20poly1305_push</span> &mdash; <span class="dc-title">ストリーミングAPI で安全に復号できるように、データのチャンクを暗号化する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.sodium-crypto-secretstream-xchacha20poly1305-push-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>sodium_crypto_secretstream_xchacha20poly1305_push</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter reference">&$state</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="attribute"><a href="class.sensitiveparameter.php">#[\SensitiveParameter]</a> </span><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$message</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$additional_data</code><span class="initializer"> = &quot;&quot;</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$tag</code><span class="initializer"> = <strong><code><a href="sodium.constants.php#constant.sodium-crypto-secretstream-xchacha20poly1305-tag-message">SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE</a></code></strong></span></span><br>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="simpara">
   ストリーミングAPIで安全に復号できるように、
   データのチャンクを暗号化します。
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.sodium-crypto-secretstream-xchacha20poly1305-push-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">state</code></dt>
    <dd>
     <span class="simpara">
      <span class="function"><a href="function.sodium-crypto-secretstream-xchacha20poly1305-init-pull.php" class="function">sodium_crypto_secretstream_xchacha20poly1305_init_pull()</a></span>
      と
      <span class="function"><a href="function.sodium-crypto-secretstream-xchacha20poly1305-init-push.php" class="function">sodium_crypto_secretstream_xchacha20poly1305_init_push()</a></span>
      を参照ください。
     </span>
    </dd>
   
   
    <dt><code class="parameter">message</code></dt>
    <dd>
     <span class="simpara">

     </span>
    </dd>
   
   
    <dt><code class="parameter">additional_data</code></dt>
    <dd>
     <span class="simpara">

     </span>
    </dd>
   
   
    <dt><code class="parameter">tag</code></dt>
    <dd>
     <span class="simpara">
      オプション。
      復号の振る舞いを指示するために使えます。
      (たとえば、鍵の再生成や、ストリームの最後のチャンクを示すなど)
     </span>
     <ul class="simplelist">
      <li>
       <strong><code><a href="sodium.constants.php#constant.sodium-crypto-secretstream-xchacha20poly1305-tag-message">SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE</a></code></strong>:
        もっとも一般的なタグ。
        メッセージの性質についての情報を全く追加しません。
      </li>
      <li>
       <strong><code><a href="sodium.constants.php#constant.sodium-crypto-secretstream-xchacha20poly1305-tag-final">SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL</a></code></strong>:
        メッセージがストリームの終端であるとマークされており、
        これより前のシーケンスで使われていた暗号化の鍵が削除されています。
      </li>
      <li>
       <strong><code><a href="sodium.constants.php#constant.sodium-crypto-secretstream-xchacha20poly1305-tag-push">SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH</a></code></strong>:
        このメッセージが、メッセージの集合の終端としてマークされていますが、
        ストリームの終端ではありません。
        たとえば、複数のチャンクとして送信された巨大なJSON文字列は、
        アプリケーションに文字列の終端を示し、
        デコードできると指示することができます。
        しかし、ストリームそのものは閉じられておらず、
        さらにデータが続く可能性があります。
      </li>
      <li>
       <strong><code><a href="sodium.constants.php#constant.sodium-crypto-secretstream-xchacha20poly1305-tag-rekey">SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY</a></code></strong>:
        このメッセージを暗号化するために、
        これまでに使われてきた鍵を"忘れ"ます。
        そして、新しい秘密鍵を生成します。
      </li>
     </ul>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.sodium-crypto-secretstream-xchacha20poly1305-push-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   暗号化されたテキストを返します。
  </p>
 </div>



</div><?php manual_footer($setup); ?>