mhash-keygen-s2k.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8a2141dcc084f72feb4e0ae2feaff3b440e5c59e Maintainer: hirokawa Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.mhash-keygen-s2k">
 <refnamediv>
  <refname>mhash_keygen_s2k</refname>
  <refpurpose>キーを生成する</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  &warn.deprecated.function-8-1-0;
 </refsynopsisdiv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>mhash_keygen_s2k</methodname>
   <methodparam><type>int</type><parameter>algo</parameter></methodparam>
   <methodparam><type>string</type><parameter>password</parameter></methodparam>
   <methodparam><type>string</type><parameter>salt</parameter></methodparam>
   <methodparam><type>int</type><parameter>length</parameter></methodparam>
  </methodsynopsis>
  <para>
   <parameter>algo</parameter>
   にユーザーが指定した <parameter>password</parameter>
   を用いてキーを生成します。
  </para>
  <para>
   OpenPGP のドキュメント (<link xlink:href="&url.rfc;2440">RFC 2440</link>)
   で規定されている、Salted S2k アルゴリズムを使用します。
  </para>
  <para>
   ユーザーが指定したパスワードは、暗号化アルゴリズムのキーとしては
   適切ではないということを覚えておきましょう。ユーザーが選択するのは、
   通常はキーボードから入力可能なキーだからです。
   これらのパスワードは、文字当たり 6 から 7 ビットのみ(もしくはそれ以下)
   しか使用していません。ユーザーの指定したキーに対して、
   (この関数のような) ある種の変換を行うことを強く推奨します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>algo</parameter></term>
     <listitem>
      <para>
       キーの作成に使用するハッシュ ID。<constant>MHASH_ハッシュ名</constant>
       定数のいずれかを指定します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       ユーザーが指定したパスワード。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>salt</parameter></term>
     <listitem>
      <para>
       異なったキーを生成するため、キーを生成するたびに、
       十分にランダムな異なる値となる必要があります。キーを調べる際に
       <parameter>salt</parameter> を知っている必要があるため、キーを salt に付加するというのは
       良い発想です。salt は 8 バイト固定長で、これより少ない場合はゼロで
       埋められます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       キーの長さをバイト数で指定します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   生成されたキーを表す文字列、あるいはエラー時に &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.1.0</entry>
       <entry>
        この関数は、推奨されなくなりました。
        <link linkend="ref.hash"><literal>hash_*()</literal> 関数</link> を代わりに使って下さい。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </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
-->