<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mhash.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.mhash-keygen-s2k.php',
    1 => 'mhash_keygen_s2k',
    2 => 'キーを生成する',
  ),
  'up' => 
  array (
    0 => 'ref.mhash.php',
    1 => 'Mhash 関数',
  ),
  'prev' => 
  array (
    0 => 'function.mhash-get-hash-name.php',
    1 => 'mhash_get_hash_name',
  ),
  'next' => 
  array (
    0 => 'book.openssl.php',
    1 => 'OpenSSL',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/mhash/functions/mhash-keygen-s2k.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.mhash-keygen-s2k" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">mhash_keygen_s2k</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">mhash_keygen_s2k</span> &mdash; <span class="dc-title">キーを生成する</span></p>

 </div>

 <div id="function.mhash-keygen-s2k-refsynopsisdiv">
  <div class="warning"><strong class="warning">警告</strong><p class="simpara">この関数は PHP 8.1.0 で
<em>非推奨</em>になります。この関数に頼らないことを強く推奨します。</p></div>
 </div>
 
 <div class="refsect1 description" id="refsect1-function.mhash-keygen-s2k-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="attribute"><a href="class.deprecated.php">#[\Deprecated]</a> </span><br>
   <span class="methodname"><strong>mhash_keygen_s2k</strong></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">$algo</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">$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">$length</code></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">
   <code class="parameter">algo</code>
   にユーザーが指定した <code class="parameter">password</code>
   を用いてキーを生成します。
  </p>
  <p class="para">
   OpenPGP のドキュメント (<a href="https://datatracker.ietf.org/doc/html/rfc2440" class="link external">&raquo;&nbsp;RFC 2440</a>)
   で規定されている、Salted S2k アルゴリズムを使用します。
  </p>
  <p class="para">
   ユーザーが指定したパスワードは、暗号化アルゴリズムのキーとしては
   適切ではないということを覚えておきましょう。ユーザーが選択するのは、
   通常はキーボードから入力可能なキーだからです。
   これらのパスワードは、文字当たり 6 から 7 ビットのみ(もしくはそれ以下)
   しか使用していません。ユーザーの指定したキーに対して、
   (この関数のような) ある種の変換を行うことを強く推奨します。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.mhash-keygen-s2k-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">algo</code></dt>
     <dd>
      <p class="para">
       キーの作成に使用するハッシュ ID。<strong><code>MHASH_ハッシュ名</code></strong>
       定数のいずれかを指定します。
      </p>
     </dd>
    
    
     <dt><code class="parameter">password</code></dt>
     <dd>
      <p class="para">
       ユーザーが指定したパスワード。
      </p>
     </dd>
    
    
     <dt><code class="parameter">salt</code></dt>
     <dd>
      <p class="para">
       異なったキーを生成するため、キーを生成するたびに、
       十分にランダムな異なる値となる必要があります。キーを調べる際に
       <code class="parameter">salt</code> を知っている必要があるため、キーを salt に付加するというのは
       良い発想です。salt は 8 バイト固定長で、これより少ない場合はゼロで
       埋められます。
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       キーの長さをバイト数で指定します。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.mhash-keygen-s2k-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 changelog" id="refsect1-function.mhash-keygen-s2k-changelog">
  <h3 class="title">変更履歴</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>バージョン</th>
       <th>説明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.1.0</td>
       <td>
        この関数は、推奨されなくなりました。
        <a href="ref.hash.php" class="link"><code class="literal">hash_*()</code> 関数</a> を代わりに使って下さい。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>

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