summaryrefslogtreecommitdiff
path: root/docs/private/trees.html
blob: d762eb62e9f63642226f9fb83e817a5d050f22d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="paramiko-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th bgcolor="#70b0f0" class="navselect">&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;private&nbsp;|&nbsp;<a href="../public/trees.html">hide&nbsp;private</a>]</font></td></tr>
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="trees.html" target="_top">no&nbsp;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 
&quot;paranoid&quot; and &quot;friend&quot;) 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 &quot;message&quot;.</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 &quot;p&quot; and 
generator &quot;g&quot; 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 (&quot;kex&quot; 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 &lt; 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) -&gt; the object's type type(name, bases, dict) -&gt; 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 &quot;WinSock&quot; 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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="paramiko-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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>