crypt-checksalt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 7b9d57fa44e5085ad1a68b96798da65f36754349 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.crypt-checksalt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>crypt_checksalt</refname>
  <refpurpose>Проверяет строку криптографических настроек</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>null</type></type><methodname>crypt_checksalt</methodname>
   <methodparam><type>string</type><parameter>salt</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   Функция проверяет, соответствует ли строка соли конфигурации системы, и сообщает,
   допустимы ли метод хеширования и параметры, которые содержатся в соли.
   Соль определяет, требуется ли повторное хеширование парольной фразы пользователя
   текущим предпочтительным методом хеширования.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>salt</parameter></term>
    <listitem>
     <simpara>
      Строка с солью, которую требуется проверить.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Функция возвращает значение с типом <type>int</type> в виде константы
   семейства <constant>CRYPT_SALT_<replaceable>*</replaceable></constant>.
  </simpara>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Пример проверки соли функцией <function>crypt_checksalt</function></title>
   <programlisting role="php">
<![CDATA[
<?php

// Генерация соли для устаревшего метода
$salt = crypt_gensalt(CRYPT_PREFIX_STD_DES);

// Проверка соли
$test = crypt_checksalt($salt);
var_dump($test === CRYPT_SALT_METHOD_LEGACY);

// Генерация соли для метода по умолчанию
$salt = crypt_gensalt();

// Проверка соли
$test = crypt_checksalt($salt);
var_dump($test === CRYPT_SALT_OK);

?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
bool(true)
bool(true)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>crypt_gensalt</function></member>
  </simplelist>
 </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
-->