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.trace import mutter, warning
46
from bzrlib.trace import mutter, warning, error
52
47
from bzrlib.transport import (
53
48
register_urlparse_netloc_protocol,
54
import bzrlib.urlutils as urlutils
67
63
CMD_HANDLE, CMD_OPEN)
68
64
from paramiko.sftp_attr import SFTPAttributes
69
65
from paramiko.sftp_file import SFTPFile
66
from paramiko.sftp_client import SFTPClient
72
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,
106
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
107
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
108
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
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()
75
228
# This is a weakref dictionary, so that we can reuse connections
76
229
# that are still active. Long term, it might be nice to have some
77
230
# sort of expiration policy, such as disconnect if inactive for
78
231
# X seconds. But that requires a lot more fanciness.
79
232
_connected_hosts = weakref.WeakValueDictionary()
82
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
83
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
84
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
87
234
def clear_connection_cache():
88
235
"""Remove all hosts from the SFTP connection cache.
92
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))
95
279
class SFTPLock(object):
96
"""This fakes a lock in a remote location.
98
A present lock is indicated just by the existence of a file. This
99
doesn't work well on all transports and they are only used in
100
deprecated storage formats.
280
"""This fakes a lock in a remote location."""
103
281
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
105
282
def __init__(self, path, transport):
106
283
assert isinstance(transport, SFTPTransport)
137
class SFTPUrlHandling(Transport):
138
"""Mix-in that does common handling of SSH/SFTP URLs."""
140
def __init__(self, base):
141
self._parse_url(base)
142
base = self._unparse_url(self._path)
145
super(SFTPUrlHandling, self).__init__(base)
147
def _parse_url(self, url):
149
self._username, self._password,
150
self._host, self._port, self._path) = self._split_url(url)
152
def _unparse_url(self, path):
153
"""Return a URL for a path relative to this transport.
155
path = urllib.quote(path)
156
# handle homedir paths
157
if not path.startswith('/'):
159
netloc = urllib.quote(self._host)
160
if self._username is not None:
161
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
162
if self._port is not None:
163
netloc = '%s:%d' % (netloc, self._port)
164
return urlparse.urlunparse((self._scheme, netloc, path, '', '', ''))
166
def _split_url(self, url):
167
(scheme, username, password, host, port, path) = split_url(url)
168
## assert scheme == 'sftp'
170
# the initial slash should be removed from the path, and treated
171
# as a homedir relative path (the path begins with a double slash
172
# if it is absolute).
173
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
174
# RBC 20060118 we are not using this as its too user hostile. instead
175
# we are following lftp and using /~/foo to mean '~/foo'.
176
# handle homedir paths
177
if path.startswith('/~/'):
181
return (scheme, username, password, host, port, path)
183
def abspath(self, relpath):
184
"""Return the full url to the given relative path.
186
@param relpath: the relative path or path components
187
@type relpath: str or list
189
return self._unparse_url(self._remote_path(relpath))
191
def _remote_path(self, relpath):
192
"""Return the path to be passed along the sftp protocol for relpath.
194
:param relpath: is a urlencoded string.
196
return self._combine_paths(self._path, relpath)
199
class SFTPTransport(SFTPUrlHandling):
200
"""Transport implementation for SFTP access."""
314
class SFTPTransport (Transport):
315
"""Transport implementation for SFTP access"""
202
317
_do_prefetch = _default_do_prefetch
203
318
# TODO: jam 20060717 Conceivably these could be configurable, either
244
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))
246
375
def _remote_path(self, relpath):
247
376
"""Return the path to be passed along the sftp protocol for relpath.
249
378
relpath is a urlencoded string.
251
:return: a path prefixed with / for regular abspath-based urls, or a
252
path that does not begin with / for urls which begin with /~/.
254
# how does this work?
255
# it processes relpath with respect to
257
# firstly we create a path to evaluate:
258
# if relpath is an abspath or homedir path, its the entire thing
259
# otherwise we join our base with relpath
260
# then we eliminate all empty segments (double //'s) outside the first
261
# two elements of the list. This avoids problems with trailing
262
# slashes, or other abnormalities.
263
# finally we evaluate the entire path in a single pass
265
# '..' result in popping the left most already
266
# processed path (which can never be empty because of the check for
267
# abspath and homedir meaning that its not, or that we've used our
268
# path. If the pop would pop the root, we ignore it.
270
# Specific case examinations:
271
# remove the special casefor ~: if the current root is ~/ popping of it
272
# = / thus our seed for a ~ based path is ['', '~']
273
# and if we end up with [''] then we had basically ('', '..') (which is
274
# '/..' so we append '' if the length is one, and assert that the first
275
# element is still ''. Lastly, if we end with ['', '~'] as a prefix for
276
# the output, we've got a homedir path, so we strip that prefix before
277
# '/' joining the resulting list.
279
# case one: '/' -> ['', ''] cannot shrink
280
# case two: '/' + '../foo' -> ['', 'foo'] (take '', '', '..', 'foo')
281
# and pop the second '' for the '..', append 'foo'
282
# case three: '/~/' -> ['', '~', '']
283
# case four: '/~/' + '../foo' -> ['', '~', '', '..', 'foo'],
284
# and we want to get '/foo' - the empty path in the middle
285
# needs to be stripped, then normal path manipulation will
287
# case five: '/..' ['', '..'], we want ['', '']
288
# stripping '' outside the first two is ok
289
# ignore .. if its too high up
291
# lastly this code is possibly reusable by FTP, but not reusable by
292
# local paths: ~ is resolvable correctly, nor by HTTP or the smart
293
# server: ~ is resolved remotely.
295
# however, a version of this that acts on self.base is possible to be
296
# written which manipulates the URL in canonical form, and would be
297
# reusable for all transports, if a flag for allowing ~/ at all was
380
# FIXME: share the common code across transports
299
381
assert isinstance(relpath, basestring)
300
relpath = urlutils.unescape(relpath)
303
if relpath.startswith('/'):
304
# abspath - normal split is fine.
305
current_path = relpath.split('/')
306
elif relpath.startswith('~/'):
307
# root is homedir based: normal split and prefix '' to remote the
309
current_path = [''].extend(relpath.split('/'))
311
# root is from the current directory:
312
if self._path.startswith('/'):
313
# abspath, take the regular split
316
# homedir based, add the '', '~' not present in self._path
317
current_path = ['', '~']
318
# add our current dir
319
current_path.extend(self._path.split('/'))
320
# add the users relpath
321
current_path.extend(relpath.split('/'))
322
# strip '' segments that are not in the first one - the leading /.
323
to_process = current_path[:1]
324
for segment in current_path[1:]:
326
to_process.append(segment)
328
# process '.' and '..' segments into output_path.
330
for segment in to_process:
332
# directory pop. Remove a directory
333
# as long as we are not at the root
334
if len(output_path) > 1:
337
# cannot pop beyond the root, so do nothing
339
continue # strip the '.' from the output.
341
# this will append '' to output_path for the root elements,
342
# which is appropriate: its why we strip '' in the first pass.
343
output_path.append(segment)
345
# check output special cases:
346
if output_path == ['']:
348
output_path = ['', '']
349
elif output_path[:2] == ['', '~']:
350
# ['', '~', ...] -> ...
351
output_path = output_path[2:]
352
path = '/'.join(output_path)
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)
355
403
def relpath(self, abspath):
356
scheme, username, password, host, port, path = self._split_url(abspath)
404
username, password, host, port, path = self._split_url(abspath)
358
406
if (username != self._username):
359
407
error.append('username mismatch')
506
554
yield cur_offset_and_size[0], this_data
507
555
cur_offset_and_size = offset_stack.next()
509
# We read a coalesced entry, so mark it as done
511
557
# Now that we've read all of the data for this coalesced section
513
559
cur_coalesced = cur_coalesced_stack.next()
515
if cur_coalesced is not None:
516
raise errors.ShortReadvError(relpath, cur_coalesced.start,
517
cur_coalesced.length, len(data))
519
def put_file(self, relpath, f, mode=None):
561
def put(self, relpath, f, mode=None):
521
Copy the file-like object into the location.
563
Copy the file-like or string object into the location.
523
565
:param relpath: Location to put the contents, relative to base.
524
:param f: File-like object.
566
:param f: File-like or string object.
525
567
:param mode: The final mode for the file
527
569
final_path = self._remote_path(relpath)
575
604
# raise the original with its traceback if we can.
578
def _put_non_atomic_helper(self, relpath, writer, mode=None,
579
create_parent_dir=False,
581
abspath = self._remote_path(relpath)
583
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
584
# set the file mode at create time. If it does, use it.
585
# But for now, we just chmod later anyway.
587
def _open_and_write_file():
588
"""Try to open the target file, raise error on failure"""
592
fout = self._sftp.file(abspath, mode='wb')
593
fout.set_pipelined(True)
595
except (paramiko.SSHException, IOError), e:
596
self._translate_io_exception(e, abspath,
599
# This is designed to chmod() right before we close.
600
# Because we set_pipelined() earlier, theoretically we might
601
# avoid the round trip for fout.close()
603
self._sftp.chmod(abspath, mode)
608
if not create_parent_dir:
609
_open_and_write_file()
612
# Try error handling to create the parent directory if we need to
614
_open_and_write_file()
616
# Try to create the parent directory, and then go back to
618
parent_dir = os.path.dirname(abspath)
619
self._mkdir(parent_dir, dir_mode)
620
_open_and_write_file()
622
def put_file_non_atomic(self, relpath, f, mode=None,
623
create_parent_dir=False,
625
"""Copy the file-like object into the target location.
627
This function is not strictly safe to use. It is only meant to
628
be used when you already know that the target does not exist.
629
It is not safe, because it will open and truncate the remote
630
file. So there may be a time when the file has invalid contents.
632
:param relpath: The remote location to put the contents.
633
:param f: File-like object.
634
:param mode: Possible access permissions for new file.
635
None means do not set remote permissions.
636
:param create_parent_dir: If we cannot create the target file because
637
the parent directory does not exist, go ahead and
638
create it, and then try again.
642
self._put_non_atomic_helper(relpath, writer, mode=mode,
643
create_parent_dir=create_parent_dir,
646
def put_bytes_non_atomic(self, relpath, bytes, mode=None,
647
create_parent_dir=False,
651
self._put_non_atomic_helper(relpath, writer, mode=mode,
652
create_parent_dir=create_parent_dir,
655
607
def iter_files_recursive(self):
656
608
"""Walk the relative paths of all files in this transport."""
657
609
queue = list(self.list_dir('.'))
659
relpath = queue.pop(0)
611
relpath = urllib.quote(queue.pop(0))
660
612
st = self.stat(relpath)
661
613
if stat.S_ISDIR(st.st_mode):
662
614
for i, basename in enumerate(self.list_dir(relpath)):
667
def _mkdir(self, abspath, mode=None):
673
self._sftp.mkdir(abspath, local_mode)
675
self._sftp.chmod(abspath, mode=mode)
676
except (paramiko.SSHException, IOError), e:
677
self._translate_io_exception(e, abspath, ': unable to mkdir',
678
failure_exc=FileExists)
680
619
def mkdir(self, relpath, mode=None):
681
620
"""Create a directory at the given path."""
682
self._mkdir(self._remote_path(relpath), mode=mode)
621
path = self._remote_path(relpath)
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)
631
except (paramiko.SSHException, IOError), e:
632
self._translate_io_exception(e, path, ': unable to mkdir',
633
failure_exc=FileExists)
684
635
def _translate_io_exception(self, e, path, more_info='',
685
636
failure_exc=PathError):
823
770
# that we have taken the lock.
824
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)
826
808
def _sftp_connect(self):
827
809
"""Connect to the remote sftp server.
828
810
After this, self._sftp should have a valid connection (or
831
813
TODO: Raise a more reasonable ConnectionFailed exception
833
self._sftp = _sftp_connect(self._host, self._port, self._username,
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),))
836
966
def _sftp_open_exclusive(self, abspath, mode=None):
837
967
"""Open a remote path exclusively.
947
class SocketDelay(object):
948
"""A socket decorator to make TCP appear slower.
950
This changes recv, send, and sendall to add a fixed latency to each python
951
call if a new roundtrip is detected. That is, when a recv is called and the
952
flag new_roundtrip is set, latency is charged. Every send and send_all
955
In addition every send, sendall and recv sleeps a bit per character send to
958
Not all methods are implemented, this is deliberate as this class is not a
959
replacement for the builtin sockets layer. fileno is not implemented to
960
prevent the proxy being bypassed.
964
_proxied_arguments = dict.fromkeys([
965
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
966
"setblocking", "setsockopt", "settimeout", "shutdown"])
968
def __init__(self, sock, latency, bandwidth=1.0,
971
:param bandwith: simulated bandwith (MegaBit)
972
:param really_sleep: If set to false, the SocketDelay will just
973
increase a counter, instead of calling time.sleep. This is useful for
974
unittesting the SocketDelay.
977
self.latency = latency
978
self.really_sleep = really_sleep
979
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
980
self.new_roundtrip = False
983
if self.really_sleep:
986
SocketDelay.simulated_time += s
988
def __getattr__(self, attr):
989
if attr in SocketDelay._proxied_arguments:
990
return getattr(self.sock, attr)
991
raise AttributeError("'SocketDelay' object has no attribute %r" %
995
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
998
def recv(self, *args):
999
data = self.sock.recv(*args)
1000
if data and self.new_roundtrip:
1001
self.new_roundtrip = False
1002
self.sleep(self.latency)
1003
self.sleep(len(data) * self.time_per_byte)
1006
def sendall(self, data, flags=0):
1007
if not self.new_roundtrip:
1008
self.new_roundtrip = True
1009
self.sleep(self.latency)
1010
self.sleep(len(data) * self.time_per_byte)
1011
return self.sock.sendall(data, flags)
1013
def send(self, data, flags=0):
1014
if not self.new_roundtrip:
1015
self.new_roundtrip = True
1016
self.sleep(self.latency)
1017
bytes_sent = self.sock.send(data, flags)
1018
self.sleep(bytes_sent * self.time_per_byte)
1022
1068
class SFTPServer(Server):
1023
1069
"""Common code for SFTP server facilities."""
1025
def __init__(self, server_interface=StubServer):
1026
1072
self._original_vendor = None
1027
1073
self._homedir = None
1028
1074
self._server_homedir = None
1029
1075
self._listener = None
1030
1076
self._root = None
1031
self._vendor = ssh.ParamikoVendor()
1032
self._server_interface = server_interface
1077
self._vendor = 'none'
1033
1078
# sftp server logs
1035
self.add_latency = 0
1037
1081
def _get_sftp_url(self, path):
1038
1082
"""Calculate an sftp url to this server for path."""
1175
1208
super(SFTPSiblingAbsoluteServer, self).setUp()
1178
def _sftp_connect(host, port, username, password):
1179
"""Connect to the remote sftp server.
1181
:raises: a TransportError 'could not connect'.
1183
:returns: an paramiko.sftp_client.SFTPClient
1185
TODO: Raise a more reasonable ConnectionFailed exception
1187
idx = (host, port, username)
1189
return _connected_hosts[idx]
1193
sftp = _sftp_connect_uncached(host, port, username, password)
1194
_connected_hosts[idx] = sftp
1197
def _sftp_connect_uncached(host, port, username, password):
1198
vendor = ssh._get_ssh_vendor()
1199
sftp = vendor.connect_sftp(username, password, host, port)
1203
1211
def get_test_permutations():
1204
1212
"""Return the permutations to be used in testing."""
1205
1213
return [(SFTPTransport, SFTPAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
