83
49
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
84
50
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
85
SFTP_OK, CMD_HANDLE, CMD_OPEN)
86
52
from paramiko.sftp_attr import SFTPAttributes
87
53
from paramiko.sftp_file import SFTPFile
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))
54
from paramiko.sftp_client import SFTPClient
56
if 'sftp' not in urlparse.uses_netloc:
57
urlparse.uses_netloc.append('sftp')
59
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
60
_default_do_prefetch = False
61
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 2):
62
_default_do_prefetch = True
66
if sys.platform == 'win32':
67
# close_fds not supported on win32
72
def _get_ssh_vendor():
73
"""Find out what version of SSH is on the system."""
75
if _ssh_vendor is not None:
80
if 'BZR_SSH' in os.environ:
81
_ssh_vendor = os.environ['BZR_SSH']
82
if _ssh_vendor == 'paramiko':
87
p = subprocess.Popen(['ssh', '-V'],
89
stdin=subprocess.PIPE,
90
stdout=subprocess.PIPE,
91
stderr=subprocess.PIPE)
92
returncode = p.returncode
93
stdout, stderr = p.communicate()
97
if 'OpenSSH' in stderr:
98
mutter('ssh implementation is OpenSSH')
99
_ssh_vendor = 'openssh'
100
elif 'SSH Secure Shell' in stderr:
101
mutter('ssh implementation is SSH Corp.')
104
if _ssh_vendor != 'none':
107
# XXX: 20051123 jamesh
108
# A check for putty's plink or lsh would go here.
110
mutter('falling back to paramiko implementation')
114
class SFTPSubprocess:
115
"""A socket-like object that talks to an ssh subprocess via pipes."""
116
def __init__(self, hostname, vendor, port=None, user=None):
117
assert vendor in ['openssh', 'ssh']
118
if vendor == 'openssh':
120
'-oForwardX11=no', '-oForwardAgent=no',
121
'-oClearAllForwardings=yes', '-oProtocol=2',
122
'-oNoHostAuthenticationForLocalhost=yes']
124
args.extend(['-p', str(port)])
126
args.extend(['-l', user])
127
args.extend(['-s', hostname, 'sftp'])
128
elif vendor == 'ssh':
131
args.extend(['-p', str(port)])
133
args.extend(['-l', user])
134
args.extend(['-s', 'sftp', hostname])
136
self.proc = subprocess.Popen(args, close_fds=_close_fds,
137
stdin=subprocess.PIPE,
138
stdout=subprocess.PIPE)
140
def send(self, data):
141
return os.write(self.proc.stdin.fileno(), data)
143
def recv_ready(self):
144
# TODO: jam 20051215 this function is necessary to support the
145
# pipelined() function. In reality, it probably should use
146
# poll() or select() to actually return if there is data
147
# available, otherwise we probably don't get any benefit
150
def recv(self, count):
151
return os.read(self.proc.stdout.fileno(), count)
154
self.proc.stdin.close()
155
self.proc.stdout.close()
159
class LoopbackSFTP(object):
160
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
162
def __init__(self, sock):
165
def send(self, data):
166
return self.__socket.send(data)
169
return self.__socket.recv(n)
171
def recv_ready(self):
175
self.__socket.close()
181
# This is a weakref dictionary, so that we can reuse connections
182
# that are still active. Long term, it might be nice to have some
183
# sort of expiration policy, such as disconnect if inactive for
184
# X seconds. But that requires a lot more fanciness.
185
_connected_hosts = weakref.WeakValueDictionary()
188
def load_host_keys():
190
Load system host keys (probably doesn't work on windows) and any
191
"discovered" keys from previous sessions.
193
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
195
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
197
mutter('failed to load system host keys: ' + str(e))
198
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
200
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
202
mutter('failed to load bzr host keys: ' + str(e))
206
def save_host_keys():
208
Save "discovered" host keys in $(config)/ssh_host_keys/.
210
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
211
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
212
ensure_config_dir_exists()
215
f = open(bzr_hostkey_path, 'w')
216
f.write('# SSH host keys collected by bzr\n')
217
for hostname, keys in BZR_HOSTKEYS.iteritems():
218
for keytype, key in keys.iteritems():
219
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
222
mutter('failed to save bzr host keys: ' + str(e))
95
225
class SFTPLock(object):
96
"""This fakes a lock in a remote location.
98
A present lock is indicated just by the existence of a file. This
99
doesn't work well on all transports and they are only used in
100
deprecated storage formats.
226
"""This fakes a lock in a remote location."""
103
227
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
105
228
def __init__(self, path, transport):
229
assert isinstance(transport, SFTPTransport)
106
231
self.lock_file = None
108
233
self.lock_path = path + '.write-lock'
131
256
# What specific errors should we catch here?
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."""
259
class SFTPTransport (Transport):
261
Transport implementation for SFTP access.
326
263
_do_prefetch = _default_do_prefetch
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)
265
def __init__(self, base, clone_from=None):
266
assert base.startswith('sftp://')
267
self._parse_url(base)
268
base = self._unparse_url()
271
super(SFTPTransport, self).__init__(base)
272
if clone_from is None:
275
# use the same ssh connection, etc
276
self._sftp = clone_from._sftp
277
# super saves 'self.base'
279
def should_cache(self):
281
Return True if the data pulled across should be cached locally.
285
def clone(self, offset=None):
287
Return a new SFTPTransport with root at self.base + offset.
288
We share the same SFTP session between such transports, because it's
289
fairly expensive to set them up.
292
return SFTPTransport(self.base, self)
294
return SFTPTransport(self.abspath(offset), self)
296
def abspath(self, relpath):
298
Return the full url to the given relative path.
300
@param relpath: the relative path or path components
301
@type relpath: str or list
303
return self._unparse_url(self._remote_path(relpath))
348
305
def _remote_path(self, relpath):
349
306
"""Return the path to be passed along the sftp protocol for relpath.
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)
308
relpath is a urlencoded string.
310
# FIXME: share the common code across transports
311
assert isinstance(relpath, basestring)
312
relpath = urllib.unquote(relpath).split('/')
313
basepath = self._path.split('/')
314
if len(basepath) > 0 and basepath[-1] == '':
315
basepath = basepath[:-1]
319
if len(basepath) == 0:
320
# In most filesystems, a request for the parent
321
# of root, just returns root.
329
path = '/'.join(basepath)
332
def relpath(self, abspath):
333
username, password, host, port, path = self._split_url(abspath)
335
if (username != self._username):
336
error.append('username mismatch')
337
if (host != self._host):
338
error.append('host mismatch')
339
if (port != self._port):
340
error.append('port mismatch')
341
if (not path.startswith(self._path)):
342
error.append('path mismatch')
344
extra = ': ' + ', '.join(error)
345
raise PathNotChild(abspath, self.base, extra=extra)
347
return path[pl:].strip('/')
401
349
def has(self, relpath):
403
351
Does the target location exist?
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')
354
self._sftp.stat(self._remote_path(relpath))
413
def get(self, relpath):
414
"""Get the file at the given relative path.
359
def get(self, relpath, decode=False):
361
Get the file at the given relative path.
416
363
: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.
424
366
path = self._remote_path(relpath)
425
f = self._get_sftp().file(path, mode='rb')
367
f = self._sftp.file(path, mode='rb')
426
368
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
429
371
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
372
self._translate_io_exception(e, path, ': error retrieving')
374
def get_partial(self, relpath, start, length=None):
376
Get just part of a file.
378
:param relpath: Path to the file, relative to base
379
:param start: The starting position to read from
380
:param length: The length to read. A length of None indicates
381
read to the end of the file.
382
:return: A file-like object containing at least the specified bytes.
383
Some implementations may return objects which can be read
384
past this length, but this is not guaranteed.
386
# TODO: implement get_partial_multi to help with knit support
435
387
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:
461
self._translate_io_exception(e, path, ': error retrieving')
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.
389
if self._do_prefetch and hasattr(f, 'prefetch'):
393
def put(self, relpath, f, mode=None):
395
Copy the file-like or string object into the location.
485
397
:param relpath: Location to put the contents, relative to base.
486
:param f: File-like object.
398
:param f: File-like or string object.
487
399
:param mode: The final mode for the file
489
401
final_path = self._remote_path(relpath)
490
return self._put(final_path, f, mode=mode)
402
self._put(final_path, f, mode=mode)
492
404
def _put(self, abspath, f, mode=None):
493
405
"""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)
660
451
def mkdir(self, relpath, mode=None):
661
452
"""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.
678
handle = self._get_sftp().file(abspath, mode='wb')
679
handle.set_pipelined(True)
454
path = self._remote_path(relpath)
455
# In the paramiko documentation, it says that passing a mode flag
456
# will filtered against the server umask.
457
# StubSFTPServer does not do this, which would be nice, because it is
458
# what we really want :)
459
# However, real servers do use umask, so we really should do it that way
460
self._sftp.mkdir(path)
462
self._sftp.chmod(path, mode=mode)
680
463
except (paramiko.SSHException, IOError), e:
681
self._translate_io_exception(e, abspath,
683
_file_streams[self.abspath(relpath)] = handle
684
return FileFileStream(self, relpath, handle)
464
self._translate_io_exception(e, path, ': unable to mkdir',
465
failure_exc=FileExists)
686
def _translate_io_exception(self, e, path, more_info='',
687
failure_exc=PathError):
467
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
688
468
"""Translate a paramiko or IOError into a friendlier exception.
690
470
:param e: The original exception
862
599
# that we have taken the lock.
863
600
return SFTPLock(relpath, self)
602
def _unparse_url(self, path=None):
605
path = urllib.quote(path)
606
# handle homedir paths
607
if not path.startswith('/'):
609
netloc = urllib.quote(self._host)
610
if self._username is not None:
611
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
612
if self._port is not None:
613
netloc = '%s:%d' % (netloc, self._port)
615
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
617
def _split_url(self, url):
618
if isinstance(url, unicode):
619
url = url.encode('utf-8')
620
(scheme, netloc, path, params,
621
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
622
assert scheme == 'sftp'
623
username = password = host = port = None
625
username, host = netloc.split('@', 1)
627
username, password = username.split(':', 1)
628
password = urllib.unquote(password)
629
username = urllib.unquote(username)
634
host, port = host.rsplit(':', 1)
638
# TODO: Should this be ConnectionError?
639
raise TransportError('%s: invalid port number' % port)
640
host = urllib.unquote(host)
642
path = urllib.unquote(path)
644
# the initial slash should be removed from the path, and treated
645
# as a homedir relative path (the path begins with a double slash
646
# if it is absolute).
647
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
648
# RBC 20060118 we are not using this as its too user hostile. instead
649
# we are following lftp and using /~/foo to mean '~/foo'.
650
# handle homedir paths
651
if path.startswith('/~/'):
655
return (username, password, host, port, path)
657
def _parse_url(self, url):
658
(self._username, self._password,
659
self._host, self._port, self._path) = self._split_url(url)
661
def _sftp_connect(self):
662
"""Connect to the remote sftp server.
663
After this, self._sftp should have a valid connection (or
664
we raise an TransportError 'could not connect').
666
TODO: Raise a more reasonable ConnectionFailed exception
668
global _connected_hosts
670
idx = (self._host, self._port, self._username)
672
self._sftp = _connected_hosts[idx]
677
vendor = _get_ssh_vendor()
678
if vendor == 'loopback':
679
sock = socket.socket()
680
sock.connect((self._host, self._port))
681
self._sftp = SFTPClient(LoopbackSFTP(sock))
682
elif vendor != 'none':
683
sock = SFTPSubprocess(self._host, vendor, self._port,
685
self._sftp = SFTPClient(sock)
687
self._paramiko_connect()
689
_connected_hosts[idx] = self._sftp
691
def _paramiko_connect(self):
692
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
697
t = paramiko.Transport((self._host, self._port or 22))
698
t.set_log_channel('bzr.paramiko')
700
except paramiko.SSHException, e:
701
raise ConnectionError('Unable to reach SSH host %s:%d' %
702
(self._host, self._port), e)
704
server_key = t.get_remote_server_key()
705
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
706
keytype = server_key.get_name()
707
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
708
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
709
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
710
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
711
our_server_key = BZR_HOSTKEYS[self._host][keytype]
712
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
714
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
715
if not BZR_HOSTKEYS.has_key(self._host):
716
BZR_HOSTKEYS[self._host] = {}
717
BZR_HOSTKEYS[self._host][keytype] = server_key
718
our_server_key = server_key
719
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
721
if server_key != our_server_key:
722
filename1 = os.path.expanduser('~/.ssh/known_hosts')
723
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
724
raise TransportError('Host keys for %s do not match! %s != %s' % \
725
(self._host, our_server_key_hex, server_key_hex),
726
['Try editing %s or %s' % (filename1, filename2)])
731
self._sftp = t.open_sftp_client()
732
except paramiko.SSHException, e:
733
raise ConnectionError('Unable to start sftp client %s:%d' %
734
(self._host, self._port), e)
736
def _sftp_auth(self, transport):
737
# paramiko requires a username, but it might be none if nothing was supplied
738
# use the local username, just in case.
739
# We don't override self._username, because if we aren't using paramiko,
740
# the username might be specified in ~/.ssh/config and we don't want to
741
# force it to something else
742
# Also, it would mess up the self.relpath() functionality
743
username = self._username or getpass.getuser()
745
# Paramiko tries to open a socket.AF_UNIX in order to connect
746
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
747
# so we get an AttributeError exception. For now, just don't try to
748
# connect to an agent if we are on win32
749
if sys.platform != 'win32':
750
agent = paramiko.Agent()
751
for key in agent.get_keys():
752
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
754
transport.auth_publickey(username, key)
756
except paramiko.SSHException, e:
759
# okay, try finding id_rsa or id_dss? (posix only)
760
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
762
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
767
transport.auth_password(username, self._password)
769
except paramiko.SSHException, e:
772
# FIXME: Don't keep a password held in memory if you can help it
773
#self._password = None
775
# give up and ask for a password
776
password = bzrlib.ui.ui_factory.get_password(
777
prompt='SSH %(user)s@%(host)s password',
778
user=username, host=self._host)
780
transport.auth_password(username, password)
781
except paramiko.SSHException, e:
782
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
783
(username, self._host), e)
785
def _try_pkey_auth(self, transport, pkey_class, username, filename):
786
filename = os.path.expanduser('~/.ssh/' + filename)
788
key = pkey_class.from_private_key_file(filename)
789
transport.auth_publickey(username, key)
791
except paramiko.PasswordRequiredException:
792
password = bzrlib.ui.ui_factory.get_password(
793
prompt='SSH %(filename)s password',
796
key = pkey_class.from_private_key_file(filename, password)
797
transport.auth_publickey(username, key)
799
except paramiko.SSHException:
800
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
801
except paramiko.SSHException:
802
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
865
807
def _sftp_open_exclusive(self, abspath, mode=None):
866
808
"""Open a remote path exclusively.
876
818
:param abspath: The remote absolute path where the file should be opened
877
819
:param mode: The mode permissions bits for the new file
879
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
880
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
881
# However, there is no way to set the permission mode at open
882
# time using the sftp_client.file() functionality.
883
path = self._get_sftp()._adjust_cwd(abspath)
884
# mutter('sftp abspath %s => %s', abspath, path)
821
path = self._sftp._adjust_cwd(abspath)
885
822
attr = SFTPAttributes()
886
823
if mode is not None:
887
824
attr.st_mode = mode
888
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
825
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
889
826
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
891
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
828
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
892
829
if t != CMD_HANDLE:
893
830
raise TransportError('Expected an SFTP handle')
894
831
handle = msg.get_string()
895
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
832
return SFTPFile(self._sftp, handle, 'wb', -1)
896
833
except (paramiko.SSHException, IOError), e:
897
834
self._translate_io_exception(e, abspath, ': unable to open',
898
835
failure_exc=FileExists)
900
def _can_roundtrip_unix_modebits(self):
901
if sys.platform == 'win32':
838
# ------------- server test implementation --------------
842
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
844
STUB_SERVER_KEY = """
845
-----BEGIN RSA PRIVATE KEY-----
846
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
847
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
848
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
849
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
850
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
851
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
852
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
853
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
854
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
855
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
856
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
857
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
858
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
859
-----END RSA PRIVATE KEY-----
863
class SingleListener(threading.Thread):
865
def __init__(self, callback):
866
threading.Thread.__init__(self)
867
self._callback = callback
868
self._socket = socket.socket()
869
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
870
self._socket.bind(('localhost', 0))
871
self._socket.listen(1)
872
self.port = self._socket.getsockname()[1]
873
self.stop_event = threading.Event()
876
s, _ = self._socket.accept()
877
# now close the listen socket
880
self._callback(s, self.stop_event)
882
pass #Ignore socket errors
884
# probably a failed test
885
warning('Exception from within unit test server thread: %r' % x)
888
self.stop_event.set()
889
# use a timeout here, because if the test fails, the server thread may
890
# never notice the stop_event.
894
class SFTPServer(Server):
895
"""Common code for SFTP server facilities."""
898
self._original_vendor = None
900
self._server_homedir = None
901
self._listener = None
903
self._vendor = 'none'
907
def _get_sftp_url(self, path):
908
"""Calculate an sftp url to this server for path."""
909
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
911
def log(self, message):
912
"""StubServer uses this to log when a new server is created."""
913
self.logs.append(message)
915
def _run_server(self, s, stop_event):
916
ssh_server = paramiko.Transport(s)
917
key_file = os.path.join(self._homedir, 'test_rsa.key')
918
file(key_file, 'w').write(STUB_SERVER_KEY)
919
host_key = paramiko.RSAKey.from_private_key_file(key_file)
920
ssh_server.add_server_key(host_key)
921
server = StubServer(self)
922
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
923
StubSFTPServer, root=self._root,
924
home=self._server_homedir)
925
event = threading.Event()
926
ssh_server.start_server(event, server)
928
stop_event.wait(30.0)
932
self._original_vendor = _ssh_vendor
933
_ssh_vendor = self._vendor
934
self._homedir = os.getcwdu()
935
if self._server_homedir is None:
936
self._server_homedir = self._homedir
938
# FIXME WINDOWS: _root should be _server_homedir[0]:/
939
self._listener = SingleListener(self._run_server)
940
self._listener.setDaemon(True)
941
self._listener.start()
944
"""See bzrlib.transport.Server.tearDown."""
946
self._listener.stop()
947
_ssh_vendor = self._original_vendor
950
class SFTPFullAbsoluteServer(SFTPServer):
951
"""A test server for sftp transports, using absolute urls and ssh."""
954
"""See bzrlib.transport.Server.get_url."""
955
return self._get_sftp_url(urlescape(self._homedir[1:]))
958
class SFTPServerWithoutSSH(SFTPServer):
959
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
962
super(SFTPServerWithoutSSH, self).__init__()
963
self._vendor = 'loopback'
965
def _run_server(self, sock, stop_event):
966
class FakeChannel(object):
967
def get_transport(self):
969
def get_log_channel(self):
973
def get_hexdump(self):
976
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
977
root=self._root, home=self._server_homedir)
978
server.start_subsystem('sftp', None, sock)
979
server.finish_subsystem()
982
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
983
"""A test server for sftp transports, using absolute urls."""
986
"""See bzrlib.transport.Server.get_url."""
987
return self._get_sftp_url(urlescape(self._homedir[1:]))
990
class SFTPHomeDirServer(SFTPServerWithoutSSH):
991
"""A test server for sftp transports, using homedir relative urls."""
994
"""See bzrlib.transport.Server.get_url."""
995
return self._get_sftp_url("~/")
998
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
999
"""A test servere for sftp transports, using absolute urls to non-home."""
1002
self._server_homedir = '/dev/noone/runs/tests/here'
1003
super(SFTPSiblingAbsoluteServer, self).setUp()
908
1006
def get_test_permutations():
909
1007
"""Return the permutations to be used in testing."""
910
from bzrlib.tests import stub_sftp
911
return [(SFTPTransport, stub_sftp.SFTPAbsoluteServer),
912
(SFTPTransport, stub_sftp.SFTPHomeDirServer),
913
(SFTPTransport, stub_sftp.SFTPSiblingAbsoluteServer),
1008
return [(SFTPTransport, SFTPAbsoluteServer),
1009
(SFTPTransport, SFTPHomeDirServer),
1010
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
