/usr/share/pyshared/libssh2/session.py is in python-libssh2 1.0.0-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | #
# pylibssh2 - python bindings for libssh2 library
#
# Copyright (C) 2010 Wallix Inc.
#
# This library is free software; you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation; either version 2.1 of the License, or (at your
# option) any later version.
#
# This library is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this library; if not, write to the Free Software Foundation, Inc.,
# 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
"""
Abstraction for libssh2 L{Session} object
"""
import _libssh2
from channel import Channel
class SessionException(Exception):
"""
Exception raised when L{Session} actions fails.
"""
pass
class Session(object):
"""
Session object
"""
def __init__(self):
"""
Create a new session object.
"""
self._session = _libssh2.Session()
def callback_set(self, callback_type, callback):
"""
Sets callback on the session.
@param callback_type: value of libssh2.LIBSSH2_CALLBACK_* constant
@type callback_set: int
@param callback: a callback Python object
@type callback: function
"""
self._session.callback_set(callback_type, callback)
def close(self, reason="Disconnect"):
"""
Closes the session.
@param reason: human readable reason for disconnection
@type reason: str
@return: 0 on success or negative on failure
@rtype: int
"""
self._session.close(reason)
def direct_tcpip(self, host, port, shost, sport):
"""
Tunnels a TCP connection through the session.
@param host: remote host
@type host: str
@param port: remote port
@type port: int
@param shost: local host
@type shost: str
@param sport: local port
@type sport: int
@return: new opened L{Channel}
@rtype: L{Channel}
"""
return self._session.direct_tcpip(host, port, shost, sport)
def forward_listen(self, host, port, bound_port, queue_maxsize):
"""
Forwards a TCP connection through the session.
@param host: remote host
@type host: str
@param port: remote port
@type port: int
@param bound_port: populated with the actual port on the remote host
@type bound_port: int
@param queue_maxsize: maxium number of pending connections
@type int
@return: new L{Listener} instance on success or None on failure
@rtype: L{Listener}
"""
return self._session.forward_listen(
host, port, bound_port, queue_maxsize
)
def hostkey_hash(self, hashtype):
"""
Returns the computed digest of the remote host's key.
@param hashtype: values possible are 1 (HASH_MD5) or 2 (HASH_SHA1)
@type hashtype: int
@return: string representation of the computed hash value
@rtype: str
"""
return self._session.hostkey_hash(hashtype)
def last_error(self):
"""
Returns the last error in tuple format (code, message).
@return: error tuple (int, str)
@rtype: tuple
"""
return self._session.last_error()
def open_session(self):
"""
Allocates a new L{Channel} for the session.
@return: new channel opened
@rtype: L{Channel}
"""
return Channel(self._session.open_session())
def set_trace(self, bitmask):
"""
Sets trace level on the session.
@param bitmask: bitmask on libssh2.LIBSSH2_TRACE_* constant
"""
self._session.set_trace(bitmask)
def scp_recv(self, remote_path):
"""
Gets a remote file via SCP Protocol.
@param remote_path: absolute path of remote file to transfer
@type remote_path: str
@return: new channel opened
@rtype: L{Channel}
"""
return Channel(self._session.scp_recv(remote_path))
def scp_send(self, path, mode, size):
"""
Sends a file to remote host via SCP protocol.
@param path: absolute path of file to transfer
@type path: str
@param mode: file access mode to create file
@type mode: int
@param size: size of file being transmitted
@type size: int
@return: new channel opened
@rtype: L{Channel}
"""
return Channel(self._session.scp_send(path, mode, size))
def session_method_pref(self, method_type, pref):
"""
Sets preferred methods to be negociated. Theses preferences must be
prior to calling L{startup}.
@param method_type: the method type constants
@type method_type: int
@param pref: coma delimited list of preferred methods
@type pref: str
@return: 0 on success or negative on failure
@rtype: int
"""
self._session.session_methods(method_type, pref)
def session_methods(self):
"""
Returns dictionnary with the current actives algorithms.
CS keys is Client to Server and SC keys is Server to Client.
@return: dictionnary with actual method negociated
@rtype: dict
"""
return self.session_methods()
def set_banner(self, banner=_libssh2.DEFAULT_BANNER):
"""
Sets the banner that will be sent to remote host. This is optional, the
banner L{_libssh2.DEFAULT_BANNER} will be sent by default.
@param banner: an user defined banner
@type banner: str
@return: 0 on success or negative on failure
@rtype: int
"""
self._session.set_banner(banner)
def sftp_init(self):
"""
Open an Sftp Channel.
@return: new Sftp channel opened
@rtype: L{Sftp}
"""
raise NotImplementedError()
def startup(self, sock):
"""
Starts up the session form a socket created by a socket.socket() call.
@param sock: a connected socket object
@type sock: socket._socketobject
@return: 0 on success or negative on failure
@rtype: int
"""
self._session.startup(sock)
def userauth_authenticated(self):
"""
Returns authentification status for the given session.
@return: non-zero if authenticated or 0 if not
@rtype: int
"""
return self._session.userauth_authenticated()
def userauth_list(self, username):
"""
Lists the authentification methods supported by a server.
@param username: username which will be used while authenticating
@type username: str
@return: string containing a comma-separated list of authentication
methods
@rtype: str
"""
self._session.userauth_list(username)
def userauth_password(self, username, password):
"""
Authenticates a session with the given username and password.
@param username: user to authenticate
@type username: str
@param password: password to use for the authentication
@type password: str
@return: 0 on success or negative on failure
@rtype: int
"""
self._session.userauth_password(username, password)
def userauth_publickey_fromfile(
self, username, publickey, privatekey, passphrase
):
"""
Authenticates a session as username using a key pair found in the
pulickey and privatekey files, and passphrase if provided.
@param username: user to authenticate
@type username: str
@param publickey: path and name of public key file
@type publickey: str
@param privatekey: path and name of private key file
@type privatekey: str
@param passphrase: passphrase to use when decoding private file
@type passphrase: str
@return: 0 on success or negative on failure
@rtype: int
"""
raise NotImplementedError()
|