<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.hash.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.hash-hmac.php',
    1 => 'hash_hmac',
    2 => 'Генерирует хеш-код на основе ключа через метод HMAC',
  ),
  'up' => 
  array (
    0 => 'ref.hash.php',
    1 => 'Функции Hash',
  ),
  'prev' => 
  array (
    0 => 'function.hash-hkdf.php',
    1 => 'hash_hkdf',
  ),
  'next' => 
  array (
    0 => 'function.hash-hmac-algos.php',
    1 => 'hash_hmac_algos',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/hash/functions/hash-hmac.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.hash-hmac" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">hash_hmac</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.2, PHP 7, PHP 8, PECL hash &gt;= 1.1)</p><p class="refpurpose"><span class="refname">hash_hmac</span> &mdash; <span class="dc-title">Генерирует хеш-код на основе ключа через метод HMAC</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.hash-hmac-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>hash_hmac</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$algo</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="attribute"><a href="class.sensitiveparameter.php">#[\SensitiveParameter]</a> </span><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$key</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$binary</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span><br>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>


 </div>

 <div class="refsect1 parameters" id="refsect1-function.hash-hmac-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">algo</code></dt>
     <dd>
      <p class="para">
       Название алгоритма хеширования (например, <code class="literal">&quot;sha256&quot;</code>).
       Список поддерживаемых алгоритмов возвращает функция <span class="function"><a href="function.hash-hmac-algos.php" class="function">hash_hmac_algos()</a></span>.
       <blockquote class="note"><p><strong class="note">Замечание</strong>: 
        <p class="para">
         Некриптографические хеш-функции не допускаются.
        </p>
       </p></blockquote>
      </p>
     </dd>
    
    
     <dt><code class="parameter">data</code></dt>
     <dd>
      <p class="para">
       Сообщение для хеширования.
      </p>
     </dd>
    
    
     <dt><code class="parameter">key</code></dt>
     <dd>
      <p class="para">
       Общий секретный ключ для генерации хеш-кода методом HMAC.
      </p>
     </dd>
    
    
     <dt><code class="parameter">binary</code></dt>
     <dd>
      <p class="para">
       Функция выводит необработанные двоичные данные, если для параметра установили значение <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>. При значении <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>
       функция выводит данные в шестнадцатеричной кодировке в нижнем регистре.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.hash-hmac-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает строку, которая содержит вычисленный хеш-код в шестнадцатеричной кодировке
   в нижнем регистре. Функция возвращает хеш-код в виде бинарных данных,
   если для параметра <code class="parameter">binary</code> установили значение <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.hash-hmac-errors">
  <h3 class="title">Ошибки</h3>
  <p class="para">
   Функция выбрасывает ошибку <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>, если в аргументе <code class="parameter">algo</code>
   указали название неизвестной или некриптографической хеш-функции.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.hash-hmac-changelog">
  <h3 class="title">Список изменений</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Версия</th>
       <th>Описание</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.0.0</td>
       <td>
        Функция теперь выбрасывает ошибку <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>,
        если в параметр <code class="parameter">algo</code> передали название неизвестной или некриптографической хеш-функции;
        раньше вместо этого возвращалось значение <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
       </td>
      </tr>

      <tr>
       <td>7.2.0</td>
       <td>
        Генерацию хеш-строки через некриптографические хеш-функции
        наподобие adler32, crc32, crc32b, fnv132, fnv1a32, fnv164, fnv1a64, joaat запретили.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.hash-hmac-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример генерации хеш-кода функцией <span class="function"><strong>hash_hmac()</strong></span></strong></p>
    <div class="example-contents">

<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">hash_hmac</span><span style="color: #007700">(</span><span style="color: #DD0000">'sha256'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Съешь же ещё этих мягких французских булок, да выпей чаю.'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret'</span><span style="color: #007700">);</span></span></code></div>
    </div>

    
<div class="example-contents"><p>
 Результат выполнения приведённого примера:
</p></div>

    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">d6f502c51167410320e6f85de2a66f04ed961c04396275cf808ed43828663a9d</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.hash-hmac-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.hash-hmac-algos.php" class="function" rel="rdfs-seeAlso">hash_hmac_algos()</a> - Возвращает список зарегистрированных алгоритмов хеширования, применимых для hash_hmac</span></li>
    <li><span class="function"><a href="function.hash-hmac-file.php" class="function" rel="rdfs-seeAlso">hash_hmac_file()</a> - Генерирует хеш-значение на основе ключа через метод HMAC и содержимое файла</span></li>
    <li><span class="function"><a href="function.hash-equals.php" class="function" rel="rdfs-seeAlso">hash_equals()</a> - Сравнивает строки без риска атаки по времени</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>