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.
  - `util`: Useful functions used by the rest of paramiko.

## Class Hierarchy

- `UserDict.DictMixin`
  - `paramiko.HostKeys`: Representation of an openssh-style "known hosts" file.
- `__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.Channel`: A secure tunnel across an SSH `Transport`.
  - `__builtin__.dict`: dict() -> new empty dictionary.
  - `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.MissingHostKeyPolicy`: Interface for defining the policy that `SSHClient` should use when the SSH server's hostname is not in either the system host keys or the application's keys.
    - `paramiko.AutoAddPolicy`: Policy for automatically adding the hostname and new host key to the local `HostKeys` object, and saving it.
    - `paramiko.RejectPolicy`: Policy for automatically rejecting the unknown hostname & key.
  - `paramiko.util.PFilter`
  - `paramiko.SecurityOptions`: Simple object containing the security preferences of an ssh transport.
  - `paramiko.ServerInterface`: This class defines an interface for controlling the behavior of paramiko in server mode.
  - `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.
  - `paramiko.SFTPServerInterface`: This class defines an interface for controlling the behavior of paramiko when using the `SFTPServer` subsystem to provide an SFTP server.
  - `paramiko.SSHClient`: A high-level representation of a session with an SSH server.
  - `paramiko.SSHConfig`: Representation of config information as stored in the format used by OpenSSH.
  - `__builtin__.type`: type(object) -> the object's type type(name, bases, dict) -> a new type
- `exceptions.Exception`: Common base class for all exceptions.
  - `paramiko.SFTPError`
  - `paramiko.SSHException`: Exception raised by failures in SSH2 protocol negotiation or logic errors.
    - `paramiko.AuthenticationException`: Exception raised when authentication failed for some reason.
      - `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.BadHostKeyException`: The host key given by the SSH server did not match what we were expecting.
    - `paramiko.ChannelException`: Exception raised when an attempt to open a new `Channel` fails.
  - `exceptions.StandardError`: Base class for all standard Python exceptions.
    - `exceptions.EnvironmentError`: Base class for I/O related errors.
      - `exceptions.IOError`: I/O operation failed.
- `paramiko.Agent`: Client interface for using private keys from an SSH agent running on the local machine.

Generated by Epydoc 2.1 on Wed Aug 16 14:35:05 2006 | http://epydoc.sf.net