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.

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.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
• 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.Agent: Client interface for using private keys from an SSH agent running on the local machine.