sodium-crypto-pwhash-str.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5bbdca0c80bcf6f1cf7cd86c8c393488287ffe08 Maintainer: lex Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.sodium-crypto-pwhash-str" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sodium_crypto_pwhash_str</refname>
  <refpurpose>Получить ASCII-кодированный хеш</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>sodium_crypto_pwhash_str</methodname>
   <methodparam><type>string</type><parameter>password</parameter></methodparam>
   <methodparam><type>int</type><parameter>opslimit</parameter></methodparam>
   <methodparam><type>int</type><parameter>memlimit</parameter></methodparam>
  </methodsynopsis>
  <para>
   Использует ресурсоёмкий по ЦПУ и памяти алгоритм хеширования. Соль генерируется случайно.
   Можно задать ограничения по использованию памяти и ЦПУ. Можно использовать для генерации
   ASCII-хешей, подходящих для хранения паролей.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>password</parameter></term>
    <listitem>
     <para>
      <type>string</type>; Пароль, для которого будет генерироваться хеш.
     </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>.
      Имеет смысл использовать одинаковые уровни защищённости в
      memlimit и opslimit.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает хеш пароля.
  </para>
  <para>
   Для того, чтобы для одного и того же пароля всегда генерировался один и тот же хеш,
   необходимо использовать одинаковые значения <parameter>opslimit</parameter> и
   <parameter>memlimit</parameter>. Так как эти параметры включены в сгенерированный
   хеш, функция <function>sodium_crypto_pwhash_str_verify</function> может проверять его
   корректность без необходимости хранить эти параметры отдельно.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>sodium_crypto_pwhash_str</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$password = 'password';
echo sodium_crypto_pwhash_str(
    $password,
    SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE,
    SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE
);
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
$argon2id$v=19$m=65536,t=2,p=1$oWIfdaXwWwhVmovOBc2NAQ$EbsZ+JnZyyavkafS0hoc4HdaOB0ILWZESAZ7kVGa+Iw
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Хеши вычисляются с помощью алгоритма Argon2ID, устойчивого для атак стороннего канала
    и GPU. В отличие от функции <function>password_hash</function>, у этой функции нет
    параметра salt (он генерируется автоматически), а параметры
    <parameter>opslimit</parameter> и <parameter>memlimit</parameter> являются
    обязательными.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sodium_crypto_pwhash_str_verify</function></member>
    <member><function>sodium_crypto_pwhash</function></member>
    <member><function>password_hash</function></member>
    <member><function>password_verify</function></member>
    <member><link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://download.libsodium.org/doc/password_hashing/the_argon2i_function.html">Документация на Libsodium Argon2</link></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
-->