59
85
CMD_HANDLE, CMD_OPEN)
60
86
from paramiko.sftp_attr import SFTPAttributes
61
87
from paramiko.sftp_file import SFTPFile
62
from paramiko.sftp_client import SFTPClient
65
register_urlparse_netloc_protocol('sftp')
69
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
70
# doesn't handle it itself.
71
# <https://launchpad.net/products/bzr/+bug/41433/+index>
73
signal.signal(signal.SIGINT, signal.SIG_IGN)
76
def os_specific_subprocess_params():
77
"""Get O/S specific subprocess parameters."""
78
if sys.platform == 'win32':
79
# setting the process group and closing fds is not supported on
83
# We close fds other than the pipes as the child process does not need
86
# We also set the child process to ignore SIGINT. Normally the signal
87
# would be sent to every process in the foreground process group, but
88
# this causes it to be seen only by bzr and not by ssh. Python will
89
# generate a KeyboardInterrupt in bzr, and we will then have a chance
90
# to release locks or do other cleanup over ssh before the connection
92
# <https://launchpad.net/products/bzr/+bug/5987>
94
# Running it in a separate process group is not good because then it
95
# can't get non-echoed input of a password or passphrase.
96
# <https://launchpad.net/products/bzr/+bug/40508>
97
return {'preexec_fn': _ignore_sigint,
102
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
103
_default_do_prefetch = False
104
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 5):
105
_default_do_prefetch = True
109
def _get_ssh_vendor():
110
"""Find out what version of SSH is on the system."""
112
if _ssh_vendor is not None:
117
if 'BZR_SSH' in os.environ:
118
_ssh_vendor = os.environ['BZR_SSH']
119
if _ssh_vendor == 'paramiko':
124
p = subprocess.Popen(['ssh', '-V'],
125
stdin=subprocess.PIPE,
126
stdout=subprocess.PIPE,
127
stderr=subprocess.PIPE,
128
**os_specific_subprocess_params())
129
returncode = p.returncode
130
stdout, stderr = p.communicate()
134
if 'OpenSSH' in stderr:
135
mutter('ssh implementation is OpenSSH')
136
_ssh_vendor = 'openssh'
137
elif 'SSH Secure Shell' in stderr:
138
mutter('ssh implementation is SSH Corp.')
141
if _ssh_vendor != 'none':
144
# XXX: 20051123 jamesh
145
# A check for putty's plink or lsh would go here.
147
mutter('falling back to paramiko implementation')
151
class SFTPSubprocess:
152
"""A socket-like object that talks to an ssh subprocess via pipes."""
153
def __init__(self, hostname, vendor, port=None, user=None):
154
assert vendor in ['openssh', 'ssh']
155
if vendor == 'openssh':
157
'-oForwardX11=no', '-oForwardAgent=no',
158
'-oClearAllForwardings=yes', '-oProtocol=2',
159
'-oNoHostAuthenticationForLocalhost=yes']
161
args.extend(['-p', str(port)])
163
args.extend(['-l', user])
164
args.extend(['-s', hostname, 'sftp'])
165
elif vendor == 'ssh':
168
args.extend(['-p', str(port)])
170
args.extend(['-l', user])
171
args.extend(['-s', 'sftp', hostname])
173
self.proc = subprocess.Popen(args,
174
stdin=subprocess.PIPE,
175
stdout=subprocess.PIPE,
176
**os_specific_subprocess_params())
178
def send(self, data):
179
return os.write(self.proc.stdin.fileno(), data)
181
def recv_ready(self):
182
# TODO: jam 20051215 this function is necessary to support the
183
# pipelined() function. In reality, it probably should use
184
# poll() or select() to actually return if there is data
185
# available, otherwise we probably don't get any benefit
188
def recv(self, count):
189
return os.read(self.proc.stdout.fileno(), count)
192
self.proc.stdin.close()
193
self.proc.stdout.close()
197
class LoopbackSFTP(object):
198
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
200
def __init__(self, sock):
203
def send(self, data):
204
return self.__socket.send(data)
207
return self.__socket.recv(n)
209
def recv_ready(self):
213
self.__socket.close()
219
# This is a weakref dictionary, so that we can reuse connections
220
# that are still active. Long term, it might be nice to have some
221
# sort of expiration policy, such as disconnect if inactive for
222
# X seconds. But that requires a lot more fanciness.
223
_connected_hosts = weakref.WeakValueDictionary()
225
def clear_connection_cache():
226
"""Remove all hosts from the SFTP connection cache.
228
Primarily useful for test cases wanting to force garbage collection.
230
_connected_hosts.clear()
233
def load_host_keys():
235
Load system host keys (probably doesn't work on windows) and any
236
"discovered" keys from previous sessions.
238
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
240
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
242
mutter('failed to load system host keys: ' + str(e))
243
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
245
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
247
mutter('failed to load bzr host keys: ' + str(e))
251
def save_host_keys():
253
Save "discovered" host keys in $(config)/ssh_host_keys/.
255
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
256
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
257
ensure_config_dir_exists()
260
f = open(bzr_hostkey_path, 'w')
261
f.write('# SSH host keys collected by bzr\n')
262
for hostname, keys in BZR_HOSTKEYS.iteritems():
263
for keytype, key in keys.iteritems():
264
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
267
mutter('failed to save bzr host keys: ' + str(e))
90
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
91
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
92
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
270
95
class SFTPLock(object):
271
"""This fakes a lock in a remote location."""
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.
272
103
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
273
105
def __init__(self, path, transport):
274
assert isinstance(transport, SFTPTransport)
276
106
self.lock_file = None
278
108
self.lock_path = path + '.write-lock'
301
131
# What specific errors should we catch here?
304
class SFTPTransport (Transport):
306
Transport implementation for SFTP access.
135
class _SFTPReadvHelper(object):
136
"""A class to help with managing the state of a readv request."""
138
# See _get_requests for an explanation.
139
_max_request_size = 32768
141
def __init__(self, original_offsets, relpath, _report_activity):
142
"""Create a new readv helper.
144
:param original_offsets: The original requests given by the caller of
146
:param relpath: The name of the file (if known)
147
:param _report_activity: A Transport._report_activity bound method,
148
to be called as data arrives.
150
self.original_offsets = list(original_offsets)
151
self.relpath = relpath
152
self._report_activity = _report_activity
154
def _get_requests(self):
155
"""Break up the offsets into individual requests over sftp.
157
The SFTP spec only requires implementers to support 32kB requests. We
158
could try something larger (openssh supports 64kB), but then we have to
159
handle requests that fail.
160
So instead, we just break up our maximum chunks into 32kB chunks, and
161
asyncronously requests them.
162
Newer versions of paramiko would do the chunking for us, but we want to
163
start processing results right away, so we do it ourselves.
165
# TODO: Because we issue async requests, we don't 'fudge' any extra
166
# data. I'm not 100% sure that is the best choice.
168
# The first thing we do, is to collapse the individual requests as much
169
# as possible, so we don't issues requests <32kB
170
sorted_offsets = sorted(self.original_offsets)
171
coalesced = list(ConnectedTransport._coalesce_offsets(sorted_offsets,
172
limit=0, fudge_factor=0))
174
for c_offset in coalesced:
175
start = c_offset.start
176
size = c_offset.length
178
# Break this up into 32kB requests
180
next_size = min(size, self._max_request_size)
181
requests.append((start, next_size))
184
if 'sftp' in debug.debug_flags:
185
mutter('SFTP.readv(%s) %s offsets => %s coalesced => %s requests',
186
self.relpath, len(sorted_offsets), len(coalesced),
190
def request_and_yield_offsets(self, fp):
191
"""Request the data from the remote machine, yielding the results.
193
:param fp: A Paramiko SFTPFile object that supports readv.
194
:return: Yield the data requested by the original readv caller, one by
197
requests = self._get_requests()
198
offset_iter = iter(self.original_offsets)
199
cur_offset, cur_size = offset_iter.next()
200
# paramiko .readv() yields strings that are in the order of the requests
201
# So we track the current request to know where the next data is
202
# being returned from.
208
# This is used to buffer chunks which we couldn't process yet
209
# It is (start, end, data) tuples.
211
# Create an 'unlimited' data stream, so we stop based on requests,
212
# rather than just because the data stream ended. This lets us detect
214
data_stream = itertools.chain(fp.readv(requests),
215
itertools.repeat(None))
216
for (start, length), data in itertools.izip(requests, data_stream):
218
if cur_coalesced is not None:
219
raise errors.ShortReadvError(self.relpath,
220
start, length, len(data))
221
if len(data) != length:
222
raise errors.ShortReadvError(self.relpath,
223
start, length, len(data))
224
self._report_activity(length, 'read')
226
# This is the first request, just buffer it
227
buffered_data = [data]
228
buffered_len = length
230
elif start == last_end:
231
# The data we are reading fits neatly on the previous
232
# buffer, so this is all part of a larger coalesced range.
233
buffered_data.append(data)
234
buffered_len += length
236
# We have an 'interrupt' in the data stream. So we know we are
237
# at a request boundary.
239
# We haven't consumed the buffer so far, so put it into
240
# data_chunks, and continue.
241
buffered = ''.join(buffered_data)
242
data_chunks.append((input_start, buffered))
244
buffered_data = [data]
245
buffered_len = length
246
last_end = start + length
247
if input_start == cur_offset and cur_size <= buffered_len:
248
# Simplify the next steps a bit by transforming buffered_data
249
# into a single string. We also have the nice property that
250
# when there is only one string ''.join([x]) == x, so there is
252
buffered = ''.join(buffered_data)
253
# Clean out buffered data so that we keep memory
257
# TODO: We *could* also consider the case where cur_offset is in
258
# in the buffered range, even though it doesn't *start*
259
# the buffered range. But for packs we pretty much always
260
# read in order, so you won't get any extra data in the
262
while (input_start == cur_offset
263
and (buffered_offset + cur_size) <= buffered_len):
264
# We've buffered enough data to process this request, spit it
266
cur_data = buffered[buffered_offset:buffered_offset + cur_size]
267
# move the direct pointer into our buffered data
268
buffered_offset += cur_size
269
# Move the start-of-buffer pointer
270
input_start += cur_size
271
# Yield the requested data
272
yield cur_offset, cur_data
273
cur_offset, cur_size = offset_iter.next()
274
# at this point, we've consumed as much of buffered as we can,
275
# so break off the portion that we consumed
276
if buffered_offset == len(buffered_data):
277
# No tail to leave behind
281
buffered = buffered[buffered_offset:]
282
buffered_data = [buffered]
283
buffered_len = len(buffered)
285
buffered = ''.join(buffered_data)
287
data_chunks.append((input_start, buffered))
289
if 'sftp' in debug.debug_flags:
290
mutter('SFTP readv left with %d out-of-order bytes',
291
sum(map(lambda x: len(x[1]), data_chunks)))
292
# We've processed all the readv data, at this point, anything we
293
# couldn't process is in data_chunks. This doesn't happen often, so
294
# this code path isn't optimized
295
# We use an interesting process for data_chunks
296
# Specifically if we have "bisect_left([(start, len, entries)],
298
# If start == qstart, then we get the specific node. Otherwise we
299
# get the previous node
301
idx = bisect.bisect_left(data_chunks, (cur_offset,))
302
if idx < len(data_chunks) and data_chunks[idx][0] == cur_offset:
303
# The data starts here
304
data = data_chunks[idx][1][:cur_size]
306
# The data is in a portion of a previous page
308
sub_offset = cur_offset - data_chunks[idx][0]
309
data = data_chunks[idx][1]
310
data = data[sub_offset:sub_offset + cur_size]
312
# We are missing the page where the data should be found,
315
if len(data) != cur_size:
316
raise AssertionError('We must have miscalulated.'
317
' We expected %d bytes, but only found %d'
318
% (cur_size, len(data)))
319
yield cur_offset, data
320
cur_offset, cur_size = offset_iter.next()
323
class SFTPTransport(ConnectedTransport):
324
"""Transport implementation for SFTP access."""
308
326
_do_prefetch = _default_do_prefetch
310
def __init__(self, base, clone_from=None):
311
assert base.startswith('sftp://')
312
self._parse_url(base)
313
base = self._unparse_url()
316
super(SFTPTransport, self).__init__(base)
317
if clone_from is None:
320
# use the same ssh connection, etc
321
self._sftp = clone_from._sftp
322
# super saves 'self.base'
324
def should_cache(self):
326
Return True if the data pulled across should be cached locally.
330
def clone(self, offset=None):
332
Return a new SFTPTransport with root at self.base + offset.
333
We share the same SFTP session between such transports, because it's
334
fairly expensive to set them up.
337
return SFTPTransport(self.base, self)
339
return SFTPTransport(self.abspath(offset), self)
341
def abspath(self, relpath):
343
Return the full url to the given relative path.
345
@param relpath: the relative path or path components
346
@type relpath: str or list
348
return self._unparse_url(self._remote_path(relpath))
327
# TODO: jam 20060717 Conceivably these could be configurable, either
328
# by auto-tuning at run-time, or by a configuration (per host??)
329
# but the performance curve is pretty flat, so just going with
330
# reasonable defaults.
331
_max_readv_combine = 200
332
# Having to round trip to the server means waiting for a response,
333
# so it is better to download extra bytes.
334
# 8KiB had good performance for both local and remote network operations
335
_bytes_to_read_before_seek = 8192
337
# The sftp spec says that implementations SHOULD allow reads
338
# to be at least 32K. paramiko.readv() does an async request
339
# for the chunks. So we need to keep it within a single request
340
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
341
# up the request itself, rather than us having to worry about it
342
_max_request_size = 32768
344
def __init__(self, base, _from_transport=None):
345
super(SFTPTransport, self).__init__(base,
346
_from_transport=_from_transport)
350
348
def _remote_path(self, relpath):
351
349
"""Return the path to be passed along the sftp protocol for relpath.
353
relpath is a urlencoded string.
355
# FIXME: share the common code across transports
356
assert isinstance(relpath, basestring)
357
relpath = urllib.unquote(relpath).split('/')
358
basepath = self._path.split('/')
359
if len(basepath) > 0 and basepath[-1] == '':
360
basepath = basepath[:-1]
364
if len(basepath) == 0:
365
# In most filesystems, a request for the parent
366
# of root, just returns root.
374
path = '/'.join(basepath)
377
def relpath(self, abspath):
378
username, password, host, port, path = self._split_url(abspath)
380
if (username != self._username):
381
error.append('username mismatch')
382
if (host != self._host):
383
error.append('host mismatch')
384
if (port != self._port):
385
error.append('port mismatch')
386
if (not path.startswith(self._path)):
387
error.append('path mismatch')
389
extra = ': ' + ', '.join(error)
390
raise PathNotChild(abspath, self.base, extra=extra)
392
return path[pl:].strip('/')
351
:param relpath: is a urlencoded string.
353
relative = urlutils.unescape(relpath).encode('utf-8')
354
remote_path = self._combine_paths(self._path, relative)
355
# the initial slash should be removed from the path, and treated as a
356
# homedir relative path (the path begins with a double slash if it is
357
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
358
# RBC 20060118 we are not using this as its too user hostile. instead
359
# we are following lftp and using /~/foo to mean '~/foo'
360
# vila--20070602 and leave absolute paths begin with a single slash.
361
if remote_path.startswith('/~/'):
362
remote_path = remote_path[3:]
363
elif remote_path == '/~':
367
def _create_connection(self, credentials=None):
368
"""Create a new connection with the provided credentials.
370
:param credentials: The credentials needed to establish the connection.
372
:return: The created connection and its associated credentials.
374
The credentials are only the password as it may have been entered
375
interactively by the user and may be different from the one provided
376
in base url at transport creation time.
378
if credentials is None:
379
password = self._password
381
password = credentials
383
vendor = ssh._get_ssh_vendor()
386
auth = config.AuthenticationConfig()
387
user = auth.get_user('ssh', self._host, self._port)
388
connection = vendor.connect_sftp(self._user, password,
389
self._host, self._port)
390
return connection, (user, password)
393
"""Ensures that a connection is established"""
394
connection = self._get_connection()
395
if connection is None:
396
# First connection ever
397
connection, credentials = self._create_connection()
398
self._set_connection(connection, credentials)
394
401
def has(self, relpath):
396
403
Does the target location exist?
399
self._sftp.stat(self._remote_path(relpath))
406
self._get_sftp().stat(self._remote_path(relpath))
407
# stat result is about 20 bytes, let's say
408
self._report_activity(20, 'read')
404
413
def get(self, relpath):
406
Get the file at the given relative path.
414
"""Get the file at the given relative path.
408
416
:param relpath: The relative path to the file
419
# FIXME: by returning the file directly, we don't pass this
420
# through to report_activity. We could try wrapping the object
421
# before it's returned. For readv and get_bytes it's handled in
422
# the higher-level function.
411
424
path = self._remote_path(relpath)
412
f = self._sftp.file(path, mode='rb')
425
f = self._get_sftp().file(path, mode='rb')
413
426
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
416
429
except (IOError, paramiko.SSHException), e:
430
self._translate_io_exception(e, path, ': error retrieving',
431
failure_exc=errors.ReadError)
433
def get_bytes(self, relpath):
434
# reimplement this here so that we can report how many bytes came back
435
f = self.get(relpath)
438
self._report_activity(len(bytes), 'read')
443
def _readv(self, relpath, offsets):
444
"""See Transport.readv()"""
445
# We overload the default readv() because we want to use a file
446
# that does not have prefetch enabled.
447
# Also, if we have a new paramiko, it implements an async readv()
452
path = self._remote_path(relpath)
453
fp = self._get_sftp().file(path, mode='rb')
454
readv = getattr(fp, 'readv', None)
456
return self._sftp_readv(fp, offsets, relpath)
457
if 'sftp' in debug.debug_flags:
458
mutter('seek and read %s offsets', len(offsets))
459
return self._seek_and_read(fp, offsets, relpath)
460
except (IOError, paramiko.SSHException), e:
417
461
self._translate_io_exception(e, path, ': error retrieving')
419
def get_partial(self, relpath, start, length=None):
421
Get just part of a file.
423
:param relpath: Path to the file, relative to base
424
:param start: The starting position to read from
425
:param length: The length to read. A length of None indicates
426
read to the end of the file.
427
:return: A file-like object containing at least the specified bytes.
428
Some implementations may return objects which can be read
429
past this length, but this is not guaranteed.
431
# TODO: implement get_partial_multi to help with knit support
432
f = self.get(relpath)
434
if self._do_prefetch and hasattr(f, 'prefetch'):
438
def put(self, relpath, f, mode=None):
440
Copy the file-like or string object into the location.
463
def recommended_page_size(self):
464
"""See Transport.recommended_page_size().
466
For SFTP we suggest a large page size to reduce the overhead
467
introduced by latency.
471
def _sftp_readv(self, fp, offsets, relpath):
472
"""Use the readv() member of fp to do async readv.
474
Then read them using paramiko.readv(). paramiko.readv()
475
does not support ranges > 64K, so it caps the request size, and
476
just reads until it gets all the stuff it wants.
478
helper = _SFTPReadvHelper(offsets, relpath, self._report_activity)
479
return helper.request_and_yield_offsets(fp)
481
def put_file(self, relpath, f, mode=None):
483
Copy the file-like object into the location.
442
485
:param relpath: Location to put the contents, relative to base.
443
:param f: File-like or string object.
486
:param f: File-like object.
444
487
:param mode: The final mode for the file
446
489
final_path = self._remote_path(relpath)
447
self._put(final_path, f, mode=mode)
490
return self._put(final_path, f, mode=mode)
449
492
def _put(self, abspath, f, mode=None):
450
493
"""Helper function so both put() and copy_abspaths can reuse the code"""
631
def _mkdir(self, abspath, mode=None):
637
self._report_activity(len(abspath), 'write')
638
self._get_sftp().mkdir(abspath, local_mode)
639
self._report_activity(1, 'read')
641
# chmod a dir through sftp will erase any sgid bit set
642
# on the server side. So, if the bit mode are already
643
# set, avoid the chmod. If the mode is not fine but
644
# the sgid bit is set, report a warning to the user
645
# with the umask fix.
646
stat = self._get_sftp().lstat(abspath)
647
mode = mode & 0777 # can't set special bits anyway
648
if mode != stat.st_mode & 0777:
649
if stat.st_mode & 06000:
650
warning('About to chmod %s over sftp, which will result'
651
' in its suid or sgid bits being cleared. If'
652
' you want to preserve those bits, change your '
653
' environment on the server to use umask 0%03o.'
654
% (abspath, 0777 - mode))
655
self._get_sftp().chmod(abspath, mode=mode)
656
except (paramiko.SSHException, IOError), e:
657
self._translate_io_exception(e, abspath, ': unable to mkdir',
658
failure_exc=FileExists)
496
660
def mkdir(self, relpath, mode=None):
497
661
"""Create a directory at the given path."""
662
self._mkdir(self._remote_path(relpath), mode=mode)
664
def open_write_stream(self, relpath, mode=None):
665
"""See Transport.open_write_stream."""
666
# initialise the file to zero-length
667
# this is three round trips, but we don't use this
668
# api more than once per write_group at the moment so
669
# it is a tolerable overhead. Better would be to truncate
670
# the file after opening. RBC 20070805
671
self.put_bytes_non_atomic(relpath, "", mode)
672
abspath = self._remote_path(relpath)
673
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
674
# set the file mode at create time. If it does, use it.
675
# But for now, we just chmod later anyway.
499
path = self._remote_path(relpath)
500
# In the paramiko documentation, it says that passing a mode flag
501
# will filtered against the server umask.
502
# StubSFTPServer does not do this, which would be nice, because it is
503
# what we really want :)
504
# However, real servers do use umask, so we really should do it that way
505
self._sftp.mkdir(path)
507
self._sftp.chmod(path, mode=mode)
678
handle = self._get_sftp().file(abspath, mode='wb')
679
handle.set_pipelined(True)
508
680
except (paramiko.SSHException, IOError), e:
509
self._translate_io_exception(e, path, ': unable to mkdir',
510
failure_exc=FileExists)
681
self._translate_io_exception(e, abspath,
683
_file_streams[self.abspath(relpath)] = handle
684
return FileFileStream(self, relpath, handle)
512
def _translate_io_exception(self, e, path, more_info='',
686
def _translate_io_exception(self, e, path, more_info='',
513
687
failure_exc=PathError):
514
688
"""Translate a paramiko or IOError into a friendlier exception.
647
840
# that we have taken the lock.
648
841
return SFTPLock(relpath, self)
650
def _unparse_url(self, path=None):
653
path = urllib.quote(path)
654
# handle homedir paths
655
if not path.startswith('/'):
657
netloc = urllib.quote(self._host)
658
if self._username is not None:
659
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
660
if self._port is not None:
661
netloc = '%s:%d' % (netloc, self._port)
662
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
664
def _split_url(self, url):
665
if isinstance(url, unicode):
666
url = url.encode('utf-8')
667
(scheme, netloc, path, params,
668
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
669
assert scheme == 'sftp'
670
username = password = host = port = None
672
username, host = netloc.split('@', 1)
674
username, password = username.split(':', 1)
675
password = urllib.unquote(password)
676
username = urllib.unquote(username)
681
host, port = host.rsplit(':', 1)
685
# TODO: Should this be ConnectionError?
686
raise TransportError('%s: invalid port number' % port)
687
host = urllib.unquote(host)
689
path = urllib.unquote(path)
691
# the initial slash should be removed from the path, and treated
692
# as a homedir relative path (the path begins with a double slash
693
# if it is absolute).
694
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
695
# RBC 20060118 we are not using this as its too user hostile. instead
696
# we are following lftp and using /~/foo to mean '~/foo'.
697
# handle homedir paths
698
if path.startswith('/~/'):
702
return (username, password, host, port, path)
704
def _parse_url(self, url):
705
(self._username, self._password,
706
self._host, self._port, self._path) = self._split_url(url)
708
def _sftp_connect(self):
709
"""Connect to the remote sftp server.
710
After this, self._sftp should have a valid connection (or
711
we raise an TransportError 'could not connect').
713
TODO: Raise a more reasonable ConnectionFailed exception
715
global _connected_hosts
717
idx = (self._host, self._port, self._username)
719
self._sftp = _connected_hosts[idx]
724
vendor = _get_ssh_vendor()
725
if vendor == 'loopback':
726
sock = socket.socket()
727
sock.connect((self._host, self._port))
728
self._sftp = SFTPClient(LoopbackSFTP(sock))
729
elif vendor != 'none':
730
sock = SFTPSubprocess(self._host, vendor, self._port,
732
self._sftp = SFTPClient(sock)
734
self._paramiko_connect()
736
_connected_hosts[idx] = self._sftp
738
def _paramiko_connect(self):
739
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
744
t = paramiko.Transport((self._host, self._port or 22))
745
t.set_log_channel('bzr.paramiko')
747
except paramiko.SSHException, e:
748
raise ConnectionError('Unable to reach SSH host %s:%d' %
749
(self._host, self._port), e)
751
server_key = t.get_remote_server_key()
752
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
753
keytype = server_key.get_name()
754
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
755
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
756
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
757
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
758
our_server_key = BZR_HOSTKEYS[self._host][keytype]
759
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
761
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
762
if not BZR_HOSTKEYS.has_key(self._host):
763
BZR_HOSTKEYS[self._host] = {}
764
BZR_HOSTKEYS[self._host][keytype] = server_key
765
our_server_key = server_key
766
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
768
if server_key != our_server_key:
769
filename1 = os.path.expanduser('~/.ssh/known_hosts')
770
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
771
raise TransportError('Host keys for %s do not match! %s != %s' % \
772
(self._host, our_server_key_hex, server_key_hex),
773
['Try editing %s or %s' % (filename1, filename2)])
778
self._sftp = t.open_sftp_client()
779
except paramiko.SSHException, e:
780
raise ConnectionError('Unable to start sftp client %s:%d' %
781
(self._host, self._port), e)
783
def _sftp_auth(self, transport):
784
# paramiko requires a username, but it might be none if nothing was supplied
785
# use the local username, just in case.
786
# We don't override self._username, because if we aren't using paramiko,
787
# the username might be specified in ~/.ssh/config and we don't want to
788
# force it to something else
789
# Also, it would mess up the self.relpath() functionality
790
username = self._username or getpass.getuser()
792
# Paramiko tries to open a socket.AF_UNIX in order to connect
793
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
794
# so we get an AttributeError exception. For now, just don't try to
795
# connect to an agent if we are on win32
796
if sys.platform != 'win32':
797
agent = paramiko.Agent()
798
for key in agent.get_keys():
799
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
801
transport.auth_publickey(username, key)
803
except paramiko.SSHException, e:
806
# okay, try finding id_rsa or id_dss? (posix only)
807
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
809
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
814
transport.auth_password(username, self._password)
816
except paramiko.SSHException, e:
819
# FIXME: Don't keep a password held in memory if you can help it
820
#self._password = None
822
# give up and ask for a password
823
password = bzrlib.ui.ui_factory.get_password(
824
prompt='SSH %(user)s@%(host)s password',
825
user=username, host=self._host)
827
transport.auth_password(username, password)
828
except paramiko.SSHException, e:
829
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
830
(username, self._host), e)
832
def _try_pkey_auth(self, transport, pkey_class, username, filename):
833
filename = os.path.expanduser('~/.ssh/' + filename)
835
key = pkey_class.from_private_key_file(filename)
836
transport.auth_publickey(username, key)
838
except paramiko.PasswordRequiredException:
839
password = bzrlib.ui.ui_factory.get_password(
840
prompt='SSH %(filename)s password',
843
key = pkey_class.from_private_key_file(filename, password)
844
transport.auth_publickey(username, key)
846
except paramiko.SSHException:
847
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
848
except paramiko.SSHException:
849
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
854
843
def _sftp_open_exclusive(self, abspath, mode=None):
855
844
"""Open a remote path exclusively.
865
854
:param abspath: The remote absolute path where the file should be opened
866
855
:param mode: The mode permissions bits for the new file
868
path = self._sftp._adjust_cwd(abspath)
857
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
858
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
859
# However, there is no way to set the permission mode at open
860
# time using the sftp_client.file() functionality.
861
path = self._get_sftp()._adjust_cwd(abspath)
862
# mutter('sftp abspath %s => %s', abspath, path)
869
863
attr = SFTPAttributes()
870
864
if mode is not None:
871
865
attr.st_mode = mode
872
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
866
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
873
867
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
875
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
869
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
876
870
if t != CMD_HANDLE:
877
871
raise TransportError('Expected an SFTP handle')
878
872
handle = msg.get_string()
879
return SFTPFile(self._sftp, handle, 'wb', -1)
873
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
880
874
except (paramiko.SSHException, IOError), e:
881
875
self._translate_io_exception(e, abspath, ': unable to open',
882
876
failure_exc=FileExists)
885
# ------------- server test implementation --------------
889
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
891
STUB_SERVER_KEY = """
892
-----BEGIN RSA PRIVATE KEY-----
893
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
894
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
895
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
896
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
897
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
898
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
899
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
900
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
901
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
902
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
903
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
904
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
905
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
906
-----END RSA PRIVATE KEY-----
910
class SingleListener(threading.Thread):
912
def __init__(self, callback):
913
threading.Thread.__init__(self)
914
self._callback = callback
915
self._socket = socket.socket()
916
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
917
self._socket.bind(('localhost', 0))
918
self._socket.listen(1)
919
self.port = self._socket.getsockname()[1]
920
self.stop_event = threading.Event()
923
s, _ = self._socket.accept()
924
# now close the listen socket
927
self._callback(s, self.stop_event)
929
pass #Ignore socket errors
931
# probably a failed test
932
warning('Exception from within unit test server thread: %r' % x)
935
self.stop_event.set()
936
# use a timeout here, because if the test fails, the server thread may
937
# never notice the stop_event.
941
class SFTPServer(Server):
942
"""Common code for SFTP server facilities."""
945
self._original_vendor = None
947
self._server_homedir = None
948
self._listener = None
950
self._vendor = 'none'
954
def _get_sftp_url(self, path):
955
"""Calculate an sftp url to this server for path."""
956
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
958
def log(self, message):
959
"""StubServer uses this to log when a new server is created."""
960
self.logs.append(message)
962
def _run_server(self, s, stop_event):
963
ssh_server = paramiko.Transport(s)
964
key_file = os.path.join(self._homedir, 'test_rsa.key')
965
file(key_file, 'w').write(STUB_SERVER_KEY)
966
host_key = paramiko.RSAKey.from_private_key_file(key_file)
967
ssh_server.add_server_key(host_key)
968
server = StubServer(self)
969
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
970
StubSFTPServer, root=self._root,
971
home=self._server_homedir)
972
event = threading.Event()
973
ssh_server.start_server(event, server)
975
stop_event.wait(30.0)
979
self._original_vendor = _ssh_vendor
980
_ssh_vendor = self._vendor
981
self._homedir = os.getcwdu()
982
if self._server_homedir is None:
983
self._server_homedir = self._homedir
985
# FIXME WINDOWS: _root should be _server_homedir[0]:/
986
self._listener = SingleListener(self._run_server)
987
self._listener.setDaemon(True)
988
self._listener.start()
991
"""See bzrlib.transport.Server.tearDown."""
993
self._listener.stop()
994
_ssh_vendor = self._original_vendor
997
class SFTPFullAbsoluteServer(SFTPServer):
998
"""A test server for sftp transports, using absolute urls and ssh."""
1001
"""See bzrlib.transport.Server.get_url."""
1002
return self._get_sftp_url(urlescape(self._homedir[1:]))
1005
class SFTPServerWithoutSSH(SFTPServer):
1006
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1009
super(SFTPServerWithoutSSH, self).__init__()
1010
self._vendor = 'loopback'
1012
def _run_server(self, sock, stop_event):
1013
class FakeChannel(object):
1014
def get_transport(self):
1016
def get_log_channel(self):
1020
def get_hexdump(self):
1025
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1026
root=self._root, home=self._server_homedir)
1027
server.start_subsystem('sftp', None, sock)
1028
server.finish_subsystem()
1031
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1032
"""A test server for sftp transports, using absolute urls."""
1035
"""See bzrlib.transport.Server.get_url."""
1036
return self._get_sftp_url(urlescape(self._homedir[1:]))
1039
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1040
"""A test server for sftp transports, using homedir relative urls."""
1043
"""See bzrlib.transport.Server.get_url."""
1044
return self._get_sftp_url("~/")
1047
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1048
"""A test servere for sftp transports, using absolute urls to non-home."""
1051
self._server_homedir = '/dev/noone/runs/tests/here'
1052
super(SFTPSiblingAbsoluteServer, self).setUp()
878
def _can_roundtrip_unix_modebits(self):
879
if sys.platform == 'win32':
1055
886
def get_test_permutations():
1056
887
"""Return the permutations to be used in testing."""
1057
return [(SFTPTransport, SFTPAbsoluteServer),
1058
(SFTPTransport, SFTPHomeDirServer),
1059
(SFTPTransport, SFTPSiblingAbsoluteServer),
888
from bzrlib.tests import stub_sftp
889
return [(SFTPTransport, stub_sftp.SFTPAbsoluteServer),
890
(SFTPTransport, stub_sftp.SFTPHomeDirServer),
891
(SFTPTransport, stub_sftp.SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
