classBcrypt.html
9.77 KB
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
<!-- HTML header for doxygen 1.8.5-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Fat-Free Framework: Bcrypt Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Fat-Free Framework
 <span id="projectnumber">3.2.2</span>
 <span class="menu"><a href="index.html">Overview</a> <a href="annotated.html">Class List</a> <a href="hierarchy.html">Hierarchy</a></span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classBcrypt-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Bcrypt Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Lightweight password hashing library.
<a href="classBcrypt.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Bcrypt:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classBcrypt.png" usemap="#Bcrypt_map" alt=""/>
<map id="Bcrypt_map" name="Bcrypt_map">
<area href="classPrefab.html" title="Factory class for single-instance objects. " alt="Prefab" shape="rect" coords="0,0,50,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adfde3babee4bf0fce0c2e161204a9779"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBcrypt.html#adfde3babee4bf0fce0c2e161204a9779">hash</a> ($pw, $salt=NULL, $cost=self::COST)</td></tr>
<tr class="separator:adfde3babee4bf0fce0c2e161204a9779"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6af12217cde70314d70c26b461a9345c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBcrypt.html#a6af12217cde70314d70c26b461a9345c">needs_rehash</a> ($<a class="el" href="classBcrypt.html#adfde3babee4bf0fce0c2e161204a9779">hash</a>, $cost=self::COST)</td></tr>
<tr class="separator:a6af12217cde70314d70c26b461a9345c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0127bb982943f4e07cd6ea5c068307d7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBcrypt.html#a0127bb982943f4e07cd6ea5c068307d7">verify</a> ($pw, $<a class="el" href="classBcrypt.html#adfde3babee4bf0fce0c2e161204a9779">hash</a>)</td></tr>
<tr class="separator:a0127bb982943f4e07cd6ea5c068307d7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1585e7ecdf377dbd67387363da582b47"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1585e7ecdf377dbd67387363da582b47"></a>
const </td><td class="memItemRight" valign="bottom"><a class="el" href="classBcrypt.html#a1585e7ecdf377dbd67387363da582b47">COST</a> =10</td></tr>
<tr class="memdesc:a1585e7ecdf377dbd67387363da582b47"><td class="mdescLeft"> </td><td class="mdescRight">Default cost. <br/></td></tr>
<tr class="separator:a1585e7ecdf377dbd67387363da582b47"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:acc5678144b71e7cfc2a3ddab09efb8c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc5678144b71e7cfc2a3ddab09efb8c4"></a>
const </td><td class="memItemRight" valign="bottom"><b>E_CostArg</b> ='Invalid cost parameter'</td></tr>
<tr class="separator:acc5678144b71e7cfc2a3ddab09efb8c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5a770850d97011c0a96f85937b67372"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5a770850d97011c0a96f85937b67372"></a>
const </td><td class="memItemRight" valign="bottom"><b>E_SaltArg</b> ='Salt must be at least 22 alphanumeric characters'</td></tr>
<tr class="separator:ab5a770850d97011c0a96f85937b67372"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classPrefab"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classPrefab')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classPrefab.html">Prefab</a></td></tr>
<tr class="memitem:a459ac539bc012dbdb77abe0d0ebeba76 inherit pub_static_methods_classPrefab"><td class="memItemLeft" align="right" valign="top">static </td><td class="memItemRight" valign="bottom"><a class="el" href="classPrefab.html#a459ac539bc012dbdb77abe0d0ebeba76">instance</a> ()</td></tr>
<tr class="separator:a459ac539bc012dbdb77abe0d0ebeba76 inherit pub_static_methods_classPrefab"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Lightweight password hashing library. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="adfde3babee4bf0fce0c2e161204a9779"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bcrypt::hash </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$pw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$salt</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$cost</em> = <code>self::COST</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate bcrypt hash of string </p>
<dl class="section return"><dt>Returns</dt><dd>string|FALSE </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$pw</td><td>string </td></tr>
<tr><td class="paramname">$salt</td><td>string </td></tr>
<tr><td class="paramname">$cost</td><td>int </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6af12217cde70314d70c26b461a9345c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bcrypt::needs_rehash </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$cost</em> = <code>self::COST</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if password is still strong enough </p>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$hash</td><td>string </td></tr>
<tr><td class="paramname">$cost</td><td>int </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0127bb982943f4e07cd6ea5c068307d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bcrypt::verify </td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>$pw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>$hash</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Verify password against hash using timing attack resistant approach </p>
<dl class="section return"><dt>Returns</dt><dd>bool </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">$pw</td><td>string </td></tr>
<tr><td class="paramname">$hash</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>bcrypt.php</li>
</ul>
</div><!-- contents -->