Edit Report a Bug

    mhash_keygen_s2k

    (PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8)

    mhash_keygen_s2k — キーを生成する

    警告

    この関数は PHP 8.1.0 で 非推奨になります。この関数に頼らないことを強く推奨します。

    説明

    mhash_keygen_s2k(
        int $algo,
        string $password,
        string $salt,
        int $length
    ): string|false

    algo にユーザーが指定した password を用いてキーを生成します。

    OpenPGP のドキュメント (» RFC 2440) で規定されている、Salted S2k アルゴリズムを使用します。

    ユーザーが指定したパスワードは、暗号化アルゴリズムのキーとしては 適切ではないということを覚えておきましょう。ユーザーが選択するのは、 通常はキーボードから入力可能なキーだからです。 これらのパスワードは、文字当たり 6 から 7 ビットのみ(もしくはそれ以下) しか使用していません。ユーザーの指定したキーに対して、 (この関数のような) ある種の変換を行うことを強く推奨します。

    パラメータ

    algo

    キーの作成に使用するハッシュ ID。MHASH_ハッシュ名 定数のいずれかを指定します。

    password

    ユーザーが指定したパスワード。

    salt

    異なったキーを生成するため、キーを生成するたびに、 十分にランダムな異なる値となる必要があります。キーを調べる際に salt を知っている必要があるため、キーを salt に付加するというのは 良い発想です。salt は 8 バイト固定長で、これより少ない場合はゼロで 埋められます。

    length

    キーの長さをバイト数で指定します。

    戻り値

    生成されたキーを表す文字列、あるいはエラー時に false を返します。

    変更履歴

    バージョン 説明
    8.1.0 この関数は、推奨されなくなりました。 hash_*() 関数 を代わりに使って下さい。

    add a note add a note

    User Contributed Notes 3 notes

    up
    1
    alix dot axel+php at gmail dot com
    12 years ago
    I looked into mhash and PHP source code and I've ported this function to pure PHP:

    <?php

    function keygen_s2k($hash, $password, $salt, $bytes)
    {
            $result = false;

        if (    extension_loaded('hash') === true)
        {
                $times = $bytes / ($block = strlen(hash($hash, null, true)));

            if (    $bytes % $block != 0)
            {
                ++    $times;
            }

            for (    $i = 0; $i < $times; ++$i)
            {
                    $result .= hash($hash, str_repeat("\0", $i) . $salt . $password, true);
            }
        }

        return     $result;
    }

    ?>
    up
    1
    gmic
    17 years ago
    Correction to ray ferguson post,

    As said in the doc : "mhash_keygen_s2k generates a key that is bytes long, from a user given password and use the specified hash algorithm to create the key." if It wasn't clear to anyone.

    The non mhash function is good as long you do not need a key longer than native MD5 hash (16 bytes)  it wont give you more.

    So the non mhash function work OK but they ARE NOT the same thing.

    Just try ray ferguson exemple asking for a 32 bytes key.

    Returning a substring longer than the packed 16 bytes string won't add anything to the string. Salted S2K algorithm does add to the key.  So better use mhash lib or create something more alike the RFC 2440 specs.

    I know the post is late on regard to Ray's post but if it can help someone not waisting time like me.
    up
    -1
    php_at_share-foo.com
    21 years ago
    // given random 8 bits of salt and a clear text password

    $clear_pw = "p4ssw0rd" ;
    $rand8bites4salt = substr(pack("h*", md5(mt_rand())) , 0, 8);

    // This

    mhash_keygen_s2k(MHASH_MD5, $clear_pw, $rand8bites4salt, 4) ;

    //is the same as this

    function myhash_keyge_s2k($pass, $salt, $bytes ){
          return substr(pack("H*", md5($salt . $pass)), 0, $bytes);
    }

    myhash_keyge_s2k($clear_pw, $rand8bites4salt, 4);

    // But the latter doesn't require mhash libs.

    // -ray ferguson
    add a note add a note
    To Top