<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.openssl.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.openssl-password-hash.php',
    1 => 'openssl_password_hash',
    2 => 'Создаёт хеш пароля при помощи Argon2 из OpenSSL',
  ),
  'up' => 
  array (
    0 => 'ref.openssl.php',
    1 => 'Функции OpenSSL',
  ),
  'prev' => 
  array (
    0 => 'function.openssl-open.php',
    1 => 'openssl_open',
  ),
  'next' => 
  array (
    0 => 'function.openssl-password-verify.php',
    1 => 'openssl_password_verify',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/openssl/functions/openssl-password-hash.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.openssl-password-hash" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">openssl_password_hash</h1>
  <p class="verinfo">(PHP 8 &gt;= 8.4.0)</p><p class="refpurpose"><span class="refname">openssl_password_hash</span> &mdash; <span class="dc-title">Создаёт хеш пароля при помощи Argon2 из OpenSSL</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.openssl-password-hash-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">function</span> <span class="methodname"><strong>openssl_password_hash</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$algo</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$password</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$options</code><span class="initializer"> = []</span></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   Создаёт хеш пароля при помощи реализации Argon2 из OpenSSL. Это альтернатива
   функции <span class="function"><a href="function.password-hash.php" class="function">password_hash()</a></span>, в которой движком выступает OpenSSL,
   что в некоторых системах позволяет использовать аппаратное ускорение.
  </p>
  <p class="para">
   Функция доступна только тогда, когда PHP скомпилирован с поддержкой OpenSSL,
   которая включает Argon2 (<code class="literal">HAVE_OPENSSL_ARGON2</code>).
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.openssl-password-hash-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">algo</code></dt>
     <dd>
      <p class="para">
       Алгоритм хеширования пароля. Поддерживаемые значения:
       <code class="literal">&quot;argon2id&quot;</code> и <code class="literal">&quot;argon2i&quot;</code>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">password</code></dt>
     <dd>
      <p class="para">
       Пароль пользователя.
      </p>
     </dd>
    
    
     <dt><code class="parameter">options</code></dt>
     <dd>
      <p class="para">
       Ассоциативный массив (<span class="type"><a href="language.types.array.php" class="type array">array</a></span>) опций. Поддерживаемые ключи:
       <ul class="simplelist">
        <li>
         <code class="literal">memory_cost</code> — максимальный объём памяти (в КиБ),
         который разрешается использовать для вычисления хеша
        </li>
        <li>
         <code class="literal">time_cost</code> — максимальное время, которое разрешается
         потратить на вычисление хеша
        </li>
        <li>
         <code class="literal">threads</code> — количество потоков, которые задействуются
         при вычислении хеша
        </li>
       </ul>
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.openssl-password-hash-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Возвращает хеш пароля в виде строки (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>).
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.openssl-password-hash-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> не входит в список поддерживаемых
   (<code class="literal">&quot;argon2i&quot;</code> или <code class="literal">&quot;argon2id&quot;</code>).
  </p>
  <p class="para">
   Выбрасывает исключение <span class="classname"><a href="class.error.php" class="classname">Error</a></span>, если операция
   хеширования завершается ошибкой по неизвестной причине.
  </p>
 </div>


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

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.4.0</td>
      <td>
       Функция добавлена.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.openssl-password-hash-examples">
  <h3 class="title">Примеры</h3>
  <div class="example" id="example-1">
   <p><strong>Пример #1 Пример использования функции <span class="function"><strong>openssl_password_hash()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$hash </span><span style="color: #007700">= </span><span style="color: #0000BB">openssl_password_hash</span><span style="color: #007700">(</span><span style="color: #DD0000">'argon2id'</span><span style="color: #007700">, </span><span style="color: #DD0000">'my-secret-password'</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$hash</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   
<div class="example-contents"><p>
 Вывод приведённого примера будет похож на:
</p></div>

   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">$argon2id$v=19$m=65536,t=4,p=1$c29tZXNhbHR2YWx1ZQ$hashvalue...</pre>
</div>
   </div>
  </div>
  <div class="example" id="example-2">
   <p><strong>Пример #2 Использование функции <span class="function"><strong>openssl_password_hash()</strong></span> с пользовательскими опциями</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$hash </span><span style="color: #007700">= </span><span style="color: #0000BB">openssl_password_hash</span><span style="color: #007700">(</span><span style="color: #DD0000">'argon2id'</span><span style="color: #007700">, </span><span style="color: #DD0000">'my-secret-password'</span><span style="color: #007700">, [<br />    </span><span style="color: #DD0000">'memory_cost' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">65536</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'time_cost'   </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">4</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'threads'     </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">1</span><span style="color: #007700">,<br />]);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.openssl-password-hash-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.openssl-password-verify.php" class="function" rel="rdfs-seeAlso">openssl_password_verify()</a> - Проверяет соответствие пароля хешу при помощи Argon2 из OpenSSL</span></li>
    <li><span class="function"><a href="function.password-hash.php" class="function" rel="rdfs-seeAlso">password_hash()</a> - Создаёт хеш пароля</span></li>
   </ul>
  </p>
 </div>


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