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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
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>
|