From ed280d5ac360e2af796e9bd973d7b4df89f0c449 Mon Sep 17 00:00:00 2001 From: "Jeremy T. Bouse" Date: Fri, 27 Nov 2009 16:20:12 -0500 Subject: Imported Upstream version 1.7.4 --- docs/private/paramiko-module.html | 407 -------------------------------------- 1 file changed, 407 deletions(-) delete mode 100644 docs/private/paramiko-module.html (limited to 'docs/private/paramiko-module.html') diff --git a/docs/private/paramiko-module.html b/docs/private/paramiko-module.html deleted file mode 100644 index 4e9f899..0000000 --- a/docs/private/paramiko-module.html +++ /dev/null @@ -1,407 +0,0 @@ - - - - - paramiko - - - - - - - - - - - - - -
   Home      Trees      Index      Help   
- - - - -
- - Package paramiko -
- 		- - -
[show private | hide private]
[frames | no frames]
- - -

Package paramiko

- -

Paramiko (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 telnet and rsh 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 sftp works, for example.)

-

To use this package, pass a socket (or socket-like object) to a Transport, and use start_server or start_client 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. (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.) As a server, you are -responsible for deciding which users, passwords, and keys to allow, and -what kind of channels to allow.

-

Once you have finished, either side may request flow-controlled Channels -to the other side, which are python objects that act like sockets, but -send and receive data over the encrypted session.

-

Paramiko is written entirely in python (no C or platform-dependent -code) and is released under the GNU Lesser General Public License -(LGPL).

-Website: http://www.lag.net/paramiko/ -
-

Version: 1.5.2 (rhydon) -

- -

Author: Robey Pointer -

- -

Contact: robey@lag.net -

- -

License: GNU Lesser General Public License (LGPL) -

- - - - - - - -
Submodules

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Classes
- AgentClient interface for using private keys from an SSH agent running on -the local machine.
- AgentKeyPrivate key held in a local SSH agent.
- BufferedFileReusable base class to implement python-style file buffering around a -simpler stream.
- ChannelA secure tunnel across an SSH Transport.
- DSSKeyRepresentation of a DSS key which can be used to sign an verify SSH2 -data.
- MessageAn SSH2 Message is a stream of bytes that encodes some -combination of strings, integers, bools, and infinite-precision integers -(known in python as longs).
- RSAKeyRepresentation of an RSA key which can be used to sign and verify SSH2 -data.
- SecurityOptionsSimple object containing the security preferences of an ssh -transport.
- SFTPan alias for SFTPClient for backwards compatability
- SFTPAttributesRepresentation of the attributes of a file (or proxied file) for SFTP -in client or server mode.
- SFTPClientSFTP client object.
- SFTPFileProxy object for a file on the remote server, in client mode SFTP.
- SFTPHandleAbstract object representing a handle to an open file (or folder) in -an SFTP server implementation.
- SFTPServerServer-side SFTP subsystem support.
- SubsystemHandlerHandler for a subsytem in server mode.
- TransportAn SSH Transport attaches to a stream (usually a socket), negotiates -an encrypted session, authenticates, and then creates stream tunnels, -called Channels, across the session.
- AuthHandlerInternal class to handle the mechanics of authentication.
- BaseSFTP 
- ChannelFileA file-like wrapper around Channel.
- PacketizerImplementation of the base SSH packet protocol.
- PKeyBase class for public keys.
- ServerInterfaceThis class defines an interface for controlling the behavior of -paramiko in server mode.
- SFTPServerInterfaceThis class defines an interface for controlling the behavior of -paramiko when using the SFTPServer subsystem to provide an SFTP -server.
- xThis class defines an interface for controlling the behavior of -paramiko in server mode.

- - - - - - - - - - - - - - -
Exceptions
- BadAuthenticationTypeException raised when an authentication type (like password) is used, -but the server isn't allowing that type.
- PasswordRequiredExceptionException raised when a password is needed to unlock a private key -file.
- SFTPError 
- SSHExceptionException raised by failures in SSH2 protocol negotiation or logic -errors.

- - - - - - - - - - - - - - - - -
Variable Summary
str__author__ = 'Robey Pointer <robey@lag.net>' -
str__date__ = '04 Dec 2005' -
str__license__ = 'GNU Lesser General Public License (LGPL)'... -
str__version__ = '1.5.2 (rhydon)' -
tuple__version_info__ = (1, 5, 2) -

- - - - - - -
Variable Details
-
- -

__author__

-
-
-
-
-
Type:
-
- str - -
-
Value:
-
-
-'Robey Pointer <robey@lag.net>'
-
-
-
-
-
- -

__date__

-
-
-
-
-
Type:
-
- str - -
-
Value:
-
-
-'04 Dec 2005'
-
-
-
-
-
- -

__license__

-
-
-
-
-
Type:
-
- str - -
-
Value:
-
-
-'GNU Lesser General Public License (LGPL)'
-
-
-
-
-
- -

__version__

-
-
-
-
-
Type:
-
- str - -
-
Value:
-
-
-'1.5.2 (rhydon)'
-
-
-
-
-
- -

__version_info__

-
-
-
-
-
Type:
-
- tuple - -
-
Value:
-
-
-(1, 5, 2)
-
-
-
-
-
- - - - - - - - - - - -
   Home      Trees      Index      Help   
- - - - - - -
Generated by Epydoc 2.1 on Sun Dec 4 11:16:47 2005http://epydoc.sf.net
- - -- cgit v1.2.3