18
18
"""Implementation of Transport over SFTP, using paramiko."""
20
# TODO: Remove the transport-based lock_read and lock_write methods. They'll
21
# then raise TransportNotPossible, which will break remote access to any
22
# formats which rely on OS-level locks. That should be fine as those formats
23
# are pretty old, but these combinations may have to be removed from the test
24
# suite. Those formats all date back to 0.7; so we should be able to remove
25
# these methods when we officially drop support for those formats.
43
from bzrlib.errors import (FileExists,
44
NoSuchFile, PathNotChild,
36
from bzrlib.config import config_dir, ensure_config_dir_exists
37
from bzrlib.errors import (ConnectionError,
39
TransportNotPossible, NoSuchFile, PathNotChild,
48
43
ParamikoNotPresent,
50
45
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
51
from bzrlib.symbol_versioning import (
55
from bzrlib.trace import mutter, warning
46
from bzrlib.trace import mutter, warning, error
56
47
from bzrlib.transport import (
60
48
register_urlparse_netloc_protocol,
66
# Disable one particular warning that comes from paramiko in Python2.5; if
67
# this is emitted at the wrong time it tends to cause spurious test failures
68
# or at least noise in the test case::
70
# [1770/7639 in 86s, 1 known failures, 50 skipped, 2 missing features]
71
# test_permissions.TestSftpPermissions.test_new_files
72
# /var/lib/python-support/python2.5/paramiko/message.py:226: DeprecationWarning: integer argument expected, got float
73
# self.packet.write(struct.pack('>I', n))
74
warnings.filterwarnings('ignore',
75
'integer argument expected, got float',
76
category=DeprecationWarning,
77
module='paramiko.message')
54
import bzrlib.urlutils as urlutils
86
63
CMD_HANDLE, CMD_OPEN)
87
64
from paramiko.sftp_attr import SFTPAttributes
88
65
from paramiko.sftp_file import SFTPFile
66
from paramiko.sftp_client import SFTPClient
91
69
register_urlparse_netloc_protocol('sftp')
73
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
74
# doesn't handle it itself.
75
# <https://launchpad.net/products/bzr/+bug/41433/+index>
77
signal.signal(signal.SIGINT, signal.SIG_IGN)
80
def os_specific_subprocess_params():
81
"""Get O/S specific subprocess parameters."""
82
if sys.platform == 'win32':
83
# setting the process group and closing fds is not supported on
87
# We close fds other than the pipes as the child process does not need
90
# We also set the child process to ignore SIGINT. Normally the signal
91
# would be sent to every process in the foreground process group, but
92
# this causes it to be seen only by bzr and not by ssh. Python will
93
# generate a KeyboardInterrupt in bzr, and we will then have a chance
94
# to release locks or do other cleanup over ssh before the connection
96
# <https://launchpad.net/products/bzr/+bug/5987>
98
# Running it in a separate process group is not good because then it
99
# can't get non-echoed input of a password or passphrase.
100
# <https://launchpad.net/products/bzr/+bug/40508>
101
return {'preexec_fn': _ignore_sigint,
94
106
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
95
107
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
96
108
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
99
@deprecated_function(zero_ninety)
110
# Paramiko 1.5 tries to open a socket.AF_UNIX in order to connect
111
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
112
# so we get an AttributeError exception. So we will not try to
113
# connect to an agent if we are on win32 and using Paramiko older than 1.6
114
_use_ssh_agent = (sys.platform != 'win32' or _paramiko_version >= (1, 6, 0))
118
def _get_ssh_vendor():
119
"""Find out what version of SSH is on the system."""
121
if _ssh_vendor is not None:
126
if 'BZR_SSH' in os.environ:
127
_ssh_vendor = os.environ['BZR_SSH']
128
if _ssh_vendor == 'paramiko':
133
p = subprocess.Popen(['ssh', '-V'],
134
stdin=subprocess.PIPE,
135
stdout=subprocess.PIPE,
136
stderr=subprocess.PIPE,
137
**os_specific_subprocess_params())
138
returncode = p.returncode
139
stdout, stderr = p.communicate()
143
if 'OpenSSH' in stderr:
144
mutter('ssh implementation is OpenSSH')
145
_ssh_vendor = 'openssh'
146
elif 'SSH Secure Shell' in stderr:
147
mutter('ssh implementation is SSH Corp.')
150
if _ssh_vendor != 'none':
153
# XXX: 20051123 jamesh
154
# A check for putty's plink or lsh would go here.
156
mutter('falling back to paramiko implementation')
160
class SFTPSubprocess:
161
"""A socket-like object that talks to an ssh subprocess via pipes."""
162
def __init__(self, hostname, vendor, port=None, user=None):
163
assert vendor in ['openssh', 'ssh']
164
if vendor == 'openssh':
166
'-oForwardX11=no', '-oForwardAgent=no',
167
'-oClearAllForwardings=yes', '-oProtocol=2',
168
'-oNoHostAuthenticationForLocalhost=yes']
170
args.extend(['-p', str(port)])
172
args.extend(['-l', user])
173
args.extend(['-s', hostname, 'sftp'])
174
elif vendor == 'ssh':
177
args.extend(['-p', str(port)])
179
args.extend(['-l', user])
180
args.extend(['-s', 'sftp', hostname])
182
self.proc = subprocess.Popen(args,
183
stdin=subprocess.PIPE,
184
stdout=subprocess.PIPE,
185
**os_specific_subprocess_params())
187
def send(self, data):
188
return os.write(self.proc.stdin.fileno(), data)
190
def recv_ready(self):
191
# TODO: jam 20051215 this function is necessary to support the
192
# pipelined() function. In reality, it probably should use
193
# poll() or select() to actually return if there is data
194
# available, otherwise we probably don't get any benefit
197
def recv(self, count):
198
return os.read(self.proc.stdout.fileno(), count)
201
self.proc.stdin.close()
202
self.proc.stdout.close()
206
class LoopbackSFTP(object):
207
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
209
def __init__(self, sock):
212
def send(self, data):
213
return self.__socket.send(data)
216
return self.__socket.recv(n)
218
def recv_ready(self):
222
self.__socket.close()
228
# This is a weakref dictionary, so that we can reuse connections
229
# that are still active. Long term, it might be nice to have some
230
# sort of expiration policy, such as disconnect if inactive for
231
# X seconds. But that requires a lot more fanciness.
232
_connected_hosts = weakref.WeakValueDictionary()
100
234
def clear_connection_cache():
101
235
"""Remove all hosts from the SFTP connection cache.
103
237
Primarily useful for test cases wanting to force garbage collection.
104
We don't have a global connection cache anymore.
239
_connected_hosts.clear()
242
def load_host_keys():
244
Load system host keys (probably doesn't work on windows) and any
245
"discovered" keys from previous sessions.
247
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
249
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
251
mutter('failed to load system host keys: ' + str(e))
252
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
254
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
256
mutter('failed to load bzr host keys: ' + str(e))
260
def save_host_keys():
262
Save "discovered" host keys in $(config)/ssh_host_keys/.
264
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
265
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
266
ensure_config_dir_exists()
269
f = open(bzr_hostkey_path, 'w')
270
f.write('# SSH host keys collected by bzr\n')
271
for hostname, keys in BZR_HOSTKEYS.iteritems():
272
for keytype, key in keys.iteritems():
273
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
276
mutter('failed to save bzr host keys: ' + str(e))
107
279
class SFTPLock(object):
108
"""This fakes a lock in a remote location.
110
A present lock is indicated just by the existence of a file. This
111
doesn't work well on all transports and they are only used in
112
deprecated storage formats.
280
"""This fakes a lock in a remote location."""
115
281
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
117
282
def __init__(self, path, transport):
118
283
assert isinstance(transport, SFTPTransport)
167
332
# up the request itself, rather than us having to worry about it
168
333
_max_request_size = 32768
170
def __init__(self, base, _from_transport=None):
335
def __init__(self, base, clone_from=None):
171
336
assert base.startswith('sftp://')
172
super(SFTPTransport, self).__init__(base,
173
_from_transport=_from_transport)
337
self._parse_url(base)
338
base = self._unparse_url()
341
super(SFTPTransport, self).__init__(base)
342
if clone_from is None:
345
# use the same ssh connection, etc
346
self._sftp = clone_from._sftp
347
# super saves 'self.base'
349
def should_cache(self):
351
Return True if the data pulled across should be cached locally.
355
def clone(self, offset=None):
357
Return a new SFTPTransport with root at self.base + offset.
358
We share the same SFTP session between such transports, because it's
359
fairly expensive to set them up.
362
return SFTPTransport(self.base, self)
364
return SFTPTransport(self.abspath(offset), self)
366
def abspath(self, relpath):
368
Return the full url to the given relative path.
370
@param relpath: the relative path or path components
371
@type relpath: str or list
373
return self._unparse_url(self._remote_path(relpath))
175
375
def _remote_path(self, relpath):
176
376
"""Return the path to be passed along the sftp protocol for relpath.
178
:param relpath: is a urlencoded string.
180
relative = urlutils.unescape(relpath).encode('utf-8')
181
remote_path = self._combine_paths(self._path, relative)
182
# the initial slash should be removed from the path, and treated as a
183
# homedir relative path (the path begins with a double slash if it is
184
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
185
# RBC 20060118 we are not using this as its too user hostile. instead
186
# we are following lftp and using /~/foo to mean '~/foo'
187
# vila--20070602 and leave absolute paths begin with a single slash.
188
if remote_path.startswith('/~/'):
189
remote_path = remote_path[3:]
190
elif remote_path == '/~':
194
def _create_connection(self, credentials=None):
195
"""Create a new connection with the provided credentials.
197
:param credentials: The credentials needed to establish the connection.
199
:return: The created connection and its associated credentials.
201
The credentials are only the password as it may have been entered
202
interactively by the user and may be different from the one provided
203
in base url at transport creation time.
205
if credentials is None:
206
password = self._password
208
password = credentials
210
vendor = ssh._get_ssh_vendor()
211
connection = vendor.connect_sftp(self._user, password,
212
self._host, self._port)
213
return connection, password
216
"""Ensures that a connection is established"""
217
connection = self._get_connection()
218
if connection is None:
219
# First connection ever
220
connection, credentials = self._create_connection()
221
self._set_connection(connection, credentials)
378
relpath is a urlencoded string.
380
# FIXME: share the common code across transports
381
assert isinstance(relpath, basestring)
382
relpath = urlutils.unescape(relpath).split('/')
383
basepath = self._path.split('/')
384
if len(basepath) > 0 and basepath[-1] == '':
385
basepath = basepath[:-1]
389
if len(basepath) == 0:
390
# In most filesystems, a request for the parent
391
# of root, just returns root.
399
path = '/'.join(basepath)
400
# mutter('relpath => remotepath %s => %s', relpath, path)
403
def relpath(self, abspath):
404
username, password, host, port, path = self._split_url(abspath)
406
if (username != self._username):
407
error.append('username mismatch')
408
if (host != self._host):
409
error.append('host mismatch')
410
if (port != self._port):
411
error.append('port mismatch')
412
if (not path.startswith(self._path)):
413
error.append('path mismatch')
415
extra = ': ' + ', '.join(error)
416
raise PathNotChild(abspath, self.base, extra=extra)
418
return path[pl:].strip('/')
224
420
def has(self, relpath):
226
422
Does the target location exist?
229
self._get_sftp().stat(self._remote_path(relpath))
425
self._sftp.stat(self._remote_path(relpath))
367
554
yield cur_offset_and_size[0], this_data
368
555
cur_offset_and_size = offset_stack.next()
370
# We read a coalesced entry, so mark it as done
372
557
# Now that we've read all of the data for this coalesced section
374
559
cur_coalesced = cur_coalesced_stack.next()
376
if cur_coalesced is not None:
377
raise errors.ShortReadvError(relpath, cur_coalesced.start,
378
cur_coalesced.length, len(data))
380
def put_file(self, relpath, f, mode=None):
561
def put(self, relpath, f, mode=None):
382
Copy the file-like object into the location.
563
Copy the file-like or string object into the location.
384
565
:param relpath: Location to put the contents, relative to base.
385
:param f: File-like object.
566
:param f: File-like or string object.
386
567
:param mode: The final mode for the file
388
569
final_path = self._remote_path(relpath)
389
return self._put(final_path, f, mode=mode)
570
self._put(final_path, f, mode=mode)
391
572
def _put(self, abspath, f, mode=None):
392
573
"""Helper function so both put() and copy_abspaths can reuse the code"""
433
self._get_sftp().remove(tmp_abspath)
600
self._sftp.remove(tmp_abspath)
435
602
# raise the saved except
437
604
# raise the original with its traceback if we can.
440
def _put_non_atomic_helper(self, relpath, writer, mode=None,
441
create_parent_dir=False,
443
abspath = self._remote_path(relpath)
445
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
446
# set the file mode at create time. If it does, use it.
447
# But for now, we just chmod later anyway.
449
def _open_and_write_file():
450
"""Try to open the target file, raise error on failure"""
454
fout = self._get_sftp().file(abspath, mode='wb')
455
fout.set_pipelined(True)
457
except (paramiko.SSHException, IOError), e:
458
self._translate_io_exception(e, abspath,
461
# This is designed to chmod() right before we close.
462
# Because we set_pipelined() earlier, theoretically we might
463
# avoid the round trip for fout.close()
465
self._get_sftp().chmod(abspath, mode)
470
if not create_parent_dir:
471
_open_and_write_file()
474
# Try error handling to create the parent directory if we need to
476
_open_and_write_file()
478
# Try to create the parent directory, and then go back to
480
parent_dir = os.path.dirname(abspath)
481
self._mkdir(parent_dir, dir_mode)
482
_open_and_write_file()
484
def put_file_non_atomic(self, relpath, f, mode=None,
485
create_parent_dir=False,
487
"""Copy the file-like object into the target location.
489
This function is not strictly safe to use. It is only meant to
490
be used when you already know that the target does not exist.
491
It is not safe, because it will open and truncate the remote
492
file. So there may be a time when the file has invalid contents.
494
:param relpath: The remote location to put the contents.
495
:param f: File-like object.
496
:param mode: Possible access permissions for new file.
497
None means do not set remote permissions.
498
:param create_parent_dir: If we cannot create the target file because
499
the parent directory does not exist, go ahead and
500
create it, and then try again.
504
self._put_non_atomic_helper(relpath, writer, mode=mode,
505
create_parent_dir=create_parent_dir,
508
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
509
create_parent_dir=False,
513
self._put_non_atomic_helper(relpath, writer, mode=mode,
514
create_parent_dir=create_parent_dir,
517
607
def iter_files_recursive(self):
518
608
"""Walk the relative paths of all files in this transport."""
519
609
queue = list(self.list_dir('.'))
521
relpath = queue.pop(0)
611
relpath = urllib.quote(queue.pop(0))
522
612
st = self.stat(relpath)
523
613
if stat.S_ISDIR(st.st_mode):
524
614
for i, basename in enumerate(self.list_dir(relpath)):
529
def _mkdir(self, abspath, mode=None):
535
self._get_sftp().mkdir(abspath, local_mode)
537
self._get_sftp().chmod(abspath, mode=mode)
538
except (paramiko.SSHException, IOError), e:
539
self._translate_io_exception(e, abspath, ': unable to mkdir',
540
failure_exc=FileExists)
542
619
def mkdir(self, relpath, mode=None):
543
620
"""Create a directory at the given path."""
544
self._mkdir(self._remote_path(relpath), mode=mode)
546
def open_write_stream(self, relpath, mode=None):
547
"""See Transport.open_write_stream."""
548
# initialise the file to zero-length
549
# this is three round trips, but we don't use this
550
# api more than once per write_group at the moment so
551
# it is a tolerable overhead. Better would be to truncate
552
# the file after opening. RBC 20070805
553
self.put_bytes_non_atomic(relpath, "", mode)
554
abspath = self._remote_path(relpath)
555
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
556
# set the file mode at create time. If it does, use it.
557
# But for now, we just chmod later anyway.
621
path = self._remote_path(relpath)
560
handle = self._get_sftp().file(abspath, mode='wb')
561
handle.set_pipelined(True)
623
# In the paramiko documentation, it says that passing a mode flag
624
# will filtered against the server umask.
625
# StubSFTPServer does not do this, which would be nice, because it is
626
# what we really want :)
627
# However, real servers do use umask, so we really should do it that way
628
self._sftp.mkdir(path)
630
self._sftp.chmod(path, mode=mode)
562
631
except (paramiko.SSHException, IOError), e:
563
self._translate_io_exception(e, abspath,
565
_file_streams[self.abspath(relpath)] = handle
566
return FileFileStream(self, relpath, handle)
632
self._translate_io_exception(e, path, ': unable to mkdir',
633
failure_exc=FileExists)
568
def _translate_io_exception(self, e, path, more_info='',
635
def _translate_io_exception(self, e, path, more_info='',
569
636
failure_exc=PathError):
570
637
"""Translate a paramiko or IOError into a friendlier exception.
714
770
# that we have taken the lock.
715
771
return SFTPLock(relpath, self)
773
def _unparse_url(self, path=None):
776
path = urllib.quote(path)
777
# handle homedir paths
778
if not path.startswith('/'):
780
netloc = urllib.quote(self._host)
781
if self._username is not None:
782
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
783
if self._port is not None:
784
netloc = '%s:%d' % (netloc, self._port)
785
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
787
def _split_url(self, url):
788
(scheme, username, password, host, port, path) = split_url(url)
789
assert scheme == 'sftp'
791
# the initial slash should be removed from the path, and treated
792
# as a homedir relative path (the path begins with a double slash
793
# if it is absolute).
794
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
795
# RBC 20060118 we are not using this as its too user hostile. instead
796
# we are following lftp and using /~/foo to mean '~/foo'.
797
# handle homedir paths
798
if path.startswith('/~/'):
802
return (username, password, host, port, path)
804
def _parse_url(self, url):
805
(self._username, self._password,
806
self._host, self._port, self._path) = self._split_url(url)
808
def _sftp_connect(self):
809
"""Connect to the remote sftp server.
810
After this, self._sftp should have a valid connection (or
811
we raise an TransportError 'could not connect').
813
TODO: Raise a more reasonable ConnectionFailed exception
815
global _connected_hosts
817
idx = (self._host, self._port, self._username)
819
self._sftp = _connected_hosts[idx]
824
vendor = _get_ssh_vendor()
825
if vendor == 'loopback':
826
sock = socket.socket()
828
sock.connect((self._host, self._port))
829
except socket.error, e:
830
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
831
% (self._host, self._port, e))
832
self._sftp = SFTPClient(LoopbackSFTP(sock))
833
elif vendor != 'none':
835
sock = SFTPSubprocess(self._host, vendor, self._port,
837
self._sftp = SFTPClient(sock)
838
except (EOFError, paramiko.SSHException), e:
839
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
840
% (self._host, self._port, e))
841
except (OSError, IOError), e:
842
# If the machine is fast enough, ssh can actually exit
843
# before we try and send it the sftp request, which
844
# raises a Broken Pipe
845
if e.errno not in (errno.EPIPE,):
847
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
848
% (self._host, self._port, e))
850
self._paramiko_connect()
852
_connected_hosts[idx] = self._sftp
854
def _paramiko_connect(self):
855
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
860
t = paramiko.Transport((self._host, self._port or 22))
861
t.set_log_channel('bzr.paramiko')
863
except (paramiko.SSHException, socket.error), e:
864
raise ConnectionError('Unable to reach SSH host %s:%s: %s'
865
% (self._host, self._port, e))
867
server_key = t.get_remote_server_key()
868
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
869
keytype = server_key.get_name()
870
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
871
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
872
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
873
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
874
our_server_key = BZR_HOSTKEYS[self._host][keytype]
875
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
877
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
878
if not BZR_HOSTKEYS.has_key(self._host):
879
BZR_HOSTKEYS[self._host] = {}
880
BZR_HOSTKEYS[self._host][keytype] = server_key
881
our_server_key = server_key
882
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
884
if server_key != our_server_key:
885
filename1 = os.path.expanduser('~/.ssh/known_hosts')
886
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
887
raise TransportError('Host keys for %s do not match! %s != %s' % \
888
(self._host, our_server_key_hex, server_key_hex),
889
['Try editing %s or %s' % (filename1, filename2)])
894
self._sftp = t.open_sftp_client()
895
except paramiko.SSHException, e:
896
raise ConnectionError('Unable to start sftp client %s:%d' %
897
(self._host, self._port), e)
899
def _sftp_auth(self, transport):
900
# paramiko requires a username, but it might be none if nothing was supplied
901
# use the local username, just in case.
902
# We don't override self._username, because if we aren't using paramiko,
903
# the username might be specified in ~/.ssh/config and we don't want to
904
# force it to something else
905
# Also, it would mess up the self.relpath() functionality
906
username = self._username or getpass.getuser()
909
agent = paramiko.Agent()
910
for key in agent.get_keys():
911
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
913
transport.auth_publickey(username, key)
915
except paramiko.SSHException, e:
918
# okay, try finding id_rsa or id_dss? (posix only)
919
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
921
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
926
transport.auth_password(username, self._password)
928
except paramiko.SSHException, e:
931
# FIXME: Don't keep a password held in memory if you can help it
932
#self._password = None
934
# give up and ask for a password
935
password = bzrlib.ui.ui_factory.get_password(
936
prompt='SSH %(user)s@%(host)s password',
937
user=username, host=self._host)
939
transport.auth_password(username, password)
940
except paramiko.SSHException, e:
941
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
942
(username, self._host), e)
944
def _try_pkey_auth(self, transport, pkey_class, username, filename):
945
filename = os.path.expanduser('~/.ssh/' + filename)
947
key = pkey_class.from_private_key_file(filename)
948
transport.auth_publickey(username, key)
950
except paramiko.PasswordRequiredException:
951
password = bzrlib.ui.ui_factory.get_password(
952
prompt='SSH %(filename)s password',
955
key = pkey_class.from_private_key_file(filename, password)
956
transport.auth_publickey(username, key)
958
except paramiko.SSHException:
959
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
960
except paramiko.SSHException:
961
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
717
966
def _sftp_open_exclusive(self, abspath, mode=None):
718
967
"""Open a remote path exclusively.
828
class SocketDelay(object):
829
"""A socket decorator to make TCP appear slower.
831
This changes recv, send, and sendall to add a fixed latency to each python
832
call if a new roundtrip is detected. That is, when a recv is called and the
833
flag new_roundtrip is set, latency is charged. Every send and send_all
836
In addition every send, sendall and recv sleeps a bit per character send to
839
Not all methods are implemented, this is deliberate as this class is not a
840
replacement for the builtin sockets layer. fileno is not implemented to
841
prevent the proxy being bypassed.
845
_proxied_arguments = dict.fromkeys([
846
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
847
"setblocking", "setsockopt", "settimeout", "shutdown"])
849
def __init__(self, sock, latency, bandwidth=1.0,
852
:param bandwith: simulated bandwith (MegaBit)
853
:param really_sleep: If set to false, the SocketDelay will just
854
increase a counter, instead of calling time.sleep. This is useful for
855
unittesting the SocketDelay.
858
self.latency = latency
859
self.really_sleep = really_sleep
860
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
861
self.new_roundtrip = False
864
if self.really_sleep:
867
SocketDelay.simulated_time += s
869
def __getattr__(self, attr):
870
if attr in SocketDelay._proxied_arguments:
871
return getattr(self.sock, attr)
872
raise AttributeError("'SocketDelay' object has no attribute %r" %
876
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
879
def recv(self, *args):
880
data = self.sock.recv(*args)
881
if data and self.new_roundtrip:
882
self.new_roundtrip = False
883
self.sleep(self.latency)
884
self.sleep(len(data) * self.time_per_byte)
887
def sendall(self, data, flags=0):
888
if not self.new_roundtrip:
889
self.new_roundtrip = True
890
self.sleep(self.latency)
891
self.sleep(len(data) * self.time_per_byte)
892
return self.sock.sendall(data, flags)
894
def send(self, data, flags=0):
895
if not self.new_roundtrip:
896
self.new_roundtrip = True
897
self.sleep(self.latency)
898
bytes_sent = self.sock.send(data, flags)
899
self.sleep(bytes_sent * self.time_per_byte)
903
1068
class SFTPServer(Server):
904
1069
"""Common code for SFTP server facilities."""
906
def __init__(self, server_interface=StubServer):
907
1072
self._original_vendor = None
908
1073
self._homedir = None
909
1074
self._server_homedir = None
910
1075
self._listener = None
911
1076
self._root = None
912
self._vendor = ssh.ParamikoVendor()
913
self._server_interface = server_interface
1077
self._vendor = 'none'
914
1078
# sftp server logs
918
1081
def _get_sftp_url(self, path):
919
1082
"""Calculate an sftp url to this server for path."""
added
removed
bzrlib/transport/sftp.py
