hash-init.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5bc68add3da3cd18c40f851e944b15095d3a26aa Maintainer: aur Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.hash-init" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>hash_init</refname>
  <refpurpose>Инициализирует контекст инкрементного хеширования</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>HashContext</type><methodname>hash_init</methodname>
   <methodparam><type>string</type><parameter>algo</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter><initializer>""</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>algo</parameter></term>
     <listitem>
      <para>
       Название выбранного алгоритма хеширования (то есть md5, sha256, haval160,4 и т. д.).
       Список поддерживаемых алгоритмов даёт описание функции <function>hash_algos</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       Необязательные настройки для генерации хеша, пока поддерживается только один вариант:
       <constant>HASH_HMAC</constant>. При этом параметр <parameter>key</parameter>
       <emphasis>должен</emphasis> быть указан.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>key</parameter></term>
     <listitem>
      <para>
       Если флаг <constant>HASH_HMAC</constant> указали для параметра <parameter>flags</parameter>,
       то в этом параметре нужно указать общий секретный ключ, который функция использует
       с методом хеширования HMAC.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Массив опций для алгоритмов хеширования.
       Пока вариантами функций хеширования MurmurHash поддерживается только параметр <literal>"seed"</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает контекст хеширования для передачи в функции
   <function>hash_update</function>, <function>hash_update_stream</function>,
   <function>hash_update_file</function> и <function>hash_final</function>.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция выбрасывает исключение <classname>ValueError</classname>,
   если параметр <parameter>algo</parameter> неизвестен или не криптографическая
   хеш-функция, или если параметр <parameter>key</parameter> пуст.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.1.0</entry>
       <entry>
        Добавили параметр <parameter>options</parameter>.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Теперь функция выбрасывает исключение <classname>ValueError</classname>,
        если параметр <parameter>algo</parameter> неизвестен или не криптографическая хеш-функция,
        или если параметр <parameter>key</parameter> пуст;
        раньше возвращалось значение &false; и выдавалась ошибка уровня <constant>E_WARNING</constant>.
        emitted.
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        Запретили некриптографические хеш-функции
        (adler32, crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat) с константой
        <constant>HASH_HMAC</constant>.
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        Функция возвращает объект класса <classname>HashContext</classname>, а не ресурс.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример инкрементного хеширования</title>
    <programlisting role="php">
<![CDATA[
<?php

$hash = hash('sha256', 'The quick brown fox jumped over the lazy dog.');

$ctx = hash_init('sha256');
hash_update($ctx, 'The quick brown fox ');
hash_update($ctx, 'jumped over the lazy dog.');
$incremental_hash = hash_final($ctx);

echo $incremental_hash, PHP_EOL;
var_dump($hash === $incremental_hash);

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>hash</function></member>
    <member><function>hash_algos</function></member>
    <member><function>hash_file</function></member>
    <member><function>hash_hmac</function></member>
    <member><function>hash_hmac_file</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
-->