twisted.conch.identity.ConchIdentity.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.conch.identity.ConchIdentity</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.conch.html">Package conch</a> ::
<a href="twisted.conch.identity.html">Module identity</a> ::
Class ConchIdentity
</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.conch.identity.ConchIdentity.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class ConchIdentity</h2>
<pre class="base-tree">
<a href="twisted.cred.identity.Identity.html"><code>Identity</code></a> --+
|
<b>ConchIdentity</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.conch.identity.OpenSSHConchIdentity.html"><code>OpenSSHConchIdentity</code></a></dd></dl>
<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.conch.identity.ConchIdentity.html#addClientForService" class="summary-sig-name"><code>addClientForService</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>,
<span class=summary-sig-arg>clientClass</span>)</span></code>
<br />
Adds a client class for the 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.conch.identity.ConchIdentity.html#addServiceForSelf" class="summary-sig-name"><code>addServiceForSelf</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>)</span></code>
<br />
This will add the service, using our name as the name for the
perspective.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>str</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.identity.ConchIdentity.html#getHomeDir" class="summary-sig-name"><code>getHomeDir</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the users home directory.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>str</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.identity.ConchIdentity.html#getShell" class="summary-sig-name"><code>getShell</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the users shell.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>tuple</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.identity.ConchIdentity.html#getUserGroupID" class="summary-sig-name"><code>getUserGroupID</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a uid and gid for this user as a tuple (uid, gid).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>Deferred</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.identity.ConchIdentity.html#validatePublicKey" class="summary-sig-name"><code>validatePublicKey</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>pubKeyString</span>)</span></code>
<br />
This should return a Deferred, that gets either called or erred back,
depending on if this is a valid key for the user.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Identity</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><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<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><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#setPassword" class="summary-sig-name"><code>setPassword</code></a>(<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><span class="summary-sig"><a href="twisted.cred.identity.Identity.html#upgradeToVersion2" class="summary-sig-name"><code>upgradeToVersion2</code></a>(<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>dict</code></font></td>
<td><b><a href="twisted.conch.identity.ConchIdentity.html#clients"><code>clients</code></a></b> = <span title="{}"><code>{} </code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Identity</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="addClientForService"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addClientForService</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>serviceName</span>,
<span class=sig-arg>clientClass</span>)</span>
</h3>
Adds a client class for the given service. Currently unused.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>serviceName</b></code>
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>clientClass</b></code>
<br /><i>
(type=<code>class</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="addServiceForSelf"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addServiceForSelf</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>serviceName</span>)</span>
</h3>
This will add the service, using our name as the name for the
perspective. Currently unused.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>serviceName</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getHomeDir"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getHomeDir</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the users home directory.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>str</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getShell"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getShell</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return the users shell.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>str</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getUserGroupID"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getUserGroupID</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return a uid and gid for this user as a tuple (uid, gid).
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>tuple</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="validatePublicKey"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">validatePublicKey</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>pubKeyString</span>)</span>
</h3>
This should return a Deferred, that gets either called or erred
back, depending on if this is a valid key for the user.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>pubKeyString</b></code>
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>Deferred</code>
</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="clients"></a>
<h3>clients</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{} </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:08:41 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>