Module and Class Hierarchies

[show private | hide private]
[frames | no frames]

## Module Hierarchy

- `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.
  - `agent`: SSH Agent interface for Unix clients.
  - `dsskey`: `DSSKey`
  - `file`: BufferedFile.
  - `message`: Implementation of an SSH2 "message".
  - `pkey`: Common API for all public keys.
  - `rsakey`: `RSAKey`
  - `server`: `ServerInterface` is an interface to override for server support.
  - `sftp`
  - `sftp_attr`
  - `sftp_client`: Client-mode SFTP support.
  - `sftp_file`: `SFTPFile`
  - `sftp_handle`: Abstraction of an SFTP file handle (for server mode).
  - `sftp_server`: Server-mode SFTP support.
  - `sftp_si`: `SFTPServerInterface` is an interface to override for SFTP server support.
  - `transport`: `Transport` handles the core SSH2 protocol.
  - `util`: Useful functions used by the rest of paramiko.
  - `auth_handler`: `AuthHandler`
  - `ber`
  - `channel`: Abstraction for an SSH2 channel.
  - `common`: Common constants and global variables.
  - `compress`: Compression implementations for a Transport.
  - `kex_gex`: Variant on `KexGroup1` where the prime "p" and generator "g" are provided by the server.
  - `kex_group1`: Standard SSH key exchange ("kex" if you wanna sound cool).
  - `logging22`: Stub out logging on python < 2.3.
  - `packet`: Packetizer.
  - `pipe`: Abstraction of a one-way pipe where the read end can be used in select().
  - `primes`: Utility functions for dealing with primes.
  - `ssh_exception`: Exceptions defined by paramiko.

## Class Hierarchy

- `__builtin__.object`: The most base type
  - `paramiko.BufferedFile`: Reusable base class to implement python-style file buffering around a simpler stream.
    - `paramiko.SFTPFile`: Proxy object for a file on the remote server, in client mode SFTP.
    - `paramiko.ChannelFile`: A file-like wrapper around `Channel`.
      - `paramiko.channel.ChannelStderrFile`
  - `paramiko.Channel`: A secure tunnel across an SSH `Transport`.
  - `paramiko.server.InteractiveQuery`: A query (set of prompts) for a user during interactive authentication.
  - `paramiko.Message`: An SSH2 Message is a stream of bytes that encodes some combination of strings, integers, bools, and infinite-precision integers (known in python as longs).
  - `paramiko.util.PFilter`
  - `paramiko.SecurityOptions`: Simple object containing the security preferences of an ssh transport.
  - `paramiko.SFTPAttributes`: Representation of the attributes of a file (or proxied file) for SFTP in client or server mode.
  - `paramiko.SFTPHandle`: Abstract object representing a handle to an open file (or folder) in an SFTP server implementation.
  - `__builtin__.type`: type(object) -> the object's type type(name, bases, dict) -> a new type
  - `threading._Verbose`
    - `threading.Thread`
      - `paramiko.SubsystemHandler`: Handler for a subsytem in server mode.
        - `paramiko.SFTPServer`: Server-side SFTP subsystem support.
      - `paramiko.Transport`: An SSH Transport attaches to a stream (usually a socket), negotiates an encrypted session, authenticates, and then creates stream tunnels, called `Channel`s, across the session.
  - `paramiko.AuthHandler`: Internal class to handle the mechanics of authentication.
  - `paramiko.BaseSFTP`
    - `paramiko.SFTPClient`: SFTP client object.
      - `paramiko.SFTP`: an alias for `SFTPClient` for backwards compatability
    - `paramiko.SFTPServer`: Server-side SFTP subsystem support.
  - `paramiko.ber.BER`: Robey's tiny little attempt at a BER decoder.
  - `paramiko.logging22.Formatter`
  - `paramiko.kex_gex.KexGex`
  - `paramiko.kex_group1.KexGroup1`
  - `paramiko.logging22.logger`
  - `paramiko.primes.ModulusPack`: convenience object for holding the contents of the /etc/ssh/moduli file, on systems that have such a file.
  - `paramiko.Packetizer`: Implementation of the base SSH packet protocol.
  - `paramiko.PKey`: Base class for public keys.
    - `paramiko.AgentKey`: Private key held in a local SSH agent.
    - `paramiko.DSSKey`: Representation of a DSS key which can be used to sign an verify SSH2 data.
    - `paramiko.RSAKey`: Representation of an RSA key which can be used to sign and verify SSH2 data.
  - `paramiko.pipe.PosixPipe`
  - `paramiko.ServerInterface`: This class defines an interface for controlling the behavior of paramiko in server mode.
  - `paramiko.SFTPServerInterface`: This class defines an interface for controlling the behavior of paramiko when using the `SFTPServer` subsystem to provide an SFTP server.
  - `paramiko.logging22.StreamHandler`
  - `paramiko.pipe.WindowsPipe`: On Windows, only an OS-level "WinSock" may be used in select(), but reads and writes must be to the actual socket object.
  - `paramiko.compress.ZlibCompressor`
  - `paramiko.compress.ZlibDecompressor`
- `exceptions.Exception`: Common base class for all exceptions.
  - `paramiko.SFTPError`
  - `paramiko.SSHException`: Exception raised by failures in SSH2 protocol negotiation or logic errors.
    - `paramiko.BadAuthenticationType`: Exception raised when an authentication type (like password) is used, but the server isn't allowing that type.
    - `paramiko.PasswordRequiredException`: Exception raised when a password is needed to unlock a private key file.
    - `paramiko.ssh_exception.PartialAuthentication`: An internal exception thrown in the case of partial authentication.
  - `paramiko.ber.BERException`
  - `paramiko.packet.NeedRekeyException`
- `paramiko.Agent`: Client interface for using private keys from an SSH agent running on the local machine.

Generated by Epydoc 2.1 on Sun Dec 4 11:16:48 2005 | http://epydoc.sf.net