Files
doc-fr/reference/csprng/functions/random-bytes.xml
George Peter Banyard fc55144f1c Apply commit 7f99d5e488d161ce3b12d1dae405a283728933c3
Remove some unnecessary methodsynopsis role attributes
2021-09-14 14:18:16 +01:00

112 lines
3.0 KiB
XML
Executable File

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: $ -->
<!-- EN-Revision: 7f99d5e488d161ce3b12d1dae405a283728933c3 Maintainer: girgias Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.random-bytes" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>random_bytes</refname>
<refpurpose>Génère des octets pseudo-aléatoire cryptographiquement sécurisé</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>random_bytes</methodname>
<methodparam><type>int</type><parameter>length</parameter></methodparam>
</methodsynopsis>
<para>
Génère une &string; de longueur arbitraire d'octets aléatoires cryptographiques
qui convient à un usage cryptographique, comme lors de la génération de sels, de clés ou
de vecteurs d'initialisation.
</para>
&csprng.sources;
&csprng.function.backport;
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>length</parameter></term>
<listitem>
<para>
La longueur de la &string; aléatoire qui doit être retourné en octets.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
Retourne une &string; contenant le nombre demandé d'octet aléatoire
cryptographiquement sécurisé.
</para>
</refsect1><!-- }}} -->
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
<itemizedlist>
&csprng.errors;
<listitem>
<simpara>
Si une longueur <parameter>length</parameter> invalide d'octet est fournit,
une <classname>Error</classname> sera lancé.
</simpara>
</listitem>
</itemizedlist>
</refsect1><!-- }}} -->
<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<example xml:id="random-bytes.example.basic"><!-- {{{ -->
<title>Exemple avec <function>random_bytes</function></title>
<programlisting role="php">
<![CDATA[
<?php
$bytes = random_bytes(5);
var_dump(bin2hex($bytes));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
string(10) "385e33f741"
]]>
</screen>
</example><!-- }}} -->
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
&reftitle.seealso;
<simplelist>
<member><function>random_int</function></member>
<member><function>openssl_random_pseudo_bytes</function></member>
<member><function>bin2hex</function></member>
</simplelist>
</refsect1><!-- }}} -->
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->