<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.hash-hkdf.php',
    1 => 'hash_hkdf',
    2 => 'Gera uma deriva&ccedil;&atilde;o de chave HKDF de uma entrada de chave fornecida',
  ),
  'up' => 
  array (
    0 => 'ref.hash.php',
    1 => 'Hash Fun&ccedil;&otilde;es',
  ),
  'prev' => 
  array (
    0 => 'function.hash-final.php',
    1 => 'hash_final',
  ),
  'next' => 
  array (
    0 => 'function.hash-hmac.php',
    1 => 'hash_hmac',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/hash/functions/hash-hkdf.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.hash-hkdf" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">hash_hkdf</h1>
  <p class="verinfo">(PHP 7 &gt;= 7.1.2, PHP 8)</p><p class="refpurpose"><span class="refname">hash_hkdf</span> &mdash; <span class="dc-title">Gera uma derivação de chave HKDF de uma entrada de chave fornecida</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.hash-hkdf-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>hash_hkdf</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="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.integer.php" class="type int">int</a></span> <code class="parameter">$length</code><span class="initializer"> = 0</span></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">$info</code><span class="initializer"> = &quot;&quot;</span></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">$salt</code><span class="initializer"> = &quot;&quot;</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-hkdf-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">algo</code></dt>
     <dd>
      <p class="para">
       Nome do algoritmo de hash selecionado (por exemplo, <code class="literal">&quot;sha256&quot;</code>).
       Para uma lista de algoritmos suportados, veja <span class="function"><a href="function.hash-hmac-algos.php" class="function">hash_hmac_algos()</a></span>.
       <blockquote class="note"><p><strong class="note">Nota</strong>: 
        <p class="para">
         Funções de hash não criptográficas não são permitidas.
        </p>
       </p></blockquote>
      </p>
     </dd>
    
    
     <dt><code class="parameter">key</code></dt>
     <dd>
      <p class="para">
       Material de chaveamento de entrada (binário bruto). Não pode estar vazio.
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       Comprimento de saída desejado em bytes.
       Não pode ser maior que 255 vezes o tamanho da função hash escolhida.
      </p>
      <p class="para">
       Se <code class="parameter">length</code> for <code class="literal">0</code>, o comprimento de saída
       será definido como padrão para o tamanho da função hash escolhida.
      </p>
     </dd>
    
    
     <dt><code class="parameter">info</code></dt>
     <dd>
      <p class="para">
       String de informação específica da aplicação/contexto.
      </p>
     </dd>
    
    
     <dt><code class="parameter">salt</code></dt>
     <dd>
      <p class="para">
       Salt a ser usado na derivação.
      </p>
      <p class="para">
       Embora opcional, adicionar salt aleatório melhora significativamente a força do HKDF.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.hash-hkdf-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna uma string contendo uma representação binária bruta da chave derivada
   (também conhecida como material de chaveamento de saída - OKM).
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.hash-hkdf-errors">
  <h3 class="title">Erros/Exceções</h3>
  <p class="para">
   Lança uma exceção <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> se <code class="parameter">key</code>
   estiver vazio, <code class="parameter">algo</code> for desconhecido ou não criptográfico,
   <code class="parameter">length</code> for menor que <code class="literal">0</code> ou muito grande
   (maior que 255 vezes o tamanho da função hash).
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.hash-hkdf-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Versão</th>
       <th>Descrição</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.0.0</td>
       <td>
        Agora lança uma exceção <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> em caso de erro.
        Anteriormente, <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> era retornado e uma mensagem <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
        era emitida.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.hash-hkdf-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   O exemplo abaixo produz um par de chaves separadas, adequadas para a criação de uma
   construção de criptografia seguida de HMAC, usando AES-256 e SHA-256 para criptografia e
   autenticação, respectivamente.
  </p>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>hash_hkdf()</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 /></span><span style="color: #FF8000">// Gera uma chave aleatória e adiciona um salt para fortalecê-la durante a derivação.<br /></span><span style="color: #0000BB">$inputKey </span><span style="color: #007700">= </span><span style="color: #0000BB">random_bytes</span><span style="color: #007700">(</span><span style="color: #0000BB">32</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$salt </span><span style="color: #007700">= </span><span style="color: #0000BB">random_bytes</span><span style="color: #007700">(</span><span style="color: #0000BB">16</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Deriva um par de chaves separadas, usando a mesma entrada criada acima.<br /></span><span style="color: #0000BB">$encryptionKey </span><span style="color: #007700">= </span><span style="color: #0000BB">hash_hkdf</span><span style="color: #007700">(</span><span style="color: #DD0000">'sha256'</span><span style="color: #007700">, </span><span style="color: #0000BB">$inputKey</span><span style="color: #007700">, </span><span style="color: #0000BB">32</span><span style="color: #007700">, </span><span style="color: #DD0000">'aes-256-encryption'</span><span style="color: #007700">, </span><span style="color: #0000BB">$salt</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$authenticationKey </span><span style="color: #007700">= </span><span style="color: #0000BB">hash_hkdf</span><span style="color: #007700">(</span><span style="color: #DD0000">'sha256'</span><span style="color: #007700">, </span><span style="color: #0000BB">$inputKey</span><span style="color: #007700">, </span><span style="color: #0000BB">32</span><span style="color: #007700">, </span><span style="color: #DD0000">'sha-256-authentication'</span><span style="color: #007700">, </span><span style="color: #0000BB">$salt</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$encryptionKey </span><span style="color: #007700">!== </span><span style="color: #0000BB">$authenticationKey</span><span style="color: #007700">); </span><span style="color: #FF8000">// bool(true)<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.hash-hkdf-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.hash-pbkdf2.php" class="function" rel="rdfs-seeAlso">hash_pbkdf2()</a> - Gera uma deriva&ccedil;&atilde;o de chave PBKDF2 de uma senha fornecida</span></li>
    <li><a href="https://datatracker.ietf.org/doc/html/rfc5869" class="link external">&raquo;&nbsp;RFC 5869</a></li>
    <li><a href="https://github.com/narfbg/hash_hkdf_compat" class="link external">&raquo;&nbsp;implementação do usuário</a></li>
   </ul>
  </p>
 </div>


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