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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
|
<!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"/>
<title>Wt: Wt::Auth::AbstractPasswordService Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="namespaceWt_1_1Auth.html">Auth</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html">AbstractPasswordService</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Auth::AbstractPasswordService Class Reference<div class="ingroups"><a class="el" href="group__auth.html">Authentication module (Wt::Auth)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Auth::AbstractPasswordService" -->
<p>Abstract password authentication service.
<a href="classWt_1_1Auth_1_1AbstractPasswordService.html#details">More...</a></p>
<p><code>#include <Wt/Auth/AbstractPasswordService></code></p>
<div class="dynheader">
Inheritance diagram for Wt::Auth::AbstractPasswordService:</div>
<div class="dyncontent">
<div class="center"><img src="classWt_1_1Auth_1_1AbstractPasswordService__inherit__graph.png" border="0" usemap="#Wt_1_1Auth_1_1AbstractPasswordService_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Auth_1_1AbstractPasswordService_inherit__map" id="Wt_1_1Auth_1_1AbstractPasswordService_inherit__map">
<area shape="rect" href="classWt_1_1Auth_1_1PasswordService.html" title="Password authentication service." alt="" coords="31,80,209,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classWt_1_1Auth_1_1AbstractPasswordService-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService_1_1AbstractStrengthValidator.html">AbstractStrengthValidator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Validator for password strength. <a href="classWt_1_1Auth_1_1AbstractPasswordService_1_1AbstractStrengthValidator.html#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService_1_1StrengthValidatorResult.html">StrengthValidatorResult</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Result returned when validating password strength. <a href="classWt_1_1Auth_1_1AbstractPasswordService_1_1StrengthValidatorResult.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6df30a56f41e4cb0464a83e10de6fb25"></a><!-- doxytag: member="Wt::Auth::AbstractPasswordService::~AbstractPasswordService" ref="a6df30a56f41e4cb0464a83e10de6fb25" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html#a6df30a56f41e4cb0464a83e10de6fb25">~AbstractPasswordService</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac85f8697cb4d9e666f155a314290babd"></a><!-- doxytag: member="Wt::Auth::AbstractPasswordService::baseAuth" ref="ac85f8697cb4d9e666f155a314290babd" args="() const =0" -->
virtual const <a class="el" href="classWt_1_1Auth_1_1AuthService.html">AuthService</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html#ac85f8697cb4d9e666f155a314290babd">baseAuth</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the basic authentication service. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad7d1fa56e35cfcca72b8028b6d4421e"></a><!-- doxytag: member="Wt::Auth::AbstractPasswordService::attemptThrottlingEnabled" ref="aad7d1fa56e35cfcca72b8028b6d4421e" args="() const =0" -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html#aad7d1fa56e35cfcca72b8028b6d4421e">attemptThrottlingEnabled</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether password attempt throttling is enabled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c6818142b299560af81bbae31555558"></a><!-- doxytag: member="Wt::Auth::AbstractPasswordService::strengthValidator" ref="a8c6818142b299560af81bbae31555558" args="() const =0" -->
virtual <a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService_1_1AbstractStrengthValidator.html">AbstractStrengthValidator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html#a8c6818142b299560af81bbae31555558">strengthValidator</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a validator which checks that a password is strong enough. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html#a48f8ad7a03a224e00ee7a8620b9dafa8">delayForNextAttempt</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the delay for this user for a next authentication attempt. <a href="#a48f8ad7a03a224e00ee7a8620b9dafa8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__auth.html#ga001a66930b52328e78649572d6922bcc">PasswordResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html#a3baff128b654ac06f27b57c15c8923d8">verifyPassword</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const <a class="el" href="classWt_1_1WString.html">WString</a> &password) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Verifies a password for a given user. <a href="#a3baff128b654ac06f27b57c15c8923d8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html#a4cb7e7f61e0896af9c1d13651219e693">updatePassword</a> (const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> &user, const <a class="el" href="classWt_1_1WString.html">WString</a> &password) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a new password for the given user. <a href="#a4cb7e7f61e0896af9c1d13651219e693"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract password authentication service. </p>
<p>This abstract class defines the interface for password authentication.</p>
<p>It provides methods to verify a password, to update a password, and to throttle password verification attempts.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1PasswordService.html" title="Password authentication service.">PasswordService</a> a default implementation </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a48f8ad7a03a224e00ee7a8620b9dafa8"></a><!-- doxytag: member="Wt::Auth::AbstractPasswordService::delayForNextAttempt" ref="a48f8ad7a03a224e00ee7a8620b9dafa8" args="(const User &user) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Wt::Auth::AbstractPasswordService::delayForNextAttempt </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the delay for this user for a next authentication attempt. </p>
<p>If password attempt throttling is enabled, then this returns the number of seconds this user must wait for a new authentication attempt, presumably because of a number of failed attempts.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Auth_1_1AbstractPasswordService.html#aad7d1fa56e35cfcca72b8028b6d4421e" title="Returns whether password attempt throttling is enabled.">attemptThrottlingEnabled()</a> </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1Auth_1_1PasswordService.html#ad37117a366dcc43f25d245181dac732f">Wt::Auth::PasswordService</a>.</p>
</div>
</div>
<a class="anchor" id="a4cb7e7f61e0896af9c1d13651219e693"></a><!-- doxytag: member="Wt::Auth::AbstractPasswordService::updatePassword" ref="a4cb7e7f61e0896af9c1d13651219e693" args="(const User &user, const WString &password) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Wt::Auth::AbstractPasswordService::updatePassword </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a new password for the given user. </p>
<p>This stores a new password for the user in the database. </p>
<p>Implemented in <a class="el" href="classWt_1_1Auth_1_1PasswordService.html#aa1cde5c463721c4373c0bf53edf3aaa1">Wt::Auth::PasswordService</a>.</p>
</div>
</div>
<a class="anchor" id="a3baff128b654ac06f27b57c15c8923d8"></a><!-- doxytag: member="Wt::Auth::AbstractPasswordService::verifyPassword" ref="a3baff128b654ac06f27b57c15c8923d8" args="(const User &user, const WString &password) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__auth.html#ga001a66930b52328e78649572d6922bcc">PasswordResult</a> Wt::Auth::AbstractPasswordService::verifyPassword </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classWt_1_1Auth_1_1User.html">User</a> & </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> & </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Verifies a password for a given user. </p>
<p>The supplied password is verified against the user's credentials stored in the database. If password account throttling is enabled, it may also refuse an authentication attempt.</p>
<dl class="see"><dt><b>See also:</b></dt><dd>setVerifier(), setAttemptThrottlingEnabled() </dd></dl>
<p>Implemented in <a class="el" href="classWt_1_1Auth_1_1PasswordService.html#afcac6c444116aa7e76bafded3516ff7c">Wt::Auth::PasswordService</a>.</p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Fri Mar 30 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
|