1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006 Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Implementation of Transport over SFTP, using paramiko."""
36
from bzrlib.config import config_dir, ensure_config_dir_exists
37
from bzrlib.errors import (ConnectionError,
39
TransportNotPossible, NoSuchFile, PathNotChild,
45
from bzrlib.osutils import pathjoin, fancy_rename, getcwd
46
from bzrlib.trace import mutter, warning, error
47
from bzrlib.transport import (
48
register_urlparse_netloc_protocol,
54
import bzrlib.urlutils as urlutils
58
except ImportError, e:
59
raise ParamikoNotPresent(e)
61
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
62
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
64
from paramiko.sftp_attr import SFTPAttributes
65
from paramiko.sftp_file import SFTPFile
66
from paramiko.sftp_client import SFTPClient
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()
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()
234
def clear_connection_cache():
235
"""Remove all hosts from the SFTP connection cache.
237
Primarily useful for test cases wanting to force garbage collection.
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))
279
class SFTPLock(object):
280
"""This fakes a lock in a remote location."""
281
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
282
def __init__(self, path, transport):
283
assert isinstance(transport, SFTPTransport)
285
self.lock_file = None
287
self.lock_path = path + '.write-lock'
288
self.transport = transport
290
# RBC 20060103 FIXME should we be using private methods here ?
291
abspath = transport._remote_path(self.lock_path)
292
self.lock_file = transport._sftp_open_exclusive(abspath)
294
raise LockError('File %r already locked' % (self.path,))
297
"""Should this warn, or actually try to cleanup?"""
299
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
303
if not self.lock_file:
305
self.lock_file.close()
306
self.lock_file = None
308
self.transport.delete(self.lock_path)
309
except (NoSuchFile,):
310
# What specific errors should we catch here?
314
class SFTPTransport(Transport):
315
"""Transport implementation for SFTP access."""
317
_do_prefetch = _default_do_prefetch
318
# TODO: jam 20060717 Conceivably these could be configurable, either
319
# by auto-tuning at run-time, or by a configuration (per host??)
320
# but the performance curve is pretty flat, so just going with
321
# reasonable defaults.
322
_max_readv_combine = 200
323
# Having to round trip to the server means waiting for a response,
324
# so it is better to download extra bytes.
325
# 8KiB had good performance for both local and remote network operations
326
_bytes_to_read_before_seek = 8192
328
# The sftp spec says that implementations SHOULD allow reads
329
# to be at least 32K. paramiko.readv() does an async request
330
# for the chunks. So we need to keep it within a single request
331
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
332
# up the request itself, rather than us having to worry about it
333
_max_request_size = 32768
335
def __init__(self, base, clone_from=None):
336
assert base.startswith('sftp://')
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))
375
def _remote_path(self, relpath):
376
"""Return the path to be passed along the sftp protocol for relpath.
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('/')
420
def has(self, relpath):
422
Does the target location exist?
425
self._sftp.stat(self._remote_path(relpath))
430
def get(self, relpath):
432
Get the file at the given relative path.
434
:param relpath: The relative path to the file
437
path = self._remote_path(relpath)
438
f = self._sftp.file(path, mode='rb')
439
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
442
except (IOError, paramiko.SSHException), e:
443
self._translate_io_exception(e, path, ': error retrieving')
445
def readv(self, relpath, offsets):
446
"""See Transport.readv()"""
447
# We overload the default readv() because we want to use a file
448
# that does not have prefetch enabled.
449
# Also, if we have a new paramiko, it implements an async readv()
454
path = self._remote_path(relpath)
455
fp = self._sftp.file(path, mode='rb')
456
readv = getattr(fp, 'readv', None)
458
return self._sftp_readv(fp, offsets)
459
mutter('seek and read %s offsets', len(offsets))
460
return self._seek_and_read(fp, offsets)
461
except (IOError, paramiko.SSHException), e:
462
self._translate_io_exception(e, path, ': error retrieving')
464
def _sftp_readv(self, fp, offsets):
465
"""Use the readv() member of fp to do async readv.
467
And then read them using paramiko.readv(). paramiko.readv()
468
does not support ranges > 64K, so it caps the request size, and
469
just reads until it gets all the stuff it wants
471
offsets = list(offsets)
472
sorted_offsets = sorted(offsets)
474
# The algorithm works as follows:
475
# 1) Coalesce nearby reads into a single chunk
476
# This generates a list of combined regions, the total size
477
# and the size of the sub regions. This coalescing step is limited
478
# in the number of nearby chunks to combine, and is allowed to
479
# skip small breaks in the requests. Limiting it makes sure that
480
# we can start yielding some data earlier, and skipping means we
481
# make fewer requests. (Beneficial even when using async)
482
# 2) Break up this combined regions into chunks that are smaller
483
# than 64KiB. Technically the limit is 65536, but we are a
484
# little bit conservative. This is because sftp has a maximum
485
# return chunk size of 64KiB (max size of an unsigned short)
486
# 3) Issue a readv() to paramiko to create an async request for
488
# 4) Read in the data as it comes back, until we've read one
489
# continuous section as determined in step 1
490
# 5) Break up the full sections into hunks for the original requested
491
# offsets. And put them in a cache
492
# 6) Check if the next request is in the cache, and if it is, remove
493
# it from the cache, and yield its data. Continue until no more
494
# entries are in the cache.
495
# 7) loop back to step 4 until all data has been read
497
# TODO: jam 20060725 This could be optimized one step further, by
498
# attempting to yield whatever data we have read, even before
499
# the first coallesced section has been fully processed.
501
# When coalescing for use with readv(), we don't really need to
502
# use any fudge factor, because the requests are made asynchronously
503
coalesced = list(self._coalesce_offsets(sorted_offsets,
504
limit=self._max_readv_combine,
508
for c_offset in coalesced:
509
start = c_offset.start
510
size = c_offset.length
512
# We need to break this up into multiple requests
514
next_size = min(size, self._max_request_size)
515
requests.append((start, next_size))
519
mutter('SFTP.readv() %s offsets => %s coalesced => %s requests',
520
len(offsets), len(coalesced), len(requests))
522
# Queue the current read until we have read the full coalesced section
525
cur_coalesced_stack = iter(coalesced)
526
cur_coalesced = cur_coalesced_stack.next()
528
# Cache the results, but only until they have been fulfilled
530
# turn the list of offsets into a stack
531
offset_stack = iter(offsets)
532
cur_offset_and_size = offset_stack.next()
534
for data in fp.readv(requests):
536
cur_data_len += len(data)
538
if cur_data_len < cur_coalesced.length:
540
assert cur_data_len == cur_coalesced.length, \
541
"Somehow we read too much: %s != %s" % (cur_data_len,
542
cur_coalesced.length)
543
all_data = ''.join(cur_data)
547
for suboffset, subsize in cur_coalesced.ranges:
548
key = (cur_coalesced.start+suboffset, subsize)
549
data_map[key] = all_data[suboffset:suboffset+subsize]
551
# Now that we've read some data, see if we can yield anything back
552
while cur_offset_and_size in data_map:
553
this_data = data_map.pop(cur_offset_and_size)
554
yield cur_offset_and_size[0], this_data
555
cur_offset_and_size = offset_stack.next()
557
# Now that we've read all of the data for this coalesced section
559
cur_coalesced = cur_coalesced_stack.next()
561
def put(self, relpath, f, mode=None):
563
Copy the file-like or string object into the location.
565
:param relpath: Location to put the contents, relative to base.
566
:param f: File-like or string object.
567
:param mode: The final mode for the file
569
final_path = self._remote_path(relpath)
570
self._put(final_path, f, mode=mode)
572
def _put(self, abspath, f, mode=None):
573
"""Helper function so both put() and copy_abspaths can reuse the code"""
574
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
575
os.getpid(), random.randint(0,0x7FFFFFFF))
576
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
580
fout.set_pipelined(True)
582
except (IOError, paramiko.SSHException), e:
583
self._translate_io_exception(e, tmp_abspath)
585
self._sftp.chmod(tmp_abspath, mode)
588
self._rename_and_overwrite(tmp_abspath, abspath)
590
# If we fail, try to clean up the temporary file
591
# before we throw the exception
592
# but don't let another exception mess things up
593
# Write out the traceback, because otherwise
594
# the catch and throw destroys it
596
mutter(traceback.format_exc())
600
self._sftp.remove(tmp_abspath)
602
# raise the saved except
604
# raise the original with its traceback if we can.
607
def iter_files_recursive(self):
608
"""Walk the relative paths of all files in this transport."""
609
queue = list(self.list_dir('.'))
611
relpath = urllib.quote(queue.pop(0))
612
st = self.stat(relpath)
613
if stat.S_ISDIR(st.st_mode):
614
for i, basename in enumerate(self.list_dir(relpath)):
615
queue.insert(i, relpath+'/'+basename)
619
def mkdir(self, relpath, mode=None):
620
"""Create a directory at the given path."""
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)
635
def _translate_io_exception(self, e, path, more_info='',
636
failure_exc=PathError):
637
"""Translate a paramiko or IOError into a friendlier exception.
639
:param e: The original exception
640
:param path: The path in question when the error is raised
641
:param more_info: Extra information that can be included,
642
such as what was going on
643
:param failure_exc: Paramiko has the super fun ability to raise completely
644
opaque errors that just set "e.args = ('Failure',)" with
646
If this parameter is set, it defines the exception
647
to raise in these cases.
649
# paramiko seems to generate detailless errors.
650
self._translate_error(e, path, raise_generic=False)
651
if hasattr(e, 'args'):
652
if (e.args == ('No such file or directory',) or
653
e.args == ('No such file',)):
654
raise NoSuchFile(path, str(e) + more_info)
655
if (e.args == ('mkdir failed',)):
656
raise FileExists(path, str(e) + more_info)
657
# strange but true, for the paramiko server.
658
if (e.args == ('Failure',)):
659
raise failure_exc(path, str(e) + more_info)
660
mutter('Raising exception with args %s', e.args)
661
if hasattr(e, 'errno'):
662
mutter('Raising exception with errno %s', e.errno)
665
def append(self, relpath, f, mode=None):
667
Append the text in the file-like object into the final
671
path = self._remote_path(relpath)
672
fout = self._sftp.file(path, 'ab')
674
self._sftp.chmod(path, mode)
678
except (IOError, paramiko.SSHException), e:
679
self._translate_io_exception(e, relpath, ': unable to append')
681
def rename(self, rel_from, rel_to):
682
"""Rename without special overwriting"""
684
self._sftp.rename(self._remote_path(rel_from),
685
self._remote_path(rel_to))
686
except (IOError, paramiko.SSHException), e:
687
self._translate_io_exception(e, rel_from,
688
': unable to rename to %r' % (rel_to))
690
def _rename_and_overwrite(self, abs_from, abs_to):
691
"""Do a fancy rename on the remote server.
693
Using the implementation provided by osutils.
696
fancy_rename(abs_from, abs_to,
697
rename_func=self._sftp.rename,
698
unlink_func=self._sftp.remove)
699
except (IOError, paramiko.SSHException), e:
700
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
702
def move(self, rel_from, rel_to):
703
"""Move the item at rel_from to the location at rel_to"""
704
path_from = self._remote_path(rel_from)
705
path_to = self._remote_path(rel_to)
706
self._rename_and_overwrite(path_from, path_to)
708
def delete(self, relpath):
709
"""Delete the item at relpath"""
710
path = self._remote_path(relpath)
712
self._sftp.remove(path)
713
except (IOError, paramiko.SSHException), e:
714
self._translate_io_exception(e, path, ': unable to delete')
717
"""Return True if this store supports listing."""
720
def list_dir(self, relpath):
722
Return a list of all files at the given location.
724
# does anything actually use this?
725
path = self._remote_path(relpath)
727
return self._sftp.listdir(path)
728
except (IOError, paramiko.SSHException), e:
729
self._translate_io_exception(e, path, ': failed to list_dir')
731
def rmdir(self, relpath):
732
"""See Transport.rmdir."""
733
path = self._remote_path(relpath)
735
return self._sftp.rmdir(path)
736
except (IOError, paramiko.SSHException), e:
737
self._translate_io_exception(e, path, ': failed to rmdir')
739
def stat(self, relpath):
740
"""Return the stat information for a file."""
741
path = self._remote_path(relpath)
743
return self._sftp.stat(path)
744
except (IOError, paramiko.SSHException), e:
745
self._translate_io_exception(e, path, ': unable to stat')
747
def lock_read(self, relpath):
749
Lock the given file for shared (read) access.
750
:return: A lock object, which has an unlock() member function
752
# FIXME: there should be something clever i can do here...
753
class BogusLock(object):
754
def __init__(self, path):
758
return BogusLock(relpath)
760
def lock_write(self, relpath):
762
Lock the given file for exclusive (write) access.
763
WARNING: many transports do not support this, so trying avoid using it
765
:return: A lock object, which has an unlock() member function
767
# This is a little bit bogus, but basically, we create a file
768
# which should not already exist, and if it does, we assume
769
# that there is a lock, and if it doesn't, the we assume
770
# that we have taken the lock.
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),))
966
def _sftp_open_exclusive(self, abspath, mode=None):
967
"""Open a remote path exclusively.
969
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
970
the file already exists. However it does not expose this
971
at the higher level of SFTPClient.open(), so we have to
974
WARNING: This breaks the SFTPClient abstraction, so it
975
could easily break against an updated version of paramiko.
977
:param abspath: The remote absolute path where the file should be opened
978
:param mode: The mode permissions bits for the new file
980
path = self._sftp._adjust_cwd(abspath)
981
# mutter('sftp abspath %s => %s', abspath, path)
982
attr = SFTPAttributes()
985
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
986
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
988
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
990
raise TransportError('Expected an SFTP handle')
991
handle = msg.get_string()
992
return SFTPFile(self._sftp, handle, 'wb', -1)
993
except (paramiko.SSHException, IOError), e:
994
self._translate_io_exception(e, abspath, ': unable to open',
995
failure_exc=FileExists)
998
# ------------- server test implementation --------------
1002
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
1004
STUB_SERVER_KEY = """
1005
-----BEGIN RSA PRIVATE KEY-----
1006
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
1007
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
1008
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
1009
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
1010
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
1011
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
1012
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
1013
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
1014
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
1015
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
1016
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
1017
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
1018
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
1019
-----END RSA PRIVATE KEY-----
1023
class SocketListener(threading.Thread):
1025
def __init__(self, callback):
1026
threading.Thread.__init__(self)
1027
self._callback = callback
1028
self._socket = socket.socket()
1029
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
1030
self._socket.bind(('localhost', 0))
1031
self._socket.listen(1)
1032
self.port = self._socket.getsockname()[1]
1033
self._stop_event = threading.Event()
1036
# called from outside this thread
1037
self._stop_event.set()
1038
# use a timeout here, because if the test fails, the server thread may
1039
# never notice the stop_event.
1041
self._socket.close()
1045
readable, writable_unused, exception_unused = \
1046
select.select([self._socket], [], [], 0.1)
1047
if self._stop_event.isSet():
1049
if len(readable) == 0:
1052
s, addr_unused = self._socket.accept()
1053
# because the loopback socket is inline, and transports are
1054
# never explicitly closed, best to launch a new thread.
1055
threading.Thread(target=self._callback, args=(s,)).start()
1056
except socket.error, x:
1057
sys.excepthook(*sys.exc_info())
1058
warning('Socket error during accept() within unit test server'
1060
except Exception, x:
1061
# probably a failed test; unit test thread will log the
1063
sys.excepthook(*sys.exc_info())
1064
warning('Exception from within unit test server thread: %r' %
1068
class SocketDelay(object):
1069
"""A socket decorator to make TCP appear slower.
1071
This changes recv, send, and sendall to add a fixed latency to each python
1072
call if a new roundtrip is detected. That is, when a recv is called and the
1073
flag new_roundtrip is set, latency is charged. Every send and send_all
1076
In addition every send, sendall and recv sleeps a bit per character send to
1079
Not all methods are implemented, this is deliberate as this class is not a
1080
replacement for the builtin sockets layer. fileno is not implemented to
1081
prevent the proxy being bypassed.
1085
_proxied_arguments = dict.fromkeys([
1086
"close", "getpeername", "getsockname", "getsockopt", "gettimeout",
1087
"setblocking", "setsockopt", "settimeout", "shutdown"])
1089
def __init__(self, sock, latency, bandwidth=1.0,
1092
:param bandwith: simulated bandwith (MegaBit)
1093
:param really_sleep: If set to false, the SocketDelay will just
1094
increase a counter, instead of calling time.sleep. This is useful for
1095
unittesting the SocketDelay.
1098
self.latency = latency
1099
self.really_sleep = really_sleep
1100
self.time_per_byte = 1 / (bandwidth / 8.0 * 1024 * 1024)
1101
self.new_roundtrip = False
1104
if self.really_sleep:
1107
SocketDelay.simulated_time += s
1109
def __getattr__(self, attr):
1110
if attr in SocketDelay._proxied_arguments:
1111
return getattr(self.sock, attr)
1112
raise AttributeError("'SocketDelay' object has no attribute %r" %
1116
return SocketDelay(self.sock.dup(), self.latency, self.time_per_byte,
1119
def recv(self, *args):
1120
data = self.sock.recv(*args)
1121
if data and self.new_roundtrip:
1122
self.new_roundtrip = False
1123
self.sleep(self.latency)
1124
self.sleep(len(data) * self.time_per_byte)
1127
def sendall(self, data, flags=0):
1128
if not self.new_roundtrip:
1129
self.new_roundtrip = True
1130
self.sleep(self.latency)
1131
self.sleep(len(data) * self.time_per_byte)
1132
return self.sock.sendall(data, flags)
1134
def send(self, data, flags=0):
1135
if not self.new_roundtrip:
1136
self.new_roundtrip = True
1137
self.sleep(self.latency)
1138
bytes_sent = self.sock.send(data, flags)
1139
self.sleep(bytes_sent * self.time_per_byte)
1143
class SFTPServer(Server):
1144
"""Common code for SFTP server facilities."""
1147
self._original_vendor = None
1148
self._homedir = None
1149
self._server_homedir = None
1150
self._listener = None
1152
self._vendor = 'none'
1155
self.add_latency = 0
1157
def _get_sftp_url(self, path):
1158
"""Calculate an sftp url to this server for path."""
1159
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
1161
def log(self, message):
1162
"""StubServer uses this to log when a new server is created."""
1163
self.logs.append(message)
1165
def _run_server_entry(self, sock):
1166
"""Entry point for all implementations of _run_server.
1168
If self.add_latency is > 0.000001 then sock is given a latency adding
1171
if self.add_latency > 0.000001:
1172
sock = SocketDelay(sock, self.add_latency)
1173
return self._run_server(sock)
1175
def _run_server(self, s):
1176
ssh_server = paramiko.Transport(s)
1177
key_file = pathjoin(self._homedir, 'test_rsa.key')
1178
f = open(key_file, 'w')
1179
f.write(STUB_SERVER_KEY)
1181
host_key = paramiko.RSAKey.from_private_key_file(key_file)
1182
ssh_server.add_server_key(host_key)
1183
server = StubServer(self)
1184
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
1185
StubSFTPServer, root=self._root,
1186
home=self._server_homedir)
1187
event = threading.Event()
1188
ssh_server.start_server(event, server)
1193
self._original_vendor = _ssh_vendor
1194
_ssh_vendor = self._vendor
1195
if sys.platform == 'win32':
1196
# Win32 needs to use the UNICODE api
1197
self._homedir = getcwd()
1199
# But Linux SFTP servers should just deal in bytestreams
1200
self._homedir = os.getcwd()
1201
if self._server_homedir is None:
1202
self._server_homedir = self._homedir
1204
if sys.platform == 'win32':
1206
self._listener = SocketListener(self._run_server_entry)
1207
self._listener.setDaemon(True)
1208
self._listener.start()
1211
"""See bzrlib.transport.Server.tearDown."""
1213
self._listener.stop()
1214
_ssh_vendor = self._original_vendor
1216
def get_bogus_url(self):
1217
"""See bzrlib.transport.Server.get_bogus_url."""
1218
# this is chosen to try to prevent trouble with proxies, wierd dns, etc
1219
# we bind a random socket, so that we get a guaranteed unused port
1220
# we just never listen on that port
1222
s.bind(('localhost', 0))
1223
return 'sftp://%s:%s/' % s.getsockname()
1226
class SFTPFullAbsoluteServer(SFTPServer):
1227
"""A test server for sftp transports, using absolute urls and ssh."""
1230
"""See bzrlib.transport.Server.get_url."""
1231
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1234
class SFTPServerWithoutSSH(SFTPServer):
1235
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1238
super(SFTPServerWithoutSSH, self).__init__()
1239
self._vendor = 'loopback'
1241
def _run_server(self, sock):
1242
class FakeChannel(object):
1243
def get_transport(self):
1245
def get_log_channel(self):
1249
def get_hexdump(self):
1254
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1255
root=self._root, home=self._server_homedir)
1257
server.start_subsystem('sftp', None, sock)
1258
except socket.error, e:
1259
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1260
# it's okay for the client to disconnect abruptly
1261
# (bug in paramiko 1.6: it should absorb this exception)
1265
except Exception, e:
1266
import sys; sys.stderr.write('\nEXCEPTION %r\n\n' % e.__class__)
1267
server.finish_subsystem()
1270
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1271
"""A test server for sftp transports, using absolute urls."""
1274
"""See bzrlib.transport.Server.get_url."""
1275
if sys.platform == 'win32':
1276
return self._get_sftp_url(urlutils.escape(self._homedir))
1278
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1281
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1282
"""A test server for sftp transports, using homedir relative urls."""
1285
"""See bzrlib.transport.Server.get_url."""
1286
return self._get_sftp_url("~/")
1289
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1290
"""A test servere for sftp transports, using absolute urls to non-home."""
1293
self._server_homedir = '/dev/noone/runs/tests/here'
1294
super(SFTPSiblingAbsoluteServer, self).setUp()
1297
def get_test_permutations():
1298
"""Return the permutations to be used in testing."""
1299
return [(SFTPTransport, SFTPAbsoluteServer),
1300
(SFTPTransport, SFTPHomeDirServer),
1301
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
