mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
5d5a8ef9cb
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343021 c90b9560-bf6c-de11-be94-00142212c4b1
136 lines
3.6 KiB
XML
136 lines
3.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="function.openssl-pbkdf2" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>openssl_pbkdf2</refname>
|
|
<refpurpose>Generates a PKCS5 v2 PBKDF2 string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>openssl_pbkdf2</methodname>
|
|
<methodparam><type>string</type><parameter>password</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>salt</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>key_length</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>iterations</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>digest_algorithm</parameter><initializer>"sha1"</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>openssl_pbkdf2</function> computes PBKDF2 (Password-Based Key Derivation Function 2),
|
|
a key derivation function defined in PKCS5 v2.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>password</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Password from which the derived key is generated.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>salt</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
PBKDF2 recommends a crytographic salt of at least 64 bits (8 bytes).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>key_length</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Length of desired output key.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>iterations</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The number of iterations desired. <link
|
|
xlink:href="https://pages.nist.gov/800-63-3/sp800-63b.html#sec5">NIST
|
|
recommends at least 10,000</link>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>digest_algorithm</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Optional hash or digest algorithm from <function>openssl_get_md_methods</function>. Defaults to SHA-1.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns raw binary string&return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>openssl_pbkdf2() example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$password = 'yOuR-pAs5w0rd-hERe';
|
|
$salt = openssl_random_pseudo_bytes(12);
|
|
$keyLength = 40;
|
|
$iterations = 10000;
|
|
$generated_key = openssl_pbkdf2($password, $salt, $keyLength, $iterations, 'sha256');
|
|
echo bin2hex($generated_key)."\n";
|
|
echo base64_encode($generated_key)."\n";
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>hash_pbkdf2</function></member>
|
|
<member><function>openssl_get_md_methods</function></member>
|
|
</simplelist>
|
|
</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
|
|
-->
|