<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.random-bytes.php',
    1 => 'random_bytes',
    2 => 'Obt&eacute;m bytes aleat&oacute;rios criptograficamente seguros',
  ),
  'up' => 
  array (
    0 => 'ref.random.php',
    1 => 'Fun&ccedil;&otilde;es Random',
  ),
  'prev' => 
  array (
    0 => 'function.rand.php',
    1 => 'rand',
  ),
  'next' => 
  array (
    0 => 'function.random-int.php',
    1 => 'random_int',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    '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">Obtém bytes aleatórios criptograficamente seguros</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.random-bytes-description">
  <h3 class="title">Descrição</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">
   Gera uma string contendo bytes aleatórios selecionados uniformemente com o comprimento solicitado em <code class="parameter">length</code>.
  </p>
  <p class="para">
   Como os bytes retornados são selecionados de forma completamente aleatória, é provável que a string resultante
   contenha caracteres não imprimíveis ou sequências UTF-8 inválidas. Pode ser necessário
   codificá-la antes da transmissão ou exibição.
  </p>
  <p class="para">
   A aleatoriedade gerada por esta função é adequada para todas as aplicações, incluindo
   a geração de segredos de longo prazo, como chaves de criptografia.
  </p>
  
<p class="para">
 As fontes de aleatoriedade usadas para esta função são as seguintes:
</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 se CCRandomGenerateBytes estiver disponível em tempo de compilação): 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">
   Qualquer combinação de sistema operacional e versão do PHP não mencionada anteriormente: <var class="filename">/dev/urandom</var>
  </span>
 </li>
 <li class="listitem">
  <span class="simpara">
   Se nenhuma das fontes estiver disponível ou todas falharem em gerar
   aleatoriedade, então uma exceção <span class="classname"><a href="class.random-randomexception.php" class="classname">Random\RandomException</a></span>
   será lançada.
  </span>
 </li>
</ul>

  
 <blockquote class="note"><p><strong class="note">Nota</strong>: 
  <span class="simpara">
   Embora esta função tenha sido adicionada ao PHP no PHP 7.0, uma
   <a href="https://github.com/paragonie/random_compat" class="link external">&raquo;&nbsp;implementação no espaço do usuário</a>
   está disponível para o PHP 5.2 ao 5.6, inclusive.
  </span>
 </p></blockquote>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.random-bytes-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">length</code></dt>
    <dd>
     <p class="para">
      O comprimento da sequência aleatória que deve ser retornada em bytes; deve ser <code class="literal">1</code> ou superior.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.random-bytes-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Uma string contendo o número solicitado de bytes aleatórios
   criptograficamente seguros.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.random-bytes-errors">
  <h3 class="title">Erros/Exceções</h3>
  <ul class="itemizedlist">
   
 <li class="listitem">
  <span class="simpara">
   Se uma fonte apropriada de aleatoriedade não puder ser encontrada,
   uma exceção <span class="classname"><a href="class.random-randomexception.php" class="classname">Random\RandomException</a></span> será lançada.
  </span>
 </li>

   <li class="listitem">
    <span class="simpara">
     Se o valor de <code class="parameter">length</code> for menor que <code class="literal">1</code>,
     um <span class="classname"><a href="class.valueerror.php" class="classname">ValueError</a></span> será lançado.
    </span>
   </li>
  </ul>
 </div>


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

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.2.0</td>
      <td>
       No caso de uma falha de <abbr title="Cryptographically Secure PseudoRandom Number Generator">CSPRNG</abbr>, esta função agora lançará uma
       <span class="classname"><a href="class.random-randomexception.php" class="classname">Random\RandomException</a></span>. Anteriormente, uma
       <span class="classname"><a href="class.exception.php" class="classname">Exception</a></span> simples era lançada.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.random-bytes-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="random-bytes.example.basic">
   <p><strong>Exemplo #1 Exemplo de <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 />$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 /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>O exemplo acima produzirá
algo semelhante a:</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">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="random-randomizer.getbytes.php" class="function" rel="rdfs-seeAlso">Random\Randomizer::getBytes()</a> - Obt&eacute;m bytes aleat&oacute;rios</span></li>
   <li><span class="function"><a href="function.random-int.php" class="function" rel="rdfs-seeAlso">random_int()</a> - Obt&eacute;m um n&uacute;mero inteiro selecionado uniformemente e criptograficamente seguro</span></li>
   <li><span class="function"><a href="function.bin2hex.php" class="function" rel="rdfs-seeAlso">bin2hex()</a> - Converte um dado bin&aacute;rio em representa&ccedil;&atilde;o hexadecimal</span></li>
   <li><span class="function"><a href="function.base64-encode.php" class="function" rel="rdfs-seeAlso">base64_encode()</a> - Codifica dados com MIME base64</span></li>
  </ul>
 </div>


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