1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="oauthprovider.generatetoken" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>OAuthProvider::generateToken</refname>
<refpurpose>Generate a random token</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>OAuthProvider::generateToken</methodname>
<methodparam><type>int</type><parameter>size</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>strong</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
Generates a <type>string</type> of pseudo-random bytes.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>size</parameter></term>
<listitem>
<para>
The desired token length, in terms of bytes.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>strong</parameter></term>
<listitem>
<para>
Setting to &true; means <literal>/dev/random</literal> will be used for
entropy, as otherwise the non-blocking <literal>/dev/urandom</literal> is used.
This parameter is ignored on Windows.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The generated token, as a <type>string</type> of bytes.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
If the <parameter>strong</parameter> parameter is &true;, then an
<constant>E_WARNING</constant> level error will be emitted when the
fallback <function>rand</function> implementation is used to fill
the remaining random bytes (e.g., when not enough random data was found,
initially).
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>OAuthProvider::generateToken</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$p = new OAuthProvider();
$t = $p->generateToken(4);
echo strlen($t), PHP_EOL;
echo bin2hex($t), PHP_EOL;
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
4
b6a82c27
]]>
</screen>
</example>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
When not enough random data is available to the system, this function will
fill the remaining random bytes using the internal PHP <function>rand</function>
implementation.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>openssl_random_pseudo_bytes</function></member>
<member><function>mcrypt_create_iv</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
-->
|
