mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
157 lines
4.1 KiB
XML
157 lines
4.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.openssl-random-pseudo-bytes" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>openssl_random_pseudo_bytes</refname>
|
|
<refpurpose>Generate a pseudo-random string of bytes</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>openssl_random_pseudo_bytes</methodname>
|
|
<methodparam><type>int</type><parameter>length</parameter></methodparam>
|
|
<methodparam choice="opt"><type>bool</type><parameter role="reference">strong_result</parameter><initializer>&null;</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Generates a <type>string</type> of pseudo-random bytes, with the number of bytes
|
|
determined by the <parameter>length</parameter> parameter.
|
|
</para>
|
|
<para>
|
|
It also indicates if a cryptographically strong algorithm was used to produce the
|
|
pseudo-random bytes, and does this via the optional <parameter>strong_result</parameter>
|
|
parameter. It's rare for this to be &false;, but some systems may be broken or old.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>length</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The length of the desired string of bytes. Must be a positive integer. PHP will
|
|
try to cast this parameter to a non-null integer to use it.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>strong_result</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If passed into the function, this will hold a <type>bool</type> value that determines
|
|
if the algorithm used was "cryptographically strong", e.g., safe for usage with GPG,
|
|
passwords, etc. &true; if it did, otherwise &false;
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the generated &string; of bytes on success, &return.falseforfailure;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
<parameter>strong_result</parameter> is nullable now.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>openssl_random_pseudo_bytes</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
for ($i = 1; $i <= 4; $i++) {
|
|
$bytes = openssl_random_pseudo_bytes($i, $cstrong);
|
|
$hex = bin2hex($bytes);
|
|
|
|
echo "Lengths: Bytes: $i and Hex: " . strlen($hex) . PHP_EOL;
|
|
var_dump($hex);
|
|
var_dump($cstrong);
|
|
echo PHP_EOL;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Lengths: Bytes: 1 and Hex: 2
|
|
string(2) "42"
|
|
bool(true)
|
|
|
|
Lengths: Bytes: 2 and Hex: 4
|
|
string(4) "dc6e"
|
|
bool(true)
|
|
|
|
Lengths: Bytes: 3 and Hex: 6
|
|
string(6) "288591"
|
|
bool(true)
|
|
|
|
Lengths: Bytes: 4 and Hex: 8
|
|
string(8) "ab86d144"
|
|
bool(true)
|
|
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<simplelist>
|
|
<member><function>random_bytes</function></member>
|
|
<member><function>bin2hex</function></member>
|
|
<member><function>crypt</function></member>
|
|
<member><function>mt_rand</function></member>
|
|
<member><function>uniqid</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
|
|
-->
|