random_bytes
(PHP 7, PHP 8)
random_bytes — Get cryptographically secure random bytes
Descrição
As the returned bytes are selected completely randomly, the resulting string is likely
to contain unprintable characters or invalid UTF-8 sequences. It may be necessary to
encode it before transmission or display.
The randomness generated by this function is suitable for all applications, including
the generation of long-term secrets, such as encryption keys.
As fontes de aleatoriedade usadas para esta função são as seguintes:
-
Linux: » getrandom(), /dev/urandom
-
FreeBSD >= 12 (PHP >= 7.3): » getrandom(), /dev/urandom
-
Windows (PHP >= 7.2): » CNG-API
Windows: » CryptGenRandom
-
macOS (PHP >= 8.2; >= 8.1.9; >= 8.0.22 se CCRandomGenerateBytes estiver disponível em tempo de compilação): CCRandomGenerateBytes()
macOS (PHP >= 8.1; >= 8.0.2): arc4random_buf(), /dev/urandom
-
NetBSD >= 7 (PHP >= 7.1; >= 7.0.1): arc4random_buf(), /dev/urandom
-
OpenBSD >= 5.5 (PHP >= 7.1; >= 7.0.1): arc4random_buf(), /dev/urandom
-
DragonflyBSD (PHP >= 8.1): » getrandom(), /dev/urandom
-
Solaris (PHP >= 8.1): » getrandom(), /dev/urandom
-
Qualquer combinação de sistema operacional e versão do PHP não mencionada anteriormente: /dev/urandom
-
Se nenhuma das fontes estiver disponível ou todas falharem em gerar
aleatoriedade, então uma exceção Random\RandomException
será lançada.
Nota:
Embora esta função tenha sido adicionada ao PHP no PHP 7.0, uma
» implementação no espaço do usuário
está disponível para o PHP 5.2 ao 5.6, inclusive.
Parâmetros
-
length
-
The length of the random string that should be returned in bytes; must be 1
or greater.
Valor Retornado
A string containing the requested number of cryptographically
secure random bytes.
Erros/Exceções
-
Se uma fonte apropriada de aleatoriedade não puder ser encontrada,
uma exceção Random\RandomException será lançada.
-
If the value of
length
is less than 1
,
a ValueError will be thrown.
Exemplos
Exemplo #1 random_bytes() example
<?php
$bytes = random_bytes(5);
var_dump(bin2hex($bytes));
?>
O exemplo acima produzirá
algo semelhante a: