twisted.conch.ssh.factory.SSHFactory.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.ssh.factory.SSHFactory</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.ssh.html">Package ssh</a> ::
<a href="twisted.conch.ssh.factory.html">Module factory</a> ::
Class SSHFactory
</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.ssh.factory.SSHFactory.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class SSHFactory</h2>
<pre class="base-tree">
<a href="twisted.internet.protocol.Factory.html"><code>Factory</code></a> --+
|
<b>SSHFactory</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.conch.openssh_compat.factory.OpenSSHFactory.html"><code>OpenSSHFactory</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.ssh.factory.SSHFactory.html#buildProtocol" class="summary-sig-name"><code>buildProtocol</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>addr</span>)</span></code>
<br />
Create an instance of a subclass of Protocol.</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.ssh.factory.SSHFactory.html#getDHPrime" class="summary-sig-name"><code>getDHPrime</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>bits</span>)</span></code>
<br />
Return a tuple of (g, p) for a Diffe-Hellman process, with p being as
close to bits bits as possible.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>dict</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.ssh.factory.SSHFactory.html#getPrimes" class="summary-sig-name"><code>getPrimes</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when the factory is started to get Diffie-Hellman generators
and primes to use.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>dict</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.ssh.factory.SSHFactory.html#getPrivateKeys" class="summary-sig-name"><code>getPrivateKeys</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when the factory is started to get the private portions of the
servers host keys.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>dict</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.ssh.factory.SSHFactory.html#getPublicKeys" class="summary-sig-name"><code>getPublicKeys</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when the factory is started to get the public portions of the
servers host keys.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> subclass of {service.SSHService}
</font></td>
<td><code><span class="summary-sig"><a href="twisted.conch.ssh.factory.SSHFactory.html#getService" class="summary-sig-name"><code>getService</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>transport</span>,
<span class=summary-sig-arg>service</span>)</span></code>
<br />
Return a class to use as a service for the given transport.</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.ssh.factory.SSHFactory.html#startFactory" class="summary-sig-name"><code>startFactory</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
This will be called before I begin listening on a Port or
Connector.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Factory</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Factory.html#doStart" class="summary-sig-name"><code>doStart</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Make sure startFactory is called.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Factory.html#doStop" class="summary-sig-name"><code>doStop</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Make sure stopFactory is called.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Factory.html#stopFactory" class="summary-sig-name"><code>stopFactory</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
This will be called before I stop listening on all
Ports/Connectors.</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.ssh.factory.SSHFactory.html#services"><code>services</code></a></b> = <span title="{'ssh-userauth': <Fake userauth.SSHUserAuthServer>, 'ssh-connection': <class twisted.conch.ssh.connection.SSHConnection at 0x87541bc>}"><code>{'ssh-userauth': <Fake userauth.SSHUserAuthSe<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Factory</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.internet.protocol.Factory.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.internet.interfaces.IProtocolFactory at 0x827f7bc>,)"><code>(<class twisted.internet.interfaces.IPr<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.internet.protocol.Factory.html#noisy"><code>noisy</code></a></b> = <span title="'sure, why not'"><code><span class="variable-quote">'</span>sure, why not<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.protocol.Factory.html#numPorts"><code>numPorts</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.internet.protocol.Factory.html#protocol"><code>protocol</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="buildProtocol"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">buildProtocol</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>addr</span>)</span>
</h3>
<p>Create an instance of a subclass of Protocol.</p>
<p>The returned instance will handle input on an incoming server
connection, and an attribute "factory" pointing to the
creating factory.</p>
Override this method to alter how Protocol instances get
created.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>addr</b></code> -
an object implementing <a
href="twisted.internet.interfaces.IAddress.html"
class="link"><code>twisted.internet.interfaces.IAddress</code></a>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.protocol.Factory.html#buildProtocol"><code>twisted.internet.protocol.Factory.buildProtocol</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getDHPrime"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getDHPrime</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>bits</span>)</span>
</h3>
Return a tuple of (g, p) for a Diffe-Hellman process, with p being
as close to bits bits as possible.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>bits</b></code>
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>tuple</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getPrimes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getPrimes</span>(<span class=sig-arg>self</span>)</span>
</h3>
Called when the factory is started to get Diffie-Hellman generators
and primes to use. Returns a dictionary mapping number of bits to lists
of tuple of (generator, prime).
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>dict</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getPrivateKeys"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getPrivateKeys</span>(<span class=sig-arg>self</span>)</span>
</h3>
Called when the factory is started to get the private portions of
the servers host keys. Returns a dictionary mapping SSH key types to
<code>Crypto.PublicKey.pubkey.pubkey</code> objects.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>dict</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getPublicKeys"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getPublicKeys</span>(<span class=sig-arg>self</span>)</span>
</h3>
Called when the factory is started to get the public portions of the
servers host keys. Returns a dictionary mapping SSH key types to public
key strings.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>dict</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getService"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getService</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>transport</span>,
<span class=sig-arg>service</span>)</span>
</h3>
Return a class to use as a service for the given transport.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>transport</b></code>
<br /><i>
(type=<code>transport.SSHServerTransport</code>)</i>
<dd><code><b>service</b></code>
<br /><i>
(type=<code>stR</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
subclass of {service.SSHService}
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="startFactory"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">startFactory</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>This will be called before I begin listening on a Port or
Connector.</p>
<p>It will only be called once, even if the factory is connected to
multiple ports.</p>
This can be used to perform 'unserialization' tasks that are best
put off until things are actually running, such as connecting to a
database, opening files, etcetera.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.protocol.Factory.html#startFactory"><code>twisted.internet.protocol.Factory.startFactory</code></a> <i>(inherited documentation)</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="services"></a>
<h3>services</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'ssh-userauth': <Fake userauth.SSHUserAuthServer>, 'ssh-connection': <class twisted.conch.ssh.connection.SSHConnection at 0x87541bc>}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'ssh-connection': <class twisted.conch.ssh.connection.SSHConnection a<span class="variable-linewrap">\</span>
t 0x87541bc>,
'ssh-userauth': <Fake userauth.SSHUserAuthServer>} </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:54 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>