ssh2-python Documentation<a class="headerlink" href="#ssh2-python-documentation" title="Permalink to this headline">¶

userauth_publickey_fromfile(self, username, privatekey, passphrase='', publickey=None)¶

Authenticate with public key from file.

Return type: int

userauth_publickey_frommemory(self, username, bytes privatekeyfiledata, passphrase='', bytes publickeyfiledata=None)¶

sock¶

ssh2.channel¶

class ssh2.channel.Channel¶

close(self)¶: Close channel. Typically done to be able to get exit status.

eof(self)¶

Get channel EOF status.

Return type: bool

execute(self, command)¶

Execute command.

Parameters: command (str) – Command to execute
Raises: ssh2.exceptions.ChannelError on errors executing command
Return type: int

flush(self)¶: Flush stdout stream

flush_ex(self, int stream_id)¶: Flush stream with id

flush_stderr(self)¶: Flush stderr stream

get_exit_signal(self)¶

Get exit signal, message and language tag, if any, for command.

Returns (returncode`, exit signal, error message,: language tag) tuple.

Return type: tuple(int, bytes, bytes, bytes)

get_exit_status(self)¶

Get exit status of command.

Note that 0 is also failure code for this function.

Best used in non-blocking mode to avoid it being impossible to tell if 0 indicates failure or an actual exit status of 0

handle_extended_data(self, int ignore_mode)¶: Deprecated, use handle_extended_data2

handle_extended_data2(self, int ignore_mode)¶

ignore_extended_data(self, int ignore_mode)¶: Deprecated, use handle_extended_data2

poll_channel_read(self, int extended)¶: Deprecated - use session.block_directions and socket polling instead

process_startup(self, request, message=None)¶

Startup process on server for request with message.

Request is a supported SSH subsystem and clients would typically use one of execute/shell/subsystem functions depending on request type.

Parameters

request (str) – Request type (exec/shell/subsystem).
message (str or None) – Request message. Content depends on request type and can be None.

pty(self, term='vt100')¶

Request a PTY (physical terminal emulation) on the channel.

Parameters: term (str) – Terminal type to emulate.

read(self, size_t size=1024)¶

Read the stdout stream. Returns return code and output buffer tuple.

Return code is the size of the buffer when positive. Negative values are error codes.

Parameters: size (int) – Max buffer size to read.
Return type: (int, bytes)

read_ex(self, size_t size=1024, int stream_id=0)¶

Read the stream with given id. Returns return code and output buffer tuple.

Return code is the size of the buffer when positive. Negative values are error codes.

Parameters: size (int) – Max buffer size to read.
Return type: (int, bytes)

read_stderr(self, size_t size=1024)¶

Read the stderr stream. Returns return code and output buffer tuple.

Return code is the size of the buffer when positive. Negative values are error codes.

Return type: (int, bytes)

receive_window_adjust(self, unsigned long adjustment, unsigned long force)¶

receive_window_adjust2(self, unsigned long adjustment, unsigned long force)¶

send_eof(self)¶

Tell the remote host that no further data will be sent on the specified channel. Processes typically interpret this as a closed stdin descriptor.

Returns 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block.

Return type: int

setenv(self, varname, value)¶

Set environment variable on channel.

Parameters

varname (str) – Name of variable to set.
value (str) – Value of variable.

Return type

shell(self)¶

Request interactive shell from channel.

Raises: ssh2.exceptions.ChannelError on errors requesting interactive shell.

subsystem(self, subsystem)¶

Request subsystem from channel.

Parameters: subsystem (str) – Name of subsystem

wait_closed(self)¶: Wait for server to acknowledge channel close command.

wait_eof(self)¶

Wait for the remote end to acknowledge an EOF request.

Returns 0 on success or negative on failure. It returns ssh2.error_codes.LIBSSH2_ERROR_EAGAIN when it would otherwise block.

Return type: int

window_read(self)¶

window_read_ex(self, unsigned long read_avail, unsigned long window_size_initial)¶

window_write(self)¶

window_write_ex(self, unsigned long window_size_initial)¶

write(self, buf)¶

Write buffer to stdin.

Returns tuple of (return_code, bytes_written).

In blocking mode bytes_written will always equal len(buf) if no errors have occurred which would raise exception.

In non-blocking mode return_code can be LIBSSH2_ERROR_EAGAIN and bytes_written can be less than len(buf).

Clients should resume from that point on next call to write, ie buf[bytes_written_in_last_call:].

Note

While this function handles unicode strings for buf argument, bytes_written offset will always be for the bytes representation thereof as returned by the C function calls which only handle byte strings.

Parameters: buf (str) – Buffer to write
Return type: tuple(int, int)

write_ex(self, int stream_id, buf)¶

Write buffer to specified stream id.

Returns tuple of (return_code, bytes_written).

In blocking mode bytes_written will always equal len(buf) if no errors have occurred which would raise exception.

In non-blocking mode return_code can be LIBSSH2_ERROR_EAGAIN and bytes_written can be less than len(buf).

Clients should resume from that point on next call to the function, ie buf[bytes_written_in_last_call:].

Note

While this function handles unicode strings for buf argument, bytes_written offset will always be for the bytes representation thereof as returned by the C function calls which only handle byte strings.

Parameters

stream_id (int) – Id of stream to write to
buf (str) – Buffer to write

Return type

tuple(int, int)

write_stderr(self, buf)¶

Write buffer to stderr.

Returns tuple of (return_code, bytes_written).

In blocking mode bytes_written will always equal len(buf) if no errors have occurred which would raise exception.

In non-blocking mode return_code can be LIBSSH2_ERROR_EAGAIN and bytes_written can be less than len(buf).

Clients should resume from that point on next call to write, ie buf[bytes_written_in_last_call:].

Note

While this function handles unicode strings for buf argument, bytes_written offset will always be for the bytes representation thereof as returned by the C function calls which only handle byte strings.

Parameters: buf (str) – Buffer to write
Return type: tuple(int, int)

x11_req(self, int screen_number)¶

x11_req_ex(self, int single_connection, const char *auth_proto, const char *auth_cookie, int screen_number)¶

session¶: Originating session.

ssh2.agent¶

class ssh2.agent.Agent¶

connect(self)¶

Connect to agent.

Raises: ssh2.exceptions.AgentConnectionError on errors connecting to agent.
Return type: int

disconnect(self)¶

Disconnect from agent.

Return type: int

get_identities(self)¶

List and get identities from agent

Return type: list(ssh2.pkey.PublicKey)

list_identities(self)¶: This method is a no-op - use ssh2.agent.Agent.get_identities() to list and retrieve identities.

userauth(self, username, PublicKey pkey)¶

Perform user authentication with specific public key

Parameters

username (str) – User name to authenticate as
pkey (ssh2.pkey.PublicKey) – Public key to authenticate with

Raises

ssh2.exceptions.AgentAuthenticationError on errors authenticating.

Return type

ssh2.sftp¶

SFTP channel class and related SFTP flags.

File types¶

var LIBSSH2_SFTP_S_IFMT: Type of file mask
var LIBSSH2_SFTP_S_IFIFO: Named pipe (fifo)
var LIBSSH2_SFTP_S_IFCHR: Character special (character device)
var LIBSSH2_SFTP_S_IFDIR: Directory
var LIBSSH2_SFTP_S_IFBLK: Block special (block device)
var LIBSSH2_SFTP_S_IFREG: Regular file
var LIBSSH2_SFTP_S_IFLNK: Symbolic link
var LIBSSH2_SFTP_S_IFSOCK: Socket

File transfer flags¶

var LIBSSH2_FXF_READ: File read flag
var LIBSSH2_FXF_WRITE: File write flag
var LIBSSH2_FXF_APPEND: File append flag
var LIBSSH2_FXF_CREAT: File create flag
var LIBSSH2_FXF_TRUNC: File truncate flag
var LIBSSH2_FXF_EXCL: Exclusive file flag

File mode masks¶

Owner masks¶

var LIBSSH2_SFTP_S_IRWXU: Read/write/execute
var LIBSSH2_SFTP_S_IRUSR: Read
var LIBSSH2_SFTP_S_IWUSR: Write
var LIBSSH2_SFTP_S_IXUSR: Execute

Group masks¶

var LIBSSH2_SFTP_S_IRWXG: Read/write/execute
var LIBSSH2_SFTP_S_IRGRP: Read
var LIBSSH2_SFTP_S_IWUSR: Write
var LIBSSH2_SFTP_S_IXUSR: Execute

Other masks¶

var LIBSSH2_SFTP_S_IRWXO: Read/write/execute
var LIBSSH2_SFTP_S_IROTH: Read
var LIBSSH2_SFTP_S_IWOTH: Write
var LIBSSH2_SFTP_S_IXOTH: Execute

Generic mode masks¶

var LIBSSH2_SFTP_ST_RDONLY: Read only
var LIBSSH2_SFTP_ST_NOSUID: No suid

class ssh2.sftp.SFTP¶

SFTP session.

Parameters: session (ssh2.session.Session pointer) – Session that initiated SFTP.

get_channel(self)¶: Get new channel from the SFTP session

last_error(self)¶

Get last error code from SFTP channel.

Return type: int

lstat(self, path)¶: Link stat a file.

mkdir(self, path, long mode)¶

Make directory.

Parameters

path (str) – Path of directory to create.
mode (int) – Permissions mode of new directory.

Return type

Raises

Appropriate exception from ssh2.exceptions on errors.

open(self, filename, unsigned long flags, long mode)¶

Open file handle for file name.

Parameters

filename (str) – Name of file to open.
flags (int) –
One or more LIBSSH2_FXF_* flags.

Eg for reading flags is LIBSSH2_FXF_READ,

for writing LIBSSH2_FXF_WRITE,

for both LIBSSH2_FXF_READ | LIBSSH2_FXF_WRITE.
mode (int) –
File permissions mode. LIBSSH2_SFTP_S_IRUSR for reading.

For writing one or more LIBSSH2_SFTP_S_* flags.

Eg, for 664 permission mask (read/write owner/group, read other),

mode is

LIBSSH2_SFTP_S_IRUSR | LIBSSH2_SFTP_S_IWUSR | \ LIBSSH2_SFTP_S_IRGRP | LIBSSH2_SFTP_S_IWGRP | \ LIBSSH2_SFTP_S_IROTH

Raises

ssh2.exceptions.SFTPHandleError on errors opening file.

open_ex(self, const char *filename, unsigned int filename_len, unsigned long flags, long mode, int open_type)¶

opendir(self, path)¶

Open handle to directory path.

Parameters: path (str) – Path of directory
Return type: ssh2.sftp.SFTPHandle or None
Raises: ssh2.exceptions.SFTPHandleError on errors opening directory.

realpath(self, path, size_t max_len=256)¶

Get real path for path.

Param: Path name to get real path for.
Parameters: max_len (int) – Max size of returned real path.
Raises: ssh2.exceptions.SFTPHandleError on errors getting real path.
Raises: ssh2.exceptions.SFTPBufferTooSmall on max_len less than real path length.

rename(self, source_filename, dest_filename)¶

Rename file.

Parameters

source_filename (str) – Old name of file.
dest_filename (str) – New name of file.

rename_ex(self, const char *source_filename, unsigned int source_filename_len, const char *dest_filename, unsigned int dest_filename_len, long flags)¶

rmdir(self, path)¶

Remove directory.

Parameters: path (str) – Directory path to remove.
Return type: int

setstat(self, path, SFTPAttributes attrs)¶

Set file attributes.

Parameters

path (str) – File path.
attrs (ssh2.sftp_handle.SFTPAttributes) – File attributes to set.

Return type

stat(self, path)¶

Stat file.

Parameters: path (str) – Path of file to stat.
Return type: ssh2.sftp_handle.SFTPAttributes or LIBSSH2_ERROR_EAGAIN

statvfs(self, path)¶

Get file system statistics from path.

Return type: ssh2.sftp.SFTPStatVFS or int of error code

symlink(self, path, target)¶

Create symlink.

Parameters

path (str) – Source file path.
target (str) – Target file path.

Return type

ssh2.knownhost.KnownHostEntry

unlink(self, filename)¶

Delete/unlink file.

Parameters: filename (str) – Name of file to delete/unlink.

session¶: Originating session.

ssh2.sftp_handle¶

SFTP handle, attributes and stat VFS classes.

class ssh2.sftp_handle.SFTPAttributes¶

atime¶

filesize¶

flags¶

gid¶

mtime¶

permissions¶

uid¶

class ssh2.sftp_handle.SFTPHandle¶

close(self)¶

Close handle. Called automatically when object is deleted and/or garbage collected.

Return type: int

fsetstat(self, SFTPAttributes attrs)¶

Set file handle attributes.

Parameters: attrs (ssh2.sftp.SFTPAttributes) – Attributes to set.

fstat(self)¶

Get file stat attributes from handle.

Return type: tuple(int, ssh2.sftp.SFTPAttributes)

fstat_ex(self, SFTPAttributes attrs, int setstat)¶: Get or set file attributes. Clients would typically use one of the fstat or fsetstat functions instead

fstatvfs(self)¶

Get file system statistics for handle

Return type: ssh2.sftp.SFTPStatVFS

fsync(self)¶

Sync file handle data.

Available from libssh2 >= 1.4.4

Return type: int

read(self, size_t buffer_maxlen=c_ssh2.LIBSSH2_CHANNEL_WINDOW_DEFAULT)¶

Read buffer from file handle.

Parameters: buffer_maxlen (int) – Max length of buffer to return.
Return type: bytes

readdir(self, size_t buffer_maxlen=1024)¶

Get directory listing from file handle, if any.

This function is a generator and should be iterated on.

File handle must be opened with ssh2.sftp.SFTP.readdir()

Parameters: buffer_maxlen – Max length of returned file entry.
Return type: iter(bytes)

readdir_ex(self, size_t longentry_maxlen=1024, size_t buffer_maxlen=1024)¶

Get directory listing from file handle, if any.

File handle must be opened with ssh2.sftp.SFTP.readdir()

This function is a generator and should be iterated on.

Parameters

buffer_maxlen – Max length of returned buffer.
longentry_maxlen – Max length of file list entry.

Return type

bytes

rewind(self)¶

Rewind file handle to beginning of file.

Return type: None

seek(self, size_t offset)¶

Deprecated, use seek64.

Seek file to given offset.

Parameters: offset (int) – Offset to seek to.
Return type: None

seek64(self, libssh2_uint64_t offset)¶

Seek file to given 64-bit offset.

Parameters: offset (int) – Offset to seek to.
Return type: None

tell(self)¶

Deprecated, use tell64.

Get current file handle offset.

Return type: int

tell64(self)¶

Get current file handle 64-bit offset.

Return type: int

write(self, bytes buf)¶

Write buffer to file handle.

Returns tuple of (error code, bytes written).

In blocking mode bytes_written will always equal len(buf) if no errors have occurred which would raise exception.

In non-blocking mode error_code can be LIBSSH2_ERROR_EAGAIN and bytes_written can be less than len(buf).

Clients should resume from that point on next call to write, ie buf[bytes_written_in_last_call:].

Parameters: buf (bytes) – Buffer to write.
Return type: tuple(int, int)

class ssh2.sftp_handle.SFTPStatVFS¶

File system statistics

f_bavail¶: Free blocks for non-root

f_bfree¶: Free blocks

f_blocks¶: Size of fs in f_frsize units

f_bsize¶: File system block size

f_favail¶: Free inodes for non-root

f_ffree¶: Free inodes

f_files¶: Inodes

f_flag¶

File system mount flags.

This property is a bit mask with defined bits LIBSSH2_SFTP_ST_RDONLY and LIBSSH2_SFTP_ST_NOSUID

f_frsize¶: Fragment size

f_fsid¶: File system ID

f_namemax¶: Maximum filename length

ssh2.pkey¶

class ssh2.pkey.PublicKey¶

Extension class for representing public key data from libssh2.

Can be used for authentication via ssh2.agent.Agent.userauth()

blob¶

Blob of public key data.

Return type: bytes

blob_len¶

Blob length of public key.

Return type: int

comment¶

Public key comment

Return type: bytes

magic¶

Magic number of public key.

Return type: int

ssh2.listener¶

class ssh2.listener.Listener¶

forward_accept(self)¶

forward_cancel(self)¶

ssh2.knownhost¶

class ssh2.knownhost.KnownHost¶

Manage known host entries.

add(self, bytes host, bytes salt, bytes key, int typemask)¶: Deprecated - use self.addc

addc(self, bytes host, bytes key, int typemask, bytes salt=None, bytes comment=None)¶

Adds a host and its key to known hosts collection.

Note - libssh2 expects correct use of hashed hosts when LIBSSH2_KNOWNHOST_TYPE_SHA1 is part of typemask. Incorrect use of hashed host typemask without appropriate hashed host and salt values will result in host entries being added to the collection without a host name.

Parameters

host (bytes) – Host to add key for.
key (bytes) – Key to add.
typemask – Bitmask of one of each from ssh2.knownhost.LIBSSH2_KNOWNHOST_TYPE_*, ssh2.knownhost.LIBSSH2_KNOWNHOST_KEYENC_* and ssh2.knownhost.LIBSSH2_KNOWNHOST_KEY_* for example for plain text host, raw key encoding and SSH RSA key type would be LIBSSH2_KNOWNHOST_TYPE_PLAIN | LIBSSH2_KNOWNHOST_KEYENC_RAW | LIBSSH2_KNOWNHOST_KEY_SSHRSA.
salt (bytes) – Salt used for host hashing if host is hashed. Defaults to None.
comment (bytes) – Comment to add for host. Defaults to None.

Raises

ssh2.exceptions.KnownHostAddError on errors adding known host entry.

check(self, bytes host, bytes key, int typemask)¶: Deprecated - use self.checkp

checkp(self, bytes host, int port, bytes key, int typemask)¶

Check a host and its key against the known hosts collection and return known host entry, if any.

Note that server key provided to this function must be base64 encoded only if checking against a self.addc added known public key. When using self.readfile and a known_hosts file, encoding is not needed.

ssh2.exceptions.KnownHostCheckError is base class for all host check error exceptions and can be used to catch all host check errors.

Parameters

host (bytes) – Host to check.
key (bytes) – Key of host to check.
typemask – Bitmask of one of each from ssh2.knownhost.LIBSSH2_KNOWNHOST_TYPE_*, ssh2.knownhost.LIBSSH2_KNOWNHOST_KEYENC_* and ssh2.knownhost.LIBSSH2_KNOWNHOST_KEY_* for example for plain text host, raw key encoding and SSH RSA key type would be LIBSSH2_KNOWNHOST_TYPE_PLAIN | LIBSSH2_KNOWNHOST_KEYENC_RAW | LIBSSH2_KNOWNHOST_KEY_SSHRSA.

Raises

ssh2.exceptions.KnownHostCheckMisMatchError on provided key mis-match error with found key from known hosts.

Raises

ssh2.exceptions.KnownHostCheckNotFoundError on host not found in known hosts.

Raises

ssh2.exceptions.KnownHostCheckFailure on failure checking known host entry.

Raises

ssh2.exceptions.KnownHostCheckError on unknown errors checking known host.

Return type

delete(self, KnownHostEntry entry)¶

Delete given known host entry from collection of known hosts.

Parameters: entry (ssh2.knownhost.KnownHostEntry) – Known host entry to delete.
Raises: ssh2.exceptions.KnownHostDeleteError on errors deleting host entry.

get(self, KnownHostEntry prev=None)¶

Retrieve all host entries in known hosts collection.

Parameters: prev – (Optional) Existing known host entry to start retrieval from. All hosts are retrieved when prev is None which is the default.
Raises: ssh2.exceptions.KnownHostGetError on errors retrieving known host collection.
Return type: list(ssh2.knownhost.KnownHostEntry)

readfile(self, filename, int f_type=c_ssh2.LIBSSH2_KNOWNHOST_FILE_OPENSSH)¶

Read known hosts file and add hosts to known hosts collection. Only OpenSSH known hosts file format is currently supported.

Returns number of successfully read host entries.

Parameters: filename (str) – File name to read.
Raises: ssh2.exceptions.KnownHostReadFileError on errors reading file.
Return type: int

readline(self, bytes line, int f_type=c_ssh2.LIBSSH2_KNOWNHOST_FILE_OPENSSH)¶

Read line from known hosts file and add to known hosts collection. Only OpenSSH known hosts file format is currently supported.

Note - When using readline, the key values returned by self.get will need to be base64 encoded as libssh2’s readline does not encode them when adding, unlike self.readfile and self.addc.

Parameters: line (bytes) – Byte string representing line to read.
Raises: ssh2.exceptions.KnownHostReadLineError on errors reading line.

writefile(self, filename, int f_type=c_ssh2.LIBSSH2_KNOWNHOST_FILE_OPENSSH)¶

Write all known host entries to file. Only OpenSSH known hosts file format is currently supported.

Parameters: filename (str) – File name to write known hosts to.
Raises: ssh2.exceptions.KnownHostWriteFileError on errors writing to file.

writeline(self, KnownHostEntry entry, int f_type=c_ssh2.LIBSSH2_KNOWNHOST_FILE_OPENSSH, size_t buf_len=1024)¶

Convert a single known host entry to a single line of output for writing. Only OpenSSH known hosts file format is currently supported.

Parameters: entry (ssh2.knownhost.KnownHostEntry) – Known host entry to write line for.
Raises: ssh2.exceptions.KnownHostWriteLineError on errors writing line.
Return type: bytes

class ssh2.knownhost.KnownHostEntry¶

Class representing a single known host entry.

key¶

Key byte string.

Key is stored base64 encoded according to libssh2 documentation and is returned by this property as a base64 decoded byte string.

Note that in some cases, like keys added by ssh2.knownhost.KnownHost.readline(), the stored key is not base64 encoded, contrary to documentation, and KnownHostEntry.key will need to be re-encoded as base64 to get actual key.

magic¶: Entry magic number.

name¶: Name of host.

typemask¶: Type mask of host entry.

Exceptions¶

exception ssh2.exceptions.AgentAuthenticationError¶

Bases: ssh2.exceptions.AuthenticationError

Raised on SSH Agent authentication errors

exception ssh2.exceptions.AgentConnectionError¶

Bases: ssh2.exceptions.AgentError

Raised on SSH Agent connection errors

exception ssh2.exceptions.AgentError¶

Base class for all SSH Agent errors

exception ssh2.exceptions.AgentGetIdentityError¶

Bases: ssh2.exceptions.AgentError

Raised on SSH Agent get identity errors

exception ssh2.exceptions.AgentListIdentitiesError¶

Bases: ssh2.exceptions.AgentError

Raised on SSH Agent list identities errors

exception ssh2.exceptions.AgentProtocolError¶

Raised on SSH agent protocol errors

exception ssh2.exceptions.AuthenticationError¶

Base class for all authentication errors

exception ssh2.exceptions.BadSocketError¶

Raised on use of bad socket errors

exception ssh2.exceptions.BadUseError¶

Raised on API bad use errors

exception ssh2.exceptions.BannerRecvError¶

Raised on errors receiving banner

exception ssh2.exceptions.BannerSendError¶

Raised on errors sending banner

exception ssh2.exceptions.BufferTooSmallError¶

Raised on buffer too small errors

exception ssh2.exceptions.ChannelClosedError¶

Raised on channel closed errors

exception ssh2.exceptions.ChannelEOFSentError¶

Raised on channel EOF errors

exception ssh2.exceptions.ChannelError¶

Base class for all channel errors

exception ssh2.exceptions.ChannelFailure¶

Raised on channel failures

exception ssh2.exceptions.ChannelOutOfOrderError¶

Raised on channel commands out of order errors

exception ssh2.exceptions.ChannelPacketExceeded¶

Raised on channel max packet length exceeded errors

exception ssh2.exceptions.ChannelRequestDenied¶

Raised on channel request denied errors

exception ssh2.exceptions.ChannelUnknownError¶

Raised on unknown channel errors

exception ssh2.exceptions.ChannelWindowExceeded¶

Raised on channel window exceeded errors

exception ssh2.exceptions.CompressError¶

Raised on compression errors

exception ssh2.exceptions.DecryptError¶

Raised on decryption errors

exception ssh2.exceptions.EncryptError¶

Raised on encryption errors

exception ssh2.exceptions.FileError¶

Raised on file errors

exception ssh2.exceptions.HostkeyInitError¶

Raised on errors initialiasing host key

exception ssh2.exceptions.HostkeySignError¶

Raised on errors signing host key

exception ssh2.exceptions.InvalidPollTypeError¶

Raised on invalid poll type errors

exception ssh2.exceptions.InvalidRequestError¶

Raised on invalid request errors

exception ssh2.exceptions.KeyExchangeError¶

Raised on errors exchanging keys

exception ssh2.exceptions.KnownHostAddError¶

Raised on errors adding known host entries

exception ssh2.exceptions.KnownHostCheckError¶

Raised on any known host check errors

exception ssh2.exceptions.KnownHostCheckFailure¶

Bases: ssh2.exceptions.KnownHostCheckError

Raised on something preventing known host check to be made

exception ssh2.exceptions.KnownHostCheckMisMatchError¶

Bases: ssh2.exceptions.KnownHostCheckError

Raised on keys do not match for known host

exception ssh2.exceptions.KnownHostCheckNotFoundError¶

Bases: ssh2.exceptions.KnownHostCheckError

Raised on no match for known host check

exception ssh2.exceptions.KnownHostDeleteError¶

Raised on errors deleting known host entry

exception ssh2.exceptions.KnownHostError¶

Base class for KnownHost errors

exception ssh2.exceptions.KnownHostGetError¶

Raised on errors retrieving known host entries

exception ssh2.exceptions.KnownHostReadFileError¶

Raised on errors reading from known hosts file

exception ssh2.exceptions.KnownHostReadLineError¶

Raised on errors reading line from known hosts file

exception ssh2.exceptions.KnownHostWriteFileError¶

Raised on errors writing to known hosts file

exception ssh2.exceptions.KnownHostWriteLineError¶

Raised on errors writing line to known hosts file

exception ssh2.exceptions.MethodNoneError¶

Raised on invalid method errors

exception ssh2.exceptions.MethodNotSupported¶

Raised on authentication method not supported errors

exception ssh2.exceptions.OutOfBoundaryError¶

Raised on out of boundary errors

exception ssh2.exceptions.PasswordExpiredError¶

Bases: ssh2.exceptions.AuthenticationError

Raised on password expired errors

exception ssh2.exceptions.ProtocolError¶

Raised on protocol errors

exception ssh2.exceptions.PublicKeyError¶

Base class for all public key protocol errors

exception ssh2.exceptions.PublicKeyInitError¶

Bases: ssh2.exceptions.PublicKeyError

Raised on errors initialising public key system

exception ssh2.exceptions.PublicKeyProtocolError¶

Raised on public key protocol errors

exception ssh2.exceptions.PublickeyUnverifiedError¶

Bases: ssh2.exceptions.AuthenticationError

Raised on public key verification errors

exception ssh2.exceptions.RequestDeniedError¶

Raised on request denied errors

exception ssh2.exceptions.SCPProtocolError¶

Raised on SCP protocol errors

exception ssh2.exceptions.SFTPError¶

Base class for SFTP errors

exception ssh2.exceptions.SFTPHandleError¶

Bases: ssh2.exceptions.SFTPError

Raised on SFTP handle errors

exception ssh2.exceptions.SFTPProtocolError¶

Bases: ssh2.exceptions.SFTPError

Raised on SFTP protocol errors

exception ssh2.exceptions.SSH2Error¶

Bases: Exception

Base class for all ssh2-python errors

exception ssh2.exceptions.SessionError¶

Base class for all session errors

exception ssh2.exceptions.SessionHandshakeError¶

Raised on session handshake errors

exception ssh2.exceptions.SessionHostKeyError¶

Raised on errors getting server host key

exception ssh2.exceptions.SessionStartupError¶

Raised on session startup errors

exception ssh2.exceptions.SocketDisconnectError¶

Raised on socket disconnection errors

exception ssh2.exceptions.SocketRecvError¶

Raised on socket receive errors

exception ssh2.exceptions.SocketSendError¶

Raised on socket send errors

exception ssh2.exceptions.SocketTimeout¶

Raised on socket timeouts

exception ssh2.exceptions.Timeout¶

Raised on timeouts

exception ssh2.exceptions.UnknownError¶

Raised on non-specific or unknown errors

exception ssh2.exceptions.ZlibError¶