<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.openssl.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.openssl-pbkdf2.php',
    1 => 'openssl_pbkdf2',
    2 => 'PKCS5 v2 の PBKDF2 文字列を生成する',
  ),
  'up' => 
  array (
    0 => 'ref.openssl.php',
    1 => 'OpenSSL 関数',
  ),
  'prev' => 
  array (
    0 => 'function.openssl-password-verify.php',
    1 => 'openssl_password_verify',
  ),
  'next' => 
  array (
    0 => 'function.openssl-pkcs12-export.php',
    1 => 'openssl_pkcs12_export',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/openssl/functions/openssl-pbkdf2.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.openssl-pbkdf2" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">openssl_pbkdf2</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.5.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">openssl_pbkdf2</span> &mdash; <span class="dc-title">PKCS5 v2 の PBKDF2 文字列を生成する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.openssl-pbkdf2-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>openssl_pbkdf2</strong></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">$password</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">$salt</code></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">$key_length</code></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">$iterations</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">$digest_algo</code><span class="initializer"> = &quot;sha1&quot;</span></span><br>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>openssl_pbkdf2()</strong></span> 関数は、PBKDF2
   (Password-Based Key Derivation Function 2 の略。PKCS5 v2 で定義されている鍵導出関数) 文字列を計算します
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.openssl-pbkdf2-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">password</code></dt>
    <dd>
     <p class="para">
       導出されるキーを生成するパスワード
     </p>
    </dd>
   
   
    <dt><code class="parameter">salt</code></dt>
    <dd>
     <p class="para">
       PBKDF2 は、暗号化のソルトとして、少なくとも128ビット(16バイト)を推奨しています。
     </p>
    </dd>
   
   
    <dt><code class="parameter">key_length</code></dt>
    <dd>
     <p class="para">
       出力されるキーの長さ
     </p>
    </dd>
   
   
    <dt><code class="parameter">iterations</code></dt>
    <dd>
     <p class="para">
      反復回数。
      <a href="https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf" class="link external">&raquo;&nbsp;
      NIST は最低でも1000を推奨</a>しています。
      2023 年の時点で、OWASP は PBKDF2-HMAC-SHA256 に対して 600,000 回、
      PBKDF2-HMAC-SHA512 に対して 210,000 回の反復を推奨しています。
     </p>
    </dd>
   
   
    <dt><code class="parameter">digest_algo</code></dt>
    <dd>
     <p class="para">
       オプションのハッシュまたはダイジェストアルゴリズム。
       アルゴリズムの一覧は、<span class="function"><a href="function.openssl-get-md-methods.php" class="function">openssl_get_md_methods()</a></span> で得られます。
       デフォルトは SHA-1 ですが、SHA-256 または SHA-512 を推奨しています。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.openssl-pbkdf2-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   生のバイナリ文字列を返します。失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.openssl-pbkdf2-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 openssl_pbkdf2() の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$password </span><span style="color: #007700">= </span><span style="color: #DD0000">'password'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$salt </span><span style="color: #007700">= </span><span style="color: #0000BB">openssl_random_pseudo_bytes</span><span style="color: #007700">(</span><span style="color: #0000BB">16</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$keyLength </span><span style="color: #007700">= </span><span style="color: #0000BB">20</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$iterations </span><span style="color: #007700">= </span><span style="color: #0000BB">600000</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$generated_key </span><span style="color: #007700">= </span><span style="color: #0000BB">openssl_pbkdf2</span><span style="color: #007700">(</span><span style="color: #0000BB">$password</span><span style="color: #007700">, </span><span style="color: #0000BB">$salt</span><span style="color: #007700">, </span><span style="color: #0000BB">$keyLength</span><span style="color: #007700">, </span><span style="color: #0000BB">$iterations</span><span style="color: #007700">, </span><span style="color: #DD0000">'sha256'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">bin2hex</span><span style="color: #007700">(</span><span style="color: #0000BB">$generated_key</span><span style="color: #007700">).</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">base64_encode</span><span style="color: #007700">(</span><span style="color: #0000BB">$generated_key</span><span style="color: #007700">).</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
   </p>
  </div>

 
 <div class="refsect1 seealso" id="refsect1-function.openssl-pbkdf2-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.hash-pbkdf2.php" class="function" rel="rdfs-seeAlso">hash_pbkdf2()</a> - PBKDF2 を使ってパスワードからキーを生成する</span></li>
    <li><span class="function"><a href="function.openssl-get-md-methods.php" class="function" rel="rdfs-seeAlso">openssl_get_md_methods()</a> - 利用可能なダイジェスト・メソッドを取得</span></li>
   </ul>
  </p>
 </div>


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