60
83
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
61
84
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
85
SFTP_OK, CMD_HANDLE, CMD_OPEN)
63
86
from paramiko.sftp_attr import SFTPAttributes
64
87
from paramiko.sftp_file import SFTPFile
65
from paramiko.sftp_client import SFTPClient
68
register_urlparse_netloc_protocol('sftp')
72
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
73
# doesn't handle it itself.
74
# <https://launchpad.net/products/bzr/+bug/41433/+index>
76
signal.signal(signal.SIGINT, signal.SIG_IGN)
79
def os_specific_subprocess_params():
80
"""Get O/S specific subprocess parameters."""
81
if sys.platform == 'win32':
82
# setting the process group and closing fds is not supported on
86
# We close fds other than the pipes as the child process does not need
89
# We also set the child process to ignore SIGINT. Normally the signal
90
# would be sent to every process in the foreground process group, but
91
# this causes it to be seen only by bzr and not by ssh. Python will
92
# generate a KeyboardInterrupt in bzr, and we will then have a chance
93
# to release locks or do other cleanup over ssh before the connection
95
# <https://launchpad.net/products/bzr/+bug/5987>
97
# Running it in a separate process group is not good because then it
98
# can't get non-echoed input of a password or passphrase.
99
# <https://launchpad.net/products/bzr/+bug/40508>
100
return {'preexec_fn': _ignore_sigint,
105
90
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
106
91
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
107
92
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
109
# Paramiko 1.5 tries to open a socket.AF_UNIX in order to connect
110
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
111
# so we get an AttributeError exception. So we will not try to
112
# connect to an agent if we are on win32 and using Paramiko older than 1.6
113
_use_ssh_agent = (sys.platform != 'win32' or _paramiko_version >= (1, 6, 0))
117
def _get_ssh_vendor():
118
"""Find out what version of SSH is on the system."""
120
if _ssh_vendor is not None:
125
if 'BZR_SSH' in os.environ:
126
_ssh_vendor = os.environ['BZR_SSH']
127
if _ssh_vendor == 'paramiko':
132
p = subprocess.Popen(['ssh', '-V'],
133
stdin=subprocess.PIPE,
134
stdout=subprocess.PIPE,
135
stderr=subprocess.PIPE,
136
**os_specific_subprocess_params())
137
returncode = p.returncode
138
stdout, stderr = p.communicate()
142
if 'OpenSSH' in stderr:
143
mutter('ssh implementation is OpenSSH')
144
_ssh_vendor = 'openssh'
145
elif 'SSH Secure Shell' in stderr:
146
mutter('ssh implementation is SSH Corp.')
149
if _ssh_vendor != 'none':
152
# XXX: 20051123 jamesh
153
# A check for putty's plink or lsh would go here.
155
mutter('falling back to paramiko implementation')
159
class SFTPSubprocess:
160
"""A socket-like object that talks to an ssh subprocess via pipes."""
161
def __init__(self, hostname, vendor, port=None, user=None):
162
assert vendor in ['openssh', 'ssh']
163
if vendor == 'openssh':
165
'-oForwardX11=no', '-oForwardAgent=no',
166
'-oClearAllForwardings=yes', '-oProtocol=2',
167
'-oNoHostAuthenticationForLocalhost=yes']
169
args.extend(['-p', str(port)])
171
args.extend(['-l', user])
172
args.extend(['-s', hostname, 'sftp'])
173
elif vendor == 'ssh':
176
args.extend(['-p', str(port)])
178
args.extend(['-l', user])
179
args.extend(['-s', 'sftp', hostname])
181
self.proc = subprocess.Popen(args,
182
stdin=subprocess.PIPE,
183
stdout=subprocess.PIPE,
184
**os_specific_subprocess_params())
186
def send(self, data):
187
return os.write(self.proc.stdin.fileno(), data)
189
def recv_ready(self):
190
# TODO: jam 20051215 this function is necessary to support the
191
# pipelined() function. In reality, it probably should use
192
# poll() or select() to actually return if there is data
193
# available, otherwise we probably don't get any benefit
196
def recv(self, count):
197
return os.read(self.proc.stdout.fileno(), count)
200
self.proc.stdin.close()
201
self.proc.stdout.close()
205
class LoopbackSFTP(object):
206
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
208
def __init__(self, sock):
211
def send(self, data):
212
return self.__socket.send(data)
215
return self.__socket.recv(n)
217
def recv_ready(self):
221
self.__socket.close()
227
# This is a weakref dictionary, so that we can reuse connections
228
# that are still active. Long term, it might be nice to have some
229
# sort of expiration policy, such as disconnect if inactive for
230
# X seconds. But that requires a lot more fanciness.
231
_connected_hosts = weakref.WeakValueDictionary()
233
def clear_connection_cache():
234
"""Remove all hosts from the SFTP connection cache.
236
Primarily useful for test cases wanting to force garbage collection.
238
_connected_hosts.clear()
241
def load_host_keys():
243
Load system host keys (probably doesn't work on windows) and any
244
"discovered" keys from previous sessions.
246
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
248
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
250
mutter('failed to load system host keys: ' + str(e))
251
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
253
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
255
mutter('failed to load bzr host keys: ' + str(e))
259
def save_host_keys():
261
Save "discovered" host keys in $(config)/ssh_host_keys/.
263
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
264
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
265
ensure_config_dir_exists()
268
f = open(bzr_hostkey_path, 'w')
269
f.write('# SSH host keys collected by bzr\n')
270
for hostname, keys in BZR_HOSTKEYS.iteritems():
271
for keytype, key in keys.iteritems():
272
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
275
mutter('failed to save bzr host keys: ' + str(e))
278
95
class SFTPLock(object):
279
"""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.
280
103
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
281
105
def __init__(self, path, transport):
282
assert isinstance(transport, SFTPTransport)
284
106
self.lock_file = None
286
108
self.lock_path = path + '.write-lock'
313
class SFTPTransport (Transport):
315
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."""
317
326
_do_prefetch = _default_do_prefetch
319
def __init__(self, base, clone_from=None):
320
assert base.startswith('sftp://')
321
self._parse_url(base)
322
base = self._unparse_url()
325
super(SFTPTransport, self).__init__(base)
326
if clone_from is None:
329
# use the same ssh connection, etc
330
self._sftp = clone_from._sftp
331
# super saves 'self.base'
333
def should_cache(self):
335
Return True if the data pulled across should be cached locally.
339
def clone(self, offset=None):
341
Return a new SFTPTransport with root at self.base + offset.
342
We share the same SFTP session between such transports, because it's
343
fairly expensive to set them up.
346
return SFTPTransport(self.base, self)
348
return SFTPTransport(self.abspath(offset), self)
350
def abspath(self, relpath):
352
Return the full url to the given relative path.
354
@param relpath: the relative path or path components
355
@type relpath: str or list
357
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)
359
348
def _remote_path(self, relpath):
360
349
"""Return the path to be passed along the sftp protocol for relpath.
362
relpath is a urlencoded string.
364
# FIXME: share the common code across transports
365
assert isinstance(relpath, basestring)
366
relpath = urlutils.unescape(relpath).split('/')
367
basepath = self._path.split('/')
368
if len(basepath) > 0 and basepath[-1] == '':
369
basepath = basepath[:-1]
373
if len(basepath) == 0:
374
# In most filesystems, a request for the parent
375
# of root, just returns root.
383
path = '/'.join(basepath)
384
# mutter('relpath => remotepath %s => %s', relpath, path)
387
def relpath(self, abspath):
388
username, password, host, port, path = self._split_url(abspath)
390
if (username != self._username):
391
error.append('username mismatch')
392
if (host != self._host):
393
error.append('host mismatch')
394
if (port != self._port):
395
error.append('port mismatch')
396
if (not path.startswith(self._path)):
397
error.append('path mismatch')
399
extra = ': ' + ', '.join(error)
400
raise PathNotChild(abspath, self.base, extra=extra)
402
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)
392
def disconnect(self):
393
connection = self._get_connection()
394
if connection is not None:
398
"""Ensures that a connection is established"""
399
connection = self._get_connection()
400
if connection is None:
401
# First connection ever
402
connection, credentials = self._create_connection()
403
self._set_connection(connection, credentials)
404
406
def has(self, relpath):
406
408
Does the target location exist?
409
self._sftp.stat(self._remote_path(relpath))
411
self._get_sftp().stat(self._remote_path(relpath))
412
# stat result is about 20 bytes, let's say
413
self._report_activity(20, 'read')
414
418
def get(self, relpath):
416
Get the file at the given relative path.
419
"""Get the file at the given relative path.
418
421
:param relpath: The relative path to the file
424
# FIXME: by returning the file directly, we don't pass this
425
# through to report_activity. We could try wrapping the object
426
# before it's returned. For readv and get_bytes it's handled in
427
# the higher-level function.
421
429
path = self._remote_path(relpath)
422
f = self._sftp.file(path, mode='rb')
430
f = self._get_sftp().file(path, mode='rb')
423
431
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
426
434
except (IOError, paramiko.SSHException), e:
435
self._translate_io_exception(e, path, ': error retrieving',
436
failure_exc=errors.ReadError)
438
def get_bytes(self, relpath):
439
# reimplement this here so that we can report how many bytes came back
440
f = self.get(relpath)
443
self._report_activity(len(bytes), 'read')
448
def _readv(self, relpath, offsets):
449
"""See Transport.readv()"""
450
# We overload the default readv() because we want to use a file
451
# that does not have prefetch enabled.
452
# Also, if we have a new paramiko, it implements an async readv()
457
path = self._remote_path(relpath)
458
fp = self._get_sftp().file(path, mode='rb')
459
readv = getattr(fp, 'readv', None)
461
return self._sftp_readv(fp, offsets, relpath)
462
if 'sftp' in debug.debug_flags:
463
mutter('seek and read %s offsets', len(offsets))
464
return self._seek_and_read(fp, offsets, relpath)
465
except (IOError, paramiko.SSHException), e:
427
466
self._translate_io_exception(e, path, ': error retrieving')
429
def get_partial(self, relpath, start, length=None):
431
Get just part of a file.
433
:param relpath: Path to the file, relative to base
434
:param start: The starting position to read from
435
:param length: The length to read. A length of None indicates
436
read to the end of the file.
437
:return: A file-like object containing at least the specified bytes.
438
Some implementations may return objects which can be read
439
past this length, but this is not guaranteed.
441
# TODO: implement get_partial_multi to help with knit support
442
f = self.get(relpath)
444
if self._do_prefetch and hasattr(f, 'prefetch'):
448
def put(self, relpath, f, mode=None):
450
Copy the file-like or string object into the location.
468
def recommended_page_size(self):
469
"""See Transport.recommended_page_size().
471
For SFTP we suggest a large page size to reduce the overhead
472
introduced by latency.
476
def _sftp_readv(self, fp, offsets, relpath):
477
"""Use the readv() member of fp to do async readv.
479
Then read them using paramiko.readv(). paramiko.readv()
480
does not support ranges > 64K, so it caps the request size, and
481
just reads until it gets all the stuff it wants.
483
helper = _SFTPReadvHelper(offsets, relpath, self._report_activity)
484
return helper.request_and_yield_offsets(fp)
486
def put_file(self, relpath, f, mode=None):
488
Copy the file-like object into the location.
452
490
:param relpath: Location to put the contents, relative to base.
453
:param f: File-like or string object.
491
:param f: File-like object.
454
492
:param mode: The final mode for the file
456
494
final_path = self._remote_path(relpath)
457
self._put(final_path, f, mode=mode)
495
return self._put(final_path, f, mode=mode)
459
497
def _put(self, abspath, f, mode=None):
460
498
"""Helper function so both put() and copy_abspaths can reuse the code"""
636
def _mkdir(self, abspath, mode=None):
642
self._report_activity(len(abspath), 'write')
643
self._get_sftp().mkdir(abspath, local_mode)
644
self._report_activity(1, 'read')
646
# chmod a dir through sftp will erase any sgid bit set
647
# on the server side. So, if the bit mode are already
648
# set, avoid the chmod. If the mode is not fine but
649
# the sgid bit is set, report a warning to the user
650
# with the umask fix.
651
stat = self._get_sftp().lstat(abspath)
652
mode = mode & 0777 # can't set special bits anyway
653
if mode != stat.st_mode & 0777:
654
if stat.st_mode & 06000:
655
warning('About to chmod %s over sftp, which will result'
656
' in its suid or sgid bits being cleared. If'
657
' you want to preserve those bits, change your '
658
' environment on the server to use umask 0%03o.'
659
% (abspath, 0777 - mode))
660
self._get_sftp().chmod(abspath, mode=mode)
661
except (paramiko.SSHException, IOError), e:
662
self._translate_io_exception(e, abspath, ': unable to mkdir',
663
failure_exc=FileExists)
506
665
def mkdir(self, relpath, mode=None):
507
666
"""Create a directory at the given path."""
508
path = self._remote_path(relpath)
667
self._mkdir(self._remote_path(relpath), mode=mode)
669
def open_write_stream(self, relpath, mode=None):
670
"""See Transport.open_write_stream."""
671
# initialise the file to zero-length
672
# this is three round trips, but we don't use this
673
# api more than once per write_group at the moment so
674
# it is a tolerable overhead. Better would be to truncate
675
# the file after opening. RBC 20070805
676
self.put_bytes_non_atomic(relpath, "", mode)
677
abspath = self._remote_path(relpath)
678
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
679
# set the file mode at create time. If it does, use it.
680
# But for now, we just chmod later anyway.
510
# In the paramiko documentation, it says that passing a mode flag
511
# will filtered against the server umask.
512
# StubSFTPServer does not do this, which would be nice, because it is
513
# what we really want :)
514
# However, real servers do use umask, so we really should do it that way
515
self._sftp.mkdir(path)
517
self._sftp.chmod(path, mode=mode)
683
handle = self._get_sftp().file(abspath, mode='wb')
684
handle.set_pipelined(True)
518
685
except (paramiko.SSHException, IOError), e:
519
self._translate_io_exception(e, path, ': unable to mkdir',
520
failure_exc=FileExists)
686
self._translate_io_exception(e, abspath,
688
_file_streams[self.abspath(relpath)] = handle
689
return FileFileStream(self, relpath, handle)
522
def _translate_io_exception(self, e, path, more_info='',
691
def _translate_io_exception(self, e, path, more_info='',
523
692
failure_exc=PathError):
524
693
"""Translate a paramiko or IOError into a friendlier exception.
657
869
# that we have taken the lock.
658
870
return SFTPLock(relpath, self)
660
def _unparse_url(self, path=None):
663
path = urllib.quote(path)
664
# handle homedir paths
665
if not path.startswith('/'):
667
netloc = urllib.quote(self._host)
668
if self._username is not None:
669
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
670
if self._port is not None:
671
netloc = '%s:%d' % (netloc, self._port)
672
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
674
def _split_url(self, url):
675
(scheme, username, password, host, port, path) = split_url(url)
676
assert scheme == 'sftp'
678
# the initial slash should be removed from the path, and treated
679
# as a homedir relative path (the path begins with a double slash
680
# if it is absolute).
681
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
682
# RBC 20060118 we are not using this as its too user hostile. instead
683
# we are following lftp and using /~/foo to mean '~/foo'.
684
# handle homedir paths
685
if path.startswith('/~/'):
689
return (username, password, host, port, path)
691
def _parse_url(self, url):
692
(self._username, self._password,
693
self._host, self._port, self._path) = self._split_url(url)
695
def _sftp_connect(self):
696
"""Connect to the remote sftp server.
697
After this, self._sftp should have a valid connection (or
698
we raise an TransportError 'could not connect').
700
TODO: Raise a more reasonable ConnectionFailed exception
702
global _connected_hosts
704
idx = (self._host, self._port, self._username)
706
self._sftp = _connected_hosts[idx]
711
vendor = _get_ssh_vendor()
712
if vendor == 'loopback':
713
sock = socket.socket()
715
sock.connect((self._host, self._port))
716
except socket.error, e:
717
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
718
% (self._host, self._port, e))
719
self._sftp = SFTPClient(LoopbackSFTP(sock))
720
elif vendor != 'none':
721
sock = SFTPSubprocess(self._host, vendor, self._port,
723
self._sftp = SFTPClient(sock)
725
self._paramiko_connect()
727
_connected_hosts[idx] = self._sftp
729
def _paramiko_connect(self):
730
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
735
t = paramiko.Transport((self._host, self._port or 22))
736
t.set_log_channel('bzr.paramiko')
738
except paramiko.SSHException, e:
739
raise ConnectionError('Unable to reach SSH host %s:%s: %s'
740
% (self._host, self._port, e))
742
server_key = t.get_remote_server_key()
743
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
744
keytype = server_key.get_name()
745
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
746
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
747
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
748
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
749
our_server_key = BZR_HOSTKEYS[self._host][keytype]
750
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
752
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
753
if not BZR_HOSTKEYS.has_key(self._host):
754
BZR_HOSTKEYS[self._host] = {}
755
BZR_HOSTKEYS[self._host][keytype] = server_key
756
our_server_key = server_key
757
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
759
if server_key != our_server_key:
760
filename1 = os.path.expanduser('~/.ssh/known_hosts')
761
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
762
raise TransportError('Host keys for %s do not match! %s != %s' % \
763
(self._host, our_server_key_hex, server_key_hex),
764
['Try editing %s or %s' % (filename1, filename2)])
769
self._sftp = t.open_sftp_client()
770
except paramiko.SSHException, e:
771
raise ConnectionError('Unable to start sftp client %s:%d' %
772
(self._host, self._port), e)
774
def _sftp_auth(self, transport):
775
# paramiko requires a username, but it might be none if nothing was supplied
776
# use the local username, just in case.
777
# We don't override self._username, because if we aren't using paramiko,
778
# the username might be specified in ~/.ssh/config and we don't want to
779
# force it to something else
780
# Also, it would mess up the self.relpath() functionality
781
username = self._username or getpass.getuser()
784
agent = paramiko.Agent()
785
for key in agent.get_keys():
786
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
788
transport.auth_publickey(username, key)
790
except paramiko.SSHException, e:
793
# okay, try finding id_rsa or id_dss? (posix only)
794
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
796
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
801
transport.auth_password(username, self._password)
803
except paramiko.SSHException, e:
806
# FIXME: Don't keep a password held in memory if you can help it
807
#self._password = None
809
# give up and ask for a password
810
password = bzrlib.ui.ui_factory.get_password(
811
prompt='SSH %(user)s@%(host)s password',
812
user=username, host=self._host)
814
transport.auth_password(username, password)
815
except paramiko.SSHException, e:
816
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
817
(username, self._host), e)
819
def _try_pkey_auth(self, transport, pkey_class, username, filename):
820
filename = os.path.expanduser('~/.ssh/' + filename)
822
key = pkey_class.from_private_key_file(filename)
823
transport.auth_publickey(username, key)
825
except paramiko.PasswordRequiredException:
826
password = bzrlib.ui.ui_factory.get_password(
827
prompt='SSH %(filename)s password',
830
key = pkey_class.from_private_key_file(filename, password)
831
transport.auth_publickey(username, key)
833
except paramiko.SSHException:
834
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
835
except paramiko.SSHException:
836
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
841
872
def _sftp_open_exclusive(self, abspath, mode=None):
842
873
"""Open a remote path exclusively.
852
883
:param abspath: The remote absolute path where the file should be opened
853
884
:param mode: The mode permissions bits for the new file
855
path = self._sftp._adjust_cwd(abspath)
886
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
887
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
888
# However, there is no way to set the permission mode at open
889
# time using the sftp_client.file() functionality.
890
path = self._get_sftp()._adjust_cwd(abspath)
856
891
# mutter('sftp abspath %s => %s', abspath, path)
857
892
attr = SFTPAttributes()
858
893
if mode is not None:
859
894
attr.st_mode = mode
860
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
895
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
861
896
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
863
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
898
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
864
899
if t != CMD_HANDLE:
865
900
raise TransportError('Expected an SFTP handle')
866
901
handle = msg.get_string()
867
return SFTPFile(self._sftp, handle, 'wb', -1)
902
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
868
903
except (paramiko.SSHException, IOError), e:
869
904
self._translate_io_exception(e, abspath, ': unable to open',
870
905
failure_exc=FileExists)
873
# ------------- server test implementation --------------
877
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
879
STUB_SERVER_KEY = """
880
-----BEGIN RSA PRIVATE KEY-----
881
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
882
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
883
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
884
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
885
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
886
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
887
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
888
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
889
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
890
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
891
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
892
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
893
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
894
-----END RSA PRIVATE KEY-----
898
class SocketListener(threading.Thread):
900
def __init__(self, callback):
901
threading.Thread.__init__(self)
902
self._callback = callback
903
self._socket = socket.socket()
904
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
905
self._socket.bind(('localhost', 0))
906
self._socket.listen(1)
907
self.port = self._socket.getsockname()[1]
908
self._stop_event = threading.Event()
911
# called from outside this thread
912
self._stop_event.set()
913
# use a timeout here, because if the test fails, the server thread may
914
# never notice the stop_event.
920
readable, writable_unused, exception_unused = \
921
select.select([self._socket], [], [], 0.1)
922
if self._stop_event.isSet():
924
if len(readable) == 0:
927
s, addr_unused = self._socket.accept()
928
# because the loopback socket is inline, and transports are
929
# never explicitly closed, best to launch a new thread.
930
threading.Thread(target=self._callback, args=(s,)).start()
931
except socket.error, x:
932
sys.excepthook(*sys.exc_info())
933
warning('Socket error during accept() within unit test server'
936
# probably a failed test; unit test thread will log the
938
sys.excepthook(*sys.exc_info())
939
warning('Exception from within unit test server thread: %r' %
943
class SFTPServer(Server):
944
"""Common code for SFTP server facilities."""
947
self._original_vendor = None
949
self._server_homedir = None
950
self._listener = None
952
self._vendor = 'none'
956
def _get_sftp_url(self, path):
957
"""Calculate an sftp url to this server for path."""
958
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
960
def log(self, message):
961
"""StubServer uses this to log when a new server is created."""
962
self.logs.append(message)
964
def _run_server(self, s):
965
ssh_server = paramiko.Transport(s)
966
key_file = pathjoin(self._homedir, 'test_rsa.key')
967
f = open(key_file, 'w')
968
f.write(STUB_SERVER_KEY)
970
host_key = paramiko.RSAKey.from_private_key_file(key_file)
971
ssh_server.add_server_key(host_key)
972
server = StubServer(self)
973
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
974
StubSFTPServer, root=self._root,
975
home=self._server_homedir)
976
event = threading.Event()
977
ssh_server.start_server(event, server)
982
self._original_vendor = _ssh_vendor
983
_ssh_vendor = self._vendor
984
if sys.platform == 'win32':
985
# Win32 needs to use the UNICODE api
986
self._homedir = getcwd()
988
# But Linux SFTP servers should just deal in bytestreams
989
self._homedir = os.getcwd()
990
if self._server_homedir is None:
991
self._server_homedir = self._homedir
993
if sys.platform == 'win32':
995
self._listener = SocketListener(self._run_server)
996
self._listener.setDaemon(True)
997
self._listener.start()
1000
"""See bzrlib.transport.Server.tearDown."""
1002
self._listener.stop()
1003
_ssh_vendor = self._original_vendor
1005
def get_bogus_url(self):
1006
"""See bzrlib.transport.Server.get_bogus_url."""
1007
# this is chosen to try to prevent trouble with proxies, wierd dns,
1009
return 'sftp://127.0.0.1:1/'
1013
class SFTPFullAbsoluteServer(SFTPServer):
1014
"""A test server for sftp transports, using absolute urls and ssh."""
1017
"""See bzrlib.transport.Server.get_url."""
1018
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1021
class SFTPServerWithoutSSH(SFTPServer):
1022
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1025
super(SFTPServerWithoutSSH, self).__init__()
1026
self._vendor = 'loopback'
1028
def _run_server(self, sock):
1029
class FakeChannel(object):
1030
def get_transport(self):
1032
def get_log_channel(self):
1036
def get_hexdump(self):
1041
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1042
root=self._root, home=self._server_homedir)
1044
server.start_subsystem('sftp', None, sock)
1045
except socket.error, e:
1046
if (len(e.args) > 0) and (e.args[0] == errno.EPIPE):
1047
# it's okay for the client to disconnect abruptly
1048
# (bug in paramiko 1.6: it should absorb this exception)
1052
except Exception, e:
1053
import sys; sys.stderr.write('\nEXCEPTION %r\n\n' % e.__class__)
1054
server.finish_subsystem()
1057
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1058
"""A test server for sftp transports, using absolute urls."""
1061
"""See bzrlib.transport.Server.get_url."""
1062
if sys.platform == 'win32':
1063
return self._get_sftp_url(urlutils.escape(self._homedir))
1065
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1068
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1069
"""A test server for sftp transports, using homedir relative urls."""
1072
"""See bzrlib.transport.Server.get_url."""
1073
return self._get_sftp_url("~/")
1076
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1077
"""A test servere for sftp transports, using absolute urls to non-home."""
1080
self._server_homedir = '/dev/noone/runs/tests/here'
1081
super(SFTPSiblingAbsoluteServer, self).setUp()
907
def _can_roundtrip_unix_modebits(self):
908
if sys.platform == 'win32':
1084
915
def get_test_permutations():
1085
916
"""Return the permutations to be used in testing."""
1086
return [(SFTPTransport, SFTPAbsoluteServer),
1087
(SFTPTransport, SFTPHomeDirServer),
1088
(SFTPTransport, SFTPSiblingAbsoluteServer),
917
from bzrlib.tests import stub_sftp
918
return [(SFTPTransport, stub_sftp.SFTPAbsoluteServer),
919
(SFTPTransport, stub_sftp.SFTPHomeDirServer),
920
(SFTPTransport, stub_sftp.SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
