<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.random.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.random-bytes.php',
    1 => 'random_bytes',
    2 => 'Генерирует криптографически безопасные случайные байты',
  ),
  'up' => 
  array (
    0 => 'ref.random.php',
    1 => 'Функции Random',
  ),
  'prev' => 
  array (
    0 => 'function.rand.php',
    1 => 'rand',
  ),
  'next' => 
  array (
    0 => 'function.random-int.php',
    1 => 'random_int',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/random/functions/random-bytes.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.random-bytes" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">random_bytes</h1>
  <p class="verinfo">(PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">random_bytes</span> &mdash; <span class="dc-title">Генерирует криптографически безопасные случайные байты</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.random-bytes-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>random_bytes</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   Функция генерирует строку, которая содержит равномерно выбранные случайные байты. Длину строки определяет параметр <code class="parameter">length</code>.
  </p>
  <p class="para">
   Функция выбирает байты случайно, поэтому с большей вероятностью вернёт строку
   с непечатаемыми символами или недопустимой последовательностью байтов, которую невозможно сопоставить ни с одним символом в кодировке UTF-8.
   В ряде сценариев перед передачей или выводом двоичную строку потребуется закодировать.
  </p>
  <p class="para">
   Случайные последовательности, которые генерирует функция, применяют для шифрования и защиты данных:
   как ключи шифрования, токены доступа, соль для хеширования паролей и другие долгосрочные или временные криптографические параметры.
  </p>
  
<p class="para">
 Источники случайных величин в порядке приоритета:
</p>
<ul class="itemizedlist">
 <li class="listitem">
  <p class="para">
   Linux: <a href="http://man7.org/linux/man-pages/man2/getrandom.2.html" class="link external">&raquo;&nbsp;getrandom()</a>, <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   FreeBSD &gt;= 12 (PHP &gt;= 7.3): <a href="http://man7.org/linux/man-pages/man2/getrandom.2.html" class="link external">&raquo;&nbsp;getrandom()</a>, <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   Windows (PHP &gt;= 7.2): <a href="https://docs.microsoft.com/en-us/windows/desktop/SecCNG/cng-portal" class="link external">&raquo;&nbsp;CNG-API</a>
  </p>
  <p class="para">
   Windows: <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa379942(v=vs.85).aspx" class="link external">&raquo;&nbsp;CryptGenRandom</a>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   macOS (PHP &gt;= 8.2; &gt;= 8.1.9; &gt;= 8.0.22, если CCRandomGenerateBytes доступен во время компиляции): CCRandomGenerateBytes()
  </p>
  <p class="para">
   macOS (PHP &gt;= 8.1; &gt;= 8.0.2): arc4random_buf(), <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   NetBSD &gt;= 7 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   OpenBSD &gt;= 5.5 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   DragonflyBSD (PHP &gt;= 8.1): <a href="http://man7.org/linux/man-pages/man2/getrandom.2.html" class="link external">&raquo;&nbsp;getrandom()</a>, <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <p class="para">
   Solaris (PHP &gt;= 8.1): <a href="http://man7.org/linux/man-pages/man2/getrandom.2.html" class="link external">&raquo;&nbsp;getrandom()</a>, <var class="filename">/dev/urandom</var>
  </p>
 </li>
 <li class="listitem">
  <span class="simpara">
   Остальные комбинации операционной системы и версии PHP: <var class="filename">/dev/urandom</var>
  </span>
 </li>
 <li class="listitem">
  <span class="simpara">
   Функция выбросит исключение <span class="classname"><a href="class.random-randomexception.php" class="classname">Random\RandomException</a></span>,
   если все источники оказались недоступны или в каждом возникла ошибка генерации случайной последовательности.
  </span>
 </li>
</ul>

  
<blockquote class="note"><p><strong class="note">Замечание</strong>: 
 <span class="simpara">
  Функцию добавили в PHP 7.0.
  <a href="https://github.com/paragonie/random_compat" class="link external">&raquo;&nbsp;Пользовательская реализация</a> функции доступна с PHP 5.2 по PHP 5.6 включительно.
 </span>
</p></blockquote>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.random-bytes-parameters">
  <h3 class="title">Список параметров</h3>
  <dl>
   
    <dt><code class="parameter">length</code></dt>
    <dd>
     <p class="para">
      Длина генерируемой строки в байтах. При передаче значения меньше <code class="literal">1</code> функция выдаст ошибку.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.random-bytes-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает строку, которая содержит заданное количество криптографически стойких байтов.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.random-bytes-errors">
  <h3 class="title">Ошибки</h3>
  <ul class="itemizedlist">
   
<li class="listitem">
 <span class="simpara">
  При недоступности источников случайных величин выбрасывается исключение
  <span class="classname"><a href="class.random-randomexception.php" class="classname">Random\RandomException</a></span>.
 </span>
</li>

   <li class="listitem">
    <span class="simpara">
     При передаче в параметр <code class="parameter">length</code> значения меньше <code class="literal">1</code>
     функция выбросит ошибку <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span>.
    </span>
   </li>
  </ul>
 </div>


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

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.2.0</td>
      <td>
       При сбое генератора криптографически безопасных псевдослучайных чисел (англ. Cryptographically Secure Pseudorandom Number Generator, <abbr title="Cryptographically Secure PseudoRandom Number Generator">CSPRNG</abbr>)
       функция теперь выбрасывает исключение <span class="classname"><a href="class.random-randomexception.php" class="classname">Random\RandomException</a></span>.
       Раньше функция выбрасывала исключение <span class="classname"><a href="class.exception.php" class="classname">Exception</a></span>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.random-bytes-examples">
  <h3 class="title">Примеры</h3>
  <div class="example" id="random-bytes.example.basic">
   <p><strong>Пример #1 Пример генерации криптографически безопасных случайных байтов функцией <span class="function"><strong>random_bytes()</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 />$bytes </span><span style="color: #007700">= </span><span style="color: #0000BB">random_bytes</span><span style="color: #007700">(</span><span style="color: #0000BB">5</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">bin2hex</span><span style="color: #007700">(</span><span style="color: #0000BB">$bytes</span><span style="color: #007700">));<br /><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="annotation-interactive examplescode"><pre class="examplescode">string(10) &quot;385e33f741&quot;</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.random-bytes-seealso">
  <h3 class="title">Смотрите также</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="random-randomizer.getbytes.php" class="function" rel="rdfs-seeAlso">Random\Randomizer::getBytes()</a> - Получает случайные байты</span></li>
   <li><span class="function"><a href="function.random-int.php" class="function" rel="rdfs-seeAlso">random_int()</a> - Получает криптографически безопасное равномерно выбранное целое число</span></li>
   <li><span class="function"><a href="function.bin2hex.php" class="function" rel="rdfs-seeAlso">bin2hex()</a> - Преобразовывает двоичные данные в шестнадцатеричное представление</span></li>
   <li><span class="function"><a href="function.base64-encode.php" class="function" rel="rdfs-seeAlso">base64_encode()</a> - Кодирует данные в формат MIME base64</span></li>
  </ul>
 </div>


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