diff options
Diffstat (limited to 'docs')
185 files changed, 42047 insertions, 0 deletions
diff --git a/docs/epydoc.css b/docs/epydoc.css new file mode 100644 index 0000000..46080bd --- /dev/null +++ b/docs/epydoc.css @@ -0,0 +1,100 @@ + +/* Body color */ +body { background: #ffffff; color: #000000; } + +/* Tables */ +table.summary, table.details, table.index + { background: #e8f0f8; color: #000000; } +tr.summary, tr.details, tr.index + { background: #70b0f0; color: #000000; + text-align: left; font-size: 120%; } +tr.group { background: #c0e0f8; color: #000000; + text-align: left; font-size: 120%; + font-style: italic; } + +/* Documentation page titles */ +h2.module { margin-top: 0.2em; } +h2.class { margin-top: 0.2em; } + +/* Headings */ +h1.heading { font-size: +140%; font-style: italic; + font-weight: bold; } +h2.heading { font-size: +125%; font-style: italic; + font-weight: bold; } +h3.heading { font-size: +110%; font-style: italic; + font-weight: normal; } + +/* Base tree */ +pre.base-tree { font-size: 80%; margin: 0; } + +/* Details Sections */ +table.func-details { background: #e8f0f8; color: #000000; + border: 2px groove #c0d0d0; + padding: 0 1em 0 1em; margin: 0.4em 0 0 0; } +h3.func-detail { background: transparent; color: #000000; + margin: 0 0 1em 0; } + +table.var-details { background: #e8f0f8; color: #000000; + border: 2px groove #c0d0d0; + padding: 0 1em 0 1em; margin: 0.4em 0 0 0; } +h3.var-details { background: transparent; color: #000000; + margin: 0 0 1em 0; } + +/* Function signatures */ +.sig { background: transparent; color: #000000; + font-weight: bold; } +.sig-name { background: transparent; color: #006080; } +.sig-arg, .sig-kwarg, .sig-vararg + { background: transparent; color: #008060; } +.sig-default { background: transparent; color: #602000; } +.summary-sig { background: transparent; color: #000000; } +.summary-sig-name { background: transparent; color: #204080; } +.summary-sig-arg, .summary-sig-kwarg, .summary-sig-vararg + { background: transparent; color: #008060; } + +/* Doctest blocks */ +.py-src { background: transparent; color: #000000; } +.py-prompt { background: transparent; color: #005050; + font-weight: bold;} +.py-string { background: transparent; color: #006030; } +.py-comment { background: transparent; color: #003060; } +.py-keyword { background: transparent; color: #600000; } +.py-output { background: transparent; color: #404040; } +pre.doctestblock { background: #f4faff; color: #000000; + padding: .5em; margin: 1em; + border: 1px solid #708890; } +table pre.doctestblock + { background: #dce4ec; color: #000000; + padding: .5em; margin: 1em; + border: 1px solid #708890; } + +/* Variable values */ +pre.variable { background: #dce4ec; color: #000000; + padding: .5em; margin: 0; + border: 1px solid #708890; } +.variable-linewrap { background: transparent; color: #604000; } +.variable-ellipsis { background: transparent; color: #604000; } +.variable-quote { background: transparent; color: #604000; } +.re { background: transparent; color: #000000; } +.re-char { background: transparent; color: #006030; } +.re-op { background: transparent; color: #600000; } +.re-group { background: transparent; color: #003060; } +.re-ref { background: transparent; color: #404040; } + +/* Navigation bar */ +table.navbar { background: #a0c0ff; color: #0000ff; + border: 2px groove #c0d0d0; } +th.navbar { background: #a0c0ff; color: #0000ff; } +th.navselect { background: #70b0ff; color: #000000; } +.nomargin { margin: 0; } + +/* Links */ +a:link { background: transparent; color: #0000ff; } +a:visited { background: transparent; color: #204080; } +a.navbar:link { background: transparent; color: #0000ff; + text-decoration: none; } +a.navbar:visited { background: transparent; color: #204080; + text-decoration: none; } + +/* Lists */ +ul { margin-top: 0; } diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..d2fca35 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,13 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"> +<html> +<head> + <title> API Documentation </title> +</head> +<frameset cols="20%,80%"> + <frameset rows="30%,70%"> + <frame src="public/toc.html" name="moduleListFrame"> + <frame src="public/toc-everything.html" name="moduleFrame"> + </frameset> + <frame src="public/paramiko-module.html" name="mainFrame"> +</frameset> +</html> diff --git a/docs/private/__builtin__.object-class.html b/docs/private/__builtin__.object-class.html new file mode 100644 index 0000000..1ac54de --- /dev/null +++ b/docs/private/__builtin__.object-class.html @@ -0,0 +1,286 @@ +<?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>__builtin__.object</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Module __builtin__ :: + Class object + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/__builtin__.object-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="__builtin__.object-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type object</h2> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a>, + <a href="paramiko.Channel-class.html"><code>Channel</code></a>, + <a href="paramiko.server.InteractiveQuery-class.html"><code>InteractiveQuery</code></a>, + <a href="paramiko.Message-class.html"><code>Message</code></a>, + <a href="paramiko.util.PFilter-class.html"><code>PFilter</code></a>, + <a href="paramiko.SecurityOptions-class.html"><code>SecurityOptions</code></a>, + <a href="paramiko.SFTPAttributes-class.html"><code>SFTPAttributes</code></a>, + <a href="paramiko.SFTPHandle-class.html"><code>SFTPHandle</code></a>, + <a href="__builtin__.type-class.html"><code>type</code></a>, + <a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a>, + <a href="../private/paramiko.AuthHandler-class.html"><code>AuthHandler</code></a>, + <a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a>, + <a href="../private/paramiko.ber.BER-class.html"><code>BER</code></a>, + <a href="../private/paramiko.logging22.Formatter-class.html"><code>Formatter</code></a>, + <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>KexGex</code></a>, + <a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>KexGroup1</code></a>, + <a href="../private/paramiko.logging22.logger-class.html"><code>logger</code></a>, + <a href="../private/paramiko.primes.ModulusPack-class.html"><code>ModulusPack</code></a>, + <a href="../private/paramiko.Packetizer-class.html"><code>Packetizer</code></a>, + <a href="../private/paramiko.PKey-class.html"><code>PKey</code></a>, + <a href="../private/paramiko.pipe.PosixPipe-class.html"><code>PosixPipe</code></a>, + <a href="../private/paramiko.ServerInterface-class.html"><code>ServerInterface</code></a>, + <a href="../private/paramiko.SFTPServerInterface-class.html"><code>SFTPServerInterface</code></a>, + <a href="../private/paramiko.logging22.StreamHandler-class.html"><code>StreamHandler</code></a>, + <a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>WindowsPipe</code></a>, + <a href="../private/paramiko.compress.ZlibCompressor-class.html"><code>ZlibCompressor</code></a>, + <a href="../private/paramiko.compress.ZlibDecompressor-class.html"><code>ZlibDecompressor</code></a></dd></dl> + +<hr/> + +The most base type +<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="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__init__(...) initializes x; see x.__class__.__doc__ for +signature</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>type</code></font></td> + <td><a name="__class__"></a><b><code>__class__</code></b> = <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></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-vararg">...</span>)</span> + <br /><i>(Constructor)</i> + </h3> + x.__init__(...) initializes x; see x.__class__.__doc__ for + signature + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__delattr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__delattr__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__delattr__('name') <==> del x.name + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__getattribute__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__getattribute__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__getattribute__('name') <==> x.name + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__hash__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__hash__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Hashing function)</i> + </h3> + x.__hash__() <==> hash(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +hash(x) +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__new__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__new__</span>(<span class=sig-arg>T</span>, + <span class=sig-arg>S</span>, + <span class="sig-vararg">...</span>)</span> + </h3> + T.__new__(S, ...) -> a new object with type S, a subtype of T + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +a new object with type S, a subtype of T +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__reduce__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__reduce__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + helper for pickle + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__reduce_ex__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__reduce_ex__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + helper for pickle + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + x.__repr__() <==> repr(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +repr(x) +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__setattr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__setattr__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__setattr__('name', value) <==> x.name = value + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + x.__str__() <==> str(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +str(x) +</pre> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/__builtin__.type-class.html b/docs/private/__builtin__.type-class.html new file mode 100644 index 0000000..0f1957a --- /dev/null +++ b/docs/private/__builtin__.type-class.html @@ -0,0 +1,504 @@ +<?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>__builtin__.type</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Module __builtin__ :: + Class type + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/__builtin__.type-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="__builtin__.type-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type type</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>type</b> +</pre><br /> + +<hr/> + +type(object) -> the object's type type(name, bases, dict) -> a +new type +<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="__builtin__.type-class.html#__call__" class="summary-sig-name"><code>__call__</code></a>(<span class=summary-sig-arg>x</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__call__(...) <==> x(...)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__cmp__" class="summary-sig-name"><code>__cmp__</code></a>(<span class=summary-sig-arg>x</span>, + <span class=summary-sig-arg>y</span>)</span></code> +<br /> +x.__cmp__(y) <==> cmp(x,y)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1">list of immediate subclasses</font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__subclasses__" class="summary-sig-name"><code>__subclasses__</code></a>()</span></code> +<br /> +__subclasses__() -> list of immediate subclasses</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1">list</font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#mro" class="summary-sig-name"><code>mro</code></a>()</span></code> +<br /> +return a type's method resolution order</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__init__(...) initializes x; see x.__class__.__doc__ for +signature</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>type</code></font></td> + <td><a name="__base__"></a><b><code>__base__</code></b> = <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="__builtin__.type-class.html#__bases__"><code>__bases__</code></a></b> = <span title="(<type 'object'>,)"><code>(<type 'object'>,) </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="__builtin__.type-class.html#__basicsize__"><code>__basicsize__</code></a></b> = <span title="420">420 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="__builtin__.type-class.html#__dictoffset__"><code>__dictoffset__</code></a></b> = <span title="132">132 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="__builtin__.type-class.html#__flags__"><code>__flags__</code></a></b> = <span title="21995">21995 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="__builtin__.type-class.html#__itemsize__"><code>__itemsize__</code></a></b> = <span title="20">20 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="__builtin__.type-class.html#__mro__"><code>__mro__</code></a></b> = <span title="(<type 'type'>, <type 'object'>)"><code>(<type 'type'>, <type 'object'>) </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td> +<td><b><a href="__builtin__.type-class.html#__name__"><code>__name__</code></a></b> = <span title="'type'"><code><span class="variable-quote">'</span>type<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="__builtin__.type-class.html#__weakrefoffset__"><code>__weakrefoffset__</code></a></b> = <span title="184">184 </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="__call__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__call__</span>(<span class=sig-arg>x</span>, + <span class="sig-vararg">...</span>)</span> + <br /><i>(Call operator)</i> + </h3> + x.__call__(...) <==> x(...) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +x(...) +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__cmp__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__cmp__</span>(<span class=sig-arg>x</span>, + <span class=sig-arg>y</span>)</span> + <br /><i>(Comparison operator)</i> + </h3> + x.__cmp__(y) <==> cmp(x,y) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +cmp(x,y) +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__delattr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__delattr__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__delattr__('name') <==> del x.name + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__delattr__"><code>__builtin__.object.__delattr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__getattribute__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__getattribute__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__getattribute__('name') <==> x.name + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__getattribute__"><code>__builtin__.object.__getattribute__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__hash__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__hash__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Hashing function)</i> + </h3> + x.__hash__() <==> hash(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +hash(x) +</pre> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__hash__"><code>__builtin__.object.__hash__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__new__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__new__</span>(<span class=sig-arg>T</span>, + <span class=sig-arg>S</span>, + <span class="sig-vararg">...</span>)</span> + </h3> + T.__new__(S, ...) -> a new object with type S, a subtype of T + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +a new object with type S, a subtype of T +</pre> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__new__"><code>__builtin__.object.__new__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + x.__repr__() <==> repr(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +repr(x) +</pre> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__setattr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__setattr__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__setattr__('name', value) <==> x.name = value + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__setattr__"><code>__builtin__.object.__setattr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__subclasses__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__subclasses__</span>()</span> + </h3> + __subclasses__() -> list of immediate subclasses + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +list of immediate subclasses </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="mro"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">mro</span>()</span> + </h3> + return a type's method resolution order + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +list </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="__bases__"></a> +<h3>__bases__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</code> + + </dd> +<span title="(<type 'object'>,)"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +(<type 'object'>,) </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__basicsize__"></a> +<h3>__basicsize__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="420"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +420 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__dictoffset__"></a> +<h3>__dictoffset__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="132"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +132 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__flags__"></a> +<h3>__flags__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="21995"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +21995 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__itemsize__"></a> +<h3>__itemsize__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="20"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +20 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__mro__"></a> +<h3>__mro__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</code> + + </dd> +<span title="(<type 'type'>, <type 'object'>)"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +(<type 'type'>, <type 'object'>) </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__name__"></a> +<h3>__name__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'type'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>type<span class="variable-quote">'</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__weakrefoffset__"></a> +<h3>__weakrefoffset__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="184"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +184 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/epydoc.css b/docs/private/epydoc.css new file mode 100644 index 0000000..46080bd --- /dev/null +++ b/docs/private/epydoc.css @@ -0,0 +1,100 @@ + +/* Body color */ +body { background: #ffffff; color: #000000; } + +/* Tables */ +table.summary, table.details, table.index + { background: #e8f0f8; color: #000000; } +tr.summary, tr.details, tr.index + { background: #70b0f0; color: #000000; + text-align: left; font-size: 120%; } +tr.group { background: #c0e0f8; color: #000000; + text-align: left; font-size: 120%; + font-style: italic; } + +/* Documentation page titles */ +h2.module { margin-top: 0.2em; } +h2.class { margin-top: 0.2em; } + +/* Headings */ +h1.heading { font-size: +140%; font-style: italic; + font-weight: bold; } +h2.heading { font-size: +125%; font-style: italic; + font-weight: bold; } +h3.heading { font-size: +110%; font-style: italic; + font-weight: normal; } + +/* Base tree */ +pre.base-tree { font-size: 80%; margin: 0; } + +/* Details Sections */ +table.func-details { background: #e8f0f8; color: #000000; + border: 2px groove #c0d0d0; + padding: 0 1em 0 1em; margin: 0.4em 0 0 0; } +h3.func-detail { background: transparent; color: #000000; + margin: 0 0 1em 0; } + +table.var-details { background: #e8f0f8; color: #000000; + border: 2px groove #c0d0d0; + padding: 0 1em 0 1em; margin: 0.4em 0 0 0; } +h3.var-details { background: transparent; color: #000000; + margin: 0 0 1em 0; } + +/* Function signatures */ +.sig { background: transparent; color: #000000; + font-weight: bold; } +.sig-name { background: transparent; color: #006080; } +.sig-arg, .sig-kwarg, .sig-vararg + { background: transparent; color: #008060; } +.sig-default { background: transparent; color: #602000; } +.summary-sig { background: transparent; color: #000000; } +.summary-sig-name { background: transparent; color: #204080; } +.summary-sig-arg, .summary-sig-kwarg, .summary-sig-vararg + { background: transparent; color: #008060; } + +/* Doctest blocks */ +.py-src { background: transparent; color: #000000; } +.py-prompt { background: transparent; color: #005050; + font-weight: bold;} +.py-string { background: transparent; color: #006030; } +.py-comment { background: transparent; color: #003060; } +.py-keyword { background: transparent; color: #600000; } +.py-output { background: transparent; color: #404040; } +pre.doctestblock { background: #f4faff; color: #000000; + padding: .5em; margin: 1em; + border: 1px solid #708890; } +table pre.doctestblock + { background: #dce4ec; color: #000000; + padding: .5em; margin: 1em; + border: 1px solid #708890; } + +/* Variable values */ +pre.variable { background: #dce4ec; color: #000000; + padding: .5em; margin: 0; + border: 1px solid #708890; } +.variable-linewrap { background: transparent; color: #604000; } +.variable-ellipsis { background: transparent; color: #604000; } +.variable-quote { background: transparent; color: #604000; } +.re { background: transparent; color: #000000; } +.re-char { background: transparent; color: #006030; } +.re-op { background: transparent; color: #600000; } +.re-group { background: transparent; color: #003060; } +.re-ref { background: transparent; color: #404040; } + +/* Navigation bar */ +table.navbar { background: #a0c0ff; color: #0000ff; + border: 2px groove #c0d0d0; } +th.navbar { background: #a0c0ff; color: #0000ff; } +th.navselect { background: #70b0ff; color: #000000; } +.nomargin { margin: 0; } + +/* Links */ +a:link { background: transparent; color: #0000ff; } +a:visited { background: transparent; color: #204080; } +a.navbar:link { background: transparent; color: #0000ff; + text-decoration: none; } +a.navbar:visited { background: transparent; color: #204080; + text-decoration: none; } + +/* Lists */ +ul { margin-top: 0; } diff --git a/docs/private/exceptions.Exception-class.html b/docs/private/exceptions.Exception-class.html new file mode 100644 index 0000000..4b99d99 --- /dev/null +++ b/docs/private/exceptions.Exception-class.html @@ -0,0 +1,87 @@ +<?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>exceptions.Exception</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Module exceptions :: + Class Exception + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/exceptions.Exception-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="exceptions.Exception-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class Exception</h2> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SFTPError-class.html"><code>SFTPError</code></a>, + <a href="paramiko.SSHException-class.html"><code>SSHException</code></a>, + <a href="../private/paramiko.ber.BERException-class.html"><code>BERException</code></a>, + <a href="../private/paramiko.packet.NeedRekeyException-class.html"><code>NeedRekeyException</code></a></dd></dl> + +<hr/> + +Common base class for all exceptions. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class="summary-sig-vararg">...</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__getitem__"></a><span class="summary-sig"><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-vararg">...</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/frames.html b/docs/private/frames.html new file mode 100644 index 0000000..77678a0 --- /dev/null +++ b/docs/private/frames.html @@ -0,0 +1,13 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"> +<html> +<head> + <title> API Documentation </title> +</head> +<frameset cols="20%,80%"> + <frameset rows="30%,70%"> + <frame src="toc.html" name="moduleListFrame"> + <frame src="toc-everything.html" name="moduleFrame"> + </frameset> + <frame src="paramiko-module.html" name="mainFrame"> +</frameset> +</html> diff --git a/docs/private/help.html b/docs/private/help.html new file mode 100644 index 0000000..5aab6d0 --- /dev/null +++ b/docs/private/help.html @@ -0,0 +1,224 @@ +<?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>Help</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="paramiko-module.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 bgcolor="#70b0f0" class="navselect"> Help </th> + <th class="navbar" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/help.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="help.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<center><h2> API Documentation </h2></center> + +<p> This document contains the API (Application Programming Interface) +documentation for this project. Documentation for the Python +objects defined by the project is divided into separate pages for each +package, module, and class. The API documentation also includes two +pages containing information about the project as a whole: a trees +page, and an index page. </p> + +<h2> Object Documentation </h2> + + <p>Each <b>Package Documentation</b> page contains: + <ul> + <li> A description of the package. </li> + <li> A list of the modules and sub-packages contained by the + package. </li> + <li> A summary of the classes defined by the package. </li> + <li> A summary of the functions defined by the package. </li> + <li> A summary of the variables defined by the package. </li> + <li> A detailed description of each function defined by the + package. </li> + <li> A detailed description of each variable defined by the + package. </li> + </ul></p> + + <p>Each <b>Module Documentation</b> page contains: + <ul> + <li> A description of the module. </li> + <li> A summary of the classes defined by the module. </li> + <li> A summary of the functions defined by the module. </li> + <li> A summary of the variables defined by the module. </li> + <li> A detailed description of each function defined by the + module. </li> + <li> A detailed description of each variable defined by the + module. </li> + </ul></p> + + <p>Each <b>Class Documentation</b> page contains: + <ul> + <li> A class inheritance diagram. </li> + <li> A list of known subclasses. </li> + <li> A description of the class. </li> + <li> A summary of the methods defined by the class. </li> + <li> A summary of the instance variables defined by the class. </li> + <li> A summary of the class (static) variables defined by the + class. </li> + <li> A detailed description of each method defined by the + class. </li> + <li> A detailed description of each instance variable defined by the + class. </li> + <li> A detailed description of each class (static) variable defined + by the class. </li> + </ul></p> + +<h2> Project Documentation </h2> + + <p> The <b>Trees</b> page contains the module and class hierarchies: + <ul> + <li> The <i>module hierarchy</i> lists every package and module, with + modules grouped into packages. At the top level, and within each + package, modules and sub-packages are listed alphabetically. </li> + <li> The <i>class hierarchy</i> lists every class, grouped by base + class. If a class has more than one base class, then it will be + listed under each base class. At the top level, and under each base + class, classes are listed alphabetically. </li> + </ul></p> + + <p> The <b>Index</b> page contains indices of terms and + identifiers: + <ul> + <li> The <i>term index</i> lists every term indexed by any object's + documentation. For each term, the index provides links to each + place where the term is indexed. </li> + <li> The <i>identifier index</i> lists the (short) name of every package, + module, class, method, function, variable, and parameter. For each + identifier, the index provides a short description, and a link to + its documentation. </li> + </ul></p> + +<h2> The Table of Contents </h2> + +<p> The table of contents occupies the two frames on the left side of +the window. The upper-left frame displays the <i>project +contents</i>, and the lower-left frame displays the <i>module +contents</i>: </p> + +<center> +<table class="summary" border="1" cellspacing="0" cellpadding="3"> + <tr heigh="30%"> + <td align="center"> + <font size="-1">Project<br>Contents<hr>...</font></td> + <td align="center" rowspan="2" width="70%"> + API<br>Documentation<br>Frame<br><br><br> + </td> + </tr> + <tr> + <td align="center"> + <font size="-1">Module<br>Contents<hr> <br>...<br> </font> + </td> + </tr> +</table><br> +</center> + +<p> The <b>project contents frame</b> contains a list of all packages +and modules that are defined by the project. Clicking on an entry +will display its contents in the module contents frame. Clicking on a +special entry, labeled "Everything," will display the contents of +the entire project. </p> + +<p> The <b>module contents frame</b> contains a list of every +submodule, class, type, exception, function, and variable defined by a +module or package. Clicking on an entry will display its +documentation in the API documentation frame. Clicking on the name of +the module, at the top of the frame, will display the documentation +for the module itself. </p> + +<p> The "<b>frames</b>" and "<b>no frames</b>" buttons below the top +navigation bar can be used to control whether the table of contents is +displayed or not. </p> + +<h2> The Navigation Bar </h2> + +<p> A navigation bar is located at the top and bottom of every page. +It indicates what type of page you are currently viewing, and allows +you to go to related pages. The following table describes the labels +on the navigation bar. Note that not some labels (such as +[Parent]) are not displayed on all pages. </p> + +<table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%"> +<tr class="summary"> + <th>Label</th> + <th>Highlighted when...</th> + <th>Links to...</th> +</tr> + <tr><td valign="top"><b>[Parent]</b></td> + <td valign="top"><i>(never highlighted)</i></td> + <td valign="top"> the parent of the current package </td></tr> + <tr><td valign="top"><b>[Package]</b></td> + <td valign="top">viewing a package</td> + <td valign="top">the package containing the current object + </td></tr> + <tr><td valign="top"><b>[Module]</b></td> + <td valign="top">viewing a module</td> + <td valign="top">the module containing the current object + </td></tr> + <tr><td valign="top"><b>[Class]</b></td> + <td valign="top">viewing a class </td> + <td valign="top">the class containing the current object</td></tr> + <tr><td valign="top"><b>[Trees]</b></td> + <td valign="top">viewing the trees page</td> + <td valign="top"> the trees page </td></tr> + <tr><td valign="top"><b>[Index]</b></td> + <td valign="top">viewing the index page</td> + <td valign="top"> the index page </td></tr> + <tr><td valign="top"><b>[Help]</b></td> + <td valign="top">viewing the help page</td> + <td valign="top"> the help page </td></tr> +</table> + +<p> The "<b>show private</b>" and "<b>hide private</b>" buttons below +the top navigation bar can be used to control whether documentation +for private objects is displayed. Private objects are usually defined +as objects whose (short) names begin with a single underscore, but do +not end with an underscore. For example, "<code>_x</code>", +"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>" +are private objects; but "<code>re.sub</code>", +"<code>__init__</code>", and "<code>type_</code>" are not. However, +if a module defines the "<code>__all__</code>" variable, then its +contents are used to decide which objects are private. </p> + +<p> A timestamp below the bottom navigation bar indicates when each +page was last updated. </p> + +<!-- =========== 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="paramiko-module.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 bgcolor="#70b0f0" class="navselect"> Help </th> + <th class="navbar" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/index.html b/docs/private/index.html new file mode 100644 index 0000000..77678a0 --- /dev/null +++ b/docs/private/index.html @@ -0,0 +1,13 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"> +<html> +<head> + <title> API Documentation </title> +</head> +<frameset cols="20%,80%"> + <frameset rows="30%,70%"> + <frame src="toc.html" name="moduleListFrame"> + <frame src="toc-everything.html" name="moduleFrame"> + </frameset> + <frame src="paramiko-module.html" name="mainFrame"> +</frameset> +</html> diff --git a/docs/private/indices.html b/docs/private/indices.html new file mode 100644 index 0000000..752a39a --- /dev/null +++ b/docs/private/indices.html @@ -0,0 +1,1635 @@ +<?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>Index</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="paramiko-module.html">Home</a> </th> + <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> + <th bgcolor="#70b0f0" class="navselect"> Index </th> + <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th> + <th class="navbar" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/indices.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="indices.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> +<br /> + +<!-- =========== START OF IDENTIFIER INDEX =========== --> +<table class="index" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="index"> + <th colspan="2">Identifier Index</th></tr> + <tr><td width="15%"><a href="../private/paramiko-module.html#__author__"><code>__author__</code></a></td> + <td>Variable in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html"><code>object</code></a></td> + <td>Class in module <code>__builtin__</code></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__bases__"><code>__bases__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__basicsize__"><code>__basicsize__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading.Thread-class.html#__bootstrap"><code>__bootstrap</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__call__"><code>__call__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.compress.ZlibCompressor-class.html#__call__"><code>__call__</code></a></td> + <td>Method in class <a href="../private/paramiko.compress.ZlibCompressor-class.html"><code>paramiko.compress.ZlibCompressor</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.compress.ZlibDecompressor-class.html#__call__"><code>__call__</code></a></td> + <td>Method in class <a href="../private/paramiko.compress.ZlibDecompressor-class.html"><code>paramiko.compress.ZlibDecompressor</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html"><code>type</code></a></td> + <td>Class in module <code>__builtin__</code></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__cmp__"><code>__cmp__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#__cmp__"><code>__cmp__</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko-module.html#__date__"><code>__date__</code></a></td> + <td>Variable in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__delattr__"><code>__delattr__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading.Thread-class.html#__delete"><code>__delete</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__dictoffset__"><code>__dictoffset__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__flags__"><code>__flags__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__getattribute__"><code>__getattribute__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="exceptions.Exception-class.html#__getitem__"><code>__getitem__</code></a></td> + <td>Method in class <a href="exceptions.Exception-class.html"><code>exceptions.Exception</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__hash__"><code>__hash__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#__hash__"><code>__hash__</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#__hash__"><code>__hash__</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="exceptions.Exception-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="exceptions.Exception-class.html"><code>exceptions.Exception</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Agent-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.AgentKey-class.html"><code>paramiko.AgentKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BadAuthenticationType-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.BadAuthenticationType-class.html"><code>paramiko.BadAuthenticationType</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BaseSFTP-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.BaseSFTP-class.html"><code>paramiko.BaseSFTP</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ChannelFile-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.ChannelFile-class.html"><code>paramiko.ChannelFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.channel.ChannelStderrFile-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.channel.ChannelStderrFile-class.html"><code>paramiko.channel.ChannelStderrFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.compress.ZlibCompressor-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.compress.ZlibCompressor-class.html"><code>paramiko.compress.ZlibCompressor</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.compress.ZlibDecompressor-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.compress.ZlibDecompressor-class.html"><code>paramiko.compress.ZlibDecompressor</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1.KexGroup1-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>paramiko.kex_group1.KexGroup1</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.Formatter-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.logging22.Formatter-class.html"><code>paramiko.logging22.Formatter</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.StreamHandler-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.logging22.StreamHandler-class.html"><code>paramiko.logging22.StreamHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.logger-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.logging22.logger-class.html"><code>paramiko.logging22.logger</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.PosixPipe-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.PosixPipe-class.html"><code>paramiko.pipe.PosixPipe</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.WindowsPipe-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>paramiko.pipe.WindowsPipe</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.primes.ModulusPack-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.primes.ModulusPack-class.html"><code>paramiko.primes.ModulusPack</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.server.InteractiveQuery-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.server.InteractiveQuery-class.html"><code>paramiko.server.InteractiveQuery</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html"><code>paramiko.ssh_exception.PartialAuthentication</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading._Verbose-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="../private/threading._Verbose-class.html"><code>threading._Verbose</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__itemsize__"><code>__itemsize__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#__iter__"><code>__iter__</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko-module.html#__license__"><code>__license__</code></a></td> + <td>Variable in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__mro__"><code>__mro__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__name__"><code>__name__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__new__"><code>__new__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__new__"><code>__new__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ChannelFile-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="../private/paramiko.ChannelFile-class.html"><code>paramiko.ChannelFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__setattr__"><code>__setattr__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#__slots__"><code>__slots__</code></a></td> + <td>Variable in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading.Thread-class.html#__stop"><code>__stop</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="exceptions.Exception-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="exceptions.Exception-class.html"><code>exceptions.Exception</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.AgentKey-class.html"><code>paramiko.AgentKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BadAuthenticationType-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.BadAuthenticationType-class.html"><code>paramiko.BadAuthenticationType</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__subclasses__"><code>__subclasses__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko-module.html#__version__"><code>__version__</code></a></td> + <td>Variable in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko-module.html#__version_info__"><code>__version_info__</code></a></td> + <td>Variable in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__weakrefoffset__"><code>__weakrefoffset__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_activate_inbound"><code>_activate_inbound</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_activate_outbound"><code>_activate_outbound</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.transport-module.html#_active_threads"><code>_active_threads</code></a></td> + <td>Variable in module <a href="paramiko.transport-module.html"><code>paramiko.transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Message-class.html#_add"><code>_add</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPClient-class.html#_adjust_cwd"><code>_adjust_cwd</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPClient-class.html#_async_request"><code>_async_request</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPFile-class.html#_async_response"><code>_async_response</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_auth_trigger"><code>_auth_trigger</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#_build_packet"><code>_build_packet</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_channel_handler_table"><code>_channel_handler_table</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_check_add_window"><code>_check_add_window</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_check_banner"><code>_check_banner</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPFile-class.html#_check_exception"><code>_check_exception</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServer-class.html#_check_file"><code>_check_file</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#_check_keepalive"><code>_check_keepalive</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_cipher_info"><code>_cipher_info</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#_CIPHER_TABLE"><code>_CIPHER_TABLE</code></a></td> + <td>Variable in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#_CIPHER_TABLE"><code>_CIPHER_TABLE</code></a></td> + <td>Variable in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#_CIPHER_TABLE"><code>_CIPHER_TABLE</code></a></td> + <td>Variable in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#_CIPHER_TABLE"><code>_CIPHER_TABLE</code></a></td> + <td>Variable in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_CLIENT_ID"><code>_CLIENT_ID</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_close_internal"><code>_close_internal</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_compression_info"><code>_compression_info</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_compute_key"><code>_compute_key</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServer-class.html#_convert_pflags"><code>_convert_pflags</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPClient-class.html#_convert_status"><code>_convert_status</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPAttributes-class.html#_debug_str"><code>_debug_str</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_DEFAULT_BUFSIZE"><code>_DEFAULT_BUFSIZE</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_DEFAULT_BUFSIZE"><code>_DEFAULT_BUFSIZE</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_DEFAULT_BUFSIZE"><code>_DEFAULT_BUFSIZE</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_DEFAULT_BUFSIZE"><code>_DEFAULT_BUFSIZE</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_disconnect_no_more_auth"><code>_disconnect_no_more_auth</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_disconnect_service_not_available"><code>_disconnect_service_not_available</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_expect_packet"><code>_expect_packet</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_feed"><code>_feed</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_feed_extended"><code>_feed_extended</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPClient-class.html#_finish_responses"><code>_finish_responses</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.file-module.html#_FLAG_APPEND"><code>_FLAG_APPEND</code></a></td> + <td>Variable in module <a href="paramiko.file-module.html"><code>paramiko.file</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.file-module.html#_FLAG_BINARY"><code>_FLAG_BINARY</code></a></td> + <td>Variable in module <a href="paramiko.file-module.html"><code>paramiko.file</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.file-module.html#_FLAG_BUFFERED"><code>_FLAG_BUFFERED</code></a></td> + <td>Variable in module <a href="paramiko.file-module.html"><code>paramiko.file</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.file-module.html#_FLAG_LINE_BUFFERED"><code>_FLAG_LINE_BUFFERED</code></a></td> + <td>Variable in module <a href="paramiko.file-module.html"><code>paramiko.file</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.file-module.html#_FLAG_READ"><code>_FLAG_READ</code></a></td> + <td>Variable in module <a href="paramiko.file-module.html"><code>paramiko.file</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.file-module.html#_FLAG_UNIVERSAL_NEWLINE"><code>_FLAG_UNIVERSAL_NEWLINE</code></a></td> + <td>Variable in module <a href="paramiko.file-module.html"><code>paramiko.file</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.file-module.html#_FLAG_WRITE"><code>_FLAG_WRITE</code></a></td> + <td>Variable in module <a href="paramiko.file-module.html"><code>paramiko.file</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPAttributes-class.html#_from_msg"><code>_from_msg</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.DSSKey-class.html#_from_private_key_file"><code>_from_private_key_file</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.RSAKey-class.html#_from_private_key_file"><code>_from_private_key_file</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.util-module.html#_g_thread_counter"><code>_g_thread_counter</code></a></td> + <td>Variable in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.util-module.html#_g_thread_ids"><code>_g_thread_ids</code></a></td> + <td>Variable in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.util-module.html#_g_thread_lock"><code>_g_thread_lock</code></a></td> + <td>Variable in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.primes-module.html#_generate_prime"><code>_generate_prime</code></a></td> + <td>Function in module <a href="../private/paramiko.primes-module.html"><code>paramiko.primes</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#_generate_x"><code>_generate_x</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1.KexGroup1-class.html#_generate_x"><code>_generate_x</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>paramiko.kex_group1.KexGroup1</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_get_cipher"><code>_get_cipher</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_get_ciphers"><code>_get_ciphers</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_get_compression"><code>_get_compression</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_get_digests"><code>_get_digests</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_get_kex"><code>_get_kex</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_get_key_types"><code>_get_key_types</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_get_modulus_pack"><code>_get_modulus_pack</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPHandle-class.html#_get_name"><code>_get_name</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPHandle-class.html#_get_next_files"><code>_get_next_files</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_get_session_blob"><code>_get_session_blob</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_get_size"><code>_get_size</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPFile-class.html#_get_size"><code>_get_size</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_get_subsystem_handler"><code>_get_subsystem_handler</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_handle_close"><code>_handle_close</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_handle_eof"><code>_handle_eof</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_handle_request"><code>_handle_request</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_handler_table"><code>_handler_table</code></a></td> + <td>Variable in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_handler_table"><code>_handler_table</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.sftp_server-module.html#_hash_class"><code>_hash_class</code></a></td> + <td>Variable in module <a href="paramiko.sftp_server-module.html"><code>paramiko.sftp_server</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_interactive_query"><code>_interactive_query</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.transport-module.html#_join_lingering_threads"><code>_join_lingering_threads</code></a></td> + <td>Function in module <a href="paramiko.transport-module.html"><code>paramiko.transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_kex_info"><code>_kex_info</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_key_info"><code>_key_info</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BaseSFTP-class.html#_log"><code>_log</code></a></td> + <td>Method in class <a href="../private/paramiko.BaseSFTP-class.html"><code>paramiko.BaseSFTP</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_log"><code>_log</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#_log"><code>_log</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_log"><code>_log</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22-module.html#_logger"><code>_logger</code></a></td> + <td>Variable in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_mac_info"><code>_mac_info</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_modulus_pack"><code>_modulus_pack</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_GROUP"><code>_MSG_KEXDH_GEX_GROUP</code></a></td> + <td>Variable in module <a href="../private/paramiko.kex_gex-module.html"><code>paramiko.kex_gex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_INIT"><code>_MSG_KEXDH_GEX_INIT</code></a></td> + <td>Variable in module <a href="../private/paramiko.kex_gex-module.html"><code>paramiko.kex_gex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_REPLY"><code>_MSG_KEXDH_GEX_REPLY</code></a></td> + <td>Variable in module <a href="../private/paramiko.kex_gex-module.html"><code>paramiko.kex_gex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_REQUEST"><code>_MSG_KEXDH_GEX_REQUEST</code></a></td> + <td>Variable in module <a href="../private/paramiko.kex_gex-module.html"><code>paramiko.kex_gex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1-module.html#_MSG_KEXDH_INIT"><code>_MSG_KEXDH_INIT</code></a></td> + <td>Variable in module <a href="../private/paramiko.kex_group1-module.html"><code>paramiko.kex_group1</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1-module.html#_MSG_KEXDH_REPLY"><code>_MSG_KEXDH_REPLY</code></a></td> + <td>Variable in module <a href="../private/paramiko.kex_group1-module.html"><code>paramiko.kex_group1</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_negotiate_keys"><code>_negotiate_keys</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading._Verbose-class.html#_note"><code>_note</code></a></td> + <td>Method in class <a href="../private/threading._Verbose-class.html"><code>threading._Verbose</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServer-class.html#_open_folder"><code>_open_folder</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPAttributes-class.html#_pack"><code>_pack</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_channel_open"><code>_parse_channel_open</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_channel_open_failure"><code>_parse_channel_open_failure</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_channel_open_success"><code>_parse_channel_open_success</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_debug"><code>_parse_debug</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_disconnect"><code>_parse_disconnect</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_global_request"><code>_parse_global_request</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_kex_init"><code>_parse_kex_init</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#_parse_kexdh_gex_group"><code>_parse_kexdh_gex_group</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#_parse_kexdh_gex_init"><code>_parse_kexdh_gex_init</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#_parse_kexdh_gex_reply"><code>_parse_kexdh_gex_reply</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#_parse_kexdh_gex_request"><code>_parse_kexdh_gex_request</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1.KexGroup1-class.html#_parse_kexdh_init"><code>_parse_kexdh_init</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>paramiko.kex_group1.KexGroup1</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1.KexGroup1-class.html#_parse_kexdh_reply"><code>_parse_kexdh_reply</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>paramiko.kex_group1.KexGroup1</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.primes.ModulusPack-class.html#_parse_modulus"><code>_parse_modulus</code></a></td> + <td>Method in class <a href="../private/paramiko.primes.ModulusPack-class.html"><code>paramiko.primes.ModulusPack</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_newkeys"><code>_parse_newkeys</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_request_failure"><code>_parse_request_failure</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_parse_request_success"><code>_parse_request_success</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_parse_service_accept"><code>_parse_service_accept</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_parse_service_request"><code>_parse_service_request</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_parse_userauth_banner"><code>_parse_userauth_banner</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_parse_userauth_failure"><code>_parse_userauth_failure</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_parse_userauth_info_request"><code>_parse_userauth_info_request</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_parse_userauth_info_response"><code>_parse_userauth_info_response</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_parse_userauth_request"><code>_parse_userauth_request</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_parse_userauth_success"><code>_parse_userauth_success</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.util-module.html#_pfilter"><code>_pfilter</code></a></td> + <td>Variable in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.RSAKey-class.html#_pkcs1imify"><code>_pkcs1imify</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_preferred_ciphers"><code>_preferred_ciphers</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_preferred_compression"><code>_preferred_compression</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_preferred_kex"><code>_preferred_kex</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_preferred_keys"><code>_preferred_keys</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_preferred_macs"><code>_preferred_macs</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPFile-class.html#_prefetch"><code>_prefetch</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServer-class.html#_process"><code>_process</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_PROTO_ID"><code>_PROTO_ID</code></a></td> + <td>Variable in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#_py22_read_all"><code>_py22_read_all</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#_py22_read_timeout"><code>_py22_read_timeout</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_read"><code>_read</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ChannelFile-class.html#_read"><code>_read</code></a></td> + <td>Method in class <a href="../private/paramiko.ChannelFile-class.html"><code>paramiko.ChannelFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPFile-class.html#_read"><code>_read</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.channel.ChannelStderrFile-class.html#_read"><code>_read</code></a></td> + <td>Method in class <a href="../private/paramiko.channel.ChannelStderrFile-class.html"><code>paramiko.channel.ChannelStderrFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Agent-class.html#_read_all"><code>_read_all</code></a></td> + <td>Method in class <a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BaseSFTP-class.html#_read_all"><code>_read_all</code></a></td> + <td>Method in class <a href="../private/paramiko.BaseSFTP-class.html"><code>paramiko.BaseSFTP</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServer-class.html#_read_folder"><code>_read_folder</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BaseSFTP-class.html#_read_packet"><code>_read_packet</code></a></td> + <td>Method in class <a href="../private/paramiko.BaseSFTP-class.html"><code>paramiko.BaseSFTP</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPFile-class.html#_read_prefetch"><code>_read_prefetch</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#_read_private_key_file"><code>_read_private_key_file</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPClient-class.html#_read_response"><code>_read_response</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#_read_timeout"><code>_read_timeout</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_record_newline"><code>_record_newline</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPClient-class.html#_request"><code>_request</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_request_auth"><code>_request_auth</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_request_failed"><code>_request_failed</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_request_success"><code>_request_success</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServer-class.html#_response"><code>_response</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.primes-module.html#_roll_random"><code>_roll_random</code></a></td> + <td>Function in module <a href="../private/paramiko.primes-module.html"><code>paramiko.primes</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SubsystemHandler-class.html#_run"><code>_run</code></a></td> + <td>Method in class <a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPAttributes-class.html#_rwx"><code>_rwx</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#_send_auth_result"><code>_send_auth_result</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_send_eof"><code>_send_eof</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServer-class.html#_send_handle_response"><code>_send_handle_response</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_send_kex_init"><code>_send_kex_init</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Agent-class.html#_send_message"><code>_send_message</code></a></td> + <td>Method in class <a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_send_message"><code>_send_message</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BaseSFTP-class.html#_send_packet"><code>_send_packet</code></a></td> + <td>Method in class <a href="../private/paramiko.BaseSFTP-class.html"><code>paramiko.BaseSFTP</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BaseSFTP-class.html#_send_server_version"><code>_send_server_version</code></a></td> + <td>Method in class <a href="../private/paramiko.BaseSFTP-class.html"><code>paramiko.BaseSFTP</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServer-class.html#_send_status"><code>_send_status</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_send_user_message"><code>_send_user_message</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BaseSFTP-class.html#_send_version"><code>_send_version</code></a></td> + <td>Method in class <a href="../private/paramiko.BaseSFTP-class.html"><code>paramiko.BaseSFTP</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_set"><code>_set</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_set_ciphers"><code>_set_ciphers</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_set_closed"><code>_set_closed</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_set_compression"><code>_set_compression</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading.Thread-class.html#_set_daemon"><code>_set_daemon</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_set_digests"><code>_set_digests</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPHandle-class.html#_set_files"><code>_set_files</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_set_K_H"><code>_set_K_H</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_set_kex"><code>_set_kex</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_set_key_types"><code>_set_key_types</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_set_mode"><code>_set_mode</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPHandle-class.html#_set_name"><code>_set_name</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_set_remote_channel"><code>_set_remote_channel</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_set_transport"><code>_set_transport</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_set_window"><code>_set_window</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading.Thread-class.html#__initialized"><code>__initialized</code></a></td> + <td>Variable in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading.Thread-class.html#__initialized"><code>__initialized</code></a></td> + <td>Variable in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading.Thread-class.html#__initialized"><code>__initialized</code></a></td> + <td>Variable in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading.Thread-class.html#__initialized"><code>__initialized</code></a></td> + <td>Variable in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.sftp_client-module.html#_to_unicode"><code>_to_unicode</code></a></td> + <td>Function in module <a href="paramiko.sftp_client-module.html"><code>paramiko.sftp_client</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SecurityOptions-class.html#_transport"><code>_transport</code></a></td> + <td>Variable in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#_trigger_rekey"><code>_trigger_rekey</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_unlink"><code>_unlink</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_unlink_channel"><code>_unlink_channel</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPAttributes-class.html#_unpack"><code>_unpack</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a></td> + <td>Class in module <code>threading</code></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Transport-class.html#_verify_key"><code>_verify_key</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.sftp-module.html#_VERSION"><code>_VERSION</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_wait_for_send_window"><code>_wait_for_send_window</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Channel-class.html#_window_adjust"><code>_window_adjust</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_write"><code>_write</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ChannelFile-class.html#_write"><code>_write</code></a></td> + <td>Method in class <a href="../private/paramiko.ChannelFile-class.html"><code>paramiko.ChannelFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPFile-class.html#_write"><code>_write</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.channel.ChannelStderrFile-class.html#_write"><code>_write</code></a></td> + <td>Method in class <a href="../private/paramiko.channel.ChannelStderrFile-class.html"><code>paramiko.channel.ChannelStderrFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BaseSFTP-class.html#_write_all"><code>_write_all</code></a></td> + <td>Method in class <a href="../private/paramiko.BaseSFTP-class.html"><code>paramiko.BaseSFTP</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BufferedFile-class.html#_write_all"><code>_write_all</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#_write_private_key_file"><code>_write_private_key_file</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#abort"><code>abort</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#accept"><code>accept</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add"><code>add</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_boolean"><code>add_boolean</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_byte"><code>add_byte</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_bytes"><code>add_bytes</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_int"><code>add_int</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_int64"><code>add_int64</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_list"><code>add_list</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_mpint"><code>add_mpint</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.server.InteractiveQuery-class.html#add_prompt"><code>add_prompt</code></a></td> + <td>Method in class <a href="paramiko.server.InteractiveQuery-class.html"><code>paramiko.server.InteractiveQuery</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#add_server_key"><code>add_server_key</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_string"><code>add_string</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.logger-class.html#addFilter"><code>addFilter</code></a></td> + <td>Method in class <a href="../private/paramiko.logging22.logger-class.html"><code>paramiko.logging22.logger</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.logger-class.html#addHandler"><code>addHandler</code></a></td> + <td>Method in class <a href="../private/paramiko.logging22.logger-class.html"><code>paramiko.logging22.logger</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Agent-class.html"><code>Agent</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html"><code>agent</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html"><code>AgentKey</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BadAuthenticationType-class.html#allowed_types"><code>allowed_types</code></a></td> + <td>Variable in class <a href="paramiko.BadAuthenticationType-class.html"><code>paramiko.BadAuthenticationType</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html#allowed_types"><code>allowed_types</code></a></td> + <td>Variable in class <a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html"><code>paramiko.ssh_exception.PartialAuthentication</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#AUTH_FAILED"><code>AUTH_FAILED</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.auth_handler-module.html"><code>auth_handler</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#auth_interactive"><code>auth_interactive</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#auth_interactive"><code>auth_interactive</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#auth_none"><code>auth_none</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#auth_none"><code>auth_none</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#AUTH_PARTIALLY_SUCCESSFUL"><code>AUTH_PARTIALLY_SUCCESSFUL</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#auth_password"><code>auth_password</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#auth_password"><code>auth_password</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#auth_publickey"><code>auth_publickey</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#auth_publickey"><code>auth_publickey</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#AUTH_SUCCESSFUL"><code>AUTH_SUCCESSFUL</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html"><code>AuthHandler</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BadAuthenticationType-class.html"><code>BadAuthenticationType</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber-module.html"><code>ber</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html"><code>BER</code></a></td> + <td>Class in module <a href="../private/paramiko.ber-module.html"><code>paramiko.ber</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BERException-class.html"><code>BERException</code></a></td> + <td>Class in module <a href="../private/paramiko.ber-module.html"><code>paramiko.ber</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#bit_length"><code>bit_length</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#can_sign"><code>can_sign</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#can_sign"><code>can_sign</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#can_sign"><code>can_sign</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#canonicalize"><code>canonicalize</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html"><code>Channel</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.channel-module.html"><code>channel</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ChannelFile-class.html"><code>ChannelFile</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.channel.ChannelStderrFile-class.html"><code>ChannelStderrFile</code></a></td> + <td>Class in module <a href="../private/paramiko.channel-module.html"><code>paramiko.channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#chattr"><code>chattr</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#chattr"><code>chattr</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#chdir"><code>chdir</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#check"><code>check</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_auth_interactive"><code>check_auth_interactive</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_auth_interactive_response"><code>check_auth_interactive_response</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_auth_none"><code>check_auth_none</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_auth_password"><code>check_auth_password</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_auth_publickey"><code>check_auth_publickey</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_channel_exec_request"><code>check_channel_exec_request</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_channel_pty_request"><code>check_channel_pty_request</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_channel_request"><code>check_channel_request</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_channel_shell_request"><code>check_channel_shell_request</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_channel_subsystem_request"><code>check_channel_subsystem_request</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_channel_window_change_request"><code>check_channel_window_change_request</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#check_global_request"><code>check_global_request</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#chmod"><code>chmod</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#chown"><code>chown</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#ciphers"><code>ciphers</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.PosixPipe-class.html#clear"><code>clear</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.PosixPipe-class.html"><code>paramiko.pipe.PosixPipe</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.WindowsPipe-class.html#clear"><code>clear</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>paramiko.pipe.WindowsPipe</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Agent-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.PosixPipe-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.PosixPipe-class.html"><code>paramiko.pipe.PosixPipe</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.WindowsPipe-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>paramiko.pipe.WindowsPipe</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_ATTRS"><code>CMD_ATTRS</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_CLOSE"><code>CMD_CLOSE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_DATA"><code>CMD_DATA</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_EXTENDED"><code>CMD_EXTENDED</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_EXTENDED_REPLY"><code>CMD_EXTENDED_REPLY</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_FSETSTAT"><code>CMD_FSETSTAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_FSTAT"><code>CMD_FSTAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_HANDLE"><code>CMD_HANDLE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_INIT"><code>CMD_INIT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_LSTAT"><code>CMD_LSTAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_MKDIR"><code>CMD_MKDIR</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_NAME"><code>CMD_NAME</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_NAMES"><code>CMD_NAMES</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_OPEN"><code>CMD_OPEN</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_OPENDIR"><code>CMD_OPENDIR</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_READ"><code>CMD_READ</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_READDIR"><code>CMD_READDIR</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_READLINK"><code>CMD_READLINK</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_REALPATH"><code>CMD_REALPATH</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_REMOVE"><code>CMD_REMOVE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_RENAME"><code>CMD_RENAME</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_RMDIR"><code>CMD_RMDIR</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_SETSTAT"><code>CMD_SETSTAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_STAT"><code>CMD_STAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_STATUS"><code>CMD_STATUS</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_SYMLINK"><code>CMD_SYMLINK</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_VERSION"><code>CMD_VERSION</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_WRITE"><code>CMD_WRITE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html"><code>common</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.compress-module.html"><code>compress</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#compression"><code>compression</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#connect"><code>connect</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#CONNECTION_FAILED_CODE"><code>CONNECTION_FAILED_CODE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#convert_errno"><code>convert_errno</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#CRITICAL"><code>CRITICAL</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22-module.html#CRITICAL"><code>CRITICAL</code></a></td> + <td>Variable in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#DEBUG"><code>DEBUG</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22-module.html#DEBUG"><code>DEBUG</code></a></td> + <td>Variable in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html#decode"><code>decode</code></a></td> + <td>Method in class <a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html#decode_next"><code>decode_next</code></a></td> + <td>Method in class <a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html#decode_sequence"><code>decode_sequence</code></a></td> + <td>Method in class <a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#deflate_long"><code>deflate_long</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#digests"><code>digests</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#DISCONNECT_AUTH_CANCELLED_BY_USER"><code>DISCONNECT_AUTH_CANCELLED_BY_USER</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE"><code>DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#DISCONNECT_SERVICE_NOT_AVAILABLE"><code>DISCONNECT_SERVICE_NOT_AVAILABLE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html"><code>DSSKey</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.dsskey-module.html"><code>dsskey</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html#encode"><code>encode</code></a></td> + <td>Method in class <a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html#encode_sequence"><code>encode_sequence</code></a></td> + <td>Method in class <a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ber.BER-class.html#encode_tlv"><code>encode_tlv</code></a></td> + <td>Method in class <a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#ERROR"><code>ERROR</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22-module.html#ERROR"><code>ERROR</code></a></td> + <td>Variable in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><code>exc_info</code></td> + <td>Function in module <code>sys</code></td></tr> + <tr><td width="15%"><a href="exceptions.Exception-class.html"><code>Exception</code></a></td> + <td>Class in module <code>exceptions</code></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#exec_command"><code>exec_command</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#file"><code>file</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.file-module.html"><code>file</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#fileno"><code>fileno</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.PosixPipe-class.html#fileno"><code>fileno</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.PosixPipe-class.html"><code>paramiko.pipe.PosixPipe</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.WindowsPipe-class.html#fileno"><code>fileno</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>paramiko.pipe.WindowsPipe</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util.PFilter-class.html#filter"><code>filter</code></a></td> + <td>Method in class <a href="paramiko.util.PFilter-class.html"><code>paramiko.util.PFilter</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#finish_subsystem"><code>finish_subsystem</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html#finish_subsystem"><code>finish_subsystem</code></a></td> + <td>Method in class <a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_AMTIME"><code>FLAG_AMTIME</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_EXTENDED"><code>FLAG_EXTENDED</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_PERMISSIONS"><code>FLAG_PERMISSIONS</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_SIZE"><code>FLAG_SIZE</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_UIDGID"><code>FLAG_UIDGID</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#flush"><code>flush</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#format_binary"><code>format_binary</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#format_binary_line"><code>format_binary_line</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#format_binary_weird"><code>format_binary_weird</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.Formatter-class.html"><code>Formatter</code></a></td> + <td>Class in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#from_private_key_file"><code>from_private_key_file</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#from_stat"><code>from_stat</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#from_transport"><code>from_transport</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1-module.html#G"><code>G</code></a></td> + <td>Variable in module <a href="../private/paramiko.kex_group1-module.html"><code>paramiko.kex_group1</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#generate"><code>generate</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#generate"><code>generate</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#generate_key_bytes"><code>generate_key_bytes</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#get"><code>get</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html#get_allowed_auths"><code>get_allowed_auths</code></a></td> + <td>Method in class <a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#get_base64"><code>get_base64</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#get_bits"><code>get_bits</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#get_bits"><code>get_bits</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#get_bits"><code>get_bits</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_boolean"><code>get_boolean</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_byte"><code>get_byte</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_bytes"><code>get_bytes</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_exception"><code>get_exception</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#get_fingerprint"><code>get_fingerprint</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#get_hexdump"><code>get_hexdump</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_hexdump"><code>get_hexdump</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#get_id"><code>get_id</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_int"><code>get_int</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_int64"><code>get_int64</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Agent-class.html#get_keys"><code>get_keys</code></a></td> + <td>Method in class <a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_list"><code>get_list</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_log_channel"><code>get_log_channel</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#get_logger"><code>get_logger</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#get_mac_size_in"><code>get_mac_size_in</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#get_mac_size_out"><code>get_mac_size_out</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.primes.ModulusPack-class.html#get_modulus"><code>get_modulus</code></a></td> + <td>Method in class <a href="../private/paramiko.primes.ModulusPack-class.html"><code>paramiko.primes.ModulusPack</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_mpint"><code>get_mpint</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html#get_name"><code>get_name</code></a></td> + <td>Method in class <a href="paramiko.AgentKey-class.html"><code>paramiko.AgentKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#get_name"><code>get_name</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#get_name"><code>get_name</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#get_name"><code>get_name</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#get_name"><code>get_name</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#get_pty"><code>get_pty</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_remainder"><code>get_remainder</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_remote_server_key"><code>get_remote_server_key</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_security_options"><code>get_security_options</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html#get_server"><code>get_server</code></a></td> + <td>Method in class <a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_server_key"><code>get_server_key</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_so_far"><code>get_so_far</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_string"><code>get_string</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#get_thread_id"><code>get_thread_id</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#get_transport"><code>get_transport</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#get_username"><code>get_username</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_username"><code>get_username</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#getcwd"><code>getcwd</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22-module.html#getLogger"><code>getLogger</code></a></td> + <td>Function in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#getName"><code>getName</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#gettimeout"><code>gettimeout</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#gettimeout"><code>gettimeout</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#global_request"><code>global_request</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#hexify"><code>hexify</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#inflate_long"><code>inflate_long</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#INFO"><code>INFO</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22-module.html#INFO"><code>INFO</code></a></td> + <td>Variable in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.server.InteractiveQuery-class.html"><code>InteractiveQuery</code></a></td> + <td>Class in module <a href="paramiko.server-module.html"><code>paramiko.server</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#invoke_shell"><code>invoke_shell</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#invoke_subsystem"><code>invoke_subsystem</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#is_active"><code>is_active</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#is_authenticated"><code>is_authenticated</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#is_authenticated"><code>is_authenticated</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#isAlive"><code>isAlive</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#isDaemon"><code>isDaemon</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#join"><code>join</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#kex"><code>kex</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex-module.html"><code>kex_gex</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1-module.html"><code>kex_group1</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html"><code>KexGex</code></a></td> + <td>Class in module <a href="../private/paramiko.kex_gex-module.html"><code>paramiko.kex_gex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>KexGroup1</code></a></td> + <td>Class in module <a href="../private/paramiko.kex_group1-module.html"><code>paramiko.kex_group1</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#key_types"><code>key_types</code></a></td> + <td>Class in module <a href="../private/paramiko.kex_group1-module.html"><code>paramiko.kex_group1</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#list_folder"><code>list_folder</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#listdir"><code>listdir</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#listdir_attr"><code>listdir_attr</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#load_host_keys"><code>load_host_keys</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#load_server_moduli"><code>load_server_moduli</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.logger-class.html#log"><code>log</code></a></td> + <td>Method in class <a href="../private/paramiko.logging22.logger-class.html"><code>paramiko.logging22.logger</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#log_to_file"><code>log_to_file</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.logger-class.html"><code>logger</code></a></td> + <td>Class in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22-module.html"><code>logging22</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#lookup_ssh_host_config"><code>lookup_ssh_host_config</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#lstat"><code>lstat</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#lstat"><code>lstat</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe-module.html#make_pipe"><code>make_pipe</code></a></td> + <td>Function in module <a href="../private/paramiko.pipe-module.html"><code>paramiko.pipe</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#makefile"><code>makefile</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#makefile_stderr"><code>makefile_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#max_bits"><code>max_bits</code></a></td> + <td>Variable in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#MAX_REQUEST_SIZE"><code>MAX_REQUEST_SIZE</code></a></td> + <td>Variable in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html"><code>Message</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.message-module.html"><code>message</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#min_bits"><code>min_bits</code></a></td> + <td>Variable in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#MIN_PACKET_SIZE"><code>MIN_PACKET_SIZE</code></a></td> + <td>Variable in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#mkdir"><code>mkdir</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#mkdir"><code>mkdir</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#mod_inverse"><code>mod_inverse</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.primes.ModulusPack-class.html"><code>ModulusPack</code></a></td> + <td>Class in module <a href="../private/paramiko.primes-module.html"><code>paramiko.primes</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#mro"><code>mro</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_CLOSE"><code>MSG_CHANNEL_CLOSE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_DATA"><code>MSG_CHANNEL_DATA</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_EOF"><code>MSG_CHANNEL_EOF</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_EXTENDED_DATA"><code>MSG_CHANNEL_EXTENDED_DATA</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_FAILURE"><code>MSG_CHANNEL_FAILURE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN"><code>MSG_CHANNEL_OPEN</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN_FAILURE"><code>MSG_CHANNEL_OPEN_FAILURE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN_SUCCESS"><code>MSG_CHANNEL_OPEN_SUCCESS</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_REQUEST"><code>MSG_CHANNEL_REQUEST</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_SUCCESS"><code>MSG_CHANNEL_SUCCESS</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_CHANNEL_WINDOW_ADJUST"><code>MSG_CHANNEL_WINDOW_ADJUST</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_DEBUG"><code>MSG_DEBUG</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_DISCONNECT"><code>MSG_DISCONNECT</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_GLOBAL_REQUEST"><code>MSG_GLOBAL_REQUEST</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_IGNORE"><code>MSG_IGNORE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_KEXINIT"><code>MSG_KEXINIT</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_NAMES"><code>MSG_NAMES</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_NEWKEYS"><code>MSG_NEWKEYS</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_REQUEST_FAILURE"><code>MSG_REQUEST_FAILURE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_REQUEST_SUCCESS"><code>MSG_REQUEST_SUCCESS</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_SERVICE_ACCEPT"><code>MSG_SERVICE_ACCEPT</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_SERVICE_REQUEST"><code>MSG_SERVICE_REQUEST</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_UNIMPLEMENTED"><code>MSG_UNIMPLEMENTED</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_USERAUTH_BANNER"><code>MSG_USERAUTH_BANNER</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_USERAUTH_FAILURE"><code>MSG_USERAUTH_FAILURE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_USERAUTH_INFO_REQUEST"><code>MSG_USERAUTH_INFO_REQUEST</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_USERAUTH_INFO_RESPONSE"><code>MSG_USERAUTH_INFO_RESPONSE</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_USERAUTH_PK_OK"><code>MSG_USERAUTH_PK_OK</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_USERAUTH_REQUEST"><code>MSG_USERAUTH_REQUEST</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#MSG_USERAUTH_SUCCESS"><code>MSG_USERAUTH_SUCCESS</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#name"><code>name</code></a></td> + <td>Variable in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1.KexGroup1-class.html#name"><code>name</code></a></td> + <td>Variable in class <a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>paramiko.kex_group1.KexGroup1</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#need_rekey"><code>need_rekey</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.packet.NeedRekeyException-class.html"><code>NeedRekeyException</code></a></td> + <td>Class in module <a href="../private/paramiko.packet-module.html"><code>paramiko.packet</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#next"><code>next</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#normalize"><code>normalize</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html"><code>object</code></a></td> + <td>Class in module <code>__builtin__</code></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#open"><code>open</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#open_channel"><code>open_channel</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#open_session"><code>open_session</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#open_sftp_client"><code>open_sftp_client</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1-module.html#P"><code>P</code></a></td> + <td>Variable in module <a href="../private/paramiko.kex_group1-module.html"><code>paramiko.kex_group1</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.packet-module.html"><code>packet</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html"><code>Packetizer</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko-module.html"><code>paramiko</code></a></td> + <td>Package</td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#parse_next"><code>parse_next</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1.KexGroup1-class.html#parse_next"><code>parse_next</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>paramiko.kex_group1.KexGroup1</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#parse_ssh_config"><code>parse_ssh_config</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html"><code>PartialAuthentication</code></a></td> + <td>Class in module <a href="../private/paramiko.ssh_exception-module.html"><code>paramiko.ssh_exception</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.PasswordRequiredException-class.html"><code>PasswordRequiredException</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util.PFilter-class.html"><code>PFilter</code></a></td> + <td>Class in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe-module.html"><code>pipe</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html"><code>PKey</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.pkey-module.html"><code>pkey</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.PosixPipe-class.html"><code>PosixPipe</code></a></td> + <td>Class in module <a href="../private/paramiko.pipe-module.html"><code>paramiko.pipe</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#preferred_bits"><code>preferred_bits</code></a></td> + <td>Variable in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#prefetch"><code>prefetch</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.primes-module.html"><code>primes</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#put"><code>put</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#read"><code>read</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#read"><code>read</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#read_all"><code>read_all</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.primes.ModulusPack-class.html#read_file"><code>read_file</code></a></td> + <td>Method in class <a href="../private/paramiko.primes.ModulusPack-class.html"><code>paramiko.primes.ModulusPack</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#read_message"><code>read_message</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#readline"><code>readline</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#readline"><code>readline</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#readlines"><code>readlines</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#readlink"><code>readlink</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#readlink"><code>readlink</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv"><code>recv</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv_exit_status"><code>recv_exit_status</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv_ready"><code>recv_ready</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv_stderr"><code>recv_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv_stderr_ready"><code>recv_stderr_ready</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#REKEY_BYTES"><code>REKEY_BYTES</code></a></td> + <td>Variable in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#REKEY_PACKETS"><code>REKEY_PACKETS</code></a></td> + <td>Variable in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#remove"><code>remove</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#remove"><code>remove</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#rename"><code>rename</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#rename"><code>rename</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#renegotiate_keys"><code>renegotiate_keys</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#resize_pty"><code>resize_pty</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#rewind"><code>rewind</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#rmdir"><code>rmdir</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#rmdir"><code>rmdir</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html"><code>RSAKey</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.rsakey-module.html"><code>rsakey</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#run"><code>run</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#run"><code>run</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#safe_string"><code>safe_string</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html"><code>SecurityOptions</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#seek"><code>seek</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#seek"><code>seek</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#send"><code>send</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#send_exit_status"><code>send_exit_status</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#send_ignore"><code>send_ignore</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#send_message"><code>send_message</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#send_stderr"><code>send_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#sendall"><code>sendall</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#sendall_stderr"><code>sendall_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.server-module.html"><code>server</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ServerInterface-class.html"><code>ServerInterface</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#session_ended"><code>session_ended</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#session_started"><code>session_started</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.PosixPipe-class.html#set"><code>set</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.PosixPipe-class.html"><code>paramiko.pipe.PosixPipe</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.WindowsPipe-class.html#set"><code>set</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>paramiko.pipe.WindowsPipe</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#set_combine_stderr"><code>set_combine_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#set_file_attr"><code>set_file_attr</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.PosixPipe-class.html#set_forever"><code>set_forever</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.PosixPipe-class.html"><code>paramiko.pipe.PosixPipe</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.WindowsPipe-class.html#set_forever"><code>set_forever</code></a></td> + <td>Method in class <a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>paramiko.pipe.WindowsPipe</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#set_hexdump"><code>set_hexdump</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#set_hexdump"><code>set_hexdump</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#set_inbound_cipher"><code>set_inbound_cipher</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#set_inbound_compressor"><code>set_inbound_compressor</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#set_keepalive"><code>set_keepalive</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#set_keepalive"><code>set_keepalive</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#set_log"><code>set_log</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#set_log_channel"><code>set_log_channel</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#set_name"><code>set_name</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#set_outbound_cipher"><code>set_outbound_cipher</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#set_outbound_compressor"><code>set_outbound_compressor</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#set_pipelined"><code>set_pipelined</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#set_subsystem_handler"><code>set_subsystem_handler</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#setblocking"><code>setblocking</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#setblocking"><code>setblocking</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#setDaemon"><code>setDaemon</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.StreamHandler-class.html#setFormatter"><code>setFormatter</code></a></td> + <td>Method in class <a href="../private/paramiko.logging22.StreamHandler-class.html"><code>paramiko.logging22.StreamHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.logger-class.html#setLevel"><code>setLevel</code></a></td> + <td>Method in class <a href="../private/paramiko.logging22.logger-class.html"><code>paramiko.logging22.logger</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#setName"><code>setName</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#settimeout"><code>settimeout</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#settimeout"><code>settimeout</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTP-class.html"><code>SFTP</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html"><code>sftp</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_attr-module.html"><code>sftp_attr</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_BAD_MESSAGE"><code>SFTP_BAD_MESSAGE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_client-module.html"><code>sftp_client</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_CONNECTION_LOST"><code>SFTP_CONNECTION_LOST</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_DESC"><code>SFTP_DESC</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_EOF"><code>SFTP_EOF</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FAILURE"><code>SFTP_FAILURE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_file-module.html"><code>sftp_file</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_APPEND"><code>SFTP_FLAG_APPEND</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_CREATE"><code>SFTP_FLAG_CREATE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_EXCL"><code>SFTP_FLAG_EXCL</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_READ"><code>SFTP_FLAG_READ</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_TRUNC"><code>SFTP_FLAG_TRUNC</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_WRITE"><code>SFTP_FLAG_WRITE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_handle-module.html"><code>sftp_handle</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_NO_CONNECTION"><code>SFTP_NO_CONNECTION</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_NO_SUCH_FILE"><code>SFTP_NO_SUCH_FILE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_OK"><code>SFTP_OK</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_OP_UNSUPPORTED"><code>SFTP_OP_UNSUPPORTED</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_PERMISSION_DENIED"><code>SFTP_PERMISSION_DENIED</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_server-module.html"><code>sftp_server</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_si-module.html"><code>sftp_si</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html"><code>SFTPAttributes</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html"><code>SFTPClient</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPError-class.html"><code>SFTPError</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html"><code>SFTPFile</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html"><code>SFTPHandle</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html"><code>SFTPServer</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html"><code>SFTPServerInterface</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#shutdown"><code>shutdown</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#shutdown_read"><code>shutdown_read</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#shutdown_write"><code>shutdown_write</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html#sign_ssh_data"><code>sign_ssh_data</code></a></td> + <td>Method in class <a href="paramiko.AgentKey-class.html"><code>paramiko.AgentKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#sign_ssh_data"><code>sign_ssh_data</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#sign_ssh_data"><code>sign_ssh_data</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#sign_ssh_data"><code>sign_ssh_data</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html#SSH2_AGENT_IDENTITIES_ANSWER"><code>SSH2_AGENT_IDENTITIES_ANSWER</code></a></td> + <td>Variable in module <a href="paramiko.agent-module.html"><code>paramiko.agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html#SSH2_AGENT_SIGN_RESPONSE"><code>SSH2_AGENT_SIGN_RESPONSE</code></a></td> + <td>Variable in module <a href="paramiko.agent-module.html"><code>paramiko.agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html#SSH2_AGENTC_REQUEST_IDENTITIES"><code>SSH2_AGENTC_REQUEST_IDENTITIES</code></a></td> + <td>Variable in module <a href="paramiko.agent-module.html"><code>paramiko.agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html#SSH2_AGENTC_SIGN_REQUEST"><code>SSH2_AGENTC_SIGN_REQUEST</code></a></td> + <td>Variable in module <a href="paramiko.agent-module.html"><code>paramiko.agent</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.ssh_exception-module.html"><code>ssh_exception</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SSHException-class.html"><code>SSHException</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#start"><code>start</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#start_client"><code>start_client</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_gex.KexGex-class.html#start_kex"><code>start_kex</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.kex_group1.KexGroup1-class.html#start_kex"><code>start_kex</code></a></td> + <td>Method in class <a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>paramiko.kex_group1.KexGroup1</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#start_server"><code>start_server</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#start_subsystem"><code>start_subsystem</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html#start_subsystem"><code>start_subsystem</code></a></td> + <td>Method in class <a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#stat"><code>stat</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#stat"><code>stat</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#stat"><code>stat</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#stat"><code>stat</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#stop_thread"><code>stop_thread</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22.StreamHandler-class.html"><code>StreamHandler</code></a></td> + <td>Class in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html"><code>SubsystemHandler</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#symlink"><code>symlink</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.SFTPServerInterface-class.html#symlink"><code>symlink</code></a></td> + <td>Method in class <a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#tb_strings"><code>tb_strings</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#tell"><code>tell</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html"><code>Thread</code></a></td> + <td>Class in module <code>threading</code></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html"><code>Transport</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.transport-module.html"><code>transport</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html"><code>type</code></a></td> + <td>Class in module <code>__builtin__</code></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#unhexify"><code>unhexify</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#use_compression"><code>use_compression</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html"><code>util</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#utime"><code>utime</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#verify_ssh_sig"><code>verify_ssh_sig</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#verify_ssh_sig"><code>verify_ssh_sig</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#verify_ssh_sig"><code>verify_ssh_sig</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.AuthHandler-class.html#wait_for_response"><code>wait_for_response</code></a></td> + <td>Method in class <a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.common-module.html#WARNING"><code>WARNING</code></a></td> + <td>Variable in module <a href="../private/paramiko.common-module.html"><code>paramiko.common</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.logging22-module.html#WARNING"><code>WARNING</code></a></td> + <td>Variable in module <a href="../private/paramiko.logging22-module.html"><code>paramiko.logging22</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>WindowsPipe</code></a></td> + <td>Class in module <a href="../private/paramiko.pipe-module.html"><code>paramiko.pipe</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#write"><code>write</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#write"><code>write</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.Packetizer-class.html#write_all"><code>write_all</code></a></td> + <td>Method in class <a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#write_private_key_file"><code>write_private_key_file</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.PKey-class.html#write_private_key_file"><code>write_private_key_file</code></a></td> + <td>Method in class <a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#write_private_key_file"><code>write_private_key_file</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#writelines"><code>writelines</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#xreadlines"><code>xreadlines</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.compress.ZlibCompressor-class.html"><code>ZlibCompressor</code></a></td> + <td>Class in module <a href="../private/paramiko.compress-module.html"><code>paramiko.compress</code></a></td></tr> + <tr><td width="15%"><a href="../private/paramiko.compress.ZlibDecompressor-class.html"><code>ZlibDecompressor</code></a></td> + <td>Class in module <a href="../private/paramiko.compress-module.html"><code>paramiko.compress</code></a></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="paramiko-module.html">Home</a> </th> + <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> + <th bgcolor="#70b0f0" class="navselect"> Index </th> + <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th> + <th class="navbar" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko-module.html b/docs/private/paramiko-module.html new file mode 100644 index 0000000..4e9f899 --- /dev/null +++ b/docs/private/paramiko-module.html @@ -0,0 +1,407 @@ +<?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>paramiko</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 bgcolor="#70b0f0" class="navselect"> Home </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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Package paramiko + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF PACKAGE DESCRIPTION =========== --> +<h2 class="package">Package paramiko</h2> + +<p><i>Paramiko</i> (a combination of the esperanto words for +"paranoid" and "friend") is a module for python 2.3 +or greater that implements the SSH2 protocol for secure (encrypted and +authenticated) connections to remote machines. Unlike SSL (aka TLS), the +SSH2 protocol does not require heirarchical certificates signed by a +powerful central authority. You may know SSH2 as the protocol that +replaced <code>telnet</code> and <code>rsh</code> for secure access to +remote shells, but the protocol also includes the ability to open +arbitrary channels to remote services across an encrypted tunnel. (This +is how <code>sftp</code> works, for example.)</p> +<p>To use this package, pass a socket (or socket-like object) to a <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>, and use <a +href="paramiko.Transport-class.html#start_server" +class="link"><code>start_server</code></a> or <a +href="paramiko.Transport-class.html#start_client" +class="link"><code>start_client</code></a> to negoatite with the remote +host as either a server or client. As a client, you are responsible for +authenticating using a password or private key, and checking the server's +host key. <i>(Key signature and verification is done by paramiko, but you +will need to provide private keys and check that the content of a public +key matches what you expected to see.)</i> As a server, you are +responsible for deciding which users, passwords, and keys to allow, and +what kind of channels to allow.</p> +<p>Once you have finished, either side may request flow-controlled <a +href="paramiko.Channel-class.html" class="link"><code>Channel</code></a>s +to the other side, which are python objects that act like sockets, but +send and receive data over the encrypted session.</p> +<p>Paramiko is written entirely in python (no C or platform-dependent +code) and is released under the GNU Lesser General Public License +(LGPL).</p> +Website: <a +href="http://www.lag.net/paramiko/">http://www.lag.net/paramiko/</a> +<hr/> +<p><b>Version:</b> 1.5.2 (rhydon) +</p> + +<p><b>Author:</b> Robey Pointer +</p> + +<p><b>Contact:</b> robey@lag.net +</p> + +<p><b>License:</b> GNU Lesser General Public License (LGPL) +</p> + + +<!-- =========== START OF SUBMODULES =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Submodules</th></tr> + <tr><td><ul> +<li> <b><a href="paramiko.agent-module.html"><code>agent</code></a></b>: <i>SSH Agent interface for Unix clients.</i> +<li> <b><a href="paramiko.dsskey-module.html"><code>dsskey</code></a></b>: <i><a href="paramiko.DSSKey-class.html" +class="link"><code>DSSKey</code></a></i> +<li> <b><a href="paramiko.file-module.html"><code>file</code></a></b>: <i>BufferedFile.</i> +<li> <b><a href="paramiko.message-module.html"><code>message</code></a></b>: <i>Implementation of an SSH2 "message".</i> +<li> <b><a href="paramiko.pkey-module.html"><code>pkey</code></a></b>: <i>Common API for all public keys.</i> +<li> <b><a href="paramiko.rsakey-module.html"><code>rsakey</code></a></b>: <i><a href="paramiko.RSAKey-class.html" +class="link"><code>RSAKey</code></a></i> +<li> <b><a href="paramiko.server-module.html"><code>server</code></a></b>: <i><a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> is an interface to override +for server support.</i> +<li> <b><a href="paramiko.sftp-module.html"><code>sftp</code></a></b> +<li> <b><a href="paramiko.sftp_attr-module.html"><code>sftp_attr</code></a></b> +<li> <b><a href="paramiko.sftp_client-module.html"><code>sftp_client</code></a></b>: <i>Client-mode SFTP support.</i> +<li> <b><a href="paramiko.sftp_file-module.html"><code>sftp_file</code></a></b>: <i><a href="paramiko.SFTPFile-class.html" +class="link"><code>SFTPFile</code></a></i> +<li> <b><a href="paramiko.sftp_handle-module.html"><code>sftp_handle</code></a></b>: <i>Abstraction of an SFTP file handle (for server mode).</i> +<li> <b><a href="paramiko.sftp_server-module.html"><code>sftp_server</code></a></b>: <i>Server-mode SFTP support.</i> +<li> <b><a href="paramiko.sftp_si-module.html"><code>sftp_si</code></a></b>: <i><a href="../private/paramiko.SFTPServerInterface-class.html" +class="link"><code>SFTPServerInterface</code></a> is an interface to +override for SFTP server support.</i> +<li> <b><a href="paramiko.transport-module.html"><code>transport</code></a></b>: <i><a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> handles the core SSH2 +protocol.</i> +<li> <b><a href="paramiko.util-module.html"><code>util</code></a></b>: <i>Useful functions used by the rest of paramiko.</i> +<li> <b><a href="../private/paramiko.auth_handler-module.html"><code>auth_handler</code></a></b>: <i><a href="../private/paramiko.AuthHandler-class.html" +class="link"><code>AuthHandler</code></a></i> +<li> <b><a href="../private/paramiko.ber-module.html"><code>ber</code></a></b> +<li> <b><a href="../private/paramiko.channel-module.html"><code>channel</code></a></b>: <i>Abstraction for an SSH2 channel.</i> +<li> <b><a href="../private/paramiko.common-module.html"><code>common</code></a></b>: <i>Common constants and global variables.</i> +<li> <b><a href="../private/paramiko.compress-module.html"><code>compress</code></a></b>: <i>Compression implementations for a Transport.</i> +<li> <b><a href="../private/paramiko.kex_gex-module.html"><code>kex_gex</code></a></b>: <i>Variant on <a +href="../private/paramiko.kex_group1.KexGroup1-class.html" +class="link"><code>KexGroup1</code></a> where the prime "p" and +generator "g" are provided by the server.</i> +<li> <b><a href="../private/paramiko.kex_group1-module.html"><code>kex_group1</code></a></b>: <i>Standard SSH key exchange ("kex" if you wanna sound +cool).</i> +<li> <b><a href="../private/paramiko.logging22-module.html"><code>logging22</code></a></b>: <i>Stub out logging on python < 2.3.</i> +<li> <b><a href="../private/paramiko.packet-module.html"><code>packet</code></a></b>: <i>Packetizer.</i> +<li> <b><a href="../private/paramiko.pipe-module.html"><code>pipe</code></a></b>: <i>Abstraction of a one-way pipe where the read end can be used in +select().</i> +<li> <b><a href="../private/paramiko.primes-module.html"><code>primes</code></a></b>: <i>Utility functions for dealing with primes.</i> +<li> <b><a href="../private/paramiko.ssh_exception-module.html"><code>ssh_exception</code></a></b>: <i>Exceptions defined by paramiko.</i> + </ul></td></tr> +</table><br /> + + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="paramiko.Agent-class.html"><code>Agent</code></a></b></td> + <td>Client interface for using private keys from an SSH agent running on +the local machine.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.AgentKey-class.html"><code>AgentKey</code></a></b></td> + <td>Private key held in a local SSH agent.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a></b></td> + <td>Reusable base class to implement python-style file buffering around a +simpler stream.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.Channel-class.html"><code>Channel</code></a></b></td> + <td>A secure tunnel across an SSH <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.DSSKey-class.html"><code>DSSKey</code></a></b></td> + <td>Representation of a DSS key which can be used to sign an verify SSH2 +data.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.Message-class.html"><code>Message</code></a></b></td> + <td>An SSH2 <i>Message</i> is a stream of bytes that encodes some +combination of strings, integers, bools, and infinite-precision integers +(known in python as <i>long</i>s).</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.RSAKey-class.html"><code>RSAKey</code></a></b></td> + <td>Representation of an RSA key which can be used to sign and verify SSH2 +data.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SecurityOptions-class.html"><code>SecurityOptions</code></a></b></td> + <td>Simple object containing the security preferences of an ssh +transport.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTP-class.html"><code>SFTP</code></a></b></td> + <td>an alias for <a href="paramiko.SFTPClient-class.html" +class="link"><code>SFTPClient</code></a> for backwards compatability</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPAttributes-class.html"><code>SFTPAttributes</code></a></b></td> + <td>Representation of the attributes of a file (or proxied file) for SFTP +in client or server mode.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPClient-class.html"><code>SFTPClient</code></a></b></td> + <td>SFTP client object.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPFile-class.html"><code>SFTPFile</code></a></b></td> + <td>Proxy object for a file on the remote server, in client mode SFTP.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPHandle-class.html"><code>SFTPHandle</code></a></b></td> + <td>Abstract object representing a handle to an open file (or folder) in +an SFTP server implementation.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPServer-class.html"><code>SFTPServer</code></a></b></td> + <td>Server-side SFTP subsystem support.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SubsystemHandler-class.html"><code>SubsystemHandler</code></a></b></td> + <td>Handler for a subsytem in server mode.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.Transport-class.html"><code>Transport</code></a></b></td> + <td>An SSH Transport attaches to a stream (usually a socket), negotiates +an encrypted session, authenticates, and then creates stream tunnels, +called <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>s, across the session.</td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.AuthHandler-class.html"><code>AuthHandler</code></a></b></td> + <td>Internal class to handle the mechanics of authentication.</td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a></b></td> + <td> </td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.ChannelFile-class.html"><code>ChannelFile</code></a></b></td> + <td>A file-like wrapper around <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.Packetizer-class.html"><code>Packetizer</code></a></b></td> + <td>Implementation of the base SSH packet protocol.</td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.PKey-class.html"><code>PKey</code></a></b></td> + <td>Base class for public keys.</td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.ServerInterface-class.html"><code>ServerInterface</code></a></b></td> + <td>This class defines an interface for controlling the behavior of +paramiko in server mode.</td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.SFTPServerInterface-class.html"><code>SFTPServerInterface</code></a></b></td> + <td>This class defines an interface for controlling the behavior of +paramiko when using the <a href="paramiko.SFTPServer-class.html" +class="link"><code>SFTPServer</code></a> subsystem to provide an SFTP +server.</td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.ServerInterface-class.html"><code>x</code></a></b></td> + <td>This class defines an interface for controlling the behavior of +paramiko in server mode.</td></tr> +</table><br /> + + +<!-- =========== START OF EXCEPTIONS =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Exceptions</th></tr> +<tr><td width="15%"> + <b><a href="paramiko.BadAuthenticationType-class.html"><code>BadAuthenticationType</code></a></b></td> + <td>Exception raised when an authentication type (like password) is used, +but the server isn't allowing that type.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.PasswordRequiredException-class.html"><code>PasswordRequiredException</code></a></b></td> + <td>Exception raised when a password is needed to unlock a private key +file.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPError-class.html"><code>SFTPError</code></a></b></td> + <td> </td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SSHException-class.html"><code>SSHException</code></a></b></td> + <td>Exception raised by failures in SSH2 protocol negotiation or logic +errors.</td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td> +<td><b><a href="../private/paramiko-module.html#__author__"><code>__author__</code></a></b> = <span title="'Robey Pointer <robey@lag.net>'"><code><span class="variable-quote">'</span>Robey Pointer <robey@lag.net><span class="variable-quote">'</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="../private/paramiko-module.html#__date__"><code>__date__</code></a></b> = <span title="'04 Dec 2005'"><code><span class="variable-quote">'</span>04 Dec 2005<span class="variable-quote">'</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="../private/paramiko-module.html#__license__"><code>__license__</code></a></b> = <span title="'GNU Lesser General Public License (LGPL)'"><code><span class="variable-quote">'</span>GNU Lesser General Public License (LGPL)<span class="variable-quote">'<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="../private/paramiko-module.html#__version__"><code>__version__</code></a></b> = <span title="'1.5.2 (rhydon)'"><code><span class="variable-quote">'</span>1.5.2 (rhydon)<span class="variable-quote">'</span> </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="../private/paramiko-module.html#__version_info__"><code>__version_info__</code></a></b> = <span title="(1, 5, 2)"><code>(1, 5, 2) </code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__author__"></a> +<h3>__author__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'Robey Pointer <robey@lag.net>'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>Robey Pointer <robey@lag.net><span class="variable-quote">'</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__date__"></a> +<h3>__date__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'04 Dec 2005'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>04 Dec 2005<span class="variable-quote">'</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__license__"></a> +<h3>__license__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'GNU Lesser General Public License (LGPL)'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>GNU Lesser General Public License (LGPL)<span class="variable-quote">'</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__version__"></a> +<h3>__version__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'1.5.2 (rhydon)'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>1.5.2 (rhydon)<span class="variable-quote">'</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__version_info__"></a> +<h3>__version_info__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</code> + + </dd> +<span title="(1, 5, 2)"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +(1, 5, 2) </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 bgcolor="#70b0f0" class="navselect"> Home </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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.Agent-class.html b/docs/private/paramiko.Agent-class.html new file mode 100644 index 0000000..1f4e20b --- /dev/null +++ b/docs/private/paramiko.Agent-class.html @@ -0,0 +1,155 @@ +<?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>paramiko.Agent</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Agent + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.Agent-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Agent-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class Agent</h2> + +<hr/> + +<p>Client interface for using private keys from an SSH agent running on +the local machine. If an SSH agent is running, this class can be used to +connect to it and retreive <a href="../private/paramiko.PKey-class.html" +class="link"><code>PKey</code></a> objects which can be used when +attempting to authenticate to remote SSH servers.</p> +Because the SSH agent protocol uses environment variables and +unix-domain sockets, this probably doesn't work on Windows. It does work +on most posix platforms though (Linux and MacOS X, for example). +<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="paramiko.Agent-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Open a session with the local machine's SSH agent, if one is +running.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Agent-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the SSH agent connection.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> tuple of <a href="paramiko.AgentKey-class.html" + class="link"><code>AgentKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Agent-class.html#get_keys" class="summary-sig-name"><code>get_keys</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the list of keys available through the SSH agent, if any.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_read_all"></a><span class="summary-sig"><span class="summary-sig-name">_read_all</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>wanted</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_send_message"></a><span class="summary-sig"><span class="summary-sig-name">_send_message</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +</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> + <br /><i>(Constructor)</i> + </h3> + Open a session with the local machine's SSH agent, if one is + running. If no agent is running, initialization will succeed, but <a + href="paramiko.Agent-class.html#get_keys" + class="link"><code>get_keys</code></a> will return an empty tuple. + <dl><dt></dt><dd> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if an SSH agent is found, but speaks an incompatible + protocol + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close the SSH agent connection. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="get_keys"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_keys</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the list of keys available through the SSH agent, if any. If + no SSH agent was running (or it couldn't be contacted), an empty list + will be returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a list of keys available on the SSH agent + <br /><i> + (type=tuple of <a href="paramiko.AgentKey-class.html" + class="link"><code>AgentKey</code></a>)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.AgentKey-class.html b/docs/private/paramiko.AgentKey-class.html new file mode 100644 index 0000000..28b1659 --- /dev/null +++ b/docs/private/paramiko.AgentKey-class.html @@ -0,0 +1,319 @@ +<?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>paramiko.AgentKey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class AgentKey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.AgentKey-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.AgentKey-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type AgentKey</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.PKey-class.html"><code>PKey</code></a> --+ + | + <b>AgentKey</b> +</pre><br /> + +<hr/> + +Private key held in a local SSH agent. This type of key can be used +for authenticating to a remote server (signing). Most other key +operations work as expected. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>agent</span>, + <span class=summary-sig-arg>blob</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.AgentKey-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string of an SSH <a href="paramiko.Message-class.html" +class="link"><code>Message</code></a> made up of the public part(s) of +this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.AgentKey-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the name of this private key implementation.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.AgentKey-class.html#sign_ssh_data" class="summary-sig-name"><code>sign_ssh_data</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>randpool</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Sign a blob of data with this private key, and return a <a +href="paramiko.Message-class.html" class="link"><code>Message</code></a> +representing an SSH signature message.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from PKey</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#__cmp__" class="summary-sig-name"><code>__cmp__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>other</span>)</span></code> +<br /> +Compare this key to another.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#_read_private_key_file" class="summary-sig-name"><code>_read_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>tag</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Read an SSH2-format private key file, looking for a string of the type +<code>"BEGIN xxx PRIVATE KEY"</code> for some <code>xxx</code>, +base64-decode the text we find, and return it as a string.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#_write_private_key_file" class="summary-sig-name"><code>_write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>tag</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write an SSH2-format private key file in a form that can be read by +paramiko or openssh.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#can_sign" class="summary-sig-name"><code>can_sign</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return <code>True</code> if this key has the private part necessary +for signing data.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#from_private_key_file" class="summary-sig-name"><code>from_private_key_file</code></a>(<span class=summary-sig-arg>cl</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Create a key object by reading a private key file. <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_base64" class="summary-sig-name"><code>get_base64</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a base64 string containing the public part of this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_bits" class="summary-sig-name"><code>get_bits</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the number of significant bits in this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_fingerprint" class="summary-sig-name"><code>get_fingerprint</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return an MD5 fingerprint of the public part of this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#verify_ssh_sig" class="summary-sig-name"><code>verify_ssh_sig</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +<br /> +Given a blob of data, and an SSH message representing a signature of +that data, verify that it was signed with this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#write_private_key_file" class="summary-sig-name"><code>write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write private key contents into a file.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from PKey</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.PKey-class.html#_CIPHER_TABLE"><code>_CIPHER_TABLE</code></a></b> = <span title="{'DES-EDE3-CBC': {'blocksize': 8, 'cipher': <module 'Crypto.Cipher.DES3' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/DES3.so'>, 'keysize': 24, 'mode': 2}}"><code>{'DES-EDE3-CBC': {'blocksize': 8, 'ciphe<span class="variable-ellipsis">...</span></code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance Method Details</th></tr> +</table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return a string of an SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> made up of the public part(s) of + this key. This string is suitable for passing to <a + href="../private/paramiko.PKey-class.html#__init__" + class="link"><code>__init__</code></a> to re-create the key object + later. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string representation of an SSH key message. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__str__"><code>paramiko.PKey.__str__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the name of this private key implementation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + name of this private key type, in SSH terminology (for + example, <code>"ssh-rsa"</code>). + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_name"><code>paramiko.PKey.get_name</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="sign_ssh_data"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">sign_ssh_data</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>randpool</span>, + <span class=sig-arg>data</span>)</span> + </h3> + Sign a blob of data with this private key, and return a <a + href="paramiko.Message-class.html" + class="link"><code>Message</code></a> representing an SSH signature + message. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>randpool</b></code> - + a secure random number generator. + <br /><i> + (type=<code>Crypto.Util.randpool.RandomPool</code>)</i> + <dd><code><b>data</b></code> - + the data to sign. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SSH signature message. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#sign_ssh_data"><code>paramiko.PKey.sign_ssh_data</code></a> <i>(inherited documentation)</i> +</dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.AuthHandler-class.html b/docs/private/paramiko.AuthHandler-class.html new file mode 100644 index 0000000..7c2b235 --- /dev/null +++ b/docs/private/paramiko.AuthHandler-class.html @@ -0,0 +1,282 @@ +<?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>paramiko.AuthHandler</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class AuthHandler + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.AuthHandler-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type AuthHandler</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>AuthHandler</b> +</pre><br /> + +<hr/> + +Internal class to handle the mechanics of authentication. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>transport</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_disconnect_no_more_auth"></a><span class="summary-sig"><span class="summary-sig-name">_disconnect_no_more_auth</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><a name="_disconnect_service_not_available"></a><span class="summary-sig"><span class="summary-sig-name">_disconnect_service_not_available</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><a name="_get_session_blob"></a><span class="summary-sig"><span class="summary-sig-name">_get_session_blob</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>key</span>, + <span class=summary-sig-arg>service</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="_interactive_query"></a><span class="summary-sig"><span class="summary-sig-name">_interactive_query</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>q</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_service_accept"></a><span class="summary-sig"><span class="summary-sig-name">_parse_service_accept</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_service_request"></a><span class="summary-sig"><span class="summary-sig-name">_parse_service_request</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_userauth_banner"></a><span class="summary-sig"><span class="summary-sig-name">_parse_userauth_banner</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_userauth_failure"></a><span class="summary-sig"><span class="summary-sig-name">_parse_userauth_failure</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_userauth_info_request"></a><span class="summary-sig"><span class="summary-sig-name">_parse_userauth_info_request</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_userauth_info_response"></a><span class="summary-sig"><span class="summary-sig-name">_parse_userauth_info_response</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_userauth_request"></a><span class="summary-sig"><span class="summary-sig-name">_parse_userauth_request</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_userauth_success"></a><span class="summary-sig"><span class="summary-sig-name">_parse_userauth_success</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_request_auth"></a><span class="summary-sig"><span class="summary-sig-name">_request_auth</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><a name="_send_auth_result"></a><span class="summary-sig"><span class="summary-sig-name">_send_auth_result</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>method</span>, + <span class=summary-sig-arg>result</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="abort"></a><span class="summary-sig"><span class="summary-sig-name">abort</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="../private/paramiko.AuthHandler-class.html#auth_interactive" class="summary-sig-name"><code>auth_interactive</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>handler</span>, + <span class=summary-sig-arg>event</span>, + <span class=summary-sig-arg>submethods</span>)</span></code> +<br /> +response_list = handler(title, instructions, prompt_list)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="auth_none"></a><span class="summary-sig"><span class="summary-sig-name">auth_none</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>event</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="auth_password"></a><span class="summary-sig"><span class="summary-sig-name">auth_password</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>password</span>, + <span class=summary-sig-arg>event</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="auth_publickey"></a><span class="summary-sig"><span class="summary-sig-name">auth_publickey</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>key</span>, + <span class=summary-sig-arg>event</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="get_username"></a><span class="summary-sig"><span class="summary-sig-name">get_username</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><a name="is_authenticated"></a><span class="summary-sig"><span class="summary-sig-name">is_authenticated</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><a name="wait_for_response"></a><span class="summary-sig"><span class="summary-sig-name">wait_for_response</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>event</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="../private/paramiko.AuthHandler-class.html#_handler_table"><code>_handler_table</code></a></b> = <span title="{5: <function _parse_service_request at 0xb7b0ae2c>, 6: <function _parse_service_accept at 0xb7b0ae64>, 50: <function _parse_userauth_request at 0xb7b0af0c>, 51: <function _parse_userauth_failure at 0xb7b0af7c>, 52: <function _parse_userauth_success at 0xb7b0af44>, 53: <function _parse_userauth_banner at 0xb7b0afb4>, 60: <function _parse_userauth_info_request at 0xb7b1302c>, 61: <function _parse_userauth_info_response at 0xb7b13064>}"><code>{5: <function _parse_service_request at<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="auth_interactive"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">auth_interactive</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>handler</span>, + <span class=sig-arg>event</span>, + <span class=sig-arg>submethods</span>=<span class=sig-default>''</span>)</span> + </h3> + response_list = handler(title, instructions, prompt_list) + <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="_handler_table"></a> +<h3>_handler_table</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{5: <function _parse_service_request at 0xb7b0ae2c>, 6: <function _parse_service_accept at 0xb7b0ae64>, 50: <function _parse_userauth_request at 0xb7b0af0c>, 51: <function _parse_userauth_failure at 0xb7b0af7c>, 52: <function _parse_userauth_success at 0xb7b0af44>, 53: <function _parse_userauth_banner at 0xb7b0afb4>, 60: <function _parse_userauth_info_request at 0xb7b1302c>, 61: <function _parse_userauth_info_response at 0xb7b13064>}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{5: <function _parse_service_request at 0xb7b0ae2c>, + 6: <function _parse_service_accept at 0xb7b0ae64>, + 50: <function _parse_userauth_request at 0xb7b0af0c>, + 51: <function _parse_userauth_failure at 0xb7b0af7c>, + 52: <function _parse_userauth_success at 0xb7b0af44>, + 53: <function _parse_userauth_banner at 0xb7b0afb4>, + 60: <function _parse_userauth_info_request at 0xb7b1302c>, + 61: <function _parse_userauth_info_response at 0xb7b13064>} </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.BadAuthenticationType-class.html b/docs/private/paramiko.BadAuthenticationType-class.html new file mode 100644 index 0000000..023879a --- /dev/null +++ b/docs/private/paramiko.BadAuthenticationType-class.html @@ -0,0 +1,141 @@ +<?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>paramiko.BadAuthenticationType</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class BadAuthenticationType + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.BadAuthenticationType-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.BadAuthenticationType-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class BadAuthenticationType</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <a href="paramiko.SSHException-class.html"><code>SSHException</code></a> --+ + | + <b>BadAuthenticationType</b> +</pre><br /> + +<hr/> + +Exception raised when an authentication type (like password) is used, +but the server isn't allowing that type. (It may only allow public-key, +for example.) +<hr/> + +<p><b>Since:</b> 1.1 +</p> + + +<!-- =========== 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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>explanation</span>, + <span class=summary-sig-arg>types</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Instance Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1">list</font></td> +<td><b><a href="paramiko.BadAuthenticationType-class.html#allowed_types"><code>allowed_types</code></a></b>: list of allowed authentication types provided by the server (possible +values are: <code>"none"</code>, +<code>"password"</code>, and +<code>"publickey"</code>).</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="allowed_types"></a> +<h3>allowed_types</h3> +list of allowed authentication types provided by the server (possible +values are: <code>"none"</code>, +<code>"password"</code>, and +<code>"publickey"</code>). +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + list + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.BaseSFTP-class.html b/docs/private/paramiko.BaseSFTP-class.html new file mode 100644 index 0000000..18917f0 --- /dev/null +++ b/docs/private/paramiko.BaseSFTP-class.html @@ -0,0 +1,149 @@ +<?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>paramiko.BaseSFTP</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class BaseSFTP + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.BaseSFTP-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type BaseSFTP</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>BaseSFTP</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SFTPClient-class.html"><code>SFTPClient</code></a>, + <a href="paramiko.SFTPServer-class.html"><code>SFTPServer</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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</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><a name="_log"></a><span class="summary-sig"><span class="summary-sig-name">_log</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>level</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_read_all"></a><span class="summary-sig"><span class="summary-sig-name">_read_all</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_read_packet"></a><span class="summary-sig"><span class="summary-sig-name">_read_packet</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><a name="_send_packet"></a><span class="summary-sig"><span class="summary-sig-name">_send_packet</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>t</span>, + <span class=summary-sig-arg>packet</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_send_server_version"></a><span class="summary-sig"><span class="summary-sig-name">_send_server_version</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><a name="_send_version"></a><span class="summary-sig"><span class="summary-sig-name">_send_version</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><a name="_write_all"></a><span class="summary-sig"><span class="summary-sig-name">_write_all</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>out</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/paramiko.BufferedFile-class.html b/docs/private/paramiko.BufferedFile-class.html new file mode 100644 index 0000000..2ab7785 --- /dev/null +++ b/docs/private/paramiko.BufferedFile-class.html @@ -0,0 +1,656 @@ +<?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>paramiko.BufferedFile</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class BufferedFile + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.BufferedFile-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.BufferedFile-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type BufferedFile</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>BufferedFile</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SFTPFile-class.html"><code>SFTPFile</code></a>, + <a href="../private/paramiko.ChannelFile-class.html"><code>ChannelFile</code></a></dd></dl> + +<hr/> + +Reusable base class to implement python-style file buffering around a +simpler stream. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</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><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns an iterator that can be used to iterate over the lines in this +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#flush" class="summary-sig-name"><code>flush</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Write out any data in the write buffer.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#next" class="summary-sig-name"><code>next</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the next line from the input, or raises +<code>StopIteration</code> when EOF is hit.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read at most <code>size</code> bytes from the file (less if we hit the +end of the file first).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readline" class="summary-sig-name"><code>readline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read one entire line from the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readlines" class="summary-sig-name"><code>readlines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sizehint</span>)</span></code> +<br /> +Read all remaining lines using <a +href="paramiko.BufferedFile-class.html#readline" +class="link"><code>readline</code></a> and return them as a list.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#seek" class="summary-sig-name"><code>seek</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>whence</span>)</span></code> +<br /> +Set the file's current position, like stdio's <code>fseek</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#tell" class="summary-sig-name"><code>tell</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the file's current position.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Write data to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#writelines" class="summary-sig-name"><code>writelines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sequence</span>)</span></code> +<br /> +Write a sequence of strings to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#xreadlines" class="summary-sig-name"><code>xreadlines</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Identical to <code>iter(f)</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_get_size" class="summary-sig-name"><code>_get_size</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +<i>(subclass override)</i> Return the size of the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_read" class="summary-sig-name"><code>_read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +<i>(subclass override)</i> Read data from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_record_newline"></a><span class="summary-sig"><span class="summary-sig-name">_record_newline</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>newline</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="../private/paramiko.BufferedFile-class.html#_set_mode" class="summary-sig-name"><code>_set_mode</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Subclasses call this method to initialize the BufferedFile.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_write" class="summary-sig-name"><code>_write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +<i>(subclass override)</i> Write data into the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_write_all"></a><span class="summary-sig"><span class="summary-sig-name">_write_all</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></b> = <span title="0">0 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.BufferedFile-class.html#_DEFAULT_BUFSIZE"><code>_DEFAULT_BUFSIZE</code></a></b> = <span title="8192">8192 </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="__iter__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__iter__</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns an iterator that can be used to iterate over the lines in + this file. This iterator happens to return the file itself, since a + file is its own iterator. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an interator. + <br /><i> + (type=iterator)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>ValueError</b></code> - + if the file is closed. + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close the file. Future read and write operations will fail. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="flush"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">flush</span>(<span class=sig-arg>self</span>)</span> + </h3> + Write out any data in the write buffer. This may do nothing if write + buffering is not turned on. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="next"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">next</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns the next line from the input, or raises + <code>StopIteration</code> when EOF is hit. Unlike python file objects, + it's okay to mix calls to <code>next</code> and <a + href="paramiko.BufferedFile-class.html#readline" + class="link"><code>readline</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a line read from the file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>StopIteration</b></code> - + when the end of the file is reached. + </dl> + </dd></dl> +</td></tr></table> + +<a name="read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">read</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>size</span>=<span class=sig-default>None</span>)</span> + </h3> + Read at most <code>size</code> bytes from the file (less if we hit + the end of the file first). If the <code>size</code> argument is + negative or omitted, read all the remaining data in the file. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>size</b></code> - + maximum number of bytes to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + data read from the file, or an empty string if EOF was + encountered immediately. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="readline"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">readline</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>size</span>=<span class=sig-default>None</span>)</span> + </h3> + Read one entire line from the file. A trailing newline character is + kept in the string (but may be absent when a file ends with an + incomplete line). If the size argument is present and non-negative, it + is a maximum byte count (including the trailing newline) and an + incomplete line may be returned. An empty string is returned only when + EOF is encountered immediately. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>size</b></code> - + maximum length of returned string. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + next line of the file, or an empty string if the end of the + file has been reached. + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Note:</b> Unlike stdio's <code>fgets()</code>, the returned string contains null +characters (<code>'\0'</code>) if they occurred in the input. +</p> + + </dd></dl> +</td></tr></table> + +<a name="readlines"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">readlines</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>sizehint</span>=<span class=sig-default>None</span>)</span> + </h3> + Read all remaining lines using <a + href="paramiko.BufferedFile-class.html#readline" + class="link"><code>readline</code></a> and return them as a list. If + the optional <code>sizehint</code> argument is present, instead of + reading up to EOF, whole lines totalling approximately sizehint bytes + (possibly after rounding up to an internal buffer size) are read. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>sizehint</b></code> - + desired maximum number of bytes to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of lines read from the file. + <br /><i> + (type=list)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="seek"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">seek</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>offset</span>, + <span class=sig-arg>whence</span>=<span class=sig-default>0</span>)</span> + </h3> + Set the file's current position, like stdio's <code>fseek</code>. + Not all file objects support seeking. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>offset</b></code> - + position to move to within the file, relative to + <code>whence</code>. + <br /><i> + (type=int)</i> + <dd><code><b>whence</b></code> - + type of movement: 0 = absolute; 1 = relative to the current + position; 2 = relative to the end of the file. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the file doesn't support random access. + </dl> +<p><b>Note:</b> If a file is opened in append mode (<code>'a'</code> or +<code>'a+'</code>), any seek operations will be undone at the next write +(as the file position will move back to the end of the file). +</p> + + </dd></dl> +</td></tr></table> + +<a name="tell"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">tell</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the file's current position. This may not be accurate or + useful if the underlying file doesn't support random access, or was + opened in append mode. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + file position (in bytes). + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">write</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>)</span> + </h3> + Write data to the file. If write buffering is on + (<code>bufsize</code> was specified and non-zero), some or all of the + data may not actually be written yet. (Use <a + href="paramiko.BufferedFile-class.html#flush" + class="link"><code>flush</code></a> or <a + href="paramiko.BufferedFile-class.html#close" + class="link"><code>close</code></a> to force buffered data to be + written out.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>data</b></code> - + data to write. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="writelines"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">writelines</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>sequence</span>)</span> + </h3> + Write a sequence of strings to the file. The sequence can be any + iterable object producing strings, typically a list of strings. (The + name is intended to match <a + href="paramiko.BufferedFile-class.html#readlines" + class="link"><code>readlines</code></a>; <code>writelines</code> does + not add line separators.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>sequence</b></code> - + an iterable sequence of strings. + <br /><i> + (type=sequence)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="xreadlines"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">xreadlines</span>(<span class=sig-arg>self</span>)</span> + </h3> + Identical to <code>iter(f)</code>. This is a deprecated file + interface that predates python iterator support. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an iterator. + <br /><i> + (type=iterator)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_get_size"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_get_size</span>(<span class=sig-arg>self</span>)</span> + </h3> + <i>(subclass override)</i> Return the size of the file. This is + called from within <a + href="../private/paramiko.BufferedFile-class.html#_set_mode" + class="link"><code>_set_mode</code></a> if the file is opened in append + mode, so the file position can be tracked and <a + href="paramiko.BufferedFile-class.html#seek" + class="link"><code>seek</code></a> and <a + href="paramiko.BufferedFile-class.html#tell" + class="link"><code>tell</code></a> will work correctly. If the file is + a stream that can't be randomly accessed, you don't need to override + this method, + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_read</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>size</span>)</span> + </h3> + <i>(subclass override)</i> Read data from the stream. Return + <code>None</code> or raise <code>EOFError</code> to indicate EOF. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_set_mode"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_set_mode</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>mode</span>=<span class=sig-default>'r'</span>, + <span class=sig-arg>bufsize</span>=<span class=sig-default>-1</span>)</span> + </h3> + Subclasses call this method to initialize the BufferedFile. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_write</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>)</span> + </h3> + <i>(subclass override)</i> Write data into the stream. + <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="SEEK_CUR"></a> +<h3>SEEK_CUR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SEEK_END"></a> +<h3>SEEK_END</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SEEK_SET"></a> +<h3>SEEK_SET</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> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_DEFAULT_BUFSIZE"></a> +<h3>_DEFAULT_BUFSIZE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8192"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8192 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.Channel-class.html b/docs/private/paramiko.Channel-class.html new file mode 100644 index 0000000..83ac46e --- /dev/null +++ b/docs/private/paramiko.Channel-class.html @@ -0,0 +1,1329 @@ +<?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>paramiko.Channel</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Channel + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.Channel-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Channel-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Channel</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>Channel</b> +</pre><br /> + +<hr/> + +<p>A secure tunnel across an SSH <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>. A Channel is meant to behave +like a socket, and has an API that should be indistinguishable from the +python socket API.</p> +Because SSH2 has a windowing kind of flow control, if you stop reading +data from a Channel and its buffer fills up, the server will be unable to +send you any more data until you read some of it. (This won't affect +other channels on the same transport -- all channels on a single +transport are flow-controlled independently.) Similarly, if the server +isn't reading data you send, calls to <a +href="paramiko.Channel-class.html#send" +class="link"><code>send</code></a> may block, unless you set a timeout. +This is exactly like a normal network socket, so it shouldn't be too +surprising. +<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="paramiko.Channel-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>chanid</span>)</span></code> +<br /> +Create a new channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string representation of this object, for debugging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#exec_command" class="summary-sig-name"><code>exec_command</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>command</span>)</span></code> +<br /> +Execute a command on the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#fileno" class="summary-sig-name"><code>fileno</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns an OS-level file descriptor which can be used for polling, but +but <i>not</i> for reading or writing).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#get_id" class="summary-sig-name"><code>get_id</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the ID # for this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Get the name of this channel that was previously set by <a +href="paramiko.Channel-class.html#set_name" +class="link"><code>set_name</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#get_pty" class="summary-sig-name"><code>get_pty</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>term</span>, + <span class=summary-sig-arg>width</span>, + <span class=summary-sig-arg>height</span>)</span></code> +<br /> +Request a pseudo-terminal from the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#get_transport" class="summary-sig-name"><code>get_transport</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> associated with this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> float +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#gettimeout" class="summary-sig-name"><code>gettimeout</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the timeout in seconds (as a float) associated with socket +operations, or <code>None</code> if no timeout is set.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#invoke_shell" class="summary-sig-name"><code>invoke_shell</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Request an interactive shell session on this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#invoke_subsystem" class="summary-sig-name"><code>invoke_subsystem</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>subsystem</span>)</span></code> +<br /> +Request a subsystem on the server (for example, +<code>sftp</code>).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.ChannelFile-class.html" + class="link"><code>ChannelFile</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#makefile" class="summary-sig-name"><code>makefile</code></a>(<span class=summary-sig-arg>self</span>, + <span class="summary-sig-vararg">*params</span>)</span></code> +<br /> +Return a file-like object associated with this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.ChannelFile-class.html" + class="link"><code>ChannelFile</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#makefile_stderr" class="summary-sig-name"><code>makefile_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class="summary-sig-vararg">*params</span>)</span></code> +<br /> +Return a file-like object associated with this channel's stderr +stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv" class="summary-sig-name"><code>recv</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>nbytes</span>)</span></code> +<br /> +Receive data from the channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_exit_status" class="summary-sig-name"><code>recv_exit_status</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the exit status from the process on the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_ready" class="summary-sig-name"><code>recv_ready</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns true if data is buffered and ready to be read from this +channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_stderr" class="summary-sig-name"><code>recv_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>nbytes</span>)</span></code> +<br /> +Receive data from the channel's stderr stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_stderr_ready" class="summary-sig-name"><code>recv_stderr_ready</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns true if data is buffered and ready to be read from this +channel's stderr stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#resize_pty" class="summary-sig-name"><code>resize_pty</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>width</span>, + <span class=summary-sig-arg>height</span>)</span></code> +<br /> +Resize the pseudo-terminal.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#send" class="summary-sig-name"><code>send</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Send data to the channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#send_exit_status" class="summary-sig-name"><code>send_exit_status</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>status</span>)</span></code> +<br /> +Send the exit status of an executed command to the client.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#send_stderr" class="summary-sig-name"><code>send_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Send data to the channel on the "stderr" stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#sendall" class="summary-sig-name"><code>sendall</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Send data to the channel, without allowing partial results.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#sendall_stderr" class="summary-sig-name"><code>sendall_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Send data to the channel's "stderr" stream, without allowing +partial results.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#set_combine_stderr" class="summary-sig-name"><code>set_combine_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>combine</span>)</span></code> +<br /> +Set whether stderr should be combined into stdout on this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#set_name" class="summary-sig-name"><code>set_name</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>)</span></code> +<br /> +Set a name for this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#setblocking" class="summary-sig-name"><code>setblocking</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>blocking</span>)</span></code> +<br /> +Set blocking or non-blocking mode of the channel: if +<code>blocking</code> is 0, the channel is set to non-blocking mode; +otherwise it's set to blocking mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#settimeout" class="summary-sig-name"><code>settimeout</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +<br /> +Set a timeout on blocking read/write operations.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#shutdown" class="summary-sig-name"><code>shutdown</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>how</span>)</span></code> +<br /> +Shut down one or both halves of the connection.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#shutdown_read" class="summary-sig-name"><code>shutdown_read</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Shutdown the receiving side of this socket, closing the stream in the +incoming direction.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#shutdown_write" class="summary-sig-name"><code>shutdown_write</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Shutdown the sending side of this socket, closing the stream in the +outgoing direction.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_check_add_window"></a><span class="summary-sig"><span class="summary-sig-name">_check_add_window</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_close_internal"></a><span class="summary-sig"><span class="summary-sig-name">_close_internal</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><a name="_feed"></a><span class="summary-sig"><span class="summary-sig-name">_feed</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_feed_extended"></a><span class="summary-sig"><span class="summary-sig-name">_feed_extended</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_handle_close"></a><span class="summary-sig"><span class="summary-sig-name">_handle_close</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_handle_eof"></a><span class="summary-sig"><span class="summary-sig-name">_handle_eof</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_handle_request"></a><span class="summary-sig"><span class="summary-sig-name">_handle_request</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_log"></a><span class="summary-sig"><span class="summary-sig-name">_log</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>level</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_request_failed"></a><span class="summary-sig"><span class="summary-sig-name">_request_failed</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_request_success"></a><span class="summary-sig"><span class="summary-sig-name">_request_success</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_send_eof"></a><span class="summary-sig"><span class="summary-sig-name">_send_eof</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><a name="_set_closed"></a><span class="summary-sig"><span class="summary-sig-name">_set_closed</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><a name="_set_remote_channel"></a><span class="summary-sig"><span class="summary-sig-name">_set_remote_channel</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>chanid</span>, + <span class=summary-sig-arg>window_size</span>, + <span class=summary-sig-arg>max_packet_size</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_set_transport"></a><span class="summary-sig"><span class="summary-sig-name">_set_transport</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>transport</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_set_window"></a><span class="summary-sig"><span class="summary-sig-name">_set_window</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>window_size</span>, + <span class=summary-sig-arg>max_packet_size</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_unlink"></a><span class="summary-sig"><span class="summary-sig-name">_unlink</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="../private/paramiko.Channel-class.html#_wait_for_send_window" class="summary-sig-name"><code>_wait_for_send_window</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +(You are already holding the lock.) Wait for the send window to open +up, and allocate up to <code>size</code> bytes for transmission.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_window_adjust"></a><span class="summary-sig"><span class="summary-sig-name">_window_adjust</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>int</code></font></td> +<td><b><a href="paramiko.Channel-class.html#MIN_PACKET_SIZE"><code>MIN_PACKET_SIZE</code></a></b> = <span title="1024">1024 </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>chanid</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new channel. The channel is not associated with any + particular session or <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> until the Transport attaches + it. Normally you would only call this method from the constructor of a + subclass of <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>chanid</b></code> - + the ID of this channel, as passed by an existing <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + Return a string representation of this object, for debugging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + str + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close the channel. All future read/write operations on the channel + will fail. The remote end will receive no more data (after queued data + is flushed). Channels are automatically closed when their <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> is closed or when they are + garbage collected. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="exec_command"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">exec_command</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>command</span>)</span> + </h3> + <p>Execute a command on the server. If the server allows it, the + channel will then be directly connected to the stdin, stdout, and + stderr of the command being executed.</p> + When the command finishes executing, the channel will be closed and + can't be reused. You must open a new channel if you wish to execute + another command. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>command</b></code> - + a shell command to execute. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="fileno"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">fileno</span>(<span class=sig-arg>self</span>)</span> + </h3> + <p>Returns an OS-level file descriptor which can be used for polling, + but but <i>not</i> for reading or writing). This is primaily to allow + python's <code>select</code> module to work.</p> + The first time <code>fileno</code> is called on a channel, a pipe is + created to simulate real OS-level file descriptor (FD) behavior. + Because of this, two OS-level FDs are created, which will use up FDs + faster than normal. You won't notice this effect unless you open + hundreds or thousands of channels simultaneously, but it's still + notable. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an OS-level file descriptor + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Warning:</b> This method causes channel reads to be slightly less efficient. +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_id"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_id</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the ID # for this channel. The channel ID is unique across a + <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> and usually a small number. + It's also the number passed to <a + href="../private/paramiko.ServerInterface-class.html#check_channel_request" + class="link"><code>ServerInterface.check_channel_request</code></a> + when determining whether to accept a channel request in server + mode. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the ID of this channel. + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> ivysaur +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Get the name of this channel that was previously set by <a + href="paramiko.Channel-class.html#set_name" + class="link"><code>set_name</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the name of this channel. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_pty"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_pty</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>term</span>=<span class=sig-default>'vt100'</span>, + <span class=sig-arg>width</span>=<span class=sig-default>80</span>, + <span class=sig-arg>height</span>=<span class=sig-default>24</span>)</span> + </h3> + Request a pseudo-terminal from the server. This is usually used + right after creating a client channel, to ask the server to provide + some basic terminal semantics for a shell invoked with <a + href="paramiko.Channel-class.html#invoke_shell" + class="link"><code>invoke_shell</code></a>. It isn't necessary (or + desirable) to call this method if you're going to exectue a single + command with <a href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>term</b></code> - + the terminal type to emulate (for example, + <code>'vt100'</code>). + <br /><i> + (type=str)</i> + <dd><code><b>width</b></code> - + width (in characters) of the terminal screen + <br /><i> + (type=int)</i> + <dd><code><b>height</b></code> - + height (in characters) of the terminal screen + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_transport"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_transport</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> associated with this + channel. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> that was used to create + this channel. + <br /><i> + (type=<a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="gettimeout"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">gettimeout</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns the timeout in seconds (as a float) associated with socket + operations, or <code>None</code> if no timeout is set. This reflects + the last call to <a href="paramiko.Channel-class.html#setblocking" + class="link"><code>setblocking</code></a> or <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + timeout in seconds, or <code>None</code>. + <br /><i> + (type=float)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="invoke_shell"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">invoke_shell</span>(<span class=sig-arg>self</span>)</span> + </h3> + <p>Request an interactive shell session on this channel. If the server + allows it, the channel will then be directly connected to the stdin, + stdout, and stderr of the shell.</p> + <p>Normally you would call <a + href="paramiko.Channel-class.html#get_pty" + class="link"><code>get_pty</code></a> before this, in which case the + shell will operate through the pty, and the channel will be connected + to the stdin and stdout of the pty.</p> + When the shell exits, the channel will be closed and can't be + reused. You must open a new channel if you wish to open another + shell. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="invoke_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">invoke_subsystem</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>subsystem</span>)</span> + </h3> + <p>Request a subsystem on the server (for example, <code>sftp</code>). + If the server allows it, the channel will then be directly connected to + the requested subsystem.</p> + When the subsystem finishes, the channel will be closed and can't be + reused. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>subsystem</b></code> - + name of the subsystem being requested. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="makefile"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">makefile</span>(<span class=sig-arg>self</span>, + <span class="sig-vararg">*params</span>)</span> + </h3> + Return a file-like object associated with this channel. The optional + <code>mode</code> and <code>bufsize</code> arguments are interpreted + the same way as by the built-in <code>file()</code> function in + python. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + object which can be used for python file I/O. + <br /><i> + (type=<a href="../private/paramiko.ChannelFile-class.html" + class="link"><code>ChannelFile</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="makefile_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">makefile_stderr</span>(<span class=sig-arg>self</span>, + <span class="sig-vararg">*params</span>)</span> + </h3> + <p>Return a file-like object associated with this channel's stderr + stream. Only channels using <a + href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a> or <a + href="paramiko.Channel-class.html#invoke_shell" + class="link"><code>invoke_shell</code></a> without a pty will ever have + data on the stderr stream.</p> + The optional <code>mode</code> and <code>bufsize</code> arguments + are interpreted the same way as by the built-in <code>file()</code> + function in python. For a client, it only makes sense to open this file + for reading. For a server, it only makes sense to open this file for + writing. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + object which can be used for python file I/O. + <br /><i> + (type=<a href="../private/paramiko.ChannelFile-class.html" + class="link"><code>ChannelFile</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="recv"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>nbytes</span>)</span> + </h3> + Receive data from the channel. The return value is a string + representing the data received. The maximum amount of data to be + received at once is specified by <code>nbytes</code>. If a string of + length zero is returned, the channel stream has closed. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>nbytes</b></code> - + maximum number of bytes to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + data. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if no data is ready before the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + </dl> + </dd></dl> +</td></tr></table> + +<a name="recv_exit_status"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv_exit_status</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the exit status from the process on the server. This is + mostly useful for retrieving the reults of an <a + href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a>. If the command hasn't + finished yet, this method will wait until it does, or until the channel + is closed. If no exit status is provided by the server, -1 is + returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the exit code of the process on the server. + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="recv_ready"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv_ready</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns true if data is buffered and ready to be read from this + channel. A <code>False</code> result does not mean that the channel has + closed; it means you may need to wait before more data arrives. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if a <a + href="paramiko.Channel-class.html#recv" + class="link"><code>recv</code></a> call on this channel would + immediately return at least one byte; <code>False</code> + otherwise. + <br /><i> + (type=boolean)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="recv_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv_stderr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>nbytes</span>)</span> + </h3> + Receive data from the channel's stderr stream. Only channels using + <a href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a> or <a + href="paramiko.Channel-class.html#invoke_shell" + class="link"><code>invoke_shell</code></a> without a pty will ever have + data on the stderr stream. The return value is a string representing + the data received. The maximum amount of data to be received at once is + specified by <code>nbytes</code>. If a string of length zero is + returned, the channel stream has closed. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>nbytes</b></code> - + maximum number of bytes to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + data. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if no data is ready before the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="recv_stderr_ready"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv_stderr_ready</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns true if data is buffered and ready to be read from this + channel's stderr stream. Only channels using <a + href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a> or <a + href="paramiko.Channel-class.html#invoke_shell" + class="link"><code>invoke_shell</code></a> without a pty will ever have + data on the stderr stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if a <a + href="paramiko.Channel-class.html#recv_stderr" + class="link"><code>recv_stderr</code></a> call on this channel + would immediately return at least one byte; <code>False</code> + otherwise. + <br /><i> + (type=boolean)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="resize_pty"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">resize_pty</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>width</span>=<span class=sig-default>80</span>, + <span class=sig-arg>height</span>=<span class=sig-default>24</span>)</span> + </h3> + Resize the pseudo-terminal. This can be used to change the width and + height of the terminal emulation created in a previous <a + href="paramiko.Channel-class.html#get_pty" + class="link"><code>get_pty</code></a> call. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>width</b></code> - + new width (in characters) of the terminal screen + <br /><i> + (type=int)</i> + <dd><code><b>height</b></code> - + new height (in characters) of the terminal screen + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="send"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">send</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Send data to the channel. Returns the number of bytes sent, or 0 if + the channel stream is closed. Applications are responsible for checking + that all data has been sent: if only some of the data was transmitted, + the application needs to attempt delivery of the remaining data. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + data to send. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + number of bytes actually sent. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if no data could be sent before the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + </dl> + </dd></dl> +</td></tr></table> + +<a name="send_exit_status"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">send_exit_status</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>status</span>)</span> + </h3> + Send the exit status of an executed command to the client. (This + really only makes sense in server mode.) Many clients expect to get + some sort of status code back from an executed command after it + completes. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>status</b></code> - + the exit code of the process + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="send_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">send_stderr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Send data to the channel on the "stderr" stream. This is + normally only used by servers to send output from shell commands -- + clients won't use this. Returns the number of bytes sent, or 0 if the + channel stream is closed. Applications are responsible for checking + that all data has been sent: if only some of the data was transmitted, + the application needs to attempt delivery of the remaining data. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + data to send. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + number of bytes actually sent. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if no data could be sent before the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="sendall"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">sendall</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Send data to the channel, without allowing partial results. Unlike + <a href="paramiko.Channel-class.html#send" + class="link"><code>send</code></a>, this method continues to send data + from the given string until either all data has been sent or an error + occurs. Nothing is returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + data to send. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if sending stalled for longer than the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + <dd><code><b>socket.error</b></code> - + if an error occured before the entire string was sent. + </dl> +<p><b>Note:</b> If the channel is closed while only part of the data hase been sent, +there is no way to determine how much data (if any) was sent. This is +irritating, but identically follows python's API. +</p> + + </dd></dl> +</td></tr></table> + +<a name="sendall_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">sendall_stderr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Send data to the channel's "stderr" stream, without + allowing partial results. Unlike <a + href="paramiko.Channel-class.html#send_stderr" + class="link"><code>send_stderr</code></a>, this method continues to + send data from the given string until all data has been sent or an + error occurs. Nothing is returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + data to send to the client as "stderr" output. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if sending stalled for longer than the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + <dd><code><b>socket.error</b></code> - + if an error occured before the entire string was sent. + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_combine_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_combine_stderr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>combine</span>)</span> + </h3> + <p>Set whether stderr should be combined into stdout on this channel. + The default is <code>False</code>, but in some cases it may be + convenient to have both streams combined.</p> + <p>If this is <code>False</code>, and <a + href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a> is called (or + <code>invoke_shell</code> with no pty), output to stderr will not show + up through the <a href="paramiko.Channel-class.html#recv" + class="link"><code>recv</code></a> and <a + href="paramiko.Channel-class.html#recv_ready" + class="link"><code>recv_ready</code></a> calls. You will have to use <a + href="paramiko.Channel-class.html#recv_stderr" + class="link"><code>recv_stderr</code></a> and <a + href="paramiko.Channel-class.html#recv_stderr_ready" + class="link"><code>recv_stderr_ready</code></a> to get stderr + output.</p> + If this is <code>True</code>, data will never show up via <a + href="paramiko.Channel-class.html#recv_stderr" + class="link"><code>recv_stderr</code></a> or <a + href="paramiko.Channel-class.html#recv_stderr_ready" + class="link"><code>recv_stderr_ready</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>combine</b></code> - + <code>True</code> if stderr output should be combined into + stdout on this channel. + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + previous setting. + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_name</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>)</span> + </h3> + Set a name for this channel. Currently it's only used to set the + name of the log level used for debugging. The name can be fetched with + the <a href="paramiko.Channel-class.html#get_name" + class="link"><code>get_name</code></a> method. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + new channel name. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="setblocking"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">setblocking</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>blocking</span>)</span> + </h3> + <p>Set blocking or non-blocking mode of the channel: if + <code>blocking</code> is 0, the channel is set to non-blocking mode; + otherwise it's set to blocking mode. Initially all channels are in + blocking mode.</p> + <p>In non-blocking mode, if a <a + href="paramiko.Channel-class.html#recv" + class="link"><code>recv</code></a> call doesn't find any data, or if a + <a href="paramiko.Channel-class.html#send" + class="link"><code>send</code></a> call can't immediately dispose of + the data, an error exception is raised. In blocking mode, the calls + block until they can proceed.</p> + <code>chan.setblocking(0)</code> is equivalent to + <code>chan.settimeout(0)</code>; <code>chan.setblocking(1)</code> is + equivalent to <code>chan.settimeout(None)</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>blocking</b></code> - + 0 to set non-blocking mode; non-0 to set blocking mode. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="settimeout"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">settimeout</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>timeout</span>)</span> + </h3> + <p>Set a timeout on blocking read/write operations. The + <code>timeout</code> argument can be a nonnegative float expressing + seconds, or <code>None</code>. If a float is given, subsequent channel + read/write operations will raise a timeout exception if the timeout + period value has elapsed before the operation has completed. Setting a + timeout of <code>None</code> disables timeouts on socket + operations.</p> + <code>chan.settimeout(0.0)</code> is equivalent to + <code>chan.setblocking(0)</code>; <code>chan.settimeout(None)</code> is + equivalent to <code>chan.setblocking(1)</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>timeout</b></code> - + seconds to wait for a pending read/write operation before + raising <code>socket.timeout</code>, or <code>None</code> for no + timeout. + <br /><i> + (type=float)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="shutdown"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">shutdown</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>how</span>)</span> + </h3> + Shut down one or both halves of the connection. If <code>how</code> + is 0, further receives are disallowed. If <code>how</code> is 1, + further sends are disallowed. If <code>how</code> is 2, further sends + and receives are disallowed. This closes the stream in one or both + directions. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>how</b></code> - + 0 (stop receiving), 1 (stop sending), or 2 (stop receiving and + sending). + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="shutdown_read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">shutdown_read</span>(<span class=sig-arg>self</span>)</span> + </h3> + Shutdown the receiving side of this socket, closing the stream in + the incoming direction. After this call, future reads on this channel + will fail instantly. This is a convenience method, equivalent to + <code>shutdown(0)</code>, for people who don't make it a habit to + memorize unix constants from the 1970s. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="shutdown_write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">shutdown_write</span>(<span class=sig-arg>self</span>)</span> + </h3> + Shutdown the sending side of this socket, closing the stream in the + outgoing direction. After this call, future writes on this channel will + fail instantly. This is a convenience method, equivalent to + <code>shutdown(1)</code>, for people who don't make it a habit to + memorize unix constants from the 1970s. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="_wait_for_send_window"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_wait_for_send_window</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>size</span>)</span> + </h3> + (You are already holding the lock.) Wait for the send window to open + up, and allocate up to <code>size</code> bytes for transmission. If no + space opens up before the timeout, a timeout exception is raised. + Returns the number of bytes available to send (may be less than + requested). + <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="MIN_PACKET_SIZE"></a> +<h3>MIN_PACKET_SIZE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1024"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1024 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.ChannelFile-class.html b/docs/private/paramiko.ChannelFile-class.html new file mode 100644 index 0000000..c3c4fea --- /dev/null +++ b/docs/private/paramiko.ChannelFile-class.html @@ -0,0 +1,347 @@ +<?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>paramiko.ChannelFile</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class ChannelFile + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.ChannelFile-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type ChannelFile</h2> + +<pre class="base-tree"> + <a href="__builtin__.object-class.html"><code>object</code></a> --+ + | +<a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a> --+ + | + <b>ChannelFile</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="../private/paramiko.channel.ChannelStderrFile-class.html"><code>ChannelStderrFile</code></a></dd></dl> + +<hr/> + +A file-like wrapper around <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>. A ChannelFile is created by +calling <a href="paramiko.Channel-class.html#makefile" +class="link"><code>Channel.makefile</code></a>. +<hr/> + +<p><b>Bug:</b> To correctly emulate the file object created from a socket's +<code>makefile</code> method, a <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a> and its <code>ChannelFile</code> +should be able to be closed or garbage-collected independently. +Currently, closing the <code>ChannelFile</code> does nothing but flush +the buffer. +</p> + + +<!-- =========== 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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns a string representation of this object, for debugging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.html#_read" class="summary-sig-name"><code>_read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +<i>(subclass override)</i> Read data from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.html#_write" class="summary-sig-name"><code>_write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +<i>(subclass override)</i> Write data into the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.html#seek" class="summary-sig-name"><code>seek</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>whence</span>)</span></code> +<br /> +Set the file's current position, like stdio's <code>fseek</code>.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BufferedFile</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__del__" class="summary-sig-name"><code>__del__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns an iterator that can be used to iterate over the lines in this +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#flush" class="summary-sig-name"><code>flush</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Write out any data in the write buffer.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#next" class="summary-sig-name"><code>next</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the next line from the input, or raises +<code>StopIteration</code> when EOF is hit.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read at most <code>size</code> bytes from the file (less if we hit the +end of the file first).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readline" class="summary-sig-name"><code>readline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read one entire line from the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readlines" class="summary-sig-name"><code>readlines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sizehint</span>)</span></code> +<br /> +Read all remaining lines using <a +href="paramiko.BufferedFile-class.html#readline" +class="link"><code>readline</code></a> and return them as a list.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#tell" class="summary-sig-name"><code>tell</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the file's current position.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Write data to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#writelines" class="summary-sig-name"><code>writelines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sequence</span>)</span></code> +<br /> +Write a sequence of strings to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#xreadlines" class="summary-sig-name"><code>xreadlines</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Identical to <code>iter(f)</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_get_size" class="summary-sig-name"><code>_get_size</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +<i>(subclass override)</i> Return the size of the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_record_newline" class="summary-sig-name"><code>_record_newline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>newline</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="../private/paramiko.BufferedFile-class.html#_set_mode" class="summary-sig-name"><code>_set_mode</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Subclasses call this method to initialize the BufferedFile.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_write_all" class="summary-sig-name"><code>_write_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BufferedFile</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></b> = <span title="0">0 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.BufferedFile-class.html#_DEFAULT_BUFSIZE"><code>_DEFAULT_BUFSIZE</code></a></b> = <span title="8192">8192 </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="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + Returns a string representation of this object, for debugging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + str + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_read</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>size</span>)</span> + </h3> + <i>(subclass override)</i> Read data from the stream. Return + <code>None</code> or raise <code>EOFError</code> to indicate EOF. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.BufferedFile-class.html#_read"><code>paramiko.BufferedFile._read</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_write</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>)</span> + </h3> + <i>(subclass override)</i> Write data into the stream. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.BufferedFile-class.html#_write"><code>paramiko.BufferedFile._write</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="seek"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">seek</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>offset</span>, + <span class=sig-arg>whence</span>=<span class=sig-default>0</span>)</span> + </h3> + Set the file's current position, like stdio's <code>fseek</code>. + Not all file objects support seeking. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>offset</b></code> - + position to move to within the file, relative to + <code>whence</code>. + <br /><i> + (type=int)</i> + <dd><code><b>whence</b></code> - + type of movement: 0 = absolute; 1 = relative to the current + position; 2 = relative to the end of the file. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the file doesn't support random access. + </dl> +<p><b>Note:</b> If a file is opened in append mode (<code>'a'</code> or +<code>'a+'</code>), any seek operations will be undone at the next write +(as the file position will move back to the end of the file). +</p> + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.DSSKey-class.html b/docs/private/paramiko.DSSKey-class.html new file mode 100644 index 0000000..9d87ee1 --- /dev/null +++ b/docs/private/paramiko.DSSKey-class.html @@ -0,0 +1,486 @@ +<?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>paramiko.DSSKey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class DSSKey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.DSSKey-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.DSSKey-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type DSSKey</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.PKey-class.html"><code>PKey</code></a> --+ + | + <b>DSSKey</b> +</pre><br /> + +<hr/> + +Representation of a DSS key which can be used to sign an verify SSH2 +data. +<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="paramiko.DSSKey-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Create a new instance of this public key type.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__hash__"></a><span class="summary-sig"><span class="summary-sig-name">__hash__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string of an SSH <a href="paramiko.Message-class.html" +class="link"><code>Message</code></a> made up of the public part(s) of +this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#can_sign" class="summary-sig-name"><code>can_sign</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return <code>True</code> if this key has the private part necessary +for signing data.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.DSSKey-class.html" + class="link"><code>DSSKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#generate" class="summary-sig-name"><code>generate</code></a>(<span class=summary-sig-arg>bits</span>, + <span class=summary-sig-arg>progress_func</span>)</span></code> +<br /> +Generate a new private DSS key. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#get_bits" class="summary-sig-name"><code>get_bits</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the number of significant bits in this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the name of this private key implementation.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="sign_ssh_data"></a><span class="summary-sig"><span class="summary-sig-name">sign_ssh_data</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>rpool</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#verify_ssh_sig" class="summary-sig-name"><code>verify_ssh_sig</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +<br /> +Given a blob of data, and an SSH message representing a signature of +that data, verify that it was signed with this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#write_private_key_file" class="summary-sig-name"><code>write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write private key contents into a file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_from_private_key_file"></a><span class="summary-sig"><span class="summary-sig-name">_from_private_key_file</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from PKey</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#__cmp__" class="summary-sig-name"><code>__cmp__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>other</span>)</span></code> +<br /> +Compare this key to another.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#_read_private_key_file" class="summary-sig-name"><code>_read_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>tag</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Read an SSH2-format private key file, looking for a string of the type +<code>"BEGIN xxx PRIVATE KEY"</code> for some <code>xxx</code>, +base64-decode the text we find, and return it as a string.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#_write_private_key_file" class="summary-sig-name"><code>_write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>tag</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write an SSH2-format private key file in a form that can be read by +paramiko or openssh.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#from_private_key_file" class="summary-sig-name"><code>from_private_key_file</code></a>(<span class=summary-sig-arg>cl</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Create a key object by reading a private key file. <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_base64" class="summary-sig-name"><code>get_base64</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a base64 string containing the public part of this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_fingerprint" class="summary-sig-name"><code>get_fingerprint</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return an MD5 fingerprint of the public part of this key.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from PKey</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.PKey-class.html#_CIPHER_TABLE"><code>_CIPHER_TABLE</code></a></b> = <span title="{'DES-EDE3-CBC': {'blocksize': 8, 'cipher': <module 'Crypto.Cipher.DES3' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/DES3.so'>, 'keysize': 24, 'mode': 2}}"><code>{'DES-EDE3-CBC': {'blocksize': 8, 'ciphe<span class="variable-ellipsis">...</span></code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>msg</span>=<span class=sig-default>None</span>, + <span class=sig-arg>data</span>=<span class=sig-default>None</span>, + <span class=sig-arg>filename</span>=<span class=sig-default>None</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>, + <span class=sig-arg>vals</span>=<span class=sig-default>None</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new instance of this public key type. If <code>msg</code> + is given, the key's public part(s) will be filled in from the message. + If <code>data</code> is given, the key's public part(s) will be filled + in from the string. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>msg</b></code> - + an optional SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> containing a public key of + this type. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + <dd><code><b>data</b></code> - + an optional string containing a public key of this type + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if a key cannot be created from the <code>data</code> or + <code>msg</code> given, or no key was passed in. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__init__"><code>paramiko.PKey.__init__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return a string of an SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> made up of the public part(s) of + this key. This string is suitable for passing to <a + href="../private/paramiko.PKey-class.html#__init__" + class="link"><code>__init__</code></a> to re-create the key object + later. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string representation of an SSH key message. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__str__"><code>paramiko.PKey.__str__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="can_sign"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">can_sign</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return <code>True</code> if this key has the private part necessary + for signing data. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if this is a private key. + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#can_sign"><code>paramiko.PKey.can_sign</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_bits"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_bits</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the number of significant bits in this key. This is useful + for judging the relative security of a key. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + bits in the key. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_bits"><code>paramiko.PKey.get_bits</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the name of this private key implementation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + name of this private key type, in SSH terminology (for + example, <code>"ssh-rsa"</code>). + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_name"><code>paramiko.PKey.get_name</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="verify_ssh_sig"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">verify_ssh_sig</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>, + <span class=sig-arg>msg</span>)</span> + </h3> + Given a blob of data, and an SSH message representing a signature of + that data, verify that it was signed with this key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>data</b></code> - + the data that was signed. + <br /><i> + (type=str)</i> + <dd><code><b>msg</b></code> - + an SSH signature message + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the signature verifies correctly; + <code>False</code> otherwise. + <br /><i> + (type=boolean)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#verify_ssh_sig"><code>paramiko.PKey.verify_ssh_sig</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="write_private_key_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">write_private_key_file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>)</span> + </h3> + Write private key contents into a file. If the password is not + <code>None</code>, the key is encrypted before writing. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to write. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + an optional password to use to encrypt the key file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if there was an error writing the file. + <dd><code><b>SSHException</b></code> - + if the key is invalid. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#write_private_key_file"><code>paramiko.PKey.write_private_key_file</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF STATIC METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Static Method Details</th></tr> +</table> + +<a name="generate"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">generate</span>(<span class=sig-arg>bits</span>=<span class=sig-default>1024</span>, + <span class=sig-arg>progress_func</span>=<span class=sig-default>None</span>)</span> + </h3> + Generate a new private DSS key. This factory function can be used to + generate a new host key or authentication key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>bits</b></code> - + number of bits the generated key should be. + <br /><i> + (type=int)</i> + <dd><code><b>progress_func</b></code> - + an optional function to call at key points in key generation + (used by <code>pyCrypto.PublicKey</code>). + <br /><i> + (type=function)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + new private key + <br /><i> + (type=<a href="paramiko.DSSKey-class.html" + class="link"><code>DSSKey</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.Message-class.html b/docs/private/paramiko.Message-class.html new file mode 100644 index 0000000..d6934e3 --- /dev/null +++ b/docs/private/paramiko.Message-class.html @@ -0,0 +1,654 @@ +<?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>paramiko.Message</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Message + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.Message-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Message-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Message</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>Message</b> +</pre><br /> + +<hr/> + +<p>An SSH2 <i>Message</i> is a stream of bytes that encodes some +combination of strings, integers, bools, and infinite-precision integers +(known in python as <i>long</i>s). This class builds or breaks down such +a byte stream.</p> +Normally you don't need to deal with anything this low-level, but it's +exposed for people implementing custom extensions, or features that +paramiko doesn't support yet. +<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="paramiko.Message-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>content</span>)</span></code> +<br /> +Create a new SSH2 Message.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns a string representation of this object, for debugging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the byte stream content of this Message, as a string.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add" class="summary-sig-name"><code>add</code></a>(<span class=summary-sig-arg>self</span>, + <span class="summary-sig-vararg">*seq</span>)</span></code> +<br /> +Add a sequence of items to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_boolean" class="summary-sig-name"><code>add_boolean</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>b</span>)</span></code> +<br /> +Add a boolean value to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_byte" class="summary-sig-name"><code>add_byte</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>b</span>)</span></code> +<br /> +Write a single byte to the stream, without any formatting.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_bytes" class="summary-sig-name"><code>add_bytes</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>b</span>)</span></code> +<br /> +Write bytes to the stream, without any formatting.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_int" class="summary-sig-name"><code>add_int</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>)</span></code> +<br /> +Add an integer to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_int64" class="summary-sig-name"><code>add_int64</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>)</span></code> +<br /> +Add a 64-bit int to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_list" class="summary-sig-name"><code>add_list</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>l</span>)</span></code> +<br /> +Add a list of strings to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_mpint" class="summary-sig-name"><code>add_mpint</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>z</span>)</span></code> +<br /> +Add a long int to the stream, encoded as an infinite-precision +integer.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_string" class="summary-sig-name"><code>add_string</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Add a string to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_boolean" class="summary-sig-name"><code>get_boolean</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a boolean from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_byte" class="summary-sig-name"><code>get_byte</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the next byte of the Message, without decomposing it.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_bytes" class="summary-sig-name"><code>get_bytes</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>)</span></code> +<br /> +Return the next <code>n</code> bytes of the Message, without +decomposing into an int, string, etc.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_int" class="summary-sig-name"><code>get_int</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch an int from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> long +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_int64" class="summary-sig-name"><code>get_int64</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a 64-bit int from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of strings +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_list" class="summary-sig-name"><code>get_list</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a list of strings from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> long +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_mpint" class="summary-sig-name"><code>get_mpint</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a long int (mpint) from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_remainder" class="summary-sig-name"><code>get_remainder</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the bytes of this Message that haven't already been parsed and +returned.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_so_far" class="summary-sig-name"><code>get_so_far</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the bytes of this Message that have been parsed and +returned.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_string" class="summary-sig-name"><code>get_string</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a string from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#rewind" class="summary-sig-name"><code>rewind</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Rewind the message to the beginning as if no items had been parsed out +of it yet.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_add"></a><span class="summary-sig"><span class="summary-sig-name">_add</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>i</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</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>content</span>=<span class=sig-default>None</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new SSH2 Message. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>content</b></code> - + the byte stream to use as the Message content (passed in only + when decomposing a Message). + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + Returns a string representation of this object, for debugging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return the byte stream content of this Message, as a string. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the contents of this Message. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add</span>(<span class=sig-arg>self</span>, + <span class="sig-vararg">*seq</span>)</span> + </h3> + Add a sequence of items to the stream. The values are encoded based + on their type: str, int, bool, list, or long. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>seq</b></code> - + the sequence of items + <br /><i> + (type=sequence)</i> + </dd> + </dl> +<p><b>Bug:</b> longs are encoded non-deterministically. Don't use this method. +</p> + + </dd></dl> +</td></tr></table> + +<a name="add_boolean"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_boolean</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>b</span>)</span> + </h3> + Add a boolean value to the stream. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>b</b></code> - + boolean value to add + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_byte"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_byte</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>b</span>)</span> + </h3> + Write a single byte to the stream, without any formatting. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>b</b></code> - + byte to add + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_bytes"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_bytes</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>b</span>)</span> + </h3> + Write bytes to the stream, without any formatting. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>b</b></code> - + bytes to add + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_int"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_int</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>n</span>)</span> + </h3> + Add an integer to the stream. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>n</b></code> - + integer to add + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_int64"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_int64</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>n</span>)</span> + </h3> + Add a 64-bit int to the stream. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>n</b></code> - + long int to add + <br /><i> + (type=long)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_list"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_list</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>l</span>)</span> + </h3> + Add a list of strings to the stream. They are encoded identically to + a single string of values separated by commas. (Yes, really, that's how + SSH2 does it.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>l</b></code> - + list of strings to add + <br /><i> + (type=list(str))</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_mpint"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_mpint</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>z</span>)</span> + </h3> + Add a long int to the stream, encoded as an infinite-precision + integer. This method only works on positive numbers. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>z</b></code> - + long int to add + <br /><i> + (type=long)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_string"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_string</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Add a string to the stream. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + string to add + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_boolean"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_boolean</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a boolean from the stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> or <code>False</code> (from the + Message). + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_byte"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_byte</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the next byte of the Message, without decomposing it. This is + equivalent to <a href="paramiko.Message-class.html#get_bytes" + class="link"><code>get_bytes(1)</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the next byte of the Message, or <code>' + aren't any bytes remaining. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_bytes"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_bytes</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>n</span>)</span> + </h3> + Return the next <code>n</code> bytes of the Message, without + decomposing into an int, string, etc. Just the raw bytes are + returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a string of the next <code>n</code> bytes of the Message, or a + string of <code>n</code> zero bytes, if there aren't + <code>n</code> bytes remaining. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_int"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_int</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch an int from the stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a 32-bit unsigned integer. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_int64"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_int64</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a 64-bit int from the stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a 64-bit unsigned integer. + <br /><i> + (type=long)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_list"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_list</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a list of strings from the stream. These are trivially encoded + as comma-separated values in a string. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a list of strings. + <br /><i> + (type=list of strings)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_mpint"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_mpint</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a long int (mpint) from the stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an arbitrary-length integer. + <br /><i> + (type=long)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_remainder"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_remainder</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the bytes of this Message that haven't already been parsed + and returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a string of the bytes not parsed yet. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_so_far"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_so_far</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns the bytes of this Message that have been parsed and + returned. The string passed into a Message's constructor can be + regenerated by concatenating <code>get_so_far</code> and <a + href="paramiko.Message-class.html#get_remainder" + class="link"><code>get_remainder</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a string of the bytes parsed so far. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_string"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_string</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a string from the stream. This could be a byte string and may + contain unprintable characters. (It's not unheard of for a string to + contain another byte-stream Message.) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a string. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="rewind"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">rewind</span>(<span class=sig-arg>self</span>)</span> + </h3> + Rewind the message to the beginning as if no items had been parsed + out of it yet. + <dl><dt></dt><dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/paramiko.PKey-class.html b/docs/private/paramiko.PKey-class.html new file mode 100644 index 0000000..3ed3e5f --- /dev/null +++ b/docs/private/paramiko.PKey-class.html @@ -0,0 +1,696 @@ +<?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>paramiko.PKey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class PKey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.PKey-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type PKey</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>PKey</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.AgentKey-class.html"><code>AgentKey</code></a>, + <a href="paramiko.DSSKey-class.html"><code>DSSKey</code></a>, + <a href="paramiko.RSAKey-class.html"><code>RSAKey</code></a></dd></dl> + +<hr/> + +Base class for public keys. +<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="../private/paramiko.PKey-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Create a new instance of this public key type.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#__cmp__" class="summary-sig-name"><code>__cmp__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>other</span>)</span></code> +<br /> +Compare this key to another.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string of an SSH <a href="paramiko.Message-class.html" +class="link"><code>Message</code></a> made up of the public part(s) of +this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#_read_private_key_file" class="summary-sig-name"><code>_read_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>tag</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Read an SSH2-format private key file, looking for a string of the type +<code>"BEGIN xxx PRIVATE KEY"</code> for some <code>xxx</code>, +base64-decode the text we find, and return it as a string.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#_write_private_key_file" class="summary-sig-name"><code>_write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>tag</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write an SSH2-format private key file in a form that can be read by +paramiko or openssh.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#can_sign" class="summary-sig-name"><code>can_sign</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return <code>True</code> if this key has the private part necessary +for signing data.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#from_private_key_file" class="summary-sig-name"><code>from_private_key_file</code></a>(<span class=summary-sig-arg>cl</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Create a key object by reading a private key file. <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_base64" class="summary-sig-name"><code>get_base64</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a base64 string containing the public part of this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_bits" class="summary-sig-name"><code>get_bits</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the number of significant bits in this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_fingerprint" class="summary-sig-name"><code>get_fingerprint</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return an MD5 fingerprint of the public part of this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the name of this private key implementation.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#sign_ssh_data" class="summary-sig-name"><code>sign_ssh_data</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>randpool</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Sign a blob of data with this private key, and return a <a +href="paramiko.Message-class.html" class="link"><code>Message</code></a> +representing an SSH signature message.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#verify_ssh_sig" class="summary-sig-name"><code>verify_ssh_sig</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +<br /> +Given a blob of data, and an SSH message representing a signature of +that data, verify that it was signed with this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#write_private_key_file" class="summary-sig-name"><code>write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write private key contents into a file.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</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="../private/paramiko.PKey-class.html#_CIPHER_TABLE"><code>_CIPHER_TABLE</code></a></b> = <span title="{'DES-EDE3-CBC': {'blocksize': 8, 'cipher': <module 'Crypto.Cipher.DES3' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/DES3.so'>, 'keysize': 24, 'mode': 2}}"><code>{'DES-EDE3-CBC': {'blocksize': 8, 'ciphe<span class="variable-ellipsis">...</span></code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>msg</span>=<span class=sig-default>None</span>, + <span class=sig-arg>data</span>=<span class=sig-default>None</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new instance of this public key type. If <code>msg</code> + is given, the key's public part(s) will be filled in from the message. + If <code>data</code> is given, the key's public part(s) will be filled + in from the string. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>msg</b></code> - + an optional SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> containing a public key of + this type. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + <dd><code><b>data</b></code> - + an optional string containing a public key of this type + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if a key cannot be created from the <code>data</code> or + <code>msg</code> given, or no key was passed in. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__cmp__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__cmp__</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>other</span>)</span> + <br /><i>(Comparison operator)</i> + </h3> + Compare this key to another. Returns 0 if this key is equivalent to + the given key, or non-0 if they are different. Only the public parts of + the key are compared, so a public key will compare equal to its + corresponding private key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>other</b></code> - + key to compare to. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + 0 if the two keys are equivalent, non-0 otherwise. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return a string of an SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> made up of the public part(s) of + this key. This string is suitable for passing to <a + href="../private/paramiko.PKey-class.html#__init__" + class="link"><code>__init__</code></a> to re-create the key object + later. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string representation of an SSH key message. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_read_private_key_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_read_private_key_file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>tag</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>)</span> + </h3> + Read an SSH2-format private key file, looking for a string of the + type <code>"BEGIN xxx PRIVATE KEY"</code> for some + <code>xxx</code>, base64-decode the text we find, and return it as a + string. If the private key is encrypted and <code>password</code> is + not <code>None</code>, the given password will be used to decrypt the + key (otherwise <a href="paramiko.PasswordRequiredException-class.html" + class="link"><code>PasswordRequiredException</code></a> is thrown). + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>tag</b></code> - + <code>"RSA"</code> or <code>"DSA"</code>, + the tag used to mark the data block. + <br /><i> + (type=str)</i> + <dd><code><b>filename</b></code> - + name of the file to read. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + an optional password to use to decrypt the key file, if it's + encrypted. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + data blob that makes up the private key. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if there was an error reading the file. + <dd><code><b>PasswordRequiredException</b></code> - + if the private key file is encrypted, and + <code>password</code> is <code>None</code>. + <dd><code><b>SSHException</b></code> - + if the key file is invalid. + </dl> + </dd></dl> +</td></tr></table> + +<a name="_write_private_key_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_write_private_key_file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>tag</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>data</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>)</span> + </h3> + Write an SSH2-format private key file in a form that can be read by + paramiko or openssh. If no password is given, the key is written in a + trivially-encoded format (base64) which is completely insecure. If a + password is given, DES-EDE3-CBC is used. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>tag</b></code> - + <code>"RSA"</code> or <code>"DSA"</code>, + the tag used to mark the data block. + <br /><i> + (type=str)</i> + <dd><code><b>filename</b></code> - + name of the file to write. + <br /><i> + (type=str)</i> + <dd><code><b>data</b></code> - + data blob that makes up the private key. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + an optional password to use to encrypt the file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if there was an error writing the file. + </dl> + </dd></dl> +</td></tr></table> + +<a name="can_sign"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">can_sign</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return <code>True</code> if this key has the private part necessary + for signing data. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if this is a private key. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_base64"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_base64</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return a base64 string containing the public part of this key. + Nothing secret is revealed. This format is compatible with that used to + store public key files or recognized host keys. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a base64 string containing the public part of the key. + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_bits"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_bits</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the number of significant bits in this key. This is useful + for judging the relative security of a key. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + bits in the key. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_fingerprint"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_fingerprint</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return an MD5 fingerprint of the public part of this key. Nothing + secret is revealed. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a 16-byte string (binary) of the MD5 fingerprint, in SSH + format. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the name of this private key implementation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + name of this private key type, in SSH terminology (for + example, <code>"ssh-rsa"</code>). + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="sign_ssh_data"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">sign_ssh_data</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>randpool</span>, + <span class=sig-arg>data</span>)</span> + </h3> + Sign a blob of data with this private key, and return a <a + href="paramiko.Message-class.html" + class="link"><code>Message</code></a> representing an SSH signature + message. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>randpool</b></code> - + a secure random number generator. + <br /><i> + (type=<code>Crypto.Util.randpool.RandomPool</code>)</i> + <dd><code><b>data</b></code> - + the data to sign. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SSH signature message. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="verify_ssh_sig"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">verify_ssh_sig</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>, + <span class=sig-arg>msg</span>)</span> + </h3> + Given a blob of data, and an SSH message representing a signature of + that data, verify that it was signed with this key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>data</b></code> - + the data that was signed. + <br /><i> + (type=str)</i> + <dd><code><b>msg</b></code> - + an SSH signature message + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the signature verifies correctly; + <code>False</code> otherwise. + <br /><i> + (type=boolean)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="write_private_key_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">write_private_key_file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>)</span> + </h3> + Write private key contents into a file. If the password is not + <code>None</code>, the key is encrypted before writing. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to write. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + an optional password to use to encrypt the key file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if there was an error writing the file. + <dd><code><b>SSHException</b></code> - + if the key is invalid. + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF CLASS METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Class Method Details</th></tr> +</table> + +<a name="from_private_key_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">from_private_key_file</span>(<span class=sig-arg>cl</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>)</span> + </h3> + Create a key object by reading a private key file. If the private + key is encrypted and <code>password</code> is not <code>None</code>, + the given password will be used to decrypt the key (otherwise <a + href="paramiko.PasswordRequiredException-class.html" + class="link"><code>PasswordRequiredException</code></a> is thrown). + Through the magic of python, this factory method will exist in all + subclasses of PKey (such as <a href="paramiko.RSAKey-class.html" + class="link"><code>RSAKey</code></a> or <a + href="paramiko.DSSKey-class.html" + class="link"><code>DSSKey</code></a>), but is useless on the abstract + PKey class. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to read. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + an optional password to use to decrypt the key file, if it's + encrypted + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a new key object based on the given private key. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if there was an error reading the file. + <dd><code><b>PasswordRequiredException</b></code> - + if the private key file is encrypted, and + <code>password</code> is <code>None</code>. + <dd><code><b>SSHException</b></code> - + if the key file is invalid. + </dl> +<p><b>Since:</b> fearow +</p> + + </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="_CIPHER_TABLE"></a> +<h3>_CIPHER_TABLE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{'DES-EDE3-CBC': {'blocksize': 8, 'cipher': <module 'Crypto.Cipher.DES3' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/DES3.so'>, 'keysize': 24, 'mode': 2}}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{'DES-EDE3-CBC': {'blocksize': 8, + 'cipher': <module 'Crypto.Cipher.DES3' from '/usr/li<span class="variable-linewrap">\</span> +b/python2.4/site-packages/Crypto/Cipher/DES3.so'>, + 'keysize': 24, + 'mode': 2}} </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.Packetizer-class.html b/docs/private/paramiko.Packetizer-class.html new file mode 100644 index 0000000..f3be97b --- /dev/null +++ b/docs/private/paramiko.Packetizer-class.html @@ -0,0 +1,441 @@ +<?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>paramiko.Packetizer</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Packetizer + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.Packetizer-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Packetizer</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>Packetizer</b> +</pre><br /> + +<hr/> + +Implementation of the base SSH packet protocol. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>socket</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</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><a name="_build_packet"></a><span class="summary-sig"><span class="summary-sig-name">_build_packet</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>payload</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_check_keepalive"></a><span class="summary-sig"><span class="summary-sig-name">_check_keepalive</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><a name="_log"></a><span class="summary-sig"><span class="summary-sig-name">_log</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>level</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_py22_read_all"></a><span class="summary-sig"><span class="summary-sig-name">_py22_read_all</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_py22_read_timeout"></a><span class="summary-sig"><span class="summary-sig-name">_py22_read_timeout</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_read_timeout"></a><span class="summary-sig"><span class="summary-sig-name">_read_timeout</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_trigger_rekey"></a><span class="summary-sig"><span class="summary-sig-name">_trigger_rekey</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><a name="close"></a><span class="summary-sig"><span class="summary-sig-name">close</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><a name="get_hexdump"></a><span class="summary-sig"><span class="summary-sig-name">get_hexdump</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><a name="get_mac_size_in"></a><span class="summary-sig"><span class="summary-sig-name">get_mac_size_in</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><a name="get_mac_size_out"></a><span class="summary-sig"><span class="summary-sig-name">get_mac_size_out</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="../private/paramiko.Packetizer-class.html#need_rekey" class="summary-sig-name"><code>need_rekey</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns <code>True</code> if a new set of keys needs to be +negotiated.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Packetizer-class.html#read_all" class="summary-sig-name"><code>read_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>, + <span class=summary-sig-arg>check_rekey</span>)</span></code> +<br /> +Read as close to N bytes as possible, blocking as long as +necessary.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Packetizer-class.html#read_message" class="summary-sig-name"><code>read_message</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Only one thread should ever be in this function (no other locking is +done).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Packetizer-class.html#readline" class="summary-sig-name"><code>readline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +<br /> +Read a line from the socket.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Packetizer-class.html#send_message" class="summary-sig-name"><code>send_message</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Write a block of data using the current cipher, as an SSH block.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="set_hexdump"></a><span class="summary-sig"><span class="summary-sig-name">set_hexdump</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>hexdump</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="../private/paramiko.Packetizer-class.html#set_inbound_cipher" class="summary-sig-name"><code>set_inbound_cipher</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>block_engine</span>, + <span class=summary-sig-arg>block_size</span>, + <span class=summary-sig-arg>mac_engine</span>, + <span class=summary-sig-arg>mac_size</span>, + <span class=summary-sig-arg>mac_key</span>)</span></code> +<br /> +Switch inbound data cipher.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="set_inbound_compressor"></a><span class="summary-sig"><span class="summary-sig-name">set_inbound_compressor</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>compressor</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="../private/paramiko.Packetizer-class.html#set_keepalive" class="summary-sig-name"><code>set_keepalive</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>interval</span>, + <span class=summary-sig-arg>callback</span>)</span></code> +<br /> +Turn on/off the callback keepalive.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Packetizer-class.html#set_log" class="summary-sig-name"><code>set_log</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>log</span>)</span></code> +<br /> +Set the python log object to use for logging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Packetizer-class.html#set_outbound_cipher" class="summary-sig-name"><code>set_outbound_cipher</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>block_engine</span>, + <span class=summary-sig-arg>block_size</span>, + <span class=summary-sig-arg>mac_engine</span>, + <span class=summary-sig-arg>mac_size</span>, + <span class=summary-sig-arg>mac_key</span>)</span></code> +<br /> +Switch outbound data cipher.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="set_outbound_compressor"></a><span class="summary-sig"><span class="summary-sig-name">set_outbound_compressor</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>compressor</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="write_all"></a><span class="summary-sig"><span class="summary-sig-name">write_all</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>out</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>int</code></font></td> +<td><b><a href="../private/paramiko.Packetizer-class.html#REKEY_BYTES"><code>REKEY_BYTES</code></a></b> = <span title="1073741824">1073741824 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.Packetizer-class.html#REKEY_PACKETS"><code>REKEY_PACKETS</code></a></b> = <span title="1073741824">1073741824 </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="need_rekey"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">need_rekey</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns <code>True</code> if a new set of keys needs to be + negotiated. This will be triggered during a packet read or write, so it + should be checked after every read or write, or at least after every + few. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if a new set of keys needs to be + negotiated + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="read_all"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">read_all</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>n</span>, + <span class=sig-arg>check_rekey</span>=<span class=sig-default>False</span>)</span> + </h3> + Read as close to N bytes as possible, blocking as long as + necessary. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>n</b></code> - + number of bytes to read + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + the data read + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>EOFError</b></code> - + if the socket was closed before all the bytes could be + read + </dl> + </dd></dl> +</td></tr></table> + +<a name="read_message"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">read_message</span>(<span class=sig-arg>self</span>)</span> + </h3> + Only one thread should ever be in this function (no other locking is + done). + <dl><dt></dt><dd> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if the packet is mangled + <dd><code><b>NeedRekeyException</b></code> - + if the transport should rekey + </dl> + </dd></dl> +</td></tr></table> + +<a name="readline"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">readline</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>timeout</span>)</span> + </h3> + Read a line from the socket. This is done in a fairly inefficient + way, but is only used for initial banner negotiation so it's not worth + optimising. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="send_message"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">send_message</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>)</span> + </h3> + Write a block of data using the current cipher, as an SSH block. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="set_inbound_cipher"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_inbound_cipher</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>block_engine</span>, + <span class=sig-arg>block_size</span>, + <span class=sig-arg>mac_engine</span>, + <span class=sig-arg>mac_size</span>, + <span class=sig-arg>mac_key</span>)</span> + </h3> + Switch inbound data cipher. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="set_keepalive"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_keepalive</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>interval</span>, + <span class=sig-arg>callback</span>)</span> + </h3> + Turn on/off the callback keepalive. If <code>interval</code> seconds + pass with no data read from or written to the socket, the callback will + be executed and the timer will be reset. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="set_log"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_log</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>log</span>)</span> + </h3> + Set the python log object to use for logging. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="set_outbound_cipher"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_outbound_cipher</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>block_engine</span>, + <span class=sig-arg>block_size</span>, + <span class=sig-arg>mac_engine</span>, + <span class=sig-arg>mac_size</span>, + <span class=sig-arg>mac_key</span>)</span> + </h3> + Switch outbound data cipher. + <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="REKEY_BYTES"></a> +<h3>REKEY_BYTES</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1073741824"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1073741824 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="REKEY_PACKETS"></a> +<h3>REKEY_PACKETS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1073741824"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1073741824 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/paramiko.PasswordRequiredException-class.html b/docs/private/paramiko.PasswordRequiredException-class.html new file mode 100644 index 0000000..2b7fb88 --- /dev/null +++ b/docs/private/paramiko.PasswordRequiredException-class.html @@ -0,0 +1,91 @@ +<?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>paramiko.PasswordRequiredException</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class PasswordRequiredException + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.PasswordRequiredException-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.PasswordRequiredException-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class PasswordRequiredException</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <a href="paramiko.SSHException-class.html"><code>SSHException</code></a> --+ + | + <b>PasswordRequiredException</b> +</pre><br /> + +<hr/> + +Exception raised when a password is needed to unlock a private key +file. +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.RSAKey-class.html b/docs/private/paramiko.RSAKey-class.html new file mode 100644 index 0000000..0550d72 --- /dev/null +++ b/docs/private/paramiko.RSAKey-class.html @@ -0,0 +1,504 @@ +<?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>paramiko.RSAKey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class RSAKey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.RSAKey-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.RSAKey-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type RSAKey</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.PKey-class.html"><code>PKey</code></a> --+ + | + <b>RSAKey</b> +</pre><br /> + +<hr/> + +Representation of an RSA key which can be used to sign and verify SSH2 +data. +<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="paramiko.RSAKey-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Create a new instance of this public key type.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__hash__"></a><span class="summary-sig"><span class="summary-sig-name">__hash__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string of an SSH <a href="paramiko.Message-class.html" +class="link"><code>Message</code></a> made up of the public part(s) of +this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#can_sign" class="summary-sig-name"><code>can_sign</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return <code>True</code> if this key has the private part necessary +for signing data.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.RSAKey-class.html" + class="link"><code>RSAKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#generate" class="summary-sig-name"><code>generate</code></a>(<span class=summary-sig-arg>bits</span>, + <span class=summary-sig-arg>progress_func</span>)</span></code> +<br /> +Generate a new private RSA key. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#get_bits" class="summary-sig-name"><code>get_bits</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the number of significant bits in this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the name of this private key implementation.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="sign_ssh_data"></a><span class="summary-sig"><span class="summary-sig-name">sign_ssh_data</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>rpool</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#verify_ssh_sig" class="summary-sig-name"><code>verify_ssh_sig</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +<br /> +Given a blob of data, and an SSH message representing a signature of +that data, verify that it was signed with this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#write_private_key_file" class="summary-sig-name"><code>write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write private key contents into a file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_from_private_key_file"></a><span class="summary-sig"><span class="summary-sig-name">_from_private_key_file</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</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="../private/paramiko.RSAKey-class.html#_pkcs1imify" class="summary-sig-name"><code>_pkcs1imify</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +turn a 20-byte SHA1 hash into a blob of data as large as the key's N, +using PKCS1's "emsa-pkcs1-v1_5" encoding.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from PKey</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#__cmp__" class="summary-sig-name"><code>__cmp__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>other</span>)</span></code> +<br /> +Compare this key to another.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#_read_private_key_file" class="summary-sig-name"><code>_read_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>tag</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Read an SSH2-format private key file, looking for a string of the type +<code>"BEGIN xxx PRIVATE KEY"</code> for some <code>xxx</code>, +base64-decode the text we find, and return it as a string.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#_write_private_key_file" class="summary-sig-name"><code>_write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>tag</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write an SSH2-format private key file in a form that can be read by +paramiko or openssh.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#from_private_key_file" class="summary-sig-name"><code>from_private_key_file</code></a>(<span class=summary-sig-arg>cl</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Create a key object by reading a private key file. <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_base64" class="summary-sig-name"><code>get_base64</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a base64 string containing the public part of this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.PKey-class.html#get_fingerprint" class="summary-sig-name"><code>get_fingerprint</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return an MD5 fingerprint of the public part of this key.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from PKey</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.PKey-class.html#_CIPHER_TABLE"><code>_CIPHER_TABLE</code></a></b> = <span title="{'DES-EDE3-CBC': {'blocksize': 8, 'cipher': <module 'Crypto.Cipher.DES3' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/DES3.so'>, 'keysize': 24, 'mode': 2}}"><code>{'DES-EDE3-CBC': {'blocksize': 8, 'ciphe<span class="variable-ellipsis">...</span></code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>msg</span>=<span class=sig-default>None</span>, + <span class=sig-arg>data</span>=<span class=sig-default>None</span>, + <span class=sig-arg>filename</span>=<span class=sig-default>None</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>, + <span class=sig-arg>vals</span>=<span class=sig-default>None</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new instance of this public key type. If <code>msg</code> + is given, the key's public part(s) will be filled in from the message. + If <code>data</code> is given, the key's public part(s) will be filled + in from the string. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>msg</b></code> - + an optional SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> containing a public key of + this type. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + <dd><code><b>data</b></code> - + an optional string containing a public key of this type + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if a key cannot be created from the <code>data</code> or + <code>msg</code> given, or no key was passed in. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__init__"><code>paramiko.PKey.__init__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return a string of an SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> made up of the public part(s) of + this key. This string is suitable for passing to <a + href="../private/paramiko.PKey-class.html#__init__" + class="link"><code>__init__</code></a> to re-create the key object + later. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string representation of an SSH key message. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__str__"><code>paramiko.PKey.__str__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="can_sign"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">can_sign</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return <code>True</code> if this key has the private part necessary + for signing data. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if this is a private key. + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#can_sign"><code>paramiko.PKey.can_sign</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_bits"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_bits</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the number of significant bits in this key. This is useful + for judging the relative security of a key. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + bits in the key. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_bits"><code>paramiko.PKey.get_bits</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the name of this private key implementation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + name of this private key type, in SSH terminology (for + example, <code>"ssh-rsa"</code>). + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_name"><code>paramiko.PKey.get_name</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="verify_ssh_sig"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">verify_ssh_sig</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>, + <span class=sig-arg>msg</span>)</span> + </h3> + Given a blob of data, and an SSH message representing a signature of + that data, verify that it was signed with this key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>data</b></code> - + the data that was signed. + <br /><i> + (type=str)</i> + <dd><code><b>msg</b></code> - + an SSH signature message + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the signature verifies correctly; + <code>False</code> otherwise. + <br /><i> + (type=boolean)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#verify_ssh_sig"><code>paramiko.PKey.verify_ssh_sig</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="write_private_key_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">write_private_key_file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>)</span> + </h3> + Write private key contents into a file. If the password is not + <code>None</code>, the key is encrypted before writing. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to write. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + an optional password to use to encrypt the key file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if there was an error writing the file. + <dd><code><b>SSHException</b></code> - + if the key is invalid. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#write_private_key_file"><code>paramiko.PKey.write_private_key_file</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="_pkcs1imify"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_pkcs1imify</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>)</span> + </h3> + turn a 20-byte SHA1 hash into a blob of data as large as the key's + N, using PKCS1's "emsa-pkcs1-v1_5" encoding. totally + bizarre. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF STATIC METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Static Method Details</th></tr> +</table> + +<a name="generate"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">generate</span>(<span class=sig-arg>bits</span>, + <span class=sig-arg>progress_func</span>=<span class=sig-default>None</span>)</span> + </h3> + Generate a new private RSA key. This factory function can be used to + generate a new host key or authentication key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>bits</b></code> - + number of bits the generated key should be. + <br /><i> + (type=int)</i> + <dd><code><b>progress_func</b></code> - + an optional function to call at key points in key generation + (used by <code>pyCrypto.PublicKey</code>). + <br /><i> + (type=function)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + new private key + <br /><i> + (type=<a href="paramiko.RSAKey-class.html" + class="link"><code>RSAKey</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.SFTP-class.html b/docs/private/paramiko.SFTP-class.html new file mode 100644 index 0000000..7ba1c7f --- /dev/null +++ b/docs/private/paramiko.SFTP-class.html @@ -0,0 +1,347 @@ +<?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>paramiko.SFTP</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTP + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SFTP-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTP-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTP</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a> --+ + | + <a href="paramiko.SFTPClient-class.html"><code>SFTPClient</code></a> --+ + | + <b>SFTP</b> +</pre><br /> + +<hr/> + +an alias for <a href="paramiko.SFTPClient-class.html" +class="link"><code>SFTPClient</code></a> for backwards compatability +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from SFTPClient</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sock</span>)</span></code> +<br /> +Create an SFTP client from an existing <a +href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#__del__" class="summary-sig-name"><code>__del__</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="paramiko.SFTPClient-class.html#chdir" class="summary-sig-name"><code>chdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Change the "current directory" of this SFTP session.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chmod" class="summary-sig-name"><code>chmod</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>mode</span>)</span></code> +<br /> +Change the mode (permissions) of a file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chown" class="summary-sig-name"><code>chown</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>uid</span>, + <span class=summary-sig-arg>gid</span>)</span></code> +<br /> +Change the owner (<code>uid</code>) and group (<code>gid</code>) of a +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the SFTP session and its underlying channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Open a file on the remote server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#from_transport" class="summary-sig-name"><code>from_transport</code></a>(<span class=summary-sig-arg>selfclass</span>, + <span class=summary-sig-arg>t</span>)</span></code> +<br /> +Create an SFTP client channel from an open <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>. <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>remotepath</span>, + <span class=summary-sig-arg>localpath</span>)</span></code> +<br /> +Copy a remote file (<code>remotepath</code>) from the SFTP server to +the local host as <code>localpath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#getcwd" class="summary-sig-name"><code>getcwd</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the "current working directory" for this SFTP +session, as emulated by paramiko.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir" class="summary-sig-name"><code>listdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return a list containing the names of the entries in the given +<code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir_attr" class="summary-sig-name"><code>listdir_attr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return a list containing <a href="paramiko.SFTPAttributes-class.html" +class="link"><code>SFTPAttributes</code></a> objects corresponding to +files in the given <code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#lstat" class="summary-sig-name"><code>lstat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Retrieve information about a file on the remote system, without +following symbolic links (shortcuts).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#mkdir" class="summary-sig-name"><code>mkdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>mode</span>)</span></code> +<br /> +Create a folder (directory) named <code>path</code> with numeric mode +<code>mode</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#normalize" class="summary-sig-name"><code>normalize</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the normalized path (on the server) of a given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>open</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Open a file on the remote server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#put" class="summary-sig-name"><code>put</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>localpath</span>, + <span class=summary-sig-arg>remotepath</span>)</span></code> +<br /> +Copy a local file (<code>localpath</code>) to the SFTP server as +<code>remotepath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#readlink" class="summary-sig-name"><code>readlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the target of a symbolic link (shortcut).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>remove</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the file at the given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rename" class="summary-sig-name"><code>rename</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>oldpath</span>, + <span class=summary-sig-arg>newpath</span>)</span></code> +<br /> +Rename a file or folder from <code>oldpath</code> to +<code>newpath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rmdir" class="summary-sig-name"><code>rmdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the folder named <code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Retrieve information about a file on the remote system.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#symlink" class="summary-sig-name"><code>symlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>source</span>, + <span class=summary-sig-arg>dest</span>)</span></code> +<br /> +Create a symbolic link (shortcut) of the <code>source</code> path at +<code>destination</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>unlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the file at the given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#utime" class="summary-sig-name"><code>utime</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>times</span>)</span></code> +<br /> +Set the access and modified times of the file specified by +<code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPClient-class.html#_adjust_cwd" class="summary-sig-name"><code>_adjust_cwd</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return an adjusted path if we're emulating a "current working +directory" for the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPClient-class.html#_async_request" class="summary-sig-name"><code>_async_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>fileobj</span>, + <span class=summary-sig-arg>t</span>, + <span class="summary-sig-vararg">*arg</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="../private/paramiko.SFTPClient-class.html#_convert_status" class="summary-sig-name"><code>_convert_status</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +<br /> +Raises EOFError or IOError on error status; otherwise does +nothing.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPClient-class.html#_finish_responses" class="summary-sig-name"><code>_finish_responses</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>fileobj</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="../private/paramiko.SFTPClient-class.html#_read_response" class="summary-sig-name"><code>_read_response</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>waitfor</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="../private/paramiko.SFTPClient-class.html#_request" class="summary-sig-name"><code>_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>t</span>, + <span class="summary-sig-vararg">*arg</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BaseSFTP</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_log" class="summary-sig-name"><code>_log</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>level</span>, + <span class=summary-sig-arg>msg</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="../private/paramiko.BaseSFTP-class.html#_read_all" class="summary-sig-name"><code>_read_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</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="../private/paramiko.BaseSFTP-class.html#_read_packet" class="summary-sig-name"><code>_read_packet</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="../private/paramiko.BaseSFTP-class.html#_send_packet" class="summary-sig-name"><code>_send_packet</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>t</span>, + <span class=summary-sig-arg>packet</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="../private/paramiko.BaseSFTP-class.html#_send_server_version" class="summary-sig-name"><code>_send_server_version</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="../private/paramiko.BaseSFTP-class.html#_send_version" class="summary-sig-name"><code>_send_version</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="../private/paramiko.BaseSFTP-class.html#_write_all" class="summary-sig-name"><code>_write_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>out</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.SFTPAttributes-class.html b/docs/private/paramiko.SFTPAttributes-class.html new file mode 100644 index 0000000..a98d008 --- /dev/null +++ b/docs/private/paramiko.SFTPAttributes-class.html @@ -0,0 +1,385 @@ +<?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>paramiko.SFTPAttributes</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPAttributes + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SFTPAttributes-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPAttributes-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPAttributes</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>SFTPAttributes</b> +</pre><br /> + +<hr/> + +Representation of the attributes of a file (or proxied file) for SFTP +in client or server mode. It attemps to mirror the object returned by +<code>os.stat</code> as closely as possible, so it may have the following +fields, with the same meanings as those returned by an +<code>os.stat</code> object: +<ul> + <li> + st_size + </li> + <li> + st_uid + </li> + <li> + st_gid + </li> + <li> + st_mode + </li> + <li> + st_atime + </li> + <li> + st_mtime + </li> +</ul> +Because SFTP allows flags to have other arbitrary named attributes, +these are stored in a dict named <code>attr</code>. Occasionally, the +filename is also stored, in <code>filename</code>. +<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="paramiko.SFTPAttributes-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Create a new (empty) SFTPAttributes object.</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="paramiko.SFTPAttributes-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +create a unix-style long description of the file (like ls -l)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPAttributes-class.html#from_stat" class="summary-sig-name"><code>from_stat</code></a>(<span class=summary-sig-arg>cls</span>, + <span class=summary-sig-arg>obj</span>, + <span class=summary-sig-arg>filename</span>)</span></code> +<br /> +Create an SFTPAttributes object from an existing <code>stat</code> +object (an object returned by <code>os.stat</code>). <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_debug_str"></a><span class="summary-sig"><span class="summary-sig-name">_debug_str</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><a name="_from_msg"></a><span class="summary-sig"><span class="summary-sig-name">_from_msg</span>(<span class=summary-sig-arg>cls</span>, + <span class=summary-sig-arg>msg</span>, + <span class=summary-sig-arg>filename</span>)</span></code> +<br /> + <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_pack"></a><span class="summary-sig"><span class="summary-sig-name">_pack</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_rwx"></a><span class="summary-sig"><span class="summary-sig-name">_rwx</span>(<span class=summary-sig-arg>n</span>, + <span class=summary-sig-arg>suid</span>, + <span class=summary-sig-arg>sticky</span>)</span></code> +<br /> + <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_unpack"></a><span class="summary-sig"><span class="summary-sig-name">_unpack</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</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>int</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_AMTIME"><code>FLAG_AMTIME</code></a></b> = <span title="8">8 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>long</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_EXTENDED"><code>FLAG_EXTENDED</code></a></b> = <span title="2147483648L"><code>2147483648L </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_PERMISSIONS"><code>FLAG_PERMISSIONS</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_SIZE"><code>FLAG_SIZE</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_UIDGID"><code>FLAG_UIDGID</code></a></b> = <span title="2">2 </span></td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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> + <br /><i>(Constructor)</i> + </h3> + Create a new (empty) SFTPAttributes object. All fields will be + empty. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + create a unix-style long description of the file (like ls -l) + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF CLASS METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Class Method Details</th></tr> +</table> + +<a name="from_stat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">from_stat</span>(<span class=sig-arg>cls</span>, + <span class=sig-arg>obj</span>, + <span class=sig-arg>filename</span>=<span class=sig-default>None</span>)</span> + </h3> + Create an SFTPAttributes object from an existing <code>stat</code> + object (an object returned by <code>os.stat</code>). + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>obj</b></code> - + an object returned by <code>os.stat</code> (or + equivalent). + <br /><i> + (type=object)</i> + <dd><code><b>filename</b></code> - + the filename associated with this file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + new <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> object with the same + attribute fields. + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</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="FLAG_AMTIME"></a> +<h3>FLAG_AMTIME</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="FLAG_EXTENDED"></a> +<h3>FLAG_EXTENDED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>long</code> + + </dd> +<span title="2147483648L"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2147483648L </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="FLAG_PERMISSIONS"></a> +<h3>FLAG_PERMISSIONS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="FLAG_SIZE"></a> +<h3>FLAG_SIZE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="FLAG_UIDGID"></a> +<h3>FLAG_UIDGID</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.SFTPClient-class.html b/docs/private/paramiko.SFTPClient-class.html new file mode 100644 index 0000000..a6ed5c0 --- /dev/null +++ b/docs/private/paramiko.SFTPClient-class.html @@ -0,0 +1,1091 @@ +<?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>paramiko.SFTPClient</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPClient + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SFTPClient-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPClient-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPClient</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a> --+ + | + <b>SFTPClient</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SFTP-class.html"><code>SFTP</code></a></dd></dl> + +<hr/> + +SFTP client object. <code>SFTPClient</code> is used to open an sftp +session across an open ssh <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> and do remote file +operations. +<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="paramiko.SFTPClient-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sock</span>)</span></code> +<br /> +Create an SFTP client from an existing <a +href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</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="paramiko.SFTPClient-class.html#chdir" class="summary-sig-name"><code>chdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Change the "current directory" of this SFTP session.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chmod" class="summary-sig-name"><code>chmod</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>mode</span>)</span></code> +<br /> +Change the mode (permissions) of a file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chown" class="summary-sig-name"><code>chown</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>uid</span>, + <span class=summary-sig-arg>gid</span>)</span></code> +<br /> +Change the owner (<code>uid</code>) and group (<code>gid</code>) of a +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the SFTP session and its underlying channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Open a file on the remote server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#from_transport" class="summary-sig-name"><code>from_transport</code></a>(<span class=summary-sig-arg>selfclass</span>, + <span class=summary-sig-arg>t</span>)</span></code> +<br /> +Create an SFTP client channel from an open <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>. <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>remotepath</span>, + <span class=summary-sig-arg>localpath</span>)</span></code> +<br /> +Copy a remote file (<code>remotepath</code>) from the SFTP server to +the local host as <code>localpath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#getcwd" class="summary-sig-name"><code>getcwd</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the "current working directory" for this SFTP +session, as emulated by paramiko.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir" class="summary-sig-name"><code>listdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return a list containing the names of the entries in the given +<code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir_attr" class="summary-sig-name"><code>listdir_attr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return a list containing <a href="paramiko.SFTPAttributes-class.html" +class="link"><code>SFTPAttributes</code></a> objects corresponding to +files in the given <code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#lstat" class="summary-sig-name"><code>lstat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Retrieve information about a file on the remote system, without +following symbolic links (shortcuts).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#mkdir" class="summary-sig-name"><code>mkdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>mode</span>)</span></code> +<br /> +Create a folder (directory) named <code>path</code> with numeric mode +<code>mode</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#normalize" class="summary-sig-name"><code>normalize</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the normalized path (on the server) of a given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>open</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Open a file on the remote server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#put" class="summary-sig-name"><code>put</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>localpath</span>, + <span class=summary-sig-arg>remotepath</span>)</span></code> +<br /> +Copy a local file (<code>localpath</code>) to the SFTP server as +<code>remotepath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#readlink" class="summary-sig-name"><code>readlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the target of a symbolic link (shortcut).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>remove</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the file at the given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rename" class="summary-sig-name"><code>rename</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>oldpath</span>, + <span class=summary-sig-arg>newpath</span>)</span></code> +<br /> +Rename a file or folder from <code>oldpath</code> to +<code>newpath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rmdir" class="summary-sig-name"><code>rmdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the folder named <code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Retrieve information about a file on the remote system.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#symlink" class="summary-sig-name"><code>symlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>source</span>, + <span class=summary-sig-arg>dest</span>)</span></code> +<br /> +Create a symbolic link (shortcut) of the <code>source</code> path at +<code>destination</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>unlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the file at the given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#utime" class="summary-sig-name"><code>utime</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>times</span>)</span></code> +<br /> +Set the access and modified times of the file specified by +<code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPClient-class.html#_adjust_cwd" class="summary-sig-name"><code>_adjust_cwd</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return an adjusted path if we're emulating a "current working +directory" for the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_async_request"></a><span class="summary-sig"><span class="summary-sig-name">_async_request</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>fileobj</span>, + <span class=summary-sig-arg>t</span>, + <span class="summary-sig-vararg">*arg</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="../private/paramiko.SFTPClient-class.html#_convert_status" class="summary-sig-name"><code>_convert_status</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +<br /> +Raises EOFError or IOError on error status; otherwise does +nothing.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_finish_responses"></a><span class="summary-sig"><span class="summary-sig-name">_finish_responses</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>fileobj</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_read_response"></a><span class="summary-sig"><span class="summary-sig-name">_read_response</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>waitfor</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_request"></a><span class="summary-sig"><span class="summary-sig-name">_request</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>t</span>, + <span class="summary-sig-vararg">*arg</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BaseSFTP</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_log" class="summary-sig-name"><code>_log</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>level</span>, + <span class=summary-sig-arg>msg</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="../private/paramiko.BaseSFTP-class.html#_read_all" class="summary-sig-name"><code>_read_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</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="../private/paramiko.BaseSFTP-class.html#_read_packet" class="summary-sig-name"><code>_read_packet</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="../private/paramiko.BaseSFTP-class.html#_send_packet" class="summary-sig-name"><code>_send_packet</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>t</span>, + <span class=summary-sig-arg>packet</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="../private/paramiko.BaseSFTP-class.html#_send_server_version" class="summary-sig-name"><code>_send_server_version</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="../private/paramiko.BaseSFTP-class.html#_send_version" class="summary-sig-name"><code>_send_version</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="../private/paramiko.BaseSFTP-class.html#_write_all" class="summary-sig-name"><code>_write_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>out</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>sock</span>)</span> + <br /><i>(Constructor)</i> + </h3> + <p>Create an SFTP client from an existing <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>. The channel should already have + requested the <code>"sftp"</code> subsystem.</p> + An alternate way to create an SFTP client context is by using <a + href="paramiko.SFTPClient-class.html#from_transport" + class="link"><code>from_transport</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>sock</b></code> - + an open <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> using the + <code>"sftp"</code> subsystem. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.BaseSFTP-class.html#__init__"><code>paramiko.BaseSFTP.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="chdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">chdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Change the "current directory" of this SFTP session. Since + SFTP doesn't really have the concept of a current working directory, + this is emulated by paramiko. Once you use this method to set a working + directory, all operations on this SFTPClient object will be relative to + that path. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + new current working directory + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the requested path doesn't exist on the server + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="chmod"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">chmod</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>mode</span>)</span> + </h3> + Change the mode (permissions) of a file. The permissions are + unix-style and identical to those used by python's + <code>os.chmod</code> function. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path of the file to change the permissions of. + <br /><i> + (type=string)</i> + <dd><code><b>mode</b></code> - + new permissions. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="chown"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">chown</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>uid</span>, + <span class=sig-arg>gid</span>)</span> + </h3> + Change the owner (<code>uid</code>) and group (<code>gid</code>) of + a file. As with python's <code>os.chown</code> function, you must pass + both arguments, so if you only want to change one, use <a + href="paramiko.SFTPClient-class.html#stat" + class="link"><code>stat</code></a> first to retrieve the current owner + and group. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path of the file to change the owner and group of. + <br /><i> + (type=string)</i> + <dd><code><b>uid</b></code> - + new owner's uid + <br /><i> + (type=int)</i> + <dd><code><b>gid</b></code> - + new group id + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close the SFTP session and its underlying channel. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>mode</span>=<span class=sig-default>'r'</span>, + <span class=sig-arg>bufsize</span>=<span class=sig-default>-1</span>)</span> + </h3> + <p>Open a file on the remote server. The arguments are the same as for + python's built-in <code>file</code> (aka <code>open</code>). A + file-like object is returned, which closely mimics the behavior of a + normal python file object.</p> + <p>The mode indicates how the file is to be opened: <code>'r'</code> + for reading, <code>'w'</code> for writing (truncating an existing + file), <code>'a'</code> for appending, <code>'r+'</code> for + reading/writing, <code>'w+'</code> for reading/writing (truncating an + existing file), <code>'a+'</code> for reading/appending. The python + <code>'b'</code> flag is ignored, since SSH treats all files as binary. + The <code>'U'</code> flag is supported in a compatible way.</p> + <p>Since 1.5.2, an <code>'x'</code> flag indicates that the operation + should only succeed if the file was created and did not previously + exist. This has no direct mapping to python's file flags, but is + commonly known as the <code>O_EXCL</code> flag in posix.</p> + The file will be buffered in standard python style by default, but + can be altered with the <code>bufsize</code> parameter. <code>0</code> + turns off buffering, <code>1</code> uses line buffering, and any number + greater than 1 (<code>>1</code>) uses that specific buffer size. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to open. + <br /><i> + (type=string)</i> + <dd><code><b>mode</b></code> - + mode (python-style) to open in. + <br /><i> + (type=string)</i> + <dd><code><b>bufsize</b></code> - + desired buffering (-1 = default buffer size) + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a file object representing the open file. + <br /><i> + (type=SFTPFile)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the file could not be opened. + </dl> + </dd></dl> +</td></tr></table> + +<a name="get"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>remotepath</span>, + <span class=sig-arg>localpath</span>)</span> + </h3> + Copy a remote file (<code>remotepath</code>) from the SFTP server to + the local host as <code>localpath</code>. Any exception raised by + operations will be passed through. This method is primarily provided as + a convenience. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>remotepath</b></code> - + the remote file to copy + <br /><i> + (type=str)</i> + <dd><code><b>localpath</b></code> - + the destination path on the local host + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="getcwd"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">getcwd</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the "current working directory" for this SFTP + session, as emulated by paramiko. If no directory has been set with <a + href="paramiko.SFTPClient-class.html#chdir" + class="link"><code>chdir</code></a>, this method will return + <code>None</code>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the current working directory on the server, or + <code>None</code> + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="listdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">listdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>=<span class=sig-default>'.'</span>)</span> + </h3> + Return a list containing the names of the entries in the given + <code>path</code>. The list is in arbitrary order. It does not include + the special entries <code>'.'</code> and <code>'..'</code> even if they + are present in the folder. This method is meant to mirror + <code>os.listdir</code> as closely as possible. For a list of full <a + href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> objects, see <a + href="paramiko.SFTPClient-class.html#listdir_attr" + class="link"><code>listdir_attr</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path to list (defaults to <code>'.'</code>) + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of filenames + <br /><i> + (type=list of str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="listdir_attr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">listdir_attr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>=<span class=sig-default>'.'</span>)</span> + </h3> + Return a list containing <a + href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> objects corresponding to + files in the given <code>path</code>. The list is in arbitrary order. + It does not include the special entries <code>'.'</code> and + <code>'..'</code> even if they are present in the folder. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path to list (defaults to <code>'.'</code>) + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of attributes + <br /><i> + (type=list of <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="lstat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">lstat</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Retrieve information about a file on the remote system, without + following symbolic links (shortcuts). This otherwise behaves exactly + the same as <a href="paramiko.SFTPClient-class.html#stat" + class="link"><code>stat</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + the filename to stat. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an object containing attributes about the given file. + <br /><i> + (type=SFTPAttributes)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="mkdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">mkdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>mode</span>=<span class=sig-default>511</span>)</span> + </h3> + Create a folder (directory) named <code>path</code> with numeric + mode <code>mode</code>. The default mode is 0777 (octal). On some + systems, mode is ignored. Where it is used, the current umask value is + first masked out. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + name of the folder to create. + <br /><i> + (type=string)</i> + <dd><code><b>mode</b></code> - + permissions (posix-style) for the newly-created folder. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="normalize"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">normalize</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Return the normalized path (on the server) of a given path. This can + be used to quickly resolve symbolic links or determine what the server + is considering to be the "current folder" (by passing + <code>'.'</code> as <code>path</code>). + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path to be normalized. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + normalized form of the given path. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the path can't be resolved on the server + </dl> + </dd></dl> +</td></tr></table> + +<a name="file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">open</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>mode</span>=<span class=sig-default>'r'</span>, + <span class=sig-arg>bufsize</span>=<span class=sig-default>-1</span>)</span> + </h3> + <p>Open a file on the remote server. The arguments are the same as for + python's built-in <code>file</code> (aka <code>open</code>). A + file-like object is returned, which closely mimics the behavior of a + normal python file object.</p> + <p>The mode indicates how the file is to be opened: <code>'r'</code> + for reading, <code>'w'</code> for writing (truncating an existing + file), <code>'a'</code> for appending, <code>'r+'</code> for + reading/writing, <code>'w+'</code> for reading/writing (truncating an + existing file), <code>'a+'</code> for reading/appending. The python + <code>'b'</code> flag is ignored, since SSH treats all files as binary. + The <code>'U'</code> flag is supported in a compatible way.</p> + <p>Since 1.5.2, an <code>'x'</code> flag indicates that the operation + should only succeed if the file was created and did not previously + exist. This has no direct mapping to python's file flags, but is + commonly known as the <code>O_EXCL</code> flag in posix.</p> + The file will be buffered in standard python style by default, but + can be altered with the <code>bufsize</code> parameter. <code>0</code> + turns off buffering, <code>1</code> uses line buffering, and any number + greater than 1 (<code>>1</code>) uses that specific buffer size. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to open. + <br /><i> + (type=string)</i> + <dd><code><b>mode</b></code> - + mode (python-style) to open in. + <br /><i> + (type=string)</i> + <dd><code><b>bufsize</b></code> - + desired buffering (-1 = default buffer size) + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a file object representing the open file. + <br /><i> + (type=SFTPFile)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the file could not be opened. + </dl> + </dd></dl> +</td></tr></table> + +<a name="put"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">put</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>localpath</span>, + <span class=sig-arg>remotepath</span>)</span> + </h3> + <p>Copy a local file (<code>localpath</code>) to the SFTP server as + <code>remotepath</code>. Any exception raised by operations will be + passed through. This method is primarily provided as a convenience.</p> + The SFTP operations use pipelining for speed. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>localpath</b></code> - + the local file to copy + <br /><i> + (type=str)</i> + <dd><code><b>remotepath</b></code> - + the destination path on the SFTP server + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="readlink"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">readlink</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Return the target of a symbolic link (shortcut). You can use <a + href="paramiko.SFTPClient-class.html#symlink" + class="link"><code>symlink</code></a> to create these. The result may + be either an absolute or relative pathname. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path of the symbolic link file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + target path. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="remove"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">remove</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Remove the file at the given path. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path (absolute or relative) of the file to remove. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the path refers to a folder (directory). Use <a + href="paramiko.SFTPClient-class.html#rmdir" + class="link"><code>rmdir</code></a> to remove a folder. + </dl> + </dd></dl> +</td></tr></table> + +<a name="rename"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">rename</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>oldpath</span>, + <span class=sig-arg>newpath</span>)</span> + </h3> + Rename a file or folder from <code>oldpath</code> to + <code>newpath</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>oldpath</b></code> - + existing name of the file or folder. + <br /><i> + (type=string)</i> + <dd><code><b>newpath</b></code> - + new name for the file or folder. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if <code>newpath</code> is a folder, or something else goes + wrong. + </dl> + </dd></dl> +</td></tr></table> + +<a name="rmdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">rmdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Remove the folder named <code>path</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + name of the folder to remove. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="stat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">stat</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + <p>Retrieve information about a file on the remote system. The return + value is an object whose attributes correspond to the attributes of + python's <code>stat</code> structure as returned by + <code>os.stat</code>, except that it contains fewer fields. An SFTP + server may return as much or as little info as it wants, so the results + may vary from server to server.</p> + <p>Unlike a python <code>stat</code> object, the result may not be + accessed as a tuple. This is mostly due to the author's slack + factor.</p> + The fields supported are: <code>st_mode</code>, + <code>st_size</code>, <code>st_uid</code>, <code>st_gid</code>, + <code>st_atime</code>, and <code>st_mtime</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + the filename to stat. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an object containing attributes about the given file. + <br /><i> + (type=SFTPAttributes)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="symlink"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">symlink</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>source</span>, + <span class=sig-arg>dest</span>)</span> + </h3> + Create a symbolic link (shortcut) of the <code>source</code> path at + <code>destination</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>source</b></code> - + path of the original file. + <br /><i> + (type=string)</i> + <dd><code><b>dest</b></code> - + path of the newly created symlink. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="remove"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">unlink</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Remove the file at the given path. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path (absolute or relative) of the file to remove. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the path refers to a folder (directory). Use <a + href="paramiko.SFTPClient-class.html#rmdir" + class="link"><code>rmdir</code></a> to remove a folder. + </dl> + </dd></dl> +</td></tr></table> + +<a name="utime"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">utime</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>times</span>)</span> + </h3> + Set the access and modified times of the file specified by + <code>path</code>. If <code>times</code> is <code>None</code>, then the + file's access and modified times are set to the current time. + Otherwise, <code>times</code> must be a 2-tuple of numbers, of the form + <code>(atime, mtime)</code>, which is used to set the access and + modified times, respectively. This bizarre API is mimicked from python + for the sake of consistency -- I apologize. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path of the file to modify. + <br /><i> + (type=string)</i> + <dd><code><b>times</b></code> - + <code>None</code> or a tuple of (access time, modified time) + in standard internet epoch time (seconds since 01 January 1970 + GMT). + <br /><i> + (type=tuple of int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_adjust_cwd"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_adjust_cwd</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Return an adjusted path if we're emulating a "current working + directory" for the server. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_convert_status"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_convert_status</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>msg</span>)</span> + </h3> + Raises EOFError or IOError on error status; otherwise does + nothing. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF CLASS METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Class Method Details</th></tr> +</table> + +<a name="from_transport"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">from_transport</span>(<span class=sig-arg>selfclass</span>, + <span class=sig-arg>t</span>)</span> + </h3> + Create an SFTP client channel from an open <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>t</b></code> - + an open <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> which is already + authenticated. + <br /><i> + (type=<a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a new <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> object, referring to an + sftp session (channel) across the transport. + <br /><i> + (type=<a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a>)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.SFTPError-class.html b/docs/private/paramiko.SFTPError-class.html new file mode 100644 index 0000000..2b7aa97 --- /dev/null +++ b/docs/private/paramiko.SFTPError-class.html @@ -0,0 +1,85 @@ +<?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>paramiko.SFTPError</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPError + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SFTPError-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPError-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class SFTPError</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <b>SFTPError</b> +</pre><br /> + +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.SFTPFile-class.html b/docs/private/paramiko.SFTPFile-class.html new file mode 100644 index 0000000..0c59d5f --- /dev/null +++ b/docs/private/paramiko.SFTPFile-class.html @@ -0,0 +1,667 @@ +<?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>paramiko.SFTPFile</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPFile + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SFTPFile-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPFile-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPFile</h2> + +<pre class="base-tree"> + <a href="__builtin__.object-class.html"><code>object</code></a> --+ + | +<a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a> --+ + | + <b>SFTPFile</b> +</pre><br /> + +<hr/> + +Proxy object for a file on the remote server, in client mode SFTP. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sftp</span>, + <span class=summary-sig-arg>handle</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#check" class="summary-sig-name"><code>check</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>hash_algorithm</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>length</span>, + <span class=summary-sig-arg>block_size</span>)</span></code> +<br /> +Ask the server for a hash of a section of this file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> float +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#gettimeout" class="summary-sig-name"><code>gettimeout</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the timeout in seconds (as a float) associated with the socket +or ssh <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a> used for this file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#prefetch" class="summary-sig-name"><code>prefetch</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Pre-fetch the remaining contents of this file in anticipation of +future <a href="paramiko.BufferedFile-class.html#read" +class="link"><code>read</code></a> calls.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#seek" class="summary-sig-name"><code>seek</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>whence</span>)</span></code> +<br /> +Set the file's current position, like stdio's <code>fseek</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#set_pipelined" class="summary-sig-name"><code>set_pipelined</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>pipelined</span>)</span></code> +<br /> +Turn on/off the pipelining of write operations to this file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#setblocking" class="summary-sig-name"><code>setblocking</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>blocking</span>)</span></code> +<br /> +Set blocking or non-blocking mode on the underiying socket or ssh <a +href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#settimeout" class="summary-sig-name"><code>settimeout</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +<br /> +Set a timeout on read/write operations on the underlying socket or ssh +<a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Retrieve information about this file from the remote system.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_async_response"></a><span class="summary-sig"><span class="summary-sig-name">_async_response</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>t</span>, + <span class=summary-sig-arg>msg</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="../private/paramiko.SFTPFile-class.html#_check_exception" class="summary-sig-name"><code>_check_exception</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +if there's a saved exception, raise & clear it</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPFile-class.html#_get_size" class="summary-sig-name"><code>_get_size</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +<i>(subclass override)</i> Return the size of the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_prefetch"></a><span class="summary-sig"><span class="summary-sig-name">_prefetch</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="../private/paramiko.SFTPFile-class.html#_read" class="summary-sig-name"><code>_read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +<i>(subclass override)</i> Read data from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_read_prefetch"></a><span class="summary-sig"><span class="summary-sig-name">_read_prefetch</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</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="../private/paramiko.SFTPFile-class.html#_write" class="summary-sig-name"><code>_write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +<i>(subclass override)</i> Write data into the stream.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BufferedFile</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns an iterator that can be used to iterate over the lines in this +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#flush" class="summary-sig-name"><code>flush</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Write out any data in the write buffer.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#next" class="summary-sig-name"><code>next</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the next line from the input, or raises +<code>StopIteration</code> when EOF is hit.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read at most <code>size</code> bytes from the file (less if we hit the +end of the file first).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readline" class="summary-sig-name"><code>readline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read one entire line from the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readlines" class="summary-sig-name"><code>readlines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sizehint</span>)</span></code> +<br /> +Read all remaining lines using <a +href="paramiko.BufferedFile-class.html#readline" +class="link"><code>readline</code></a> and return them as a list.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#tell" class="summary-sig-name"><code>tell</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the file's current position.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Write data to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#writelines" class="summary-sig-name"><code>writelines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sequence</span>)</span></code> +<br /> +Write a sequence of strings to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#xreadlines" class="summary-sig-name"><code>xreadlines</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Identical to <code>iter(f)</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_record_newline" class="summary-sig-name"><code>_record_newline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>newline</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="../private/paramiko.BufferedFile-class.html#_set_mode" class="summary-sig-name"><code>_set_mode</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Subclasses call this method to initialize the BufferedFile.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_write_all" class="summary-sig-name"><code>_write_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>int</code></font></td> +<td><b><a href="paramiko.SFTPFile-class.html#MAX_REQUEST_SIZE"><code>MAX_REQUEST_SIZE</code></a></b> = <span title="32768">32768 </span></td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BufferedFile</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></b> = <span title="0">0 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.BufferedFile-class.html#_DEFAULT_BUFSIZE"><code>_DEFAULT_BUFSIZE</code></a></b> = <span title="8192">8192 </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="check"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>hash_algorithm</span>, + <span class=sig-arg>offset</span>=<span class=sig-default>0</span>, + <span class=sig-arg>length</span>=<span class=sig-default>0</span>, + <span class=sig-arg>block_size</span>=<span class=sig-default>0</span>)</span> + </h3> + <p>Ask the server for a hash of a section of this file. This can be + used to verify a successful upload or download, or for various + rsync-like operations.</p> + <p>The file is hashed from <code>offset</code>, for <code>length</code> + bytes. If <code>length</code> is 0, the remainder of the file is + hashed. Thus, if both <code>offset</code> and <code>length</code> are + zero, the entire file is hashed.</p> + <p>Normally, <code>block_size</code> will be 0 (the default), and this + method will return a byte string representing the requested hash (for + example, a string of length 16 for MD5, or 20 for SHA-1). If a non-zero + <code>block_size</code> is given, each chunk of the file (from + <code>offset</code> to <code>offset + length</code>) of + <code>block_size</code> bytes is computed as a separate hash. The hash + results are all concatenated and returned as a single string.</p> + For example, <code>check('sha1', 0, 1024, 512)</code> will return a + string of length 40. The first 20 bytes will be the SHA-1 of the first + 512 bytes of the file, and the last 20 bytes will be the SHA-1 of the + next 512 bytes. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hash_algorithm</b></code> - + the name of the hash algorithm to use (normally + <code>"sha1"</code> or + <code>"md5"</code>) + <br /><i> + (type=str)</i> + <dd><code><b>offset</b></code> - + offset into the file to begin hashing (0 means to start from + the beginning) + <br /><i> + (type=int or long)</i> + <dd><code><b>length</b></code> - + number of bytes to hash (0 means continue to the end of the + file) + <br /><i> + (type=int or long)</i> + <dd><code><b>block_size</b></code> - + number of bytes to hash per result (must not be less than 256; + 0 means to compute only one hash of the entire segment) + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + string of bytes representing the hash of each block, + concatenated together + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the server doesn't support the "check-file" + extension, or possibly doesn't support the hash algorithm + requested + </dl> +<p><b>Note:</b> Many (most?) servers don't support this extension yet. +</p> + +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>_async</span>=<span class=sig-default>False</span>)</span> + </h3> + Close the file. Future read and write operations will fail. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="paramiko.BufferedFile-class.html#close"><code>paramiko.BufferedFile.close</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="gettimeout"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">gettimeout</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns the timeout in seconds (as a float) associated with the + socket or ssh <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> used for this file. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + float + </dd> + </dl> +<p><b>See Also:</b> <a href="paramiko.Channel-class.html#gettimeout" +class="link"><code>Channel.gettimeout</code></a> +</p> + + </dd></dl> +</td></tr></table> + +<a name="prefetch"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">prefetch</span>(<span class=sig-arg>self</span>)</span> + </h3> + Pre-fetch the remaining contents of this file in anticipation of + future <a href="paramiko.BufferedFile-class.html#read" + class="link"><code>read</code></a> calls. If reading the entire file, + pre-fetching can dramatically improve the download speed by avoiding + roundtrip latency. The file's contents are incrementally buffered in a + background thread. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.5.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="seek"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">seek</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>offset</span>, + <span class=sig-arg>whence</span>=<span class=sig-default>0</span>)</span> + </h3> + Set the file's current position, like stdio's <code>fseek</code>. + Not all file objects support seeking. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>offset</b></code> - + position to move to within the file, relative to + <code>whence</code>. + <br /><i> + (type=int)</i> + <dd><code><b>whence</b></code> - + type of movement: 0 = absolute; 1 = relative to the current + position; 2 = relative to the end of the file. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the file doesn't support random access. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="paramiko.BufferedFile-class.html#seek"><code>paramiko.BufferedFile.seek</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Note:</b> If a file is opened in append mode (<code>'a'</code> or +<code>'a+'</code>), any seek operations will be undone at the next write +(as the file position will move back to the end of the file). +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_pipelined"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_pipelined</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>pipelined</span>=<span class=sig-default>True</span>)</span> + </h3> + <p>Turn on/off the pipelining of write operations to this file. When + pipelining is on, paramiko won't wait for the server response after + each write operation. Instead, they're collected as they come in. At + the first non-write operation (including <a + href="paramiko.SFTPFile-class.html#close" + class="link"><code>close</code></a>), all remaining server responses + are collected. This means that if there was an error with one of your + later writes, an exception might be thrown from within <a + href="paramiko.SFTPFile-class.html#close" + class="link"><code>close</code></a> instead of <a + href="paramiko.BufferedFile-class.html#write" + class="link"><code>write</code></a>.</p> + By default, files are <i>not</i> pipelined. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>pipelined</b></code> - + <code>True</code> if pipelining should be turned on for this + file; <code>False</code> otherwise + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Since:</b> 1.5 +</p> + + </dd></dl> +</td></tr></table> + +<a name="setblocking"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">setblocking</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>blocking</span>)</span> + </h3> + Set blocking or non-blocking mode on the underiying socket or ssh <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>blocking</b></code> - + 0 to set non-blocking mode; non-0 to set blocking mode. + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>See Also:</b> <a href="paramiko.Channel-class.html#setblocking" +class="link"><code>Channel.setblocking</code></a> +</p> + + </dd></dl> +</td></tr></table> + +<a name="settimeout"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">settimeout</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>timeout</span>)</span> + </h3> + Set a timeout on read/write operations on the underlying socket or + ssh <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>timeout</b></code> - + seconds to wait for a pending read/write operation before + raising <code>socket.timeout</code>, or <code>None</code> for no + timeout + <br /><i> + (type=float)</i> + </dd> + </dl> +<p><b>See Also:</b> <a href="paramiko.Channel-class.html#settimeout" +class="link"><code>Channel.settimeout</code></a> +</p> + + </dd></dl> +</td></tr></table> + +<a name="stat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">stat</span>(<span class=sig-arg>self</span>)</span> + </h3> + Retrieve information about this file from the remote system. This is + exactly like <a href="paramiko.SFTP-class.html#stat" + class="link"><code>SFTP.stat</code></a>, except that it operates on an + already-open file. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an object containing attributes about this file. + <br /><i> + (type=SFTPAttributes)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_check_exception"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_check_exception</span>(<span class=sig-arg>self</span>)</span> + </h3> + if there's a saved exception, raise & clear it + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_get_size"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_get_size</span>(<span class=sig-arg>self</span>)</span> + </h3> + <i>(subclass override)</i> Return the size of the file. This is + called from within <a + href="../private/paramiko.BufferedFile-class.html#_set_mode" + class="link"><code>_set_mode</code></a> if the file is opened in append + mode, so the file position can be tracked and <a + href="paramiko.BufferedFile-class.html#seek" + class="link"><code>seek</code></a> and <a + href="paramiko.BufferedFile-class.html#tell" + class="link"><code>tell</code></a> will work correctly. If the file is + a stream that can't be randomly accessed, you don't need to override + this method, + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.BufferedFile-class.html#_get_size"><code>paramiko.BufferedFile._get_size</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_read</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>size</span>)</span> + </h3> + <i>(subclass override)</i> Read data from the stream. Return + <code>None</code> or raise <code>EOFError</code> to indicate EOF. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.BufferedFile-class.html#_read"><code>paramiko.BufferedFile._read</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_write</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>)</span> + </h3> + <i>(subclass override)</i> Write data into the stream. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.BufferedFile-class.html#_write"><code>paramiko.BufferedFile._write</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="MAX_REQUEST_SIZE"></a> +<h3>MAX_REQUEST_SIZE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="32768"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +32768 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.SFTPHandle-class.html b/docs/private/paramiko.SFTPHandle-class.html new file mode 100644 index 0000000..958dbba --- /dev/null +++ b/docs/private/paramiko.SFTPHandle-class.html @@ -0,0 +1,364 @@ +<?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>paramiko.SFTPHandle</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPHandle + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SFTPHandle-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPHandle-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPHandle</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>SFTPHandle</b> +</pre><br /> + +<hr/> + +<p>Abstract object representing a handle to an open file (or folder) in +an SFTP server implementation. Each handle has a string representation +used by the client to refer to the underlying file.</p> +Server implementations can (and should) subclass SFTPHandle to +implement features of a file handle, like <a +href="paramiko.SFTPHandle-class.html#stat" +class="link"><code>stat</code></a> or <a +href="paramiko.SFTPHandle-class.html#chattr" +class="link"><code>chattr</code></a>. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#chattr" class="summary-sig-name"><code>chattr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>attr</span>)</span></code> +<br /> +Change the attributes of this file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +When a client closes a file, this method is called on the handle.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>length</span>)</span></code> +<br /> +Read up to <code>length</code> bytes from this file, starting at +position <code>offset</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return an <a href="paramiko.SFTPAttributes-class.html" +class="link"><code>SFTPAttributes</code></a> object referring to this +open file, or an error code.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Write <code>data</code> into this file at position +<code>offset</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_get_name"></a><span class="summary-sig"><span class="summary-sig-name">_get_name</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="../private/paramiko.SFTPHandle-class.html#_get_next_files" class="summary-sig-name"><code>_get_next_files</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Used by the SFTP server code to retreive a cached directory +listing.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPHandle-class.html#_set_files" class="summary-sig-name"><code>_set_files</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>files</span>)</span></code> +<br /> +Used by the SFTP server code to cache a directory listing.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_set_name"></a><span class="summary-sig"><span class="summary-sig-name">_set_name</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="chattr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">chattr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>attr</span>)</span> + </h3> + Change the attributes of this file. The <code>attr</code> object + will contain only those fields provided by the client in its request, + so you should check for the presence of fields before using them. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>attr</b></code> - + the attributes to change on this file. + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an error code like <a + href="../private/paramiko-module.html#SFTP_OK" + class="link"><code>SFTP_OK</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + <p>When a client closes a file, this method is called on the handle. + Normally you would use this method to close the underlying OS level + file object(s).</p> + The default implementation checks for attributes on + <code>self</code> named <code>readfile</code> and/or + <code>writefile</code>, and if either or both are present, their + <code>close()</code> methods are called. This means that if you are + using the default implementations of <a + href="paramiko.SFTPHandle-class.html#read" + class="link"><code>read</code></a> and <a + href="paramiko.SFTPHandle-class.html#write" + class="link"><code>write</code></a>, this method's default + implementation should be fine also. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">read</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>offset</span>, + <span class=sig-arg>length</span>)</span> + </h3> + <p>Read up to <code>length</code> bytes from this file, starting at + position <code>offset</code>. The offset may be a python long, since + SFTP allows it to be 64 bits.</p> + <p>If the end of the file has been reached, this method may return an + empty string to signify EOF, or it may also return <a + href="../private/paramiko-module.html#SFTP_EOF" + class="link"><code>SFTP_EOF</code></a>.</p> + The default implementation checks for an attribute on + <code>self</code> named <code>readfile</code>, and if present, performs + the read operation on the python file-like object found there. (This is + meant as a time saver for the common case where you are wrapping a + python file object.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>offset</b></code> - + position in the file to start reading from. + <br /><i> + (type=int or long)</i> + <dd><code><b>length</b></code> - + number of bytes to attempt to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + data read from the file, or an SFTP error code. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="stat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">stat</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return an <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> object referring to this + open file, or an error code. This is equivalent to <a + href="../private/paramiko.SFTPServerInterface-class.html#stat" + class="link"><code>SFTPServerInterface.stat</code></a>, except it's + called on an open file instead of a path. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an attributes object for the given file, or an SFTP error code + (like <a + href="../private/paramiko-module.html#SFTP_PERMISSION_DENIED" + class="link"><code>SFTP_PERMISSION_DENIED</code></a>). + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">write</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>offset</span>, + <span class=sig-arg>data</span>)</span> + </h3> + <p>Write <code>data</code> into this file at position + <code>offset</code>. Extending the file past its original end is + expected. Unlike python's normal <code>write()</code> methods, this + method cannot do a partial write: it must write all of + <code>data</code> or else return an error.</p> + The default implementation checks for an attribute on + <code>self</code> named <code>writefile</code>, and if present, + performs the write operation on the python file-like object found + there. The attribute is named differently from <code>readfile</code> to + make it easy to implement read-only (or write-only) files, but if both + attributes are present, they should refer to the same file. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>offset</b></code> - + position in the file to start reading from. + <br /><i> + (type=int or long)</i> + <dd><code><b>data</b></code> - + data to write into the file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SFTP error code like <a + href="../private/paramiko-module.html#SFTP_OK" + class="link"><code>SFTP_OK</code></a>. + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_get_next_files"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_get_next_files</span>(<span class=sig-arg>self</span>)</span> + </h3> + Used by the SFTP server code to retreive a cached directory + listing. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_set_files"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_set_files</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>files</span>)</span> + </h3> + Used by the SFTP server code to cache a directory listing. (In the + SFTP protocol, listing a directory is a multi-stage process requiring a + temporary handle.) + <dl><dt></dt><dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.SFTPServer-class.html b/docs/private/paramiko.SFTPServer-class.html new file mode 100644 index 0000000..07a16b0 --- /dev/null +++ b/docs/private/paramiko.SFTPServer-class.html @@ -0,0 +1,511 @@ +<?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>paramiko.SFTPServer</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPServer + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SFTPServer-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPServer-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPServer</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a> --+ + | + <a href="threading.Thread-class.html"><code>Thread</code></a> --+ + | + <a href="paramiko.SubsystemHandler-class.html"><code>SubsystemHandler</code></a> --+ + | + <a href="__builtin__.object-class.html"><code>object</code></a> --+ | + | | + <a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a> --+ + | + <b>SFTPServer</b> +</pre><br /> + +<hr/> + +Server-side SFTP subsystem support. Since this is a <a +href="paramiko.SubsystemHandler-class.html" +class="link"><code>SubsystemHandler</code></a>, it can be (and is meant +to be) set as the handler for <code>"sftp"</code> requests. Use +<a href="paramiko.Transport-class.html#set_subsystem_handler" +class="link"><code>Transport.set_subsystem_handler</code></a> to activate +this class. +<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="paramiko.SFTPServer-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>server</span>, + <span class=summary-sig-arg>sftp_si</span>, + <span class="summary-sig-vararg">*largs</span>, + <span class="summary-sig-kwarg">**kwargs</span>)</span></code> +<br /> +The constructor for SFTPServer is meant to be called from within the +<a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> as a subsystem handler.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPServer-class.html#convert_errno" class="summary-sig-name"><code>convert_errno</code></a>(<span class=summary-sig-arg>e</span>)</span></code> +<br /> +Convert an errno value (as from an <code>OSError</code> or +<code>IOError</code>) into a standard SFTP result code. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPServer-class.html#finish_subsystem" class="summary-sig-name"><code>finish_subsystem</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Perform any cleanup at the end of a subsystem.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPServer-class.html#set_file_attr" class="summary-sig-name"><code>set_file_attr</code></a>(<span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>attr</span>)</span></code> +<br /> +Change a file's attributes on the local filesystem. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPServer-class.html#start_subsystem" class="summary-sig-name"><code>start_subsystem</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>transport</span>, + <span class=summary-sig-arg>channel</span>)</span></code> +<br /> +Process an ssh subsystem in server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_check_file"></a><span class="summary-sig"><span class="summary-sig-name">_check_file</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>request_number</span>, + <span class=summary-sig-arg>msg</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="../private/paramiko.SFTPServer-class.html#_convert_pflags" class="summary-sig-name"><code>_convert_pflags</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>pflags</span>)</span></code> +<br /> +convert SFTP-style open() flags to python's os.open() flags</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_open_folder"></a><span class="summary-sig"><span class="summary-sig-name">_open_folder</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>request_number</span>, + <span class=summary-sig-arg>path</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_process"></a><span class="summary-sig"><span class="summary-sig-name">_process</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>t</span>, + <span class=summary-sig-arg>request_number</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_read_folder"></a><span class="summary-sig"><span class="summary-sig-name">_read_folder</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>request_number</span>, + <span class=summary-sig-arg>folder</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_response"></a><span class="summary-sig"><span class="summary-sig-name">_response</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>request_number</span>, + <span class=summary-sig-arg>t</span>, + <span class="summary-sig-vararg">*arg</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_send_handle_response"></a><span class="summary-sig"><span class="summary-sig-name">_send_handle_response</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>request_number</span>, + <span class=summary-sig-arg>handle</span>, + <span class=summary-sig-arg>folder</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_send_status"></a><span class="summary-sig"><span class="summary-sig-name">_send_status</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>request_number</span>, + <span class=summary-sig-arg>code</span>, + <span class=summary-sig-arg>desc</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BaseSFTP</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BaseSFTP-class.html#_log" class="summary-sig-name"><code>_log</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>level</span>, + <span class=summary-sig-arg>msg</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="../private/paramiko.BaseSFTP-class.html#_read_all" class="summary-sig-name"><code>_read_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</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="../private/paramiko.BaseSFTP-class.html#_read_packet" class="summary-sig-name"><code>_read_packet</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="../private/paramiko.BaseSFTP-class.html#_send_packet" class="summary-sig-name"><code>_send_packet</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>t</span>, + <span class=summary-sig-arg>packet</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="../private/paramiko.BaseSFTP-class.html#_send_server_version" class="summary-sig-name"><code>_send_server_version</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="../private/paramiko.BaseSFTP-class.html#_send_version" class="summary-sig-name"><code>_send_version</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="../private/paramiko.BaseSFTP-class.html#_write_all" class="summary-sig-name"><code>_write_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>out</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from SubsystemHandler</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SubsystemHandler-class.html#get_server" class="summary-sig-name"><code>get_server</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the <a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> object associated with this +channel and subsystem.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SubsystemHandler-class.html#_run" class="summary-sig-name"><code>_run</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Thread</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="threading.Thread-class.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="threading.Thread-class.html#getName" class="summary-sig-name"><code>getName</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="threading.Thread-class.html#isAlive" class="summary-sig-name"><code>isAlive</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="threading.Thread-class.html#isDaemon" class="summary-sig-name"><code>isDaemon</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="threading.Thread-class.html#join" class="summary-sig-name"><code>join</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</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="threading.Thread-class.html#run" class="summary-sig-name"><code>run</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="threading.Thread-class.html#setDaemon" class="summary-sig-name"><code>setDaemon</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>daemonic</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="threading.Thread-class.html#setName" class="summary-sig-name"><code>setName</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</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="threading.Thread-class.html#start" class="summary-sig-name"><code>start</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="../private/threading.Thread-class.html#_set_daemon" class="summary-sig-name"><code>_set_daemon</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from _Verbose</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/threading._Verbose-class.html#_note" class="summary-sig-name"><code>_note</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>format</span>, + <span class="summary-sig-vararg">*args</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Thread</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td> +<td><b><a href="../private/threading.Thread-class.html#__initialized"><code>_Thread__initialized</code></a></b> = <span title="False"><code>False </code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>channel</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>server</span>, + <span class=sig-arg>sftp_si</span>=<span class=sig-default><class 'paramiko.SFTPServerInterface'></span>, + <span class="sig-vararg">*largs</span>, + <span class="sig-kwarg">**kwargs</span>)</span> + <br /><i>(Constructor)</i> + </h3> + The constructor for SFTPServer is meant to be called from within the + <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> as a subsystem handler. + <code>server</code> and any additional parameters or keyword parameters + are passed from the original call to <a + href="paramiko.Transport-class.html#set_subsystem_handler" + class="link"><code>Transport.set_subsystem_handler</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>channel</b></code> - + channel passed from the <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + <dd><code><b>name</b></code> - + name of the requested subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>server</b></code> - + the server object associated with this channel and + subsystem + <br /><i> + (type=<a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a>)</i> + <dd><code><b>sftp_si</b></code> - + a subclass of <a + href="../private/paramiko.SFTPServerInterface-class.html" + class="link"><code>SFTPServerInterface</code></a> to use for + handling individual requests. + <br /><i> + (type=class)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.BaseSFTP-class.html#__init__"><code>paramiko.BaseSFTP.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="finish_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">finish_subsystem</span>(<span class=sig-arg>self</span>)</span> + </h3> + Perform any cleanup at the end of a subsystem. The default + implementation just closes the channel. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="paramiko.SubsystemHandler-class.html#finish_subsystem"><code>paramiko.SubsystemHandler.finish_subsystem</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="start_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">start_subsystem</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>transport</span>, + <span class=sig-arg>channel</span>)</span> + </h3> + <p>Process an ssh subsystem in server mode. This method is called on a + new object (and in a new thread) for each subsystem request. It is + assumed that all subsystem logic will take place here, and when the + subsystem is finished, this method will return. After this method + returns, the channel is closed.</p> + The combination of <code>transport</code> and <code>channel</code> + are unique; this handler corresponds to exactly one <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> on one <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + name of the requested subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>transport</b></code> - + the server-mode <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <br /><i> + (type=<a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>)</i> + <dd><code><b>channel</b></code> - + the channel associated with this subsystem request. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="paramiko.SubsystemHandler-class.html#start_subsystem"><code>paramiko.SubsystemHandler.start_subsystem</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Note:</b> It is the responsibility of this method to exit if the underlying <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> is closed. This can be done by +checking <a href="paramiko.Transport-class.html#is_active" +class="link"><code>Transport.is_active</code></a> or noticing an EOF on +the <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>. If this method loops forever +without checking for this case, your python interpreter may refuse to +exit because this thread will still be running. +</p> + + </dd></dl> +</td></tr></table> + +<a name="_convert_pflags"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_convert_pflags</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>pflags</span>)</span> + </h3> + convert SFTP-style open() flags to python's os.open() flags + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF STATIC METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Static Method Details</th></tr> +</table> + +<a name="convert_errno"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">convert_errno</span>(<span class=sig-arg>e</span>)</span> + </h3> + Convert an errno value (as from an <code>OSError</code> or + <code>IOError</code>) into a standard SFTP result code. This is a + convenience function for trapping exceptions in server code and + returning an appropriate result. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>e</b></code> - + an errno code, as from <code>OSError.errno</code>. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SFTP error code like <a + href="../private/paramiko-module.html#SFTP_NO_SUCH_FILE" + class="link"><code>SFTP_NO_SUCH_FILE</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="set_file_attr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_file_attr</span>(<span class=sig-arg>filename</span>, + <span class=sig-arg>attr</span>)</span> + </h3> + <p>Change a file's attributes on the local filesystem. The contents of + <code>attr</code> are used to change the permissions, owner, group + ownership, and/or modification & access time of the file, depending + on which attributes are present in <code>attr</code>.</p> + This is meant to be a handy helper function for translating SFTP + file requests into local file operations. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to alter (should usually be an absolute + path). + <br /><i> + (type=str)</i> + <dd><code><b>attr</b></code> - + attributes to change. + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.SFTPServerInterface-class.html b/docs/private/paramiko.SFTPServerInterface-class.html new file mode 100644 index 0000000..a0bd429 --- /dev/null +++ b/docs/private/paramiko.SFTPServerInterface-class.html @@ -0,0 +1,744 @@ +<?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>paramiko.SFTPServerInterface</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPServerInterface + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.SFTPServerInterface-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPServerInterface</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>SFTPServerInterface</b> +</pre><br /> + +<hr/> + +<p>This class defines an interface for controlling the behavior of +paramiko when using the <a href="paramiko.SFTPServer-class.html" +class="link"><code>SFTPServer</code></a> subsystem to provide an SFTP +server.</p> +Methods on this class are called from the SFTP session's thread, so +you can block as long as necessary without affecting other sessions (even +other SFTP sessions). However, raising an exception will usually cause +the SFTP session to abruptly end, so you will usually want to catch +exceptions and return an appropriate error code. +<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="../private/paramiko.SFTPServerInterface-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>server</span>, + <span class="summary-sig-vararg">*largs</span>, + <span class="summary-sig-kwarg">**kwargs</span>)</span></code> +<br /> +Create a new SFTPServerInterface object.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#canonicalize" class="summary-sig-name"><code>canonicalize</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the canonical form of a path on the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#chattr" class="summary-sig-name"><code>chattr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>attr</span>)</span></code> +<br /> +Change the attributes of a file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#list_folder" class="summary-sig-name"><code>list_folder</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return a list of files within a given folder.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#lstat" class="summary-sig-name"><code>lstat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return an <a href="paramiko.SFTPAttributes-class.html" +class="link"><code>SFTPAttributes</code></a> object for a path on the +server, or an error code.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#mkdir" class="summary-sig-name"><code>mkdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>attr</span>)</span></code> +<br /> +Create a new directory with the given attributes.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#open" class="summary-sig-name"><code>open</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>flags</span>, + <span class=summary-sig-arg>attr</span>)</span></code> +<br /> +Open a file on the server and create a handle for future operations on +that file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str <i>or error code</i> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#readlink" class="summary-sig-name"><code>readlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the target of a symbolic link (or shortcut) on the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#remove" class="summary-sig-name"><code>remove</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Delete a file, if possible.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#rename" class="summary-sig-name"><code>rename</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>oldpath</span>, + <span class=summary-sig-arg>newpath</span>)</span></code> +<br /> +Rename (or move) a file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#rmdir" class="summary-sig-name"><code>rmdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove a directory if it exists.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#session_ended" class="summary-sig-name"><code>session_ended</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +The SFTP server session has just ended, either cleanly or via an +exception.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#session_started" class="summary-sig-name"><code>session_started</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +The SFTP server session has just started.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return an <a href="paramiko.SFTPAttributes-class.html" +class="link"><code>SFTPAttributes</code></a> object for a path on the +server, or an error code.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.SFTPServerInterface-class.html#symlink" class="summary-sig-name"><code>symlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>target_path</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Create a symbolic link on the server, as new pathname +<code>path</code>, with <code>target_path</code> as the target of the +link.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>server</span>, + <span class="sig-vararg">*largs</span>, + <span class="sig-kwarg">**kwargs</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new SFTPServerInterface object. This method does nothing by + default and is meant to be overridden by subclasses. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>server</b></code> - + the server object associated with this channel and SFTP + subsystem + <br /><i> + (type=<a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="canonicalize"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">canonicalize</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + <p>Return the canonical form of a path on the server. For example, if + the server's home folder is <code>/home/foo</code>, the path + <code>"../betty"</code> would be canonicalized to + <code>"/home/betty"</code>. Note the obvious security issues: + if you're serving files only from a specific folder, you probably don't + want this method to reveal path names outside that folder.</p> + <p>You may find the python methods in <code>os.path</code> useful, + especially <code>os.path.normpath</code> and + <code>os.path.realpath</code>.</p> + The default implementation returns <code>os.path.normpath('/' + + path)</code>. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="chattr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">chattr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>attr</span>)</span> + </h3> + Change the attributes of a file. The <code>attr</code> object will + contain only those fields provided by the client in its request, so you + should check for the presence of fields before using them. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + requested path (relative or absolute) of the file to + change. + <br /><i> + (type=str)</i> + <dd><code><b>attr</b></code> - + requested attributes to change on the file. + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an error code like <a + href="../private/paramiko-module.html#SFTP_OK" + class="link"><code>SFTP_OK</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="list_folder"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">list_folder</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + <p>Return a list of files within a given folder. The <code>path</code> + will use posix notation (<code>"/"</code> separates folder + names) and may be an absolute or relative path.</p> + <p>The list of files is expected to be a list of <a + href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> objects, which are similar + in structure to the objects returned by <code>os.stat</code>. In + addition, each object should have its <code>filename</code> field + filled in, since this is important to a directory listing and not + normally present in <code>os.stat</code> results. The method + <code>SFTPAttributes.from_stat</code> will usually do what you + want.</p> + In case of an error, you should return one of the + <code>SFTP_*</code> error codes, such as <a + href="../private/paramiko-module.html#SFTP_PERMISSION_DENIED" + class="link"><code>SFTP_PERMISSION_DENIED</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + the requested path (relative or absolute) to be listed. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a list of the files in the given folder, using <a + href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> objects. + <br /><i> + (type=list of <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i>)</i> + </dd> + </dl> +<p><b>Note:</b> You should normalize the given <code>path</code> first (see the +<code>os.path</code> module) and check appropriate permissions before +returning the list of files. Be careful of malicious clients attempting +to use relative paths to escape restricted folders, if you're doing a +direct translation from the SFTP server path to your local +filesystem. +</p> + + </dd></dl> +</td></tr></table> + +<a name="lstat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">lstat</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Return an <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> object for a path on the + server, or an error code. If your server supports symbolic links (also + known as "aliases"), you should <i>not</i> follow them -- + instead, you should return data on the symlink or alias itself. (<a + href="../private/paramiko.SFTPServerInterface-class.html#stat" + class="link"><code>stat</code></a> is the corresponding call that + follows symlinks/aliases.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + the requested path (relative or absolute) to fetch file + statistics for. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an attributes object for the given file, or an SFTP error code + (like <a + href="../private/paramiko-module.html#SFTP_PERMISSION_DENIED" + class="link"><code>SFTP_PERMISSION_DENIED</code></a>). + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="mkdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">mkdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>attr</span>)</span> + </h3> + <p>Create a new directory with the given attributes. The + <code>attr</code> object may be considered a "hint" and + ignored.</p> + The <code>attr</code> object will contain only those fields provided + by the client in its request, so you should use <code>hasattr</code> to + check for the presense of fields before using them. In some cases, the + <code>attr</code> object may be completely empty. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + requested path (relative or absolute) of the new folder. + <br /><i> + (type=str)</i> + <dd><code><b>attr</b></code> - + requested attributes of the new folder. + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SFTP error code like <a + href="../private/paramiko-module.html#SFTP_OK" + class="link"><code>SFTP_OK</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="open"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">open</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>flags</span>, + <span class=sig-arg>attr</span>)</span> + </h3> + <p>Open a file on the server and create a handle for future operations + on that file. On success, a new object subclassed from <a + href="paramiko.SFTPHandle-class.html" + class="link"><code>SFTPHandle</code></a> should be returned. This + handle will be used for future operations on the file (read, write, + etc). On failure, an error code such as <a + href="../private/paramiko-module.html#SFTP_PERMISSION_DENIED" + class="link"><code>SFTP_PERMISSION_DENIED</code></a> should be + returned.</p> + <code>flags</code> contains the requested mode for opening + (read-only, write-append, etc) as a bitset of flags from the + <code>os</code> module: + <ul> + <li> + <code>os.O_RDONLY</code> + </li> + <li> + <code>os.O_WRONLY</code> + </li> + <li> + <code>os.O_RDWR</code> + </li> + <li> + <code>os.O_APPEND</code> + </li> + <li> + <code>os.O_CREAT</code> + </li> + <li> + <code>os.O_TRUNC</code> + </li> + <li> + <code>os.O_EXCL</code> + </li> + </ul> + <p>(One of <code>os.O_RDONLY</code>, <code>os.O_WRONLY</code>, or + <code>os.O_RDWR</code> will always be set.)</p> + The <code>attr</code> object contains requested attributes of the + file if it has to be created. Some or all attribute fields may be + missing if the client didn't specify them. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + the requested path (relative or absolute) of the file to be + opened. + <br /><i> + (type=str)</i> + <dd><code><b>flags</b></code> - + flags or'd together from the <code>os</code> module indicating + the requested mode for opening the file. + <br /><i> + (type=int)</i> + <dd><code><b>attr</b></code> - + requested attributes of the file if it is newly created. + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a new <a href="paramiko.SFTPHandle-class.html" + class="link"><code>SFTPHandle</code></a> <i>or error code</i>. + @rtype <a href="paramiko.SFTPHandle-class.html" + class="link"><code>SFTPHandle</code></a> + </dd> + </dl> +<p><b>Note:</b> The SFTP protocol defines all files to be in "binary" mode. +There is no equivalent to python's "text" mode. +</p> + + </dd></dl> +</td></tr></table> + +<a name="readlink"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">readlink</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Return the target of a symbolic link (or shortcut) on the server. If + the specified path doesn't refer to a symbolic link, an error should be + returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path (relative or absolute) of the symbolic link. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + the target path of the symbolic link, or an error code like <a + href="../private/paramiko-module.html#SFTP_NO_SUCH_FILE" + class="link"><code>SFTP_NO_SUCH_FILE</code></a>. + <br /><i> + (type=str <i>or error code</i>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="remove"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">remove</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Delete a file, if possible. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + the requested path (relative or absolute) of the file to + delete. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SFTP error code like <a + href="../private/paramiko-module.html#SFTP_OK" + class="link"><code>SFTP_OK</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="rename"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">rename</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>oldpath</span>, + <span class=sig-arg>newpath</span>)</span> + </h3> + Rename (or move) a file. The SFTP specification implies that this + method can be used to move an existing file into a different folder, + and since there's no other (easy) way to move files via SFTP, it's + probably a good idea to implement "move" in this method too, + even for files that cross disk partition boundaries, if at all + possible. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>oldpath</b></code> - + the requested path (relative or absolute) of the existing + file. + <br /><i> + (type=str)</i> + <dd><code><b>newpath</b></code> - + the requested new path of the file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SFTP error code like <a + href="../private/paramiko-module.html#SFTP_OK" + class="link"><code>SFTP_OK</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Note:</b> You should return an error if a file with the same name as +<code>newpath</code> already exists. (The rename operation should be +non-desctructive.) +</p> + + </dd></dl> +</td></tr></table> + +<a name="rmdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">rmdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Remove a directory if it exists. The <code>path</code> should refer + to an existing, empty folder -- otherwise this method should return an + error. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + requested path (relative or absolute) of the folder to + remove. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SFTP error code like <a + href="../private/paramiko-module.html#SFTP_OK" + class="link"><code>SFTP_OK</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="session_ended"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">session_ended</span>(<span class=sig-arg>self</span>)</span> + </h3> + The SFTP server session has just ended, either cleanly or via an + exception. This method is meant to be overridden to perform any + necessary cleanup before this <code>SFTPServerInterface</code> object + is destroyed. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="session_started"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">session_started</span>(<span class=sig-arg>self</span>)</span> + </h3> + The SFTP server session has just started. This method is meant to be + overridden to perform any necessary setup before handling callbacks + from SFTP operations. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="stat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">stat</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Return an <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> object for a path on the + server, or an error code. If your server supports symbolic links (also + known as "aliases"), you should follow them. (<a + href="../private/paramiko.SFTPServerInterface-class.html#lstat" + class="link"><code>lstat</code></a> is the corresponding call that + doesn't follow symlinks/aliases.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + the requested path (relative or absolute) to fetch file + statistics for. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an attributes object for the given file, or an SFTP error code + (like <a + href="../private/paramiko-module.html#SFTP_PERMISSION_DENIED" + class="link"><code>SFTP_PERMISSION_DENIED</code></a>). + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="symlink"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">symlink</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>target_path</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Create a symbolic link on the server, as new pathname + <code>path</code>, with <code>target_path</code> as the target of the + link. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>target_path</b></code> - + path (relative or absolute) of the target for this new + symbolic link. + <br /><i> + (type=str)</i> + <dd><code><b>path</b></code> - + path (relative or absolute) of the symbolic link to + create. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an error code like <code>SFTP_OK</code>. + <br /><i> + (type=int)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.SSHException-class.html b/docs/private/paramiko.SSHException-class.html new file mode 100644 index 0000000..74d34e6 --- /dev/null +++ b/docs/private/paramiko.SSHException-class.html @@ -0,0 +1,95 @@ +<?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>paramiko.SSHException</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SSHException + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SSHException-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SSHException-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class SSHException</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <b>SSHException</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.BadAuthenticationType-class.html"><code>BadAuthenticationType</code></a>, + <a href="paramiko.PasswordRequiredException-class.html"><code>PasswordRequiredException</code></a>, + <a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html"><code>PartialAuthentication</code></a></dd></dl> + +<hr/> + +Exception raised by failures in SSH2 protocol negotiation or logic +errors. +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.SecurityOptions-class.html b/docs/private/paramiko.SecurityOptions-class.html new file mode 100644 index 0000000..1763962 --- /dev/null +++ b/docs/private/paramiko.SecurityOptions-class.html @@ -0,0 +1,373 @@ +<?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>paramiko.SecurityOptions</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SecurityOptions + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SecurityOptions-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SecurityOptions-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SecurityOptions</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>SecurityOptions</b> +</pre><br /> + +<hr/> + +<p>Simple object containing the security preferences of an ssh transport. +These are tuples of acceptable ciphers, digests, key types, and key +exchange algorithms, listed in order of preference.</p> +Changing the contents and/or order of these fields affects the +underlying <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> (but only if you change them +before starting the session). If you try to add an algorithm that +paramiko doesn't recognize, <code>ValueError</code> will be raised. If +you try to assign something besides a tuple to one of the fields, +<code>TypeError</code> will be raised. +<hr/> + +<p><b>Since:</b> ivysaur +</p> + + +<!-- =========== 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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>transport</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SecurityOptions-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns a string representation of this object, for debugging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_get_ciphers"></a><span class="summary-sig"><span class="summary-sig-name">_get_ciphers</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><a name="_get_compression"></a><span class="summary-sig"><span class="summary-sig-name">_get_compression</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><a name="_get_digests"></a><span class="summary-sig"><span class="summary-sig-name">_get_digests</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><a name="_get_kex"></a><span class="summary-sig"><span class="summary-sig-name">_get_kex</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><a name="_get_key_types"></a><span class="summary-sig"><span class="summary-sig-name">_get_key_types</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><a name="_set"></a><span class="summary-sig"><span class="summary-sig-name">_set</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>orig</span>, + <span class=summary-sig-arg>x</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_set_ciphers"></a><span class="summary-sig"><span class="summary-sig-name">_set_ciphers</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_set_compression"></a><span class="summary-sig"><span class="summary-sig-name">_set_compression</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_set_digests"></a><span class="summary-sig"><span class="summary-sig-name">_set_digests</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_set_kex"></a><span class="summary-sig"><span class="summary-sig-name">_set_kex</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_set_key_types"></a><span class="summary-sig"><span class="summary-sig-name">_set_key_types</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</td></tr> +</table><br /> + + +<!-- =========== START OF PROPERTY SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Property Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#ciphers"><code>ciphers</code></a></b>: Symmetric encryption ciphers</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#compression"><code>compression</code></a></b>: Compression algorithms</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#digests"><code>digests</code></a></b>: Digest (one-way hash) algorithms</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#kex"><code>kex</code></a></b>: Key exchange algorithms</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#key_types"><code>key_types</code></a></b>: Public-key algorithms</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>list</code></font></td> +<td><b><a href="paramiko.SecurityOptions-class.html#__slots__"><code>__slots__</code></a></b> = <span title="['ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport']"><code>['ciphers', 'digests', 'key_types', 'kex', '<span class="variable-ellipsis">...</span></code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>member_descriptor</code></font></td> +<td><b><a href="../private/paramiko.SecurityOptions-class.html#_transport"><code>_transport</code></a></b> = <span title="<member '_transport' of 'SecurityOptions' objects>"><code><member '_transport' of 'SecurityOptions' o<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="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + Returns a string representation of this object, for debugging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + str + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF PROPERTY DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Property Details</th></tr> +</table> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="ciphers"></a> +<h3>ciphers</h3> +Symmetric encryption ciphers +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Get Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_get_ciphers" class="summary-sig-name"><code>_get_ciphers</code></a>(<span class=summary-sig-arg>self</span>)</span> + </dd> + <dt><b>Set Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_set_ciphers" class="summary-sig-name"><code>_set_ciphers</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span> + </dd> + </dl> + </dd> +</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="compression"></a> +<h3>compression</h3> +Compression algorithms +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Get Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_get_compression" class="summary-sig-name"><code>_get_compression</code></a>(<span class=summary-sig-arg>self</span>)</span> + </dd> + <dt><b>Set Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_set_compression" class="summary-sig-name"><code>_set_compression</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span> + </dd> + </dl> + </dd> +</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="digests"></a> +<h3>digests</h3> +Digest (one-way hash) algorithms +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Get Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_get_digests" class="summary-sig-name"><code>_get_digests</code></a>(<span class=summary-sig-arg>self</span>)</span> + </dd> + <dt><b>Set Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_set_digests" class="summary-sig-name"><code>_set_digests</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span> + </dd> + </dl> + </dd> +</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="kex"></a> +<h3>kex</h3> +Key exchange algorithms +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Get Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_get_kex" class="summary-sig-name"><code>_get_kex</code></a>(<span class=summary-sig-arg>self</span>)</span> + </dd> + <dt><b>Set Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_set_kex" class="summary-sig-name"><code>_set_kex</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span> + </dd> + </dl> + </dd> +</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="key_types"></a> +<h3>key_types</h3> +Public-key algorithms +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Get Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_get_key_types" class="summary-sig-name"><code>_get_key_types</code></a>(<span class=summary-sig-arg>self</span>)</span> + </dd> + <dt><b>Set Method:</b></dt> + <dd><span class="summary-sig"><a href="../private/paramiko.SecurityOptions-class.html#_set_key_types" class="summary-sig-name"><code>_set_key_types</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span> + </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="__slots__"></a> +<h3>__slots__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>list</code> + + </dd> +<span title="['ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport']"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +['ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport'<span class="variable-linewrap">\</span> +] </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_transport"></a> +<h3>_transport</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>member_descriptor</code> + + </dd> +<span title="<member '_transport' of 'SecurityOptions' objects>"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<member '_transport' of 'SecurityOptions' objects> </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.ServerInterface-class.html b/docs/private/paramiko.ServerInterface-class.html new file mode 100644 index 0000000..5cf358f --- /dev/null +++ b/docs/private/paramiko.ServerInterface-class.html @@ -0,0 +1,894 @@ +<?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>paramiko.ServerInterface</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class ServerInterface + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.ServerInterface-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type ServerInterface</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>ServerInterface</b> +</pre><br /> + +<hr/> + +<p>This class defines an interface for controlling the behavior of +paramiko in server mode.</p> +Methods on this class are called from paramiko's primary thread, so +you shouldn't do too much work in them. (Certainly nothing that blocks or +sleeps.) +<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"> int or <a href="paramiko.server.InteractiveQuery-class.html" + class="link"><code>InteractiveQuery</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_auth_interactive" class="summary-sig-name"><code>check_auth_interactive</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>submethods</span>)</span></code> +<br /> +Begin an interactive authentication challenge, if supported.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int or <a href="paramiko.server.InteractiveQuery-class.html" + class="link"><code>InteractiveQuery</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_auth_interactive_response" class="summary-sig-name"><code>check_auth_interactive_response</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>responses</span>)</span></code> +<br /> +Continue or finish an interactive authentication challenge, if +supported.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_auth_none" class="summary-sig-name"><code>check_auth_none</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>)</span></code> +<br /> +Determine if a client may open channels with no (further) +authentication.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_auth_password" class="summary-sig-name"><code>check_auth_password</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Determine if a given username and password supplied by the client is +acceptable for use in authentication.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_auth_publickey" class="summary-sig-name"><code>check_auth_publickey</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>key</span>)</span></code> +<br /> +Determine if a given key supplied by the client is acceptable for use +in authentication.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_channel_exec_request" class="summary-sig-name"><code>check_channel_exec_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>command</span>)</span></code> +<br /> +Determine if a shell command will be executed for the client.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_channel_pty_request" class="summary-sig-name"><code>check_channel_pty_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>term</span>, + <span class=summary-sig-arg>width</span>, + <span class=summary-sig-arg>height</span>, + <span class=summary-sig-arg>pixelwidth</span>, + <span class=summary-sig-arg>pixelheight</span>, + <span class=summary-sig-arg>modes</span>)</span></code> +<br /> +Determine if a pseudo-terminal of the given dimensions (usually +requested for shell access) can be provided on the given channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_channel_request" class="summary-sig-name"><code>check_channel_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>kind</span>, + <span class=summary-sig-arg>chanid</span>)</span></code> +<br /> +Determine if a channel request of a given type will be granted, and +return <code>OPEN_SUCCEEDED</code> or an error code.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_channel_shell_request" class="summary-sig-name"><code>check_channel_shell_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>)</span></code> +<br /> +Determine if a shell will be provided to the client on the given +channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_channel_subsystem_request" class="summary-sig-name"><code>check_channel_subsystem_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>name</span>)</span></code> +<br /> +Determine if a requested subsystem will be provided to the client on +the given channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_channel_window_change_request" class="summary-sig-name"><code>check_channel_window_change_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>width</span>, + <span class=summary-sig-arg>height</span>, + <span class=summary-sig-arg>pixelwidth</span>, + <span class=summary-sig-arg>pixelheight</span>)</span></code> +<br /> +Determine if the pseudo-terminal on the given channel can be +resized.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#check_global_request" class="summary-sig-name"><code>check_global_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>kind</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +<br /> +Handle a global request of the given <code>kind</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ServerInterface-class.html#get_allowed_auths" class="summary-sig-name"><code>get_allowed_auths</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>)</span></code> +<br /> +Return a list of authentication methods supported by the server.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__init__(...) initializes x; see x.__class__.__doc__ for +signature</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="check_auth_interactive"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_auth_interactive</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>submethods</span>)</span> + </h3> + <p>Begin an interactive authentication challenge, if supported. You + should override this method in server mode if you want to support the + <code>"keyboard-interactive"</code> auth type, which requires + you to send a series of questions for the client to answer.</p> + <p>Return <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if this auth method isn't + supported. Otherwise, you should return an <a + href="paramiko.server.InteractiveQuery-class.html" + class="link"><code>InteractiveQuery</code></a> object containing the + prompts and instructions for the user. The response will be sent via a + call to <a + href="../private/paramiko.ServerInterface-class.html#check_auth_interactive_response" + class="link"><code>check_auth_interactive_response</code></a>.</p> + The default implementation always returns <a + href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username of the authenticating client + <br /><i> + (type=str)</i> + <dd><code><b>submethods</b></code> - + a comma-separated list of methods preferred by the client + (usually empty) + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if this auth method + isn't supported; otherwise an object containing queries for the + user + <br /><i> + (type=int or <a href="paramiko.server.InteractiveQuery-class.html" + class="link"><code>InteractiveQuery</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="check_auth_interactive_response"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_auth_interactive_response</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>responses</span>)</span> + </h3> + <p>Continue or finish an interactive authentication challenge, if + supported. You should override this method in server mode if you want + to support the <code>"keyboard-interactive"</code> auth + type.</p> + <p>Return <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if the responses are not + accepted, <a href="../private/paramiko-module.html#AUTH_SUCCESSFUL" + class="link"><code>AUTH_SUCCESSFUL</code></a> if the responses are + accepted and complete the authentication, or <a + href="../private/paramiko-module.html#AUTH_PARTIALLY_SUCCESSFUL" + class="link"><code>AUTH_PARTIALLY_SUCCESSFUL</code></a> if your + authentication is stateful, and this set of responses is accepted for + authentication, but more authentication is required. (In this latter + case, <a + href="../private/paramiko.ServerInterface-class.html#get_allowed_auths" + class="link"><code>get_allowed_auths</code></a> will be called to + report to the client what options it has for continuing the + authentication.)</p> + <p>If you wish to continue interactive authentication with more + questions, you may return an <a + href="paramiko.server.InteractiveQuery-class.html" + class="link"><code>InteractiveQuery</code></a> object, which should + cause the client to respond with more answers, calling this method + again. This cycle can continue indefinitely.</p> + The default implementation always returns <a + href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>responses</b></code> - + list of responses from the client + <br /><i> + (type=list(str))</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if the authentication + fails; <a href="../private/paramiko-module.html#AUTH_SUCCESSFUL" + class="link"><code>AUTH_SUCCESSFUL</code></a> if it succeeds; <a + href="../private/paramiko-module.html#AUTH_PARTIALLY_SUCCESSFUL" + class="link"><code>AUTH_PARTIALLY_SUCCESSFUL</code></a> if the + interactive auth is successful, but authentication must continue; + otherwise an object containing queries for the user + <br /><i> + (type=int or <a href="paramiko.server.InteractiveQuery-class.html" + class="link"><code>InteractiveQuery</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="check_auth_none"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_auth_none</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>)</span> + </h3> + <p>Determine if a client may open channels with no (further) + authentication.</p> + <p>Return <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if the client must + authenticate, or <a + href="../private/paramiko-module.html#AUTH_SUCCESSFUL" + class="link"><code>AUTH_SUCCESSFUL</code></a> if it's okay for the + client to not authenticate.</p> + The default implementation always returns <a + href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username of the client. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if the authentication + fails; <a href="../private/paramiko-module.html#AUTH_SUCCESSFUL" + class="link"><code>AUTH_SUCCESSFUL</code></a> if it succeeds. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="check_auth_password"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_auth_password</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>password</span>)</span> + </h3> + <p>Determine if a given username and password supplied by the client is + acceptable for use in authentication.</p> + <p>Return <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if the password is not + accepted, <a href="../private/paramiko-module.html#AUTH_SUCCESSFUL" + class="link"><code>AUTH_SUCCESSFUL</code></a> if the password is + accepted and completes the authentication, or <a + href="../private/paramiko-module.html#AUTH_PARTIALLY_SUCCESSFUL" + class="link"><code>AUTH_PARTIALLY_SUCCESSFUL</code></a> if your + authentication is stateful, and this key is accepted for + authentication, but more authentication is required. (In this latter + case, <a + href="../private/paramiko.ServerInterface-class.html#get_allowed_auths" + class="link"><code>get_allowed_auths</code></a> will be called to + report to the client what options it has for continuing the + authentication.)</p> + The default implementation always returns <a + href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username of the authenticating client. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + the password given by the client. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if the authentication + fails; <a href="../private/paramiko-module.html#AUTH_SUCCESSFUL" + class="link"><code>AUTH_SUCCESSFUL</code></a> if it succeeds; <a + href="../private/paramiko-module.html#AUTH_PARTIALLY_SUCCESSFUL" + class="link"><code>AUTH_PARTIALLY_SUCCESSFUL</code></a> if the + password auth is successful, but authentication must + continue. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="check_auth_publickey"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_auth_publickey</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>key</span>)</span> + </h3> + <p>Determine if a given key supplied by the client is acceptable for + use in authentication. You should override this method in server mode + to check the username and key and decide if you would accept a + signature made using this key.</p> + <p>Return <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if the key is not accepted, + <a href="../private/paramiko-module.html#AUTH_SUCCESSFUL" + class="link"><code>AUTH_SUCCESSFUL</code></a> if the key is accepted + and completes the authentication, or <a + href="../private/paramiko-module.html#AUTH_PARTIALLY_SUCCESSFUL" + class="link"><code>AUTH_PARTIALLY_SUCCESSFUL</code></a> if your + authentication is stateful, and this password is accepted for + authentication, but more authentication is required. (In this latter + case, <a + href="../private/paramiko.ServerInterface-class.html#get_allowed_auths" + class="link"><code>get_allowed_auths</code></a> will be called to + report to the client what options it has for continuing the + authentication.)</p> + <p>Note that you don't have to actually verify any key signtature here. + If you're willing to accept the key, paramiko will do the work of + verifying the client's signature.</p> + The default implementation always returns <a + href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username of the authenticating client + <br /><i> + (type=str)</i> + <dd><code><b>key</b></code> - + the key object provided by the client + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <a href="../private/paramiko-module.html#AUTH_FAILED" + class="link"><code>AUTH_FAILED</code></a> if the client can't + authenticate with this key; <a + href="../private/paramiko-module.html#AUTH_SUCCESSFUL" + class="link"><code>AUTH_SUCCESSFUL</code></a> if it can; <a + href="../private/paramiko-module.html#AUTH_PARTIALLY_SUCCESSFUL" + class="link"><code>AUTH_PARTIALLY_SUCCESSFUL</code></a> if it can + authenticate with this key but must continue with + authentication + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="check_channel_exec_request"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_channel_exec_request</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>channel</span>, + <span class=sig-arg>command</span>)</span> + </h3> + <p>Determine if a shell command will be executed for the client. If + this method returns <code>True</code>, the channel should be connected + to the stdin, stdout, and stderr of the shell command.</p> + The default implementation always returns <code>False</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>channel</b></code> - + the <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> the request arrived on. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + <dd><code><b>command</b></code> - + the command to execute. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if this channel is now hooked up to the + stdin, stdout, and stderr of the executing command; + <code>False</code> if the command will not be executed. + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="check_channel_pty_request"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_channel_pty_request</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>channel</span>, + <span class=sig-arg>term</span>, + <span class=sig-arg>width</span>, + <span class=sig-arg>height</span>, + <span class=sig-arg>pixelwidth</span>, + <span class=sig-arg>pixelheight</span>, + <span class=sig-arg>modes</span>)</span> + </h3> + <p>Determine if a pseudo-terminal of the given dimensions (usually + requested for shell access) can be provided on the given channel.</p> + The default implementation always returns <code>False</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>channel</b></code> - + the <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> the pty request arrived + on. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + <dd><code><b>term</b></code> - + type of terminal requested (for example, + <code>"vt100"</code>). + <br /><i> + (type=str)</i> + <dd><code><b>width</b></code> - + width of screen in characters. + <br /><i> + (type=int)</i> + <dd><code><b>height</b></code> - + height of screen in characters. + <br /><i> + (type=int)</i> + <dd><code><b>pixelwidth</b></code> - + width of screen in pixels, if known (may be <code>0</code> if + unknown). + <br /><i> + (type=int)</i> + <dd><code><b>pixelheight</b></code> - + height of screen in pixels, if known (may be <code>0</code> if + unknown). + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the psuedo-terminal has been allocated; + <code>False</code> otherwise. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="check_channel_request"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_channel_request</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>kind</span>, + <span class=sig-arg>chanid</span>)</span> + </h3> + <p>Determine if a channel request of a given type will be granted, and + return <code>OPEN_SUCCEEDED</code> or an error code. This method is + called in server mode when the client requests a channel, after + authentication is complete.</p> + If you allow channel requests (and an ssh server that didn't would + be useless), you should also override some of the channel request + methods below, which are used to determine which services will be + allowed on a given channel: + <ul> + <li> + <a + href="../private/paramiko.ServerInterface-class.html#check_channel_pty_request" + class="link"><code>check_channel_pty_request</code></a> + </li> + <li> + <a + href="../private/paramiko.ServerInterface-class.html#check_channel_shell_request" + class="link"><code>check_channel_shell_request</code></a> + </li> + <li> + <a + href="../private/paramiko.ServerInterface-class.html#check_channel_subsystem_request" + class="link"><code>check_channel_subsystem_request</code></a> + </li> + <li> + <a + href="../private/paramiko.ServerInterface-class.html#check_channel_window_change_request" + class="link"><code>check_channel_window_change_request</code></a> + </li> + </ul> + <p>The <code>chanid</code> parameter is a small number that uniquely + identifies the channel within a <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. A <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> object is not created unless this + method returns <code>OPEN_SUCCEEDED</code> -- once a <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> object is created, you can call + <a href="paramiko.Channel-class.html#get_id" + class="link"><code>Channel.get_id</code></a> to retrieve the channel + ID.</p> + The return value should either be <code>OPEN_SUCCEEDED</code> (or + <code>0</code>) to allow the channel request, or one of the following + error codes to reject it: + <ul> + <li> + <code>OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED</code> + </li> + <li> + <code>OPEN_FAILED_CONNECT_FAILED</code> + </li> + <li> + <code>OPEN_FAILED_UNKNOWN_CHANNEL_TYPE</code> + </li> + <li> + <code>OPEN_FAILED_RESOURCE_SHORTAGE</code> + </li> + </ul> + The default implementation always returns + <code>OPEN_FAILED_ADMINISTRATIVELY_PROHIBITED</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>kind</b></code> - + the kind of channel the client would like to open (usually + <code>"session"</code>). + <br /><i> + (type=str)</i> + <dd><code><b>chanid</b></code> - + ID of the channel + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a success or failure code (listed above) + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="check_channel_shell_request"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_channel_shell_request</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>channel</span>)</span> + </h3> + <p>Determine if a shell will be provided to the client on the given + channel. If this method returns <code>True</code>, the channel should + be connected to the stdin/stdout of a shell (or something that acts + like a shell).</p> + The default implementation always returns <code>False</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>channel</b></code> - + the <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> the request arrived on. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if this channel is now hooked up to a shell; + <code>False</code> if a shell can't or won't be provided. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="check_channel_subsystem_request"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_channel_subsystem_request</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>channel</span>, + <span class=sig-arg>name</span>)</span> + </h3> + <p>Determine if a requested subsystem will be provided to the client on + the given channel. If this method returns <code>True</code>, all future + I/O through this channel will be assumed to be connected to the + requested subsystem. An example of a subsystem is + <code>sftp</code>.</p> + The default implementation checks for a subsystem handler assigned + via <a href="paramiko.Transport-class.html#set_subsystem_handler" + class="link"><code>Transport.set_subsystem_handler</code></a>. If one + has been set, the handler is invoked and this method returns + <code>True</code>. Otherwise it returns <code>False</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>channel</b></code> - + the <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> the pty request arrived + on. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + <dd><code><b>name</b></code> - + name of the requested subsystem. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if this channel is now hooked up to the + requested subsystem; <code>False</code> if that subsystem can't + or won't be provided. + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Note:</b> Because the default implementation uses the <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> to identify valid subsystems, you +probably won't need to override this method. +</p> + + </dd></dl> +</td></tr></table> + +<a name="check_channel_window_change_request"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_channel_window_change_request</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>channel</span>, + <span class=sig-arg>width</span>, + <span class=sig-arg>height</span>, + <span class=sig-arg>pixelwidth</span>, + <span class=sig-arg>pixelheight</span>)</span> + </h3> + <p>Determine if the pseudo-terminal on the given channel can be + resized. This only makes sense if a pty was previously allocated on + it.</p> + The default implementation always returns <code>False</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>channel</b></code> - + the <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> the pty request arrived + on. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + <dd><code><b>width</b></code> - + width of screen in characters. + <br /><i> + (type=int)</i> + <dd><code><b>height</b></code> - + height of screen in characters. + <br /><i> + (type=int)</i> + <dd><code><b>pixelwidth</b></code> - + width of screen in pixels, if known (may be <code>0</code> if + unknown). + <br /><i> + (type=int)</i> + <dd><code><b>pixelheight</b></code> - + height of screen in pixels, if known (may be <code>0</code> if + unknown). + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the terminal was resized; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="check_global_request"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check_global_request</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>kind</span>, + <span class=sig-arg>msg</span>)</span> + </h3> + <p>Handle a global request of the given <code>kind</code>. This method + is called in server mode and client mode, whenever the remote host + makes a global request. If there are any arguments to the request, they + will be in <code>msg</code>.</p> + <p>There aren't any useful global requests defined, aside from port + forwarding, so usually this type of request is an extension to the + protocol.</p> + <p>If the request was successful and you would like to return + contextual data to the remote host, return a tuple. Items in the tuple + will be sent back with the successful result. (Note that the items in + the tuple can only be strings, ints, longs, or bools.)</p> + The default implementation always returns <code>False</code>, + indicating that it does not support any global requests. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>kind</b></code> - + the kind of global request being made. + <br /><i> + (type=str)</i> + <dd><code><b>msg</b></code> - + any extra arguments to the request. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> or a tuple of data if the request was + granted; <code>False</code> otherwise. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_allowed_auths"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_allowed_auths</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>)</span> + </h3> + <p>Return a list of authentication methods supported by the server. + This list is sent to clients attempting to authenticate, to inform them + of authentication methods that might be successful.</p> + <p>The "list" is actually a string of comma-separated names + of types of authentication. Possible values are + <code>"password"</code>, <code>"publickey"</code>, + and <code>"none"</code>.</p> + The default implementation always returns + <code>"password"</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username requesting authentication. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a comma-separated list of authentication types + <br /><i> + (type=str)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.SubsystemHandler-class.html b/docs/private/paramiko.SubsystemHandler-class.html new file mode 100644 index 0000000..1d8116a --- /dev/null +++ b/docs/private/paramiko.SubsystemHandler-class.html @@ -0,0 +1,352 @@ +<?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>paramiko.SubsystemHandler</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SubsystemHandler + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.SubsystemHandler-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SubsystemHandler-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SubsystemHandler</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a> --+ + | + <a href="threading.Thread-class.html"><code>Thread</code></a> --+ + | + <b>SubsystemHandler</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SFTPServer-class.html"><code>SFTPServer</code></a></dd></dl> + +<hr/> + +<p>Handler for a subsytem in server mode. If you create a subclass of +this class and pass it to <a +href="paramiko.Transport-class.html#set_subsystem_handler" +class="link"><code>Transport.set_subsystem_handler</code></a>, an object +of this class will be created for each request for this subsystem. Each +new object will be executed within its own new thread by calling <a +href="paramiko.SubsystemHandler-class.html#start_subsystem" +class="link"><code>start_subsystem</code></a>. When that method +completes, the channel is closed.</p> +For example, if you made a subclass <code>MP3Handler</code> and +registered it as the handler for subsystem <code>"mp3"</code>, +then whenever a client has successfully authenticated and requests +subsytem <code>"mp3"</code>, an object of class +<code>MP3Handler</code> will be created, and <a +href="paramiko.SubsystemHandler-class.html#start_subsystem" +class="link"><code>start_subsystem</code></a> will be called on it from a +new thread. +<hr/> + +<p><b>Since:</b> ivysaur +</p> + + +<!-- =========== 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="paramiko.SubsystemHandler-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>server</span>)</span></code> +<br /> +Create a new handler for a channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SubsystemHandler-class.html#finish_subsystem" class="summary-sig-name"><code>finish_subsystem</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Perform any cleanup at the end of a subsystem.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SubsystemHandler-class.html#get_server" class="summary-sig-name"><code>get_server</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the <a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> object associated with this +channel and subsystem.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SubsystemHandler-class.html#start_subsystem" class="summary-sig-name"><code>start_subsystem</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>transport</span>, + <span class=summary-sig-arg>channel</span>)</span></code> +<br /> +Process an ssh subsystem in server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_run"></a><span class="summary-sig"><span class="summary-sig-name">_run</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Thread</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="threading.Thread-class.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="threading.Thread-class.html#getName" class="summary-sig-name"><code>getName</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="threading.Thread-class.html#isAlive" class="summary-sig-name"><code>isAlive</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="threading.Thread-class.html#isDaemon" class="summary-sig-name"><code>isDaemon</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="threading.Thread-class.html#join" class="summary-sig-name"><code>join</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</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="threading.Thread-class.html#run" class="summary-sig-name"><code>run</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="threading.Thread-class.html#setDaemon" class="summary-sig-name"><code>setDaemon</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>daemonic</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="threading.Thread-class.html#setName" class="summary-sig-name"><code>setName</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</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="threading.Thread-class.html#start" class="summary-sig-name"><code>start</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="../private/threading.Thread-class.html#_set_daemon" class="summary-sig-name"><code>_set_daemon</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from _Verbose</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/threading._Verbose-class.html#_note" class="summary-sig-name"><code>_note</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>format</span>, + <span class="summary-sig-vararg">*args</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Thread</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td> +<td><b><a href="../private/threading.Thread-class.html#__initialized"><code>_Thread__initialized</code></a></b> = <span title="False"><code>False </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>channel</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>server</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new handler for a channel. This is used by <a + href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> to start up a new handler + when a channel requests this subsystem. You don't need to override this + method, but if you do, be sure to pass the <code>channel</code> and + <code>name</code> parameters through to the original + <code>__init__</code> method here. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>channel</b></code> - + the channel associated with this subsystem request. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + <dd><code><b>name</b></code> - + name of the requested subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>server</b></code> - + the server object for the session that started this + subsystem + <br /><i> + (type=<a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="threading.Thread-class.html#__init__"><code>threading.Thread.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="finish_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">finish_subsystem</span>(<span class=sig-arg>self</span>)</span> + </h3> + Perform any cleanup at the end of a subsystem. The default + implementation just closes the channel. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_server"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_server</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the <a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> object associated with + this channel and subsystem. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="start_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">start_subsystem</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>transport</span>, + <span class=sig-arg>channel</span>)</span> + </h3> + <p>Process an ssh subsystem in server mode. This method is called on a + new object (and in a new thread) for each subsystem request. It is + assumed that all subsystem logic will take place here, and when the + subsystem is finished, this method will return. After this method + returns, the channel is closed.</p> + The combination of <code>transport</code> and <code>channel</code> + are unique; this handler corresponds to exactly one <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> on one <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + name of the requested subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>transport</b></code> - + the server-mode <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <br /><i> + (type=<a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>)</i> + <dd><code><b>channel</b></code> - + the channel associated with this subsystem request. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> +<p><b>Note:</b> It is the responsibility of this method to exit if the underlying <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> is closed. This can be done by +checking <a href="paramiko.Transport-class.html#is_active" +class="link"><code>Transport.is_active</code></a> or noticing an EOF on +the <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>. If this method loops forever +without checking for this case, your python interpreter may refuse to +exit because this thread will still be running. +</p> + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.Transport-class.html b/docs/private/paramiko.Transport-class.html new file mode 100644 index 0000000..5b96b90 --- /dev/null +++ b/docs/private/paramiko.Transport-class.html @@ -0,0 +1,2151 @@ +<?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>paramiko.Transport</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Transport + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.Transport-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Transport-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Transport</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a> --+ + | + <a href="threading.Thread-class.html"><code>Thread</code></a> --+ + | + <b>Transport</b> +</pre><br /> + +<hr/> + +An SSH Transport attaches to a stream (usually a socket), negotiates +an encrypted session, authenticates, and then creates stream tunnels, +called <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>s, across the session. Multiple +channels can be multiplexed across a single session (and often are, in +the case of port forwardings). +<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="paramiko.Transport-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sock</span>)</span></code> +<br /> +Create a new SSH session over an existing socket, or socket-like +object.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns a string representation of this object, for debugging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#accept" class="summary-sig-name"><code>accept</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +<br /> +Return the next channel opened by the client over this transport, in +server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#add_server_key" class="summary-sig-name"><code>add_server_key</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>key</span>)</span></code> +<br /> +Add a host key to the list of keys used for server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#auth_interactive" class="summary-sig-name"><code>auth_interactive</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>handler</span>, + <span class=summary-sig-arg>submethods</span>)</span></code> +<br /> +Authenticate to the server interactively.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#auth_none" class="summary-sig-name"><code>auth_none</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>)</span></code> +<br /> +Try to authenticate to the server using no authentication at all.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#auth_password" class="summary-sig-name"><code>auth_password</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>password</span>, + <span class=summary-sig-arg>event</span>, + <span class=summary-sig-arg>fallback</span>)</span></code> +<br /> +Authenticate to the server using a password.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#auth_publickey" class="summary-sig-name"><code>auth_publickey</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>key</span>, + <span class=summary-sig-arg>event</span>)</span></code> +<br /> +Authenticate to the server using a private key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close this session, and any open channels that are tied to it.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#connect" class="summary-sig-name"><code>connect</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>hostkey</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>password</span>, + <span class=summary-sig-arg>pkey</span>)</span></code> +<br /> +Negotiate an SSH2 session, and optionally verify the server's host key +and authenticate using a password or private key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> Exception +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_exception" class="summary-sig-name"><code>get_exception</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return any exception that happened during the last server request.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_hexdump" class="summary-sig-name"><code>get_hexdump</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return <code>True</code> if the transport is currently logging hex +dumps of protocol traffic.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_log_channel" class="summary-sig-name"><code>get_log_channel</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the channel name used for this transport's logging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_remote_server_key" class="summary-sig-name"><code>get_remote_server_key</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the host key of the server (in client mode).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SecurityOptions-class.html" + class="link"><code>SecurityOptions</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_security_options" class="summary-sig-name"><code>get_security_options</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a <a href="paramiko.SecurityOptions-class.html" +class="link"><code>SecurityOptions</code></a> object which can be used to +tweak the encryption algorithms this transport will permit, and the order +of preference for them.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_server_key" class="summary-sig-name"><code>get_server_key</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the active host key, in server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_username" class="summary-sig-name"><code>get_username</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the username this connection is authenticated for.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#global_request" class="summary-sig-name"><code>global_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>kind</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>wait</span>)</span></code> +<br /> +Make a global request to the remote host.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#is_active" class="summary-sig-name"><code>is_active</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return true if this session is active (open).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#is_authenticated" class="summary-sig-name"><code>is_authenticated</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return true if this session is active and authenticated.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#load_server_moduli" class="summary-sig-name"><code>load_server_moduli</code></a>(<span class=summary-sig-arg>filename</span>)</span></code> +<br /> +<i>(optional)</i> Load a file of prime moduli for use in doing +group-exchange key negotiation in server mode. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#open_channel" class="summary-sig-name"><code>open_channel</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>kind</span>, + <span class=summary-sig-arg>dest_addr</span>, + <span class=summary-sig-arg>src_addr</span>)</span></code> +<br /> +Request a new channel to the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#open_session" class="summary-sig-name"><code>open_session</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Request a new channel to the server, of type +<code>"session"</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#open_sftp_client" class="summary-sig-name"><code>open_sftp_client</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Create an SFTP client channel from an open transport.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#renegotiate_keys" class="summary-sig-name"><code>renegotiate_keys</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Force this session to switch to new keys.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="run"></a><span class="summary-sig"><span class="summary-sig-name">run</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="paramiko.Transport-class.html#send_ignore" class="summary-sig-name"><code>send_ignore</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>bytes</span>)</span></code> +<br /> +Send a junk packet across the encrypted link.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#set_hexdump" class="summary-sig-name"><code>set_hexdump</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>hexdump</span>)</span></code> +<br /> +Turn on/off logging a hex dump of protocol traffic at DEBUG level in +the logs.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#set_keepalive" class="summary-sig-name"><code>set_keepalive</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>interval</span>)</span></code> +<br /> +Turn on/off keepalive packets (default is off).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#set_log_channel" class="summary-sig-name"><code>set_log_channel</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>)</span></code> +<br /> +Set the channel for this transport's logging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#set_subsystem_handler" class="summary-sig-name"><code>set_subsystem_handler</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>handler</span>, + <span class="summary-sig-vararg">*larg</span>, + <span class="summary-sig-kwarg">**kwarg</span>)</span></code> +<br /> +Set the handler class for a subsystem in server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#start_client" class="summary-sig-name"><code>start_client</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>event</span>)</span></code> +<br /> +Negotiate a new SSH2 session as a client.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#start_server" class="summary-sig-name"><code>start_server</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>event</span>, + <span class=summary-sig-arg>server</span>)</span></code> +<br /> +Negotiate a new SSH2 session as a server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="stop_thread"></a><span class="summary-sig"><span class="summary-sig-name">stop_thread</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="paramiko.Transport-class.html#use_compression" class="summary-sig-name"><code>use_compression</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>compress</span>)</span></code> +<br /> +Turn on/off compression.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Transport-class.html#_activate_inbound" class="summary-sig-name"><code>_activate_inbound</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +switch on newly negotiated encryption parameters for inbound +traffic</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Transport-class.html#_activate_outbound" class="summary-sig-name"><code>_activate_outbound</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +switch on newly negotiated encryption parameters for outbound +traffic</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_auth_trigger"></a><span class="summary-sig"><span class="summary-sig-name">_auth_trigger</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><a name="_check_banner"></a><span class="summary-sig"><span class="summary-sig-name">_check_banner</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="../private/paramiko.Transport-class.html#_compute_key" class="summary-sig-name"><code>_compute_key</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>id</span>, + <span class=summary-sig-arg>nbytes</span>)</span></code> +<br /> +id is 'A' - 'F' for the various keys used by ssh</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Transport-class.html#_expect_packet" class="summary-sig-name"><code>_expect_packet</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>type</span>)</span></code> +<br /> +used by a kex object to register the next packet type it expects to +see</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_get_cipher"></a><span class="summary-sig"><span class="summary-sig-name">_get_cipher</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>key</span>, + <span class=summary-sig-arg>iv</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="../private/paramiko.Transport-class.html#_get_modulus_pack" class="summary-sig-name"><code>_get_modulus_pack</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +used by KexGex to find primes for group exchange</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_get_subsystem_handler"></a><span class="summary-sig"><span class="summary-sig-name">_get_subsystem_handler</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_log"></a><span class="summary-sig"><span class="summary-sig-name">_log</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>level</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_negotiate_keys"></a><span class="summary-sig"><span class="summary-sig-name">_negotiate_keys</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_channel_open"></a><span class="summary-sig"><span class="summary-sig-name">_parse_channel_open</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_channel_open_failure"></a><span class="summary-sig"><span class="summary-sig-name">_parse_channel_open_failure</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_channel_open_success"></a><span class="summary-sig"><span class="summary-sig-name">_parse_channel_open_success</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_debug"></a><span class="summary-sig"><span class="summary-sig-name">_parse_debug</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_disconnect"></a><span class="summary-sig"><span class="summary-sig-name">_parse_disconnect</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_global_request"></a><span class="summary-sig"><span class="summary-sig-name">_parse_global_request</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_kex_init"></a><span class="summary-sig"><span class="summary-sig-name">_parse_kex_init</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_newkeys"></a><span class="summary-sig"><span class="summary-sig-name">_parse_newkeys</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_request_failure"></a><span class="summary-sig"><span class="summary-sig-name">_parse_request_failure</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_request_success"></a><span class="summary-sig"><span class="summary-sig-name">_parse_request_success</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</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="../private/paramiko.Transport-class.html#_send_kex_init" class="summary-sig-name"><code>_send_kex_init</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +announce to the other side that we'd like to negotiate keys, and what +kind of key negotiation we support.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_send_message"></a><span class="summary-sig"><span class="summary-sig-name">_send_message</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</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="../private/paramiko.Transport-class.html#_send_user_message" class="summary-sig-name"><code>_send_user_message</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +send a message, but block if we're in key negotiation.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Transport-class.html#_set_K_H" class="summary-sig-name"><code>_set_K_H</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>k</span>, + <span class=summary-sig-arg>h</span>)</span></code> +<br /> +used by a kex object to set the K (root key) and H (exchange hash)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.Transport-class.html#_unlink_channel" class="summary-sig-name"><code>_unlink_channel</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>chanid</span>)</span></code> +<br /> +used by a Channel to remove itself from the active channel list</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_verify_key"></a><span class="summary-sig"><span class="summary-sig-name">_verify_key</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>host_key</span>, + <span class=summary-sig-arg>sig</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Thread</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="threading.Thread-class.html#getName" class="summary-sig-name"><code>getName</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="threading.Thread-class.html#isAlive" class="summary-sig-name"><code>isAlive</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="threading.Thread-class.html#isDaemon" class="summary-sig-name"><code>isDaemon</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="threading.Thread-class.html#join" class="summary-sig-name"><code>join</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</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="threading.Thread-class.html#setDaemon" class="summary-sig-name"><code>setDaemon</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>daemonic</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="threading.Thread-class.html#setName" class="summary-sig-name"><code>setName</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</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="threading.Thread-class.html#start" class="summary-sig-name"><code>start</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="../private/threading.Thread-class.html#_set_daemon" class="summary-sig-name"><code>_set_daemon</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from _Verbose</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/threading._Verbose-class.html#_note" class="summary-sig-name"><code>_note</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>format</span>, + <span class="summary-sig-vararg">*args</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="../private/paramiko.Transport-class.html#_channel_handler_table"><code>_channel_handler_table</code></a></b> = <span title="{96: <unbound method Channel._handle_eof>, 97: <unbound method Channel._handle_close>, 98: <unbound method Channel._handle_request>, 99: <unbound method Channel._request_success>, 100: <unbound method Channel._request_failed>, 93: <unbound method Channel._window_adjust>, 94: <unbound method Channel._feed>, 95: <unbound method Channel._feed_extended>}"><code>{96: <unbound method Channel._h<span class="variable-ellipsis">...</span></code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_cipher_info"><code>_cipher_info</code></a></b> = <span title="{'blowfish-cbc': {'block-size': 8, 'key-size': 16, 'class': <module 'Crypto.Cipher.Blowfish' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/Blowfish.so'>, 'mode': 2}, '3des-cbc': {'block-size': 8, 'key-size': 24, 'class': <module 'Crypto.Cipher.DES3' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/DES3.so'>, 'mode': 2}, 'aes256-cbc': {'block-size': 16, 'key-size': 32, 'class': <module 'Crypto.Cipher.AES' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/AES.so'>, 'mode': 2}, 'aes128-cbc': {'block-size': 16, 'key-size': 16, 'class': <module 'Crypto.Cipher.AES' from '/usr/lib/py..."><code>{'blowfish-cbc': {'block-size': 8, 'key-s<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="../private/paramiko.Transport-class.html#_CLIENT_ID"><code>_CLIENT_ID</code></a></b> = <span title="'paramiko_1.5.2'"><code><span class="variable-quote">'</span>paramiko_1.5.2<span class="variable-quote">'</span> </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_compression_info"><code>_compression_info</code></a></b> = <span title="{'none': (None, None), 'zlib': (<class 'paramiko.compress.ZlibCompressor'>, <class 'paramiko.compress.ZlibDecompressor'>), 'zlib@openssh.com': (<class 'paramiko.compress.ZlibCompressor'>, <class 'paramiko.compress.ZlibDecompressor'>)}"><code>{'none': (None, None), 'zlib': (<cla<span class="variable-ellipsis">...</span></code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_handler_table"><code>_handler_table</code></a></b> = <span title="{80: <function _parse_global_request at 0xb7b13fb4>, 81: <function _parse_request_success at 0xb7b1e02c>, 82: <function _parse_request_failure at 0xb7b1e064>, 20: <function _negotiate_keys at 0xb7b13dbc>, 21: <function _parse_newkeys at 0xb7b13f44>, 90: <function _parse_channel_open at 0xb7b1e10c>, 91: <function _parse_channel_open_success at 0xb7b1e09c>, 92: <function _parse_channel_open_failure at 0xb7b1e0d4>}"><code>{80: <function _parse_global_request at<span class="variable-ellipsis">...</span></code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_kex_info"><code>_kex_info</code></a></b> = <span title="{'diffie-hellman-group1-sha1': <class 'paramiko.kex_group1.KexGroup1'>, 'diffie-hellman-group-exchange-sha1': <class 'paramiko.kex_gex.KexGex'>}"><code>{'diffie-hellman-group1-sha1': <class 'param<span class="variable-ellipsis">...</span></code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_key_info"><code>_key_info</code></a></b> = <span title="{'ssh-dss': <class 'paramiko.DSSKey'>, 'ssh-rsa': <class 'paramiko.RSAKey'>}"><code>{'ssh-dss': <class 'paramiko.DSSKey'>, 'ssh-<span class="variable-ellipsis">...</span></code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_mac_info"><code>_mac_info</code></a></b> = <span title="{'hmac-sha1': {'class': <module 'Crypto.Hash.SHA' from '/usr/lib/python2.4/site-packages/Crypto/Hash/SHA.pyc'>, 'size': 20}, 'hmac-md5-96': {'class': <module 'Crypto.Hash.MD5' from '/usr/lib/python2.4/site-packages/Crypto/Hash/MD5.pyc'>, 'size': 12}, 'hmac-sha1-96': {'class': <module 'Crypto.Hash.SHA' from '/usr/lib/python2.4/site-packages/Crypto/Hash/SHA.pyc'>, 'size': 12}, 'hmac-md5': {'class': <module 'Crypto.Hash.MD5' from '/usr/lib/python2.4/site-packages/Crypto/Hash/MD5.pyc'>, 'size': 16}}"><code>{'hmac-sha1': {'class': <module 'Crypto.Hash<span class="variable-ellipsis">...</span></code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_modulus_pack"><code>_modulus_pack</code></a></b> = <span title="None">None </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_preferred_ciphers"><code>_preferred_ciphers</code></a></b> = <span title="('aes128-cbc', 'blowfish-cbc', 'aes256-cbc', '3des-cbc')"><code>('aes128-cbc', 'blowfish-cbc', 'aes<span class="variable-ellipsis">...</span></code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_preferred_compression"><code>_preferred_compression</code></a></b> = <span title="('none',)"><code>('none',) </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_preferred_kex"><code>_preferred_kex</code></a></b> = <span title="('diffie-hellman-group1-sha1', 'diffie-hellman-group-exchange-sha1')"><code>('diffie-hellman-group1-sha1', 'diffie-<span class="variable-ellipsis">...</span></code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_preferred_keys"><code>_preferred_keys</code></a></b> = <span title="('ssh-rsa', 'ssh-dss')"><code>('ssh-rsa', 'ssh-dss') </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="../private/paramiko.Transport-class.html#_preferred_macs"><code>_preferred_macs</code></a></b> = <span title="('hmac-sha1', 'hmac-md5', 'hmac-sha1-96', 'hmac-md5-96')"><code>('hmac-sha1', 'hmac-md5', 'hmac-sha1-9<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="../private/paramiko.Transport-class.html#_PROTO_ID"><code>_PROTO_ID</code></a></b> = <span title="'2.0'"><code><span class="variable-quote">'</span>2.0<span class="variable-quote">'</span> </code> +</span></td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Thread</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>bool</code></font></td> +<td><b><a href="../private/threading.Thread-class.html#__initialized"><code>_Thread__initialized</code></a></b> = <span title="False"><code>False </code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>sock</span>)</span> + <br /><i>(Constructor)</i> + </h3> + <p>Create a new SSH session over an existing socket, or socket-like + object. This only creates the Transport object; it doesn't begin the + SSH session yet. Use <a href="paramiko.Transport-class.html#connect" + class="link"><code>connect</code></a> or <a + href="paramiko.Transport-class.html#start_client" + class="link"><code>start_client</code></a> to begin a client session, + or <a href="paramiko.Transport-class.html#start_server" + class="link"><code>start_server</code></a> to begin a server + session.</p> + If the object is not actually a socket, it must have the following + methods: + <ul> + <li> + <code>send(str)</code>: Writes from 1 to <code>len(str)</code> + bytes, and returns an int representing the number of bytes written. + Returns 0 or raises <code>EOFError</code> if the stream has been + closed. + </li> + <li> + <code>recv(int)</code>: Reads from 1 to <code>int</code> bytes + and returns them as a string. Returns 0 or raises + <code>EOFError</code> if the stream has been closed. + </li> + <li> + <code>close()</code>: Closes the socket. + </li> + <li> + <code>settimeout(n)</code>: Sets a (float) timeout on I/O + operations. + </li> + </ul> + For ease of use, you may also pass in an address (as a tuple) or a + host string as the <code>sock</code> argument. (A host string is a + hostname with an optional port (separated by + <code>":"</code>) which will be converted into a tuple of + <code>(hostname, port)</code>.) A socket will be connected to this + address and used for communication. Exceptions from the + <code>socket</code> call may be thrown in this case. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>sock</b></code> - + a socket or socket-like object to create the session over. + <br /><i> + (type=socket)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="threading.Thread-class.html#__init__"><code>threading.Thread.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + Returns a string representation of this object, for debugging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + str + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="threading.Thread-class.html#__repr__"><code>threading.Thread.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="accept"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">accept</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>timeout</span>=<span class=sig-default>None</span>)</span> + </h3> + Return the next channel opened by the client over this transport, in + server mode. If no channel is opened before the given timeout, + <code>None</code> is returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>timeout</b></code> - + seconds to wait for a channel, or <code>None</code> to wait + forever + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a new Channel opened by the client + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_server_key"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_server_key</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>key</span>)</span> + </h3> + Add a host key to the list of keys used for server mode. When + behaving as a server, the host key is used to sign certain packets + during the SSH2 negotiation, so that the client can trust that we are + who we say we are. Because this is used for signing, the key must + contain private key info, not just the public half. Only one key of + each type (RSA or DSS) is kept. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>key</b></code> - + the host key to add, usually an <a + href="paramiko.RSAKey-class.html" + class="link"><code>RSAKey</code></a> or <a + href="paramiko.DSSKey-class.html" + class="link"><code>DSSKey</code></a>. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="auth_interactive"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">auth_interactive</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>handler</span>, + <span class=sig-arg>submethods</span>=<span class=sig-default>''</span>)</span> + </h3> + <p>Authenticate to the server interactively. A handler is used to + answer arbitrary questions from the server. On many servers, this is + just a dumb wrapper around PAM.</p> + <p>This method will block until the authentication succeeds or fails, + peroidically calling the handler asynchronously to get answers to + authentication questions. The handler may be called more than once if + the server continues to ask questions.</p> + <p>The handler is expected to be a callable that will handle calls of + the form: <code>handler(title, instructions, prompt_list)</code>. The + <code>title</code> is meant to be a dialog-window title, and the + <code>instructions</code> are user instructions (both are strings). + <code>prompt_list</code> will be a list of prompts, each prompt being a + tuple of <code>(str, bool)</code>. The string is the prompt and the + boolean indicates whether the user text should be echoed.</p> + <p>A sample call would thus be: <code>handler('title', 'instructions', + [('Password:', False)])</code>.</p> + <p>The handler should return a list or tuple of answers to the server's + questions.</p> + If the server requires multi-step authentication (which is very + rare), this method will return a list of auth types permissible for the + next step. Otherwise, in the normal case, an empty list is + returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username to authenticate as + <br /><i> + (type=string)</i> + <dd><code><b>handler</b></code> - + a handler for responding to server questions + <br /><i> + (type=callable)</i> + <dd><code><b>submethods</b></code> - + a string list of desired submethods (optional) + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of auth types permissible for the next stage of + authentication (normally empty). + <br /><i> + (type=list)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>BadAuthenticationType</b></code> - + if public-key authentication isn't allowed by the server for + this user + <dd><code><b>SSHException</b></code> - + if the authentication failed + </dl> +<p><b>Since:</b> 1.5 +</p> + + </dd></dl> +</td></tr></table> + +<a name="auth_none"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">auth_none</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>)</span> + </h3> + Try to authenticate to the server using no authentication at all. + This will almost always fail. It may be useful for determining the list + of authentication types supported by the server, by catching the <a + href="paramiko.BadAuthenticationType-class.html" + class="link"><code>BadAuthenticationType</code></a> exception + raised. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username to authenticate as + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of auth types permissible for the next stage of + authentication (normally empty) + <br /><i> + (type=list)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>BadAuthenticationType</b></code> - + if "none" authentication isn't allowed by the server + for this user + <dd><code><b>SSHException</b></code> - + if the authentication failed due to a network error + </dl> +<p><b>Since:</b> 1.5 +</p> + + </dd></dl> +</td></tr></table> + +<a name="auth_password"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">auth_password</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>password</span>, + <span class=sig-arg>event</span>=<span class=sig-default>None</span>, + <span class=sig-arg>fallback</span>=<span class=sig-default>True</span>)</span> + </h3> + <p>Authenticate to the server using a password. The username and + password are sent over an encrypted link.</p> + <p>If an <code>event</code> is passed in, this method will return + immediately, and the event will be triggered once authentication + succeeds or fails. On success, <a + href="paramiko.Transport-class.html#is_authenticated" + class="link"><code>is_authenticated</code></a> will return + <code>True</code>. On failure, you may use <a + href="paramiko.Transport-class.html#get_exception" + class="link"><code>get_exception</code></a> to get more detailed error + information.</p> + <p>Since 1.1, if no event is passed, this method will block until the + authentication succeeds or fails. On failure, an exception is raised. + Otherwise, the method simply returns.</p> + <p>Since 1.5, if no event is passed and <code>fallback</code> is + <code>True</code> (the default), if the server doesn't support plain + password authentication but does support so-called + "keyboard-interactive" mode, an attempt will be made to + authenticate using this interactive mode. If it fails, the normal + exception will be thrown as if the attempt had never been made. This is + useful for some recent Gentoo and Debian distributions, which turn off + plain password authentication in a misguided belief that interactive + authentication is "more secure". (It's not.)</p> + If the server requires multi-step authentication (which is very + rare), this method will return a list of auth types permissible for the + next step. Otherwise, in the normal case, an empty list is + returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username to authenticate as + <br /><i> + (type=string)</i> + <dd><code><b>password</b></code> - + the password to authenticate with + <br /><i> + (type=string)</i> + <dd><code><b>event</b></code> - + an event to trigger when the authentication attempt is + complete (whether it was successful or not) + <br /><i> + (type=threading.Event)</i> + <dd><code><b>fallback</b></code> - + <code>True</code> if an attempt at an automated + "interactive" password auth should be made if the + server doesn't support normal password auth + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of auth types permissible for the next stage of + authentication (normally empty) + <br /><i> + (type=list)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>BadAuthenticationType</b></code> - + if password authentication isn't allowed by the server for + this user (and no event was passed in) + <dd><code><b>SSHException</b></code> - + if the authentication failed (and no event was passed in) + </dl> + </dd></dl> +</td></tr></table> + +<a name="auth_publickey"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">auth_publickey</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>key</span>, + <span class=sig-arg>event</span>=<span class=sig-default>None</span>)</span> + </h3> + <p>Authenticate to the server using a private key. The key is used to + sign data from the server, so it must include the private part.</p> + <p>If an <code>event</code> is passed in, this method will return + immediately, and the event will be triggered once authentication + succeeds or fails. On success, <a + href="paramiko.Transport-class.html#is_authenticated" + class="link"><code>is_authenticated</code></a> will return + <code>True</code>. On failure, you may use <a + href="paramiko.Transport-class.html#get_exception" + class="link"><code>get_exception</code></a> to get more detailed error + information.</p> + <p>Since 1.1, if no event is passed, this method will block until the + authentication succeeds or fails. On failure, an exception is raised. + Otherwise, the method simply returns.</p> + If the server requires multi-step authentication (which is very + rare), this method will return a list of auth types permissible for the + next step. Otherwise, in the normal case, an empty list is + returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username to authenticate as + <br /><i> + (type=string)</i> + <dd><code><b>key</b></code> - + the private key to authenticate with + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + <dd><code><b>event</b></code> - + an event to trigger when the authentication attempt is + complete (whether it was successful or not) + <br /><i> + (type=threading.Event)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of auth types permissible for the next stage of + authentication (normally empty). + <br /><i> + (type=list)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>BadAuthenticationType</b></code> - + if public-key authentication isn't allowed by the server for + this user (and no event was passed in). + <dd><code><b>SSHException</b></code> - + if the authentication failed (and no event was passed in). + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close this session, and any open channels that are tied to it. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="connect"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">connect</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>hostkey</span>=<span class=sig-default>None</span>, + <span class=sig-arg>username</span>=<span class=sig-default>''</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>, + <span class=sig-arg>pkey</span>=<span class=sig-default>None</span>)</span> + </h3> + <p>Negotiate an SSH2 session, and optionally verify the server's host + key and authenticate using a password or private key. This is a + shortcut for <a href="paramiko.Transport-class.html#start_client" + class="link"><code>start_client</code></a>, <a + href="paramiko.Transport-class.html#get_remote_server_key" + class="link"><code>get_remote_server_key</code></a>, and <a + href="paramiko.Transport-class.html#auth_password" + class="link"><code>Transport.auth_password</code></a> or <a + href="paramiko.Transport-class.html#auth_publickey" + class="link"><code>Transport.auth_publickey</code></a>. Use those + methods if you want more control.</p> + You can use this method immediately after creating a Transport to + negotiate encryption with a server. If it fails, an exception will be + thrown. On success, the method will return cleanly, and an encrypted + session exists. You may immediately call <a + href="paramiko.Transport-class.html#open_channel" + class="link"><code>open_channel</code></a> or <a + href="paramiko.Transport-class.html#open_session" + class="link"><code>open_session</code></a> to get a <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> object, which is used for data + transfer. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hostkey</b></code> - + the host key expected from the server, or <code>None</code> if + you don't want to do host key verification. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + <dd><code><b>username</b></code> - + the username to authenticate as. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + a password to use for authentication, if you want to use + password authentication; otherwise <code>None</code>. + <br /><i> + (type=str)</i> + <dd><code><b>pkey</b></code> - + a private key to use for authentication, if you want to use + private key authentication; otherwise <code>None</code>. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if the SSH2 negotiation fails, the host key supplied by the + server is incorrect, or authentication fails. + </dl> +<p><b>Note:</b> If you fail to supply a password or private key, this method may +succeed, but a subsequent <a +href="paramiko.Transport-class.html#open_channel" +class="link"><code>open_channel</code></a> or <a +href="paramiko.Transport-class.html#open_session" +class="link"><code>open_session</code></a> call may fail because you +haven't authenticated yet. +</p> + +<p><b>Since:</b> doduo +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_exception"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_exception</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return any exception that happened during the last server request. + This can be used to fetch more specific error information after using + calls like <a href="paramiko.Transport-class.html#start_client" + class="link"><code>start_client</code></a>. The exception (if any) is + cleared after this call. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an exception, or <code>None</code> if there is no stored + exception. + <br /><i> + (type=Exception)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_hexdump"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_hexdump</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return <code>True</code> if the transport is currently logging hex + dumps of protocol traffic. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if hex dumps are being logged + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_log_channel"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_log_channel</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the channel name used for this transport's logging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + channel name. + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_remote_server_key"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_remote_server_key</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the host key of the server (in client mode). + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + public key of the remote server. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if no session is currently active. + </dl> +<p><b>Note:</b> Previously this call returned a tuple of (key type, key string). You +can get the same effect by calling <a +href="../private/paramiko.PKey-class.html#get_name" +class="link"><code>PKey.get_name</code></a> for the key type, and +<code>str(key)</code> for the key string. +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_security_options"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_security_options</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return a <a href="paramiko.SecurityOptions-class.html" + class="link"><code>SecurityOptions</code></a> object which can be used + to tweak the encryption algorithms this transport will permit, and the + order of preference for them. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an object that can be used to change the preferred algorithms + for encryption, digest (hash), public key, and key exchange. + <br /><i> + (type=<a href="paramiko.SecurityOptions-class.html" + class="link"><code>SecurityOptions</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> ivysaur +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_server_key"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_server_key</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the active host key, in server mode. After negotiating with + the client, this method will return the negotiated host key. If only + one type of host key was set with <a + href="paramiko.Transport-class.html#add_server_key" + class="link"><code>add_server_key</code></a>, that's the only key that + will ever be returned. But in cases where you have set more than one + type of host key (for example, an RSA key and a DSS key), the key type + will be negotiated by the client, and this method will return the key + of the type agreed on. If the host key has not been negotiated yet, + <code>None</code> is returned. In client mode, the behavior is + undefined. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + host key of the type negotiated by the client, or + <code>None</code>. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_username"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_username</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the username this connection is authenticated for. If the + session is not authenticated (or authentication failed), this method + returns <code>None</code>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + username that was authenticated, or <code>None</code>. + <br /><i> + (type=string)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="global_request"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">global_request</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>kind</span>, + <span class=sig-arg>data</span>=<span class=sig-default>None</span>, + <span class=sig-arg>wait</span>=<span class=sig-default>True</span>)</span> + </h3> + Make a global request to the remote host. These are normally + extensions to the SSH2 protocol. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>kind</b></code> - + name of the request. + <br /><i> + (type=str)</i> + <dd><code><b>data</b></code> - + an optional tuple containing additional data to attach to the + request. + <br /><i> + (type=tuple)</i> + <dd><code><b>wait</b></code> - + <code>True</code> if this method should not return until a + response is received; <code>False</code> otherwise. + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> containing possible + additional data if the request was successful (or an empty <a + href="paramiko.Message-class.html" + class="link"><code>Message</code></a> if <code>wait</code> was + <code>False</code>); <code>None</code> if the request was + denied. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="is_active"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">is_active</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return true if this session is active (open). + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + True if the session is still active (open); False if the + session is closed. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="is_authenticated"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">is_authenticated</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return true if this session is active and authenticated. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + True if the session is still open and has been authenticated + successfully; False if authentication failed and/or the session + is closed. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="open_channel"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">open_channel</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>kind</span>, + <span class=sig-arg>dest_addr</span>=<span class=sig-default>None</span>, + <span class=sig-arg>src_addr</span>=<span class=sig-default>None</span>)</span> + </h3> + Request a new channel to the server. <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>s are socket-like objects used for + the actual transfer of data across the session. You may only request a + channel after negotiating encryption (using <a + href="paramiko.Transport-class.html#connect" + class="link"><code>connect</code></a> or <a + href="paramiko.Transport-class.html#start_client" + class="link"><code>start_client</code></a>) and authenticating. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>kind</b></code> - + the kind of channel requested (usually + <code>"session"</code>, + <code>"forwarded-tcpip"</code> or + <code>"direct-tcpip"</code>). + <br /><i> + (type=str)</i> + <dd><code><b>dest_addr</b></code> - + the destination address of this port forwarding, if + <code>kind</code> is <code>"forwarded-tcpip"</code> or + <code>"direct-tcpip"</code> (ignored for other channel + types). + <br /><i> + (type=(str, int))</i> + <dd><code><b>src_addr</b></code> - + the source address of this port forwarding, if + <code>kind</code> is <code>"forwarded-tcpip"</code> or + <code>"direct-tcpip"</code>. + <br /><i> + (type=(str, int))</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a new <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> on success, or + <code>None</code> if the request is rejected or the session ends + prematurely. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="open_session"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">open_session</span>(<span class=sig-arg>self</span>)</span> + </h3> + Request a new channel to the server, of type + <code>"session"</code>. This is just an alias for + <code>open_channel('session')</code>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a new <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> on success, or + <code>None</code> if the request is rejected or the session ends + prematurely. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="open_sftp_client"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">open_sftp_client</span>(<span class=sig-arg>self</span>)</span> + </h3> + Create an SFTP client channel from an open transport. On success, an + SFTP session will be opened with the remote host, and a new SFTPClient + object will be returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a new <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> object, referring to an + sftp session (channel) across this transport + <br /><i> + (type=<a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="renegotiate_keys"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">renegotiate_keys</span>(<span class=sig-arg>self</span>)</span> + </h3> + Force this session to switch to new keys. Normally this is done + automatically after the session hits a certain number of packets or + bytes sent or received, but this method gives you the option of forcing + new keys whenever you want. Negotiating new keys causes a pause in + traffic both ways as the two sides swap keys and do computations. This + method returns when the session has switched to new keys, or the + session has died mid-negotiation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + True if the renegotiation was successful, and the link is + using new keys; False if the session dropped during + renegotiation. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="send_ignore"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">send_ignore</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>bytes</span>=<span class=sig-default>None</span>)</span> + </h3> + Send a junk packet across the encrypted link. This is sometimes used + to add "noise" to a connection to confuse would-be attackers. + It can also be used as a keep-alive for long lived connections + traversing firewalls. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>bytes</b></code> - + the number of random bytes to send in the payload of the + ignored packet -- defaults to a random number from 10 to 41. + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_hexdump"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_hexdump</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>hexdump</span>)</span> + </h3> + Turn on/off logging a hex dump of protocol traffic at DEBUG level in + the logs. Normally you would want this off (which is the default), but + if you are debugging something, it may be useful. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hexdump</b></code> - + <code>True</code> to log protocol traffix (in hex) to the log; + <code>False</code> otherwise. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="set_keepalive"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_keepalive</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>interval</span>)</span> + </h3> + Turn on/off keepalive packets (default is off). If this is set, + after <code>interval</code> seconds without sending any data over the + connection, a "keepalive" packet will be sent (and ignored by + the remote host). This can be useful to keep connections alive over a + NAT, for example. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>interval</b></code> - + seconds to wait before sending a keepalive packet (or 0 to + disable keepalives). + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_log_channel"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_log_channel</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>)</span> + </h3> + Set the channel for this transport's logging. The default is + <code>"paramiko.transport"</code> but it can be set to + anything you want. (See the <code>logging</code> module for more info.) + SSH Channels will log to a sub-channel of the one specified. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + new channel name for logging. + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_subsystem_handler"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_subsystem_handler</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>handler</span>, + <span class="sig-vararg">*larg</span>, + <span class="sig-kwarg">**kwarg</span>)</span> + </h3> + <p>Set the handler class for a subsystem in server mode. If a request + for this subsystem is made on an open ssh channel later, this handler + will be constructed and called -- see <a + href="paramiko.SubsystemHandler-class.html" + class="link"><code>SubsystemHandler</code></a> for more detailed + documentation.</p> + Any extra parameters (including keyword arguments) are saved and + passed to the <a href="paramiko.SubsystemHandler-class.html" + class="link"><code>SubsystemHandler</code></a> constructor later. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + name of the subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>handler</b></code> - + subclass of <a href="paramiko.SubsystemHandler-class.html" + class="link"><code>SubsystemHandler</code></a> that handles this + subsystem. + <br /><i> + (type=class)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="start_client"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">start_client</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>event</span>=<span class=sig-default>None</span>)</span> + </h3> + <p>Negotiate a new SSH2 session as a client. This is the first step + after creating a new <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. A separate thread is created + for protocol negotiation.</p> + <p>If an event is passed in, this method returns immediately. When + negotiation is done (successful or not), the given <code>Event</code> + will be triggered. On failure, <a + href="paramiko.Transport-class.html#is_active" + class="link"><code>is_active</code></a> will return + <code>False</code>.</p> + <p>(Since 1.4) If <code>event</code> is <code>None</code>, this method + will not return until negotation is done. On success, the method + returns normally. Otherwise an SSHException is raised.</p> + After a successful negotiation, you will usually want to + authenticate, calling <a + href="paramiko.Transport-class.html#auth_password" + class="link"><code>auth_password</code></a> or <a + href="paramiko.Transport-class.html#auth_publickey" + class="link"><code>auth_publickey</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>event</b></code> - + an event to trigger when negotiation is complete + (optional) + <br /><i> + (type=threading.Event)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if negotiation fails (and no <code>event</code> was passed + in) + </dl> +<p><b>Notes:</b> +<ul> + <li><a href="paramiko.Transport-class.html#connect" +class="link"><code>connect</code></a> is a simpler method for connecting +as a client. +</li> + <li>After calling this method (or <a +href="paramiko.Transport-class.html#start_server" +class="link"><code>start_server</code></a> or <a +href="paramiko.Transport-class.html#connect" +class="link"><code>connect</code></a>), you should no longer directly +read from or write to the original socket object. + + </li> +</ul></p> + + </dd></dl> +</td></tr></table> + +<a name="start_server"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">start_server</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>event</span>=<span class=sig-default>None</span>, + <span class=sig-arg>server</span>=<span class=sig-default>None</span>)</span> + </h3> + <p>Negotiate a new SSH2 session as a server. This is the first step + after creating a new <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> and setting up your server host + key(s). A separate thread is created for protocol negotiation.</p> + <p>If an event is passed in, this method returns immediately. When + negotiation is done (successful or not), the given <code>Event</code> + will be triggered. On failure, <a + href="paramiko.Transport-class.html#is_active" + class="link"><code>is_active</code></a> will return + <code>False</code>.</p> + <p>(Since 1.4) If <code>event</code> is <code>None</code>, this method + will not return until negotation is done. On success, the method + returns normally. Otherwise an SSHException is raised.</p> + <p>After a successful negotiation, the client will need to + authenticate. Override the methods <a + href="../private/paramiko.ServerInterface-class.html#get_allowed_auths" + class="link"><code>get_allowed_auths</code></a>, <a + href="../private/paramiko.ServerInterface-class.html#check_auth_none" + class="link"><code>check_auth_none</code></a>, <a + href="../private/paramiko.ServerInterface-class.html#check_auth_password" + class="link"><code>check_auth_password</code></a>, and <a + href="../private/paramiko.ServerInterface-class.html#check_auth_publickey" + class="link"><code>check_auth_publickey</code></a> in the given + <code>server</code> object to control the authentication process.</p> + After a successful authentication, the client should request to open + a channel. Override <a + href="../private/paramiko.ServerInterface-class.html#check_channel_request" + class="link"><code>check_channel_request</code></a> in the given + <code>server</code> object to allow channels to be opened. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>event</b></code> - + an event to trigger when negotiation is complete. + <br /><i> + (type=threading.Event)</i> + <dd><code><b>server</b></code> - + an object used to perform authentication and create <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>s. + <br /><i> + (type=<a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>server.ServerInterface</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if negotiation fails (and no <code>event</code> was passed + in) + </dl> +<p><b>Note:</b> After calling this method (or <a +href="paramiko.Transport-class.html#start_client" +class="link"><code>start_client</code></a> or <a +href="paramiko.Transport-class.html#connect" +class="link"><code>connect</code></a>), you should no longer directly +read from or write to the original socket object. +</p> + + </dd></dl> +</td></tr></table> + +<a name="use_compression"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">use_compression</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>compress</span>=<span class=sig-default>True</span>)</span> + </h3> + Turn on/off compression. This will only have an affect before + starting the transport (ie before calling <a + href="paramiko.Transport-class.html#connect" + class="link"><code>connect</code></a>, etc). By default, compression is + off since it negatively affects interactive sessions and is not fully + tested. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>compress</b></code> - + <code>True</code> to ask the remote client/server to compress + traffic; <code>False</code> to refuse compression + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Since:</b> 1.5.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="_activate_inbound"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_activate_inbound</span>(<span class=sig-arg>self</span>)</span> + </h3> + switch on newly negotiated encryption parameters for inbound + traffic + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_activate_outbound"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_activate_outbound</span>(<span class=sig-arg>self</span>)</span> + </h3> + switch on newly negotiated encryption parameters for outbound + traffic + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_compute_key"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_compute_key</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>id</span>, + <span class=sig-arg>nbytes</span>)</span> + </h3> + id is 'A' - 'F' for the various keys used by ssh + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_expect_packet"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_expect_packet</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>type</span>)</span> + </h3> + used by a kex object to register the next packet type it expects to + see + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_get_modulus_pack"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_get_modulus_pack</span>(<span class=sig-arg>self</span>)</span> + </h3> + used by KexGex to find primes for group exchange + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_send_kex_init"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_send_kex_init</span>(<span class=sig-arg>self</span>)</span> + </h3> + announce to the other side that we'd like to negotiate keys, and + what kind of key negotiation we support. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_send_user_message"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_send_user_message</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>)</span> + </h3> + send a message, but block if we're in key negotiation. this is used + for user-initiated requests. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_set_K_H"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_set_K_H</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>k</span>, + <span class=sig-arg>h</span>)</span> + </h3> + used by a kex object to set the K (root key) and H (exchange + hash) + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_unlink_channel"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_unlink_channel</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>chanid</span>)</span> + </h3> + used by a Channel to remove itself from the active channel list + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF STATIC METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Static Method Details</th></tr> +</table> + +<a name="load_server_moduli"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">load_server_moduli</span>(<span class=sig-arg>filename</span>=<span class=sig-default>None</span>)</span> + </h3> + <p><i>(optional)</i> Load a file of prime moduli for use in doing + group-exchange key negotiation in server mode. It's a rather obscure + option and can be safely ignored.</p> + In server mode, the remote client may request + "group-exchange" key negotiation, which asks the server to + send a random prime number that fits certain criteria. These primes are + pretty difficult to compute, so they can't be generated on demand. But + many systems contain a file of suitable primes (usually named something + like <code>/etc/ssh/moduli</code>). If you call + <code>load_server_moduli</code> and it returns <code>True</code>, then + this file of primes has been loaded and we will support + "group-exchange" in server mode. Otherwise server mode will + just claim that it doesn't support that method of key negotiation. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + optional path to the moduli file, if you happen to know that + it's not in a standard location. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + True if a moduli file was successfully loaded; False + otherwise. + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Note:</b> This has no effect when used in client mode. +</p> + +<p><b>Since:</b> doduo +</p> + + </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="_channel_handler_table"></a> +<h3>_channel_handler_table</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{96: <unbound method Channel._handle_eof>, 97: <unbound method Channel._handle_close>, 98: <unbound method Channel._handle_request>, 99: <unbound method Channel._request_success>, 100: <unbound method Channel._request_failed>, 93: <unbound method Channel._window_adjust>, 94: <unbound method Channel._feed>, 95: <unbound method Channel._feed_extended>}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{93: <unbound method Channel._window_adjust>, + 94: <unbound method Channel._feed>, + 95: <unbound method Channel._feed_extended>, + 96: <unbound method Channel._handle_eof>, + 97: <unbound method Channel._handle_close>, + 98: <unbound method Channel._handle_request>, + 99: <unbound method Channel._request_success>, + 100: <unbound method Channel._request_failed>} </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_cipher_info"></a> +<h3>_cipher_info</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{'blowfish-cbc': {'block-size': 8, 'key-size': 16, 'class': <module 'Crypto.Cipher.Blowfish' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/Blowfish.so'>, 'mode': 2}, '3des-cbc': {'block-size': 8, 'key-size': 24, 'class': <module 'Crypto.Cipher.DES3' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/DES3.so'>, 'mode': 2}, 'aes256-cbc': {'block-size': 16, 'key-size': 32, 'class': <module 'Crypto.Cipher.AES' from '/usr/lib/python2.4/site-packages/Crypto/Cipher/AES.so'>, 'mode': 2}, 'aes128-cbc': {'block-size': 16, 'key-size': 16, 'class': <module 'Crypto.Cipher.AES' from '/usr/lib/py..."> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{'3des-cbc': {'block-size': 8, + 'class': <module 'Crypto.Cipher.DES3' from '/usr/lib/pyt<span class="variable-linewrap">\</span> +hon2.4/site-packages/Crypto/Cipher/DES3.so'>, + 'key-size': 24, + 'mode': 2}, + 'aes128-cbc': {'block-size': 16, + 'class': <module 'Crypto.Cipher.AES' from '/usr/lib/py<span class="variable-linewrap">\</span> +thon2.4/site-packages/Crypto/Cipher/AES.so'>, +<span class="variable-ellipsis">...</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_CLIENT_ID"></a> +<h3>_CLIENT_ID</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'paramiko_1.5.2'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>paramiko_1.5.2<span class="variable-quote">'</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_compression_info"></a> +<h3>_compression_info</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{'none': (None, None), 'zlib': (<class 'paramiko.compress.ZlibCompressor'>, <class 'paramiko.compress.ZlibDecompressor'>), 'zlib@openssh.com': (<class 'paramiko.compress.ZlibCompressor'>, <class 'paramiko.compress.ZlibDecompressor'>)}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{'none': (None, None), + 'zlib': (<class 'paramiko.compress.ZlibCompressor'>, + <class 'paramiko.compress.ZlibDecompressor'>), + 'zlib@openssh.com': (<class 'paramiko.compress.ZlibCompressor'>, + <class 'paramiko.compress.ZlibDecompressor'>)} </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_handler_table"></a> +<h3>_handler_table</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{80: <function _parse_global_request at 0xb7b13fb4>, 81: <function _parse_request_success at 0xb7b1e02c>, 82: <function _parse_request_failure at 0xb7b1e064>, 20: <function _negotiate_keys at 0xb7b13dbc>, 21: <function _parse_newkeys at 0xb7b13f44>, 90: <function _parse_channel_open at 0xb7b1e10c>, 91: <function _parse_channel_open_success at 0xb7b1e09c>, 92: <function _parse_channel_open_failure at 0xb7b1e0d4>}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{20: <function _negotiate_keys at 0xb7b13dbc>, + 21: <function _parse_newkeys at 0xb7b13f44>, + 80: <function _parse_global_request at 0xb7b13fb4>, + 81: <function _parse_request_success at 0xb7b1e02c>, + 82: <function _parse_request_failure at 0xb7b1e064>, + 90: <function _parse_channel_open at 0xb7b1e10c>, + 91: <function _parse_channel_open_success at 0xb7b1e09c>, + 92: <function _parse_channel_open_failure at 0xb7b1e0d4>} </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_kex_info"></a> +<h3>_kex_info</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{'diffie-hellman-group1-sha1': <class 'paramiko.kex_group1.KexGroup1'>, 'diffie-hellman-group-exchange-sha1': <class 'paramiko.kex_gex.KexGex'>}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{'diffie-hellman-group-exchange-sha1': <class 'paramiko.kex_gex.KexGex<span class="variable-linewrap">\</span> +'>, + 'diffie-hellman-group1-sha1': <class 'paramiko.kex_group1.KexGroup1'><span class="variable-linewrap">\</span> +} </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_key_info"></a> +<h3>_key_info</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{'ssh-dss': <class 'paramiko.DSSKey'>, 'ssh-rsa': <class 'paramiko.RSAKey'>}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{'ssh-dss': <class 'paramiko.DSSKey'>, 'ssh-rsa': <class 'paramiko.RSA<span class="variable-linewrap">\</span> +Key'>} </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_mac_info"></a> +<h3>_mac_info</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{'hmac-sha1': {'class': <module 'Crypto.Hash.SHA' from '/usr/lib/python2.4/site-packages/Crypto/Hash/SHA.pyc'>, 'size': 20}, 'hmac-md5-96': {'class': <module 'Crypto.Hash.MD5' from '/usr/lib/python2.4/site-packages/Crypto/Hash/MD5.pyc'>, 'size': 12}, 'hmac-sha1-96': {'class': <module 'Crypto.Hash.SHA' from '/usr/lib/python2.4/site-packages/Crypto/Hash/SHA.pyc'>, 'size': 12}, 'hmac-md5': {'class': <module 'Crypto.Hash.MD5' from '/usr/lib/python2.4/site-packages/Crypto/Hash/MD5.pyc'>, 'size': 16}}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{'hmac-md5': {'class': <module 'Crypto.Hash.MD5' from '/usr/lib/python<span class="variable-linewrap">\</span> +2.4/site-packages/Crypto/Hash/MD5.pyc'>, + 'size': 16}, + 'hmac-md5-96': {'class': <module 'Crypto.Hash.MD5' from '/usr/lib/pyt<span class="variable-linewrap">\</span> +hon2.4/site-packages/Crypto/Hash/MD5.pyc'>, + 'size': 12}, + 'hmac-sha1': {'class': <module 'Crypto.Hash.SHA' from '/usr/lib/pytho<span class="variable-linewrap">\</span> +n2.4/site-packages/Crypto/Hash/SHA.pyc'>, +<span class="variable-ellipsis">...</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_modulus_pack"></a> +<h3>_modulus_pack</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="_preferred_ciphers"></a> +<h3>_preferred_ciphers</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</code> + + </dd> +<span title="('aes128-cbc', 'blowfish-cbc', 'aes256-cbc', '3des-cbc')"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +('aes128-cbc', 'blowfish-cbc', 'aes256-cbc', '3des-cbc') </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_preferred_compression"></a> +<h3>_preferred_compression</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</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="_preferred_kex"></a> +<h3>_preferred_kex</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</code> + + </dd> +<span title="('diffie-hellman-group1-sha1', 'diffie-hellman-group-exchange-sha1')"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +('diffie-hellman-group1-sha1', 'diffie-hellman-group-exchange-sha1') </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_preferred_keys"></a> +<h3>_preferred_keys</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</code> + + </dd> +<span title="('ssh-rsa', 'ssh-dss')"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +('ssh-rsa', 'ssh-dss') </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_preferred_macs"></a> +<h3>_preferred_macs</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</code> + + </dd> +<span title="('hmac-sha1', 'hmac-md5', 'hmac-sha1-96', 'hmac-md5-96')"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +('hmac-sha1', 'hmac-md5', 'hmac-sha1-96', 'hmac-md5-96') </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_PROTO_ID"></a> +<h3>_PROTO_ID</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'2.0'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>2.0<span class="variable-quote">'</span> </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.agent-module.html b/docs/private/paramiko.agent-module.html new file mode 100644 index 0000000..889d9ea --- /dev/null +++ b/docs/private/paramiko.agent-module.html @@ -0,0 +1,164 @@ +<?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>paramiko.agent</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module agent + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.agent-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.agent-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.agent</h2> + +SSH Agent interface for Unix clients. +<hr/> + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.agent-module.html#SSH2_AGENT_IDENTITIES_ANSWER"><code>SSH2_AGENT_IDENTITIES_ANSWER</code></a></b> = <span title="12">12 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.agent-module.html#SSH2_AGENT_SIGN_RESPONSE"><code>SSH2_AGENT_SIGN_RESPONSE</code></a></b> = <span title="14">14 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.agent-module.html#SSH2_AGENTC_REQUEST_IDENTITIES"><code>SSH2_AGENTC_REQUEST_IDENTITIES</code></a></b> = <span title="11">11 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.agent-module.html#SSH2_AGENTC_SIGN_REQUEST"><code>SSH2_AGENTC_SIGN_REQUEST</code></a></b> = <span title="13">13 </span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SSH2_AGENT_IDENTITIES_ANSWER"></a> +<h3>SSH2_AGENT_IDENTITIES_ANSWER</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="12"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +12 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SSH2_AGENT_SIGN_RESPONSE"></a> +<h3>SSH2_AGENT_SIGN_RESPONSE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="14"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +14 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SSH2_AGENTC_REQUEST_IDENTITIES"></a> +<h3>SSH2_AGENTC_REQUEST_IDENTITIES</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="11"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +11 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SSH2_AGENTC_SIGN_REQUEST"></a> +<h3>SSH2_AGENTC_SIGN_REQUEST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="13"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +13 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.auth_handler-module.html b/docs/private/paramiko.auth_handler-module.html new file mode 100644 index 0000000..464b764 --- /dev/null +++ b/docs/private/paramiko.auth_handler-module.html @@ -0,0 +1,62 @@ +<?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>paramiko.auth_handler</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module auth_handler + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.auth_handler-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.auth_handler</h2> + +<a href="../private/paramiko.AuthHandler-class.html" +class="link"><code>AuthHandler</code></a> +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.ber-module.html b/docs/private/paramiko.ber-module.html new file mode 100644 index 0000000..03d907b --- /dev/null +++ b/docs/private/paramiko.ber-module.html @@ -0,0 +1,79 @@ +<?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>paramiko.ber</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module ber + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.ber-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.ber</h2> + + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.ber.BER-class.html"><code>BER</code></a></b></td> + <td>Robey's tiny little attempt at a BER decoder.</td></tr> +</table><br /> + + +<!-- =========== START OF EXCEPTIONS =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Exceptions</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.ber.BERException-class.html"><code>BERException</code></a></b></td> + <td> </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.ber.BER-class.html b/docs/private/paramiko.ber.BER-class.html new file mode 100644 index 0000000..79b10ba --- /dev/null +++ b/docs/private/paramiko.ber.BER-class.html @@ -0,0 +1,145 @@ +<?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>paramiko.ber.BER</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.ber-module.html">Module ber</a> :: + Class BER + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.ber.BER-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type BER</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>BER</b> +</pre><br /> + +<hr/> + +Robey's tiny little attempt at a BER decoder. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>content</span>)</span></code> +</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><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</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><a name="decode"></a><span class="summary-sig"><span class="summary-sig-name">decode</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><a name="decode_next"></a><span class="summary-sig"><span class="summary-sig-name">decode_next</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><a name="decode_sequence"></a><span class="summary-sig"><span class="summary-sig-name">decode_sequence</span>(<span class=summary-sig-arg>data</span>)</span></code> +<br /> + <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="encode"></a><span class="summary-sig"><span class="summary-sig-name">encode</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="encode_sequence"></a><span class="summary-sig"><span class="summary-sig-name">encode_sequence</span>(<span class=summary-sig-arg>data</span>)</span></code> +<br /> + <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="encode_tlv"></a><span class="summary-sig"><span class="summary-sig-name">encode_tlv</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>ident</span>, + <span class=summary-sig-arg>val</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.ber.BERException-class.html b/docs/private/paramiko.ber.BERException-class.html new file mode 100644 index 0000000..9ae6fff --- /dev/null +++ b/docs/private/paramiko.ber.BERException-class.html @@ -0,0 +1,86 @@ +<?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>paramiko.ber.BERException</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.ber-module.html">Module ber</a> :: + Class BERException + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.ber.BERException-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class BERException</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <b>BERException</b> +</pre><br /> + +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.channel-module.html b/docs/private/paramiko.channel-module.html new file mode 100644 index 0000000..bf3adc0 --- /dev/null +++ b/docs/private/paramiko.channel-module.html @@ -0,0 +1,71 @@ +<?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>paramiko.channel</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module channel + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.channel-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.channel</h2> + +Abstraction for an SSH2 channel. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.channel.ChannelStderrFile-class.html"><code>ChannelStderrFile</code></a></b></td> + <td> </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.channel.ChannelStderrFile-class.html b/docs/private/paramiko.channel.ChannelStderrFile-class.html new file mode 100644 index 0000000..646d24a --- /dev/null +++ b/docs/private/paramiko.channel.ChannelStderrFile-class.html @@ -0,0 +1,282 @@ +<?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>paramiko.channel.ChannelStderrFile</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.channel-module.html">Module channel</a> :: + Class ChannelStderrFile + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.channel.ChannelStderrFile-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type ChannelStderrFile</h2> + +<pre class="base-tree"> + <a href="__builtin__.object-class.html"><code>object</code></a> --+ + | +<a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a> --+ + | + <a href="../private/paramiko.ChannelFile-class.html"><code>ChannelFile</code></a> --+ + | + <b>ChannelStderrFile</b> +</pre><br /> + +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</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="../private/paramiko.channel.ChannelStderrFile-class.html#_read" class="summary-sig-name"><code>_read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +<i>(subclass override)</i> Read data from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.channel.ChannelStderrFile-class.html#_write" class="summary-sig-name"><code>_write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +<i>(subclass override)</i> Write data into the stream.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from ChannelFile</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns a string representation of this object, for debugging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.ChannelFile-class.html#seek" class="summary-sig-name"><code>seek</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>whence</span>)</span></code> +<br /> +Set the file's current position, like stdio's <code>fseek</code>.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BufferedFile</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__del__" class="summary-sig-name"><code>__del__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns an iterator that can be used to iterate over the lines in this +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#flush" class="summary-sig-name"><code>flush</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Write out any data in the write buffer.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#next" class="summary-sig-name"><code>next</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the next line from the input, or raises +<code>StopIteration</code> when EOF is hit.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read at most <code>size</code> bytes from the file (less if we hit the +end of the file first).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readline" class="summary-sig-name"><code>readline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read one entire line from the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readlines" class="summary-sig-name"><code>readlines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sizehint</span>)</span></code> +<br /> +Read all remaining lines using <a +href="paramiko.BufferedFile-class.html#readline" +class="link"><code>readline</code></a> and return them as a list.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#tell" class="summary-sig-name"><code>tell</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the file's current position.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Write data to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#writelines" class="summary-sig-name"><code>writelines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sequence</span>)</span></code> +<br /> +Write a sequence of strings to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#xreadlines" class="summary-sig-name"><code>xreadlines</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Identical to <code>iter(f)</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_get_size" class="summary-sig-name"><code>_get_size</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +<i>(subclass override)</i> Return the size of the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_record_newline" class="summary-sig-name"><code>_record_newline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>newline</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="../private/paramiko.BufferedFile-class.html#_set_mode" class="summary-sig-name"><code>_set_mode</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Subclasses call this method to initialize the BufferedFile.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.BufferedFile-class.html#_write_all" class="summary-sig-name"><code>_write_all</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BufferedFile</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></b> = <span title="0">0 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.BufferedFile-class.html#_DEFAULT_BUFSIZE"><code>_DEFAULT_BUFSIZE</code></a></b> = <span title="8192">8192 </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="_read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_read</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>size</span>)</span> + </h3> + <i>(subclass override)</i> Read data from the stream. Return + <code>None</code> or raise <code>EOFError</code> to indicate EOF. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.ChannelFile-class.html#_read"><code>paramiko.ChannelFile._read</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="_write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_write</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>)</span> + </h3> + <i>(subclass override)</i> Write data into the stream. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.ChannelFile-class.html#_write"><code>paramiko.ChannelFile._write</code></a> <i>(inherited documentation)</i> +</dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/paramiko.common-module.html b/docs/private/paramiko.common-module.html new file mode 100644 index 0000000..5422192 --- /dev/null +++ b/docs/private/paramiko.common-module.html @@ -0,0 +1,1013 @@ +<?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>paramiko.common</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module common + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.common-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.common</h2> + +Common constants and global variables. +<hr/> + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#AUTH_FAILED"><code>AUTH_FAILED</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#AUTH_PARTIALLY_SUCCESSFUL"><code>AUTH_PARTIALLY_SUCCESSFUL</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#AUTH_SUCCESSFUL"><code>AUTH_SUCCESSFUL</code></a></b> = <span title="0">0 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#CONNECTION_FAILED_CODE"><code>CONNECTION_FAILED_CODE</code></a></b> = <span title="{1: 'Administratively prohibited', 2: 'Connect failed', 3: 'Unknown channel type', 4: 'Resource shortage'}"><code>{1: 'Administratively prohibite<span class="variable-ellipsis">...</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="../private/paramiko.common-module.html#CRITICAL"><code>CRITICAL</code></a></b> = <span title="50">50 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#DEBUG"><code>DEBUG</code></a></b> = <span title="10">10 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#DISCONNECT_AUTH_CANCELLED_BY_USER"><code>DISCONNECT_AUTH_CANCELLED_BY_USER</code></a></b> = <span title="13">13 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE"><code>DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE</code></a></b> = <span title="14">14 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#DISCONNECT_SERVICE_NOT_AVAILABLE"><code>DISCONNECT_SERVICE_NOT_AVAILABLE</code></a></b> = <span title="7">7 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#ERROR"><code>ERROR</code></a></b> = <span title="40">40 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#INFO"><code>INFO</code></a></b> = <span title="20">20 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_CLOSE"><code>MSG_CHANNEL_CLOSE</code></a></b> = <span title="97">97 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_DATA"><code>MSG_CHANNEL_DATA</code></a></b> = <span title="94">94 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_EOF"><code>MSG_CHANNEL_EOF</code></a></b> = <span title="96">96 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_EXTENDED_DATA"><code>MSG_CHANNEL_EXTENDED_DATA</code></a></b> = <span title="95">95 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_FAILURE"><code>MSG_CHANNEL_FAILURE</code></a></b> = <span title="100">100 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN"><code>MSG_CHANNEL_OPEN</code></a></b> = <span title="90">90 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN_FAILURE"><code>MSG_CHANNEL_OPEN_FAILURE</code></a></b> = <span title="92">92 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN_SUCCESS"><code>MSG_CHANNEL_OPEN_SUCCESS</code></a></b> = <span title="91">91 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_REQUEST"><code>MSG_CHANNEL_REQUEST</code></a></b> = <span title="98">98 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_SUCCESS"><code>MSG_CHANNEL_SUCCESS</code></a></b> = <span title="99">99 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_CHANNEL_WINDOW_ADJUST"><code>MSG_CHANNEL_WINDOW_ADJUST</code></a></b> = <span title="93">93 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_DEBUG"><code>MSG_DEBUG</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_DISCONNECT"><code>MSG_DISCONNECT</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_GLOBAL_REQUEST"><code>MSG_GLOBAL_REQUEST</code></a></b> = <span title="80">80 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_IGNORE"><code>MSG_IGNORE</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_KEXINIT"><code>MSG_KEXINIT</code></a></b> = <span title="20">20 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_NAMES"><code>MSG_NAMES</code></a></b> = <span title="{1: 'disconnect', 2: 'ignore', 3: 'unimplemented', 4: 'debug', 5: 'service-request', 6: 'service-accept', 20: 'kexinit', 21: 'newkeys', 30: 'kex30', 31: 'kex31', 32: 'kex32', 33: 'kex33', 34: 'kex34', 50: 'userauth-request', 51: 'userauth-failure', 52: 'userauth-success', 53: 'userauth--banner', 60: 'userauth-60(pk-ok/info-request)', 61: 'userauth-info-response', 80: 'global-request', 81: 'request-success', 82: 'request-failure', 90: 'channel-open', 91: 'channel-open-success', 92: 'channel-open-failure', 93: 'channel-window-adjust', 94: 'channel-data', 95: 'channel-extended-data', 96: 'chan..."><code>{1: 'disconnect', 2: 'ignore', 3: 'unimpleme<span class="variable-ellipsis">...</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="../private/paramiko.common-module.html#MSG_NEWKEYS"><code>MSG_NEWKEYS</code></a></b> = <span title="21">21 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_REQUEST_FAILURE"><code>MSG_REQUEST_FAILURE</code></a></b> = <span title="82">82 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_REQUEST_SUCCESS"><code>MSG_REQUEST_SUCCESS</code></a></b> = <span title="81">81 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_SERVICE_ACCEPT"><code>MSG_SERVICE_ACCEPT</code></a></b> = <span title="6">6 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_SERVICE_REQUEST"><code>MSG_SERVICE_REQUEST</code></a></b> = <span title="5">5 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_UNIMPLEMENTED"><code>MSG_UNIMPLEMENTED</code></a></b> = <span title="3">3 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_USERAUTH_BANNER"><code>MSG_USERAUTH_BANNER</code></a></b> = <span title="53">53 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_USERAUTH_FAILURE"><code>MSG_USERAUTH_FAILURE</code></a></b> = <span title="51">51 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_USERAUTH_INFO_REQUEST"><code>MSG_USERAUTH_INFO_REQUEST</code></a></b> = <span title="60">60 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_USERAUTH_INFO_RESPONSE"><code>MSG_USERAUTH_INFO_RESPONSE</code></a></b> = <span title="61">61 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_USERAUTH_PK_OK"><code>MSG_USERAUTH_PK_OK</code></a></b> = <span title="60">60 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_USERAUTH_REQUEST"><code>MSG_USERAUTH_REQUEST</code></a></b> = <span title="50">50 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#MSG_USERAUTH_SUCCESS"><code>MSG_USERAUTH_SUCCESS</code></a></b> = <span title="52">52 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.common-module.html#WARNING"><code>WARNING</code></a></b> = <span title="30">30 </span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="AUTH_FAILED"></a> +<h3>AUTH_FAILED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="AUTH_PARTIALLY_SUCCESSFUL"></a> +<h3>AUTH_PARTIALLY_SUCCESSFUL</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="AUTH_SUCCESSFUL"></a> +<h3>AUTH_SUCCESSFUL</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> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CONNECTION_FAILED_CODE"></a> +<h3>CONNECTION_FAILED_CODE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{1: 'Administratively prohibited', 2: 'Connect failed', 3: 'Unknown channel type', 4: 'Resource shortage'}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{1: 'Administratively prohibited', + 2: 'Connect failed', + 3: 'Unknown channel type', + 4: 'Resource shortage'} </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CRITICAL"></a> +<h3>CRITICAL</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="50"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +50 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="DEBUG"></a> +<h3>DEBUG</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="10"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +10 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="DISCONNECT_AUTH_CANCELLED_BY_USER"></a> +<h3>DISCONNECT_AUTH_CANCELLED_BY_USER</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="13"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +13 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE"></a> +<h3>DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="14"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +14 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="DISCONNECT_SERVICE_NOT_AVAILABLE"></a> +<h3>DISCONNECT_SERVICE_NOT_AVAILABLE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="7"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +7 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="ERROR"></a> +<h3>ERROR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="40"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +40 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="INFO"></a> +<h3>INFO</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="20"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +20 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_CLOSE"></a> +<h3>MSG_CHANNEL_CLOSE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="97"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +97 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_DATA"></a> +<h3>MSG_CHANNEL_DATA</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="94"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +94 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_EOF"></a> +<h3>MSG_CHANNEL_EOF</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="96"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +96 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_EXTENDED_DATA"></a> +<h3>MSG_CHANNEL_EXTENDED_DATA</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="95"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +95 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_FAILURE"></a> +<h3>MSG_CHANNEL_FAILURE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="100"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +100 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_OPEN"></a> +<h3>MSG_CHANNEL_OPEN</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="90"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +90 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_OPEN_FAILURE"></a> +<h3>MSG_CHANNEL_OPEN_FAILURE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="92"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +92 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_OPEN_SUCCESS"></a> +<h3>MSG_CHANNEL_OPEN_SUCCESS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="91"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +91 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_REQUEST"></a> +<h3>MSG_CHANNEL_REQUEST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="98"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +98 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_SUCCESS"></a> +<h3>MSG_CHANNEL_SUCCESS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="99"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +99 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_CHANNEL_WINDOW_ADJUST"></a> +<h3>MSG_CHANNEL_WINDOW_ADJUST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="93"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +93 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_DEBUG"></a> +<h3>MSG_DEBUG</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_DISCONNECT"></a> +<h3>MSG_DISCONNECT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_GLOBAL_REQUEST"></a> +<h3>MSG_GLOBAL_REQUEST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="80"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +80 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_IGNORE"></a> +<h3>MSG_IGNORE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_KEXINIT"></a> +<h3>MSG_KEXINIT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="20"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +20 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_NAMES"></a> +<h3>MSG_NAMES</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{1: 'disconnect', 2: 'ignore', 3: 'unimplemented', 4: 'debug', 5: 'service-request', 6: 'service-accept', 20: 'kexinit', 21: 'newkeys', 30: 'kex30', 31: 'kex31', 32: 'kex32', 33: 'kex33', 34: 'kex34', 50: 'userauth-request', 51: 'userauth-failure', 52: 'userauth-success', 53: 'userauth--banner', 60: 'userauth-60(pk-ok/info-request)', 61: 'userauth-info-response', 80: 'global-request', 81: 'request-success', 82: 'request-failure', 90: 'channel-open', 91: 'channel-open-success', 92: 'channel-open-failure', 93: 'channel-window-adjust', 94: 'channel-data', 95: 'channel-extended-data', 96: 'chan..."> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{1: 'disconnect', + 2: 'ignore', + 3: 'unimplemented', + 4: 'debug', + 5: 'service-request', + 6: 'service-accept', + 20: 'kexinit', + 21: 'newkeys', +<span class="variable-ellipsis">...</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_NEWKEYS"></a> +<h3>MSG_NEWKEYS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="21"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +21 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_REQUEST_FAILURE"></a> +<h3>MSG_REQUEST_FAILURE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="82"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +82 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_REQUEST_SUCCESS"></a> +<h3>MSG_REQUEST_SUCCESS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="81"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +81 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_SERVICE_ACCEPT"></a> +<h3>MSG_SERVICE_ACCEPT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="6"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +6 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_SERVICE_REQUEST"></a> +<h3>MSG_SERVICE_REQUEST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="5"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +5 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_UNIMPLEMENTED"></a> +<h3>MSG_UNIMPLEMENTED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="3"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +3 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_USERAUTH_BANNER"></a> +<h3>MSG_USERAUTH_BANNER</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="53"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +53 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_USERAUTH_FAILURE"></a> +<h3>MSG_USERAUTH_FAILURE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="51"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +51 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_USERAUTH_INFO_REQUEST"></a> +<h3>MSG_USERAUTH_INFO_REQUEST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="60"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +60 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_USERAUTH_INFO_RESPONSE"></a> +<h3>MSG_USERAUTH_INFO_RESPONSE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="61"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +61 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_USERAUTH_PK_OK"></a> +<h3>MSG_USERAUTH_PK_OK</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="60"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +60 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_USERAUTH_REQUEST"></a> +<h3>MSG_USERAUTH_REQUEST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="50"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +50 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="MSG_USERAUTH_SUCCESS"></a> +<h3>MSG_USERAUTH_SUCCESS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="52"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +52 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="WARNING"></a> +<h3>WARNING</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="30"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +30 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.compress-module.html b/docs/private/paramiko.compress-module.html new file mode 100644 index 0000000..aa60bc4 --- /dev/null +++ b/docs/private/paramiko.compress-module.html @@ -0,0 +1,74 @@ +<?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>paramiko.compress</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module compress + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.compress-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.compress</h2> + +Compression implementations for a Transport. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.compress.ZlibCompressor-class.html"><code>ZlibCompressor</code></a></b></td> + <td> </td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.compress.ZlibDecompressor-class.html"><code>ZlibDecompressor</code></a></b></td> + <td> </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/paramiko.compress.ZlibCompressor-class.html b/docs/private/paramiko.compress.ZlibCompressor-class.html new file mode 100644 index 0000000..ac848f4 --- /dev/null +++ b/docs/private/paramiko.compress.ZlibCompressor-class.html @@ -0,0 +1,122 @@ +<?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>paramiko.compress.ZlibCompressor</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.compress-module.html">Module compress</a> :: + Class ZlibCompressor + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.compress.ZlibCompressor-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type ZlibCompressor</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>ZlibCompressor</b> +</pre><br /> + +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</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><a name="__call__"></a><span class="summary-sig"><span class="summary-sig-name">__call__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.compress.ZlibDecompressor-class.html b/docs/private/paramiko.compress.ZlibDecompressor-class.html new file mode 100644 index 0000000..63e0b1f --- /dev/null +++ b/docs/private/paramiko.compress.ZlibDecompressor-class.html @@ -0,0 +1,122 @@ +<?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>paramiko.compress.ZlibDecompressor</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.compress-module.html">Module compress</a> :: + Class ZlibDecompressor + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.compress.ZlibDecompressor-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type ZlibDecompressor</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>ZlibDecompressor</b> +</pre><br /> + +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</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><a name="__call__"></a><span class="summary-sig"><span class="summary-sig-name">__call__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.dsskey-module.html b/docs/private/paramiko.dsskey-module.html new file mode 100644 index 0000000..370a1c8 --- /dev/null +++ b/docs/private/paramiko.dsskey-module.html @@ -0,0 +1,62 @@ +<?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>paramiko.dsskey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module dsskey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.dsskey-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.dsskey-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.dsskey</h2> + +<a href="paramiko.DSSKey-class.html" +class="link"><code>DSSKey</code></a> +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.file-module.html b/docs/private/paramiko.file-module.html new file mode 100644 index 0000000..676e3ce --- /dev/null +++ b/docs/private/paramiko.file-module.html @@ -0,0 +1,230 @@ +<?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>paramiko.file</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module file + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.file-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.file-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.file</h2> + +BufferedFile. +<hr/> + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.file-module.html#_FLAG_APPEND"><code>_FLAG_APPEND</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.file-module.html#_FLAG_BINARY"><code>_FLAG_BINARY</code></a></b> = <span title="16">16 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.file-module.html#_FLAG_BUFFERED"><code>_FLAG_BUFFERED</code></a></b> = <span title="32">32 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.file-module.html#_FLAG_LINE_BUFFERED"><code>_FLAG_LINE_BUFFERED</code></a></b> = <span title="64">64 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.file-module.html#_FLAG_READ"><code>_FLAG_READ</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.file-module.html#_FLAG_UNIVERSAL_NEWLINE"><code>_FLAG_UNIVERSAL_NEWLINE</code></a></b> = <span title="128">128 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.file-module.html#_FLAG_WRITE"><code>_FLAG_WRITE</code></a></b> = <span title="2">2 </span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_FLAG_APPEND"></a> +<h3>_FLAG_APPEND</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_FLAG_BINARY"></a> +<h3>_FLAG_BINARY</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="16"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +16 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_FLAG_BUFFERED"></a> +<h3>_FLAG_BUFFERED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="32"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +32 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_FLAG_LINE_BUFFERED"></a> +<h3>_FLAG_LINE_BUFFERED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="64"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +64 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_FLAG_READ"></a> +<h3>_FLAG_READ</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_FLAG_UNIVERSAL_NEWLINE"></a> +<h3>_FLAG_UNIVERSAL_NEWLINE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="128"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +128 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_FLAG_WRITE"></a> +<h3>_FLAG_WRITE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.kex_gex-module.html b/docs/private/paramiko.kex_gex-module.html new file mode 100644 index 0000000..8fad377 --- /dev/null +++ b/docs/private/paramiko.kex_gex-module.html @@ -0,0 +1,179 @@ +<?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>paramiko.kex_gex</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module kex_gex + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.kex_gex-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.kex_gex</h2> + +Variant on <a +href="../private/paramiko.kex_group1.KexGroup1-class.html" +class="link"><code>KexGroup1</code></a> where the prime "p" and +generator "g" are provided by the server. A bit more work is +required on the client side, and a <b>lot</b> more on the server +side. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.kex_gex.KexGex-class.html"><code>KexGex</code></a></b></td> + <td> </td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_GROUP"><code>_MSG_KEXDH_GEX_GROUP</code></a></b> = <span title="31">31 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_INIT"><code>_MSG_KEXDH_GEX_INIT</code></a></b> = <span title="32">32 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_REPLY"><code>_MSG_KEXDH_GEX_REPLY</code></a></b> = <span title="33">33 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_REQUEST"><code>_MSG_KEXDH_GEX_REQUEST</code></a></b> = <span title="34">34 </span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_MSG_KEXDH_GEX_GROUP"></a> +<h3>_MSG_KEXDH_GEX_GROUP</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="31"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +31 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_MSG_KEXDH_GEX_INIT"></a> +<h3>_MSG_KEXDH_GEX_INIT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="32"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +32 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_MSG_KEXDH_GEX_REPLY"></a> +<h3>_MSG_KEXDH_GEX_REPLY</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="33"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +33 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_MSG_KEXDH_GEX_REQUEST"></a> +<h3>_MSG_KEXDH_GEX_REQUEST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="34"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +34 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.kex_gex.KexGex-class.html b/docs/private/paramiko.kex_gex.KexGex-class.html new file mode 100644 index 0000000..2eec555 --- /dev/null +++ b/docs/private/paramiko.kex_gex.KexGex-class.html @@ -0,0 +1,250 @@ +<?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>paramiko.kex_gex.KexGex</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.kex_gex-module.html">Module kex_gex</a> :: + Class KexGex + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.kex_gex.KexGex-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type KexGex</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>KexGex</b> +</pre><br /> + +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>transport</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_generate_x"></a><span class="summary-sig"><span class="summary-sig-name">_generate_x</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><a name="_parse_kexdh_gex_group"></a><span class="summary-sig"><span class="summary-sig-name">_parse_kexdh_gex_group</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_kexdh_gex_init"></a><span class="summary-sig"><span class="summary-sig-name">_parse_kexdh_gex_init</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_kexdh_gex_reply"></a><span class="summary-sig"><span class="summary-sig-name">_parse_kexdh_gex_reply</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_kexdh_gex_request"></a><span class="summary-sig"><span class="summary-sig-name">_parse_kexdh_gex_request</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="parse_next"></a><span class="summary-sig"><span class="summary-sig-name">parse_next</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>ptype</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="start_kex"></a><span class="summary-sig"><span class="summary-sig-name">start_kex</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>int</code></font></td> +<td><b><a href="../private/paramiko.kex_gex.KexGex-class.html#max_bits"><code>max_bits</code></a></b> = <span title="8192">8192 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.kex_gex.KexGex-class.html#min_bits"><code>min_bits</code></a></b> = <span title="1024">1024 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td> +<td><b><a href="../private/paramiko.kex_gex.KexGex-class.html#name"><code>name</code></a></b> = <span title="'diffie-hellman-group-exchange-sha1'"><code><span class="variable-quote">'</span>diffie-hellman-group-exchange-sha1<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="../private/paramiko.kex_gex.KexGex-class.html#preferred_bits"><code>preferred_bits</code></a></b> = <span title="2048">2048 </span></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="max_bits"></a> +<h3>max_bits</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8192"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8192 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="min_bits"></a> +<h3>min_bits</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1024"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1024 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="name"></a> +<h3>name</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'diffie-hellman-group-exchange-sha1'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>diffie-hellman-group-exchange-sha1<span class="variable-quote">'</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="preferred_bits"></a> +<h3>preferred_bits</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2048"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2048 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.kex_group1-module.html b/docs/private/paramiko.kex_group1-module.html new file mode 100644 index 0000000..84a44f2 --- /dev/null +++ b/docs/private/paramiko.kex_group1-module.html @@ -0,0 +1,181 @@ +<?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>paramiko.kex_group1</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module kex_group1 + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.kex_group1-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.kex_group1</h2> + +Standard SSH key exchange ("kex" if you wanna sound cool). +Diffie-Hellman of 1024 bit key halves, using a known "p" prime +and "g" generator. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>KexGroup1</code></a></b></td> + <td> </td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.kex_group1-module.html#_MSG_KEXDH_INIT"><code>_MSG_KEXDH_INIT</code></a></b> = <span title="30">30 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.kex_group1-module.html#_MSG_KEXDH_REPLY"><code>_MSG_KEXDH_REPLY</code></a></b> = <span title="31">31 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.kex_group1-module.html#G"><code>G</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>long</code></font></td> +<td><b><a href="../private/paramiko.kex_group1-module.html#P"><code>P</code></a></b> = <span title="179769313486231590770839156793787453197860296048756011706444423684197180216158519368947833795864925541502180565485980503646440548199239100050792877003355816639229553136239076508735759914822574862575007425302077447712589550957937778424442426617334727629299387668709205606050270810842907692932019128194467627007L"><code>1797693134862315907708391567937874531978602960487560<span class="variable-ellipsis">...</span></code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_MSG_KEXDH_INIT"></a> +<h3>_MSG_KEXDH_INIT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="30"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +30 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_MSG_KEXDH_REPLY"></a> +<h3>_MSG_KEXDH_REPLY</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="31"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +31 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="G"></a> +<h3>G</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="P"></a> +<h3>P</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>long</code> + + </dd> +<span title="179769313486231590770839156793787453197860296048756011706444423684197180216158519368947833795864925541502180565485980503646440548199239100050792877003355816639229553136239076508735759914822574862575007425302077447712589550957937778424442426617334727629299387668709205606050270810842907692932019128194467627007L"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1797693134862315907708391567937874531978602960487560117064444236841971<span class="variable-linewrap">\</span> +8021615851936894783379586492554150218056548598050364644054819923910005<span class="variable-linewrap">\</span> +0792877003355816639229553136239076508735759914822574862575007425302077<span class="variable-linewrap">\</span> +4477125895509579377784244424266173347276292993876687092056060502708108<span class="variable-linewrap">\</span> +42907692932019128194467627007L </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.kex_group1.KexGroup1-class.html b/docs/private/paramiko.kex_group1.KexGroup1-class.html new file mode 100644 index 0000000..7287b9d --- /dev/null +++ b/docs/private/paramiko.kex_group1.KexGroup1-class.html @@ -0,0 +1,176 @@ +<?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>paramiko.kex_group1.KexGroup1</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.kex_group1-module.html">Module kex_group1</a> :: + Class KexGroup1 + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.kex_group1.KexGroup1-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type KexGroup1</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>KexGroup1</b> +</pre><br /> + +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>transport</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_generate_x"></a><span class="summary-sig"><span class="summary-sig-name">_generate_x</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><a name="_parse_kexdh_init"></a><span class="summary-sig"><span class="summary-sig-name">_parse_kexdh_init</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_kexdh_reply"></a><span class="summary-sig"><span class="summary-sig-name">_parse_kexdh_reply</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="parse_next"></a><span class="summary-sig"><span class="summary-sig-name">parse_next</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>ptype</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="start_kex"></a><span class="summary-sig"><span class="summary-sig-name">start_kex</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>str</code></font></td> +<td><b><a href="../private/paramiko.kex_group1.KexGroup1-class.html#name"><code>name</code></a></b> = <span title="'diffie-hellman-group1-sha1'"><code><span class="variable-quote">'</span>diffie-hellman-group1-sha1<span class="variable-quote">'</span> </code> +</span></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="name"></a> +<h3>name</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'diffie-hellman-group1-sha1'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>diffie-hellman-group1-sha1<span class="variable-quote">'</span> </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.logging22-module.html b/docs/private/paramiko.logging22-module.html new file mode 100644 index 0000000..daa72e6 --- /dev/null +++ b/docs/private/paramiko.logging22-module.html @@ -0,0 +1,235 @@ +<?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>paramiko.logging22</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module logging22 + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.logging22-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.logging22</h2> + +Stub out logging on python < 2.3. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.logging22.Formatter-class.html"><code>Formatter</code></a></b></td> + <td> </td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.logging22.logger-class.html"><code>logger</code></a></b></td> + <td> </td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.logging22.StreamHandler-class.html"><code>StreamHandler</code></a></b></td> + <td> </td></tr> +</table><br /> + + +<!-- =========== START OF FUNCTION SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Function Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="getLogger"></a><span class="summary-sig"><span class="summary-sig-name">getLogger</span>(<span class=summary-sig-arg>name</span>)</span></code> +</td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>logger</code></font></td> +<td><b><a href="../private/paramiko.logging22-module.html#_logger"><code>_logger</code></a></b> = <span title="<paramiko.logging22.logger object at 0xb7b2254c>"><code><paramiko.logging22.logger object at 0xb7b2254<span class="variable-ellipsis">...</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="../private/paramiko.logging22-module.html#CRITICAL"><code>CRITICAL</code></a></b> = <span title="50">50 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.logging22-module.html#DEBUG"><code>DEBUG</code></a></b> = <span title="10">10 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.logging22-module.html#ERROR"><code>ERROR</code></a></b> = <span title="40">40 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.logging22-module.html#INFO"><code>INFO</code></a></b> = <span title="20">20 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.logging22-module.html#WARNING"><code>WARNING</code></a></b> = <span title="30">30 </span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_logger"></a> +<h3>_logger</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>logger</code> + + </dd> +<span title="<paramiko.logging22.logger object at 0xb7b2254c>"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<paramiko.logging22.logger object at 0xb7b2254c> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CRITICAL"></a> +<h3>CRITICAL</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="50"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +50 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="DEBUG"></a> +<h3>DEBUG</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="10"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +10 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="ERROR"></a> +<h3>ERROR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="40"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +40 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="INFO"></a> +<h3>INFO</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="20"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +20 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="WARNING"></a> +<h3>WARNING</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="30"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +30 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.logging22.Formatter-class.html b/docs/private/paramiko.logging22.Formatter-class.html new file mode 100644 index 0000000..78fa916 --- /dev/null +++ b/docs/private/paramiko.logging22.Formatter-class.html @@ -0,0 +1,120 @@ +<?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>paramiko.logging22.Formatter</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.logging22-module.html">Module logging22</a> :: + Class Formatter + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.logging22.Formatter-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Formatter</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>Formatter</b> +</pre><br /> + +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>x</span>, + <span class=summary-sig-arg>y</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.logging22.StreamHandler-class.html b/docs/private/paramiko.logging22.StreamHandler-class.html new file mode 100644 index 0000000..dc3e953 --- /dev/null +++ b/docs/private/paramiko.logging22.StreamHandler-class.html @@ -0,0 +1,123 @@ +<?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>paramiko.logging22.StreamHandler</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.logging22-module.html">Module logging22</a> :: + Class StreamHandler + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.logging22.StreamHandler-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type StreamHandler</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>StreamHandler</b> +</pre><br /> + +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>f</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="setFormatter"></a><span class="summary-sig"><span class="summary-sig-name">setFormatter</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>f</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.logging22.logger-class.html b/docs/private/paramiko.logging22.logger-class.html new file mode 100644 index 0000000..75bd6da --- /dev/null +++ b/docs/private/paramiko.logging22.logger-class.html @@ -0,0 +1,135 @@ +<?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>paramiko.logging22.logger</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.logging22-module.html">Module logging22</a> :: + Class logger + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.logging22.logger-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type logger</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>logger</b> +</pre><br /> + +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</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><a name="addFilter"></a><span class="summary-sig"><span class="summary-sig-name">addFilter</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filter</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="addHandler"></a><span class="summary-sig"><span class="summary-sig-name">addHandler</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>h</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="log"></a><span class="summary-sig"><span class="summary-sig-name">log</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>level</span>, + <span class=summary-sig-arg>text</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="setLevel"></a><span class="summary-sig"><span class="summary-sig-name">setLevel</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>level</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.message-module.html b/docs/private/paramiko.message-module.html new file mode 100644 index 0000000..3a82218 --- /dev/null +++ b/docs/private/paramiko.message-module.html @@ -0,0 +1,61 @@ +<?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>paramiko.message</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module message + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.message-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.message-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.message</h2> + +Implementation of an SSH2 "message". +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/paramiko.packet-module.html b/docs/private/paramiko.packet-module.html new file mode 100644 index 0000000..a14ccd8 --- /dev/null +++ b/docs/private/paramiko.packet-module.html @@ -0,0 +1,71 @@ +<?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>paramiko.packet</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module packet + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.packet-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.packet</h2> + +Packetizer. +<hr/> + +<!-- =========== START OF EXCEPTIONS =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Exceptions</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.packet.NeedRekeyException-class.html"><code>NeedRekeyException</code></a></b></td> + <td> </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.packet.NeedRekeyException-class.html b/docs/private/paramiko.packet.NeedRekeyException-class.html new file mode 100644 index 0000000..850f706 --- /dev/null +++ b/docs/private/paramiko.packet.NeedRekeyException-class.html @@ -0,0 +1,86 @@ +<?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>paramiko.packet.NeedRekeyException</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.packet-module.html">Module packet</a> :: + Class NeedRekeyException + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.packet.NeedRekeyException-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class NeedRekeyException</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <b>NeedRekeyException</b> +</pre><br /> + +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.pipe-module.html b/docs/private/paramiko.pipe-module.html new file mode 100644 index 0000000..34edd01 --- /dev/null +++ b/docs/private/paramiko.pipe-module.html @@ -0,0 +1,87 @@ +<?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>paramiko.pipe</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module pipe + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.pipe-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.pipe</h2> + +Abstraction of a one-way pipe where the read end can be used in +select(). Normally this is trivial, but Windows makes it nearly +impossible. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.pipe.PosixPipe-class.html"><code>PosixPipe</code></a></b></td> + <td> </td></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>WindowsPipe</code></a></b></td> + <td>On Windows, only an OS-level "WinSock" may be used in +select(), but reads and writes must be to the actual socket object.</td></tr> +</table><br /> + + +<!-- =========== START OF FUNCTION SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Function Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="make_pipe"></a><span class="summary-sig"><span class="summary-sig-name">make_pipe</span>()</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.pipe.PosixPipe-class.html b/docs/private/paramiko.pipe.PosixPipe-class.html new file mode 100644 index 0000000..b8a01b1 --- /dev/null +++ b/docs/private/paramiko.pipe.PosixPipe-class.html @@ -0,0 +1,133 @@ +<?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>paramiko.pipe.PosixPipe</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.pipe-module.html">Module pipe</a> :: + Class PosixPipe + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.pipe.PosixPipe-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type PosixPipe</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>PosixPipe</b> +</pre><br /> + +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</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><a name="clear"></a><span class="summary-sig"><span class="summary-sig-name">clear</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><a name="close"></a><span class="summary-sig"><span class="summary-sig-name">close</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><a name="fileno"></a><span class="summary-sig"><span class="summary-sig-name">fileno</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><a name="set"></a><span class="summary-sig"><span class="summary-sig-name">set</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><a name="set_forever"></a><span class="summary-sig"><span class="summary-sig-name">set_forever</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/paramiko.pipe.WindowsPipe-class.html b/docs/private/paramiko.pipe.WindowsPipe-class.html new file mode 100644 index 0000000..56bd3f4 --- /dev/null +++ b/docs/private/paramiko.pipe.WindowsPipe-class.html @@ -0,0 +1,137 @@ +<?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>paramiko.pipe.WindowsPipe</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.pipe-module.html">Module pipe</a> :: + Class WindowsPipe + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.pipe.WindowsPipe-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type WindowsPipe</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>WindowsPipe</b> +</pre><br /> + +<hr/> + +On Windows, only an OS-level "WinSock" may be used in +select(), but reads and writes must be to the actual socket 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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</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><a name="clear"></a><span class="summary-sig"><span class="summary-sig-name">clear</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><a name="close"></a><span class="summary-sig"><span class="summary-sig-name">close</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><a name="fileno"></a><span class="summary-sig"><span class="summary-sig-name">fileno</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><a name="set"></a><span class="summary-sig"><span class="summary-sig-name">set</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><a name="set_forever"></a><span class="summary-sig"><span class="summary-sig-name">set_forever</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/paramiko.pkey-module.html b/docs/private/paramiko.pkey-module.html new file mode 100644 index 0000000..3b6a4a1 --- /dev/null +++ b/docs/private/paramiko.pkey-module.html @@ -0,0 +1,61 @@ +<?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>paramiko.pkey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module pkey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.pkey-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.pkey-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.pkey</h2> + +Common API for all public keys. +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.primes-module.html b/docs/private/paramiko.primes-module.html new file mode 100644 index 0000000..3f2df29 --- /dev/null +++ b/docs/private/paramiko.primes-module.html @@ -0,0 +1,117 @@ +<?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>paramiko.primes</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module primes + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.primes-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.primes</h2> + +Utility functions for dealing with primes. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.primes.ModulusPack-class.html"><code>ModulusPack</code></a></b></td> + <td>convenience object for holding the contents of the /etc/ssh/moduli +file, on systems that have such a file.</td></tr> +</table><br /> + + +<!-- =========== START OF FUNCTION SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Function Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.primes-module.html#_generate_prime" class="summary-sig-name"><code>_generate_prime</code></a>(<span class=summary-sig-arg>bits</span>, + <span class=summary-sig-arg>randpool</span>)</span></code> +<br /> +primtive attempt at prime generation</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.primes-module.html#_roll_random" class="summary-sig-name"><code>_roll_random</code></a>(<span class=summary-sig-arg>rpool</span>, + <span class=summary-sig-arg>n</span>)</span></code> +<br /> +returns a random # from 0 to N-1</td></tr> +</table><br /> + + +<!-- =========== START OF FUNCTION DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Function Details</th></tr> +</table> + +<a name="_generate_prime"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_generate_prime</span>(<span class=sig-arg>bits</span>, + <span class=sig-arg>randpool</span>)</span> + </h3> + primtive attempt at prime generation + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="_roll_random"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_roll_random</span>(<span class=sig-arg>rpool</span>, + <span class=sig-arg>n</span>)</span> + </h3> + returns a random # from 0 to N-1 + <dl><dt></dt><dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.primes.ModulusPack-class.html b/docs/private/paramiko.primes.ModulusPack-class.html new file mode 100644 index 0000000..438893b --- /dev/null +++ b/docs/private/paramiko.primes.ModulusPack-class.html @@ -0,0 +1,158 @@ +<?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>paramiko.primes.ModulusPack</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.primes-module.html">Module primes</a> :: + Class ModulusPack + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.primes.ModulusPack-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type ModulusPack</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>ModulusPack</b> +</pre><br /> + +<hr/> + +convenience object for holding the contents of the /etc/ssh/moduli +file, on systems that have such a file. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>rpool</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_parse_modulus"></a><span class="summary-sig"><span class="summary-sig-name">_parse_modulus</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>line</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="get_modulus"></a><span class="summary-sig"><span class="summary-sig-name">get_modulus</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>min</span>, + <span class=summary-sig-arg>prefer</span>, + <span class=summary-sig-arg>max</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="../private/paramiko.primes.ModulusPack-class.html#read_file" class="summary-sig-name"><code>read_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="read_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">read_file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>)</span> + </h3> + <dl><dt></dt><dd> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + passed from any file operations that fail. + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.rsakey-module.html b/docs/private/paramiko.rsakey-module.html new file mode 100644 index 0000000..29f2397 --- /dev/null +++ b/docs/private/paramiko.rsakey-module.html @@ -0,0 +1,62 @@ +<?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>paramiko.rsakey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module rsakey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.rsakey-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.rsakey-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.rsakey</h2> + +<a href="paramiko.RSAKey-class.html" +class="link"><code>RSAKey</code></a> +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.server-module.html b/docs/private/paramiko.server-module.html new file mode 100644 index 0000000..95d6786 --- /dev/null +++ b/docs/private/paramiko.server-module.html @@ -0,0 +1,74 @@ +<?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>paramiko.server</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module server + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.server-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.server-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.server</h2> + +<a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> is an interface to override +for server support. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="paramiko.server.InteractiveQuery-class.html"><code>InteractiveQuery</code></a></b></td> + <td>A query (set of prompts) for a user during interactive +authentication.</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.server.InteractiveQuery-class.html b/docs/private/paramiko.server.InteractiveQuery-class.html new file mode 100644 index 0000000..adc7ea2 --- /dev/null +++ b/docs/private/paramiko.server.InteractiveQuery-class.html @@ -0,0 +1,195 @@ +<?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>paramiko.server.InteractiveQuery</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="paramiko.server-module.html">Module server</a> :: + Class InteractiveQuery + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.server.InteractiveQuery-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.server.InteractiveQuery-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type InteractiveQuery</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>InteractiveQuery</b> +</pre><br /> + +<hr/> + +A query (set of prompts) for a user during interactive +authentication. +<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="paramiko.server.InteractiveQuery-class.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>instructions</span>, + <span class="summary-sig-vararg">*prompts</span>)</span></code> +<br /> +Create a new interactive query to send to the client.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.server.InteractiveQuery-class.html#add_prompt" class="summary-sig-name"><code>add_prompt</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>prompt</span>, + <span class=summary-sig-arg>echo</span>)</span></code> +<br /> +Add a prompt to this query.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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-default>''</span>, + <span class=sig-arg>instructions</span>=<span class=sig-default>''</span>, + <span class="sig-vararg">*prompts</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new interactive query to send to the client. The name and + instructions are optional, but are generally displayed to the end user. + A list of prompts may be included, or they may be added via the <a + href="paramiko.server.InteractiveQuery-class.html#add_prompt" + class="link"><code>add_prompt</code></a> method. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + name of this query + <br /><i> + (type=str)</i> + <dd><code><b>instructions</b></code> - + user instructions (usually short) about this query + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_prompt"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_prompt</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>prompt</span>, + <span class=sig-arg>echo</span>=<span class=sig-default>True</span>)</span> + </h3> + Add a prompt to this query. The prompt should be a (reasonably + short) string. Multiple prompts can be added to the same query. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>prompt</b></code> - + the user prompt + <br /><i> + (type=str)</i> + <dd><code><b>echo</b></code> - + <code>True</code> (default) if the user's response should be + echoed; <code>False</code> if not (for a password or similar) + <br /><i> + (type=bool)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.sftp-module.html b/docs/private/paramiko.sftp-module.html new file mode 100644 index 0000000..2d280dd --- /dev/null +++ b/docs/private/paramiko.sftp-module.html @@ -0,0 +1,1082 @@ +<?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>paramiko.sftp</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.sftp-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp</h2> + + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_ATTRS"><code>CMD_ATTRS</code></a></b> = <span title="105">105 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_CLOSE"><code>CMD_CLOSE</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_DATA"><code>CMD_DATA</code></a></b> = <span title="103">103 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_EXTENDED"><code>CMD_EXTENDED</code></a></b> = <span title="200">200 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_EXTENDED_REPLY"><code>CMD_EXTENDED_REPLY</code></a></b> = <span title="201">201 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_FSETSTAT"><code>CMD_FSETSTAT</code></a></b> = <span title="10">10 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_FSTAT"><code>CMD_FSTAT</code></a></b> = <span title="8">8 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_HANDLE"><code>CMD_HANDLE</code></a></b> = <span title="102">102 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_INIT"><code>CMD_INIT</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_LSTAT"><code>CMD_LSTAT</code></a></b> = <span title="7">7 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_MKDIR"><code>CMD_MKDIR</code></a></b> = <span title="14">14 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_NAME"><code>CMD_NAME</code></a></b> = <span title="104">104 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_NAMES"><code>CMD_NAMES</code></a></b> = <span title="{1: 'init', 2: 'version', 3: 'open', 4: 'close', 5: 'read', 6: 'write', 7: 'lstat', 8: 'fstat', 9: 'setstat', 10: 'fsetstat', 11: 'opendir', 12: 'readdir', 13: 'remove', 14: 'mkdir', 15: 'rmdir', 16: 'realpath', 17: 'stat', 18: 'rename', 19: 'readlink', 20: 'symlink', 200: 'extended', 201: 'extended_reply', 101: 'status', 102: 'handle', 103: 'data', 104: 'name', 105: 'attrs'}"><code>{1: 'init', 2: 'version', 3: 'open', 4: 'clo<span class="variable-ellipsis">...</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="paramiko.sftp-module.html#CMD_OPEN"><code>CMD_OPEN</code></a></b> = <span title="3">3 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_OPENDIR"><code>CMD_OPENDIR</code></a></b> = <span title="11">11 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_READ"><code>CMD_READ</code></a></b> = <span title="5">5 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_READDIR"><code>CMD_READDIR</code></a></b> = <span title="12">12 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_READLINK"><code>CMD_READLINK</code></a></b> = <span title="19">19 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_REALPATH"><code>CMD_REALPATH</code></a></b> = <span title="16">16 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_REMOVE"><code>CMD_REMOVE</code></a></b> = <span title="13">13 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_RENAME"><code>CMD_RENAME</code></a></b> = <span title="18">18 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_RMDIR"><code>CMD_RMDIR</code></a></b> = <span title="15">15 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_SETSTAT"><code>CMD_SETSTAT</code></a></b> = <span title="9">9 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_STAT"><code>CMD_STAT</code></a></b> = <span title="17">17 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_STATUS"><code>CMD_STATUS</code></a></b> = <span title="101">101 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_SYMLINK"><code>CMD_SYMLINK</code></a></b> = <span title="20">20 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_VERSION"><code>CMD_VERSION</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_WRITE"><code>CMD_WRITE</code></a></b> = <span title="6">6 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_BAD_MESSAGE"><code>SFTP_BAD_MESSAGE</code></a></b> = <span title="5">5 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_CONNECTION_LOST"><code>SFTP_CONNECTION_LOST</code></a></b> = <span title="7">7 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_DESC"><code>SFTP_DESC</code></a></b> = <span title="['Success', 'End of file', 'No such file', 'Permission denied', 'Failure', 'Bad message', 'No connection', 'Connection lost', 'Operation unsupported']"><code>['Success', 'End of file', 'No such file', '<span class="variable-ellipsis">...</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="paramiko.sftp-module.html#SFTP_EOF"><code>SFTP_EOF</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FAILURE"><code>SFTP_FAILURE</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_APPEND"><code>SFTP_FLAG_APPEND</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_CREATE"><code>SFTP_FLAG_CREATE</code></a></b> = <span title="8">8 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_EXCL"><code>SFTP_FLAG_EXCL</code></a></b> = <span title="32">32 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_READ"><code>SFTP_FLAG_READ</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_TRUNC"><code>SFTP_FLAG_TRUNC</code></a></b> = <span title="16">16 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_WRITE"><code>SFTP_FLAG_WRITE</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_NO_CONNECTION"><code>SFTP_NO_CONNECTION</code></a></b> = <span title="6">6 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_NO_SUCH_FILE"><code>SFTP_NO_SUCH_FILE</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_OK"><code>SFTP_OK</code></a></b> = <span title="0">0 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_OP_UNSUPPORTED"><code>SFTP_OP_UNSUPPORTED</code></a></b> = <span title="8">8 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_PERMISSION_DENIED"><code>SFTP_PERMISSION_DENIED</code></a></b> = <span title="3">3 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.sftp-module.html#_VERSION"><code>_VERSION</code></a></b> = <span title="3">3 </span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_ATTRS"></a> +<h3>CMD_ATTRS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="105"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +105 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_CLOSE"></a> +<h3>CMD_CLOSE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_DATA"></a> +<h3>CMD_DATA</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="103"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +103 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_EXTENDED"></a> +<h3>CMD_EXTENDED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="200"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +200 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_EXTENDED_REPLY"></a> +<h3>CMD_EXTENDED_REPLY</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="201"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +201 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_FSETSTAT"></a> +<h3>CMD_FSETSTAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="10"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +10 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_FSTAT"></a> +<h3>CMD_FSTAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_HANDLE"></a> +<h3>CMD_HANDLE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="102"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +102 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_INIT"></a> +<h3>CMD_INIT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_LSTAT"></a> +<h3>CMD_LSTAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="7"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +7 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_MKDIR"></a> +<h3>CMD_MKDIR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="14"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +14 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_NAME"></a> +<h3>CMD_NAME</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="104"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +104 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_NAMES"></a> +<h3>CMD_NAMES</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{1: 'init', 2: 'version', 3: 'open', 4: 'close', 5: 'read', 6: 'write', 7: 'lstat', 8: 'fstat', 9: 'setstat', 10: 'fsetstat', 11: 'opendir', 12: 'readdir', 13: 'remove', 14: 'mkdir', 15: 'rmdir', 16: 'realpath', 17: 'stat', 18: 'rename', 19: 'readlink', 20: 'symlink', 200: 'extended', 201: 'extended_reply', 101: 'status', 102: 'handle', 103: 'data', 104: 'name', 105: 'attrs'}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{1: 'init', + 2: 'version', + 3: 'open', + 4: 'close', + 5: 'read', + 6: 'write', + 7: 'lstat', + 8: 'fstat', +<span class="variable-ellipsis">...</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_OPEN"></a> +<h3>CMD_OPEN</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="3"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +3 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_OPENDIR"></a> +<h3>CMD_OPENDIR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="11"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +11 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_READ"></a> +<h3>CMD_READ</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="5"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +5 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_READDIR"></a> +<h3>CMD_READDIR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="12"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +12 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_READLINK"></a> +<h3>CMD_READLINK</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="19"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +19 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_REALPATH"></a> +<h3>CMD_REALPATH</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="16"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +16 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_REMOVE"></a> +<h3>CMD_REMOVE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="13"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +13 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_RENAME"></a> +<h3>CMD_RENAME</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="18"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +18 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_RMDIR"></a> +<h3>CMD_RMDIR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="15"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +15 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_SETSTAT"></a> +<h3>CMD_SETSTAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="9"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +9 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_STAT"></a> +<h3>CMD_STAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="17"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +17 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_STATUS"></a> +<h3>CMD_STATUS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="101"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +101 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_SYMLINK"></a> +<h3>CMD_SYMLINK</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="20"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +20 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_VERSION"></a> +<h3>CMD_VERSION</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_WRITE"></a> +<h3>CMD_WRITE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="6"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +6 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_BAD_MESSAGE"></a> +<h3>SFTP_BAD_MESSAGE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="5"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +5 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_CONNECTION_LOST"></a> +<h3>SFTP_CONNECTION_LOST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="7"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +7 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_DESC"></a> +<h3>SFTP_DESC</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>list</code> + + </dd> +<span title="['Success', 'End of file', 'No such file', 'Permission denied', 'Failure', 'Bad message', 'No connection', 'Connection lost', 'Operation unsupported']"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +['Success', + 'End of file', + 'No such file', + 'Permission denied', + 'Failure', + 'Bad message', + 'No connection', + 'Connection lost', +<span class="variable-ellipsis">...</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_EOF"></a> +<h3>SFTP_EOF</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FAILURE"></a> +<h3>SFTP_FAILURE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_APPEND"></a> +<h3>SFTP_FLAG_APPEND</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_CREATE"></a> +<h3>SFTP_FLAG_CREATE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_EXCL"></a> +<h3>SFTP_FLAG_EXCL</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="32"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +32 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_READ"></a> +<h3>SFTP_FLAG_READ</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_TRUNC"></a> +<h3>SFTP_FLAG_TRUNC</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="16"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +16 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_WRITE"></a> +<h3>SFTP_FLAG_WRITE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_NO_CONNECTION"></a> +<h3>SFTP_NO_CONNECTION</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="6"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +6 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_NO_SUCH_FILE"></a> +<h3>SFTP_NO_SUCH_FILE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_OK"></a> +<h3>SFTP_OK</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> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_OP_UNSUPPORTED"></a> +<h3>SFTP_OP_UNSUPPORTED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_PERMISSION_DENIED"></a> +<h3>SFTP_PERMISSION_DENIED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="3"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +3 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_VERSION"></a> +<h3>_VERSION</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="3"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +3 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.sftp_attr-module.html b/docs/private/paramiko.sftp_attr-module.html new file mode 100644 index 0000000..f5e9f9c --- /dev/null +++ b/docs/private/paramiko.sftp_attr-module.html @@ -0,0 +1,59 @@ +<?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>paramiko.sftp_attr</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_attr + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.sftp_attr-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_attr-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_attr</h2> + + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.sftp_client-module.html b/docs/private/paramiko.sftp_client-module.html new file mode 100644 index 0000000..9eff026 --- /dev/null +++ b/docs/private/paramiko.sftp_client-module.html @@ -0,0 +1,89 @@ +<?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>paramiko.sftp_client</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_client + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.sftp_client-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_client-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_client</h2> + +Client-mode SFTP support. +<hr/> + +<!-- =========== START OF FUNCTION SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Function Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/paramiko.sftp_client-module.html#_to_unicode" class="summary-sig-name"><code>_to_unicode</code></a>(<span class=summary-sig-arg>s</span>)</span></code> +<br /> +if a str is not ascii, decode its utf8 into unicode</td></tr> +</table><br /> + + +<!-- =========== START OF FUNCTION DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Function Details</th></tr> +</table> + +<a name="_to_unicode"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">_to_unicode</span>(<span class=sig-arg>s</span>)</span> + </h3> + if a str is not ascii, decode its utf8 into unicode + <dl><dt></dt><dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.sftp_file-module.html b/docs/private/paramiko.sftp_file-module.html new file mode 100644 index 0000000..f954ea3 --- /dev/null +++ b/docs/private/paramiko.sftp_file-module.html @@ -0,0 +1,62 @@ +<?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>paramiko.sftp_file</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_file + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.sftp_file-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_file-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_file</h2> + +<a href="paramiko.SFTPFile-class.html" +class="link"><code>SFTPFile</code></a> +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.sftp_handle-module.html b/docs/private/paramiko.sftp_handle-module.html new file mode 100644 index 0000000..aba785c --- /dev/null +++ b/docs/private/paramiko.sftp_handle-module.html @@ -0,0 +1,61 @@ +<?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>paramiko.sftp_handle</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_handle + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.sftp_handle-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_handle-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_handle</h2> + +Abstraction of an SFTP file handle (for server mode). +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.sftp_server-module.html b/docs/private/paramiko.sftp_server-module.html new file mode 100644 index 0000000..a4c43f5 --- /dev/null +++ b/docs/private/paramiko.sftp_server-module.html @@ -0,0 +1,102 @@ +<?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>paramiko.sftp_server</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_server + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.sftp_server-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_server-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_server</h2> + +Server-mode SFTP support. +<hr/> + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.sftp_server-module.html#_hash_class"><code>_hash_class</code></a></b> = <span title="{'sha1': <module 'Crypto.Hash.SHA' from '/usr/lib/python2.4/site-packages/Crypto/Hash/SHA.pyc'>, 'md5': <module 'Crypto.Hash.MD5' from '/usr/lib/python2.4/site-packages/Crypto/Hash/MD5.pyc'>}"><code>{'sha1': <module 'Crypto.Hash.SHA' from '/<span class="variable-ellipsis">...</span></code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_hash_class"></a> +<h3>_hash_class</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{'sha1': <module 'Crypto.Hash.SHA' from '/usr/lib/python2.4/site-packages/Crypto/Hash/SHA.pyc'>, 'md5': <module 'Crypto.Hash.MD5' from '/usr/lib/python2.4/site-packages/Crypto/Hash/MD5.pyc'>}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{'md5': <module 'Crypto.Hash.MD5' from '/usr/lib/python2.4/site-packag<span class="variable-linewrap">\</span> +es/Crypto/Hash/MD5.pyc'>, + 'sha1': <module 'Crypto.Hash.SHA' from '/usr/lib/python2.4/site-packa<span class="variable-linewrap">\</span> +ges/Crypto/Hash/SHA.pyc'>} </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.sftp_si-module.html b/docs/private/paramiko.sftp_si-module.html new file mode 100644 index 0000000..c4e623f --- /dev/null +++ b/docs/private/paramiko.sftp_si-module.html @@ -0,0 +1,63 @@ +<?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>paramiko.sftp_si</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_si + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.sftp_si-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_si-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_si</h2> + +<a href="../private/paramiko.SFTPServerInterface-class.html" +class="link"><code>SFTPServerInterface</code></a> is an interface to +override for SFTP server support. +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.ssh_exception-module.html b/docs/private/paramiko.ssh_exception-module.html new file mode 100644 index 0000000..dd9908c --- /dev/null +++ b/docs/private/paramiko.ssh_exception-module.html @@ -0,0 +1,72 @@ +<?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>paramiko.ssh_exception</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module ssh_exception + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.ssh_exception-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.ssh_exception</h2> + +Exceptions defined by paramiko. +<hr/> + +<!-- =========== START OF EXCEPTIONS =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Exceptions</th></tr> +<tr><td width="15%"> + <b><a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html"><code>PartialAuthentication</code></a></b></td> + <td>An internal exception thrown in the case of partial +authentication.</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/private/paramiko.ssh_exception.PartialAuthentication-class.html b/docs/private/paramiko.ssh_exception.PartialAuthentication-class.html new file mode 100644 index 0000000..0aa4a93 --- /dev/null +++ b/docs/private/paramiko.ssh_exception.PartialAuthentication-class.html @@ -0,0 +1,131 @@ +<?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>paramiko.ssh_exception.PartialAuthentication</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="../private/paramiko.ssh_exception-module.html">Module ssh_exception</a> :: + Class PartialAuthentication + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class PartialAuthentication</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <a href="paramiko.SSHException-class.html"><code>SSHException</code></a> --+ + | + <b>PartialAuthentication</b> +</pre><br /> + +<hr/> + +An internal exception thrown in the case of partial +authentication. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>types</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-vararg">...</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>list</code></font></td> +<td><b><a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html#allowed_types"><code>allowed_types</code></a></b> = <span title="[]"><code>[] </code> +</span></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="allowed_types"></a> +<h3>allowed_types</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>list</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.transport-module.html b/docs/private/paramiko.transport-module.html new file mode 100644 index 0000000..1d52647 --- /dev/null +++ b/docs/private/paramiko.transport-module.html @@ -0,0 +1,111 @@ +<?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>paramiko.transport</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module transport + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.transport-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.transport-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.transport</h2> + +<a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> handles the core SSH2 +protocol. +<hr/> + +<!-- =========== START OF FUNCTION SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Function Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_join_lingering_threads"></a><span class="summary-sig"><span class="summary-sig-name">_join_lingering_threads</span>()</span></code> +</td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td> +<td><b><a href="../private/paramiko.transport-module.html#_active_threads"><code>_active_threads</code></a></b> = <span title="[]"><code>[] </code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_active_threads"></a> +<h3>_active_threads</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>list</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/paramiko.util-module.html b/docs/private/paramiko.util-module.html new file mode 100644 index 0000000..660bdf3 --- /dev/null +++ b/docs/private/paramiko.util-module.html @@ -0,0 +1,475 @@ +<?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>paramiko.util</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module util + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.util-module.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.util-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.util</h2> + +Useful functions used by the rest of paramiko. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="paramiko.util.PFilter-class.html"><code>PFilter</code></a></b></td> + <td> </td></tr> +</table><br /> + + +<!-- =========== START OF FUNCTION SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Function Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="bit_length"></a><span class="summary-sig"><span class="summary-sig-name">bit_length</span>(<span class=summary-sig-arg>n</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="paramiko.util-module.html#deflate_long" class="summary-sig-name"><code>deflate_long</code></a>(<span class=summary-sig-arg>n</span>, + <span class=summary-sig-arg>add_sign_padding</span>)</span></code> +<br /> +turns a long-int into a normalized byte string (adapted from +Crypto.Util.number)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="format_binary"></a><span class="summary-sig"><span class="summary-sig-name">format_binary</span>(<span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>prefix</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="format_binary_line"></a><span class="summary-sig"><span class="summary-sig-name">format_binary_line</span>(<span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="format_binary_weird"></a><span class="summary-sig"><span class="summary-sig-name">format_binary_weird</span>(<span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#generate_key_bytes" class="summary-sig-name"><code>generate_key_bytes</code></a>(<span class=summary-sig-arg>hashclass</span>, + <span class=summary-sig-arg>salt</span>, + <span class=summary-sig-arg>key</span>, + <span class=summary-sig-arg>nbytes</span>)</span></code> +<br /> +Given a password, passphrase, or other human-source key, scramble it +through a secure hash into some keyworthy bytes.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="get_logger"></a><span class="summary-sig"><span class="summary-sig-name">get_logger</span>(<span class=summary-sig-arg>name</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="get_thread_id"></a><span class="summary-sig"><span class="summary-sig-name">get_thread_id</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="paramiko.util-module.html#hexify" class="summary-sig-name"><code>hexify</code></a>(<span class=summary-sig-arg>s</span>)</span></code> +<br /> +turn a string into a hex sequence</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#inflate_long" class="summary-sig-name"><code>inflate_long</code></a>(<span class=summary-sig-arg>s</span>, + <span class=summary-sig-arg>always_positive</span>)</span></code> +<br /> +turns a normalized byte string into a long-int (adapted from +Crypto.Util.number)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> dict(hostname, dict(keytype, <a + href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)) +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#load_host_keys" class="summary-sig-name"><code>load_host_keys</code></a>(<span class=summary-sig-arg>filename</span>)</span></code> +<br /> +Read a file of known SSH host keys, in the format used by openssh, and +return a compound dict of <code>hostname -> keytype -></code> <a +href="../private/paramiko.PKey-class.html" +class="link"><code>PKey</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#log_to_file" class="summary-sig-name"><code>log_to_file</code></a>(<span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>level</span>)</span></code> +<br /> +send paramiko logs to a logfile, if they're not already going +somewhere</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#lookup_ssh_host_config" class="summary-sig-name"><code>lookup_ssh_host_config</code></a>(<span class=summary-sig-arg>hostname</span>, + <span class=summary-sig-arg>config</span>)</span></code> +<br /> +Return a dict of config options for a given hostname.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="mod_inverse"></a><span class="summary-sig"><span class="summary-sig-name">mod_inverse</span>(<span class=summary-sig-arg>x</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> object +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#parse_ssh_config" class="summary-sig-name"><code>parse_ssh_config</code></a>(<span class=summary-sig-arg>file_obj</span>)</span></code> +<br /> +Parse a config file of the format used by OpenSSH, and return an +object that can be used to make queries to <a +href="paramiko.util-module.html#lookup_ssh_host_config" +class="link"><code>lookup_ssh_host_config</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="safe_string"></a><span class="summary-sig"><span class="summary-sig-name">safe_string</span>(<span class=summary-sig-arg>s</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="tb_strings"></a><span class="summary-sig"><span class="summary-sig-name">tb_strings</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="paramiko.util-module.html#unhexify" class="summary-sig-name"><code>unhexify</code></a>(<span class=summary-sig-arg>s</span>)</span></code> +<br /> +turn a hex sequence back into a string</td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="../private/paramiko.util-module.html#_g_thread_counter"><code>_g_thread_counter</code></a></b> = <span title="0">0 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="../private/paramiko.util-module.html#_g_thread_ids"><code>_g_thread_ids</code></a></b> = <span title="{}"><code>{} </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>lock</code></font></td> +<td><b><a href="../private/paramiko.util-module.html#_g_thread_lock"><code>_g_thread_lock</code></a></b> = <span title="<thread.lock object at 0xb7df2180>"><code><thread.lock object at 0xb7df2180> </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>PFilter</code></font></td> +<td><b><a href="../private/paramiko.util-module.html#_pfilter"><code>_pfilter</code></a></b> = <span title="<paramiko.util.PFilter object at 0xb7b39dac>"><code><paramiko.util.PFilter object at 0xb7b39dac> </code> +</span></td></tr> +</table><br /> + + +<!-- =========== START OF FUNCTION DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Function Details</th></tr> +</table> + +<a name="deflate_long"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">deflate_long</span>(<span class=sig-arg>n</span>, + <span class=sig-arg>add_sign_padding</span>=<span class=sig-default>True</span>)</span> + </h3> + turns a long-int into a normalized byte string (adapted from + Crypto.Util.number) + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="generate_key_bytes"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">generate_key_bytes</span>(<span class=sig-arg>hashclass</span>, + <span class=sig-arg>salt</span>, + <span class=sig-arg>key</span>, + <span class=sig-arg>nbytes</span>)</span> + </h3> + Given a password, passphrase, or other human-source key, scramble it + through a secure hash into some keyworthy bytes. This specific + algorithm is used for encrypting/decrypting private key files. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hashclass</b></code> - + class from <code>Crypto.Hash</code> that can be used as a + secure hashing function (like <code>MD5</code> or + <code>SHA</code>). + <br /><i> + (type=<code>Crypto.Hash</code>)</i> + <dd><code><b>salt</b></code> - + data to salt the hash with. + <br /><i> + (type=string)</i> + <dd><code><b>key</b></code> - + human-entered password or passphrase. + <br /><i> + (type=string)</i> + <dd><code><b>nbytes</b></code> - + number of bytes to generate. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + key data + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="hexify"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">hexify</span>(<span class=sig-arg>s</span>)</span> + </h3> + turn a string into a hex sequence + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="inflate_long"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">inflate_long</span>(<span class=sig-arg>s</span>, + <span class=sig-arg>always_positive</span>=<span class=sig-default>False</span>)</span> + </h3> + turns a normalized byte string into a long-int (adapted from + Crypto.Util.number) + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="load_host_keys"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">load_host_keys</span>(<span class=sig-arg>filename</span>)</span> + </h3> + <p>Read a file of known SSH host keys, in the format used by openssh, + and return a compound dict of <code>hostname -> keytype -></code> + <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>. The hostname may be an IP address + or DNS name. The keytype will be either + <code>"ssh-rsa"</code> or + <code>"ssh-dss"</code>.</p> + This type of file unfortunately doesn't exist on Windows, but on + posix, it will usually be stored in + <code>os.path.expanduser("~/.ssh/known_hosts")</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to read host keys from + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + dict of host keys, indexed by hostname and then keytype + <br /><i> + (type=dict(hostname, dict(keytype, <a + href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)))</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="log_to_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">log_to_file</span>(<span class=sig-arg>filename</span>, + <span class=sig-arg>level</span>=<span class=sig-default>10</span>)</span> + </h3> + send paramiko logs to a logfile, if they're not already going + somewhere + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="lookup_ssh_host_config"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">lookup_ssh_host_config</span>(<span class=sig-arg>hostname</span>, + <span class=sig-arg>config</span>)</span> + </h3> + <p>Return a dict of config options for a given hostname. The + <code>config</code> object must come from <a + href="paramiko.util-module.html#parse_ssh_config" + class="link"><code>parse_ssh_config</code></a>.</p> + <p>The host-matching rules of OpenSSH's <code>ssh_config</code> man + page are used, which means that all configuration options from matching + host specifications are merged, with more specific hostmasks taking + precedence. In other words, if <code>"Port"</code> is set + under <code>"Host *"</code> and also <code>"Host + *.example.com"</code>, and the lookup is for + <code>"ssh.example.com"</code>, then the port entry for + <code>"Host *.example.com"</code> will win out.</p> + The keys in the returned dict are all normalized to lowercase (look + for <code>"port"</code>, not <code>"Port"</code>. + No other processing is done to the keys or values. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hostname</b></code> - + the hostname to lookup + <br /><i> + (type=str)</i> + <dd><code><b>config</b></code> - + the config object to search + <br /><i> + (type=object)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="parse_ssh_config"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">parse_ssh_config</span>(<span class=sig-arg>file_obj</span>)</span> + </h3> + <p>Parse a config file of the format used by OpenSSH, and return an + object that can be used to make queries to <a + href="paramiko.util-module.html#lookup_ssh_host_config" + class="link"><code>lookup_ssh_host_config</code></a>. The format is + described in OpenSSH's <code>ssh_config</code> man page. This method is + provided primarily as a convenience to posix users (since the OpenSSH + format is a de-facto standard on posix) but should work fine on Windows + too.</p> + The return value is currently a list of dictionaries, each + containing host-specific configuration, but this is considered an + implementation detail and may be subject to change in later + versions. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>file_obj</b></code> - + a file-like object to read the config file from + <br /><i> + (type=file)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + opaque configuration object + <br /><i> + (type=object)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="unhexify"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">unhexify</span>(<span class=sig-arg>s</span>)</span> + </h3> + turn a hex sequence back into a string + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_g_thread_counter"></a> +<h3>_g_thread_counter</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> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_g_thread_ids"></a> +<h3>_g_thread_ids</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> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_g_thread_lock"></a> +<h3>_g_thread_lock</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>lock</code> + + </dd> +<span title="<thread.lock object at 0xb7df2180>"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<thread.lock object at 0xb7df2180> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="_pfilter"></a> +<h3>_pfilter</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>PFilter</code> + + </dd> +<span title="<paramiko.util.PFilter object at 0xb7b39dac>"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<paramiko.util.PFilter object at 0xb7b39dac> </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/paramiko.util.PFilter-class.html b/docs/private/paramiko.util.PFilter-class.html new file mode 100644 index 0000000..dee3883 --- /dev/null +++ b/docs/private/paramiko.util.PFilter-class.html @@ -0,0 +1,124 @@ +<?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>paramiko.util.PFilter</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="paramiko.util-module.html">Module util</a> :: + Class PFilter + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/paramiko.util.PFilter-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.util.PFilter-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type PFilter</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>PFilter</b> +</pre><br /> + +<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><a name="filter"></a><span class="summary-sig"><span class="summary-sig-name">filter</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>record</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__init__(...) initializes x; see x.__class__.__doc__ for +signature</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/threading.Thread-class.html b/docs/private/threading.Thread-class.html new file mode 100644 index 0000000..292b074 --- /dev/null +++ b/docs/private/threading.Thread-class.html @@ -0,0 +1,237 @@ +<?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>threading.Thread</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Module threading :: + Class Thread + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/threading.Thread-class.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="threading.Thread-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Thread</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a> --+ + | + <b>Thread</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SubsystemHandler-class.html"><code>SubsystemHandler</code></a>, + <a href="paramiko.Transport-class.html"><code>Transport</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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>group</span>, + <span class=summary-sig-arg>target</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>args</span>, + <span class=summary-sig-arg>kwargs</span>, + <span class=summary-sig-arg>verbose</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1">(type, value, traceback)</font></td> + <td><code><span class="summary-sig"><code>__exc_info</code>()</span></code> +<br /> +Return information about the most recent exception caught by an except +clause in the current stack frame or in an older stack frame.</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><a name="getName"></a><span class="summary-sig"><span class="summary-sig-name">getName</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><a name="isAlive"></a><span class="summary-sig"><span class="summary-sig-name">isAlive</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><a name="isDaemon"></a><span class="summary-sig"><span class="summary-sig-name">isDaemon</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><a name="join"></a><span class="summary-sig"><span class="summary-sig-name">join</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="run"></a><span class="summary-sig"><span class="summary-sig-name">run</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><a name="setDaemon"></a><span class="summary-sig"><span class="summary-sig-name">setDaemon</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>daemonic</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="setName"></a><span class="summary-sig"><span class="summary-sig-name">setName</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="start"></a><span class="summary-sig"><span class="summary-sig-name">start</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><a name="__bootstrap"></a><span class="summary-sig"><span class="summary-sig-name">__bootstrap</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="../private/threading.Thread-class.html#__delete" class="summary-sig-name"><code>__delete</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Remove current thread from the dict of currently running threads.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__stop"></a><span class="summary-sig"><span class="summary-sig-name">__stop</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><a name="_set_daemon"></a><span class="summary-sig"><span class="summary-sig-name">_set_daemon</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from _Verbose</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="../private/threading._Verbose-class.html#_note" class="summary-sig-name"><code>_note</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>format</span>, + <span class="summary-sig-vararg">*args</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>bool</code></font></td> +<td><b><a href="../private/threading.Thread-class.html#__initialized"><code>_Thread__initialized</code></a></b> = <span title="False"><code>False </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="__delete"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__delete</span>(<span class=sig-arg>self</span>)</span> + </h3> + Remove current thread from the dict of currently running + threads. + <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="_Thread__initialized"></a> +<h3>_Thread__initialized</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>bool</code> + + </dd> +<span title="False"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +False </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/private/threading._Verbose-class.html b/docs/private/threading._Verbose-class.html new file mode 100644 index 0000000..dec73e3 --- /dev/null +++ b/docs/private/threading._Verbose-class.html @@ -0,0 +1,127 @@ +<?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>threading._Verbose</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Module threading :: + Class _Verbose + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/threading._Verbose-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type _Verbose</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>_Verbose</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="threading.Thread-class.html"><code>Thread</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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>verbose</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="_note"></a><span class="summary-sig"><span class="summary-sig-name">_note</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>format</span>, + <span class="summary-sig-vararg">*args</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/private/toc-everything.html b/docs/private/toc-everything.html new file mode 100644 index 0000000..a232317 --- /dev/null +++ b/docs/private/toc-everything.html @@ -0,0 +1,224 @@ +<?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>Everything</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b>Everything</b></font></center> +<hr> + +<!-- =========== START OF ALL CLASSES =========== --> +<font size="+1"><b>All Classes</b></font><br /> +<a target="mainFrame" href="paramiko.Agent-class.html">paramiko.Agent</a><br /> +<a target="mainFrame" href="paramiko.AgentKey-class.html">paramiko.AgentKey</a><br /> +<a target="mainFrame" href="../private/paramiko.AuthHandler-class.html">paramiko.AuthHandler</a><br /> +<a target="mainFrame" href="../private/paramiko.BaseSFTP-class.html">paramiko.BaseSFTP</a><br /> +<a target="mainFrame" href="../private/paramiko.ber.BER-class.html">paramiko.ber.BER</a><br /> +<a target="mainFrame" href="paramiko.BufferedFile-class.html">paramiko.BufferedFile</a><br /> +<a target="mainFrame" href="paramiko.Channel-class.html">paramiko.Channel</a><br /> +<a target="mainFrame" href="../private/paramiko.channel.ChannelStderrFile-class.html">paramiko.channel.ChannelStderrFile</a><br /> +<a target="mainFrame" href="../private/paramiko.ChannelFile-class.html">paramiko.ChannelFile</a><br /> +<a target="mainFrame" href="../private/paramiko.compress.ZlibCompressor-class.html">paramiko.compress.ZlibCompressor</a><br /> +<a target="mainFrame" href="../private/paramiko.compress.ZlibDecompressor-class.html">paramiko.compress.ZlibDecompressor</a><br /> +<a target="mainFrame" href="paramiko.DSSKey-class.html">paramiko.DSSKey</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex.KexGex-class.html">paramiko.kex_gex.KexGex</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1.KexGroup1-class.html">paramiko.kex_group1.KexGroup1</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22.Formatter-class.html">paramiko.logging22.Formatter</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22.logger-class.html">paramiko.logging22.logger</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22.StreamHandler-class.html">paramiko.logging22.StreamHandler</a><br /> +<a target="mainFrame" href="paramiko.Message-class.html">paramiko.Message</a><br /> +<a target="mainFrame" href="../private/paramiko.Packetizer-class.html">paramiko.Packetizer</a><br /> +<a target="mainFrame" href="../private/paramiko.pipe.PosixPipe-class.html">paramiko.pipe.PosixPipe</a><br /> +<a target="mainFrame" href="../private/paramiko.pipe.WindowsPipe-class.html">paramiko.pipe.WindowsPipe</a><br /> +<a target="mainFrame" href="../private/paramiko.PKey-class.html">paramiko.PKey</a><br /> +<a target="mainFrame" href="../private/paramiko.primes.ModulusPack-class.html">paramiko.primes.ModulusPack</a><br /> +<a target="mainFrame" href="paramiko.RSAKey-class.html">paramiko.RSAKey</a><br /> +<a target="mainFrame" href="paramiko.SecurityOptions-class.html">paramiko.SecurityOptions</a><br /> +<a target="mainFrame" href="paramiko.server.InteractiveQuery-class.html">paramiko.server.InteractiveQuery</a><br /> +<a target="mainFrame" href="../private/paramiko.ServerInterface-class.html">paramiko.ServerInterface</a><br /> +<a target="mainFrame" href="paramiko.SFTP-class.html">paramiko.SFTP</a><br /> +<a target="mainFrame" href="paramiko.SFTPAttributes-class.html">paramiko.SFTPAttributes</a><br /> +<a target="mainFrame" href="paramiko.SFTPClient-class.html">paramiko.SFTPClient</a><br /> +<a target="mainFrame" href="paramiko.SFTPFile-class.html">paramiko.SFTPFile</a><br /> +<a target="mainFrame" href="paramiko.SFTPHandle-class.html">paramiko.SFTPHandle</a><br /> +<a target="mainFrame" href="paramiko.SFTPServer-class.html">paramiko.SFTPServer</a><br /> +<a target="mainFrame" href="../private/paramiko.SFTPServerInterface-class.html">paramiko.SFTPServerInterface</a><br /> +<a target="mainFrame" href="paramiko.SubsystemHandler-class.html">paramiko.SubsystemHandler</a><br /> +<a target="mainFrame" href="paramiko.Transport-class.html">paramiko.Transport</a><br /> +<a target="mainFrame" href="paramiko.util.PFilter-class.html">paramiko.util.PFilter</a><br /> +<br /> + +<!-- =========== START OF ALL EXCEPTIONS =========== --> +<font size="+1"><b>All Exceptions</b></font><br /> +<a target="mainFrame" href="paramiko.BadAuthenticationType-class.html">paramiko.BadAuthenticationType</a><br /> +<a target="mainFrame" href="../private/paramiko.ber.BERException-class.html">paramiko.ber.BERException</a><br /> +<a target="mainFrame" href="../private/paramiko.packet.NeedRekeyException-class.html">paramiko.packet.NeedRekeyException</a><br /> +<a target="mainFrame" href="paramiko.PasswordRequiredException-class.html">paramiko.PasswordRequiredException</a><br /> +<a target="mainFrame" href="paramiko.SFTPError-class.html">paramiko.SFTPError</a><br /> +<a target="mainFrame" href="../private/paramiko.ssh_exception.PartialAuthentication-class.html">paramiko.ssh_exception.PartialAuthentication</a><br /> +<a target="mainFrame" href="paramiko.SSHException-class.html">paramiko.SSHException</a><br /> +<br /> + +<!-- =========== START OF ALL FUNCTIONS =========== --> +<font size="+1"><b>All Functions</b></font><br /> +<a target="mainFrame" href="../private/paramiko.primes-module.html#_generate_prime">_generate_prime</a><br /> +<a target="mainFrame" href="../private/paramiko.transport-module.html#_join_lingering_threads">_join_lingering_threads</a><br /> +<a target="mainFrame" href="../private/paramiko.primes-module.html#_roll_random">_roll_random</a><br /> +<a target="mainFrame" href="../private/paramiko.sftp_client-module.html#_to_unicode">_to_unicode</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#bit_length">bit_length</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#deflate_long">deflate_long</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary">format_binary</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary_line">format_binary_line</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary_weird">format_binary_weird</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#generate_key_bytes">generate_key_bytes</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#get_logger">get_logger</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#get_thread_id">get_thread_id</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#getLogger">getLogger</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#hexify">hexify</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#inflate_long">inflate_long</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#load_host_keys">load_host_keys</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#log_to_file">log_to_file</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#lookup_ssh_host_config">lookup_ssh_host_config</a><br /> +<a target="mainFrame" href="../private/paramiko.pipe-module.html#make_pipe">make_pipe</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#mod_inverse">mod_inverse</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#parse_ssh_config">parse_ssh_config</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#safe_string">safe_string</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#tb_strings">tb_strings</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#unhexify">unhexify</a><br /> +<br /> + +<!-- =========== START OF ALL VARIABLES =========== --> +<font size="+1"><b>All Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__author__">__author__</a><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__date__">__date__</a><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__license__">__license__</a><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__version__">__version__</a><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__version_info__">__version_info__</a><br /> +<a target="mainFrame" href="../private/paramiko.transport-module.html#_active_threads">_active_threads</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_APPEND">_FLAG_APPEND</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_BINARY">_FLAG_BINARY</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_BUFFERED">_FLAG_BUFFERED</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_LINE_BUFFERED">_FLAG_LINE_BUFFERED</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_READ">_FLAG_READ</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_UNIVERSAL_NEWLINE">_FLAG_UNIVERSAL_NEWLINE</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_WRITE">_FLAG_WRITE</a><br /> +<a target="mainFrame" href="../private/paramiko.util-module.html#_g_thread_counter">_g_thread_counter</a><br /> +<a target="mainFrame" href="../private/paramiko.util-module.html#_g_thread_ids">_g_thread_ids</a><br /> +<a target="mainFrame" href="../private/paramiko.util-module.html#_g_thread_lock">_g_thread_lock</a><br /> +<a target="mainFrame" href="../private/paramiko.sftp_server-module.html#_hash_class">_hash_class</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#_logger">_logger</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_GROUP">_MSG_KEXDH_GEX_GROUP</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_INIT">_MSG_KEXDH_GEX_INIT</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_REPLY">_MSG_KEXDH_GEX_REPLY</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_REQUEST">_MSG_KEXDH_GEX_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1-module.html#_MSG_KEXDH_INIT">_MSG_KEXDH_INIT</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1-module.html#_MSG_KEXDH_REPLY">_MSG_KEXDH_REPLY</a><br /> +<a target="mainFrame" href="../private/paramiko.util-module.html#_pfilter">_pfilter</a><br /> +<a target="mainFrame" href="../private/paramiko.sftp-module.html#_VERSION">_VERSION</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#AUTH_FAILED">AUTH_FAILED</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#AUTH_PARTIALLY_SUCCESSFUL">AUTH_PARTIALLY_SUCCESSFUL</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#AUTH_SUCCESSFUL">AUTH_SUCCESSFUL</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_ATTRS">CMD_ATTRS</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_CLOSE">CMD_CLOSE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_DATA">CMD_DATA</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_EXTENDED">CMD_EXTENDED</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_EXTENDED_REPLY">CMD_EXTENDED_REPLY</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_FSETSTAT">CMD_FSETSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_FSTAT">CMD_FSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_HANDLE">CMD_HANDLE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_INIT">CMD_INIT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_LSTAT">CMD_LSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_MKDIR">CMD_MKDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_NAME">CMD_NAME</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_NAMES">CMD_NAMES</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_OPEN">CMD_OPEN</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_OPENDIR">CMD_OPENDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READ">CMD_READ</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READDIR">CMD_READDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READLINK">CMD_READLINK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_REALPATH">CMD_REALPATH</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_REMOVE">CMD_REMOVE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_RENAME">CMD_RENAME</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_RMDIR">CMD_RMDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_SETSTAT">CMD_SETSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_STAT">CMD_STAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_STATUS">CMD_STATUS</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_SYMLINK">CMD_SYMLINK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_VERSION">CMD_VERSION</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_WRITE">CMD_WRITE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#CONNECTION_FAILED_CODE">CONNECTION_FAILED_CODE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#CRITICAL">CRITICAL</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#CRITICAL">CRITICAL</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#DEBUG">DEBUG</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#DEBUG">DEBUG</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#DISCONNECT_AUTH_CANCELLED_BY_USER">DISCONNECT_AUTH_CANCELLED_BY_USER</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE">DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#DISCONNECT_SERVICE_NOT_AVAILABLE">DISCONNECT_SERVICE_NOT_AVAILABLE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#ERROR">ERROR</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#ERROR">ERROR</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1-module.html#G">G</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#INFO">INFO</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#INFO">INFO</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_CLOSE">MSG_CHANNEL_CLOSE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_DATA">MSG_CHANNEL_DATA</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_EOF">MSG_CHANNEL_EOF</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_EXTENDED_DATA">MSG_CHANNEL_EXTENDED_DATA</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_FAILURE">MSG_CHANNEL_FAILURE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN">MSG_CHANNEL_OPEN</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN_FAILURE">MSG_CHANNEL_OPEN_FAILURE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN_SUCCESS">MSG_CHANNEL_OPEN_SUCCESS</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_REQUEST">MSG_CHANNEL_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_SUCCESS">MSG_CHANNEL_SUCCESS</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_WINDOW_ADJUST">MSG_CHANNEL_WINDOW_ADJUST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_DEBUG">MSG_DEBUG</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_DISCONNECT">MSG_DISCONNECT</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_GLOBAL_REQUEST">MSG_GLOBAL_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_IGNORE">MSG_IGNORE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_KEXINIT">MSG_KEXINIT</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_NAMES">MSG_NAMES</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_NEWKEYS">MSG_NEWKEYS</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_REQUEST_FAILURE">MSG_REQUEST_FAILURE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_REQUEST_SUCCESS">MSG_REQUEST_SUCCESS</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_SERVICE_ACCEPT">MSG_SERVICE_ACCEPT</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_SERVICE_REQUEST">MSG_SERVICE_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_UNIMPLEMENTED">MSG_UNIMPLEMENTED</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_BANNER">MSG_USERAUTH_BANNER</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_FAILURE">MSG_USERAUTH_FAILURE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_INFO_REQUEST">MSG_USERAUTH_INFO_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_INFO_RESPONSE">MSG_USERAUTH_INFO_RESPONSE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_PK_OK">MSG_USERAUTH_PK_OK</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_REQUEST">MSG_USERAUTH_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_SUCCESS">MSG_USERAUTH_SUCCESS</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1-module.html#P">P</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_BAD_MESSAGE">SFTP_BAD_MESSAGE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_CONNECTION_LOST">SFTP_CONNECTION_LOST</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_DESC">SFTP_DESC</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_EOF">SFTP_EOF</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FAILURE">SFTP_FAILURE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_APPEND">SFTP_FLAG_APPEND</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_CREATE">SFTP_FLAG_CREATE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_EXCL">SFTP_FLAG_EXCL</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_READ">SFTP_FLAG_READ</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_TRUNC">SFTP_FLAG_TRUNC</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_WRITE">SFTP_FLAG_WRITE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_NO_CONNECTION">SFTP_NO_CONNECTION</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_NO_SUCH_FILE">SFTP_NO_SUCH_FILE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_OK">SFTP_OK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_OP_UNSUPPORTED">SFTP_OP_UNSUPPORTED</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_PERMISSION_DENIED">SFTP_PERMISSION_DENIED</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENT_IDENTITIES_ANSWER">SSH2_AGENT_IDENTITIES_ANSWER</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENT_SIGN_RESPONSE">SSH2_AGENT_SIGN_RESPONSE</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENTC_REQUEST_IDENTITIES">SSH2_AGENTC_REQUEST_IDENTITIES</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENTC_SIGN_REQUEST">SSH2_AGENTC_SIGN_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#WARNING">WARNING</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#WARNING">WARNING</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-everything.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko-module.html b/docs/private/toc-paramiko-module.html new file mode 100644 index 0000000..e6f4d8b --- /dev/null +++ b/docs/private/toc-paramiko-module.html @@ -0,0 +1,94 @@ +<?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>paramiko</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko-module.html">paramiko</a></b></font></center> +<hr> + +<!-- =========== START OF MODULES =========== --> +<font size="+1"><b>Modules</b></font><br /> +<a target="mainFrame" href="paramiko.agent-module.html">agent</a><br /> +<a target="mainFrame" href="../private/paramiko.auth_handler-module.html">auth_handler</a><br /> +<a target="mainFrame" href="../private/paramiko.ber-module.html">ber</a><br /> +<a target="mainFrame" href="../private/paramiko.channel-module.html">channel</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html">common</a><br /> +<a target="mainFrame" href="../private/paramiko.compress-module.html">compress</a><br /> +<a target="mainFrame" href="paramiko.dsskey-module.html">dsskey</a><br /> +<a target="mainFrame" href="paramiko.file-module.html">file</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex-module.html">kex_gex</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1-module.html">kex_group1</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html">logging22</a><br /> +<a target="mainFrame" href="paramiko.message-module.html">message</a><br /> +<a target="mainFrame" href="../private/paramiko.packet-module.html">packet</a><br /> +<a target="mainFrame" href="../private/paramiko.pipe-module.html">pipe</a><br /> +<a target="mainFrame" href="paramiko.pkey-module.html">pkey</a><br /> +<a target="mainFrame" href="../private/paramiko.primes-module.html">primes</a><br /> +<a target="mainFrame" href="paramiko.rsakey-module.html">rsakey</a><br /> +<a target="mainFrame" href="paramiko.server-module.html">server</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html">sftp</a><br /> +<a target="mainFrame" href="paramiko.sftp_attr-module.html">sftp_attr</a><br /> +<a target="mainFrame" href="paramiko.sftp_client-module.html">sftp_client</a><br /> +<a target="mainFrame" href="paramiko.sftp_file-module.html">sftp_file</a><br /> +<a target="mainFrame" href="paramiko.sftp_handle-module.html">sftp_handle</a><br /> +<a target="mainFrame" href="paramiko.sftp_server-module.html">sftp_server</a><br /> +<a target="mainFrame" href="paramiko.sftp_si-module.html">sftp_si</a><br /> +<a target="mainFrame" href="../private/paramiko.ssh_exception-module.html">ssh_exception</a><br /> +<a target="mainFrame" href="paramiko.transport-module.html">transport</a><br /> +<a target="mainFrame" href="paramiko.util-module.html">util</a><br /> +<br /> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="paramiko.Agent-class.html">Agent</a><br /> +<a target="mainFrame" href="paramiko.AgentKey-class.html">AgentKey</a><br /> +<a target="mainFrame" href="../private/paramiko.AuthHandler-class.html">AuthHandler</a><br /> +<a target="mainFrame" href="../private/paramiko.BaseSFTP-class.html">BaseSFTP</a><br /> +<a target="mainFrame" href="paramiko.BufferedFile-class.html">BufferedFile</a><br /> +<a target="mainFrame" href="paramiko.Channel-class.html">Channel</a><br /> +<a target="mainFrame" href="../private/paramiko.ChannelFile-class.html">ChannelFile</a><br /> +<a target="mainFrame" href="paramiko.DSSKey-class.html">DSSKey</a><br /> +<a target="mainFrame" href="paramiko.Message-class.html">Message</a><br /> +<a target="mainFrame" href="../private/paramiko.Packetizer-class.html">Packetizer</a><br /> +<a target="mainFrame" href="../private/paramiko.PKey-class.html">PKey</a><br /> +<a target="mainFrame" href="paramiko.RSAKey-class.html">RSAKey</a><br /> +<a target="mainFrame" href="paramiko.SecurityOptions-class.html">SecurityOptions</a><br /> +<a target="mainFrame" href="../private/paramiko.ServerInterface-class.html">ServerInterface</a><br /> +<a target="mainFrame" href="paramiko.SFTP-class.html">SFTP</a><br /> +<a target="mainFrame" href="paramiko.SFTPAttributes-class.html">SFTPAttributes</a><br /> +<a target="mainFrame" href="paramiko.SFTPClient-class.html">SFTPClient</a><br /> +<a target="mainFrame" href="paramiko.SFTPFile-class.html">SFTPFile</a><br /> +<a target="mainFrame" href="paramiko.SFTPHandle-class.html">SFTPHandle</a><br /> +<a target="mainFrame" href="paramiko.SFTPServer-class.html">SFTPServer</a><br /> +<a target="mainFrame" href="../private/paramiko.SFTPServerInterface-class.html">SFTPServerInterface</a><br /> +<a target="mainFrame" href="paramiko.SubsystemHandler-class.html">SubsystemHandler</a><br /> +<a target="mainFrame" href="paramiko.Transport-class.html">Transport</a><br /> +<a target="mainFrame" href="../private/paramiko.ServerInterface-class.html">x</a><br /> +<br /> + +<!-- =========== START OF EXCEPTIONS =========== --> +<font size="+1"><b>Exceptions</b></font><br /> +<a target="mainFrame" href="paramiko.BadAuthenticationType-class.html">BadAuthenticationType</a><br /> +<a target="mainFrame" href="paramiko.PasswordRequiredException-class.html">PasswordRequiredException</a><br /> +<a target="mainFrame" href="paramiko.SFTPError-class.html">SFTPError</a><br /> +<a target="mainFrame" href="paramiko.SSHException-class.html">SSHException</a><br /> +<br /> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__author__">__author__</a><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__date__">__date__</a><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__license__">__license__</a><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__version__">__version__</a><br /> +<a target="mainFrame" href="../private/paramiko-module.html#__version_info__">__version_info__</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.agent-module.html b/docs/private/toc-paramiko.agent-module.html new file mode 100644 index 0000000..67aa397 --- /dev/null +++ b/docs/private/toc-paramiko.agent-module.html @@ -0,0 +1,25 @@ +<?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>paramiko.agent</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.agent-module.html">agent</a></b></font></center> +<hr> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENT_IDENTITIES_ANSWER">SSH2_AGENT_IDENTITIES_ANSWER</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENT_SIGN_RESPONSE">SSH2_AGENT_SIGN_RESPONSE</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENTC_REQUEST_IDENTITIES">SSH2_AGENTC_REQUEST_IDENTITIES</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENTC_SIGN_REQUEST">SSH2_AGENTC_SIGN_REQUEST</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.agent-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.auth_handler-module.html b/docs/private/toc-paramiko.auth_handler-module.html new file mode 100644 index 0000000..a82871d --- /dev/null +++ b/docs/private/toc-paramiko.auth_handler-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.auth_handler</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.auth_handler-module.html">auth_handler</a></b></font></center> +<hr> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.ber-module.html b/docs/private/toc-paramiko.ber-module.html new file mode 100644 index 0000000..2dd81d0 --- /dev/null +++ b/docs/private/toc-paramiko.ber-module.html @@ -0,0 +1,27 @@ +<?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>paramiko.ber</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.ber-module.html">ber</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="../private/paramiko.ber.BER-class.html">BER</a><br /> +<br /> + +<!-- =========== START OF EXCEPTIONS =========== --> +<font size="+1"><b>Exceptions</b></font><br /> +<a target="mainFrame" href="../private/paramiko.ber.BERException-class.html">BERException</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.channel-module.html b/docs/private/toc-paramiko.channel-module.html new file mode 100644 index 0000000..d0eb4d9 --- /dev/null +++ b/docs/private/toc-paramiko.channel-module.html @@ -0,0 +1,22 @@ +<?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>paramiko.channel</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.channel-module.html">channel</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="../private/paramiko.channel.ChannelStderrFile-class.html">ChannelStderrFile</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.common-module.html b/docs/private/toc-paramiko.common-module.html new file mode 100644 index 0000000..3fe063c --- /dev/null +++ b/docs/private/toc-paramiko.common-module.html @@ -0,0 +1,63 @@ +<?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>paramiko.common</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.common-module.html">common</a></b></font></center> +<hr> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#AUTH_FAILED">AUTH_FAILED</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#AUTH_PARTIALLY_SUCCESSFUL">AUTH_PARTIALLY_SUCCESSFUL</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#AUTH_SUCCESSFUL">AUTH_SUCCESSFUL</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#CONNECTION_FAILED_CODE">CONNECTION_FAILED_CODE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#CRITICAL">CRITICAL</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#DEBUG">DEBUG</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#DISCONNECT_AUTH_CANCELLED_BY_USER">DISCONNECT_AUTH_CANCELLED_BY_USER</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE">DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#DISCONNECT_SERVICE_NOT_AVAILABLE">DISCONNECT_SERVICE_NOT_AVAILABLE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#ERROR">ERROR</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#INFO">INFO</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_CLOSE">MSG_CHANNEL_CLOSE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_DATA">MSG_CHANNEL_DATA</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_EOF">MSG_CHANNEL_EOF</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_EXTENDED_DATA">MSG_CHANNEL_EXTENDED_DATA</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_FAILURE">MSG_CHANNEL_FAILURE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN">MSG_CHANNEL_OPEN</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN_FAILURE">MSG_CHANNEL_OPEN_FAILURE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_OPEN_SUCCESS">MSG_CHANNEL_OPEN_SUCCESS</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_REQUEST">MSG_CHANNEL_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_SUCCESS">MSG_CHANNEL_SUCCESS</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_CHANNEL_WINDOW_ADJUST">MSG_CHANNEL_WINDOW_ADJUST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_DEBUG">MSG_DEBUG</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_DISCONNECT">MSG_DISCONNECT</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_GLOBAL_REQUEST">MSG_GLOBAL_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_IGNORE">MSG_IGNORE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_KEXINIT">MSG_KEXINIT</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_NAMES">MSG_NAMES</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_NEWKEYS">MSG_NEWKEYS</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_REQUEST_FAILURE">MSG_REQUEST_FAILURE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_REQUEST_SUCCESS">MSG_REQUEST_SUCCESS</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_SERVICE_ACCEPT">MSG_SERVICE_ACCEPT</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_SERVICE_REQUEST">MSG_SERVICE_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_UNIMPLEMENTED">MSG_UNIMPLEMENTED</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_BANNER">MSG_USERAUTH_BANNER</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_FAILURE">MSG_USERAUTH_FAILURE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_INFO_REQUEST">MSG_USERAUTH_INFO_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_INFO_RESPONSE">MSG_USERAUTH_INFO_RESPONSE</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_PK_OK">MSG_USERAUTH_PK_OK</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_REQUEST">MSG_USERAUTH_REQUEST</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#MSG_USERAUTH_SUCCESS">MSG_USERAUTH_SUCCESS</a><br /> +<a target="mainFrame" href="../private/paramiko.common-module.html#WARNING">WARNING</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.compress-module.html b/docs/private/toc-paramiko.compress-module.html new file mode 100644 index 0000000..df10cb8 --- /dev/null +++ b/docs/private/toc-paramiko.compress-module.html @@ -0,0 +1,23 @@ +<?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>paramiko.compress</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.compress-module.html">compress</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="../private/paramiko.compress.ZlibCompressor-class.html">ZlibCompressor</a><br /> +<a target="mainFrame" href="../private/paramiko.compress.ZlibDecompressor-class.html">ZlibDecompressor</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.dsskey-module.html b/docs/private/toc-paramiko.dsskey-module.html new file mode 100644 index 0000000..dbdf69c --- /dev/null +++ b/docs/private/toc-paramiko.dsskey-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.dsskey</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.dsskey-module.html">dsskey</a></b></font></center> +<hr> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.dsskey-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.file-module.html b/docs/private/toc-paramiko.file-module.html new file mode 100644 index 0000000..9cda933 --- /dev/null +++ b/docs/private/toc-paramiko.file-module.html @@ -0,0 +1,28 @@ +<?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>paramiko.file</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.file-module.html">file</a></b></font></center> +<hr> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_APPEND">_FLAG_APPEND</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_BINARY">_FLAG_BINARY</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_BUFFERED">_FLAG_BUFFERED</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_LINE_BUFFERED">_FLAG_LINE_BUFFERED</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_READ">_FLAG_READ</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_UNIVERSAL_NEWLINE">_FLAG_UNIVERSAL_NEWLINE</a><br /> +<a target="mainFrame" href="../private/paramiko.file-module.html#_FLAG_WRITE">_FLAG_WRITE</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.file-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.kex_gex-module.html b/docs/private/toc-paramiko.kex_gex-module.html new file mode 100644 index 0000000..fd9acc8 --- /dev/null +++ b/docs/private/toc-paramiko.kex_gex-module.html @@ -0,0 +1,30 @@ +<?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>paramiko.kex_gex</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.kex_gex-module.html">kex_gex</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex.KexGex-class.html">KexGex</a><br /> +<br /> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_GROUP">_MSG_KEXDH_GEX_GROUP</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_INIT">_MSG_KEXDH_GEX_INIT</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_REPLY">_MSG_KEXDH_GEX_REPLY</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_gex-module.html#_MSG_KEXDH_GEX_REQUEST">_MSG_KEXDH_GEX_REQUEST</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.kex_group1-module.html b/docs/private/toc-paramiko.kex_group1-module.html new file mode 100644 index 0000000..ca51eb0 --- /dev/null +++ b/docs/private/toc-paramiko.kex_group1-module.html @@ -0,0 +1,30 @@ +<?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>paramiko.kex_group1</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.kex_group1-module.html">kex_group1</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1.KexGroup1-class.html">KexGroup1</a><br /> +<br /> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1-module.html#_MSG_KEXDH_INIT">_MSG_KEXDH_INIT</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1-module.html#_MSG_KEXDH_REPLY">_MSG_KEXDH_REPLY</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1-module.html#G">G</a><br /> +<a target="mainFrame" href="../private/paramiko.kex_group1-module.html#P">P</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.logging22-module.html b/docs/private/toc-paramiko.logging22-module.html new file mode 100644 index 0000000..6b96de4 --- /dev/null +++ b/docs/private/toc-paramiko.logging22-module.html @@ -0,0 +1,39 @@ +<?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>paramiko.logging22</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.logging22-module.html">logging22</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="../private/paramiko.logging22.Formatter-class.html">Formatter</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22.logger-class.html">logger</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22.StreamHandler-class.html">StreamHandler</a><br /> +<br /> + +<!-- =========== START OF FUNCTIONS =========== --> +<font size="+1"><b>Functions</b></font><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#getLogger">getLogger</a><br /> +<br /> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#_logger">_logger</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#CRITICAL">CRITICAL</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#DEBUG">DEBUG</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#ERROR">ERROR</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#INFO">INFO</a><br /> +<a target="mainFrame" href="../private/paramiko.logging22-module.html#WARNING">WARNING</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.message-module.html b/docs/private/toc-paramiko.message-module.html new file mode 100644 index 0000000..13e6444 --- /dev/null +++ b/docs/private/toc-paramiko.message-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.message</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.message-module.html">message</a></b></font></center> +<hr> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.message-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.packet-module.html b/docs/private/toc-paramiko.packet-module.html new file mode 100644 index 0000000..670fb37 --- /dev/null +++ b/docs/private/toc-paramiko.packet-module.html @@ -0,0 +1,22 @@ +<?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>paramiko.packet</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.packet-module.html">packet</a></b></font></center> +<hr> + +<!-- =========== START OF EXCEPTIONS =========== --> +<font size="+1"><b>Exceptions</b></font><br /> +<a target="mainFrame" href="../private/paramiko.packet.NeedRekeyException-class.html">NeedRekeyException</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.pipe-module.html b/docs/private/toc-paramiko.pipe-module.html new file mode 100644 index 0000000..4a6b775 --- /dev/null +++ b/docs/private/toc-paramiko.pipe-module.html @@ -0,0 +1,28 @@ +<?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>paramiko.pipe</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.pipe-module.html">pipe</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="../private/paramiko.pipe.PosixPipe-class.html">PosixPipe</a><br /> +<a target="mainFrame" href="../private/paramiko.pipe.WindowsPipe-class.html">WindowsPipe</a><br /> +<br /> + +<!-- =========== START OF FUNCTIONS =========== --> +<font size="+1"><b>Functions</b></font><br /> +<a target="mainFrame" href="../private/paramiko.pipe-module.html#make_pipe">make_pipe</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.pkey-module.html b/docs/private/toc-paramiko.pkey-module.html new file mode 100644 index 0000000..56fa96f --- /dev/null +++ b/docs/private/toc-paramiko.pkey-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.pkey</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.pkey-module.html">pkey</a></b></font></center> +<hr> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.pkey-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.primes-module.html b/docs/private/toc-paramiko.primes-module.html new file mode 100644 index 0000000..356d9bd --- /dev/null +++ b/docs/private/toc-paramiko.primes-module.html @@ -0,0 +1,28 @@ +<?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>paramiko.primes</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.primes-module.html">primes</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="../private/paramiko.primes.ModulusPack-class.html">ModulusPack</a><br /> +<br /> + +<!-- =========== START OF FUNCTIONS =========== --> +<font size="+1"><b>Functions</b></font><br /> +<a target="mainFrame" href="../private/paramiko.primes-module.html#_generate_prime">_generate_prime</a><br /> +<a target="mainFrame" href="../private/paramiko.primes-module.html#_roll_random">_roll_random</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.rsakey-module.html b/docs/private/toc-paramiko.rsakey-module.html new file mode 100644 index 0000000..117cc82 --- /dev/null +++ b/docs/private/toc-paramiko.rsakey-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.rsakey</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.rsakey-module.html">rsakey</a></b></font></center> +<hr> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.rsakey-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.server-module.html b/docs/private/toc-paramiko.server-module.html new file mode 100644 index 0000000..58cf1e4 --- /dev/null +++ b/docs/private/toc-paramiko.server-module.html @@ -0,0 +1,22 @@ +<?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>paramiko.server</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.server-module.html">server</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="paramiko.server.InteractiveQuery-class.html">InteractiveQuery</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.server-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.sftp-module.html b/docs/private/toc-paramiko.sftp-module.html new file mode 100644 index 0000000..a2d59c4 --- /dev/null +++ b/docs/private/toc-paramiko.sftp-module.html @@ -0,0 +1,66 @@ +<?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>paramiko.sftp</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp-module.html">sftp</a></b></font></center> +<hr> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko.sftp-module.html#_VERSION">_VERSION</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_ATTRS">CMD_ATTRS</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_CLOSE">CMD_CLOSE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_DATA">CMD_DATA</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_EXTENDED">CMD_EXTENDED</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_EXTENDED_REPLY">CMD_EXTENDED_REPLY</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_FSETSTAT">CMD_FSETSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_FSTAT">CMD_FSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_HANDLE">CMD_HANDLE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_INIT">CMD_INIT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_LSTAT">CMD_LSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_MKDIR">CMD_MKDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_NAME">CMD_NAME</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_NAMES">CMD_NAMES</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_OPEN">CMD_OPEN</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_OPENDIR">CMD_OPENDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READ">CMD_READ</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READDIR">CMD_READDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READLINK">CMD_READLINK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_REALPATH">CMD_REALPATH</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_REMOVE">CMD_REMOVE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_RENAME">CMD_RENAME</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_RMDIR">CMD_RMDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_SETSTAT">CMD_SETSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_STAT">CMD_STAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_STATUS">CMD_STATUS</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_SYMLINK">CMD_SYMLINK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_VERSION">CMD_VERSION</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_WRITE">CMD_WRITE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_BAD_MESSAGE">SFTP_BAD_MESSAGE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_CONNECTION_LOST">SFTP_CONNECTION_LOST</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_DESC">SFTP_DESC</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_EOF">SFTP_EOF</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FAILURE">SFTP_FAILURE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_APPEND">SFTP_FLAG_APPEND</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_CREATE">SFTP_FLAG_CREATE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_EXCL">SFTP_FLAG_EXCL</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_READ">SFTP_FLAG_READ</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_TRUNC">SFTP_FLAG_TRUNC</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_WRITE">SFTP_FLAG_WRITE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_NO_CONNECTION">SFTP_NO_CONNECTION</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_NO_SUCH_FILE">SFTP_NO_SUCH_FILE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_OK">SFTP_OK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_OP_UNSUPPORTED">SFTP_OP_UNSUPPORTED</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_PERMISSION_DENIED">SFTP_PERMISSION_DENIED</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.sftp-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.sftp_attr-module.html b/docs/private/toc-paramiko.sftp_attr-module.html new file mode 100644 index 0000000..e1180e3 --- /dev/null +++ b/docs/private/toc-paramiko.sftp_attr-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.sftp_attr</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_attr-module.html">sftp_attr</a></b></font></center> +<hr> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.sftp_attr-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.sftp_client-module.html b/docs/private/toc-paramiko.sftp_client-module.html new file mode 100644 index 0000000..e2f94fd --- /dev/null +++ b/docs/private/toc-paramiko.sftp_client-module.html @@ -0,0 +1,22 @@ +<?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>paramiko.sftp_client</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_client-module.html">sftp_client</a></b></font></center> +<hr> + +<!-- =========== START OF FUNCTIONS =========== --> +<font size="+1"><b>Functions</b></font><br /> +<a target="mainFrame" href="../private/paramiko.sftp_client-module.html#_to_unicode">_to_unicode</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.sftp_client-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.sftp_file-module.html b/docs/private/toc-paramiko.sftp_file-module.html new file mode 100644 index 0000000..f270b0f --- /dev/null +++ b/docs/private/toc-paramiko.sftp_file-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.sftp_file</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_file-module.html">sftp_file</a></b></font></center> +<hr> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.sftp_file-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.sftp_handle-module.html b/docs/private/toc-paramiko.sftp_handle-module.html new file mode 100644 index 0000000..1df5358 --- /dev/null +++ b/docs/private/toc-paramiko.sftp_handle-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.sftp_handle</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_handle-module.html">sftp_handle</a></b></font></center> +<hr> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.sftp_handle-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.sftp_server-module.html b/docs/private/toc-paramiko.sftp_server-module.html new file mode 100644 index 0000000..3c12fcc --- /dev/null +++ b/docs/private/toc-paramiko.sftp_server-module.html @@ -0,0 +1,22 @@ +<?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>paramiko.sftp_server</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_server-module.html">sftp_server</a></b></font></center> +<hr> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko.sftp_server-module.html#_hash_class">_hash_class</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.sftp_server-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.sftp_si-module.html b/docs/private/toc-paramiko.sftp_si-module.html new file mode 100644 index 0000000..75605b8 --- /dev/null +++ b/docs/private/toc-paramiko.sftp_si-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.sftp_si</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_si-module.html">sftp_si</a></b></font></center> +<hr> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.sftp_si-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.ssh_exception-module.html b/docs/private/toc-paramiko.ssh_exception-module.html new file mode 100644 index 0000000..1567097 --- /dev/null +++ b/docs/private/toc-paramiko.ssh_exception-module.html @@ -0,0 +1,22 @@ +<?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>paramiko.ssh_exception</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="../private/paramiko.ssh_exception-module.html">ssh_exception</a></b></font></center> +<hr> + +<!-- =========== START OF EXCEPTIONS =========== --> +<font size="+1"><b>Exceptions</b></font><br /> +<a target="mainFrame" href="../private/paramiko.ssh_exception.PartialAuthentication-class.html">PartialAuthentication</a><br /> +<br /> + +<hr> +<font size="-2">[<b>show private</b> | hide private]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.transport-module.html b/docs/private/toc-paramiko.transport-module.html new file mode 100644 index 0000000..d5d5651 --- /dev/null +++ b/docs/private/toc-paramiko.transport-module.html @@ -0,0 +1,27 @@ +<?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>paramiko.transport</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.transport-module.html">transport</a></b></font></center> +<hr> + +<!-- =========== START OF FUNCTIONS =========== --> +<font size="+1"><b>Functions</b></font><br /> +<a target="mainFrame" href="../private/paramiko.transport-module.html#_join_lingering_threads">_join_lingering_threads</a><br /> +<br /> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko.transport-module.html#_active_threads">_active_threads</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.transport-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc-paramiko.util-module.html b/docs/private/toc-paramiko.util-module.html new file mode 100644 index 0000000..a290c16 --- /dev/null +++ b/docs/private/toc-paramiko.util-module.html @@ -0,0 +1,52 @@ +<?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>paramiko.util</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.util-module.html">util</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="paramiko.util.PFilter-class.html">PFilter</a><br /> +<br /> + +<!-- =========== START OF FUNCTIONS =========== --> +<font size="+1"><b>Functions</b></font><br /> +<a target="mainFrame" href="paramiko.util-module.html#bit_length">bit_length</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#deflate_long">deflate_long</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary">format_binary</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary_line">format_binary_line</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary_weird">format_binary_weird</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#generate_key_bytes">generate_key_bytes</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#get_logger">get_logger</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#get_thread_id">get_thread_id</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#hexify">hexify</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#inflate_long">inflate_long</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#load_host_keys">load_host_keys</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#log_to_file">log_to_file</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#lookup_ssh_host_config">lookup_ssh_host_config</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#mod_inverse">mod_inverse</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#parse_ssh_config">parse_ssh_config</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#safe_string">safe_string</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#tb_strings">tb_strings</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#unhexify">unhexify</a><br /> +<br /> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="../private/paramiko.util-module.html#_g_thread_counter">_g_thread_counter</a><br /> +<a target="mainFrame" href="../private/paramiko.util-module.html#_g_thread_ids">_g_thread_ids</a><br /> +<a target="mainFrame" href="../private/paramiko.util-module.html#_g_thread_lock">_g_thread_lock</a><br /> +<a target="mainFrame" href="../private/paramiko.util-module.html#_pfilter">_pfilter</a><br /> +<br /> + +<hr> +<font size="-2">[show private | <a href="../public/toc-paramiko.util-module.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/toc.html b/docs/private/toc.html new file mode 100644 index 0000000..fd91230 --- /dev/null +++ b/docs/private/toc.html @@ -0,0 +1,53 @@ +<?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>Table of Contents</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b>Table of Contents</b></font></center> +<hr> +<a target="moduleFrame" href="toc-everything.html">Everything</a><br /> + +<!-- =========== START OF PACKAGES =========== --> +<br /><font size="+1"><b>Packages</b></font><br /> +<a target="moduleFrame" href="toc-paramiko-module.html">paramiko</a><br /> + +<!-- =========== START OF MODULES =========== --> +<br /><font size="+1"><b>Modules</b></font><br /> +<a target="moduleFrame" href="toc-paramiko.agent-module.html">paramiko.agent</a><br /> +<a target="moduleFrame" href="toc-paramiko.auth_handler-module.html">paramiko.auth_handler</a><br /> +<a target="moduleFrame" href="toc-paramiko.ber-module.html">paramiko.ber</a><br /> +<a target="moduleFrame" href="toc-paramiko.channel-module.html">paramiko.channel</a><br /> +<a target="moduleFrame" href="toc-paramiko.common-module.html">paramiko.common</a><br /> +<a target="moduleFrame" href="toc-paramiko.compress-module.html">paramiko.compress</a><br /> +<a target="moduleFrame" href="toc-paramiko.dsskey-module.html">paramiko.dsskey</a><br /> +<a target="moduleFrame" href="toc-paramiko.file-module.html">paramiko.file</a><br /> +<a target="moduleFrame" href="toc-paramiko.kex_gex-module.html">paramiko.kex_gex</a><br /> +<a target="moduleFrame" href="toc-paramiko.kex_group1-module.html">paramiko.kex_group1</a><br /> +<a target="moduleFrame" href="toc-paramiko.logging22-module.html">paramiko.logging22</a><br /> +<a target="moduleFrame" href="toc-paramiko.message-module.html">paramiko.message</a><br /> +<a target="moduleFrame" href="toc-paramiko.packet-module.html">paramiko.packet</a><br /> +<a target="moduleFrame" href="toc-paramiko.pipe-module.html">paramiko.pipe</a><br /> +<a target="moduleFrame" href="toc-paramiko.pkey-module.html">paramiko.pkey</a><br /> +<a target="moduleFrame" href="toc-paramiko.primes-module.html">paramiko.primes</a><br /> +<a target="moduleFrame" href="toc-paramiko.rsakey-module.html">paramiko.rsakey</a><br /> +<a target="moduleFrame" href="toc-paramiko.server-module.html">paramiko.server</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp-module.html">paramiko.sftp</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_attr-module.html">paramiko.sftp_attr</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_client-module.html">paramiko.sftp_client</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_file-module.html">paramiko.sftp_file</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_handle-module.html">paramiko.sftp_handle</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_server-module.html">paramiko.sftp_server</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_si-module.html">paramiko.sftp_si</a><br /> +<a target="moduleFrame" href="toc-paramiko.ssh_exception-module.html">paramiko.ssh_exception</a><br /> +<a target="moduleFrame" href="toc-paramiko.transport-module.html">paramiko.transport</a><br /> +<a target="moduleFrame" href="toc-paramiko.util-module.html">paramiko.util</a><br /> + +<br /><hr> +<font size="-2">[show private | <a href="../public/toc.html">hide private</a>]</font> +</body> +</html> diff --git a/docs/private/trees.html b/docs/private/trees.html new file mode 100644 index 0000000..d762eb6 --- /dev/null +++ b/docs/private/trees.html @@ -0,0 +1,243 @@ +<?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>Module and Class Hierarchies</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="paramiko-module.html">Home</a> </th> + <th bgcolor="#70b0f0" class="navselect"> Trees </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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[show private | <a href="../public/trees.html">hide private</a>]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="trees.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE HIERARCHY =========== --> +<h2>Module Hierarchy</h2> +<ul> +<li> <b><a href="paramiko-module.html"><code>paramiko</code></a></b>: <i><i>Paramiko</i> (a combination of the esperanto words for +"paranoid" and "friend") is a module for python 2.3 +or greater that implements the SSH2 protocol for secure (encrypted and +authenticated) connections to remote machines.</i> + <ul> + <li> <b><a href="paramiko.agent-module.html"><code>agent</code></a></b>: <i>SSH Agent interface for Unix clients.</i> + <li> <b><a href="paramiko.dsskey-module.html"><code>dsskey</code></a></b>: <i><a href="paramiko.DSSKey-class.html" +class="link"><code>DSSKey</code></a></i> + <li> <b><a href="paramiko.file-module.html"><code>file</code></a></b>: <i>BufferedFile.</i> + <li> <b><a href="paramiko.message-module.html"><code>message</code></a></b>: <i>Implementation of an SSH2 "message".</i> + <li> <b><a href="paramiko.pkey-module.html"><code>pkey</code></a></b>: <i>Common API for all public keys.</i> + <li> <b><a href="paramiko.rsakey-module.html"><code>rsakey</code></a></b>: <i><a href="paramiko.RSAKey-class.html" +class="link"><code>RSAKey</code></a></i> + <li> <b><a href="paramiko.server-module.html"><code>server</code></a></b>: <i><a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> is an interface to override +for server support.</i> + <li> <b><a href="paramiko.sftp-module.html"><code>sftp</code></a></b> + <li> <b><a href="paramiko.sftp_attr-module.html"><code>sftp_attr</code></a></b> + <li> <b><a href="paramiko.sftp_client-module.html"><code>sftp_client</code></a></b>: <i>Client-mode SFTP support.</i> + <li> <b><a href="paramiko.sftp_file-module.html"><code>sftp_file</code></a></b>: <i><a href="paramiko.SFTPFile-class.html" +class="link"><code>SFTPFile</code></a></i> + <li> <b><a href="paramiko.sftp_handle-module.html"><code>sftp_handle</code></a></b>: <i>Abstraction of an SFTP file handle (for server mode).</i> + <li> <b><a href="paramiko.sftp_server-module.html"><code>sftp_server</code></a></b>: <i>Server-mode SFTP support.</i> + <li> <b><a href="paramiko.sftp_si-module.html"><code>sftp_si</code></a></b>: <i><a href="../private/paramiko.SFTPServerInterface-class.html" +class="link"><code>SFTPServerInterface</code></a> is an interface to +override for SFTP server support.</i> + <li> <b><a href="paramiko.transport-module.html"><code>transport</code></a></b>: <i><a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> handles the core SSH2 +protocol.</i> + <li> <b><a href="paramiko.util-module.html"><code>util</code></a></b>: <i>Useful functions used by the rest of paramiko.</i> + <li> <b><a href="../private/paramiko.auth_handler-module.html"><code>auth_handler</code></a></b>: <i><a href="../private/paramiko.AuthHandler-class.html" +class="link"><code>AuthHandler</code></a></i> + <li> <b><a href="../private/paramiko.ber-module.html"><code>ber</code></a></b> + <li> <b><a href="../private/paramiko.channel-module.html"><code>channel</code></a></b>: <i>Abstraction for an SSH2 channel.</i> + <li> <b><a href="../private/paramiko.common-module.html"><code>common</code></a></b>: <i>Common constants and global variables.</i> + <li> <b><a href="../private/paramiko.compress-module.html"><code>compress</code></a></b>: <i>Compression implementations for a Transport.</i> + <li> <b><a href="../private/paramiko.kex_gex-module.html"><code>kex_gex</code></a></b>: <i>Variant on <a +href="../private/paramiko.kex_group1.KexGroup1-class.html" +class="link"><code>KexGroup1</code></a> where the prime "p" and +generator "g" are provided by the server.</i> + <li> <b><a href="../private/paramiko.kex_group1-module.html"><code>kex_group1</code></a></b>: <i>Standard SSH key exchange ("kex" if you wanna sound +cool).</i> + <li> <b><a href="../private/paramiko.logging22-module.html"><code>logging22</code></a></b>: <i>Stub out logging on python < 2.3.</i> + <li> <b><a href="../private/paramiko.packet-module.html"><code>packet</code></a></b>: <i>Packetizer.</i> + <li> <b><a href="../private/paramiko.pipe-module.html"><code>pipe</code></a></b>: <i>Abstraction of a one-way pipe where the read end can be used in +select().</i> + <li> <b><a href="../private/paramiko.primes-module.html"><code>primes</code></a></b>: <i>Utility functions for dealing with primes.</i> + <li> <b><a href="../private/paramiko.ssh_exception-module.html"><code>ssh_exception</code></a></b>: <i>Exceptions defined by paramiko.</i> + </ul> +</ul> + +<!-- =========== START OF CLASS HIERARCHY =========== --> +<h2>Class Hierarchy</h2> +<ul> + <li> <b><a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></b>: <i> +The most base type</i> + <ul> + <li> <b><a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></b>: <i> +Reusable base class to implement python-style file buffering around a +simpler stream.</i> + <ul> + <li> <b><a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></b>: <i> +Proxy object for a file on the remote server, in client mode SFTP.</i> + <li> <b><a href="../private/paramiko.ChannelFile-class.html"><code>paramiko.ChannelFile</code></a></b>: <i> +A file-like wrapper around <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</i> + <ul> + <li> <b><a href="../private/paramiko.channel.ChannelStderrFile-class.html"><code>paramiko.channel.ChannelStderrFile</code></a></b> + </ul> + </ul> + <li> <b><a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></b>: <i> +A secure tunnel across an SSH <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>.</i> + <li> <b><a href="paramiko.server.InteractiveQuery-class.html"><code>paramiko.server.InteractiveQuery</code></a></b>: <i> +A query (set of prompts) for a user during interactive +authentication.</i> + <li> <b><a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></b>: <i> +An SSH2 <i>Message</i> is a stream of bytes that encodes some +combination of strings, integers, bools, and infinite-precision integers +(known in python as <i>long</i>s).</i> + <li> <b><a href="paramiko.util.PFilter-class.html"><code>paramiko.util.PFilter</code></a></b> + <li> <b><a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></b>: <i> +Simple object containing the security preferences of an ssh +transport.</i> + <li> <b><a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></b>: <i> +Representation of the attributes of a file (or proxied file) for SFTP +in client or server mode.</i> + <li> <b><a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></b>: <i> +Abstract object representing a handle to an open file (or folder) in +an SFTP server implementation.</i> + <li> <b><a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></b>: <i> +type(object) -> the object's type type(name, bases, dict) -> a +new type</i> + <li> <b><a href="../private/threading._Verbose-class.html"><code>threading._Verbose</code></a></b> + <ul> + <li> <b><a href="threading.Thread-class.html"><code>threading.Thread</code></a></b> + <ul> + <li> <b><a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></b>: <i> +Handler for a subsytem in server mode.</i> + <ul> + <li> <b><a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></b>: <i> +Server-side SFTP subsystem support.</i> + </ul> + <li> <b><a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></b>: <i> +An SSH Transport attaches to a stream (usually a socket), negotiates +an encrypted session, authenticates, and then creates stream tunnels, +called <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>s, across the session.</i> + </ul> + </ul> + <li> <b><a href="../private/paramiko.AuthHandler-class.html"><code>paramiko.AuthHandler</code></a></b>: <i> +Internal class to handle the mechanics of authentication.</i> + <li> <b><a href="../private/paramiko.BaseSFTP-class.html"><code>paramiko.BaseSFTP</code></a></b> + <ul> + <li> <b><a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></b>: <i> +SFTP client object.</i> + <ul> + <li> <b><a href="paramiko.SFTP-class.html"><code>paramiko.SFTP</code></a></b>: <i> +an alias for <a href="paramiko.SFTPClient-class.html" +class="link"><code>SFTPClient</code></a> for backwards compatability</i> + </ul> + <li> <b><a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></b>: <i> +Server-side SFTP subsystem support.</i> + </ul> + <li> <b><a href="../private/paramiko.ber.BER-class.html"><code>paramiko.ber.BER</code></a></b>: <i> +Robey's tiny little attempt at a BER decoder.</i> + <li> <b><a href="../private/paramiko.logging22.Formatter-class.html"><code>paramiko.logging22.Formatter</code></a></b> + <li> <b><a href="../private/paramiko.kex_gex.KexGex-class.html"><code>paramiko.kex_gex.KexGex</code></a></b> + <li> <b><a href="../private/paramiko.kex_group1.KexGroup1-class.html"><code>paramiko.kex_group1.KexGroup1</code></a></b> + <li> <b><a href="../private/paramiko.logging22.logger-class.html"><code>paramiko.logging22.logger</code></a></b> + <li> <b><a href="../private/paramiko.primes.ModulusPack-class.html"><code>paramiko.primes.ModulusPack</code></a></b>: <i> +convenience object for holding the contents of the /etc/ssh/moduli +file, on systems that have such a file.</i> + <li> <b><a href="../private/paramiko.Packetizer-class.html"><code>paramiko.Packetizer</code></a></b>: <i> +Implementation of the base SSH packet protocol.</i> + <li> <b><a href="../private/paramiko.PKey-class.html"><code>paramiko.PKey</code></a></b>: <i> +Base class for public keys.</i> + <ul> + <li> <b><a href="paramiko.AgentKey-class.html"><code>paramiko.AgentKey</code></a></b>: <i> +Private key held in a local SSH agent.</i> + <li> <b><a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></b>: <i> +Representation of a DSS key which can be used to sign an verify SSH2 +data.</i> + <li> <b><a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></b>: <i> +Representation of an RSA key which can be used to sign and verify SSH2 +data.</i> + </ul> + <li> <b><a href="../private/paramiko.pipe.PosixPipe-class.html"><code>paramiko.pipe.PosixPipe</code></a></b> + <li> <b><a href="../private/paramiko.ServerInterface-class.html"><code>paramiko.ServerInterface</code></a></b>: <i> +This class defines an interface for controlling the behavior of +paramiko in server mode.</i> + <li> <b><a href="../private/paramiko.SFTPServerInterface-class.html"><code>paramiko.SFTPServerInterface</code></a></b>: <i> +This class defines an interface for controlling the behavior of +paramiko when using the <a href="paramiko.SFTPServer-class.html" +class="link"><code>SFTPServer</code></a> subsystem to provide an SFTP +server.</i> + <li> <b><a href="../private/paramiko.logging22.StreamHandler-class.html"><code>paramiko.logging22.StreamHandler</code></a></b> + <li> <b><a href="../private/paramiko.pipe.WindowsPipe-class.html"><code>paramiko.pipe.WindowsPipe</code></a></b>: <i> +On Windows, only an OS-level "WinSock" may be used in +select(), but reads and writes must be to the actual socket object.</i> + <li> <b><a href="../private/paramiko.compress.ZlibCompressor-class.html"><code>paramiko.compress.ZlibCompressor</code></a></b> + <li> <b><a href="../private/paramiko.compress.ZlibDecompressor-class.html"><code>paramiko.compress.ZlibDecompressor</code></a></b> + </ul> + <li> <b><a href="exceptions.Exception-class.html"><code>exceptions.Exception</code></a></b>: <i> +Common base class for all exceptions.</i> + <ul> + <li> <b><a href="paramiko.SFTPError-class.html"><code>paramiko.SFTPError</code></a></b> + <li> <b><a href="paramiko.SSHException-class.html"><code>paramiko.SSHException</code></a></b>: <i> +Exception raised by failures in SSH2 protocol negotiation or logic +errors.</i> + <ul> + <li> <b><a href="paramiko.BadAuthenticationType-class.html"><code>paramiko.BadAuthenticationType</code></a></b>: <i> +Exception raised when an authentication type (like password) is used, +but the server isn't allowing that type.</i> + <li> <b><a href="paramiko.PasswordRequiredException-class.html"><code>paramiko.PasswordRequiredException</code></a></b>: <i> +Exception raised when a password is needed to unlock a private key +file.</i> + <li> <b><a href="../private/paramiko.ssh_exception.PartialAuthentication-class.html"><code>paramiko.ssh_exception.PartialAuthentication</code></a></b>: <i> +An internal exception thrown in the case of partial +authentication.</i> + </ul> + <li> <b><a href="../private/paramiko.ber.BERException-class.html"><code>paramiko.ber.BERException</code></a></b> + <li> <b><a href="../private/paramiko.packet.NeedRekeyException-class.html"><code>paramiko.packet.NeedRekeyException</code></a></b> + </ul> + <li> <b><a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></b>: <i> +Client interface for using private keys from an SSH agent running on +the local machine.</i> +</ul> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/__builtin__.object-class.html b/docs/public/__builtin__.object-class.html new file mode 100644 index 0000000..f9ab2d2 --- /dev/null +++ b/docs/public/__builtin__.object-class.html @@ -0,0 +1,268 @@ +<?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>__builtin__.object</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Module __builtin__ :: + Class object + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/__builtin__.object-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="__builtin__.object-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type object</h2> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a>, + <a href="paramiko.Channel-class.html"><code>Channel</code></a>, + <a href="paramiko.server.InteractiveQuery-class.html"><code>InteractiveQuery</code></a>, + <a href="paramiko.Message-class.html"><code>Message</code></a>, + <a href="paramiko.util.PFilter-class.html"><code>PFilter</code></a>, + <a href="paramiko.SecurityOptions-class.html"><code>SecurityOptions</code></a>, + <a href="paramiko.SFTPAttributes-class.html"><code>SFTPAttributes</code></a>, + <a href="paramiko.SFTPHandle-class.html"><code>SFTPHandle</code></a>, + <a href="__builtin__.type-class.html"><code>type</code></a></dd></dl> + +<hr/> + +The most base type +<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="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__init__(...) initializes x; see x.__class__.__doc__ for +signature</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>type</code></font></td> + <td><a name="__class__"></a><b><code>__class__</code></b> = <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></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-vararg">...</span>)</span> + <br /><i>(Constructor)</i> + </h3> + x.__init__(...) initializes x; see x.__class__.__doc__ for + signature + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__delattr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__delattr__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__delattr__('name') <==> del x.name + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__getattribute__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__getattribute__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__getattribute__('name') <==> x.name + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__hash__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__hash__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Hashing function)</i> + </h3> + x.__hash__() <==> hash(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +hash(x) +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__new__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__new__</span>(<span class=sig-arg>T</span>, + <span class=sig-arg>S</span>, + <span class="sig-vararg">...</span>)</span> + </h3> + T.__new__(S, ...) -> a new object with type S, a subtype of T + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +a new object with type S, a subtype of T +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__reduce__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__reduce__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + helper for pickle + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__reduce_ex__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__reduce_ex__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + helper for pickle + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + x.__repr__() <==> repr(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +repr(x) +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__setattr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__setattr__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__setattr__('name', value) <==> x.name = value + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + x.__str__() <==> str(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +str(x) +</pre> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/public/__builtin__.type-class.html b/docs/public/__builtin__.type-class.html new file mode 100644 index 0000000..21075f7 --- /dev/null +++ b/docs/public/__builtin__.type-class.html @@ -0,0 +1,504 @@ +<?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>__builtin__.type</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Module __builtin__ :: + Class type + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/__builtin__.type-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="__builtin__.type-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type type</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>type</b> +</pre><br /> + +<hr/> + +type(object) -> the object's type type(name, bases, dict) -> a +new type +<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="__builtin__.type-class.html#__call__" class="summary-sig-name"><code>__call__</code></a>(<span class=summary-sig-arg>x</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__call__(...) <==> x(...)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__cmp__" class="summary-sig-name"><code>__cmp__</code></a>(<span class=summary-sig-arg>x</span>, + <span class=summary-sig-arg>y</span>)</span></code> +<br /> +x.__cmp__(y) <==> cmp(x,y)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1">list of immediate subclasses</font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#__subclasses__" class="summary-sig-name"><code>__subclasses__</code></a>()</span></code> +<br /> +__subclasses__() -> list of immediate subclasses</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1">list</font></td> + <td><code><span class="summary-sig"><a href="__builtin__.type-class.html#mro" class="summary-sig-name"><code>mro</code></a>()</span></code> +<br /> +return a type's method resolution order</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__init__(...) initializes x; see x.__class__.__doc__ for +signature</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>type</code></font></td> + <td><a name="__base__"></a><b><code>__base__</code></b> = <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="__builtin__.type-class.html#__bases__"><code>__bases__</code></a></b> = <span title="(<type 'object'>,)"><code>(<type 'object'>,) </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="__builtin__.type-class.html#__basicsize__"><code>__basicsize__</code></a></b> = <span title="420">420 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="__builtin__.type-class.html#__dictoffset__"><code>__dictoffset__</code></a></b> = <span title="132">132 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="__builtin__.type-class.html#__flags__"><code>__flags__</code></a></b> = <span title="21995">21995 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="__builtin__.type-class.html#__itemsize__"><code>__itemsize__</code></a></b> = <span title="20">20 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td> +<td><b><a href="__builtin__.type-class.html#__mro__"><code>__mro__</code></a></b> = <span title="(<type 'type'>, <type 'object'>)"><code>(<type 'type'>, <type 'object'>) </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td> +<td><b><a href="__builtin__.type-class.html#__name__"><code>__name__</code></a></b> = <span title="'type'"><code><span class="variable-quote">'</span>type<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="__builtin__.type-class.html#__weakrefoffset__"><code>__weakrefoffset__</code></a></b> = <span title="184">184 </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="__call__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__call__</span>(<span class=sig-arg>x</span>, + <span class="sig-vararg">...</span>)</span> + <br /><i>(Call operator)</i> + </h3> + x.__call__(...) <==> x(...) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +x(...) +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__cmp__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__cmp__</span>(<span class=sig-arg>x</span>, + <span class=sig-arg>y</span>)</span> + <br /><i>(Comparison operator)</i> + </h3> + x.__cmp__(y) <==> cmp(x,y) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +cmp(x,y) +</pre> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__delattr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__delattr__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__delattr__('name') <==> del x.name + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__delattr__"><code>__builtin__.object.__delattr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__getattribute__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__getattribute__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__getattribute__('name') <==> x.name + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__getattribute__"><code>__builtin__.object.__getattribute__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__hash__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__hash__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Hashing function)</i> + </h3> + x.__hash__() <==> hash(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +hash(x) +</pre> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__hash__"><code>__builtin__.object.__hash__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__new__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__new__</span>(<span class=sig-arg>T</span>, + <span class=sig-arg>S</span>, + <span class="sig-vararg">...</span>)</span> + </h3> + T.__new__(S, ...) -> a new object with type S, a subtype of T + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +a new object with type S, a subtype of T +</pre> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__new__"><code>__builtin__.object.__new__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>x</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + x.__repr__() <==> repr(x) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +<pre class="literalblock"> +repr(x) +</pre> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__setattr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__setattr__</span>(<span class="sig-vararg">...</span>)</span> + </h3> + x.__setattr__('name', value) <==> x.name = value + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__setattr__"><code>__builtin__.object.__setattr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__subclasses__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__subclasses__</span>()</span> + </h3> + __subclasses__() -> list of immediate subclasses + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +list of immediate subclasses </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="mro"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">mro</span>()</span> + </h3> + return a type's method resolution order + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> +list </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="__bases__"></a> +<h3>__bases__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</code> + + </dd> +<span title="(<type 'object'>,)"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +(<type 'object'>,) </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__basicsize__"></a> +<h3>__basicsize__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="420"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +420 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__dictoffset__"></a> +<h3>__dictoffset__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="132"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +132 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__flags__"></a> +<h3>__flags__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="21995"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +21995 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__itemsize__"></a> +<h3>__itemsize__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="20"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +20 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__mro__"></a> +<h3>__mro__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>tuple</code> + + </dd> +<span title="(<type 'type'>, <type 'object'>)"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +(<type 'type'>, <type 'object'>) </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__name__"></a> +<h3>__name__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>str</code> + + </dd> +<span title="'type'"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +<span class="variable-quote">'</span>type<span class="variable-quote">'</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="__weakrefoffset__"></a> +<h3>__weakrefoffset__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="184"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +184 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/epydoc.css b/docs/public/epydoc.css new file mode 100644 index 0000000..46080bd --- /dev/null +++ b/docs/public/epydoc.css @@ -0,0 +1,100 @@ + +/* Body color */ +body { background: #ffffff; color: #000000; } + +/* Tables */ +table.summary, table.details, table.index + { background: #e8f0f8; color: #000000; } +tr.summary, tr.details, tr.index + { background: #70b0f0; color: #000000; + text-align: left; font-size: 120%; } +tr.group { background: #c0e0f8; color: #000000; + text-align: left; font-size: 120%; + font-style: italic; } + +/* Documentation page titles */ +h2.module { margin-top: 0.2em; } +h2.class { margin-top: 0.2em; } + +/* Headings */ +h1.heading { font-size: +140%; font-style: italic; + font-weight: bold; } +h2.heading { font-size: +125%; font-style: italic; + font-weight: bold; } +h3.heading { font-size: +110%; font-style: italic; + font-weight: normal; } + +/* Base tree */ +pre.base-tree { font-size: 80%; margin: 0; } + +/* Details Sections */ +table.func-details { background: #e8f0f8; color: #000000; + border: 2px groove #c0d0d0; + padding: 0 1em 0 1em; margin: 0.4em 0 0 0; } +h3.func-detail { background: transparent; color: #000000; + margin: 0 0 1em 0; } + +table.var-details { background: #e8f0f8; color: #000000; + border: 2px groove #c0d0d0; + padding: 0 1em 0 1em; margin: 0.4em 0 0 0; } +h3.var-details { background: transparent; color: #000000; + margin: 0 0 1em 0; } + +/* Function signatures */ +.sig { background: transparent; color: #000000; + font-weight: bold; } +.sig-name { background: transparent; color: #006080; } +.sig-arg, .sig-kwarg, .sig-vararg + { background: transparent; color: #008060; } +.sig-default { background: transparent; color: #602000; } +.summary-sig { background: transparent; color: #000000; } +.summary-sig-name { background: transparent; color: #204080; } +.summary-sig-arg, .summary-sig-kwarg, .summary-sig-vararg + { background: transparent; color: #008060; } + +/* Doctest blocks */ +.py-src { background: transparent; color: #000000; } +.py-prompt { background: transparent; color: #005050; + font-weight: bold;} +.py-string { background: transparent; color: #006030; } +.py-comment { background: transparent; color: #003060; } +.py-keyword { background: transparent; color: #600000; } +.py-output { background: transparent; color: #404040; } +pre.doctestblock { background: #f4faff; color: #000000; + padding: .5em; margin: 1em; + border: 1px solid #708890; } +table pre.doctestblock + { background: #dce4ec; color: #000000; + padding: .5em; margin: 1em; + border: 1px solid #708890; } + +/* Variable values */ +pre.variable { background: #dce4ec; color: #000000; + padding: .5em; margin: 0; + border: 1px solid #708890; } +.variable-linewrap { background: transparent; color: #604000; } +.variable-ellipsis { background: transparent; color: #604000; } +.variable-quote { background: transparent; color: #604000; } +.re { background: transparent; color: #000000; } +.re-char { background: transparent; color: #006030; } +.re-op { background: transparent; color: #600000; } +.re-group { background: transparent; color: #003060; } +.re-ref { background: transparent; color: #404040; } + +/* Navigation bar */ +table.navbar { background: #a0c0ff; color: #0000ff; + border: 2px groove #c0d0d0; } +th.navbar { background: #a0c0ff; color: #0000ff; } +th.navselect { background: #70b0ff; color: #000000; } +.nomargin { margin: 0; } + +/* Links */ +a:link { background: transparent; color: #0000ff; } +a:visited { background: transparent; color: #204080; } +a.navbar:link { background: transparent; color: #0000ff; + text-decoration: none; } +a.navbar:visited { background: transparent; color: #204080; + text-decoration: none; } + +/* Lists */ +ul { margin-top: 0; } diff --git a/docs/public/exceptions.Exception-class.html b/docs/public/exceptions.Exception-class.html new file mode 100644 index 0000000..8e04fe7 --- /dev/null +++ b/docs/public/exceptions.Exception-class.html @@ -0,0 +1,85 @@ +<?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>exceptions.Exception</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Module exceptions :: + Class Exception + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/exceptions.Exception-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="exceptions.Exception-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class Exception</h2> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SFTPError-class.html"><code>SFTPError</code></a>, + <a href="paramiko.SSHException-class.html"><code>SSHException</code></a></dd></dl> + +<hr/> + +Common base class for all exceptions. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class="summary-sig-vararg">...</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__getitem__"></a><span class="summary-sig"><span class="summary-sig-name">__getitem__</span>(<span class="summary-sig-vararg">...</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/frames.html b/docs/public/frames.html new file mode 100644 index 0000000..77678a0 --- /dev/null +++ b/docs/public/frames.html @@ -0,0 +1,13 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"> +<html> +<head> + <title> API Documentation </title> +</head> +<frameset cols="20%,80%"> + <frameset rows="30%,70%"> + <frame src="toc.html" name="moduleListFrame"> + <frame src="toc-everything.html" name="moduleFrame"> + </frameset> + <frame src="paramiko-module.html" name="mainFrame"> +</frameset> +</html> diff --git a/docs/public/help.html b/docs/public/help.html new file mode 100644 index 0000000..99e33a2 --- /dev/null +++ b/docs/public/help.html @@ -0,0 +1,224 @@ +<?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>Help</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="paramiko-module.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 bgcolor="#70b0f0" class="navselect"> Help </th> + <th class="navbar" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/help.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="help.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<center><h2> API Documentation </h2></center> + +<p> This document contains the API (Application Programming Interface) +documentation for this project. Documentation for the Python +objects defined by the project is divided into separate pages for each +package, module, and class. The API documentation also includes two +pages containing information about the project as a whole: a trees +page, and an index page. </p> + +<h2> Object Documentation </h2> + + <p>Each <b>Package Documentation</b> page contains: + <ul> + <li> A description of the package. </li> + <li> A list of the modules and sub-packages contained by the + package. </li> + <li> A summary of the classes defined by the package. </li> + <li> A summary of the functions defined by the package. </li> + <li> A summary of the variables defined by the package. </li> + <li> A detailed description of each function defined by the + package. </li> + <li> A detailed description of each variable defined by the + package. </li> + </ul></p> + + <p>Each <b>Module Documentation</b> page contains: + <ul> + <li> A description of the module. </li> + <li> A summary of the classes defined by the module. </li> + <li> A summary of the functions defined by the module. </li> + <li> A summary of the variables defined by the module. </li> + <li> A detailed description of each function defined by the + module. </li> + <li> A detailed description of each variable defined by the + module. </li> + </ul></p> + + <p>Each <b>Class Documentation</b> page contains: + <ul> + <li> A class inheritance diagram. </li> + <li> A list of known subclasses. </li> + <li> A description of the class. </li> + <li> A summary of the methods defined by the class. </li> + <li> A summary of the instance variables defined by the class. </li> + <li> A summary of the class (static) variables defined by the + class. </li> + <li> A detailed description of each method defined by the + class. </li> + <li> A detailed description of each instance variable defined by the + class. </li> + <li> A detailed description of each class (static) variable defined + by the class. </li> + </ul></p> + +<h2> Project Documentation </h2> + + <p> The <b>Trees</b> page contains the module and class hierarchies: + <ul> + <li> The <i>module hierarchy</i> lists every package and module, with + modules grouped into packages. At the top level, and within each + package, modules and sub-packages are listed alphabetically. </li> + <li> The <i>class hierarchy</i> lists every class, grouped by base + class. If a class has more than one base class, then it will be + listed under each base class. At the top level, and under each base + class, classes are listed alphabetically. </li> + </ul></p> + + <p> The <b>Index</b> page contains indices of terms and + identifiers: + <ul> + <li> The <i>term index</i> lists every term indexed by any object's + documentation. For each term, the index provides links to each + place where the term is indexed. </li> + <li> The <i>identifier index</i> lists the (short) name of every package, + module, class, method, function, variable, and parameter. For each + identifier, the index provides a short description, and a link to + its documentation. </li> + </ul></p> + +<h2> The Table of Contents </h2> + +<p> The table of contents occupies the two frames on the left side of +the window. The upper-left frame displays the <i>project +contents</i>, and the lower-left frame displays the <i>module +contents</i>: </p> + +<center> +<table class="summary" border="1" cellspacing="0" cellpadding="3"> + <tr heigh="30%"> + <td align="center"> + <font size="-1">Project<br>Contents<hr>...</font></td> + <td align="center" rowspan="2" width="70%"> + API<br>Documentation<br>Frame<br><br><br> + </td> + </tr> + <tr> + <td align="center"> + <font size="-1">Module<br>Contents<hr> <br>...<br> </font> + </td> + </tr> +</table><br> +</center> + +<p> The <b>project contents frame</b> contains a list of all packages +and modules that are defined by the project. Clicking on an entry +will display its contents in the module contents frame. Clicking on a +special entry, labeled "Everything," will display the contents of +the entire project. </p> + +<p> The <b>module contents frame</b> contains a list of every +submodule, class, type, exception, function, and variable defined by a +module or package. Clicking on an entry will display its +documentation in the API documentation frame. Clicking on the name of +the module, at the top of the frame, will display the documentation +for the module itself. </p> + +<p> The "<b>frames</b>" and "<b>no frames</b>" buttons below the top +navigation bar can be used to control whether the table of contents is +displayed or not. </p> + +<h2> The Navigation Bar </h2> + +<p> A navigation bar is located at the top and bottom of every page. +It indicates what type of page you are currently viewing, and allows +you to go to related pages. The following table describes the labels +on the navigation bar. Note that not some labels (such as +[Parent]) are not displayed on all pages. </p> + +<table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%"> +<tr class="summary"> + <th>Label</th> + <th>Highlighted when...</th> + <th>Links to...</th> +</tr> + <tr><td valign="top"><b>[Parent]</b></td> + <td valign="top"><i>(never highlighted)</i></td> + <td valign="top"> the parent of the current package </td></tr> + <tr><td valign="top"><b>[Package]</b></td> + <td valign="top">viewing a package</td> + <td valign="top">the package containing the current object + </td></tr> + <tr><td valign="top"><b>[Module]</b></td> + <td valign="top">viewing a module</td> + <td valign="top">the module containing the current object + </td></tr> + <tr><td valign="top"><b>[Class]</b></td> + <td valign="top">viewing a class </td> + <td valign="top">the class containing the current object</td></tr> + <tr><td valign="top"><b>[Trees]</b></td> + <td valign="top">viewing the trees page</td> + <td valign="top"> the trees page </td></tr> + <tr><td valign="top"><b>[Index]</b></td> + <td valign="top">viewing the index page</td> + <td valign="top"> the index page </td></tr> + <tr><td valign="top"><b>[Help]</b></td> + <td valign="top">viewing the help page</td> + <td valign="top"> the help page </td></tr> +</table> + +<p> The "<b>show private</b>" and "<b>hide private</b>" buttons below +the top navigation bar can be used to control whether documentation +for private objects is displayed. Private objects are usually defined +as objects whose (short) names begin with a single underscore, but do +not end with an underscore. For example, "<code>_x</code>", +"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>" +are private objects; but "<code>re.sub</code>", +"<code>__init__</code>", and "<code>type_</code>" are not. However, +if a module defines the "<code>__all__</code>" variable, then its +contents are used to decide which objects are private. </p> + +<p> A timestamp below the bottom navigation bar indicates when each +page was last updated. </p> + +<!-- =========== 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="paramiko-module.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 bgcolor="#70b0f0" class="navselect"> Help </th> + <th class="navbar" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/index.html b/docs/public/index.html new file mode 100644 index 0000000..77678a0 --- /dev/null +++ b/docs/public/index.html @@ -0,0 +1,13 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"> +<html> +<head> + <title> API Documentation </title> +</head> +<frameset cols="20%,80%"> + <frameset rows="30%,70%"> + <frame src="toc.html" name="moduleListFrame"> + <frame src="toc-everything.html" name="moduleFrame"> + </frameset> + <frame src="paramiko-module.html" name="mainFrame"> +</frameset> +</html> diff --git a/docs/public/indices.html b/docs/public/indices.html new file mode 100644 index 0000000..ce1f266 --- /dev/null +++ b/docs/public/indices.html @@ -0,0 +1,803 @@ +<?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>Index</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="paramiko-module.html">Home</a> </th> + <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> + <th bgcolor="#70b0f0" class="navselect"> Index </th> + <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th> + <th class="navbar" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/indices.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="indices.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> +<br /> + +<!-- =========== START OF IDENTIFIER INDEX =========== --> +<table class="index" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="index"> + <th colspan="2">Identifier Index</th></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html"><code>object</code></a></td> + <td>Class in module <code>__builtin__</code></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__bases__"><code>__bases__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__basicsize__"><code>__basicsize__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__call__"><code>__call__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html"><code>type</code></a></td> + <td>Class in module <code>__builtin__</code></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__cmp__"><code>__cmp__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#__del__"><code>__del__</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__delattr__"><code>__delattr__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__dictoffset__"><code>__dictoffset__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__flags__"><code>__flags__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__getattribute__"><code>__getattribute__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="exceptions.Exception-class.html#__getitem__"><code>__getitem__</code></a></td> + <td>Method in class <a href="exceptions.Exception-class.html"><code>exceptions.Exception</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__hash__"><code>__hash__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#__hash__"><code>__hash__</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#__hash__"><code>__hash__</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="exceptions.Exception-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="exceptions.Exception-class.html"><code>exceptions.Exception</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Agent-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.AgentKey-class.html"><code>paramiko.AgentKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BadAuthenticationType-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.BadAuthenticationType-class.html"><code>paramiko.BadAuthenticationType</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.server.InteractiveQuery-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="paramiko.server.InteractiveQuery-class.html"><code>paramiko.server.InteractiveQuery</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#__init__"><code>__init__</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__itemsize__"><code>__itemsize__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#__iter__"><code>__iter__</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__mro__"><code>__mro__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__name__"><code>__name__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__new__"><code>__new__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__new__"><code>__new__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#__repr__"><code>__repr__</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__setattr__"><code>__setattr__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#__slots__"><code>__slots__</code></a></td> + <td>Variable in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></td></tr> + <tr><td width="15%"><a href="exceptions.Exception-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="exceptions.Exception-class.html"><code>exceptions.Exception</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.AgentKey-class.html"><code>paramiko.AgentKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BadAuthenticationType-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.BadAuthenticationType-class.html"><code>paramiko.BadAuthenticationType</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#__str__"><code>__str__</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__subclasses__"><code>__subclasses__</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#__weakrefoffset__"><code>__weakrefoffset__</code></a></td> + <td>Variable in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#accept"><code>accept</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add"><code>add</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_boolean"><code>add_boolean</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_byte"><code>add_byte</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_bytes"><code>add_bytes</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_int"><code>add_int</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_int64"><code>add_int64</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_list"><code>add_list</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_mpint"><code>add_mpint</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.server.InteractiveQuery-class.html#add_prompt"><code>add_prompt</code></a></td> + <td>Method in class <a href="paramiko.server.InteractiveQuery-class.html"><code>paramiko.server.InteractiveQuery</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#add_server_key"><code>add_server_key</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#add_string"><code>add_string</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Agent-class.html"><code>Agent</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html"><code>agent</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html"><code>AgentKey</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BadAuthenticationType-class.html#allowed_types"><code>allowed_types</code></a></td> + <td>Variable in class <a href="paramiko.BadAuthenticationType-class.html"><code>paramiko.BadAuthenticationType</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#auth_interactive"><code>auth_interactive</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#auth_none"><code>auth_none</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#auth_password"><code>auth_password</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#auth_publickey"><code>auth_publickey</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BadAuthenticationType-class.html"><code>BadAuthenticationType</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#bit_length"><code>bit_length</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#can_sign"><code>can_sign</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#can_sign"><code>can_sign</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html"><code>Channel</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#chattr"><code>chattr</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#chdir"><code>chdir</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#check"><code>check</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#chmod"><code>chmod</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#chown"><code>chown</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#ciphers"><code>ciphers</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Agent-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#close"><code>close</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_ATTRS"><code>CMD_ATTRS</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_CLOSE"><code>CMD_CLOSE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_DATA"><code>CMD_DATA</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_EXTENDED"><code>CMD_EXTENDED</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_EXTENDED_REPLY"><code>CMD_EXTENDED_REPLY</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_FSETSTAT"><code>CMD_FSETSTAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_FSTAT"><code>CMD_FSTAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_HANDLE"><code>CMD_HANDLE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_INIT"><code>CMD_INIT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_LSTAT"><code>CMD_LSTAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_MKDIR"><code>CMD_MKDIR</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_NAME"><code>CMD_NAME</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_NAMES"><code>CMD_NAMES</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_OPEN"><code>CMD_OPEN</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_OPENDIR"><code>CMD_OPENDIR</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_READ"><code>CMD_READ</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_READDIR"><code>CMD_READDIR</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_READLINK"><code>CMD_READLINK</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_REALPATH"><code>CMD_REALPATH</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_REMOVE"><code>CMD_REMOVE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_RENAME"><code>CMD_RENAME</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_RMDIR"><code>CMD_RMDIR</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_SETSTAT"><code>CMD_SETSTAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_STAT"><code>CMD_STAT</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_STATUS"><code>CMD_STATUS</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_SYMLINK"><code>CMD_SYMLINK</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_VERSION"><code>CMD_VERSION</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#CMD_WRITE"><code>CMD_WRITE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#compression"><code>compression</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#connect"><code>connect</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#convert_errno"><code>convert_errno</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#deflate_long"><code>deflate_long</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#digests"><code>digests</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html"><code>DSSKey</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.dsskey-module.html"><code>dsskey</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><code>exc_info</code></td> + <td>Function in module <code>sys</code></td></tr> + <tr><td width="15%"><a href="exceptions.Exception-class.html"><code>Exception</code></a></td> + <td>Class in module <code>exceptions</code></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#exec_command"><code>exec_command</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#file"><code>file</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.file-module.html"><code>file</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#fileno"><code>fileno</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util.PFilter-class.html#filter"><code>filter</code></a></td> + <td>Method in class <a href="paramiko.util.PFilter-class.html"><code>paramiko.util.PFilter</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#finish_subsystem"><code>finish_subsystem</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html#finish_subsystem"><code>finish_subsystem</code></a></td> + <td>Method in class <a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_AMTIME"><code>FLAG_AMTIME</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_EXTENDED"><code>FLAG_EXTENDED</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_PERMISSIONS"><code>FLAG_PERMISSIONS</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_SIZE"><code>FLAG_SIZE</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#FLAG_UIDGID"><code>FLAG_UIDGID</code></a></td> + <td>Variable in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#flush"><code>flush</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#format_binary"><code>format_binary</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#format_binary_line"><code>format_binary_line</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#format_binary_weird"><code>format_binary_weird</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html#from_stat"><code>from_stat</code></a></td> + <td>Method in class <a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#from_transport"><code>from_transport</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#generate"><code>generate</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#generate"><code>generate</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#generate_key_bytes"><code>generate_key_bytes</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#get"><code>get</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#get_bits"><code>get_bits</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#get_bits"><code>get_bits</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_boolean"><code>get_boolean</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_byte"><code>get_byte</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_bytes"><code>get_bytes</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_exception"><code>get_exception</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_hexdump"><code>get_hexdump</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#get_id"><code>get_id</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_int"><code>get_int</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_int64"><code>get_int64</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Agent-class.html#get_keys"><code>get_keys</code></a></td> + <td>Method in class <a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_list"><code>get_list</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_log_channel"><code>get_log_channel</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#get_logger"><code>get_logger</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_mpint"><code>get_mpint</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html#get_name"><code>get_name</code></a></td> + <td>Method in class <a href="paramiko.AgentKey-class.html"><code>paramiko.AgentKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#get_name"><code>get_name</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#get_name"><code>get_name</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#get_name"><code>get_name</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#get_pty"><code>get_pty</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_remainder"><code>get_remainder</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_remote_server_key"><code>get_remote_server_key</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_security_options"><code>get_security_options</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html#get_server"><code>get_server</code></a></td> + <td>Method in class <a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_server_key"><code>get_server_key</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_so_far"><code>get_so_far</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#get_string"><code>get_string</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#get_thread_id"><code>get_thread_id</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#get_transport"><code>get_transport</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#get_username"><code>get_username</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#getcwd"><code>getcwd</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#getName"><code>getName</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#gettimeout"><code>gettimeout</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#gettimeout"><code>gettimeout</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#global_request"><code>global_request</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#hexify"><code>hexify</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#inflate_long"><code>inflate_long</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.server.InteractiveQuery-class.html"><code>InteractiveQuery</code></a></td> + <td>Class in module <a href="paramiko.server-module.html"><code>paramiko.server</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#invoke_shell"><code>invoke_shell</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#invoke_subsystem"><code>invoke_subsystem</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#is_active"><code>is_active</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#is_authenticated"><code>is_authenticated</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#isAlive"><code>isAlive</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#isDaemon"><code>isDaemon</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#join"><code>join</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#kex"><code>kex</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html#key_types"><code>key_types</code></a></td> + <td>Class in module <a href="../private/paramiko.kex_group1-module.html"><code>paramiko.kex_group1</code></a> in class <a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#listdir"><code>listdir</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#listdir_attr"><code>listdir_attr</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#load_host_keys"><code>load_host_keys</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#load_server_moduli"><code>load_server_moduli</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#log_to_file"><code>log_to_file</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#lookup_ssh_host_config"><code>lookup_ssh_host_config</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#lstat"><code>lstat</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#makefile"><code>makefile</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#makefile_stderr"><code>makefile_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#MAX_REQUEST_SIZE"><code>MAX_REQUEST_SIZE</code></a></td> + <td>Variable in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html"><code>Message</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.message-module.html"><code>message</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#MIN_PACKET_SIZE"><code>MIN_PACKET_SIZE</code></a></td> + <td>Variable in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#mkdir"><code>mkdir</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#mod_inverse"><code>mod_inverse</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html#mro"><code>mro</code></a></td> + <td>Method in class <a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#next"><code>next</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#normalize"><code>normalize</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.object-class.html"><code>object</code></a></td> + <td>Class in module <code>__builtin__</code></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#open_channel"><code>open_channel</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#open_session"><code>open_session</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#open_sftp_client"><code>open_sftp_client</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko-module.html"><code>paramiko</code></a></td> + <td>Package</td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#parse_ssh_config"><code>parse_ssh_config</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.PasswordRequiredException-class.html"><code>PasswordRequiredException</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util.PFilter-class.html"><code>PFilter</code></a></td> + <td>Class in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.pkey-module.html"><code>pkey</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#prefetch"><code>prefetch</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#put"><code>put</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#read"><code>read</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#read"><code>read</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#readline"><code>readline</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#readlines"><code>readlines</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#readlink"><code>readlink</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv"><code>recv</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv_exit_status"><code>recv_exit_status</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv_ready"><code>recv_ready</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv_stderr"><code>recv_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#recv_stderr_ready"><code>recv_stderr_ready</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#remove"><code>remove</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#rename"><code>rename</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#renegotiate_keys"><code>renegotiate_keys</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#resize_pty"><code>resize_pty</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Message-class.html#rewind"><code>rewind</code></a></td> + <td>Method in class <a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#rmdir"><code>rmdir</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html"><code>RSAKey</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.rsakey-module.html"><code>rsakey</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#run"><code>run</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#run"><code>run</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#safe_string"><code>safe_string</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SecurityOptions-class.html"><code>SecurityOptions</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#seek"><code>seek</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#seek"><code>seek</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</code></a></td> + <td>Variable in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#send"><code>send</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#send_exit_status"><code>send_exit_status</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#send_ignore"><code>send_ignore</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#send_stderr"><code>send_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#sendall"><code>sendall</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#sendall_stderr"><code>sendall_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.server-module.html"><code>server</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#set_combine_stderr"><code>set_combine_stderr</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#set_file_attr"><code>set_file_attr</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#set_hexdump"><code>set_hexdump</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#set_keepalive"><code>set_keepalive</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#set_log_channel"><code>set_log_channel</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#set_name"><code>set_name</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#set_pipelined"><code>set_pipelined</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#set_subsystem_handler"><code>set_subsystem_handler</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#setblocking"><code>setblocking</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#setblocking"><code>setblocking</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#setDaemon"><code>setDaemon</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#setName"><code>setName</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#settimeout"><code>settimeout</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#settimeout"><code>settimeout</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTP-class.html"><code>SFTP</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html"><code>sftp</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_attr-module.html"><code>sftp_attr</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_BAD_MESSAGE"><code>SFTP_BAD_MESSAGE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_client-module.html"><code>sftp_client</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_CONNECTION_LOST"><code>SFTP_CONNECTION_LOST</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_DESC"><code>SFTP_DESC</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_EOF"><code>SFTP_EOF</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FAILURE"><code>SFTP_FAILURE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_file-module.html"><code>sftp_file</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_APPEND"><code>SFTP_FLAG_APPEND</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_CREATE"><code>SFTP_FLAG_CREATE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_EXCL"><code>SFTP_FLAG_EXCL</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_READ"><code>SFTP_FLAG_READ</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_TRUNC"><code>SFTP_FLAG_TRUNC</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_FLAG_WRITE"><code>SFTP_FLAG_WRITE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_handle-module.html"><code>sftp_handle</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_NO_CONNECTION"><code>SFTP_NO_CONNECTION</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_NO_SUCH_FILE"><code>SFTP_NO_SUCH_FILE</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_OK"><code>SFTP_OK</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_OP_UNSUPPORTED"><code>SFTP_OP_UNSUPPORTED</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp-module.html#SFTP_PERMISSION_DENIED"><code>SFTP_PERMISSION_DENIED</code></a></td> + <td>Variable in module <a href="paramiko.sftp-module.html"><code>paramiko.sftp</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_server-module.html"><code>sftp_server</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.sftp_si-module.html"><code>sftp_si</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPAttributes-class.html"><code>SFTPAttributes</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html"><code>SFTPClient</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPError-class.html"><code>SFTPError</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html"><code>SFTPFile</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html"><code>SFTPHandle</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html"><code>SFTPServer</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#shutdown"><code>shutdown</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#shutdown_read"><code>shutdown_read</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Channel-class.html#shutdown_write"><code>shutdown_write</code></a></td> + <td>Method in class <a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.AgentKey-class.html#sign_ssh_data"><code>sign_ssh_data</code></a></td> + <td>Method in class <a href="paramiko.AgentKey-class.html"><code>paramiko.AgentKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#sign_ssh_data"><code>sign_ssh_data</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#sign_ssh_data"><code>sign_ssh_data</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html#SSH2_AGENT_IDENTITIES_ANSWER"><code>SSH2_AGENT_IDENTITIES_ANSWER</code></a></td> + <td>Variable in module <a href="paramiko.agent-module.html"><code>paramiko.agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html#SSH2_AGENT_SIGN_RESPONSE"><code>SSH2_AGENT_SIGN_RESPONSE</code></a></td> + <td>Variable in module <a href="paramiko.agent-module.html"><code>paramiko.agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html#SSH2_AGENTC_REQUEST_IDENTITIES"><code>SSH2_AGENTC_REQUEST_IDENTITIES</code></a></td> + <td>Variable in module <a href="paramiko.agent-module.html"><code>paramiko.agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.agent-module.html#SSH2_AGENTC_SIGN_REQUEST"><code>SSH2_AGENTC_SIGN_REQUEST</code></a></td> + <td>Variable in module <a href="paramiko.agent-module.html"><code>paramiko.agent</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SSHException-class.html"><code>SSHException</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html#start"><code>start</code></a></td> + <td>Method in class <a href="threading.Thread-class.html"><code>threading.Thread</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#start_client"><code>start_client</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#start_server"><code>start_server</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPServer-class.html#start_subsystem"><code>start_subsystem</code></a></td> + <td>Method in class <a href="paramiko.SFTPServer-class.html"><code>paramiko.SFTPServer</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html#start_subsystem"><code>start_subsystem</code></a></td> + <td>Method in class <a href="paramiko.SubsystemHandler-class.html"><code>paramiko.SubsystemHandler</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#stat"><code>stat</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPFile-class.html#stat"><code>stat</code></a></td> + <td>Method in class <a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#stat"><code>stat</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#stop_thread"><code>stop_thread</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SubsystemHandler-class.html"><code>SubsystemHandler</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#symlink"><code>symlink</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#tb_strings"><code>tb_strings</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#tell"><code>tell</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="threading.Thread-class.html"><code>Thread</code></a></td> + <td>Class in module <code>threading</code></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html"><code>Transport</code></a></td> + <td>Class in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.transport-module.html"><code>transport</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="__builtin__.type-class.html"><code>type</code></a></td> + <td>Class in module <code>__builtin__</code></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html#unhexify"><code>unhexify</code></a></td> + <td>Function in module <a href="paramiko.util-module.html"><code>paramiko.util</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.Transport-class.html#use_compression"><code>use_compression</code></a></td> + <td>Method in class <a href="paramiko.Transport-class.html"><code>paramiko.Transport</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.util-module.html"><code>util</code></a></td> + <td>Module in package <a href="paramiko-module.html"><code>paramiko</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPClient-class.html#utime"><code>utime</code></a></td> + <td>Method in class <a href="paramiko.SFTPClient-class.html"><code>paramiko.SFTPClient</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#verify_ssh_sig"><code>verify_ssh_sig</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#verify_ssh_sig"><code>verify_ssh_sig</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#write"><code>write</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.SFTPHandle-class.html#write"><code>write</code></a></td> + <td>Method in class <a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.DSSKey-class.html#write_private_key_file"><code>write_private_key_file</code></a></td> + <td>Method in class <a href="paramiko.DSSKey-class.html"><code>paramiko.DSSKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.RSAKey-class.html#write_private_key_file"><code>write_private_key_file</code></a></td> + <td>Method in class <a href="paramiko.RSAKey-class.html"><code>paramiko.RSAKey</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#writelines"><code>writelines</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></td></tr> + <tr><td width="15%"><a href="paramiko.BufferedFile-class.html#xreadlines"><code>xreadlines</code></a></td> + <td>Method in class <a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></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="paramiko-module.html">Home</a> </th> + <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> + <th bgcolor="#70b0f0" class="navselect"> Index </th> + <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th> + <th class="navbar" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko-module.html b/docs/public/paramiko-module.html new file mode 100644 index 0000000..15da9ab --- /dev/null +++ b/docs/public/paramiko-module.html @@ -0,0 +1,229 @@ +<?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>paramiko</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 bgcolor="#70b0f0" class="navselect"> Home </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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Package paramiko + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF PACKAGE DESCRIPTION =========== --> +<h2 class="package">Package paramiko</h2> + +<p><i>Paramiko</i> (a combination of the esperanto words for +"paranoid" and "friend") is a module for python 2.3 +or greater that implements the SSH2 protocol for secure (encrypted and +authenticated) connections to remote machines. Unlike SSL (aka TLS), the +SSH2 protocol does not require heirarchical certificates signed by a +powerful central authority. You may know SSH2 as the protocol that +replaced <code>telnet</code> and <code>rsh</code> for secure access to +remote shells, but the protocol also includes the ability to open +arbitrary channels to remote services across an encrypted tunnel. (This +is how <code>sftp</code> works, for example.)</p> +<p>To use this package, pass a socket (or socket-like object) to a <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>, and use <a +href="paramiko.Transport-class.html#start_server" +class="link"><code>start_server</code></a> or <a +href="paramiko.Transport-class.html#start_client" +class="link"><code>start_client</code></a> to negoatite with the remote +host as either a server or client. As a client, you are responsible for +authenticating using a password or private key, and checking the server's +host key. <i>(Key signature and verification is done by paramiko, but you +will need to provide private keys and check that the content of a public +key matches what you expected to see.)</i> As a server, you are +responsible for deciding which users, passwords, and keys to allow, and +what kind of channels to allow.</p> +<p>Once you have finished, either side may request flow-controlled <a +href="paramiko.Channel-class.html" class="link"><code>Channel</code></a>s +to the other side, which are python objects that act like sockets, but +send and receive data over the encrypted session.</p> +<p>Paramiko is written entirely in python (no C or platform-dependent +code) and is released under the GNU Lesser General Public License +(LGPL).</p> +Website: <a +href="http://www.lag.net/paramiko/">http://www.lag.net/paramiko/</a> +<hr/> +<p><b>Version:</b> 1.5.2 (rhydon) +</p> + +<p><b>Author:</b> Robey Pointer +</p> + +<p><b>Contact:</b> robey@lag.net +</p> + +<p><b>License:</b> GNU Lesser General Public License (LGPL) +</p> + + +<!-- =========== START OF SUBMODULES =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Submodules</th></tr> + <tr><td><ul> +<li> <b><a href="paramiko.agent-module.html"><code>agent</code></a></b>: <i>SSH Agent interface for Unix clients.</i> +<li> <b><a href="paramiko.dsskey-module.html"><code>dsskey</code></a></b>: <i><a href="paramiko.DSSKey-class.html" +class="link"><code>DSSKey</code></a></i> +<li> <b><a href="paramiko.file-module.html"><code>file</code></a></b>: <i>BufferedFile.</i> +<li> <b><a href="paramiko.message-module.html"><code>message</code></a></b>: <i>Implementation of an SSH2 "message".</i> +<li> <b><a href="paramiko.pkey-module.html"><code>pkey</code></a></b>: <i>Common API for all public keys.</i> +<li> <b><a href="paramiko.rsakey-module.html"><code>rsakey</code></a></b>: <i><a href="paramiko.RSAKey-class.html" +class="link"><code>RSAKey</code></a></i> +<li> <b><a href="paramiko.server-module.html"><code>server</code></a></b>: <i><a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> is an interface to override +for server support.</i> +<li> <b><a href="paramiko.sftp-module.html"><code>sftp</code></a></b> +<li> <b><a href="paramiko.sftp_attr-module.html"><code>sftp_attr</code></a></b> +<li> <b><a href="paramiko.sftp_client-module.html"><code>sftp_client</code></a></b>: <i>Client-mode SFTP support.</i> +<li> <b><a href="paramiko.sftp_file-module.html"><code>sftp_file</code></a></b>: <i><a href="paramiko.SFTPFile-class.html" +class="link"><code>SFTPFile</code></a></i> +<li> <b><a href="paramiko.sftp_handle-module.html"><code>sftp_handle</code></a></b>: <i>Abstraction of an SFTP file handle (for server mode).</i> +<li> <b><a href="paramiko.sftp_server-module.html"><code>sftp_server</code></a></b>: <i>Server-mode SFTP support.</i> +<li> <b><a href="paramiko.sftp_si-module.html"><code>sftp_si</code></a></b>: <i><a href="../private/paramiko.SFTPServerInterface-class.html" +class="link"><code>SFTPServerInterface</code></a> is an interface to +override for SFTP server support.</i> +<li> <b><a href="paramiko.transport-module.html"><code>transport</code></a></b>: <i><a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> handles the core SSH2 +protocol.</i> +<li> <b><a href="paramiko.util-module.html"><code>util</code></a></b>: <i>Useful functions used by the rest of paramiko.</i> + </ul></td></tr> +</table><br /> + + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="paramiko.Agent-class.html"><code>Agent</code></a></b></td> + <td>Client interface for using private keys from an SSH agent running on +the local machine.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.AgentKey-class.html"><code>AgentKey</code></a></b></td> + <td>Private key held in a local SSH agent.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a></b></td> + <td>Reusable base class to implement python-style file buffering around a +simpler stream.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.Channel-class.html"><code>Channel</code></a></b></td> + <td>A secure tunnel across an SSH <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.DSSKey-class.html"><code>DSSKey</code></a></b></td> + <td>Representation of a DSS key which can be used to sign an verify SSH2 +data.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.Message-class.html"><code>Message</code></a></b></td> + <td>An SSH2 <i>Message</i> is a stream of bytes that encodes some +combination of strings, integers, bools, and infinite-precision integers +(known in python as <i>long</i>s).</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.RSAKey-class.html"><code>RSAKey</code></a></b></td> + <td>Representation of an RSA key which can be used to sign and verify SSH2 +data.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SecurityOptions-class.html"><code>SecurityOptions</code></a></b></td> + <td>Simple object containing the security preferences of an ssh +transport.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTP-class.html"><code>SFTP</code></a></b></td> + <td>an alias for <a href="paramiko.SFTPClient-class.html" +class="link"><code>SFTPClient</code></a> for backwards compatability</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPAttributes-class.html"><code>SFTPAttributes</code></a></b></td> + <td>Representation of the attributes of a file (or proxied file) for SFTP +in client or server mode.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPClient-class.html"><code>SFTPClient</code></a></b></td> + <td>SFTP client object.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPFile-class.html"><code>SFTPFile</code></a></b></td> + <td>Proxy object for a file on the remote server, in client mode SFTP.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPHandle-class.html"><code>SFTPHandle</code></a></b></td> + <td>Abstract object representing a handle to an open file (or folder) in +an SFTP server implementation.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPServer-class.html"><code>SFTPServer</code></a></b></td> + <td>Server-side SFTP subsystem support.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SubsystemHandler-class.html"><code>SubsystemHandler</code></a></b></td> + <td>Handler for a subsytem in server mode.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.Transport-class.html"><code>Transport</code></a></b></td> + <td>An SSH Transport attaches to a stream (usually a socket), negotiates +an encrypted session, authenticates, and then creates stream tunnels, +called <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>s, across the session.</td></tr> +</table><br /> + + +<!-- =========== START OF EXCEPTIONS =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Exceptions</th></tr> +<tr><td width="15%"> + <b><a href="paramiko.BadAuthenticationType-class.html"><code>BadAuthenticationType</code></a></b></td> + <td>Exception raised when an authentication type (like password) is used, +but the server isn't allowing that type.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.PasswordRequiredException-class.html"><code>PasswordRequiredException</code></a></b></td> + <td>Exception raised when a password is needed to unlock a private key +file.</td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SFTPError-class.html"><code>SFTPError</code></a></b></td> + <td> </td></tr> +<tr><td width="15%"> + <b><a href="paramiko.SSHException-class.html"><code>SSHException</code></a></b></td> + <td>Exception raised by failures in SSH2 protocol negotiation or logic +errors.</td></tr> +</table><br /> + + +<!-- =========== START OF NAVBAR =========== --> +<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> + <tr valign="center"> + <th bgcolor="#70b0f0" class="navselect"> Home </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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.Agent-class.html b/docs/public/paramiko.Agent-class.html new file mode 100644 index 0000000..144efdf --- /dev/null +++ b/docs/public/paramiko.Agent-class.html @@ -0,0 +1,147 @@ +<?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>paramiko.Agent</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Agent + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.Agent-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Agent-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class Agent</h2> + +<hr/> + +<p>Client interface for using private keys from an SSH agent running on +the local machine. If an SSH agent is running, this class can be used to +connect to it and retreive <a href="../private/paramiko.PKey-class.html" +class="link"><code>PKey</code></a> objects which can be used when +attempting to authenticate to remote SSH servers.</p> +Because the SSH agent protocol uses environment variables and +unix-domain sockets, this probably doesn't work on Windows. It does work +on most posix platforms though (Linux and MacOS X, for example). +<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="paramiko.Agent-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Open a session with the local machine's SSH agent, if one is +running.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Agent-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the SSH agent connection.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> tuple of <a href="paramiko.AgentKey-class.html" + class="link"><code>AgentKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Agent-class.html#get_keys" class="summary-sig-name"><code>get_keys</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the list of keys available through the SSH agent, if any.</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> + <br /><i>(Constructor)</i> + </h3> + Open a session with the local machine's SSH agent, if one is + running. If no agent is running, initialization will succeed, but <a + href="paramiko.Agent-class.html#get_keys" + class="link"><code>get_keys</code></a> will return an empty tuple. + <dl><dt></dt><dd> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if an SSH agent is found, but speaks an incompatible + protocol + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close the SSH agent connection. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="get_keys"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_keys</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the list of keys available through the SSH agent, if any. If + no SSH agent was running (or it couldn't be contacted), an empty list + will be returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a list of keys available on the SSH agent + <br /><i> + (type=tuple of <a href="paramiko.AgentKey-class.html" + class="link"><code>AgentKey</code></a>)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.AgentKey-class.html b/docs/public/paramiko.AgentKey-class.html new file mode 100644 index 0000000..203e0f4 --- /dev/null +++ b/docs/public/paramiko.AgentKey-class.html @@ -0,0 +1,236 @@ +<?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>paramiko.AgentKey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class AgentKey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.AgentKey-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.AgentKey-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type AgentKey</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.PKey-class.html"><code>PKey</code></a> --+ + | + <b>AgentKey</b> +</pre><br /> + +<hr/> + +Private key held in a local SSH agent. This type of key can be used +for authenticating to a remote server (signing). Most other key +operations work as expected. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>agent</span>, + <span class=summary-sig-arg>blob</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.AgentKey-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string of an SSH <a href="paramiko.Message-class.html" +class="link"><code>Message</code></a> made up of the public part(s) of +this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.AgentKey-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the name of this private key implementation.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.AgentKey-class.html#sign_ssh_data" class="summary-sig-name"><code>sign_ssh_data</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>randpool</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Sign a blob of data with this private key, and return a <a +href="paramiko.Message-class.html" class="link"><code>Message</code></a> +representing an SSH signature message.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance Method Details</th></tr> +</table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return a string of an SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> made up of the public part(s) of + this key. This string is suitable for passing to <a + href="../private/paramiko.PKey-class.html#__init__" + class="link"><code>__init__</code></a> to re-create the key object + later. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string representation of an SSH key message. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__str__"><code>paramiko.PKey.__str__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the name of this private key implementation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + name of this private key type, in SSH terminology (for + example, <code>"ssh-rsa"</code>). + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_name"><code>paramiko.PKey.get_name</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="sign_ssh_data"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">sign_ssh_data</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>randpool</span>, + <span class=sig-arg>data</span>)</span> + </h3> + Sign a blob of data with this private key, and return a <a + href="paramiko.Message-class.html" + class="link"><code>Message</code></a> representing an SSH signature + message. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>randpool</b></code> - + a secure random number generator. + <br /><i> + (type=<code>Crypto.Util.randpool.RandomPool</code>)</i> + <dd><code><b>data</b></code> - + the data to sign. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SSH signature message. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#sign_ssh_data"><code>paramiko.PKey.sign_ssh_data</code></a> <i>(inherited documentation)</i> +</dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.BadAuthenticationType-class.html b/docs/public/paramiko.BadAuthenticationType-class.html new file mode 100644 index 0000000..27659ed --- /dev/null +++ b/docs/public/paramiko.BadAuthenticationType-class.html @@ -0,0 +1,141 @@ +<?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>paramiko.BadAuthenticationType</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class BadAuthenticationType + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.BadAuthenticationType-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.BadAuthenticationType-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class BadAuthenticationType</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <a href="paramiko.SSHException-class.html"><code>SSHException</code></a> --+ + | + <b>BadAuthenticationType</b> +</pre><br /> + +<hr/> + +Exception raised when an authentication type (like password) is used, +but the server isn't allowing that type. (It may only allow public-key, +for example.) +<hr/> + +<p><b>Since:</b> 1.1 +</p> + + +<!-- =========== 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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>explanation</span>, + <span class=summary-sig-arg>types</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Instance Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1">list</font></td> +<td><b><a href="paramiko.BadAuthenticationType-class.html#allowed_types"><code>allowed_types</code></a></b>: list of allowed authentication types provided by the server (possible +values are: <code>"none"</code>, +<code>"password"</code>, and +<code>"publickey"</code>).</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="allowed_types"></a> +<h3>allowed_types</h3> +list of allowed authentication types provided by the server (possible +values are: <code>"none"</code>, +<code>"password"</code>, and +<code>"publickey"</code>). +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + list + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.BufferedFile-class.html b/docs/public/paramiko.BufferedFile-class.html new file mode 100644 index 0000000..535c74f --- /dev/null +++ b/docs/public/paramiko.BufferedFile-class.html @@ -0,0 +1,554 @@ +<?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>paramiko.BufferedFile</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class BufferedFile + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.BufferedFile-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.BufferedFile-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type BufferedFile</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>BufferedFile</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SFTPFile-class.html"><code>SFTPFile</code></a></dd></dl> + +<hr/> + +Reusable base class to implement python-style file buffering around a +simpler stream. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</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><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns an iterator that can be used to iterate over the lines in this +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#flush" class="summary-sig-name"><code>flush</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Write out any data in the write buffer.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#next" class="summary-sig-name"><code>next</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the next line from the input, or raises +<code>StopIteration</code> when EOF is hit.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read at most <code>size</code> bytes from the file (less if we hit the +end of the file first).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readline" class="summary-sig-name"><code>readline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read one entire line from the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readlines" class="summary-sig-name"><code>readlines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sizehint</span>)</span></code> +<br /> +Read all remaining lines using <a +href="paramiko.BufferedFile-class.html#readline" +class="link"><code>readline</code></a> and return them as a list.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#seek" class="summary-sig-name"><code>seek</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>whence</span>)</span></code> +<br /> +Set the file's current position, like stdio's <code>fseek</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#tell" class="summary-sig-name"><code>tell</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the file's current position.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Write data to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#writelines" class="summary-sig-name"><code>writelines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sequence</span>)</span></code> +<br /> +Write a sequence of strings to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#xreadlines" class="summary-sig-name"><code>xreadlines</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Identical to <code>iter(f)</code>.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</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="__iter__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__iter__</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns an iterator that can be used to iterate over the lines in + this file. This iterator happens to return the file itself, since a + file is its own iterator. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an interator. + <br /><i> + (type=iterator)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>ValueError</b></code> - + if the file is closed. + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close the file. Future read and write operations will fail. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="flush"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">flush</span>(<span class=sig-arg>self</span>)</span> + </h3> + Write out any data in the write buffer. This may do nothing if write + buffering is not turned on. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="next"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">next</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns the next line from the input, or raises + <code>StopIteration</code> when EOF is hit. Unlike python file objects, + it's okay to mix calls to <code>next</code> and <a + href="paramiko.BufferedFile-class.html#readline" + class="link"><code>readline</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a line read from the file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>StopIteration</b></code> - + when the end of the file is reached. + </dl> + </dd></dl> +</td></tr></table> + +<a name="read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">read</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>size</span>=<span class=sig-default>None</span>)</span> + </h3> + Read at most <code>size</code> bytes from the file (less if we hit + the end of the file first). If the <code>size</code> argument is + negative or omitted, read all the remaining data in the file. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>size</b></code> - + maximum number of bytes to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + data read from the file, or an empty string if EOF was + encountered immediately. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="readline"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">readline</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>size</span>=<span class=sig-default>None</span>)</span> + </h3> + Read one entire line from the file. A trailing newline character is + kept in the string (but may be absent when a file ends with an + incomplete line). If the size argument is present and non-negative, it + is a maximum byte count (including the trailing newline) and an + incomplete line may be returned. An empty string is returned only when + EOF is encountered immediately. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>size</b></code> - + maximum length of returned string. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + next line of the file, or an empty string if the end of the + file has been reached. + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Note:</b> Unlike stdio's <code>fgets()</code>, the returned string contains null +characters (<code>'\0'</code>) if they occurred in the input. +</p> + + </dd></dl> +</td></tr></table> + +<a name="readlines"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">readlines</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>sizehint</span>=<span class=sig-default>None</span>)</span> + </h3> + Read all remaining lines using <a + href="paramiko.BufferedFile-class.html#readline" + class="link"><code>readline</code></a> and return them as a list. If + the optional <code>sizehint</code> argument is present, instead of + reading up to EOF, whole lines totalling approximately sizehint bytes + (possibly after rounding up to an internal buffer size) are read. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>sizehint</b></code> - + desired maximum number of bytes to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of lines read from the file. + <br /><i> + (type=list)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="seek"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">seek</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>offset</span>, + <span class=sig-arg>whence</span>=<span class=sig-default>0</span>)</span> + </h3> + Set the file's current position, like stdio's <code>fseek</code>. + Not all file objects support seeking. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>offset</b></code> - + position to move to within the file, relative to + <code>whence</code>. + <br /><i> + (type=int)</i> + <dd><code><b>whence</b></code> - + type of movement: 0 = absolute; 1 = relative to the current + position; 2 = relative to the end of the file. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the file doesn't support random access. + </dl> +<p><b>Note:</b> If a file is opened in append mode (<code>'a'</code> or +<code>'a+'</code>), any seek operations will be undone at the next write +(as the file position will move back to the end of the file). +</p> + + </dd></dl> +</td></tr></table> + +<a name="tell"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">tell</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the file's current position. This may not be accurate or + useful if the underlying file doesn't support random access, or was + opened in append mode. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + file position (in bytes). + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">write</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>)</span> + </h3> + Write data to the file. If write buffering is on + (<code>bufsize</code> was specified and non-zero), some or all of the + data may not actually be written yet. (Use <a + href="paramiko.BufferedFile-class.html#flush" + class="link"><code>flush</code></a> or <a + href="paramiko.BufferedFile-class.html#close" + class="link"><code>close</code></a> to force buffered data to be + written out.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>data</b></code> - + data to write. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="writelines"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">writelines</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>sequence</span>)</span> + </h3> + Write a sequence of strings to the file. The sequence can be any + iterable object producing strings, typically a list of strings. (The + name is intended to match <a + href="paramiko.BufferedFile-class.html#readlines" + class="link"><code>readlines</code></a>; <code>writelines</code> does + not add line separators.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>sequence</b></code> - + an iterable sequence of strings. + <br /><i> + (type=sequence)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="xreadlines"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">xreadlines</span>(<span class=sig-arg>self</span>)</span> + </h3> + Identical to <code>iter(f)</code>. This is a deprecated file + interface that predates python iterator support. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an iterator. + <br /><i> + (type=iterator)</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="SEEK_CUR"></a> +<h3>SEEK_CUR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SEEK_END"></a> +<h3>SEEK_END</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SEEK_SET"></a> +<h3>SEEK_SET</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.Channel-class.html b/docs/public/paramiko.Channel-class.html new file mode 100644 index 0000000..89bff06 --- /dev/null +++ b/docs/public/paramiko.Channel-class.html @@ -0,0 +1,1241 @@ +<?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>paramiko.Channel</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Channel + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.Channel-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Channel-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Channel</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>Channel</b> +</pre><br /> + +<hr/> + +<p>A secure tunnel across an SSH <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>. A Channel is meant to behave +like a socket, and has an API that should be indistinguishable from the +python socket API.</p> +Because SSH2 has a windowing kind of flow control, if you stop reading +data from a Channel and its buffer fills up, the server will be unable to +send you any more data until you read some of it. (This won't affect +other channels on the same transport -- all channels on a single +transport are flow-controlled independently.) Similarly, if the server +isn't reading data you send, calls to <a +href="paramiko.Channel-class.html#send" +class="link"><code>send</code></a> may block, unless you set a timeout. +This is exactly like a normal network socket, so it shouldn't be too +surprising. +<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="paramiko.Channel-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>chanid</span>)</span></code> +<br /> +Create a new channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string representation of this object, for debugging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#exec_command" class="summary-sig-name"><code>exec_command</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>command</span>)</span></code> +<br /> +Execute a command on the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#fileno" class="summary-sig-name"><code>fileno</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns an OS-level file descriptor which can be used for polling, but +but <i>not</i> for reading or writing).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#get_id" class="summary-sig-name"><code>get_id</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the ID # for this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Get the name of this channel that was previously set by <a +href="paramiko.Channel-class.html#set_name" +class="link"><code>set_name</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#get_pty" class="summary-sig-name"><code>get_pty</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>term</span>, + <span class=summary-sig-arg>width</span>, + <span class=summary-sig-arg>height</span>)</span></code> +<br /> +Request a pseudo-terminal from the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#get_transport" class="summary-sig-name"><code>get_transport</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> associated with this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> float +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#gettimeout" class="summary-sig-name"><code>gettimeout</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the timeout in seconds (as a float) associated with socket +operations, or <code>None</code> if no timeout is set.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#invoke_shell" class="summary-sig-name"><code>invoke_shell</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Request an interactive shell session on this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#invoke_subsystem" class="summary-sig-name"><code>invoke_subsystem</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>subsystem</span>)</span></code> +<br /> +Request a subsystem on the server (for example, +<code>sftp</code>).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.ChannelFile-class.html" + class="link"><code>ChannelFile</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#makefile" class="summary-sig-name"><code>makefile</code></a>(<span class=summary-sig-arg>self</span>, + <span class="summary-sig-vararg">*params</span>)</span></code> +<br /> +Return a file-like object associated with this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.ChannelFile-class.html" + class="link"><code>ChannelFile</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#makefile_stderr" class="summary-sig-name"><code>makefile_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class="summary-sig-vararg">*params</span>)</span></code> +<br /> +Return a file-like object associated with this channel's stderr +stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv" class="summary-sig-name"><code>recv</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>nbytes</span>)</span></code> +<br /> +Receive data from the channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_exit_status" class="summary-sig-name"><code>recv_exit_status</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the exit status from the process on the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_ready" class="summary-sig-name"><code>recv_ready</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns true if data is buffered and ready to be read from this +channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_stderr" class="summary-sig-name"><code>recv_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>nbytes</span>)</span></code> +<br /> +Receive data from the channel's stderr stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#recv_stderr_ready" class="summary-sig-name"><code>recv_stderr_ready</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns true if data is buffered and ready to be read from this +channel's stderr stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#resize_pty" class="summary-sig-name"><code>resize_pty</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>width</span>, + <span class=summary-sig-arg>height</span>)</span></code> +<br /> +Resize the pseudo-terminal.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#send" class="summary-sig-name"><code>send</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Send data to the channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#send_exit_status" class="summary-sig-name"><code>send_exit_status</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>status</span>)</span></code> +<br /> +Send the exit status of an executed command to the client.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#send_stderr" class="summary-sig-name"><code>send_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Send data to the channel on the "stderr" stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#sendall" class="summary-sig-name"><code>sendall</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Send data to the channel, without allowing partial results.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#sendall_stderr" class="summary-sig-name"><code>sendall_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Send data to the channel's "stderr" stream, without allowing +partial results.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#set_combine_stderr" class="summary-sig-name"><code>set_combine_stderr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>combine</span>)</span></code> +<br /> +Set whether stderr should be combined into stdout on this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#set_name" class="summary-sig-name"><code>set_name</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>)</span></code> +<br /> +Set a name for this channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#setblocking" class="summary-sig-name"><code>setblocking</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>blocking</span>)</span></code> +<br /> +Set blocking or non-blocking mode of the channel: if +<code>blocking</code> is 0, the channel is set to non-blocking mode; +otherwise it's set to blocking mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#settimeout" class="summary-sig-name"><code>settimeout</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +<br /> +Set a timeout on blocking read/write operations.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#shutdown" class="summary-sig-name"><code>shutdown</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>how</span>)</span></code> +<br /> +Shut down one or both halves of the connection.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#shutdown_read" class="summary-sig-name"><code>shutdown_read</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Shutdown the receiving side of this socket, closing the stream in the +incoming direction.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Channel-class.html#shutdown_write" class="summary-sig-name"><code>shutdown_write</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Shutdown the sending side of this socket, closing the stream in the +outgoing direction.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>int</code></font></td> +<td><b><a href="paramiko.Channel-class.html#MIN_PACKET_SIZE"><code>MIN_PACKET_SIZE</code></a></b> = <span title="1024">1024 </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>chanid</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new channel. The channel is not associated with any + particular session or <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> until the Transport attaches + it. Normally you would only call this method from the constructor of a + subclass of <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>chanid</b></code> - + the ID of this channel, as passed by an existing <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + Return a string representation of this object, for debugging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + str + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close the channel. All future read/write operations on the channel + will fail. The remote end will receive no more data (after queued data + is flushed). Channels are automatically closed when their <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> is closed or when they are + garbage collected. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="exec_command"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">exec_command</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>command</span>)</span> + </h3> + <p>Execute a command on the server. If the server allows it, the + channel will then be directly connected to the stdin, stdout, and + stderr of the command being executed.</p> + When the command finishes executing, the channel will be closed and + can't be reused. You must open a new channel if you wish to execute + another command. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>command</b></code> - + a shell command to execute. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="fileno"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">fileno</span>(<span class=sig-arg>self</span>)</span> + </h3> + <p>Returns an OS-level file descriptor which can be used for polling, + but but <i>not</i> for reading or writing). This is primaily to allow + python's <code>select</code> module to work.</p> + The first time <code>fileno</code> is called on a channel, a pipe is + created to simulate real OS-level file descriptor (FD) behavior. + Because of this, two OS-level FDs are created, which will use up FDs + faster than normal. You won't notice this effect unless you open + hundreds or thousands of channels simultaneously, but it's still + notable. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an OS-level file descriptor + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Warning:</b> This method causes channel reads to be slightly less efficient. +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_id"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_id</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the ID # for this channel. The channel ID is unique across a + <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> and usually a small number. + It's also the number passed to <a + href="../private/paramiko.ServerInterface-class.html#check_channel_request" + class="link"><code>ServerInterface.check_channel_request</code></a> + when determining whether to accept a channel request in server + mode. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the ID of this channel. + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> ivysaur +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Get the name of this channel that was previously set by <a + href="paramiko.Channel-class.html#set_name" + class="link"><code>set_name</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the name of this channel. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_pty"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_pty</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>term</span>=<span class=sig-default>'vt100'</span>, + <span class=sig-arg>width</span>=<span class=sig-default>80</span>, + <span class=sig-arg>height</span>=<span class=sig-default>24</span>)</span> + </h3> + Request a pseudo-terminal from the server. This is usually used + right after creating a client channel, to ask the server to provide + some basic terminal semantics for a shell invoked with <a + href="paramiko.Channel-class.html#invoke_shell" + class="link"><code>invoke_shell</code></a>. It isn't necessary (or + desirable) to call this method if you're going to exectue a single + command with <a href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>term</b></code> - + the terminal type to emulate (for example, + <code>'vt100'</code>). + <br /><i> + (type=str)</i> + <dd><code><b>width</b></code> - + width (in characters) of the terminal screen + <br /><i> + (type=int)</i> + <dd><code><b>height</b></code> - + height (in characters) of the terminal screen + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_transport"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_transport</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> associated with this + channel. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> that was used to create + this channel. + <br /><i> + (type=<a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="gettimeout"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">gettimeout</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns the timeout in seconds (as a float) associated with socket + operations, or <code>None</code> if no timeout is set. This reflects + the last call to <a href="paramiko.Channel-class.html#setblocking" + class="link"><code>setblocking</code></a> or <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + timeout in seconds, or <code>None</code>. + <br /><i> + (type=float)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="invoke_shell"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">invoke_shell</span>(<span class=sig-arg>self</span>)</span> + </h3> + <p>Request an interactive shell session on this channel. If the server + allows it, the channel will then be directly connected to the stdin, + stdout, and stderr of the shell.</p> + <p>Normally you would call <a + href="paramiko.Channel-class.html#get_pty" + class="link"><code>get_pty</code></a> before this, in which case the + shell will operate through the pty, and the channel will be connected + to the stdin and stdout of the pty.</p> + When the shell exits, the channel will be closed and can't be + reused. You must open a new channel if you wish to open another + shell. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="invoke_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">invoke_subsystem</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>subsystem</span>)</span> + </h3> + <p>Request a subsystem on the server (for example, <code>sftp</code>). + If the server allows it, the channel will then be directly connected to + the requested subsystem.</p> + When the subsystem finishes, the channel will be closed and can't be + reused. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>subsystem</b></code> - + name of the subsystem being requested. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="makefile"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">makefile</span>(<span class=sig-arg>self</span>, + <span class="sig-vararg">*params</span>)</span> + </h3> + Return a file-like object associated with this channel. The optional + <code>mode</code> and <code>bufsize</code> arguments are interpreted + the same way as by the built-in <code>file()</code> function in + python. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + object which can be used for python file I/O. + <br /><i> + (type=<a href="../private/paramiko.ChannelFile-class.html" + class="link"><code>ChannelFile</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="makefile_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">makefile_stderr</span>(<span class=sig-arg>self</span>, + <span class="sig-vararg">*params</span>)</span> + </h3> + <p>Return a file-like object associated with this channel's stderr + stream. Only channels using <a + href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a> or <a + href="paramiko.Channel-class.html#invoke_shell" + class="link"><code>invoke_shell</code></a> without a pty will ever have + data on the stderr stream.</p> + The optional <code>mode</code> and <code>bufsize</code> arguments + are interpreted the same way as by the built-in <code>file()</code> + function in python. For a client, it only makes sense to open this file + for reading. For a server, it only makes sense to open this file for + writing. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + object which can be used for python file I/O. + <br /><i> + (type=<a href="../private/paramiko.ChannelFile-class.html" + class="link"><code>ChannelFile</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="recv"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>nbytes</span>)</span> + </h3> + Receive data from the channel. The return value is a string + representing the data received. The maximum amount of data to be + received at once is specified by <code>nbytes</code>. If a string of + length zero is returned, the channel stream has closed. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>nbytes</b></code> - + maximum number of bytes to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + data. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if no data is ready before the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + </dl> + </dd></dl> +</td></tr></table> + +<a name="recv_exit_status"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv_exit_status</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the exit status from the process on the server. This is + mostly useful for retrieving the reults of an <a + href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a>. If the command hasn't + finished yet, this method will wait until it does, or until the channel + is closed. If no exit status is provided by the server, -1 is + returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the exit code of the process on the server. + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="recv_ready"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv_ready</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns true if data is buffered and ready to be read from this + channel. A <code>False</code> result does not mean that the channel has + closed; it means you may need to wait before more data arrives. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if a <a + href="paramiko.Channel-class.html#recv" + class="link"><code>recv</code></a> call on this channel would + immediately return at least one byte; <code>False</code> + otherwise. + <br /><i> + (type=boolean)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="recv_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv_stderr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>nbytes</span>)</span> + </h3> + Receive data from the channel's stderr stream. Only channels using + <a href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a> or <a + href="paramiko.Channel-class.html#invoke_shell" + class="link"><code>invoke_shell</code></a> without a pty will ever have + data on the stderr stream. The return value is a string representing + the data received. The maximum amount of data to be received at once is + specified by <code>nbytes</code>. If a string of length zero is + returned, the channel stream has closed. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>nbytes</b></code> - + maximum number of bytes to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + data. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if no data is ready before the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="recv_stderr_ready"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">recv_stderr_ready</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns true if data is buffered and ready to be read from this + channel's stderr stream. Only channels using <a + href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a> or <a + href="paramiko.Channel-class.html#invoke_shell" + class="link"><code>invoke_shell</code></a> without a pty will ever have + data on the stderr stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if a <a + href="paramiko.Channel-class.html#recv_stderr" + class="link"><code>recv_stderr</code></a> call on this channel + would immediately return at least one byte; <code>False</code> + otherwise. + <br /><i> + (type=boolean)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="resize_pty"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">resize_pty</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>width</span>=<span class=sig-default>80</span>, + <span class=sig-arg>height</span>=<span class=sig-default>24</span>)</span> + </h3> + Resize the pseudo-terminal. This can be used to change the width and + height of the terminal emulation created in a previous <a + href="paramiko.Channel-class.html#get_pty" + class="link"><code>get_pty</code></a> call. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>width</b></code> - + new width (in characters) of the terminal screen + <br /><i> + (type=int)</i> + <dd><code><b>height</b></code> - + new height (in characters) of the terminal screen + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the operation succeeded; + <code>False</code> if not. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="send"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">send</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Send data to the channel. Returns the number of bytes sent, or 0 if + the channel stream is closed. Applications are responsible for checking + that all data has been sent: if only some of the data was transmitted, + the application needs to attempt delivery of the remaining data. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + data to send. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + number of bytes actually sent. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if no data could be sent before the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + </dl> + </dd></dl> +</td></tr></table> + +<a name="send_exit_status"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">send_exit_status</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>status</span>)</span> + </h3> + Send the exit status of an executed command to the client. (This + really only makes sense in server mode.) Many clients expect to get + some sort of status code back from an executed command after it + completes. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>status</b></code> - + the exit code of the process + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="send_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">send_stderr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Send data to the channel on the "stderr" stream. This is + normally only used by servers to send output from shell commands -- + clients won't use this. Returns the number of bytes sent, or 0 if the + channel stream is closed. Applications are responsible for checking + that all data has been sent: if only some of the data was transmitted, + the application needs to attempt delivery of the remaining data. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + data to send. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + number of bytes actually sent. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if no data could be sent before the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="sendall"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">sendall</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Send data to the channel, without allowing partial results. Unlike + <a href="paramiko.Channel-class.html#send" + class="link"><code>send</code></a>, this method continues to send data + from the given string until either all data has been sent or an error + occurs. Nothing is returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + data to send. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if sending stalled for longer than the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + <dd><code><b>socket.error</b></code> - + if an error occured before the entire string was sent. + </dl> +<p><b>Note:</b> If the channel is closed while only part of the data hase been sent, +there is no way to determine how much data (if any) was sent. This is +irritating, but identically follows python's API. +</p> + + </dd></dl> +</td></tr></table> + +<a name="sendall_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">sendall_stderr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Send data to the channel's "stderr" stream, without + allowing partial results. Unlike <a + href="paramiko.Channel-class.html#send_stderr" + class="link"><code>send_stderr</code></a>, this method continues to + send data from the given string until all data has been sent or an + error occurs. Nothing is returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + data to send to the client as "stderr" output. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>socket.timeout</b></code> - + if sending stalled for longer than the timeout set by <a + href="paramiko.Channel-class.html#settimeout" + class="link"><code>settimeout</code></a>. + <dd><code><b>socket.error</b></code> - + if an error occured before the entire string was sent. + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_combine_stderr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_combine_stderr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>combine</span>)</span> + </h3> + <p>Set whether stderr should be combined into stdout on this channel. + The default is <code>False</code>, but in some cases it may be + convenient to have both streams combined.</p> + <p>If this is <code>False</code>, and <a + href="paramiko.Channel-class.html#exec_command" + class="link"><code>exec_command</code></a> is called (or + <code>invoke_shell</code> with no pty), output to stderr will not show + up through the <a href="paramiko.Channel-class.html#recv" + class="link"><code>recv</code></a> and <a + href="paramiko.Channel-class.html#recv_ready" + class="link"><code>recv_ready</code></a> calls. You will have to use <a + href="paramiko.Channel-class.html#recv_stderr" + class="link"><code>recv_stderr</code></a> and <a + href="paramiko.Channel-class.html#recv_stderr_ready" + class="link"><code>recv_stderr_ready</code></a> to get stderr + output.</p> + If this is <code>True</code>, data will never show up via <a + href="paramiko.Channel-class.html#recv_stderr" + class="link"><code>recv_stderr</code></a> or <a + href="paramiko.Channel-class.html#recv_stderr_ready" + class="link"><code>recv_stderr_ready</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>combine</b></code> - + <code>True</code> if stderr output should be combined into + stdout on this channel. + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + previous setting. + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_name</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>)</span> + </h3> + Set a name for this channel. Currently it's only used to set the + name of the log level used for debugging. The name can be fetched with + the <a href="paramiko.Channel-class.html#get_name" + class="link"><code>get_name</code></a> method. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + new channel name. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="setblocking"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">setblocking</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>blocking</span>)</span> + </h3> + <p>Set blocking or non-blocking mode of the channel: if + <code>blocking</code> is 0, the channel is set to non-blocking mode; + otherwise it's set to blocking mode. Initially all channels are in + blocking mode.</p> + <p>In non-blocking mode, if a <a + href="paramiko.Channel-class.html#recv" + class="link"><code>recv</code></a> call doesn't find any data, or if a + <a href="paramiko.Channel-class.html#send" + class="link"><code>send</code></a> call can't immediately dispose of + the data, an error exception is raised. In blocking mode, the calls + block until they can proceed.</p> + <code>chan.setblocking(0)</code> is equivalent to + <code>chan.settimeout(0)</code>; <code>chan.setblocking(1)</code> is + equivalent to <code>chan.settimeout(None)</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>blocking</b></code> - + 0 to set non-blocking mode; non-0 to set blocking mode. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="settimeout"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">settimeout</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>timeout</span>)</span> + </h3> + <p>Set a timeout on blocking read/write operations. The + <code>timeout</code> argument can be a nonnegative float expressing + seconds, or <code>None</code>. If a float is given, subsequent channel + read/write operations will raise a timeout exception if the timeout + period value has elapsed before the operation has completed. Setting a + timeout of <code>None</code> disables timeouts on socket + operations.</p> + <code>chan.settimeout(0.0)</code> is equivalent to + <code>chan.setblocking(0)</code>; <code>chan.settimeout(None)</code> is + equivalent to <code>chan.setblocking(1)</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>timeout</b></code> - + seconds to wait for a pending read/write operation before + raising <code>socket.timeout</code>, or <code>None</code> for no + timeout. + <br /><i> + (type=float)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="shutdown"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">shutdown</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>how</span>)</span> + </h3> + Shut down one or both halves of the connection. If <code>how</code> + is 0, further receives are disallowed. If <code>how</code> is 1, + further sends are disallowed. If <code>how</code> is 2, further sends + and receives are disallowed. This closes the stream in one or both + directions. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>how</b></code> - + 0 (stop receiving), 1 (stop sending), or 2 (stop receiving and + sending). + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="shutdown_read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">shutdown_read</span>(<span class=sig-arg>self</span>)</span> + </h3> + Shutdown the receiving side of this socket, closing the stream in + the incoming direction. After this call, future reads on this channel + will fail instantly. This is a convenience method, equivalent to + <code>shutdown(0)</code>, for people who don't make it a habit to + memorize unix constants from the 1970s. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="shutdown_write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">shutdown_write</span>(<span class=sig-arg>self</span>)</span> + </h3> + Shutdown the sending side of this socket, closing the stream in the + outgoing direction. After this call, future writes on this channel will + fail instantly. This is a convenience method, equivalent to + <code>shutdown(1)</code>, for people who don't make it a habit to + memorize unix constants from the 1970s. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.2 +</p> + + </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="MIN_PACKET_SIZE"></a> +<h3>MIN_PACKET_SIZE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1024"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1024 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.DSSKey-class.html b/docs/public/paramiko.DSSKey-class.html new file mode 100644 index 0000000..f36e784 --- /dev/null +++ b/docs/public/paramiko.DSSKey-class.html @@ -0,0 +1,423 @@ +<?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>paramiko.DSSKey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class DSSKey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.DSSKey-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.DSSKey-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type DSSKey</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.PKey-class.html"><code>PKey</code></a> --+ + | + <b>DSSKey</b> +</pre><br /> + +<hr/> + +Representation of a DSS key which can be used to sign an verify SSH2 +data. +<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="paramiko.DSSKey-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Create a new instance of this public key type.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__hash__"></a><span class="summary-sig"><span class="summary-sig-name">__hash__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string of an SSH <a href="paramiko.Message-class.html" +class="link"><code>Message</code></a> made up of the public part(s) of +this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#can_sign" class="summary-sig-name"><code>can_sign</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return <code>True</code> if this key has the private part necessary +for signing data.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.DSSKey-class.html" + class="link"><code>DSSKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#generate" class="summary-sig-name"><code>generate</code></a>(<span class=summary-sig-arg>bits</span>, + <span class=summary-sig-arg>progress_func</span>)</span></code> +<br /> +Generate a new private DSS key. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#get_bits" class="summary-sig-name"><code>get_bits</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the number of significant bits in this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the name of this private key implementation.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="sign_ssh_data"></a><span class="summary-sig"><span class="summary-sig-name">sign_ssh_data</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>rpool</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#verify_ssh_sig" class="summary-sig-name"><code>verify_ssh_sig</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +<br /> +Given a blob of data, and an SSH message representing a signature of +that data, verify that it was signed with this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.DSSKey-class.html#write_private_key_file" class="summary-sig-name"><code>write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write private key contents into a file.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>msg</span>=<span class=sig-default>None</span>, + <span class=sig-arg>data</span>=<span class=sig-default>None</span>, + <span class=sig-arg>filename</span>=<span class=sig-default>None</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>, + <span class=sig-arg>vals</span>=<span class=sig-default>None</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new instance of this public key type. If <code>msg</code> + is given, the key's public part(s) will be filled in from the message. + If <code>data</code> is given, the key's public part(s) will be filled + in from the string. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>msg</b></code> - + an optional SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> containing a public key of + this type. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + <dd><code><b>data</b></code> - + an optional string containing a public key of this type + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if a key cannot be created from the <code>data</code> or + <code>msg</code> given, or no key was passed in. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__init__"><code>paramiko.PKey.__init__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return a string of an SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> made up of the public part(s) of + this key. This string is suitable for passing to <a + href="../private/paramiko.PKey-class.html#__init__" + class="link"><code>__init__</code></a> to re-create the key object + later. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string representation of an SSH key message. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__str__"><code>paramiko.PKey.__str__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="can_sign"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">can_sign</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return <code>True</code> if this key has the private part necessary + for signing data. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if this is a private key. + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#can_sign"><code>paramiko.PKey.can_sign</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_bits"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_bits</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the number of significant bits in this key. This is useful + for judging the relative security of a key. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + bits in the key. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_bits"><code>paramiko.PKey.get_bits</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the name of this private key implementation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + name of this private key type, in SSH terminology (for + example, <code>"ssh-rsa"</code>). + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_name"><code>paramiko.PKey.get_name</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="verify_ssh_sig"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">verify_ssh_sig</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>, + <span class=sig-arg>msg</span>)</span> + </h3> + Given a blob of data, and an SSH message representing a signature of + that data, verify that it was signed with this key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>data</b></code> - + the data that was signed. + <br /><i> + (type=str)</i> + <dd><code><b>msg</b></code> - + an SSH signature message + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the signature verifies correctly; + <code>False</code> otherwise. + <br /><i> + (type=boolean)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#verify_ssh_sig"><code>paramiko.PKey.verify_ssh_sig</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="write_private_key_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">write_private_key_file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>)</span> + </h3> + Write private key contents into a file. If the password is not + <code>None</code>, the key is encrypted before writing. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to write. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + an optional password to use to encrypt the key file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if there was an error writing the file. + <dd><code><b>SSHException</b></code> - + if the key is invalid. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#write_private_key_file"><code>paramiko.PKey.write_private_key_file</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF STATIC METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Static Method Details</th></tr> +</table> + +<a name="generate"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">generate</span>(<span class=sig-arg>bits</span>=<span class=sig-default>1024</span>, + <span class=sig-arg>progress_func</span>=<span class=sig-default>None</span>)</span> + </h3> + Generate a new private DSS key. This factory function can be used to + generate a new host key or authentication key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>bits</b></code> - + number of bits the generated key should be. + <br /><i> + (type=int)</i> + <dd><code><b>progress_func</b></code> - + an optional function to call at key points in key generation + (used by <code>pyCrypto.PublicKey</code>). + <br /><i> + (type=function)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + new private key + <br /><i> + (type=<a href="paramiko.DSSKey-class.html" + class="link"><code>DSSKey</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.Message-class.html b/docs/public/paramiko.Message-class.html new file mode 100644 index 0000000..7f097f8 --- /dev/null +++ b/docs/public/paramiko.Message-class.html @@ -0,0 +1,650 @@ +<?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>paramiko.Message</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Message + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.Message-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Message-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Message</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>Message</b> +</pre><br /> + +<hr/> + +<p>An SSH2 <i>Message</i> is a stream of bytes that encodes some +combination of strings, integers, bools, and infinite-precision integers +(known in python as <i>long</i>s). This class builds or breaks down such +a byte stream.</p> +Normally you don't need to deal with anything this low-level, but it's +exposed for people implementing custom extensions, or features that +paramiko doesn't support yet. +<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="paramiko.Message-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>content</span>)</span></code> +<br /> +Create a new SSH2 Message.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns a string representation of this object, for debugging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the byte stream content of this Message, as a string.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add" class="summary-sig-name"><code>add</code></a>(<span class=summary-sig-arg>self</span>, + <span class="summary-sig-vararg">*seq</span>)</span></code> +<br /> +Add a sequence of items to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_boolean" class="summary-sig-name"><code>add_boolean</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>b</span>)</span></code> +<br /> +Add a boolean value to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_byte" class="summary-sig-name"><code>add_byte</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>b</span>)</span></code> +<br /> +Write a single byte to the stream, without any formatting.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_bytes" class="summary-sig-name"><code>add_bytes</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>b</span>)</span></code> +<br /> +Write bytes to the stream, without any formatting.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_int" class="summary-sig-name"><code>add_int</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>)</span></code> +<br /> +Add an integer to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_int64" class="summary-sig-name"><code>add_int64</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>)</span></code> +<br /> +Add a 64-bit int to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_list" class="summary-sig-name"><code>add_list</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>l</span>)</span></code> +<br /> +Add a list of strings to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_mpint" class="summary-sig-name"><code>add_mpint</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>z</span>)</span></code> +<br /> +Add a long int to the stream, encoded as an infinite-precision +integer.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#add_string" class="summary-sig-name"><code>add_string</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>s</span>)</span></code> +<br /> +Add a string to the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_boolean" class="summary-sig-name"><code>get_boolean</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a boolean from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_byte" class="summary-sig-name"><code>get_byte</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the next byte of the Message, without decomposing it.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_bytes" class="summary-sig-name"><code>get_bytes</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>n</span>)</span></code> +<br /> +Return the next <code>n</code> bytes of the Message, without +decomposing into an int, string, etc.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_int" class="summary-sig-name"><code>get_int</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch an int from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> long +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_int64" class="summary-sig-name"><code>get_int64</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a 64-bit int from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of strings +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_list" class="summary-sig-name"><code>get_list</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a list of strings from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> long +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_mpint" class="summary-sig-name"><code>get_mpint</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a long int (mpint) from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_remainder" class="summary-sig-name"><code>get_remainder</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the bytes of this Message that haven't already been parsed and +returned.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_so_far" class="summary-sig-name"><code>get_so_far</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the bytes of this Message that have been parsed and +returned.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#get_string" class="summary-sig-name"><code>get_string</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Fetch a string from the stream.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Message-class.html#rewind" class="summary-sig-name"><code>rewind</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Rewind the message to the beginning as if no items had been parsed out +of it yet.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</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>content</span>=<span class=sig-default>None</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new SSH2 Message. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>content</b></code> - + the byte stream to use as the Message content (passed in only + when decomposing a Message). + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + Returns a string representation of this object, for debugging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return the byte stream content of this Message, as a string. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the contents of this Message. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add</span>(<span class=sig-arg>self</span>, + <span class="sig-vararg">*seq</span>)</span> + </h3> + Add a sequence of items to the stream. The values are encoded based + on their type: str, int, bool, list, or long. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>seq</b></code> - + the sequence of items + <br /><i> + (type=sequence)</i> + </dd> + </dl> +<p><b>Bug:</b> longs are encoded non-deterministically. Don't use this method. +</p> + + </dd></dl> +</td></tr></table> + +<a name="add_boolean"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_boolean</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>b</span>)</span> + </h3> + Add a boolean value to the stream. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>b</b></code> - + boolean value to add + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_byte"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_byte</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>b</span>)</span> + </h3> + Write a single byte to the stream, without any formatting. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>b</b></code> - + byte to add + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_bytes"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_bytes</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>b</span>)</span> + </h3> + Write bytes to the stream, without any formatting. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>b</b></code> - + bytes to add + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_int"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_int</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>n</span>)</span> + </h3> + Add an integer to the stream. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>n</b></code> - + integer to add + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_int64"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_int64</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>n</span>)</span> + </h3> + Add a 64-bit int to the stream. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>n</b></code> - + long int to add + <br /><i> + (type=long)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_list"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_list</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>l</span>)</span> + </h3> + Add a list of strings to the stream. They are encoded identically to + a single string of values separated by commas. (Yes, really, that's how + SSH2 does it.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>l</b></code> - + list of strings to add + <br /><i> + (type=list(str))</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_mpint"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_mpint</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>z</span>)</span> + </h3> + Add a long int to the stream, encoded as an infinite-precision + integer. This method only works on positive numbers. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>z</b></code> - + long int to add + <br /><i> + (type=long)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_string"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_string</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>s</span>)</span> + </h3> + Add a string to the stream. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>s</b></code> - + string to add + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_boolean"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_boolean</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a boolean from the stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> or <code>False</code> (from the + Message). + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_byte"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_byte</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the next byte of the Message, without decomposing it. This is + equivalent to <a href="paramiko.Message-class.html#get_bytes" + class="link"><code>get_bytes(1)</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the next byte of the Message, or <code>' + aren't any bytes remaining. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_bytes"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_bytes</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>n</span>)</span> + </h3> + Return the next <code>n</code> bytes of the Message, without + decomposing into an int, string, etc. Just the raw bytes are + returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a string of the next <code>n</code> bytes of the Message, or a + string of <code>n</code> zero bytes, if there aren't + <code>n</code> bytes remaining. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_int"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_int</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch an int from the stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a 32-bit unsigned integer. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_int64"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_int64</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a 64-bit int from the stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a 64-bit unsigned integer. + <br /><i> + (type=long)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_list"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_list</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a list of strings from the stream. These are trivially encoded + as comma-separated values in a string. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a list of strings. + <br /><i> + (type=list of strings)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_mpint"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_mpint</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a long int (mpint) from the stream. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an arbitrary-length integer. + <br /><i> + (type=long)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_remainder"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_remainder</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the bytes of this Message that haven't already been parsed + and returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a string of the bytes not parsed yet. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_so_far"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_so_far</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns the bytes of this Message that have been parsed and + returned. The string passed into a Message's constructor can be + regenerated by concatenating <code>get_so_far</code> and <a + href="paramiko.Message-class.html#get_remainder" + class="link"><code>get_remainder</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a string of the bytes parsed so far. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_string"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_string</span>(<span class=sig-arg>self</span>)</span> + </h3> + Fetch a string from the stream. This could be a byte string and may + contain unprintable characters. (It's not unheard of for a string to + contain another byte-stream Message.) + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a string. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="rewind"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">rewind</span>(<span class=sig-arg>self</span>)</span> + </h3> + Rewind the message to the beginning as if no items had been parsed + out of it yet. + <dl><dt></dt><dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/public/paramiko.PasswordRequiredException-class.html b/docs/public/paramiko.PasswordRequiredException-class.html new file mode 100644 index 0000000..3d05e9c --- /dev/null +++ b/docs/public/paramiko.PasswordRequiredException-class.html @@ -0,0 +1,91 @@ +<?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>paramiko.PasswordRequiredException</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class PasswordRequiredException + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.PasswordRequiredException-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.PasswordRequiredException-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class PasswordRequiredException</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <a href="paramiko.SSHException-class.html"><code>SSHException</code></a> --+ + | + <b>PasswordRequiredException</b> +</pre><br /> + +<hr/> + +Exception raised when a password is needed to unlock a private key +file. +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.RSAKey-class.html b/docs/public/paramiko.RSAKey-class.html new file mode 100644 index 0000000..168a684 --- /dev/null +++ b/docs/public/paramiko.RSAKey-class.html @@ -0,0 +1,423 @@ +<?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>paramiko.RSAKey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class RSAKey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.RSAKey-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.RSAKey-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type RSAKey</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.PKey-class.html"><code>PKey</code></a> --+ + | + <b>RSAKey</b> +</pre><br /> + +<hr/> + +Representation of an RSA key which can be used to sign and verify SSH2 +data. +<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="paramiko.RSAKey-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>msg</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Create a new instance of this public key type.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__hash__"></a><span class="summary-sig"><span class="summary-sig-name">__hash__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a string of an SSH <a href="paramiko.Message-class.html" +class="link"><code>Message</code></a> made up of the public part(s) of +this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#can_sign" class="summary-sig-name"><code>can_sign</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return <code>True</code> if this key has the private part necessary +for signing data.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.RSAKey-class.html" + class="link"><code>RSAKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#generate" class="summary-sig-name"><code>generate</code></a>(<span class=summary-sig-arg>bits</span>, + <span class=summary-sig-arg>progress_func</span>)</span></code> +<br /> +Generate a new private RSA key. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#get_bits" class="summary-sig-name"><code>get_bits</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the number of significant bits in this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#get_name" class="summary-sig-name"><code>get_name</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the name of this private key implementation.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="sign_ssh_data"></a><span class="summary-sig"><span class="summary-sig-name">sign_ssh_data</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>rpool</span>, + <span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#verify_ssh_sig" class="summary-sig-name"><code>verify_ssh_sig</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>msg</span>)</span></code> +<br /> +Given a blob of data, and an SSH message representing a signature of +that data, verify that it was signed with this key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.RSAKey-class.html#write_private_key_file" class="summary-sig-name"><code>write_private_key_file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>password</span>)</span></code> +<br /> +Write private key contents into a file.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>msg</span>=<span class=sig-default>None</span>, + <span class=sig-arg>data</span>=<span class=sig-default>None</span>, + <span class=sig-arg>filename</span>=<span class=sig-default>None</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>, + <span class=sig-arg>vals</span>=<span class=sig-default>None</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new instance of this public key type. If <code>msg</code> + is given, the key's public part(s) will be filled in from the message. + If <code>data</code> is given, the key's public part(s) will be filled + in from the string. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>msg</b></code> - + an optional SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> containing a public key of + this type. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + <dd><code><b>data</b></code> - + an optional string containing a public key of this type + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if a key cannot be created from the <code>data</code> or + <code>msg</code> given, or no key was passed in. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__init__"><code>paramiko.PKey.__init__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + Return a string of an SSH <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> made up of the public part(s) of + this key. This string is suitable for passing to <a + href="../private/paramiko.PKey-class.html#__init__" + class="link"><code>__init__</code></a> to re-create the key object + later. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + string representation of an SSH key message. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#__str__"><code>paramiko.PKey.__str__</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="can_sign"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">can_sign</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return <code>True</code> if this key has the private part necessary + for signing data. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if this is a private key. + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#can_sign"><code>paramiko.PKey.can_sign</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_bits"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_bits</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the number of significant bits in this key. This is useful + for judging the relative security of a key. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + bits in the key. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_bits"><code>paramiko.PKey.get_bits</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_name"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_name</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the name of this private key implementation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + name of this private key type, in SSH terminology (for + example, <code>"ssh-rsa"</code>). + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#get_name"><code>paramiko.PKey.get_name</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="verify_ssh_sig"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">verify_ssh_sig</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>data</span>, + <span class=sig-arg>msg</span>)</span> + </h3> + Given a blob of data, and an SSH message representing a signature of + that data, verify that it was signed with this key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>data</b></code> - + the data that was signed. + <br /><i> + (type=str)</i> + <dd><code><b>msg</b></code> - + an SSH signature message + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if the signature verifies correctly; + <code>False</code> otherwise. + <br /><i> + (type=boolean)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#verify_ssh_sig"><code>paramiko.PKey.verify_ssh_sig</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="write_private_key_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">write_private_key_file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>)</span> + </h3> + Write private key contents into a file. If the password is not + <code>None</code>, the key is encrypted before writing. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to write. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + an optional password to use to encrypt the key file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if there was an error writing the file. + <dd><code><b>SSHException</b></code> - + if the key is invalid. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.PKey-class.html#write_private_key_file"><code>paramiko.PKey.write_private_key_file</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF STATIC METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Static Method Details</th></tr> +</table> + +<a name="generate"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">generate</span>(<span class=sig-arg>bits</span>, + <span class=sig-arg>progress_func</span>=<span class=sig-default>None</span>)</span> + </h3> + Generate a new private RSA key. This factory function can be used to + generate a new host key or authentication key. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>bits</b></code> - + number of bits the generated key should be. + <br /><i> + (type=int)</i> + <dd><code><b>progress_func</b></code> - + an optional function to call at key points in key generation + (used by <code>pyCrypto.PublicKey</code>). + <br /><i> + (type=function)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + new private key + <br /><i> + (type=<a href="paramiko.RSAKey-class.html" + class="link"><code>RSAKey</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.SFTP-class.html b/docs/public/paramiko.SFTP-class.html new file mode 100644 index 0000000..72ebc70 --- /dev/null +++ b/docs/public/paramiko.SFTP-class.html @@ -0,0 +1,287 @@ +<?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>paramiko.SFTP</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTP + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SFTP-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTP-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTP</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a> --+ + | + <a href="paramiko.SFTPClient-class.html"><code>SFTPClient</code></a> --+ + | + <b>SFTP</b> +</pre><br /> + +<hr/> + +an alias for <a href="paramiko.SFTPClient-class.html" +class="link"><code>SFTPClient</code></a> for backwards compatability +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from SFTPClient</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sock</span>)</span></code> +<br /> +Create an SFTP client from an existing <a +href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#__del__" class="summary-sig-name"><code>__del__</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="paramiko.SFTPClient-class.html#chdir" class="summary-sig-name"><code>chdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Change the "current directory" of this SFTP session.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chmod" class="summary-sig-name"><code>chmod</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>mode</span>)</span></code> +<br /> +Change the mode (permissions) of a file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chown" class="summary-sig-name"><code>chown</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>uid</span>, + <span class=summary-sig-arg>gid</span>)</span></code> +<br /> +Change the owner (<code>uid</code>) and group (<code>gid</code>) of a +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the SFTP session and its underlying channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Open a file on the remote server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#from_transport" class="summary-sig-name"><code>from_transport</code></a>(<span class=summary-sig-arg>selfclass</span>, + <span class=summary-sig-arg>t</span>)</span></code> +<br /> +Create an SFTP client channel from an open <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>. <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>remotepath</span>, + <span class=summary-sig-arg>localpath</span>)</span></code> +<br /> +Copy a remote file (<code>remotepath</code>) from the SFTP server to +the local host as <code>localpath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#getcwd" class="summary-sig-name"><code>getcwd</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the "current working directory" for this SFTP +session, as emulated by paramiko.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir" class="summary-sig-name"><code>listdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return a list containing the names of the entries in the given +<code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir_attr" class="summary-sig-name"><code>listdir_attr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return a list containing <a href="paramiko.SFTPAttributes-class.html" +class="link"><code>SFTPAttributes</code></a> objects corresponding to +files in the given <code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#lstat" class="summary-sig-name"><code>lstat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Retrieve information about a file on the remote system, without +following symbolic links (shortcuts).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#mkdir" class="summary-sig-name"><code>mkdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>mode</span>)</span></code> +<br /> +Create a folder (directory) named <code>path</code> with numeric mode +<code>mode</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#normalize" class="summary-sig-name"><code>normalize</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the normalized path (on the server) of a given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>open</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Open a file on the remote server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#put" class="summary-sig-name"><code>put</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>localpath</span>, + <span class=summary-sig-arg>remotepath</span>)</span></code> +<br /> +Copy a local file (<code>localpath</code>) to the SFTP server as +<code>remotepath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#readlink" class="summary-sig-name"><code>readlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the target of a symbolic link (shortcut).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>remove</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the file at the given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rename" class="summary-sig-name"><code>rename</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>oldpath</span>, + <span class=summary-sig-arg>newpath</span>)</span></code> +<br /> +Rename a file or folder from <code>oldpath</code> to +<code>newpath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rmdir" class="summary-sig-name"><code>rmdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the folder named <code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Retrieve information about a file on the remote system.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#symlink" class="summary-sig-name"><code>symlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>source</span>, + <span class=summary-sig-arg>dest</span>)</span></code> +<br /> +Create a symbolic link (shortcut) of the <code>source</code> path at +<code>destination</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>unlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the file at the given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#utime" class="summary-sig-name"><code>utime</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>times</span>)</span></code> +<br /> +Set the access and modified times of the file specified by +<code>path</code>.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.SFTPAttributes-class.html b/docs/public/paramiko.SFTPAttributes-class.html new file mode 100644 index 0000000..c3cc57c --- /dev/null +++ b/docs/public/paramiko.SFTPAttributes-class.html @@ -0,0 +1,360 @@ +<?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>paramiko.SFTPAttributes</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPAttributes + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SFTPAttributes-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPAttributes-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPAttributes</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>SFTPAttributes</b> +</pre><br /> + +<hr/> + +Representation of the attributes of a file (or proxied file) for SFTP +in client or server mode. It attemps to mirror the object returned by +<code>os.stat</code> as closely as possible, so it may have the following +fields, with the same meanings as those returned by an +<code>os.stat</code> object: +<ul> + <li> + st_size + </li> + <li> + st_uid + </li> + <li> + st_gid + </li> + <li> + st_mode + </li> + <li> + st_atime + </li> + <li> + st_mtime + </li> +</ul> +Because SFTP allows flags to have other arbitrary named attributes, +these are stored in a dict named <code>attr</code>. Occasionally, the +filename is also stored, in <code>filename</code>. +<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="paramiko.SFTPAttributes-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Create a new (empty) SFTPAttributes object.</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="paramiko.SFTPAttributes-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +create a unix-style long description of the file (like ls -l)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPAttributes-class.html#from_stat" class="summary-sig-name"><code>from_stat</code></a>(<span class=summary-sig-arg>cls</span>, + <span class=summary-sig-arg>obj</span>, + <span class=summary-sig-arg>filename</span>)</span></code> +<br /> +Create an SFTPAttributes object from an existing <code>stat</code> +object (an object returned by <code>os.stat</code>). <i>(Class method)</i> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</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>int</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_AMTIME"><code>FLAG_AMTIME</code></a></b> = <span title="8">8 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>long</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_EXTENDED"><code>FLAG_EXTENDED</code></a></b> = <span title="2147483648L"><code>2147483648L </code> +</span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_PERMISSIONS"><code>FLAG_PERMISSIONS</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_SIZE"><code>FLAG_SIZE</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.SFTPAttributes-class.html#FLAG_UIDGID"><code>FLAG_UIDGID</code></a></b> = <span title="2">2 </span></td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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> + <br /><i>(Constructor)</i> + </h3> + Create a new (empty) SFTPAttributes object. All fields will be + empty. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__str__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__str__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Informal representation operator)</i> + </h3> + create a unix-style long description of the file (like ls -l) + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__str__"><code>__builtin__.object.__str__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF CLASS METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Class Method Details</th></tr> +</table> + +<a name="from_stat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">from_stat</span>(<span class=sig-arg>cls</span>, + <span class=sig-arg>obj</span>, + <span class=sig-arg>filename</span>=<span class=sig-default>None</span>)</span> + </h3> + Create an SFTPAttributes object from an existing <code>stat</code> + object (an object returned by <code>os.stat</code>). + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>obj</b></code> - + an object returned by <code>os.stat</code> (or + equivalent). + <br /><i> + (type=object)</i> + <dd><code><b>filename</b></code> - + the filename associated with this file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + new <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> object with the same + attribute fields. + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</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="FLAG_AMTIME"></a> +<h3>FLAG_AMTIME</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="FLAG_EXTENDED"></a> +<h3>FLAG_EXTENDED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>long</code> + + </dd> +<span title="2147483648L"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2147483648L </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="FLAG_PERMISSIONS"></a> +<h3>FLAG_PERMISSIONS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="FLAG_SIZE"></a> +<h3>FLAG_SIZE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="FLAG_UIDGID"></a> +<h3>FLAG_UIDGID</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.SFTPClient-class.html b/docs/public/paramiko.SFTPClient-class.html new file mode 100644 index 0000000..d691c5e --- /dev/null +++ b/docs/public/paramiko.SFTPClient-class.html @@ -0,0 +1,1009 @@ +<?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>paramiko.SFTPClient</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPClient + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SFTPClient-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPClient-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPClient</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a> --+ + | + <b>SFTPClient</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SFTP-class.html"><code>SFTP</code></a></dd></dl> + +<hr/> + +SFTP client object. <code>SFTPClient</code> is used to open an sftp +session across an open ssh <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> and do remote file +operations. +<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="paramiko.SFTPClient-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sock</span>)</span></code> +<br /> +Create an SFTP client from an existing <a +href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</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="paramiko.SFTPClient-class.html#chdir" class="summary-sig-name"><code>chdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Change the "current directory" of this SFTP session.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chmod" class="summary-sig-name"><code>chmod</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>mode</span>)</span></code> +<br /> +Change the mode (permissions) of a file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#chown" class="summary-sig-name"><code>chown</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>uid</span>, + <span class=summary-sig-arg>gid</span>)</span></code> +<br /> +Change the owner (<code>uid</code>) and group (<code>gid</code>) of a +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the SFTP session and its underlying channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>file</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Open a file on the remote server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#from_transport" class="summary-sig-name"><code>from_transport</code></a>(<span class=summary-sig-arg>selfclass</span>, + <span class=summary-sig-arg>t</span>)</span></code> +<br /> +Create an SFTP client channel from an open <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>. <i>(Class method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#get" class="summary-sig-name"><code>get</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>remotepath</span>, + <span class=summary-sig-arg>localpath</span>)</span></code> +<br /> +Copy a remote file (<code>remotepath</code>) from the SFTP server to +the local host as <code>localpath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#getcwd" class="summary-sig-name"><code>getcwd</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the "current working directory" for this SFTP +session, as emulated by paramiko.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir" class="summary-sig-name"><code>listdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return a list containing the names of the entries in the given +<code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list of <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#listdir_attr" class="summary-sig-name"><code>listdir_attr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return a list containing <a href="paramiko.SFTPAttributes-class.html" +class="link"><code>SFTPAttributes</code></a> objects corresponding to +files in the given <code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#lstat" class="summary-sig-name"><code>lstat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Retrieve information about a file on the remote system, without +following symbolic links (shortcuts).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#mkdir" class="summary-sig-name"><code>mkdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>mode</span>)</span></code> +<br /> +Create a folder (directory) named <code>path</code> with numeric mode +<code>mode</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#normalize" class="summary-sig-name"><code>normalize</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the normalized path (on the server) of a given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPFile +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#file" class="summary-sig-name"><code>open</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +<br /> +Open a file on the remote server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#put" class="summary-sig-name"><code>put</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>localpath</span>, + <span class=summary-sig-arg>remotepath</span>)</span></code> +<br /> +Copy a local file (<code>localpath</code>) to the SFTP server as +<code>remotepath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#readlink" class="summary-sig-name"><code>readlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Return the target of a symbolic link (shortcut).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>remove</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the file at the given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rename" class="summary-sig-name"><code>rename</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>oldpath</span>, + <span class=summary-sig-arg>newpath</span>)</span></code> +<br /> +Rename a file or folder from <code>oldpath</code> to +<code>newpath</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#rmdir" class="summary-sig-name"><code>rmdir</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the folder named <code>path</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Retrieve information about a file on the remote system.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#symlink" class="summary-sig-name"><code>symlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>source</span>, + <span class=summary-sig-arg>dest</span>)</span></code> +<br /> +Create a symbolic link (shortcut) of the <code>source</code> path at +<code>destination</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#remove" class="summary-sig-name"><code>unlink</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>)</span></code> +<br /> +Remove the file at the given path.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPClient-class.html#utime" class="summary-sig-name"><code>utime</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>path</span>, + <span class=summary-sig-arg>times</span>)</span></code> +<br /> +Set the access and modified times of the file specified by +<code>path</code>.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>sock</span>)</span> + <br /><i>(Constructor)</i> + </h3> + <p>Create an SFTP client from an existing <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>. The channel should already have + requested the <code>"sftp"</code> subsystem.</p> + An alternate way to create an SFTP client context is by using <a + href="paramiko.SFTPClient-class.html#from_transport" + class="link"><code>from_transport</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>sock</b></code> - + an open <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> using the + <code>"sftp"</code> subsystem. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.BaseSFTP-class.html#__init__"><code>paramiko.BaseSFTP.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="chdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">chdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Change the "current directory" of this SFTP session. Since + SFTP doesn't really have the concept of a current working directory, + this is emulated by paramiko. Once you use this method to set a working + directory, all operations on this SFTPClient object will be relative to + that path. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + new current working directory + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the requested path doesn't exist on the server + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="chmod"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">chmod</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>mode</span>)</span> + </h3> + Change the mode (permissions) of a file. The permissions are + unix-style and identical to those used by python's + <code>os.chmod</code> function. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path of the file to change the permissions of. + <br /><i> + (type=string)</i> + <dd><code><b>mode</b></code> - + new permissions. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="chown"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">chown</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>uid</span>, + <span class=sig-arg>gid</span>)</span> + </h3> + Change the owner (<code>uid</code>) and group (<code>gid</code>) of + a file. As with python's <code>os.chown</code> function, you must pass + both arguments, so if you only want to change one, use <a + href="paramiko.SFTPClient-class.html#stat" + class="link"><code>stat</code></a> first to retrieve the current owner + and group. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path of the file to change the owner and group of. + <br /><i> + (type=string)</i> + <dd><code><b>uid</b></code> - + new owner's uid + <br /><i> + (type=int)</i> + <dd><code><b>gid</b></code> - + new group id + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close the SFTP session and its underlying channel. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">file</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>mode</span>=<span class=sig-default>'r'</span>, + <span class=sig-arg>bufsize</span>=<span class=sig-default>-1</span>)</span> + </h3> + <p>Open a file on the remote server. The arguments are the same as for + python's built-in <code>file</code> (aka <code>open</code>). A + file-like object is returned, which closely mimics the behavior of a + normal python file object.</p> + <p>The mode indicates how the file is to be opened: <code>'r'</code> + for reading, <code>'w'</code> for writing (truncating an existing + file), <code>'a'</code> for appending, <code>'r+'</code> for + reading/writing, <code>'w+'</code> for reading/writing (truncating an + existing file), <code>'a+'</code> for reading/appending. The python + <code>'b'</code> flag is ignored, since SSH treats all files as binary. + The <code>'U'</code> flag is supported in a compatible way.</p> + <p>Since 1.5.2, an <code>'x'</code> flag indicates that the operation + should only succeed if the file was created and did not previously + exist. This has no direct mapping to python's file flags, but is + commonly known as the <code>O_EXCL</code> flag in posix.</p> + The file will be buffered in standard python style by default, but + can be altered with the <code>bufsize</code> parameter. <code>0</code> + turns off buffering, <code>1</code> uses line buffering, and any number + greater than 1 (<code>>1</code>) uses that specific buffer size. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to open. + <br /><i> + (type=string)</i> + <dd><code><b>mode</b></code> - + mode (python-style) to open in. + <br /><i> + (type=string)</i> + <dd><code><b>bufsize</b></code> - + desired buffering (-1 = default buffer size) + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a file object representing the open file. + <br /><i> + (type=SFTPFile)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the file could not be opened. + </dl> + </dd></dl> +</td></tr></table> + +<a name="get"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>remotepath</span>, + <span class=sig-arg>localpath</span>)</span> + </h3> + Copy a remote file (<code>remotepath</code>) from the SFTP server to + the local host as <code>localpath</code>. Any exception raised by + operations will be passed through. This method is primarily provided as + a convenience. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>remotepath</b></code> - + the remote file to copy + <br /><i> + (type=str)</i> + <dd><code><b>localpath</b></code> - + the destination path on the local host + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="getcwd"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">getcwd</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the "current working directory" for this SFTP + session, as emulated by paramiko. If no directory has been set with <a + href="paramiko.SFTPClient-class.html#chdir" + class="link"><code>chdir</code></a>, this method will return + <code>None</code>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + the current working directory on the server, or + <code>None</code> + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="listdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">listdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>=<span class=sig-default>'.'</span>)</span> + </h3> + Return a list containing the names of the entries in the given + <code>path</code>. The list is in arbitrary order. It does not include + the special entries <code>'.'</code> and <code>'..'</code> even if they + are present in the folder. This method is meant to mirror + <code>os.listdir</code> as closely as possible. For a list of full <a + href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> objects, see <a + href="paramiko.SFTPClient-class.html#listdir_attr" + class="link"><code>listdir_attr</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path to list (defaults to <code>'.'</code>) + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of filenames + <br /><i> + (type=list of str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="listdir_attr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">listdir_attr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>=<span class=sig-default>'.'</span>)</span> + </h3> + Return a list containing <a + href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> objects corresponding to + files in the given <code>path</code>. The list is in arbitrary order. + It does not include the special entries <code>'.'</code> and + <code>'..'</code> even if they are present in the folder. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path to list (defaults to <code>'.'</code>) + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of attributes + <br /><i> + (type=list of <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="lstat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">lstat</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Retrieve information about a file on the remote system, without + following symbolic links (shortcuts). This otherwise behaves exactly + the same as <a href="paramiko.SFTPClient-class.html#stat" + class="link"><code>stat</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + the filename to stat. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an object containing attributes about the given file. + <br /><i> + (type=SFTPAttributes)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="mkdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">mkdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>mode</span>=<span class=sig-default>511</span>)</span> + </h3> + Create a folder (directory) named <code>path</code> with numeric + mode <code>mode</code>. The default mode is 0777 (octal). On some + systems, mode is ignored. Where it is used, the current umask value is + first masked out. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + name of the folder to create. + <br /><i> + (type=string)</i> + <dd><code><b>mode</b></code> - + permissions (posix-style) for the newly-created folder. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="normalize"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">normalize</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Return the normalized path (on the server) of a given path. This can + be used to quickly resolve symbolic links or determine what the server + is considering to be the "current folder" (by passing + <code>'.'</code> as <code>path</code>). + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path to be normalized. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + normalized form of the given path. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the path can't be resolved on the server + </dl> + </dd></dl> +</td></tr></table> + +<a name="file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">open</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>filename</span>, + <span class=sig-arg>mode</span>=<span class=sig-default>'r'</span>, + <span class=sig-arg>bufsize</span>=<span class=sig-default>-1</span>)</span> + </h3> + <p>Open a file on the remote server. The arguments are the same as for + python's built-in <code>file</code> (aka <code>open</code>). A + file-like object is returned, which closely mimics the behavior of a + normal python file object.</p> + <p>The mode indicates how the file is to be opened: <code>'r'</code> + for reading, <code>'w'</code> for writing (truncating an existing + file), <code>'a'</code> for appending, <code>'r+'</code> for + reading/writing, <code>'w+'</code> for reading/writing (truncating an + existing file), <code>'a+'</code> for reading/appending. The python + <code>'b'</code> flag is ignored, since SSH treats all files as binary. + The <code>'U'</code> flag is supported in a compatible way.</p> + <p>Since 1.5.2, an <code>'x'</code> flag indicates that the operation + should only succeed if the file was created and did not previously + exist. This has no direct mapping to python's file flags, but is + commonly known as the <code>O_EXCL</code> flag in posix.</p> + The file will be buffered in standard python style by default, but + can be altered with the <code>bufsize</code> parameter. <code>0</code> + turns off buffering, <code>1</code> uses line buffering, and any number + greater than 1 (<code>>1</code>) uses that specific buffer size. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to open. + <br /><i> + (type=string)</i> + <dd><code><b>mode</b></code> - + mode (python-style) to open in. + <br /><i> + (type=string)</i> + <dd><code><b>bufsize</b></code> - + desired buffering (-1 = default buffer size) + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a file object representing the open file. + <br /><i> + (type=SFTPFile)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the file could not be opened. + </dl> + </dd></dl> +</td></tr></table> + +<a name="put"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">put</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>localpath</span>, + <span class=sig-arg>remotepath</span>)</span> + </h3> + <p>Copy a local file (<code>localpath</code>) to the SFTP server as + <code>remotepath</code>. Any exception raised by operations will be + passed through. This method is primarily provided as a convenience.</p> + The SFTP operations use pipelining for speed. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>localpath</b></code> - + the local file to copy + <br /><i> + (type=str)</i> + <dd><code><b>remotepath</b></code> - + the destination path on the SFTP server + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="readlink"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">readlink</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Return the target of a symbolic link (shortcut). You can use <a + href="paramiko.SFTPClient-class.html#symlink" + class="link"><code>symlink</code></a> to create these. The result may + be either an absolute or relative pathname. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path of the symbolic link file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + target path. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="remove"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">remove</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Remove the file at the given path. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path (absolute or relative) of the file to remove. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the path refers to a folder (directory). Use <a + href="paramiko.SFTPClient-class.html#rmdir" + class="link"><code>rmdir</code></a> to remove a folder. + </dl> + </dd></dl> +</td></tr></table> + +<a name="rename"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">rename</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>oldpath</span>, + <span class=sig-arg>newpath</span>)</span> + </h3> + Rename a file or folder from <code>oldpath</code> to + <code>newpath</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>oldpath</b></code> - + existing name of the file or folder. + <br /><i> + (type=string)</i> + <dd><code><b>newpath</b></code> - + new name for the file or folder. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if <code>newpath</code> is a folder, or something else goes + wrong. + </dl> + </dd></dl> +</td></tr></table> + +<a name="rmdir"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">rmdir</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Remove the folder named <code>path</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + name of the folder to remove. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="stat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">stat</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + <p>Retrieve information about a file on the remote system. The return + value is an object whose attributes correspond to the attributes of + python's <code>stat</code> structure as returned by + <code>os.stat</code>, except that it contains fewer fields. An SFTP + server may return as much or as little info as it wants, so the results + may vary from server to server.</p> + <p>Unlike a python <code>stat</code> object, the result may not be + accessed as a tuple. This is mostly due to the author's slack + factor.</p> + The fields supported are: <code>st_mode</code>, + <code>st_size</code>, <code>st_uid</code>, <code>st_gid</code>, + <code>st_atime</code>, and <code>st_mtime</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + the filename to stat. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an object containing attributes about the given file. + <br /><i> + (type=SFTPAttributes)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="symlink"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">symlink</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>source</span>, + <span class=sig-arg>dest</span>)</span> + </h3> + Create a symbolic link (shortcut) of the <code>source</code> path at + <code>destination</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>source</b></code> - + path of the original file. + <br /><i> + (type=string)</i> + <dd><code><b>dest</b></code> - + path of the newly created symlink. + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="remove"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">unlink</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>)</span> + </h3> + Remove the file at the given path. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path (absolute or relative) of the file to remove. + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the path refers to a folder (directory). Use <a + href="paramiko.SFTPClient-class.html#rmdir" + class="link"><code>rmdir</code></a> to remove a folder. + </dl> + </dd></dl> +</td></tr></table> + +<a name="utime"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">utime</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>path</span>, + <span class=sig-arg>times</span>)</span> + </h3> + Set the access and modified times of the file specified by + <code>path</code>. If <code>times</code> is <code>None</code>, then the + file's access and modified times are set to the current time. + Otherwise, <code>times</code> must be a 2-tuple of numbers, of the form + <code>(atime, mtime)</code>, which is used to set the access and + modified times, respectively. This bizarre API is mimicked from python + for the sake of consistency -- I apologize. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>path</b></code> - + path of the file to modify. + <br /><i> + (type=string)</i> + <dd><code><b>times</b></code> - + <code>None</code> or a tuple of (access time, modified time) + in standard internet epoch time (seconds since 01 January 1970 + GMT). + <br /><i> + (type=tuple of int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF CLASS METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Class Method Details</th></tr> +</table> + +<a name="from_transport"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">from_transport</span>(<span class=sig-arg>selfclass</span>, + <span class=sig-arg>t</span>)</span> + </h3> + Create an SFTP client channel from an open <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>t</b></code> - + an open <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> which is already + authenticated. + <br /><i> + (type=<a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a new <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> object, referring to an + sftp session (channel) across the transport. + <br /><i> + (type=<a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a>)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.SFTPError-class.html b/docs/public/paramiko.SFTPError-class.html new file mode 100644 index 0000000..ed3a76d --- /dev/null +++ b/docs/public/paramiko.SFTPError-class.html @@ -0,0 +1,85 @@ +<?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>paramiko.SFTPError</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPError + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SFTPError-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPError-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class SFTPError</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <b>SFTPError</b> +</pre><br /> + +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.SFTPFile-class.html b/docs/public/paramiko.SFTPFile-class.html new file mode 100644 index 0000000..6425f07 --- /dev/null +++ b/docs/public/paramiko.SFTPFile-class.html @@ -0,0 +1,560 @@ +<?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>paramiko.SFTPFile</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPFile + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SFTPFile-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPFile-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPFile</h2> + +<pre class="base-tree"> + <a href="__builtin__.object-class.html"><code>object</code></a> --+ + | +<a href="paramiko.BufferedFile-class.html"><code>BufferedFile</code></a> --+ + | + <b>SFTPFile</b> +</pre><br /> + +<hr/> + +Proxy object for a file on the remote server, in client mode SFTP. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sftp</span>, + <span class=summary-sig-arg>handle</span>, + <span class=summary-sig-arg>mode</span>, + <span class=summary-sig-arg>bufsize</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#check" class="summary-sig-name"><code>check</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>hash_algorithm</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>length</span>, + <span class=summary-sig-arg>block_size</span>)</span></code> +<br /> +Ask the server for a hash of a section of this file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> float +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#gettimeout" class="summary-sig-name"><code>gettimeout</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the timeout in seconds (as a float) associated with the socket +or ssh <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a> used for this file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#prefetch" class="summary-sig-name"><code>prefetch</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Pre-fetch the remaining contents of this file in anticipation of +future <a href="paramiko.BufferedFile-class.html#read" +class="link"><code>read</code></a> calls.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#seek" class="summary-sig-name"><code>seek</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>whence</span>)</span></code> +<br /> +Set the file's current position, like stdio's <code>fseek</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#set_pipelined" class="summary-sig-name"><code>set_pipelined</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>pipelined</span>)</span></code> +<br /> +Turn on/off the pipelining of write operations to this file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#setblocking" class="summary-sig-name"><code>setblocking</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>blocking</span>)</span></code> +<br /> +Set blocking or non-blocking mode on the underiying socket or ssh <a +href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#settimeout" class="summary-sig-name"><code>settimeout</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +<br /> +Set a timeout on read/write operations on the underlying socket or ssh +<a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> SFTPAttributes +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPFile-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Retrieve information about this file from the remote system.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BufferedFile</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#__iter__" class="summary-sig-name"><code>__iter__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns an iterator that can be used to iterate over the lines in this +file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#flush" class="summary-sig-name"><code>flush</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Write out any data in the write buffer.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#next" class="summary-sig-name"><code>next</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns the next line from the input, or raises +<code>StopIteration</code> when EOF is hit.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read at most <code>size</code> bytes from the file (less if we hit the +end of the file first).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readline" class="summary-sig-name"><code>readline</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>size</span>)</span></code> +<br /> +Read one entire line from the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#readlines" class="summary-sig-name"><code>readlines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sizehint</span>)</span></code> +<br /> +Read all remaining lines using <a +href="paramiko.BufferedFile-class.html#readline" +class="link"><code>readline</code></a> and return them as a list.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#tell" class="summary-sig-name"><code>tell</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the file's current position.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Write data to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#writelines" class="summary-sig-name"><code>writelines</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sequence</span>)</span></code> +<br /> +Write a sequence of strings to the file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> iterator +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.BufferedFile-class.html#xreadlines" class="summary-sig-name"><code>xreadlines</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Identical to <code>iter(f)</code>.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>int</code></font></td> +<td><b><a href="paramiko.SFTPFile-class.html#MAX_REQUEST_SIZE"><code>MAX_REQUEST_SIZE</code></a></b> = <span title="32768">32768 </span></td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from BufferedFile</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_CUR"><code>SEEK_CUR</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_END"><code>SEEK_END</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.BufferedFile-class.html#SEEK_SET"><code>SEEK_SET</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="check"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">check</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>hash_algorithm</span>, + <span class=sig-arg>offset</span>=<span class=sig-default>0</span>, + <span class=sig-arg>length</span>=<span class=sig-default>0</span>, + <span class=sig-arg>block_size</span>=<span class=sig-default>0</span>)</span> + </h3> + <p>Ask the server for a hash of a section of this file. This can be + used to verify a successful upload or download, or for various + rsync-like operations.</p> + <p>The file is hashed from <code>offset</code>, for <code>length</code> + bytes. If <code>length</code> is 0, the remainder of the file is + hashed. Thus, if both <code>offset</code> and <code>length</code> are + zero, the entire file is hashed.</p> + <p>Normally, <code>block_size</code> will be 0 (the default), and this + method will return a byte string representing the requested hash (for + example, a string of length 16 for MD5, or 20 for SHA-1). If a non-zero + <code>block_size</code> is given, each chunk of the file (from + <code>offset</code> to <code>offset + length</code>) of + <code>block_size</code> bytes is computed as a separate hash. The hash + results are all concatenated and returned as a single string.</p> + For example, <code>check('sha1', 0, 1024, 512)</code> will return a + string of length 40. The first 20 bytes will be the SHA-1 of the first + 512 bytes of the file, and the last 20 bytes will be the SHA-1 of the + next 512 bytes. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hash_algorithm</b></code> - + the name of the hash algorithm to use (normally + <code>"sha1"</code> or + <code>"md5"</code>) + <br /><i> + (type=str)</i> + <dd><code><b>offset</b></code> - + offset into the file to begin hashing (0 means to start from + the beginning) + <br /><i> + (type=int or long)</i> + <dd><code><b>length</b></code> - + number of bytes to hash (0 means continue to the end of the + file) + <br /><i> + (type=int or long)</i> + <dd><code><b>block_size</b></code> - + number of bytes to hash per result (must not be less than 256; + 0 means to compute only one hash of the entire segment) + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + string of bytes representing the hash of each block, + concatenated together + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the server doesn't support the "check-file" + extension, or possibly doesn't support the hash algorithm + requested + </dl> +<p><b>Note:</b> Many (most?) servers don't support this extension yet. +</p> + +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>_async</span>=<span class=sig-default>False</span>)</span> + </h3> + Close the file. Future read and write operations will fail. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="paramiko.BufferedFile-class.html#close"><code>paramiko.BufferedFile.close</code></a> <i>(inherited documentation)</i> +</dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="gettimeout"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">gettimeout</span>(<span class=sig-arg>self</span>)</span> + </h3> + Returns the timeout in seconds (as a float) associated with the + socket or ssh <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> used for this file. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + float + </dd> + </dl> +<p><b>See Also:</b> <a href="paramiko.Channel-class.html#gettimeout" +class="link"><code>Channel.gettimeout</code></a> +</p> + + </dd></dl> +</td></tr></table> + +<a name="prefetch"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">prefetch</span>(<span class=sig-arg>self</span>)</span> + </h3> + Pre-fetch the remaining contents of this file in anticipation of + future <a href="paramiko.BufferedFile-class.html#read" + class="link"><code>read</code></a> calls. If reading the entire file, + pre-fetching can dramatically improve the download speed by avoiding + roundtrip latency. The file's contents are incrementally buffered in a + background thread. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.5.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="seek"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">seek</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>offset</span>, + <span class=sig-arg>whence</span>=<span class=sig-default>0</span>)</span> + </h3> + Set the file's current position, like stdio's <code>fseek</code>. + Not all file objects support seeking. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>offset</b></code> - + position to move to within the file, relative to + <code>whence</code>. + <br /><i> + (type=int)</i> + <dd><code><b>whence</b></code> - + type of movement: 0 = absolute; 1 = relative to the current + position; 2 = relative to the end of the file. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>IOError</b></code> - + if the file doesn't support random access. + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="paramiko.BufferedFile-class.html#seek"><code>paramiko.BufferedFile.seek</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Note:</b> If a file is opened in append mode (<code>'a'</code> or +<code>'a+'</code>), any seek operations will be undone at the next write +(as the file position will move back to the end of the file). +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_pipelined"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_pipelined</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>pipelined</span>=<span class=sig-default>True</span>)</span> + </h3> + <p>Turn on/off the pipelining of write operations to this file. When + pipelining is on, paramiko won't wait for the server response after + each write operation. Instead, they're collected as they come in. At + the first non-write operation (including <a + href="paramiko.SFTPFile-class.html#close" + class="link"><code>close</code></a>), all remaining server responses + are collected. This means that if there was an error with one of your + later writes, an exception might be thrown from within <a + href="paramiko.SFTPFile-class.html#close" + class="link"><code>close</code></a> instead of <a + href="paramiko.BufferedFile-class.html#write" + class="link"><code>write</code></a>.</p> + By default, files are <i>not</i> pipelined. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>pipelined</b></code> - + <code>True</code> if pipelining should be turned on for this + file; <code>False</code> otherwise + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Since:</b> 1.5 +</p> + + </dd></dl> +</td></tr></table> + +<a name="setblocking"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">setblocking</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>blocking</span>)</span> + </h3> + Set blocking or non-blocking mode on the underiying socket or ssh <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>blocking</b></code> - + 0 to set non-blocking mode; non-0 to set blocking mode. + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>See Also:</b> <a href="paramiko.Channel-class.html#setblocking" +class="link"><code>Channel.setblocking</code></a> +</p> + + </dd></dl> +</td></tr></table> + +<a name="settimeout"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">settimeout</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>timeout</span>)</span> + </h3> + Set a timeout on read/write operations on the underlying socket or + ssh <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>timeout</b></code> - + seconds to wait for a pending read/write operation before + raising <code>socket.timeout</code>, or <code>None</code> for no + timeout + <br /><i> + (type=float)</i> + </dd> + </dl> +<p><b>See Also:</b> <a href="paramiko.Channel-class.html#settimeout" +class="link"><code>Channel.settimeout</code></a> +</p> + + </dd></dl> +</td></tr></table> + +<a name="stat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">stat</span>(<span class=sig-arg>self</span>)</span> + </h3> + Retrieve information about this file from the remote system. This is + exactly like <a href="paramiko.SFTP-class.html#stat" + class="link"><code>SFTP.stat</code></a>, except that it operates on an + already-open file. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an object containing attributes about this file. + <br /><i> + (type=SFTPAttributes)</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="MAX_REQUEST_SIZE"></a> +<h3>MAX_REQUEST_SIZE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="32768"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +32768 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.SFTPHandle-class.html b/docs/public/paramiko.SFTPHandle-class.html new file mode 100644 index 0000000..662ee6a --- /dev/null +++ b/docs/public/paramiko.SFTPHandle-class.html @@ -0,0 +1,325 @@ +<?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>paramiko.SFTPHandle</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPHandle + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SFTPHandle-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPHandle-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPHandle</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>SFTPHandle</b> +</pre><br /> + +<hr/> + +<p>Abstract object representing a handle to an open file (or folder) in +an SFTP server implementation. Each handle has a string representation +used by the client to refer to the underlying file.</p> +Server implementations can (and should) subclass SFTPHandle to +implement features of a file handle, like <a +href="paramiko.SFTPHandle-class.html#stat" +class="link"><code>stat</code></a> or <a +href="paramiko.SFTPHandle-class.html#chattr" +class="link"><code>chattr</code></a>. +<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#chattr" class="summary-sig-name"><code>chattr</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>attr</span>)</span></code> +<br /> +Change the attributes of this file.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +When a client closes a file, this method is called on the handle.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#read" class="summary-sig-name"><code>read</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>length</span>)</span></code> +<br /> +Read up to <code>length</code> bytes from this file, starting at +position <code>offset</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#stat" class="summary-sig-name"><code>stat</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return an <a href="paramiko.SFTPAttributes-class.html" +class="link"><code>SFTPAttributes</code></a> object referring to this +open file, or an error code.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPHandle-class.html#write" class="summary-sig-name"><code>write</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>offset</span>, + <span class=summary-sig-arg>data</span>)</span></code> +<br /> +Write <code>data</code> into this file at position +<code>offset</code>.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="chattr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">chattr</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>attr</span>)</span> + </h3> + Change the attributes of this file. The <code>attr</code> object + will contain only those fields provided by the client in its request, + so you should check for the presence of fields before using them. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>attr</b></code> - + the attributes to change on this file. + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an error code like <a + href="../private/paramiko-module.html#SFTP_OK" + class="link"><code>SFTP_OK</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + <p>When a client closes a file, this method is called on the handle. + Normally you would use this method to close the underlying OS level + file object(s).</p> + The default implementation checks for attributes on + <code>self</code> named <code>readfile</code> and/or + <code>writefile</code>, and if either or both are present, their + <code>close()</code> methods are called. This means that if you are + using the default implementations of <a + href="paramiko.SFTPHandle-class.html#read" + class="link"><code>read</code></a> and <a + href="paramiko.SFTPHandle-class.html#write" + class="link"><code>write</code></a>, this method's default + implementation should be fine also. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="read"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">read</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>offset</span>, + <span class=sig-arg>length</span>)</span> + </h3> + <p>Read up to <code>length</code> bytes from this file, starting at + position <code>offset</code>. The offset may be a python long, since + SFTP allows it to be 64 bits.</p> + <p>If the end of the file has been reached, this method may return an + empty string to signify EOF, or it may also return <a + href="../private/paramiko-module.html#SFTP_EOF" + class="link"><code>SFTP_EOF</code></a>.</p> + The default implementation checks for an attribute on + <code>self</code> named <code>readfile</code>, and if present, performs + the read operation on the python file-like object found there. (This is + meant as a time saver for the common case where you are wrapping a + python file object.) + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>offset</b></code> - + position in the file to start reading from. + <br /><i> + (type=int or long)</i> + <dd><code><b>length</b></code> - + number of bytes to attempt to read. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + data read from the file, or an SFTP error code. + <br /><i> + (type=str)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="stat"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">stat</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return an <a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> object referring to this + open file, or an error code. This is equivalent to <a + href="../private/paramiko.SFTPServerInterface-class.html#stat" + class="link"><code>SFTPServerInterface.stat</code></a>, except it's + called on an open file instead of a path. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an attributes object for the given file, or an SFTP error code + (like <a + href="../private/paramiko-module.html#SFTP_PERMISSION_DENIED" + class="link"><code>SFTP_PERMISSION_DENIED</code></a>). + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a> <i>or error + code</i>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="write"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">write</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>offset</span>, + <span class=sig-arg>data</span>)</span> + </h3> + <p>Write <code>data</code> into this file at position + <code>offset</code>. Extending the file past its original end is + expected. Unlike python's normal <code>write()</code> methods, this + method cannot do a partial write: it must write all of + <code>data</code> or else return an error.</p> + The default implementation checks for an attribute on + <code>self</code> named <code>writefile</code>, and if present, + performs the write operation on the python file-like object found + there. The attribute is named differently from <code>readfile</code> to + make it easy to implement read-only (or write-only) files, but if both + attributes are present, they should refer to the same file. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>offset</b></code> - + position in the file to start reading from. + <br /><i> + (type=int or long)</i> + <dd><code><b>data</b></code> - + data to write into the file. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SFTP error code like <a + href="../private/paramiko-module.html#SFTP_OK" + class="link"><code>SFTP_OK</code></a>. + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.SFTPServer-class.html b/docs/public/paramiko.SFTPServer-class.html new file mode 100644 index 0000000..4d4e827 --- /dev/null +++ b/docs/public/paramiko.SFTPServer-class.html @@ -0,0 +1,403 @@ +<?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>paramiko.SFTPServer</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SFTPServer + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SFTPServer-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SFTPServer-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SFTPServer</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a> --+ + | + <a href="threading.Thread-class.html"><code>Thread</code></a> --+ + | + <a href="paramiko.SubsystemHandler-class.html"><code>SubsystemHandler</code></a> --+ + | + <a href="__builtin__.object-class.html"><code>object</code></a> --+ | + | | + <a href="../private/paramiko.BaseSFTP-class.html"><code>BaseSFTP</code></a> --+ + | + <b>SFTPServer</b> +</pre><br /> + +<hr/> + +Server-side SFTP subsystem support. Since this is a <a +href="paramiko.SubsystemHandler-class.html" +class="link"><code>SubsystemHandler</code></a>, it can be (and is meant +to be) set as the handler for <code>"sftp"</code> requests. Use +<a href="paramiko.Transport-class.html#set_subsystem_handler" +class="link"><code>Transport.set_subsystem_handler</code></a> to activate +this class. +<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="paramiko.SFTPServer-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>server</span>, + <span class=summary-sig-arg>sftp_si</span>, + <span class="summary-sig-vararg">*largs</span>, + <span class="summary-sig-kwarg">**kwargs</span>)</span></code> +<br /> +The constructor for SFTPServer is meant to be called from within the +<a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> as a subsystem handler.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> int +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPServer-class.html#convert_errno" class="summary-sig-name"><code>convert_errno</code></a>(<span class=summary-sig-arg>e</span>)</span></code> +<br /> +Convert an errno value (as from an <code>OSError</code> or +<code>IOError</code>) into a standard SFTP result code. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPServer-class.html#finish_subsystem" class="summary-sig-name"><code>finish_subsystem</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Perform any cleanup at the end of a subsystem.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPServer-class.html#set_file_attr" class="summary-sig-name"><code>set_file_attr</code></a>(<span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>attr</span>)</span></code> +<br /> +Change a file's attributes on the local filesystem. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SFTPServer-class.html#start_subsystem" class="summary-sig-name"><code>start_subsystem</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>transport</span>, + <span class=summary-sig-arg>channel</span>)</span></code> +<br /> +Process an ssh subsystem in server mode.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from SubsystemHandler</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SubsystemHandler-class.html#get_server" class="summary-sig-name"><code>get_server</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the <a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> object associated with this +channel and subsystem.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Thread</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="threading.Thread-class.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="threading.Thread-class.html#getName" class="summary-sig-name"><code>getName</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="threading.Thread-class.html#isAlive" class="summary-sig-name"><code>isAlive</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="threading.Thread-class.html#isDaemon" class="summary-sig-name"><code>isDaemon</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="threading.Thread-class.html#join" class="summary-sig-name"><code>join</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</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="threading.Thread-class.html#run" class="summary-sig-name"><code>run</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="threading.Thread-class.html#setDaemon" class="summary-sig-name"><code>setDaemon</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>daemonic</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="threading.Thread-class.html#setName" class="summary-sig-name"><code>setName</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</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="threading.Thread-class.html#start" class="summary-sig-name"><code>start</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>channel</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>server</span>, + <span class=sig-arg>sftp_si</span>=<span class=sig-default><class 'paramiko.SFTPServerInterface'></span>, + <span class="sig-vararg">*largs</span>, + <span class="sig-kwarg">**kwargs</span>)</span> + <br /><i>(Constructor)</i> + </h3> + The constructor for SFTPServer is meant to be called from within the + <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> as a subsystem handler. + <code>server</code> and any additional parameters or keyword parameters + are passed from the original call to <a + href="paramiko.Transport-class.html#set_subsystem_handler" + class="link"><code>Transport.set_subsystem_handler</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>channel</b></code> - + channel passed from the <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + <dd><code><b>name</b></code> - + name of the requested subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>server</b></code> - + the server object associated with this channel and + subsystem + <br /><i> + (type=<a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a>)</i> + <dd><code><b>sftp_si</b></code> - + a subclass of <a + href="../private/paramiko.SFTPServerInterface-class.html" + class="link"><code>SFTPServerInterface</code></a> to use for + handling individual requests. + <br /><i> + (type=class)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="../private/paramiko.BaseSFTP-class.html#__init__"><code>paramiko.BaseSFTP.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="finish_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">finish_subsystem</span>(<span class=sig-arg>self</span>)</span> + </h3> + Perform any cleanup at the end of a subsystem. The default + implementation just closes the channel. + <dl><dt></dt><dd> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="paramiko.SubsystemHandler-class.html#finish_subsystem"><code>paramiko.SubsystemHandler.finish_subsystem</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="start_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">start_subsystem</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>transport</span>, + <span class=sig-arg>channel</span>)</span> + </h3> + <p>Process an ssh subsystem in server mode. This method is called on a + new object (and in a new thread) for each subsystem request. It is + assumed that all subsystem logic will take place here, and when the + subsystem is finished, this method will return. After this method + returns, the channel is closed.</p> + The combination of <code>transport</code> and <code>channel</code> + are unique; this handler corresponds to exactly one <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> on one <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + name of the requested subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>transport</b></code> - + the server-mode <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <br /><i> + (type=<a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>)</i> + <dd><code><b>channel</b></code> - + the channel associated with this subsystem request. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="paramiko.SubsystemHandler-class.html#start_subsystem"><code>paramiko.SubsystemHandler.start_subsystem</code></a> <i>(inherited documentation)</i> +</dd> + </dl> +<p><b>Note:</b> It is the responsibility of this method to exit if the underlying <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> is closed. This can be done by +checking <a href="paramiko.Transport-class.html#is_active" +class="link"><code>Transport.is_active</code></a> or noticing an EOF on +the <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>. If this method loops forever +without checking for this case, your python interpreter may refuse to +exit because this thread will still be running. +</p> + + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF STATIC METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Static Method Details</th></tr> +</table> + +<a name="convert_errno"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">convert_errno</span>(<span class=sig-arg>e</span>)</span> + </h3> + Convert an errno value (as from an <code>OSError</code> or + <code>IOError</code>) into a standard SFTP result code. This is a + convenience function for trapping exceptions in server code and + returning an appropriate result. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>e</b></code> - + an errno code, as from <code>OSError.errno</code>. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + an SFTP error code like <a + href="../private/paramiko-module.html#SFTP_NO_SUCH_FILE" + class="link"><code>SFTP_NO_SUCH_FILE</code></a>. + <br /><i> + (type=int)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="set_file_attr"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_file_attr</span>(<span class=sig-arg>filename</span>, + <span class=sig-arg>attr</span>)</span> + </h3> + <p>Change a file's attributes on the local filesystem. The contents of + <code>attr</code> are used to change the permissions, owner, group + ownership, and/or modification & access time of the file, depending + on which attributes are present in <code>attr</code>.</p> + This is meant to be a handy helper function for translating SFTP + file requests into local file operations. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to alter (should usually be an absolute + path). + <br /><i> + (type=str)</i> + <dd><code><b>attr</b></code> - + attributes to change. + <br /><i> + (type=<a href="paramiko.SFTPAttributes-class.html" + class="link"><code>SFTPAttributes</code></a>)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.SSHException-class.html b/docs/public/paramiko.SSHException-class.html new file mode 100644 index 0000000..a628f2f --- /dev/null +++ b/docs/public/paramiko.SSHException-class.html @@ -0,0 +1,94 @@ +<?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>paramiko.SSHException</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SSHException + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SSHException-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SSHException-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Class SSHException</h2> + +<pre class="base-tree"> +<a href="exceptions.Exception-class.html"><code>Exception</code></a> --+ + | + <b>SSHException</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.BadAuthenticationType-class.html"><code>BadAuthenticationType</code></a>, + <a href="paramiko.PasswordRequiredException-class.html"><code>PasswordRequiredException</code></a></dd></dl> + +<hr/> + +Exception raised by failures in SSH2 protocol negotiation or logic +errors. +<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 bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Exception</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="exceptions.Exception-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__getitem__" class="summary-sig-name"><code>__getitem__</code></a>(<span class="summary-sig-vararg">...</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="exceptions.Exception-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.SecurityOptions-class.html b/docs/public/paramiko.SecurityOptions-class.html new file mode 100644 index 0000000..a9ca4be --- /dev/null +++ b/docs/public/paramiko.SecurityOptions-class.html @@ -0,0 +1,274 @@ +<?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>paramiko.SecurityOptions</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SecurityOptions + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SecurityOptions-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SecurityOptions-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SecurityOptions</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>SecurityOptions</b> +</pre><br /> + +<hr/> + +<p>Simple object containing the security preferences of an ssh transport. +These are tuples of acceptable ciphers, digests, key types, and key +exchange algorithms, listed in order of preference.</p> +Changing the contents and/or order of these fields affects the +underlying <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> (but only if you change them +before starting the session). If you try to add an algorithm that +paramiko doesn't recognize, <code>ValueError</code> will be raised. If +you try to assign something besides a tuple to one of the fields, +<code>TypeError</code> will be raised. +<hr/> + +<p><b>Since:</b> ivysaur +</p> + + +<!-- =========== 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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>transport</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SecurityOptions-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns a string representation of this object, for debugging.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</td></tr> +</table><br /> + + +<!-- =========== START OF PROPERTY SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Property Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#ciphers"><code>ciphers</code></a></b>: Symmetric encryption ciphers</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#compression"><code>compression</code></a></b>: Compression algorithms</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#digests"><code>digests</code></a></b>: Digest (one-way hash) algorithms</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#kex"><code>kex</code></a></b>: Key exchange algorithms</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><b><a href="paramiko.SecurityOptions-class.html#key_types"><code>key_types</code></a></b>: Public-key algorithms</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>list</code></font></td> +<td><b><a href="paramiko.SecurityOptions-class.html#__slots__"><code>__slots__</code></a></b> = <span title="['ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport']"><code>['ciphers', 'digests', 'key_types', 'kex', '<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="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + Returns a string representation of this object, for debugging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + str + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__repr__"><code>__builtin__.object.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF PROPERTY DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Property Details</th></tr> +</table> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="ciphers"></a> +<h3>ciphers</h3> +Symmetric encryption ciphers +<dl> + <dt></dt> + <dd> + <dl> + </dl> + </dd> +</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="compression"></a> +<h3>compression</h3> +Compression algorithms +<dl> + <dt></dt> + <dd> + <dl> + </dl> + </dd> +</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="digests"></a> +<h3>digests</h3> +Digest (one-way hash) algorithms +<dl> + <dt></dt> + <dd> + <dl> + </dl> + </dd> +</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="kex"></a> +<h3>kex</h3> +Key exchange algorithms +<dl> + <dt></dt> + <dd> + <dl> + </dl> + </dd> +</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + +<a name="key_types"></a> +<h3>key_types</h3> +Public-key algorithms +<dl> + <dt></dt> + <dd> + <dl> + </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="__slots__"></a> +<h3>__slots__</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>list</code> + + </dd> +<span title="['ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport']"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +['ciphers', 'digests', 'key_types', 'kex', 'compression', '_transport'<span class="variable-linewrap">\</span> +] </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.SubsystemHandler-class.html b/docs/public/paramiko.SubsystemHandler-class.html new file mode 100644 index 0000000..05c7bdb --- /dev/null +++ b/docs/public/paramiko.SubsystemHandler-class.html @@ -0,0 +1,327 @@ +<?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>paramiko.SubsystemHandler</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class SubsystemHandler + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.SubsystemHandler-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.SubsystemHandler-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type SubsystemHandler</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a> --+ + | + <a href="threading.Thread-class.html"><code>Thread</code></a> --+ + | + <b>SubsystemHandler</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SFTPServer-class.html"><code>SFTPServer</code></a></dd></dl> + +<hr/> + +<p>Handler for a subsytem in server mode. If you create a subclass of +this class and pass it to <a +href="paramiko.Transport-class.html#set_subsystem_handler" +class="link"><code>Transport.set_subsystem_handler</code></a>, an object +of this class will be created for each request for this subsystem. Each +new object will be executed within its own new thread by calling <a +href="paramiko.SubsystemHandler-class.html#start_subsystem" +class="link"><code>start_subsystem</code></a>. When that method +completes, the channel is closed.</p> +For example, if you made a subclass <code>MP3Handler</code> and +registered it as the handler for subsystem <code>"mp3"</code>, +then whenever a client has successfully authenticated and requests +subsytem <code>"mp3"</code>, an object of class +<code>MP3Handler</code> will be created, and <a +href="paramiko.SubsystemHandler-class.html#start_subsystem" +class="link"><code>start_subsystem</code></a> will be called on it from a +new thread. +<hr/> + +<p><b>Since:</b> ivysaur +</p> + + +<!-- =========== 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="paramiko.SubsystemHandler-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>channel</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>server</span>)</span></code> +<br /> +Create a new handler for a channel.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SubsystemHandler-class.html#finish_subsystem" class="summary-sig-name"><code>finish_subsystem</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Perform any cleanup at the end of a subsystem.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.SubsystemHandler-class.html#get_server" class="summary-sig-name"><code>get_server</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the <a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> object associated with this +channel and subsystem.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.SubsystemHandler-class.html#start_subsystem" class="summary-sig-name"><code>start_subsystem</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>transport</span>, + <span class=summary-sig-arg>channel</span>)</span></code> +<br /> +Process an ssh subsystem in server mode.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Thread</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="threading.Thread-class.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="threading.Thread-class.html#getName" class="summary-sig-name"><code>getName</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="threading.Thread-class.html#isAlive" class="summary-sig-name"><code>isAlive</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="threading.Thread-class.html#isDaemon" class="summary-sig-name"><code>isDaemon</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="threading.Thread-class.html#join" class="summary-sig-name"><code>join</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</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="threading.Thread-class.html#run" class="summary-sig-name"><code>run</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="threading.Thread-class.html#setDaemon" class="summary-sig-name"><code>setDaemon</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>daemonic</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="threading.Thread-class.html#setName" class="summary-sig-name"><code>setName</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</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="threading.Thread-class.html#start" class="summary-sig-name"><code>start</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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>channel</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>server</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new handler for a channel. This is used by <a + href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> to start up a new handler + when a channel requests this subsystem. You don't need to override this + method, but if you do, be sure to pass the <code>channel</code> and + <code>name</code> parameters through to the original + <code>__init__</code> method here. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>channel</b></code> - + the channel associated with this subsystem request. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + <dd><code><b>name</b></code> - + name of the requested subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>server</b></code> - + the server object for the session that started this + subsystem + <br /><i> + (type=<a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="threading.Thread-class.html#__init__"><code>threading.Thread.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="finish_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">finish_subsystem</span>(<span class=sig-arg>self</span>)</span> + </h3> + Perform any cleanup at the end of a subsystem. The default + implementation just closes the channel. + <dl><dt></dt><dd> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_server"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_server</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the <a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> object associated with + this channel and subsystem. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>ServerInterface</code></a> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="start_subsystem"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">start_subsystem</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>transport</span>, + <span class=sig-arg>channel</span>)</span> + </h3> + <p>Process an ssh subsystem in server mode. This method is called on a + new object (and in a new thread) for each subsystem request. It is + assumed that all subsystem logic will take place here, and when the + subsystem is finished, this method will return. After this method + returns, the channel is closed.</p> + The combination of <code>transport</code> and <code>channel</code> + are unique; this handler corresponds to exactly one <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> on one <a + href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + name of the requested subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>transport</b></code> - + the server-mode <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. + <br /><i> + (type=<a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>)</i> + <dd><code><b>channel</b></code> - + the channel associated with this subsystem request. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> +<p><b>Note:</b> It is the responsibility of this method to exit if the underlying <a +href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> is closed. This can be done by +checking <a href="paramiko.Transport-class.html#is_active" +class="link"><code>Transport.is_active</code></a> or noticing an EOF on +the <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>. If this method loops forever +without checking for this case, your python interpreter may refuse to +exit because this thread will still be running. +</p> + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.Transport-class.html b/docs/public/paramiko.Transport-class.html new file mode 100644 index 0000000..562982b --- /dev/null +++ b/docs/public/paramiko.Transport-class.html @@ -0,0 +1,1524 @@ +<?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>paramiko.Transport</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Class Transport + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.Transport-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.Transport-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Transport</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a> --+ + | + <a href="threading.Thread-class.html"><code>Thread</code></a> --+ + | + <b>Transport</b> +</pre><br /> + +<hr/> + +An SSH Transport attaches to a stream (usually a socket), negotiates +an encrypted session, authenticates, and then creates stream tunnels, +called <a href="paramiko.Channel-class.html" +class="link"><code>Channel</code></a>s, across the session. Multiple +channels can be multiplexed across a single session (and often are, in +the case of port forwardings). +<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="paramiko.Transport-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>sock</span>)</span></code> +<br /> +Create a new SSH session over an existing socket, or socket-like +object.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="__del__"></a><span class="summary-sig"><span class="summary-sig-name">__del__</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Returns a string representation of this object, for debugging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#accept" class="summary-sig-name"><code>accept</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +<br /> +Return the next channel opened by the client over this transport, in +server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#add_server_key" class="summary-sig-name"><code>add_server_key</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>key</span>)</span></code> +<br /> +Add a host key to the list of keys used for server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#auth_interactive" class="summary-sig-name"><code>auth_interactive</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>handler</span>, + <span class=summary-sig-arg>submethods</span>)</span></code> +<br /> +Authenticate to the server interactively.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#auth_none" class="summary-sig-name"><code>auth_none</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>)</span></code> +<br /> +Try to authenticate to the server using no authentication at all.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#auth_password" class="summary-sig-name"><code>auth_password</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>password</span>, + <span class=summary-sig-arg>event</span>, + <span class=summary-sig-arg>fallback</span>)</span></code> +<br /> +Authenticate to the server using a password.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> list +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#auth_publickey" class="summary-sig-name"><code>auth_publickey</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>key</span>, + <span class=summary-sig-arg>event</span>)</span></code> +<br /> +Authenticate to the server using a private key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Close this session, and any open channels that are tied to it.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#connect" class="summary-sig-name"><code>connect</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>hostkey</span>, + <span class=summary-sig-arg>username</span>, + <span class=summary-sig-arg>password</span>, + <span class=summary-sig-arg>pkey</span>)</span></code> +<br /> +Negotiate an SSH2 session, and optionally verify the server's host key +and authenticate using a password or private key.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> Exception +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_exception" class="summary-sig-name"><code>get_exception</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return any exception that happened during the last server request.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_hexdump" class="summary-sig-name"><code>get_hexdump</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return <code>True</code> if the transport is currently logging hex +dumps of protocol traffic.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> str +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_log_channel" class="summary-sig-name"><code>get_log_channel</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the channel name used for this transport's logging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_remote_server_key" class="summary-sig-name"><code>get_remote_server_key</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the host key of the server (in client mode).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SecurityOptions-class.html" + class="link"><code>SecurityOptions</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_security_options" class="summary-sig-name"><code>get_security_options</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return a <a href="paramiko.SecurityOptions-class.html" +class="link"><code>SecurityOptions</code></a> object which can be used to +tweak the encryption algorithms this transport will permit, and the order +of preference for them.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_server_key" class="summary-sig-name"><code>get_server_key</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the active host key, in server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#get_username" class="summary-sig-name"><code>get_username</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return the username this connection is authenticated for.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#global_request" class="summary-sig-name"><code>global_request</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>kind</span>, + <span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>wait</span>)</span></code> +<br /> +Make a global request to the remote host.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#is_active" class="summary-sig-name"><code>is_active</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return true if this session is active (open).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#is_authenticated" class="summary-sig-name"><code>is_authenticated</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Return true if this session is active and authenticated.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#load_server_moduli" class="summary-sig-name"><code>load_server_moduli</code></a>(<span class=summary-sig-arg>filename</span>)</span></code> +<br /> +<i>(optional)</i> Load a file of prime moduli for use in doing +group-exchange key negotiation in server mode. <i>(Static method)</i> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#open_channel" class="summary-sig-name"><code>open_channel</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>kind</span>, + <span class=summary-sig-arg>dest_addr</span>, + <span class=summary-sig-arg>src_addr</span>)</span></code> +<br /> +Request a new channel to the server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#open_session" class="summary-sig-name"><code>open_session</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Request a new channel to the server, of type +<code>"session"</code>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#open_sftp_client" class="summary-sig-name"><code>open_sftp_client</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Create an SFTP client channel from an open transport.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> bool +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#renegotiate_keys" class="summary-sig-name"><code>renegotiate_keys</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +<br /> +Force this session to switch to new keys.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="run"></a><span class="summary-sig"><span class="summary-sig-name">run</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="paramiko.Transport-class.html#send_ignore" class="summary-sig-name"><code>send_ignore</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>bytes</span>)</span></code> +<br /> +Send a junk packet across the encrypted link.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#set_hexdump" class="summary-sig-name"><code>set_hexdump</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>hexdump</span>)</span></code> +<br /> +Turn on/off logging a hex dump of protocol traffic at DEBUG level in +the logs.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#set_keepalive" class="summary-sig-name"><code>set_keepalive</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>interval</span>)</span></code> +<br /> +Turn on/off keepalive packets (default is off).</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#set_log_channel" class="summary-sig-name"><code>set_log_channel</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>)</span></code> +<br /> +Set the channel for this transport's logging.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#set_subsystem_handler" class="summary-sig-name"><code>set_subsystem_handler</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>handler</span>, + <span class="summary-sig-vararg">*larg</span>, + <span class="summary-sig-kwarg">**kwarg</span>)</span></code> +<br /> +Set the handler class for a subsystem in server mode.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#start_client" class="summary-sig-name"><code>start_client</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>event</span>)</span></code> +<br /> +Negotiate a new SSH2 session as a client.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.Transport-class.html#start_server" class="summary-sig-name"><code>start_server</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>event</span>, + <span class=summary-sig-arg>server</span>)</span></code> +<br /> +Negotiate a new SSH2 session as a server.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="stop_thread"></a><span class="summary-sig"><span class="summary-sig-name">stop_thread</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="paramiko.Transport-class.html#use_compression" class="summary-sig-name"><code>use_compression</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>compress</span>)</span></code> +<br /> +Turn on/off compression.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from Thread</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="threading.Thread-class.html#getName" class="summary-sig-name"><code>getName</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="threading.Thread-class.html#isAlive" class="summary-sig-name"><code>isAlive</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="threading.Thread-class.html#isDaemon" class="summary-sig-name"><code>isDaemon</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="threading.Thread-class.html#join" class="summary-sig-name"><code>join</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</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="threading.Thread-class.html#setDaemon" class="summary-sig-name"><code>setDaemon</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>daemonic</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="threading.Thread-class.html#setName" class="summary-sig-name"><code>setName</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</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="threading.Thread-class.html#start" class="summary-sig-name"><code>start</code></a>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</td></tr> +</table><br /> + + +<!-- =========== START OF INSTANCE METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Instance 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>sock</span>)</span> + <br /><i>(Constructor)</i> + </h3> + <p>Create a new SSH session over an existing socket, or socket-like + object. This only creates the Transport object; it doesn't begin the + SSH session yet. Use <a href="paramiko.Transport-class.html#connect" + class="link"><code>connect</code></a> or <a + href="paramiko.Transport-class.html#start_client" + class="link"><code>start_client</code></a> to begin a client session, + or <a href="paramiko.Transport-class.html#start_server" + class="link"><code>start_server</code></a> to begin a server + session.</p> + If the object is not actually a socket, it must have the following + methods: + <ul> + <li> + <code>send(str)</code>: Writes from 1 to <code>len(str)</code> + bytes, and returns an int representing the number of bytes written. + Returns 0 or raises <code>EOFError</code> if the stream has been + closed. + </li> + <li> + <code>recv(int)</code>: Reads from 1 to <code>int</code> bytes + and returns them as a string. Returns 0 or raises + <code>EOFError</code> if the stream has been closed. + </li> + <li> + <code>close()</code>: Closes the socket. + </li> + <li> + <code>settimeout(n)</code>: Sets a (float) timeout on I/O + operations. + </li> + </ul> + For ease of use, you may also pass in an address (as a tuple) or a + host string as the <code>sock</code> argument. (A host string is a + hostname with an optional port (separated by + <code>":"</code>) which will be converted into a tuple of + <code>(hostname, port)</code>.) A socket will be connected to this + address and used for communication. Exceptions from the + <code>socket</code> call may be thrown in this case. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>sock</b></code> - + a socket or socket-like object to create the session over. + <br /><i> + (type=socket)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="threading.Thread-class.html#__init__"><code>threading.Thread.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="__repr__"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span> + <br /><i>(Representation operator)</i> + </h3> + Returns a string representation of this object, for debugging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + str + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="threading.Thread-class.html#__repr__"><code>threading.Thread.__repr__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="accept"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">accept</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>timeout</span>=<span class=sig-default>None</span>)</span> + </h3> + Return the next channel opened by the client over this transport, in + server mode. If no channel is opened before the given timeout, + <code>None</code> is returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>timeout</b></code> - + seconds to wait for a channel, or <code>None</code> to wait + forever + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a new Channel opened by the client + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_server_key"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_server_key</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>key</span>)</span> + </h3> + Add a host key to the list of keys used for server mode. When + behaving as a server, the host key is used to sign certain packets + during the SSH2 negotiation, so that the client can trust that we are + who we say we are. Because this is used for signing, the key must + contain private key info, not just the public half. Only one key of + each type (RSA or DSS) is kept. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>key</b></code> - + the host key to add, usually an <a + href="paramiko.RSAKey-class.html" + class="link"><code>RSAKey</code></a> or <a + href="paramiko.DSSKey-class.html" + class="link"><code>DSSKey</code></a>. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="auth_interactive"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">auth_interactive</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>handler</span>, + <span class=sig-arg>submethods</span>=<span class=sig-default>''</span>)</span> + </h3> + <p>Authenticate to the server interactively. A handler is used to + answer arbitrary questions from the server. On many servers, this is + just a dumb wrapper around PAM.</p> + <p>This method will block until the authentication succeeds or fails, + peroidically calling the handler asynchronously to get answers to + authentication questions. The handler may be called more than once if + the server continues to ask questions.</p> + <p>The handler is expected to be a callable that will handle calls of + the form: <code>handler(title, instructions, prompt_list)</code>. The + <code>title</code> is meant to be a dialog-window title, and the + <code>instructions</code> are user instructions (both are strings). + <code>prompt_list</code> will be a list of prompts, each prompt being a + tuple of <code>(str, bool)</code>. The string is the prompt and the + boolean indicates whether the user text should be echoed.</p> + <p>A sample call would thus be: <code>handler('title', 'instructions', + [('Password:', False)])</code>.</p> + <p>The handler should return a list or tuple of answers to the server's + questions.</p> + If the server requires multi-step authentication (which is very + rare), this method will return a list of auth types permissible for the + next step. Otherwise, in the normal case, an empty list is + returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username to authenticate as + <br /><i> + (type=string)</i> + <dd><code><b>handler</b></code> - + a handler for responding to server questions + <br /><i> + (type=callable)</i> + <dd><code><b>submethods</b></code> - + a string list of desired submethods (optional) + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of auth types permissible for the next stage of + authentication (normally empty). + <br /><i> + (type=list)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>BadAuthenticationType</b></code> - + if public-key authentication isn't allowed by the server for + this user + <dd><code><b>SSHException</b></code> - + if the authentication failed + </dl> +<p><b>Since:</b> 1.5 +</p> + + </dd></dl> +</td></tr></table> + +<a name="auth_none"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">auth_none</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>)</span> + </h3> + Try to authenticate to the server using no authentication at all. + This will almost always fail. It may be useful for determining the list + of authentication types supported by the server, by catching the <a + href="paramiko.BadAuthenticationType-class.html" + class="link"><code>BadAuthenticationType</code></a> exception + raised. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username to authenticate as + <br /><i> + (type=string)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of auth types permissible for the next stage of + authentication (normally empty) + <br /><i> + (type=list)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>BadAuthenticationType</b></code> - + if "none" authentication isn't allowed by the server + for this user + <dd><code><b>SSHException</b></code> - + if the authentication failed due to a network error + </dl> +<p><b>Since:</b> 1.5 +</p> + + </dd></dl> +</td></tr></table> + +<a name="auth_password"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">auth_password</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>password</span>, + <span class=sig-arg>event</span>=<span class=sig-default>None</span>, + <span class=sig-arg>fallback</span>=<span class=sig-default>True</span>)</span> + </h3> + <p>Authenticate to the server using a password. The username and + password are sent over an encrypted link.</p> + <p>If an <code>event</code> is passed in, this method will return + immediately, and the event will be triggered once authentication + succeeds or fails. On success, <a + href="paramiko.Transport-class.html#is_authenticated" + class="link"><code>is_authenticated</code></a> will return + <code>True</code>. On failure, you may use <a + href="paramiko.Transport-class.html#get_exception" + class="link"><code>get_exception</code></a> to get more detailed error + information.</p> + <p>Since 1.1, if no event is passed, this method will block until the + authentication succeeds or fails. On failure, an exception is raised. + Otherwise, the method simply returns.</p> + <p>Since 1.5, if no event is passed and <code>fallback</code> is + <code>True</code> (the default), if the server doesn't support plain + password authentication but does support so-called + "keyboard-interactive" mode, an attempt will be made to + authenticate using this interactive mode. If it fails, the normal + exception will be thrown as if the attempt had never been made. This is + useful for some recent Gentoo and Debian distributions, which turn off + plain password authentication in a misguided belief that interactive + authentication is "more secure". (It's not.)</p> + If the server requires multi-step authentication (which is very + rare), this method will return a list of auth types permissible for the + next step. Otherwise, in the normal case, an empty list is + returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username to authenticate as + <br /><i> + (type=string)</i> + <dd><code><b>password</b></code> - + the password to authenticate with + <br /><i> + (type=string)</i> + <dd><code><b>event</b></code> - + an event to trigger when the authentication attempt is + complete (whether it was successful or not) + <br /><i> + (type=threading.Event)</i> + <dd><code><b>fallback</b></code> - + <code>True</code> if an attempt at an automated + "interactive" password auth should be made if the + server doesn't support normal password auth + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of auth types permissible for the next stage of + authentication (normally empty) + <br /><i> + (type=list)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>BadAuthenticationType</b></code> - + if password authentication isn't allowed by the server for + this user (and no event was passed in) + <dd><code><b>SSHException</b></code> - + if the authentication failed (and no event was passed in) + </dl> + </dd></dl> +</td></tr></table> + +<a name="auth_publickey"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">auth_publickey</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>username</span>, + <span class=sig-arg>key</span>, + <span class=sig-arg>event</span>=<span class=sig-default>None</span>)</span> + </h3> + <p>Authenticate to the server using a private key. The key is used to + sign data from the server, so it must include the private part.</p> + <p>If an <code>event</code> is passed in, this method will return + immediately, and the event will be triggered once authentication + succeeds or fails. On success, <a + href="paramiko.Transport-class.html#is_authenticated" + class="link"><code>is_authenticated</code></a> will return + <code>True</code>. On failure, you may use <a + href="paramiko.Transport-class.html#get_exception" + class="link"><code>get_exception</code></a> to get more detailed error + information.</p> + <p>Since 1.1, if no event is passed, this method will block until the + authentication succeeds or fails. On failure, an exception is raised. + Otherwise, the method simply returns.</p> + If the server requires multi-step authentication (which is very + rare), this method will return a list of auth types permissible for the + next step. Otherwise, in the normal case, an empty list is + returned. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>username</b></code> - + the username to authenticate as + <br /><i> + (type=string)</i> + <dd><code><b>key</b></code> - + the private key to authenticate with + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + <dd><code><b>event</b></code> - + an event to trigger when the authentication attempt is + complete (whether it was successful or not) + <br /><i> + (type=threading.Event)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + list of auth types permissible for the next stage of + authentication (normally empty). + <br /><i> + (type=list)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>BadAuthenticationType</b></code> - + if public-key authentication isn't allowed by the server for + this user (and no event was passed in). + <dd><code><b>SSHException</b></code> - + if the authentication failed (and no event was passed in). + </dl> + </dd></dl> +</td></tr></table> + +<a name="close"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">close</span>(<span class=sig-arg>self</span>)</span> + </h3> + Close this session, and any open channels that are tied to it. + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="connect"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">connect</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>hostkey</span>=<span class=sig-default>None</span>, + <span class=sig-arg>username</span>=<span class=sig-default>''</span>, + <span class=sig-arg>password</span>=<span class=sig-default>None</span>, + <span class=sig-arg>pkey</span>=<span class=sig-default>None</span>)</span> + </h3> + <p>Negotiate an SSH2 session, and optionally verify the server's host + key and authenticate using a password or private key. This is a + shortcut for <a href="paramiko.Transport-class.html#start_client" + class="link"><code>start_client</code></a>, <a + href="paramiko.Transport-class.html#get_remote_server_key" + class="link"><code>get_remote_server_key</code></a>, and <a + href="paramiko.Transport-class.html#auth_password" + class="link"><code>Transport.auth_password</code></a> or <a + href="paramiko.Transport-class.html#auth_publickey" + class="link"><code>Transport.auth_publickey</code></a>. Use those + methods if you want more control.</p> + You can use this method immediately after creating a Transport to + negotiate encryption with a server. If it fails, an exception will be + thrown. On success, the method will return cleanly, and an encrypted + session exists. You may immediately call <a + href="paramiko.Transport-class.html#open_channel" + class="link"><code>open_channel</code></a> or <a + href="paramiko.Transport-class.html#open_session" + class="link"><code>open_session</code></a> to get a <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> object, which is used for data + transfer. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hostkey</b></code> - + the host key expected from the server, or <code>None</code> if + you don't want to do host key verification. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + <dd><code><b>username</b></code> - + the username to authenticate as. + <br /><i> + (type=str)</i> + <dd><code><b>password</b></code> - + a password to use for authentication, if you want to use + password authentication; otherwise <code>None</code>. + <br /><i> + (type=str)</i> + <dd><code><b>pkey</b></code> - + a private key to use for authentication, if you want to use + private key authentication; otherwise <code>None</code>. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if the SSH2 negotiation fails, the host key supplied by the + server is incorrect, or authentication fails. + </dl> +<p><b>Note:</b> If you fail to supply a password or private key, this method may +succeed, but a subsequent <a +href="paramiko.Transport-class.html#open_channel" +class="link"><code>open_channel</code></a> or <a +href="paramiko.Transport-class.html#open_session" +class="link"><code>open_session</code></a> call may fail because you +haven't authenticated yet. +</p> + +<p><b>Since:</b> doduo +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_exception"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_exception</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return any exception that happened during the last server request. + This can be used to fetch more specific error information after using + calls like <a href="paramiko.Transport-class.html#start_client" + class="link"><code>start_client</code></a>. The exception (if any) is + cleared after this call. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an exception, or <code>None</code> if there is no stored + exception. + <br /><i> + (type=Exception)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_hexdump"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_hexdump</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return <code>True</code> if the transport is currently logging hex + dumps of protocol traffic. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + <code>True</code> if hex dumps are being logged + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Since:</b> 1.4 +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_log_channel"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_log_channel</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the channel name used for this transport's logging. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + channel name. + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.2 +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_remote_server_key"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_remote_server_key</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the host key of the server (in client mode). + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + public key of the remote server. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if no session is currently active. + </dl> +<p><b>Note:</b> Previously this call returned a tuple of (key type, key string). You +can get the same effect by calling <a +href="../private/paramiko.PKey-class.html#get_name" +class="link"><code>PKey.get_name</code></a> for the key type, and +<code>str(key)</code> for the key string. +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_security_options"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_security_options</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return a <a href="paramiko.SecurityOptions-class.html" + class="link"><code>SecurityOptions</code></a> object which can be used + to tweak the encryption algorithms this transport will permit, and the + order of preference for them. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + an object that can be used to change the preferred algorithms + for encryption, digest (hash), public key, and key exchange. + <br /><i> + (type=<a href="paramiko.SecurityOptions-class.html" + class="link"><code>SecurityOptions</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> ivysaur +</p> + + </dd></dl> +</td></tr></table> + +<a name="get_server_key"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_server_key</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the active host key, in server mode. After negotiating with + the client, this method will return the negotiated host key. If only + one type of host key was set with <a + href="paramiko.Transport-class.html#add_server_key" + class="link"><code>add_server_key</code></a>, that's the only key that + will ever be returned. But in cases where you have set more than one + type of host key (for example, an RSA key and a DSS key), the key type + will be negotiated by the client, and this method will return the key + of the type agreed on. If the host key has not been negotiated yet, + <code>None</code> is returned. In client mode, the behavior is + undefined. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + host key of the type negotiated by the client, or + <code>None</code>. + <br /><i> + (type=<a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="get_username"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">get_username</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return the username this connection is authenticated for. If the + session is not authenticated (or authentication failed), this method + returns <code>None</code>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + username that was authenticated, or <code>None</code>. + <br /><i> + (type=string)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="global_request"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">global_request</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>kind</span>, + <span class=sig-arg>data</span>=<span class=sig-default>None</span>, + <span class=sig-arg>wait</span>=<span class=sig-default>True</span>)</span> + </h3> + Make a global request to the remote host. These are normally + extensions to the SSH2 protocol. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>kind</b></code> - + name of the request. + <br /><i> + (type=str)</i> + <dd><code><b>data</b></code> - + an optional tuple containing additional data to attach to the + request. + <br /><i> + (type=tuple)</i> + <dd><code><b>wait</b></code> - + <code>True</code> if this method should not return until a + response is received; <code>False</code> otherwise. + <br /><i> + (type=bool)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a <a href="paramiko.Message-class.html" + class="link"><code>Message</code></a> containing possible + additional data if the request was successful (or an empty <a + href="paramiko.Message-class.html" + class="link"><code>Message</code></a> if <code>wait</code> was + <code>False</code>); <code>None</code> if the request was + denied. + <br /><i> + (type=<a href="paramiko.Message-class.html" + class="link"><code>Message</code></a>)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="is_active"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">is_active</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return true if this session is active (open). + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + True if the session is still active (open); False if the + session is closed. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="is_authenticated"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">is_authenticated</span>(<span class=sig-arg>self</span>)</span> + </h3> + Return true if this session is active and authenticated. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + True if the session is still open and has been authenticated + successfully; False if authentication failed and/or the session + is closed. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="open_channel"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">open_channel</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>kind</span>, + <span class=sig-arg>dest_addr</span>=<span class=sig-default>None</span>, + <span class=sig-arg>src_addr</span>=<span class=sig-default>None</span>)</span> + </h3> + Request a new channel to the server. <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>s are socket-like objects used for + the actual transfer of data across the session. You may only request a + channel after negotiating encryption (using <a + href="paramiko.Transport-class.html#connect" + class="link"><code>connect</code></a> or <a + href="paramiko.Transport-class.html#start_client" + class="link"><code>start_client</code></a>) and authenticating. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>kind</b></code> - + the kind of channel requested (usually + <code>"session"</code>, + <code>"forwarded-tcpip"</code> or + <code>"direct-tcpip"</code>). + <br /><i> + (type=str)</i> + <dd><code><b>dest_addr</b></code> - + the destination address of this port forwarding, if + <code>kind</code> is <code>"forwarded-tcpip"</code> or + <code>"direct-tcpip"</code> (ignored for other channel + types). + <br /><i> + (type=(str, int))</i> + <dd><code><b>src_addr</b></code> - + the source address of this port forwarding, if + <code>kind</code> is <code>"forwarded-tcpip"</code> or + <code>"direct-tcpip"</code>. + <br /><i> + (type=(str, int))</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + a new <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> on success, or + <code>None</code> if the request is rejected or the session ends + prematurely. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="open_session"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">open_session</span>(<span class=sig-arg>self</span>)</span> + </h3> + Request a new channel to the server, of type + <code>"session"</code>. This is just an alias for + <code>open_channel('session')</code>. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a new <a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a> on success, or + <code>None</code> if the request is rejected or the session ends + prematurely. + <br /><i> + (type=<a href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="open_sftp_client"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">open_sftp_client</span>(<span class=sig-arg>self</span>)</span> + </h3> + Create an SFTP client channel from an open transport. On success, an + SFTP session will be opened with the remote host, and a new SFTPClient + object will be returned. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + a new <a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a> object, referring to an + sftp session (channel) across this transport + <br /><i> + (type=<a href="paramiko.SFTPClient-class.html" + class="link"><code>SFTPClient</code></a>)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="renegotiate_keys"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">renegotiate_keys</span>(<span class=sig-arg>self</span>)</span> + </h3> + Force this session to switch to new keys. Normally this is done + automatically after the session hits a certain number of packets or + bytes sent or received, but this method gives you the option of forcing + new keys whenever you want. Negotiating new keys causes a pause in + traffic both ways as the two sides swap keys and do computations. This + method returns when the session has switched to new keys, or the + session has died mid-negotiation. + <dl><dt></dt><dd> + <dl><dt><b>Returns:</b></dt> + <dd> + True if the renegotiation was successful, and the link is + using new keys; False if the session dropped during + renegotiation. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="send_ignore"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">send_ignore</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>bytes</span>=<span class=sig-default>None</span>)</span> + </h3> + Send a junk packet across the encrypted link. This is sometimes used + to add "noise" to a connection to confuse would-be attackers. + It can also be used as a keep-alive for long lived connections + traversing firewalls. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>bytes</b></code> - + the number of random bytes to send in the payload of the + ignored packet -- defaults to a random number from 10 to 41. + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_hexdump"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_hexdump</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>hexdump</span>)</span> + </h3> + Turn on/off logging a hex dump of protocol traffic at DEBUG level in + the logs. Normally you would want this off (which is the default), but + if you are debugging something, it may be useful. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hexdump</b></code> - + <code>True</code> to log protocol traffix (in hex) to the log; + <code>False</code> otherwise. + <br /><i> + (type=bool)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="set_keepalive"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_keepalive</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>interval</span>)</span> + </h3> + Turn on/off keepalive packets (default is off). If this is set, + after <code>interval</code> seconds without sending any data over the + connection, a "keepalive" packet will be sent (and ignored by + the remote host). This can be useful to keep connections alive over a + NAT, for example. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>interval</b></code> - + seconds to wait before sending a keepalive packet (or 0 to + disable keepalives). + <br /><i> + (type=int)</i> + </dd> + </dl> +<p><b>Since:</b> fearow +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_log_channel"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_log_channel</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>)</span> + </h3> + Set the channel for this transport's logging. The default is + <code>"paramiko.transport"</code> but it can be set to + anything you want. (See the <code>logging</code> module for more info.) + SSH Channels will log to a sub-channel of the one specified. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + new channel name for logging. + <br /><i> + (type=str)</i> + </dd> + </dl> +<p><b>Since:</b> 1.1 +</p> + + </dd></dl> +</td></tr></table> + +<a name="set_subsystem_handler"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">set_subsystem_handler</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>name</span>, + <span class=sig-arg>handler</span>, + <span class="sig-vararg">*larg</span>, + <span class="sig-kwarg">**kwarg</span>)</span> + </h3> + <p>Set the handler class for a subsystem in server mode. If a request + for this subsystem is made on an open ssh channel later, this handler + will be constructed and called -- see <a + href="paramiko.SubsystemHandler-class.html" + class="link"><code>SubsystemHandler</code></a> for more detailed + documentation.</p> + Any extra parameters (including keyword arguments) are saved and + passed to the <a href="paramiko.SubsystemHandler-class.html" + class="link"><code>SubsystemHandler</code></a> constructor later. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + name of the subsystem. + <br /><i> + (type=str)</i> + <dd><code><b>handler</b></code> - + subclass of <a href="paramiko.SubsystemHandler-class.html" + class="link"><code>SubsystemHandler</code></a> that handles this + subsystem. + <br /><i> + (type=class)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="start_client"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">start_client</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>event</span>=<span class=sig-default>None</span>)</span> + </h3> + <p>Negotiate a new SSH2 session as a client. This is the first step + after creating a new <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a>. A separate thread is created + for protocol negotiation.</p> + <p>If an event is passed in, this method returns immediately. When + negotiation is done (successful or not), the given <code>Event</code> + will be triggered. On failure, <a + href="paramiko.Transport-class.html#is_active" + class="link"><code>is_active</code></a> will return + <code>False</code>.</p> + <p>(Since 1.4) If <code>event</code> is <code>None</code>, this method + will not return until negotation is done. On success, the method + returns normally. Otherwise an SSHException is raised.</p> + After a successful negotiation, you will usually want to + authenticate, calling <a + href="paramiko.Transport-class.html#auth_password" + class="link"><code>auth_password</code></a> or <a + href="paramiko.Transport-class.html#auth_publickey" + class="link"><code>auth_publickey</code></a>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>event</b></code> - + an event to trigger when negotiation is complete + (optional) + <br /><i> + (type=threading.Event)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if negotiation fails (and no <code>event</code> was passed + in) + </dl> +<p><b>Notes:</b> +<ul> + <li><a href="paramiko.Transport-class.html#connect" +class="link"><code>connect</code></a> is a simpler method for connecting +as a client. +</li> + <li>After calling this method (or <a +href="paramiko.Transport-class.html#start_server" +class="link"><code>start_server</code></a> or <a +href="paramiko.Transport-class.html#connect" +class="link"><code>connect</code></a>), you should no longer directly +read from or write to the original socket object. + + </li> +</ul></p> + + </dd></dl> +</td></tr></table> + +<a name="start_server"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">start_server</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>event</span>=<span class=sig-default>None</span>, + <span class=sig-arg>server</span>=<span class=sig-default>None</span>)</span> + </h3> + <p>Negotiate a new SSH2 session as a server. This is the first step + after creating a new <a href="paramiko.Transport-class.html" + class="link"><code>Transport</code></a> and setting up your server host + key(s). A separate thread is created for protocol negotiation.</p> + <p>If an event is passed in, this method returns immediately. When + negotiation is done (successful or not), the given <code>Event</code> + will be triggered. On failure, <a + href="paramiko.Transport-class.html#is_active" + class="link"><code>is_active</code></a> will return + <code>False</code>.</p> + <p>(Since 1.4) If <code>event</code> is <code>None</code>, this method + will not return until negotation is done. On success, the method + returns normally. Otherwise an SSHException is raised.</p> + <p>After a successful negotiation, the client will need to + authenticate. Override the methods <a + href="../private/paramiko.ServerInterface-class.html#get_allowed_auths" + class="link"><code>get_allowed_auths</code></a>, <a + href="../private/paramiko.ServerInterface-class.html#check_auth_none" + class="link"><code>check_auth_none</code></a>, <a + href="../private/paramiko.ServerInterface-class.html#check_auth_password" + class="link"><code>check_auth_password</code></a>, and <a + href="../private/paramiko.ServerInterface-class.html#check_auth_publickey" + class="link"><code>check_auth_publickey</code></a> in the given + <code>server</code> object to control the authentication process.</p> + After a successful authentication, the client should request to open + a channel. Override <a + href="../private/paramiko.ServerInterface-class.html#check_channel_request" + class="link"><code>check_channel_request</code></a> in the given + <code>server</code> object to allow channels to be opened. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>event</b></code> - + an event to trigger when negotiation is complete. + <br /><i> + (type=threading.Event)</i> + <dd><code><b>server</b></code> - + an object used to perform authentication and create <a + href="paramiko.Channel-class.html" + class="link"><code>Channel</code></a>s. + <br /><i> + (type=<a href="../private/paramiko.ServerInterface-class.html" + class="link"><code>server.ServerInterface</code></a>)</i> + </dd> + </dl> + <dl><dt><b>Raises:</b></dt> + <dd><code><b>SSHException</b></code> - + if negotiation fails (and no <code>event</code> was passed + in) + </dl> +<p><b>Note:</b> After calling this method (or <a +href="paramiko.Transport-class.html#start_client" +class="link"><code>start_client</code></a> or <a +href="paramiko.Transport-class.html#connect" +class="link"><code>connect</code></a>), you should no longer directly +read from or write to the original socket object. +</p> + + </dd></dl> +</td></tr></table> + +<a name="use_compression"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">use_compression</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>compress</span>=<span class=sig-default>True</span>)</span> + </h3> + Turn on/off compression. This will only have an affect before + starting the transport (ie before calling <a + href="paramiko.Transport-class.html#connect" + class="link"><code>connect</code></a>, etc). By default, compression is + off since it negatively affects interactive sessions and is not fully + tested. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>compress</b></code> - + <code>True</code> to ask the remote client/server to compress + traffic; <code>False</code> to refuse compression + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Since:</b> 1.5.2 +</p> + + </dd></dl> +</td></tr></table> +<br /> + + +<!-- =========== START OF STATIC METHOD DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Static Method Details</th></tr> +</table> + +<a name="load_server_moduli"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">load_server_moduli</span>(<span class=sig-arg>filename</span>=<span class=sig-default>None</span>)</span> + </h3> + <p><i>(optional)</i> Load a file of prime moduli for use in doing + group-exchange key negotiation in server mode. It's a rather obscure + option and can be safely ignored.</p> + In server mode, the remote client may request + "group-exchange" key negotiation, which asks the server to + send a random prime number that fits certain criteria. These primes are + pretty difficult to compute, so they can't be generated on demand. But + many systems contain a file of suitable primes (usually named something + like <code>/etc/ssh/moduli</code>). If you call + <code>load_server_moduli</code> and it returns <code>True</code>, then + this file of primes has been loaded and we will support + "group-exchange" in server mode. Otherwise server mode will + just claim that it doesn't support that method of key negotiation. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + optional path to the moduli file, if you happen to know that + it's not in a standard location. + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + True if a moduli file was successfully loaded; False + otherwise. + <br /><i> + (type=bool)</i> + </dd> + </dl> +<p><b>Note:</b> This has no effect when used in client mode. +</p> + +<p><b>Since:</b> doduo +</p> + + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.agent-module.html b/docs/public/paramiko.agent-module.html new file mode 100644 index 0000000..560432a --- /dev/null +++ b/docs/public/paramiko.agent-module.html @@ -0,0 +1,164 @@ +<?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>paramiko.agent</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module agent + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.agent-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.agent-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.agent</h2> + +SSH Agent interface for Unix clients. +<hr/> + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.agent-module.html#SSH2_AGENT_IDENTITIES_ANSWER"><code>SSH2_AGENT_IDENTITIES_ANSWER</code></a></b> = <span title="12">12 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.agent-module.html#SSH2_AGENT_SIGN_RESPONSE"><code>SSH2_AGENT_SIGN_RESPONSE</code></a></b> = <span title="14">14 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.agent-module.html#SSH2_AGENTC_REQUEST_IDENTITIES"><code>SSH2_AGENTC_REQUEST_IDENTITIES</code></a></b> = <span title="11">11 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.agent-module.html#SSH2_AGENTC_SIGN_REQUEST"><code>SSH2_AGENTC_SIGN_REQUEST</code></a></b> = <span title="13">13 </span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SSH2_AGENT_IDENTITIES_ANSWER"></a> +<h3>SSH2_AGENT_IDENTITIES_ANSWER</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="12"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +12 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SSH2_AGENT_SIGN_RESPONSE"></a> +<h3>SSH2_AGENT_SIGN_RESPONSE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="14"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +14 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SSH2_AGENTC_REQUEST_IDENTITIES"></a> +<h3>SSH2_AGENTC_REQUEST_IDENTITIES</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="11"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +11 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SSH2_AGENTC_SIGN_REQUEST"></a> +<h3>SSH2_AGENTC_SIGN_REQUEST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="13"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +13 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.dsskey-module.html b/docs/public/paramiko.dsskey-module.html new file mode 100644 index 0000000..f600c89 --- /dev/null +++ b/docs/public/paramiko.dsskey-module.html @@ -0,0 +1,62 @@ +<?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>paramiko.dsskey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module dsskey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.dsskey-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.dsskey-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.dsskey</h2> + +<a href="paramiko.DSSKey-class.html" +class="link"><code>DSSKey</code></a> +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.file-module.html b/docs/public/paramiko.file-module.html new file mode 100644 index 0000000..4cb6c90 --- /dev/null +++ b/docs/public/paramiko.file-module.html @@ -0,0 +1,61 @@ +<?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>paramiko.file</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module file + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.file-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.file-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.file</h2> + +BufferedFile. +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.message-module.html b/docs/public/paramiko.message-module.html new file mode 100644 index 0000000..2ccf4d9 --- /dev/null +++ b/docs/public/paramiko.message-module.html @@ -0,0 +1,61 @@ +<?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>paramiko.message</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module message + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.message-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.message-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.message</h2> + +Implementation of an SSH2 "message". +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:46 2005</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> diff --git a/docs/public/paramiko.pkey-module.html b/docs/public/paramiko.pkey-module.html new file mode 100644 index 0000000..e7aac95 --- /dev/null +++ b/docs/public/paramiko.pkey-module.html @@ -0,0 +1,61 @@ +<?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>paramiko.pkey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module pkey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.pkey-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.pkey-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.pkey</h2> + +Common API for all public keys. +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.rsakey-module.html b/docs/public/paramiko.rsakey-module.html new file mode 100644 index 0000000..b287187 --- /dev/null +++ b/docs/public/paramiko.rsakey-module.html @@ -0,0 +1,62 @@ +<?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>paramiko.rsakey</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module rsakey + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.rsakey-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.rsakey-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.rsakey</h2> + +<a href="paramiko.RSAKey-class.html" +class="link"><code>RSAKey</code></a> +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.server-module.html b/docs/public/paramiko.server-module.html new file mode 100644 index 0000000..b283866 --- /dev/null +++ b/docs/public/paramiko.server-module.html @@ -0,0 +1,74 @@ +<?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>paramiko.server</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module server + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.server-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.server-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.server</h2> + +<a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> is an interface to override +for server support. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="paramiko.server.InteractiveQuery-class.html"><code>InteractiveQuery</code></a></b></td> + <td>A query (set of prompts) for a user during interactive +authentication.</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.server.InteractiveQuery-class.html b/docs/public/paramiko.server.InteractiveQuery-class.html new file mode 100644 index 0000000..6a96be3 --- /dev/null +++ b/docs/public/paramiko.server.InteractiveQuery-class.html @@ -0,0 +1,195 @@ +<?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>paramiko.server.InteractiveQuery</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="paramiko.server-module.html">Module server</a> :: + Class InteractiveQuery + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.server.InteractiveQuery-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.server.InteractiveQuery-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type InteractiveQuery</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>InteractiveQuery</b> +</pre><br /> + +<hr/> + +A query (set of prompts) for a user during interactive +authentication. +<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="paramiko.server.InteractiveQuery-class.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>instructions</span>, + <span class="summary-sig-vararg">*prompts</span>)</span></code> +<br /> +Create a new interactive query to send to the client.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.server.InteractiveQuery-class.html#add_prompt" class="summary-sig-name"><code>add_prompt</code></a>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>prompt</span>, + <span class=summary-sig-arg>echo</span>)</span></code> +<br /> +Add a prompt to this query.</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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-default>''</span>, + <span class=sig-arg>instructions</span>=<span class=sig-default>''</span>, + <span class="sig-vararg">*prompts</span>)</span> + <br /><i>(Constructor)</i> + </h3> + Create a new interactive query to send to the client. The name and + instructions are optional, but are generally displayed to the end user. + A list of prompts may be included, or they may be added via the <a + href="paramiko.server.InteractiveQuery-class.html#add_prompt" + class="link"><code>add_prompt</code></a> method. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>name</b></code> - + name of this query + <br /><i> + (type=str)</i> + <dd><code><b>instructions</b></code> - + user instructions (usually short) about this query + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Overrides:</b></dt> + <dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="add_prompt"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">add_prompt</span>(<span class=sig-arg>self</span>, + <span class=sig-arg>prompt</span>, + <span class=sig-arg>echo</span>=<span class=sig-default>True</span>)</span> + </h3> + Add a prompt to this query. The prompt should be a (reasonably + short) string. Multiple prompts can be added to the same query. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>prompt</b></code> - + the user prompt + <br /><i> + (type=str)</i> + <dd><code><b>echo</b></code> - + <code>True</code> (default) if the user's response should be + echoed; <code>False</code> if not (for a password or similar) + <br /><i> + (type=bool)</i> + </dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.sftp-module.html b/docs/public/paramiko.sftp-module.html new file mode 100644 index 0000000..66fb99e --- /dev/null +++ b/docs/public/paramiko.sftp-module.html @@ -0,0 +1,1060 @@ +<?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>paramiko.sftp</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.sftp-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp</h2> + + +<!-- =========== START OF VARIABLE SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Variable Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_ATTRS"><code>CMD_ATTRS</code></a></b> = <span title="105">105 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_CLOSE"><code>CMD_CLOSE</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_DATA"><code>CMD_DATA</code></a></b> = <span title="103">103 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_EXTENDED"><code>CMD_EXTENDED</code></a></b> = <span title="200">200 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_EXTENDED_REPLY"><code>CMD_EXTENDED_REPLY</code></a></b> = <span title="201">201 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_FSETSTAT"><code>CMD_FSETSTAT</code></a></b> = <span title="10">10 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_FSTAT"><code>CMD_FSTAT</code></a></b> = <span title="8">8 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_HANDLE"><code>CMD_HANDLE</code></a></b> = <span title="102">102 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_INIT"><code>CMD_INIT</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_LSTAT"><code>CMD_LSTAT</code></a></b> = <span title="7">7 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_MKDIR"><code>CMD_MKDIR</code></a></b> = <span title="14">14 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_NAME"><code>CMD_NAME</code></a></b> = <span title="104">104 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_NAMES"><code>CMD_NAMES</code></a></b> = <span title="{1: 'init', 2: 'version', 3: 'open', 4: 'close', 5: 'read', 6: 'write', 7: 'lstat', 8: 'fstat', 9: 'setstat', 10: 'fsetstat', 11: 'opendir', 12: 'readdir', 13: 'remove', 14: 'mkdir', 15: 'rmdir', 16: 'realpath', 17: 'stat', 18: 'rename', 19: 'readlink', 20: 'symlink', 200: 'extended', 201: 'extended_reply', 101: 'status', 102: 'handle', 103: 'data', 104: 'name', 105: 'attrs'}"><code>{1: 'init', 2: 'version', 3: 'open', 4: 'clo<span class="variable-ellipsis">...</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="paramiko.sftp-module.html#CMD_OPEN"><code>CMD_OPEN</code></a></b> = <span title="3">3 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_OPENDIR"><code>CMD_OPENDIR</code></a></b> = <span title="11">11 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_READ"><code>CMD_READ</code></a></b> = <span title="5">5 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_READDIR"><code>CMD_READDIR</code></a></b> = <span title="12">12 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_READLINK"><code>CMD_READLINK</code></a></b> = <span title="19">19 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_REALPATH"><code>CMD_REALPATH</code></a></b> = <span title="16">16 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_REMOVE"><code>CMD_REMOVE</code></a></b> = <span title="13">13 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_RENAME"><code>CMD_RENAME</code></a></b> = <span title="18">18 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_RMDIR"><code>CMD_RMDIR</code></a></b> = <span title="15">15 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_SETSTAT"><code>CMD_SETSTAT</code></a></b> = <span title="9">9 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_STAT"><code>CMD_STAT</code></a></b> = <span title="17">17 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_STATUS"><code>CMD_STATUS</code></a></b> = <span title="101">101 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_SYMLINK"><code>CMD_SYMLINK</code></a></b> = <span title="20">20 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_VERSION"><code>CMD_VERSION</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#CMD_WRITE"><code>CMD_WRITE</code></a></b> = <span title="6">6 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_BAD_MESSAGE"><code>SFTP_BAD_MESSAGE</code></a></b> = <span title="5">5 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_CONNECTION_LOST"><code>SFTP_CONNECTION_LOST</code></a></b> = <span title="7">7 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_DESC"><code>SFTP_DESC</code></a></b> = <span title="['Success', 'End of file', 'No such file', 'Permission denied', 'Failure', 'Bad message', 'No connection', 'Connection lost', 'Operation unsupported']"><code>['Success', 'End of file', 'No such file', '<span class="variable-ellipsis">...</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="paramiko.sftp-module.html#SFTP_EOF"><code>SFTP_EOF</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FAILURE"><code>SFTP_FAILURE</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_APPEND"><code>SFTP_FLAG_APPEND</code></a></b> = <span title="4">4 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_CREATE"><code>SFTP_FLAG_CREATE</code></a></b> = <span title="8">8 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_EXCL"><code>SFTP_FLAG_EXCL</code></a></b> = <span title="32">32 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_READ"><code>SFTP_FLAG_READ</code></a></b> = <span title="1">1 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_TRUNC"><code>SFTP_FLAG_TRUNC</code></a></b> = <span title="16">16 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_FLAG_WRITE"><code>SFTP_FLAG_WRITE</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_NO_CONNECTION"><code>SFTP_NO_CONNECTION</code></a></b> = <span title="6">6 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_NO_SUCH_FILE"><code>SFTP_NO_SUCH_FILE</code></a></b> = <span title="2">2 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_OK"><code>SFTP_OK</code></a></b> = <span title="0">0 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_OP_UNSUPPORTED"><code>SFTP_OP_UNSUPPORTED</code></a></b> = <span title="8">8 </span></td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td> +<td><b><a href="paramiko.sftp-module.html#SFTP_PERMISSION_DENIED"><code>SFTP_PERMISSION_DENIED</code></a></b> = <span title="3">3 </span></td></tr> +</table><br /> + + +<!-- =========== START OF VARIABLE DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Variable Details</th></tr> +</table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_ATTRS"></a> +<h3>CMD_ATTRS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="105"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +105 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_CLOSE"></a> +<h3>CMD_CLOSE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_DATA"></a> +<h3>CMD_DATA</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="103"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +103 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_EXTENDED"></a> +<h3>CMD_EXTENDED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="200"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +200 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_EXTENDED_REPLY"></a> +<h3>CMD_EXTENDED_REPLY</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="201"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +201 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_FSETSTAT"></a> +<h3>CMD_FSETSTAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="10"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +10 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_FSTAT"></a> +<h3>CMD_FSTAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_HANDLE"></a> +<h3>CMD_HANDLE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="102"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +102 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_INIT"></a> +<h3>CMD_INIT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_LSTAT"></a> +<h3>CMD_LSTAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="7"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +7 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_MKDIR"></a> +<h3>CMD_MKDIR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="14"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +14 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_NAME"></a> +<h3>CMD_NAME</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="104"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +104 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_NAMES"></a> +<h3>CMD_NAMES</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>dict</code> + + </dd> +<span title="{1: 'init', 2: 'version', 3: 'open', 4: 'close', 5: 'read', 6: 'write', 7: 'lstat', 8: 'fstat', 9: 'setstat', 10: 'fsetstat', 11: 'opendir', 12: 'readdir', 13: 'remove', 14: 'mkdir', 15: 'rmdir', 16: 'realpath', 17: 'stat', 18: 'rename', 19: 'readlink', 20: 'symlink', 200: 'extended', 201: 'extended_reply', 101: 'status', 102: 'handle', 103: 'data', 104: 'name', 105: 'attrs'}"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +{1: 'init', + 2: 'version', + 3: 'open', + 4: 'close', + 5: 'read', + 6: 'write', + 7: 'lstat', + 8: 'fstat', +<span class="variable-ellipsis">...</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_OPEN"></a> +<h3>CMD_OPEN</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="3"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +3 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_OPENDIR"></a> +<h3>CMD_OPENDIR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="11"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +11 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_READ"></a> +<h3>CMD_READ</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="5"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +5 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_READDIR"></a> +<h3>CMD_READDIR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="12"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +12 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_READLINK"></a> +<h3>CMD_READLINK</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="19"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +19 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_REALPATH"></a> +<h3>CMD_REALPATH</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="16"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +16 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_REMOVE"></a> +<h3>CMD_REMOVE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="13"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +13 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_RENAME"></a> +<h3>CMD_RENAME</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="18"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +18 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_RMDIR"></a> +<h3>CMD_RMDIR</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="15"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +15 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_SETSTAT"></a> +<h3>CMD_SETSTAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="9"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +9 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_STAT"></a> +<h3>CMD_STAT</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="17"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +17 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_STATUS"></a> +<h3>CMD_STATUS</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="101"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +101 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_SYMLINK"></a> +<h3>CMD_SYMLINK</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="20"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +20 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_VERSION"></a> +<h3>CMD_VERSION</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="CMD_WRITE"></a> +<h3>CMD_WRITE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="6"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +6 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_BAD_MESSAGE"></a> +<h3>SFTP_BAD_MESSAGE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="5"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +5 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_CONNECTION_LOST"></a> +<h3>SFTP_CONNECTION_LOST</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="7"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +7 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_DESC"></a> +<h3>SFTP_DESC</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>list</code> + + </dd> +<span title="['Success', 'End of file', 'No such file', 'Permission denied', 'Failure', 'Bad message', 'No connection', 'Connection lost', 'Operation unsupported']"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +['Success', + 'End of file', + 'No such file', + 'Permission denied', + 'Failure', + 'Bad message', + 'No connection', + 'Connection lost', +<span class="variable-ellipsis">...</span> </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_EOF"></a> +<h3>SFTP_EOF</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FAILURE"></a> +<h3>SFTP_FAILURE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_APPEND"></a> +<h3>SFTP_FLAG_APPEND</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="4"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +4 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_CREATE"></a> +<h3>SFTP_FLAG_CREATE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_EXCL"></a> +<h3>SFTP_FLAG_EXCL</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="32"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +32 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_READ"></a> +<h3>SFTP_FLAG_READ</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="1"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +1 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_TRUNC"></a> +<h3>SFTP_FLAG_TRUNC</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="16"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +16 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_FLAG_WRITE"></a> +<h3>SFTP_FLAG_WRITE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_NO_CONNECTION"></a> +<h3>SFTP_NO_CONNECTION</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="6"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +6 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_NO_SUCH_FILE"></a> +<h3>SFTP_NO_SUCH_FILE</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="2"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +2 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_OK"></a> +<h3>SFTP_OK</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> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_OP_UNSUPPORTED"></a> +<h3>SFTP_OP_UNSUPPORTED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="8"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +8 </pre> + </td></tr></table></dd> +</span> </dl> + </dd> +</dl></td></tr></table> +<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td> +<a name="SFTP_PERMISSION_DENIED"></a> +<h3>SFTP_PERMISSION_DENIED</h3> +<dl> + <dt></dt> + <dd> + <dl> + <dt><b>Type:</b></dt> + <dd> + <code>int</code> + + </dd> +<span title="3"> <dt><b>Value:</b></dt> + <dd><table><tr><td> +<pre class="variable"> +3 </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.sftp_attr-module.html b/docs/public/paramiko.sftp_attr-module.html new file mode 100644 index 0000000..7ff2add --- /dev/null +++ b/docs/public/paramiko.sftp_attr-module.html @@ -0,0 +1,59 @@ +<?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>paramiko.sftp_attr</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_attr + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.sftp_attr-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_attr-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_attr</h2> + + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.sftp_client-module.html b/docs/public/paramiko.sftp_client-module.html new file mode 100644 index 0000000..a82e15f --- /dev/null +++ b/docs/public/paramiko.sftp_client-module.html @@ -0,0 +1,61 @@ +<?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>paramiko.sftp_client</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_client + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.sftp_client-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_client-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_client</h2> + +Client-mode SFTP support. +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.sftp_file-module.html b/docs/public/paramiko.sftp_file-module.html new file mode 100644 index 0000000..3d2f402 --- /dev/null +++ b/docs/public/paramiko.sftp_file-module.html @@ -0,0 +1,62 @@ +<?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>paramiko.sftp_file</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_file + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.sftp_file-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_file-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_file</h2> + +<a href="paramiko.SFTPFile-class.html" +class="link"><code>SFTPFile</code></a> +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.sftp_handle-module.html b/docs/public/paramiko.sftp_handle-module.html new file mode 100644 index 0000000..2a75e59 --- /dev/null +++ b/docs/public/paramiko.sftp_handle-module.html @@ -0,0 +1,61 @@ +<?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>paramiko.sftp_handle</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_handle + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.sftp_handle-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_handle-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_handle</h2> + +Abstraction of an SFTP file handle (for server mode). +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.sftp_server-module.html b/docs/public/paramiko.sftp_server-module.html new file mode 100644 index 0000000..06183af --- /dev/null +++ b/docs/public/paramiko.sftp_server-module.html @@ -0,0 +1,61 @@ +<?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>paramiko.sftp_server</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_server + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.sftp_server-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_server-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_server</h2> + +Server-mode SFTP support. +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.sftp_si-module.html b/docs/public/paramiko.sftp_si-module.html new file mode 100644 index 0000000..121d97e --- /dev/null +++ b/docs/public/paramiko.sftp_si-module.html @@ -0,0 +1,63 @@ +<?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>paramiko.sftp_si</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module sftp_si + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.sftp_si-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.sftp_si-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.sftp_si</h2> + +<a href="../private/paramiko.SFTPServerInterface-class.html" +class="link"><code>SFTPServerInterface</code></a> is an interface to +override for SFTP server support. +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.transport-module.html b/docs/public/paramiko.transport-module.html new file mode 100644 index 0000000..42d378f --- /dev/null +++ b/docs/public/paramiko.transport-module.html @@ -0,0 +1,63 @@ +<?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>paramiko.transport</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module transport + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.transport-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.transport-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.transport</h2> + +<a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> handles the core SSH2 +protocol. +<hr/> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/paramiko.util-module.html b/docs/public/paramiko.util-module.html new file mode 100644 index 0000000..a7ad4cd --- /dev/null +++ b/docs/public/paramiko.util-module.html @@ -0,0 +1,369 @@ +<?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>paramiko.util</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + Module util + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.util-module.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.util-module.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE DESCRIPTION =========== --> +<h2 class="module">Module paramiko.util</h2> + +Useful functions used by the rest of paramiko. +<hr/> + +<!-- =========== START OF CLASSES =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Classes</th></tr> +<tr><td width="15%"> + <b><a href="paramiko.util.PFilter-class.html"><code>PFilter</code></a></b></td> + <td> </td></tr> +</table><br /> + + +<!-- =========== START OF FUNCTION SUMMARY =========== --> +<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="summary"> + <th colspan="2">Function Summary</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="bit_length"></a><span class="summary-sig"><span class="summary-sig-name">bit_length</span>(<span class=summary-sig-arg>n</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="paramiko.util-module.html#deflate_long" class="summary-sig-name"><code>deflate_long</code></a>(<span class=summary-sig-arg>n</span>, + <span class=summary-sig-arg>add_sign_padding</span>)</span></code> +<br /> +turns a long-int into a normalized byte string (adapted from +Crypto.Util.number)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="format_binary"></a><span class="summary-sig"><span class="summary-sig-name">format_binary</span>(<span class=summary-sig-arg>data</span>, + <span class=summary-sig-arg>prefix</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="format_binary_line"></a><span class="summary-sig"><span class="summary-sig-name">format_binary_line</span>(<span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="format_binary_weird"></a><span class="summary-sig"><span class="summary-sig-name">format_binary_weird</span>(<span class=summary-sig-arg>data</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> string +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#generate_key_bytes" class="summary-sig-name"><code>generate_key_bytes</code></a>(<span class=summary-sig-arg>hashclass</span>, + <span class=summary-sig-arg>salt</span>, + <span class=summary-sig-arg>key</span>, + <span class=summary-sig-arg>nbytes</span>)</span></code> +<br /> +Given a password, passphrase, or other human-source key, scramble it +through a secure hash into some keyworthy bytes.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="get_logger"></a><span class="summary-sig"><span class="summary-sig-name">get_logger</span>(<span class=summary-sig-arg>name</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="get_thread_id"></a><span class="summary-sig"><span class="summary-sig-name">get_thread_id</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="paramiko.util-module.html#hexify" class="summary-sig-name"><code>hexify</code></a>(<span class=summary-sig-arg>s</span>)</span></code> +<br /> +turn a string into a hex sequence</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#inflate_long" class="summary-sig-name"><code>inflate_long</code></a>(<span class=summary-sig-arg>s</span>, + <span class=summary-sig-arg>always_positive</span>)</span></code> +<br /> +turns a normalized byte string into a long-int (adapted from +Crypto.Util.number)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> dict(hostname, dict(keytype, <a + href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)) +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#load_host_keys" class="summary-sig-name"><code>load_host_keys</code></a>(<span class=summary-sig-arg>filename</span>)</span></code> +<br /> +Read a file of known SSH host keys, in the format used by openssh, and +return a compound dict of <code>hostname -> keytype -></code> <a +href="../private/paramiko.PKey-class.html" +class="link"><code>PKey</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#log_to_file" class="summary-sig-name"><code>log_to_file</code></a>(<span class=summary-sig-arg>filename</span>, + <span class=summary-sig-arg>level</span>)</span></code> +<br /> +send paramiko logs to a logfile, if they're not already going +somewhere</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#lookup_ssh_host_config" class="summary-sig-name"><code>lookup_ssh_host_config</code></a>(<span class=summary-sig-arg>hostname</span>, + <span class=summary-sig-arg>config</span>)</span></code> +<br /> +Return a dict of config options for a given hostname.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="mod_inverse"></a><span class="summary-sig"><span class="summary-sig-name">mod_inverse</span>(<span class=summary-sig-arg>x</span>, + <span class=summary-sig-arg>m</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> object +</font></td> + <td><code><span class="summary-sig"><a href="paramiko.util-module.html#parse_ssh_config" class="summary-sig-name"><code>parse_ssh_config</code></a>(<span class=summary-sig-arg>file_obj</span>)</span></code> +<br /> +Parse a config file of the format used by OpenSSH, and return an +object that can be used to make queries to <a +href="paramiko.util-module.html#lookup_ssh_host_config" +class="link"><code>lookup_ssh_host_config</code></a>.</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="safe_string"></a><span class="summary-sig"><span class="summary-sig-name">safe_string</span>(<span class=summary-sig-arg>s</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="tb_strings"></a><span class="summary-sig"><span class="summary-sig-name">tb_strings</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="paramiko.util-module.html#unhexify" class="summary-sig-name"><code>unhexify</code></a>(<span class=summary-sig-arg>s</span>)</span></code> +<br /> +turn a hex sequence back into a string</td></tr> +</table><br /> + + +<!-- =========== START OF FUNCTION DETAILS =========== --> +<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> +<tr bgcolor="#70b0f0" class="details"> + <th colspan="2">Function Details</th></tr> +</table> + +<a name="deflate_long"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">deflate_long</span>(<span class=sig-arg>n</span>, + <span class=sig-arg>add_sign_padding</span>=<span class=sig-default>True</span>)</span> + </h3> + turns a long-int into a normalized byte string (adapted from + Crypto.Util.number) + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="generate_key_bytes"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">generate_key_bytes</span>(<span class=sig-arg>hashclass</span>, + <span class=sig-arg>salt</span>, + <span class=sig-arg>key</span>, + <span class=sig-arg>nbytes</span>)</span> + </h3> + Given a password, passphrase, or other human-source key, scramble it + through a secure hash into some keyworthy bytes. This specific + algorithm is used for encrypting/decrypting private key files. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hashclass</b></code> - + class from <code>Crypto.Hash</code> that can be used as a + secure hashing function (like <code>MD5</code> or + <code>SHA</code>). + <br /><i> + (type=<code>Crypto.Hash</code>)</i> + <dd><code><b>salt</b></code> - + data to salt the hash with. + <br /><i> + (type=string)</i> + <dd><code><b>key</b></code> - + human-entered password or passphrase. + <br /><i> + (type=string)</i> + <dd><code><b>nbytes</b></code> - + number of bytes to generate. + <br /><i> + (type=int)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + key data + <br /><i> + (type=string)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="hexify"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">hexify</span>(<span class=sig-arg>s</span>)</span> + </h3> + turn a string into a hex sequence + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="inflate_long"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">inflate_long</span>(<span class=sig-arg>s</span>, + <span class=sig-arg>always_positive</span>=<span class=sig-default>False</span>)</span> + </h3> + turns a normalized byte string into a long-int (adapted from + Crypto.Util.number) + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="load_host_keys"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">load_host_keys</span>(<span class=sig-arg>filename</span>)</span> + </h3> + <p>Read a file of known SSH host keys, in the format used by openssh, + and return a compound dict of <code>hostname -> keytype -></code> + <a href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>. The hostname may be an IP address + or DNS name. The keytype will be either + <code>"ssh-rsa"</code> or + <code>"ssh-dss"</code>.</p> + This type of file unfortunately doesn't exist on Windows, but on + posix, it will usually be stored in + <code>os.path.expanduser("~/.ssh/known_hosts")</code>. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>filename</b></code> - + name of the file to read host keys from + <br /><i> + (type=str)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + dict of host keys, indexed by hostname and then keytype + <br /><i> + (type=dict(hostname, dict(keytype, <a + href="../private/paramiko.PKey-class.html" + class="link"><code>PKey</code></a>)))</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="log_to_file"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">log_to_file</span>(<span class=sig-arg>filename</span>, + <span class=sig-arg>level</span>=<span class=sig-default>10</span>)</span> + </h3> + send paramiko logs to a logfile, if they're not already going + somewhere + <dl><dt></dt><dd> + </dd></dl> +</td></tr></table> + +<a name="lookup_ssh_host_config"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">lookup_ssh_host_config</span>(<span class=sig-arg>hostname</span>, + <span class=sig-arg>config</span>)</span> + </h3> + <p>Return a dict of config options for a given hostname. The + <code>config</code> object must come from <a + href="paramiko.util-module.html#parse_ssh_config" + class="link"><code>parse_ssh_config</code></a>.</p> + <p>The host-matching rules of OpenSSH's <code>ssh_config</code> man + page are used, which means that all configuration options from matching + host specifications are merged, with more specific hostmasks taking + precedence. In other words, if <code>"Port"</code> is set + under <code>"Host *"</code> and also <code>"Host + *.example.com"</code>, and the lookup is for + <code>"ssh.example.com"</code>, then the port entry for + <code>"Host *.example.com"</code> will win out.</p> + The keys in the returned dict are all normalized to lowercase (look + for <code>"port"</code>, not <code>"Port"</code>. + No other processing is done to the keys or values. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>hostname</b></code> - + the hostname to lookup + <br /><i> + (type=str)</i> + <dd><code><b>config</b></code> - + the config object to search + <br /><i> + (type=object)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="parse_ssh_config"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">parse_ssh_config</span>(<span class=sig-arg>file_obj</span>)</span> + </h3> + <p>Parse a config file of the format used by OpenSSH, and return an + object that can be used to make queries to <a + href="paramiko.util-module.html#lookup_ssh_host_config" + class="link"><code>lookup_ssh_host_config</code></a>. The format is + described in OpenSSH's <code>ssh_config</code> man page. This method is + provided primarily as a convenience to posix users (since the OpenSSH + format is a de-facto standard on posix) but should work fine on Windows + too.</p> + The return value is currently a list of dictionaries, each + containing host-specific configuration, but this is considered an + implementation detail and may be subject to change in later + versions. + <dl><dt></dt><dd> + <dl><dt><b>Parameters:</b></dt> + <dd><code><b>file_obj</b></code> - + a file-like object to read the config file from + <br /><i> + (type=file)</i> + </dd> + </dl> + <dl><dt><b>Returns:</b></dt> + <dd> + opaque configuration object + <br /><i> + (type=object)</i> + </dd> + </dl> + </dd></dl> +</td></tr></table> + +<a name="unhexify"></a> +<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> + <h3><span class="sig"><span class="sig-name">unhexify</span>(<span class=sig-arg>s</span>)</span> + </h3> + turn a hex sequence back into a string + <dl><dt></dt><dd> + </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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/paramiko.util.PFilter-class.html b/docs/public/paramiko.util.PFilter-class.html new file mode 100644 index 0000000..f1e8059 --- /dev/null +++ b/docs/public/paramiko.util.PFilter-class.html @@ -0,0 +1,124 @@ +<?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>paramiko.util.PFilter</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + <a href="paramiko-module.html">Package paramiko</a> :: + <a href="paramiko.util-module.html">Module util</a> :: + Class PFilter + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/paramiko.util.PFilter-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="paramiko.util.PFilter-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type PFilter</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <b>PFilter</b> +</pre><br /> + +<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><a name="filter"></a><span class="summary-sig"><span class="summary-sig-name">filter</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>record</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__init__(...) initializes x; see x.__class__.__doc__ for +signature</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__repr__() <==> repr(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> diff --git a/docs/public/threading.Thread-class.html b/docs/public/threading.Thread-class.html new file mode 100644 index 0000000..951099e --- /dev/null +++ b/docs/public/threading.Thread-class.html @@ -0,0 +1,161 @@ +<?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>threading.Thread</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="paramiko-module.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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + <font size="-1"><b class="breadcrumbs"> + Module threading :: + Class Thread + </b></font></br> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/threading.Thread-class.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="threading.Thread-class.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF CLASS DESCRIPTION =========== --> +<h2 class="class">Type Thread</h2> + +<pre class="base-tree"> +<a href="__builtin__.object-class.html"><code>object</code></a> --+ + | + <a href="../private/threading._Verbose-class.html"><code>_Verbose</code></a> --+ + | + <b>Thread</b> +</pre><br /> + +<dl><dt><b>Known Subclasses:</b></dt> +<dd> + <a href="paramiko.SubsystemHandler-class.html"><code>SubsystemHandler</code></a>, + <a href="paramiko.Transport-class.html"><code>Transport</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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>group</span>, + <span class=summary-sig-arg>target</span>, + <span class=summary-sig-arg>name</span>, + <span class=summary-sig-arg>args</span>, + <span class=summary-sig-arg>kwargs</span>, + <span class=summary-sig-arg>verbose</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1">(type, value, traceback)</font></td> + <td><code><span class="summary-sig"><code>__exc_info</code>()</span></code> +<br /> +Return information about the most recent exception caught by an except +clause in the current stack frame or in an older stack frame.</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><a name="getName"></a><span class="summary-sig"><span class="summary-sig-name">getName</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><a name="isAlive"></a><span class="summary-sig"><span class="summary-sig-name">isAlive</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><a name="isDaemon"></a><span class="summary-sig"><span class="summary-sig-name">isDaemon</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><a name="join"></a><span class="summary-sig"><span class="summary-sig-name">join</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>timeout</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="run"></a><span class="summary-sig"><span class="summary-sig-name">run</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><a name="setDaemon"></a><span class="summary-sig"><span class="summary-sig-name">setDaemon</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>daemonic</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="setName"></a><span class="summary-sig"><span class="summary-sig-name">setName</span>(<span class=summary-sig-arg>self</span>, + <span class=summary-sig-arg>name</span>)</span></code> +</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><a name="start"></a><span class="summary-sig"><span class="summary-sig-name">start</span>(<span class=summary-sig-arg>self</span>)</span></code> +</td></tr> +<tr bgcolor="#e8f0f8" class="group"> + <th colspan="2"> Inherited from object</th></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__delattr__('name') <==> del x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__getattribute__" class="summary-sig-name"><code>__getattribute__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__getattribute__('name') <==> x.name</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__hash__() <==> hash(x)</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__new__" class="summary-sig-name"><code>__new__</code></a>(<span class=summary-sig-arg>T</span>, + <span class=summary-sig-arg>S</span>, + <span class="summary-sig-vararg">...</span>)</span></code> +<br /> +T.__new__(S, ...) -> a new object with type S, a subtype of T</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce__" class="summary-sig-name"><code>__reduce__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__reduce_ex__" class="summary-sig-name"><code>__reduce_ex__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +helper for pickle</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class="summary-sig-vararg">...</span>)</span></code> +<br /> +x.__setattr__('name', value) <==> x.name = value</td></tr> +<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> + <td><code><span class="summary-sig"><a href="__builtin__.object-class.html#__str__" class="summary-sig-name"><code>__str__</code></a>(<span class=summary-sig-arg>x</span>)</span></code> +<br /> +x.__str__() <==> str(x)</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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005</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> diff --git a/docs/public/toc-everything.html b/docs/public/toc-everything.html new file mode 100644 index 0000000..e699f06 --- /dev/null +++ b/docs/public/toc-everything.html @@ -0,0 +1,121 @@ +<?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>Everything</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b>Everything</b></font></center> +<hr> + +<!-- =========== START OF ALL CLASSES =========== --> +<font size="+1"><b>All Classes</b></font><br /> +<a target="mainFrame" href="paramiko.Agent-class.html">paramiko.Agent</a><br /> +<a target="mainFrame" href="paramiko.AgentKey-class.html">paramiko.AgentKey</a><br /> +<a target="mainFrame" href="paramiko.BufferedFile-class.html">paramiko.BufferedFile</a><br /> +<a target="mainFrame" href="paramiko.Channel-class.html">paramiko.Channel</a><br /> +<a target="mainFrame" href="paramiko.DSSKey-class.html">paramiko.DSSKey</a><br /> +<a target="mainFrame" href="paramiko.Message-class.html">paramiko.Message</a><br /> +<a target="mainFrame" href="paramiko.RSAKey-class.html">paramiko.RSAKey</a><br /> +<a target="mainFrame" href="paramiko.SecurityOptions-class.html">paramiko.SecurityOptions</a><br /> +<a target="mainFrame" href="paramiko.server.InteractiveQuery-class.html">paramiko.server.InteractiveQuery</a><br /> +<a target="mainFrame" href="paramiko.SFTP-class.html">paramiko.SFTP</a><br /> +<a target="mainFrame" href="paramiko.SFTPAttributes-class.html">paramiko.SFTPAttributes</a><br /> +<a target="mainFrame" href="paramiko.SFTPClient-class.html">paramiko.SFTPClient</a><br /> +<a target="mainFrame" href="paramiko.SFTPFile-class.html">paramiko.SFTPFile</a><br /> +<a target="mainFrame" href="paramiko.SFTPHandle-class.html">paramiko.SFTPHandle</a><br /> +<a target="mainFrame" href="paramiko.SFTPServer-class.html">paramiko.SFTPServer</a><br /> +<a target="mainFrame" href="paramiko.SubsystemHandler-class.html">paramiko.SubsystemHandler</a><br /> +<a target="mainFrame" href="paramiko.Transport-class.html">paramiko.Transport</a><br /> +<a target="mainFrame" href="paramiko.util.PFilter-class.html">paramiko.util.PFilter</a><br /> +<br /> + +<!-- =========== START OF ALL EXCEPTIONS =========== --> +<font size="+1"><b>All Exceptions</b></font><br /> +<a target="mainFrame" href="paramiko.BadAuthenticationType-class.html">paramiko.BadAuthenticationType</a><br /> +<a target="mainFrame" href="paramiko.PasswordRequiredException-class.html">paramiko.PasswordRequiredException</a><br /> +<a target="mainFrame" href="paramiko.SFTPError-class.html">paramiko.SFTPError</a><br /> +<a target="mainFrame" href="paramiko.SSHException-class.html">paramiko.SSHException</a><br /> +<br /> + +<!-- =========== START OF ALL FUNCTIONS =========== --> +<font size="+1"><b>All Functions</b></font><br /> +<a target="mainFrame" href="paramiko.util-module.html#bit_length">bit_length</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#deflate_long">deflate_long</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary">format_binary</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary_line">format_binary_line</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary_weird">format_binary_weird</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#generate_key_bytes">generate_key_bytes</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#get_logger">get_logger</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#get_thread_id">get_thread_id</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#hexify">hexify</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#inflate_long">inflate_long</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#load_host_keys">load_host_keys</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#log_to_file">log_to_file</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#lookup_ssh_host_config">lookup_ssh_host_config</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#mod_inverse">mod_inverse</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#parse_ssh_config">parse_ssh_config</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#safe_string">safe_string</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#tb_strings">tb_strings</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#unhexify">unhexify</a><br /> +<br /> + +<!-- =========== START OF ALL VARIABLES =========== --> +<font size="+1"><b>All Variables</b></font><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_ATTRS">CMD_ATTRS</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_CLOSE">CMD_CLOSE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_DATA">CMD_DATA</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_EXTENDED">CMD_EXTENDED</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_EXTENDED_REPLY">CMD_EXTENDED_REPLY</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_FSETSTAT">CMD_FSETSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_FSTAT">CMD_FSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_HANDLE">CMD_HANDLE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_INIT">CMD_INIT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_LSTAT">CMD_LSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_MKDIR">CMD_MKDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_NAME">CMD_NAME</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_NAMES">CMD_NAMES</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_OPEN">CMD_OPEN</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_OPENDIR">CMD_OPENDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READ">CMD_READ</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READDIR">CMD_READDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READLINK">CMD_READLINK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_REALPATH">CMD_REALPATH</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_REMOVE">CMD_REMOVE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_RENAME">CMD_RENAME</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_RMDIR">CMD_RMDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_SETSTAT">CMD_SETSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_STAT">CMD_STAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_STATUS">CMD_STATUS</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_SYMLINK">CMD_SYMLINK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_VERSION">CMD_VERSION</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_WRITE">CMD_WRITE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_BAD_MESSAGE">SFTP_BAD_MESSAGE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_CONNECTION_LOST">SFTP_CONNECTION_LOST</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_DESC">SFTP_DESC</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_EOF">SFTP_EOF</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FAILURE">SFTP_FAILURE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_APPEND">SFTP_FLAG_APPEND</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_CREATE">SFTP_FLAG_CREATE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_EXCL">SFTP_FLAG_EXCL</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_READ">SFTP_FLAG_READ</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_TRUNC">SFTP_FLAG_TRUNC</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_WRITE">SFTP_FLAG_WRITE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_NO_CONNECTION">SFTP_NO_CONNECTION</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_NO_SUCH_FILE">SFTP_NO_SUCH_FILE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_OK">SFTP_OK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_OP_UNSUPPORTED">SFTP_OP_UNSUPPORTED</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_PERMISSION_DENIED">SFTP_PERMISSION_DENIED</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENT_IDENTITIES_ANSWER">SSH2_AGENT_IDENTITIES_ANSWER</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENT_SIGN_RESPONSE">SSH2_AGENT_SIGN_RESPONSE</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENTC_REQUEST_IDENTITIES">SSH2_AGENTC_REQUEST_IDENTITIES</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENTC_SIGN_REQUEST">SSH2_AGENTC_SIGN_REQUEST</a><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-everything.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko-module.html b/docs/public/toc-paramiko-module.html new file mode 100644 index 0000000..7353601 --- /dev/null +++ b/docs/public/toc-paramiko-module.html @@ -0,0 +1,69 @@ +<?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>paramiko</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko-module.html">paramiko</a></b></font></center> +<hr> + +<!-- =========== START OF MODULES =========== --> +<font size="+1"><b>Modules</b></font><br /> +<a target="mainFrame" href="paramiko.agent-module.html">agent</a><br /> +<a target="mainFrame" href="paramiko.dsskey-module.html">dsskey</a><br /> +<a target="mainFrame" href="paramiko.file-module.html">file</a><br /> +<a target="mainFrame" href="paramiko.message-module.html">message</a><br /> +<a target="mainFrame" href="paramiko.pkey-module.html">pkey</a><br /> +<a target="mainFrame" href="paramiko.rsakey-module.html">rsakey</a><br /> +<a target="mainFrame" href="paramiko.server-module.html">server</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html">sftp</a><br /> +<a target="mainFrame" href="paramiko.sftp_attr-module.html">sftp_attr</a><br /> +<a target="mainFrame" href="paramiko.sftp_client-module.html">sftp_client</a><br /> +<a target="mainFrame" href="paramiko.sftp_file-module.html">sftp_file</a><br /> +<a target="mainFrame" href="paramiko.sftp_handle-module.html">sftp_handle</a><br /> +<a target="mainFrame" href="paramiko.sftp_server-module.html">sftp_server</a><br /> +<a target="mainFrame" href="paramiko.sftp_si-module.html">sftp_si</a><br /> +<a target="mainFrame" href="paramiko.transport-module.html">transport</a><br /> +<a target="mainFrame" href="paramiko.util-module.html">util</a><br /> +<br /> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="paramiko.Agent-class.html">Agent</a><br /> +<a target="mainFrame" href="paramiko.AgentKey-class.html">AgentKey</a><br /> +<a target="mainFrame" href="paramiko.BufferedFile-class.html">BufferedFile</a><br /> +<a target="mainFrame" href="paramiko.Channel-class.html">Channel</a><br /> +<a target="mainFrame" href="paramiko.DSSKey-class.html">DSSKey</a><br /> +<a target="mainFrame" href="paramiko.Message-class.html">Message</a><br /> +<a target="mainFrame" href="paramiko.RSAKey-class.html">RSAKey</a><br /> +<a target="mainFrame" href="paramiko.SecurityOptions-class.html">SecurityOptions</a><br /> +<a target="mainFrame" href="paramiko.SFTP-class.html">SFTP</a><br /> +<a target="mainFrame" href="paramiko.SFTPAttributes-class.html">SFTPAttributes</a><br /> +<a target="mainFrame" href="paramiko.SFTPClient-class.html">SFTPClient</a><br /> +<a target="mainFrame" href="paramiko.SFTPFile-class.html">SFTPFile</a><br /> +<a target="mainFrame" href="paramiko.SFTPHandle-class.html">SFTPHandle</a><br /> +<a target="mainFrame" href="paramiko.SFTPServer-class.html">SFTPServer</a><br /> +<a target="mainFrame" href="paramiko.SubsystemHandler-class.html">SubsystemHandler</a><br /> +<a target="mainFrame" href="paramiko.Transport-class.html">Transport</a><br /> +<br /> + +<!-- =========== START OF EXCEPTIONS =========== --> +<font size="+1"><b>Exceptions</b></font><br /> +<a target="mainFrame" href="paramiko.BadAuthenticationType-class.html">BadAuthenticationType</a><br /> +<a target="mainFrame" href="paramiko.PasswordRequiredException-class.html">PasswordRequiredException</a><br /> +<a target="mainFrame" href="paramiko.SFTPError-class.html">SFTPError</a><br /> +<a target="mainFrame" href="paramiko.SSHException-class.html">SSHException</a><br /> +<br /> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.agent-module.html b/docs/public/toc-paramiko.agent-module.html new file mode 100644 index 0000000..543e5af --- /dev/null +++ b/docs/public/toc-paramiko.agent-module.html @@ -0,0 +1,25 @@ +<?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>paramiko.agent</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.agent-module.html">agent</a></b></font></center> +<hr> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENT_IDENTITIES_ANSWER">SSH2_AGENT_IDENTITIES_ANSWER</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENT_SIGN_RESPONSE">SSH2_AGENT_SIGN_RESPONSE</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENTC_REQUEST_IDENTITIES">SSH2_AGENTC_REQUEST_IDENTITIES</a><br /> +<a target="mainFrame" href="paramiko.agent-module.html#SSH2_AGENTC_SIGN_REQUEST">SSH2_AGENTC_SIGN_REQUEST</a><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.agent-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.dsskey-module.html b/docs/public/toc-paramiko.dsskey-module.html new file mode 100644 index 0000000..7f5fddb --- /dev/null +++ b/docs/public/toc-paramiko.dsskey-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.dsskey</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.dsskey-module.html">dsskey</a></b></font></center> +<hr> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.dsskey-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.file-module.html b/docs/public/toc-paramiko.file-module.html new file mode 100644 index 0000000..9c02537 --- /dev/null +++ b/docs/public/toc-paramiko.file-module.html @@ -0,0 +1,21 @@ +<?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>paramiko.file</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.file-module.html">file</a></b></font></center> +<hr> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.file-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.message-module.html b/docs/public/toc-paramiko.message-module.html new file mode 100644 index 0000000..14ecd78 --- /dev/null +++ b/docs/public/toc-paramiko.message-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.message</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.message-module.html">message</a></b></font></center> +<hr> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.message-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.pkey-module.html b/docs/public/toc-paramiko.pkey-module.html new file mode 100644 index 0000000..a2c0c5b --- /dev/null +++ b/docs/public/toc-paramiko.pkey-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.pkey</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.pkey-module.html">pkey</a></b></font></center> +<hr> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.pkey-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.rsakey-module.html b/docs/public/toc-paramiko.rsakey-module.html new file mode 100644 index 0000000..ceceb19 --- /dev/null +++ b/docs/public/toc-paramiko.rsakey-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.rsakey</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.rsakey-module.html">rsakey</a></b></font></center> +<hr> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.rsakey-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.server-module.html b/docs/public/toc-paramiko.server-module.html new file mode 100644 index 0000000..c01d6d6 --- /dev/null +++ b/docs/public/toc-paramiko.server-module.html @@ -0,0 +1,22 @@ +<?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>paramiko.server</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.server-module.html">server</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="paramiko.server.InteractiveQuery-class.html">InteractiveQuery</a><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.server-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.sftp-module.html b/docs/public/toc-paramiko.sftp-module.html new file mode 100644 index 0000000..52f03a3 --- /dev/null +++ b/docs/public/toc-paramiko.sftp-module.html @@ -0,0 +1,65 @@ +<?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>paramiko.sftp</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp-module.html">sftp</a></b></font></center> +<hr> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_ATTRS">CMD_ATTRS</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_CLOSE">CMD_CLOSE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_DATA">CMD_DATA</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_EXTENDED">CMD_EXTENDED</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_EXTENDED_REPLY">CMD_EXTENDED_REPLY</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_FSETSTAT">CMD_FSETSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_FSTAT">CMD_FSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_HANDLE">CMD_HANDLE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_INIT">CMD_INIT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_LSTAT">CMD_LSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_MKDIR">CMD_MKDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_NAME">CMD_NAME</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_NAMES">CMD_NAMES</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_OPEN">CMD_OPEN</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_OPENDIR">CMD_OPENDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READ">CMD_READ</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READDIR">CMD_READDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_READLINK">CMD_READLINK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_REALPATH">CMD_REALPATH</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_REMOVE">CMD_REMOVE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_RENAME">CMD_RENAME</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_RMDIR">CMD_RMDIR</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_SETSTAT">CMD_SETSTAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_STAT">CMD_STAT</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_STATUS">CMD_STATUS</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_SYMLINK">CMD_SYMLINK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_VERSION">CMD_VERSION</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#CMD_WRITE">CMD_WRITE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_BAD_MESSAGE">SFTP_BAD_MESSAGE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_CONNECTION_LOST">SFTP_CONNECTION_LOST</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_DESC">SFTP_DESC</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_EOF">SFTP_EOF</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FAILURE">SFTP_FAILURE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_APPEND">SFTP_FLAG_APPEND</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_CREATE">SFTP_FLAG_CREATE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_EXCL">SFTP_FLAG_EXCL</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_READ">SFTP_FLAG_READ</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_TRUNC">SFTP_FLAG_TRUNC</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_FLAG_WRITE">SFTP_FLAG_WRITE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_NO_CONNECTION">SFTP_NO_CONNECTION</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_NO_SUCH_FILE">SFTP_NO_SUCH_FILE</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_OK">SFTP_OK</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_OP_UNSUPPORTED">SFTP_OP_UNSUPPORTED</a><br /> +<a target="mainFrame" href="paramiko.sftp-module.html#SFTP_PERMISSION_DENIED">SFTP_PERMISSION_DENIED</a><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.sftp-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.sftp_attr-module.html b/docs/public/toc-paramiko.sftp_attr-module.html new file mode 100644 index 0000000..080044e --- /dev/null +++ b/docs/public/toc-paramiko.sftp_attr-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.sftp_attr</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_attr-module.html">sftp_attr</a></b></font></center> +<hr> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.sftp_attr-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.sftp_client-module.html b/docs/public/toc-paramiko.sftp_client-module.html new file mode 100644 index 0000000..7bf1ad8 --- /dev/null +++ b/docs/public/toc-paramiko.sftp_client-module.html @@ -0,0 +1,21 @@ +<?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>paramiko.sftp_client</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_client-module.html">sftp_client</a></b></font></center> +<hr> + +<!-- =========== START OF FUNCTIONS =========== --> +<font size="+1"><b>Functions</b></font><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.sftp_client-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.sftp_file-module.html b/docs/public/toc-paramiko.sftp_file-module.html new file mode 100644 index 0000000..aee1350 --- /dev/null +++ b/docs/public/toc-paramiko.sftp_file-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.sftp_file</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_file-module.html">sftp_file</a></b></font></center> +<hr> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.sftp_file-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.sftp_handle-module.html b/docs/public/toc-paramiko.sftp_handle-module.html new file mode 100644 index 0000000..fc8b60a --- /dev/null +++ b/docs/public/toc-paramiko.sftp_handle-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.sftp_handle</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_handle-module.html">sftp_handle</a></b></font></center> +<hr> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.sftp_handle-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.sftp_server-module.html b/docs/public/toc-paramiko.sftp_server-module.html new file mode 100644 index 0000000..93677ba --- /dev/null +++ b/docs/public/toc-paramiko.sftp_server-module.html @@ -0,0 +1,21 @@ +<?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>paramiko.sftp_server</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_server-module.html">sftp_server</a></b></font></center> +<hr> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.sftp_server-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.sftp_si-module.html b/docs/public/toc-paramiko.sftp_si-module.html new file mode 100644 index 0000000..58a1d30 --- /dev/null +++ b/docs/public/toc-paramiko.sftp_si-module.html @@ -0,0 +1,17 @@ +<?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>paramiko.sftp_si</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.sftp_si-module.html">sftp_si</a></b></font></center> +<hr> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.sftp_si-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.transport-module.html b/docs/public/toc-paramiko.transport-module.html new file mode 100644 index 0000000..14e73b4 --- /dev/null +++ b/docs/public/toc-paramiko.transport-module.html @@ -0,0 +1,25 @@ +<?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>paramiko.transport</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.transport-module.html">transport</a></b></font></center> +<hr> + +<!-- =========== START OF FUNCTIONS =========== --> +<font size="+1"><b>Functions</b></font><br /> +<br /> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.transport-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc-paramiko.util-module.html b/docs/public/toc-paramiko.util-module.html new file mode 100644 index 0000000..1224321 --- /dev/null +++ b/docs/public/toc-paramiko.util-module.html @@ -0,0 +1,48 @@ +<?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>paramiko.util</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b><a target="mainFrame" href="paramiko.util-module.html">util</a></b></font></center> +<hr> + +<!-- =========== START OF CLASSES =========== --> +<font size="+1"><b>Classes</b></font><br /> +<a target="mainFrame" href="paramiko.util.PFilter-class.html">PFilter</a><br /> +<br /> + +<!-- =========== START OF FUNCTIONS =========== --> +<font size="+1"><b>Functions</b></font><br /> +<a target="mainFrame" href="paramiko.util-module.html#bit_length">bit_length</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#deflate_long">deflate_long</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary">format_binary</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary_line">format_binary_line</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#format_binary_weird">format_binary_weird</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#generate_key_bytes">generate_key_bytes</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#get_logger">get_logger</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#get_thread_id">get_thread_id</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#hexify">hexify</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#inflate_long">inflate_long</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#load_host_keys">load_host_keys</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#log_to_file">log_to_file</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#lookup_ssh_host_config">lookup_ssh_host_config</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#mod_inverse">mod_inverse</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#parse_ssh_config">parse_ssh_config</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#safe_string">safe_string</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#tb_strings">tb_strings</a><br /> +<a target="mainFrame" href="paramiko.util-module.html#unhexify">unhexify</a><br /> +<br /> + +<!-- =========== START OF VARIABLES =========== --> +<font size="+1"><b>Variables</b></font><br /> +<br /> + +<hr> +<font size="-2">[<a href="../private/toc-paramiko.util-module.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/toc.html b/docs/public/toc.html new file mode 100644 index 0000000..a99a3d0 --- /dev/null +++ b/docs/public/toc.html @@ -0,0 +1,41 @@ +<?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>Table of Contents</title> + <link rel="stylesheet" href="epydoc.css" type="text/css"></link> +</head> +<body bgcolor="white" text="black" link="blue" vlink="#204080" + alink="#204080"> +<center><font size="+1"><b>Table of Contents</b></font></center> +<hr> +<a target="moduleFrame" href="toc-everything.html">Everything</a><br /> + +<!-- =========== START OF PACKAGES =========== --> +<br /><font size="+1"><b>Packages</b></font><br /> +<a target="moduleFrame" href="toc-paramiko-module.html">paramiko</a><br /> + +<!-- =========== START OF MODULES =========== --> +<br /><font size="+1"><b>Modules</b></font><br /> +<a target="moduleFrame" href="toc-paramiko.agent-module.html">paramiko.agent</a><br /> +<a target="moduleFrame" href="toc-paramiko.dsskey-module.html">paramiko.dsskey</a><br /> +<a target="moduleFrame" href="toc-paramiko.file-module.html">paramiko.file</a><br /> +<a target="moduleFrame" href="toc-paramiko.message-module.html">paramiko.message</a><br /> +<a target="moduleFrame" href="toc-paramiko.pkey-module.html">paramiko.pkey</a><br /> +<a target="moduleFrame" href="toc-paramiko.rsakey-module.html">paramiko.rsakey</a><br /> +<a target="moduleFrame" href="toc-paramiko.server-module.html">paramiko.server</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp-module.html">paramiko.sftp</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_attr-module.html">paramiko.sftp_attr</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_client-module.html">paramiko.sftp_client</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_file-module.html">paramiko.sftp_file</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_handle-module.html">paramiko.sftp_handle</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_server-module.html">paramiko.sftp_server</a><br /> +<a target="moduleFrame" href="toc-paramiko.sftp_si-module.html">paramiko.sftp_si</a><br /> +<a target="moduleFrame" href="toc-paramiko.transport-module.html">paramiko.transport</a><br /> +<a target="moduleFrame" href="toc-paramiko.util-module.html">paramiko.util</a><br /> + +<br /><hr> +<font size="-2">[<a href="../private/toc.html">show private</a> | hide private]</font> +</body> +</html> diff --git a/docs/public/trees.html b/docs/public/trees.html new file mode 100644 index 0000000..6c85192 --- /dev/null +++ b/docs/public/trees.html @@ -0,0 +1,151 @@ +<?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>Module and Class Hierarchies</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="paramiko-module.html">Home</a> </th> + <th bgcolor="#70b0f0" class="navselect"> Trees </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" width="100%"></th> + </tr> +</table> +<table width="100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td width="100%"> + </td> + <td><table cellpadding="0" cellspacing="0"> + <tr><td align="right"><font size="-2">[<a href="../private/trees.html">show private</a> | hide private]</font></td></tr> + <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="trees.html" target="_top">no frames</a>]</font></td></tr> + </table></td> +</tr></table> + +<!-- =========== START OF MODULE HIERARCHY =========== --> +<h2>Module Hierarchy</h2> +<ul> +<li> <b><a href="paramiko-module.html"><code>paramiko</code></a></b>: <i><i>Paramiko</i> (a combination of the esperanto words for +"paranoid" and "friend") is a module for python 2.3 +or greater that implements the SSH2 protocol for secure (encrypted and +authenticated) connections to remote machines.</i> + <ul> + <li> <b><a href="paramiko.agent-module.html"><code>agent</code></a></b>: <i>SSH Agent interface for Unix clients.</i> + <li> <b><a href="paramiko.dsskey-module.html"><code>dsskey</code></a></b>: <i><a href="paramiko.DSSKey-class.html" +class="link"><code>DSSKey</code></a></i> + <li> <b><a href="paramiko.file-module.html"><code>file</code></a></b>: <i>BufferedFile.</i> + <li> <b><a href="paramiko.message-module.html"><code>message</code></a></b>: <i>Implementation of an SSH2 "message".</i> + <li> <b><a href="paramiko.pkey-module.html"><code>pkey</code></a></b>: <i>Common API for all public keys.</i> + <li> <b><a href="paramiko.rsakey-module.html"><code>rsakey</code></a></b>: <i><a href="paramiko.RSAKey-class.html" +class="link"><code>RSAKey</code></a></i> + <li> <b><a href="paramiko.server-module.html"><code>server</code></a></b>: <i><a href="../private/paramiko.ServerInterface-class.html" +class="link"><code>ServerInterface</code></a> is an interface to override +for server support.</i> + <li> <b><a href="paramiko.sftp-module.html"><code>sftp</code></a></b> + <li> <b><a href="paramiko.sftp_attr-module.html"><code>sftp_attr</code></a></b> + <li> <b><a href="paramiko.sftp_client-module.html"><code>sftp_client</code></a></b>: <i>Client-mode SFTP support.</i> + <li> <b><a href="paramiko.sftp_file-module.html"><code>sftp_file</code></a></b>: <i><a href="paramiko.SFTPFile-class.html" +class="link"><code>SFTPFile</code></a></i> + <li> <b><a href="paramiko.sftp_handle-module.html"><code>sftp_handle</code></a></b>: <i>Abstraction of an SFTP file handle (for server mode).</i> + <li> <b><a href="paramiko.sftp_server-module.html"><code>sftp_server</code></a></b>: <i>Server-mode SFTP support.</i> + <li> <b><a href="paramiko.sftp_si-module.html"><code>sftp_si</code></a></b>: <i><a href="../private/paramiko.SFTPServerInterface-class.html" +class="link"><code>SFTPServerInterface</code></a> is an interface to +override for SFTP server support.</i> + <li> <b><a href="paramiko.transport-module.html"><code>transport</code></a></b>: <i><a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a> handles the core SSH2 +protocol.</i> + <li> <b><a href="paramiko.util-module.html"><code>util</code></a></b>: <i>Useful functions used by the rest of paramiko.</i> + </ul> +</ul> + +<!-- =========== START OF CLASS HIERARCHY =========== --> +<h2>Class Hierarchy</h2> +<ul> + <li> <b><a href="__builtin__.object-class.html"><code>__builtin__.object</code></a></b>: <i> +The most base type</i> + <ul> + <li> <b><a href="paramiko.BufferedFile-class.html"><code>paramiko.BufferedFile</code></a></b>: <i> +Reusable base class to implement python-style file buffering around a +simpler stream.</i> + <ul> + <li> <b><a href="paramiko.SFTPFile-class.html"><code>paramiko.SFTPFile</code></a></b>: <i> +Proxy object for a file on the remote server, in client mode SFTP.</i> + </ul> + <li> <b><a href="paramiko.Channel-class.html"><code>paramiko.Channel</code></a></b>: <i> +A secure tunnel across an SSH <a href="paramiko.Transport-class.html" +class="link"><code>Transport</code></a>.</i> + <li> <b><a href="paramiko.server.InteractiveQuery-class.html"><code>paramiko.server.InteractiveQuery</code></a></b>: <i> +A query (set of prompts) for a user during interactive +authentication.</i> + <li> <b><a href="paramiko.Message-class.html"><code>paramiko.Message</code></a></b>: <i> +An SSH2 <i>Message</i> is a stream of bytes that encodes some +combination of strings, integers, bools, and infinite-precision integers +(known in python as <i>long</i>s).</i> + <li> <b><a href="paramiko.util.PFilter-class.html"><code>paramiko.util.PFilter</code></a></b> + <li> <b><a href="paramiko.SecurityOptions-class.html"><code>paramiko.SecurityOptions</code></a></b>: <i> +Simple object containing the security preferences of an ssh +transport.</i> + <li> <b><a href="paramiko.SFTPAttributes-class.html"><code>paramiko.SFTPAttributes</code></a></b>: <i> +Representation of the attributes of a file (or proxied file) for SFTP +in client or server mode.</i> + <li> <b><a href="paramiko.SFTPHandle-class.html"><code>paramiko.SFTPHandle</code></a></b>: <i> +Abstract object representing a handle to an open file (or folder) in +an SFTP server implementation.</i> + <li> <b><a href="__builtin__.type-class.html"><code>__builtin__.type</code></a></b>: <i> +type(object) -> the object's type type(name, bases, dict) -> a +new type</i> + <ul> + </ul> + <ul> + </ul> + <ul> + </ul> + </ul> + <li> <b><a href="exceptions.Exception-class.html"><code>exceptions.Exception</code></a></b>: <i> +Common base class for all exceptions.</i> + <ul> + <li> <b><a href="paramiko.SFTPError-class.html"><code>paramiko.SFTPError</code></a></b> + <li> <b><a href="paramiko.SSHException-class.html"><code>paramiko.SSHException</code></a></b>: <i> +Exception raised by failures in SSH2 protocol negotiation or logic +errors.</i> + <ul> + <li> <b><a href="paramiko.BadAuthenticationType-class.html"><code>paramiko.BadAuthenticationType</code></a></b>: <i> +Exception raised when an authentication type (like password) is used, +but the server isn't allowing that type.</i> + <li> <b><a href="paramiko.PasswordRequiredException-class.html"><code>paramiko.PasswordRequiredException</code></a></b>: <i> +Exception raised when a password is needed to unlock a private key +file.</i> + </ul> + </ul> + <li> <b><a href="paramiko.Agent-class.html"><code>paramiko.Agent</code></a></b>: <i> +Client interface for using private keys from an SSH agent running on +the local machine.</i> +</ul> + +<!-- =========== 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="paramiko-module.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" width="100%"></th> + </tr> +</table> + +<table border="0" cellpadding="0" cellspacing="0" width="100%"> + <tr> + <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005</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> |