twisted.cred.checkers.FilePasswordDB.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.cred.checkers.FilePasswordDB</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.cred.html">Package cred</a> ::
<a href="twisted.cred.checkers.html">Module checkers</a> ::
Class FilePasswordDB
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.cred.checkers.FilePasswordDB.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class FilePasswordDB</h2>
<hr/>
<p>A file-based, text-based username/password database.</p>
Records in the datafile for this class are delimited by a particular
string. The username appears in a fixed field of the columns delimited by
this string, as does the password. Both fields are specifiable. If the
passwords are not stored plaintext, a hash function must be supplied to
convert plaintext passwords to the form stored on disk and this
CredentialsChecker will only be able to check IUsernamePassword
credentials. If the passwords are stored plaintext,
IUsernameHashedPassword credentials will be checkable as well.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.checkers.FilePasswordDB.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>delim</span>,
<span class=summary-sig-arg>usernameField</span>,
<span class=summary-sig-arg>passwordField</span>,
<span class=summary-sig-arg>caseSensitive</span>,
<span class=summary-sig-arg>hash</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_cbPasswordMatch"></a><span class="summary-sig"><span class="summary-sig-name">_cbPasswordMatch</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>matched</span>,
<span class=summary-sig-arg>username</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getUser"></a><span class="summary-sig"><span class="summary-sig-name">getUser</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>username</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="requestAvatarId"></a><span class="summary-sig"><span class="summary-sig-name">requestAvatarId</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>c</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.cred.checkers.FilePasswordDB.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.cred.checkers.ICredentialsChecker at 0x85adbcc>,)"><code>(<class twisted.cred.checkers.ICredenti<span class="variable-ellipsis">...</span></code>
</span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>filename</span>,
<span class=sig-arg>delim</span>=<span class=sig-default>':'</span>,
<span class=sig-arg>usernameField</span>=<span class=sig-default>0</span>,
<span class=sig-arg>passwordField</span>=<span class=sig-default>1</span>,
<span class=sig-arg>caseSensitive</span>=<span class=sig-default>1</span>,
<span class=sig-arg>hash</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>filename</b></code> -
The name of the file from which to read username and password
information.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>delim</b></code> -
The field delimiter used in the file.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>usernameField</b></code> -
The index of the username after splitting a line on the
delimiter.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>passwordField</b></code> -
The index of the password after splitting a line on the
delimiter.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>caseSensitive</b></code> -
If true, consider the case of the username when performing a
lookup. Ignore it otherwise.
<br /><i>
(type=<code>bool</code>)</i>
<dd><code><b>hash</b></code> -
A function used to transform the plaintext password received
over the network to a format suitable for comparison against the
version stored on disk. The arguments to the callable are the
username, the network-supplied password, and the in-file version
of the password.
<br /><i>
(type=Three-argument callable.)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__implements__"></a>
<h3>__implements__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="(<class twisted.cred.checkers.ICredentialsChecker at 0x85adbcc>,)"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
(<class twisted.cred.checkers.ICredentialsChecker at 0x85adbcc>,) </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:44 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>