twisted.python.otp.OTP.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.python.otp.OTP</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.python.html">Package python</a> ::
<a href="twisted.python.otp.html">Module otp</a> ::
Class OTP
</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.python.otp.OTP.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class OTP</h2>
<pre class="base-tree">
<a href="twisted.python.otp.OTPAuthenticator.html"><code>OTPAuthenticator</code></a> --+
|
<b>OTP</b>
</pre><br />
<hr/>
<p>An automatic version of the OTP-Authenticator</p>
<p>Updates the sequence and the keeps last approved password on success
On the next authentication, the stored password is hashed and checked up
against the one given by the user. If they match, the sequencecounter is
decreased and the circle is closed.</p>
<p>This object should be glued to each user</p>
Note: It does NOT reset the sequence when the combinations left
approach zero, This has to be done manuelly by instancing a new
object
<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.python.otp.OTP.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>passwd</span>,
<span class=summary-sig-arg>sequence</span>,
<span class=summary-sig-arg>hash</span>)</span></code>
<br />
Initialize the OTP-Sequence, and discard the password</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTP.html#authenticate" class="summary-sig-name"><code>authenticate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>phrase</span>)</span></code>
<br />
Test the phrase against the last challenge issued</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTP.html#challenge" class="summary-sig-name"><code>challenge</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a challenge string</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from OTPAuthenticator</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTPAuthenticator.html#calculateParity" class="summary-sig-name"><code>calculateParity</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>otp</span>)</span></code>
<br />
Calculate the parity from a 64bit OTP</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTPAuthenticator.html#foldDigest" class="summary-sig-name"><code>foldDigest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>otp</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTPAuthenticator.html#foldDigest128" class="summary-sig-name"><code>foldDigest128</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>otp128</span>)</span></code>
<br />
Fold a 128 bit digest to 64 bit</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTPAuthenticator.html#foldDigest160" class="summary-sig-name"><code>foldDigest160</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>otp160</span>)</span></code>
<br />
Fold a 160 bit digest to 64 bit</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTPAuthenticator.html#generateOTP" class="summary-sig-name"><code>generateOTP</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>seed</span>,
<span class=summary-sig-arg>passwd</span>,
<span class=summary-sig-arg>sequence</span>)</span></code>
<br />
Return a 64 bit OTP based on inputs Run through makeReadable to get a
6 word pass-phrase</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTPAuthenticator.html#generateSeed" class="summary-sig-name"><code>generateSeed</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a 10 char random seed, with 6 lowercase chars and 4 digits</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTPAuthenticator.html#hashUpdate" class="summary-sig-name"><code>hashUpdate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>digest</span>)</span></code>
<br />
Run through the hash and fold to 64 bit</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTPAuthenticator.html#makeReadable" class="summary-sig-name"><code>makeReadable</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>otp</span>)</span></code>
<br />
Returns a 6 word pass-phrase from a 64bit OTP</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.otp.OTPAuthenticator.html#parsePhrase" class="summary-sig-name"><code>parsePhrase</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>phrase</span>)</span></code>
<br />
Decode the phrase, and return a 64bit OTP I will raise Unauthorized if
the parity is wrong TODO: Add support for hex (MUST) and the '2nd
scheme'(SHOULD)</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>NoneType</code></font></td>
<td><b><a href="twisted.python.otp.OTP.html#lastotp"><code>lastotp</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.python.otp.OTP.html#seed"><code>seed</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.python.otp.OTP.html#sequence"><code>sequence</code></a></b> = <span title="0">0 </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>passwd</span>,
<span class=sig-arg>sequence</span>=<span class=sig-default>1000</span>,
<span class=sig-arg>hash</span>=<span class=sig-default><module 'md5' from '/usr/lib/python2.2/lib-dynload/md5.so'></span>)</span>
<br /><i>(Constructor)</i>
</h3>
Initialize the OTP-Sequence, and discard the password
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.python.otp.OTPAuthenticator.html#__init__"><code>twisted.python.otp.OTPAuthenticator.__init__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="authenticate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">authenticate</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>phrase</span>)</span>
</h3>
Test the phrase against the last challenge issued
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="challenge"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">challenge</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return a challenge string
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.python.otp.OTPAuthenticator.html#challenge"><code>twisted.python.otp.OTPAuthenticator.challenge</code></a></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="lastotp"></a>
<h3>lastotp</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="seed"></a>
<h3>seed</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="sequence"></a>
<h3>sequence</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </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:55 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>