twisted.cred.identity.Identity.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.identity.Identity</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.identity.html">Module identity</a> ::
Class Identity
</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.identity.Identity.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Identity</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.conch.identity.ConchIdentity.html"><code>ConchIdentity</code></a></dd></dl>
<hr/>
<p>An identity, with different methods for verification.</p>
An identity represents a user's permissions with a particular
application. It is a username, a password, and a collection of
Perspective/Service name pairs, each of which is a perspective that this
identity is allowed to access.
<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.identity.Identity.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>authorizer</span>)</span></code>
<br />
Create an identity.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</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.cred.identity.Identity.html#addKeyByString" class="summary-sig-name"><code>addKeyByString</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>,
<span class=summary-sig-arg>perspectiveName</span>)</span></code>
<br />
Put a key on my keyring.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#addKeyForPerspective" class="summary-sig-name"><code>addKeyForPerspective</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>perspective</span>)</span></code>
<br />
Add a key for the given perspective.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#challenge" class="summary-sig-name"><code>challenge</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
I return some random data.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#getAllKeys" class="summary-sig-name"><code>getAllKeys</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Returns a list of all services and perspectives this identity can
connect to.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#removeKey" class="summary-sig-name"><code>removeKey</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>,
<span class=summary-sig-arg>perspectiveName</span>)</span></code>
<br />
Remove a key from my keyring.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#requestPerspectiveForKey" class="summary-sig-name"><code>requestPerspectiveForKey</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>,
<span class=summary-sig-arg>perspectiveName</span>)</span></code>
<br />
Get a perspective request (a Deferred) for the given key.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#requestPerspectiveForService" class="summary-sig-name"><code>requestPerspectiveForService</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>)</span></code>
<br />
Get the first available perspective for a given service.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#save" class="summary-sig-name"><code>save</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Persist this Identity to the authorizer.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#setAlreadyHashedPassword" class="summary-sig-name"><code>setAlreadyHashedPassword</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>cyphertext</span>)</span></code>
<br />
(legacy) Set a password for this identity, already md5 hashed.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="setPassword"></a><span class="summary-sig"><span class="summary-sig-name">setPassword</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>plaintext</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="upgradeToVersion2"></a><span class="summary-sig"><span class="summary-sig-name">upgradeToVersion2</span>(<span class=summary-sig-arg>self</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.cred.identity.Identity.html#verifyPassword" class="summary-sig-name"><code>verifyPassword</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>challenge</span>,
<span class=summary-sig-arg>hashedPassword</span>)</span></code>
<br />
Verify a challenge/response 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.cred.identity.Identity.html#verifyPlainPassword" class="summary-sig-name"><code>verifyPlainPassword</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>plaintext</span>)</span></code>
<br />
Verify plain text password.</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.cred.identity.Identity.html#hashedPassword"><code>hashedPassword</code></a></b> = <span title="None">None </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>name</span>,
<span class=sig-arg>authorizer</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<p>Create an identity.</p>
I must have a name, and a backreference to the Application that the
Keys on my keyring make reference to.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="addKeyByString"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addKeyByString</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>serviceName</span>,
<span class=sig-arg>perspectiveName</span>)</span>
</h3>
<p>Put a key on my keyring.</p>
This key will give me a token to access to some service in the
future.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="addKeyForPerspective"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addKeyForPerspective</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>perspective</span>)</span>
</h3>
Add a key for the given perspective.
<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>
<p>I return some random data.</p>
This is a method in addition to the module-level function because it
is anticipated that we will want to change this to store salted
passwords.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getAllKeys"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getAllKeys</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Returns a list of all services and perspectives this identity can
connect to.</p>
This returns a sequence of keys.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="removeKey"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeKey</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>serviceName</span>,
<span class=sig-arg>perspectiveName</span>)</span>
</h3>
<p>Remove a key from my keyring.</p>
If this key is not present, raise KeyError.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="requestPerspectiveForKey"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">requestPerspectiveForKey</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>serviceName</span>,
<span class=sig-arg>perspectiveName</span>)</span>
</h3>
<p>Get a perspective request (a Deferred) for the given key.</p>
If this identity does not have access to the given
<code>(serviceName, perspectiveName)</code> pair, I will raise <a
href="twisted.cred.error.KeyNotFound.html"
class="link"><code>KeyNotFound</code></a>.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="requestPerspectiveForService"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">requestPerspectiveForService</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>serviceName</span>)</span>
</h3>
Get the first available perspective for a given service.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="save"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">save</span>(<span class=sig-arg>self</span>)</span>
</h3>
Persist this Identity to the authorizer.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setAlreadyHashedPassword"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setAlreadyHashedPassword</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>cyphertext</span>)</span>
</h3>
(legacy) Set a password for this identity, already md5 hashed.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="verifyPassword"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">verifyPassword</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>challenge</span>,
<span class=sig-arg>hashedPassword</span>)</span>
</h3>
Verify a challenge/response password.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="verifyPlainPassword"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">verifyPlainPassword</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>plaintext</span>)</span>
</h3>
<p>Verify plain text password.</p>
This is insecure, but necessary to support legacy protocols such as
IRC, POP3, HTTP, etc.
<dl><dt></dt><dd>
</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="hashedPassword"></a>
<h3>hashedPassword</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>
<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:52 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>