sodium-crypto-pwhash.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d76a7fe17dd2488e47d664a8ab38e161b13ac843 Maintainer: lex Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.sodium-crypto-pwhash" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sodium_crypto_pwhash</refname>
  <refpurpose>Получает ключ из пароля алгоритмом Argon2</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>sodium_crypto_pwhash</methodname>
   <methodparam><type>int</type><parameter>length</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>password</parameter></methodparam>
   <methodparam><type>string</type><parameter>salt</parameter></methodparam>
   <methodparam><type>int</type><parameter>opslimit</parameter></methodparam>
   <methodparam><type>int</type><parameter>memlimit</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>algo</parameter><initializer><constant>SODIUM_CRYPTO_PWHASH_ALG_DEFAULT</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция предоставляет низкоуровневый доступ к функции crypto_pwhash
   библиотеки libsodium. Если у отсутствует принципиальная необходимость в этой
   функции, лучше пользоваться функциями <function>sodium_crypto_pwhash_str</function> или
   <function>password_hash</function>.
  </para>
  <para>
   Распространённая причина, по которой вызывают эту функцию — получить начальные
   числа для криптографических ключей из пароля и соли,
   а затем использовать эти начальные числа для генерации фактических ключей,
   необходимых для некоторых целей (например, подписать сообщение, как делает функция
   <function>sodium_crypto_sign_detached</function>).
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>length</parameter></term>
    <listitem>
     <para>
      Целое число (<type>int</type>); Длина хеша пароля в байтах.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>password</parameter></term>
    <listitem>
     <para>
      Строка (<type>string</type>); Пароль, для которого функция создаёт хеш.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>salt</parameter></term>
    <listitem>
     <para>
      Соль, которую добавляют к паролю перед хешированием.
      Соль должна быть непредсказуемой, в идеале генерироваться из хорошего
      источника случайных чисел наподобие функции <function>random_bytes</function>
      и быть длиной, равной значению константы
      <constant>SODIUM_CRYPTO_PWHASH_SALTBYTES</constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>opslimit</parameter></term>
    <listitem>
     <para>
      Представляет максимальное количество вычислений для выполнения
      Увеличение этого числа приведёт к тому, что функции потребуется больше циклов ЦП для вычисления ключа.
      Существуют константы, доступные для установки предела операций для соответствующих значений в зависимости от предполагаемого использования,
      в порядке убывания: <constant>SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE</constant>, <constant>SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE</constant> и <constant>SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE</constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>memlimit</parameter></term>
    <listitem>
     <para>
      Максимальный объем ОЗУ в байтах, который будет использовать функция.
      Выбрать подходящее значение помогают константы в порядке размера:
      <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE</constant>,
      <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE</constant>
      и <constant>SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE</constant>.
      Как правило, константы должны сочетаться со значениями <parameter>opslimit</parameter>,
      которым они соответствуют.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>algo</parameter></term>
    <listitem>
     <para>
      Цело число (<type>int</type>), которое указывает алгоритм хеширования.
      По умолчанию задана константа <constant>SODIUM_CRYPTO_PWHASH_ALG_DEFAULT</constant>
      (рекомендуемый алгоритм, который изменяется от версии к версии модуля libsodium),
      или явно задать константу <constant>SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13</constant>,
      которая представляет версию алгоритма Argon2id 1.3.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает захешированный пароль. Возвращаемое значение —
   двоичная строка хеша, а не ASCII-представление, и не содержит
   дополнительной информации о параметрах, с которыми генерировался хеш, поэтому
   разработчик сам сохраняет значения параметров для
   проверки корректности хеша в будущем. Чтобы избежать этого,
   пользуются функцией <function>sodium_crypto_pwhash_str</function>.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования функции <function>password_hash</function></title>
    <programlisting role="php">
<![CDATA[
<?php

// Для будущей проверки нужно сохранить соль
$salt = random_bytes(SODIUM_CRYPTO_PWHASH_SALTBYTES);

// Вызываем функцию bin2hex для удобочитаемости
echo bin2hex(
    sodium_crypto_pwhash(
        16, // == 128 бит
        'password',
        $salt,
        SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE,
        SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE,
        SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13
    )
);

?>]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
a18f346ba57992eb7e4ae6abf3fd30ee
]]>
    </screen>
   </example>
  </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
-->