sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

added reference to mhash_keygen_s2k

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@34523 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nikos Mavroyanopoulos 2000-10-25 18:18:46 +00:00
parent 552785d09b
commit 6074ccbeb7
1 changed files with 37 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
functions/mhash.xml
View file

@ -239,6 +239,43 @@ for ($i = 0; $i <= $nr; $i++) {
</refsect1>
</refentry>
<refentry id="function.mhash_keygen_s2k">
<refnamediv>
<refname>mhash_keygen_s2k</refname>
<refpurpose>Generates a key</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>mhash_keygen_s2k</function></funcdef>
<paramdef>int <parameter>hash</parameter></paramdef>
<paramdef>string <parameter>password</parameter></paramdef>
<paramdef>string <parameter>salt</parameter></paramdef>
<paramdef>int <parameter>bytes</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
<function>Mhash_keygen_s2k</function> generates a key that is
<parameter>bytes</parameter> long, from a user given password.
This is the Salted S2K algorithm as specified in the OpenPGP
document (RFC 2440). That algorithm will use the specified
<parameter>hash</parameter> algorithm to create the key.
The <parameter>salt</parameter> must be different and random
enough for every key you generate in order to create different keys.
That salt must be known when you check the keys, thus it is
a good idea to append the key to it. Salt has a fixed length
of 8 bytes and will be padded with zeros if you supply less bytes.
Keep in mind that user supplied passwords are not really suitable
to be used as keys in cryptographic algorithms, since users normally
choose keys they can write on keyboard. These passwords use
only 6 to 7 bits per character (or less). It is highly recommended
to use some kind of tranformation (like this function) to the user
supplied key.
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file