83
54
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
84
55
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
85
SFTP_OK, CMD_HANDLE, CMD_OPEN)
86
57
from paramiko.sftp_attr import SFTPAttributes
87
58
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))
59
from paramiko.sftp_client import SFTPClient
62
register_urlparse_netloc_protocol('sftp')
65
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
66
_default_do_prefetch = False
67
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 2):
68
_default_do_prefetch = True
72
if sys.platform == 'win32':
73
# close_fds not supported on win32
78
def _get_ssh_vendor():
79
"""Find out what version of SSH is on the system."""
81
if _ssh_vendor is not None:
86
if 'BZR_SSH' in os.environ:
87
_ssh_vendor = os.environ['BZR_SSH']
88
if _ssh_vendor == 'paramiko':
93
p = subprocess.Popen(['ssh', '-V'],
95
stdin=subprocess.PIPE,
96
stdout=subprocess.PIPE,
97
stderr=subprocess.PIPE)
98
returncode = p.returncode
99
stdout, stderr = p.communicate()
103
if 'OpenSSH' in stderr:
104
mutter('ssh implementation is OpenSSH')
105
_ssh_vendor = 'openssh'
106
elif 'SSH Secure Shell' in stderr:
107
mutter('ssh implementation is SSH Corp.')
110
if _ssh_vendor != 'none':
113
# XXX: 20051123 jamesh
114
# A check for putty's plink or lsh would go here.
116
mutter('falling back to paramiko implementation')
120
class SFTPSubprocess:
121
"""A socket-like object that talks to an ssh subprocess via pipes."""
122
def __init__(self, hostname, vendor, port=None, user=None):
123
assert vendor in ['openssh', 'ssh']
124
if vendor == 'openssh':
126
'-oForwardX11=no', '-oForwardAgent=no',
127
'-oClearAllForwardings=yes', '-oProtocol=2',
128
'-oNoHostAuthenticationForLocalhost=yes']
130
args.extend(['-p', str(port)])
132
args.extend(['-l', user])
133
args.extend(['-s', hostname, 'sftp'])
134
elif vendor == 'ssh':
137
args.extend(['-p', str(port)])
139
args.extend(['-l', user])
140
args.extend(['-s', 'sftp', hostname])
142
self.proc = subprocess.Popen(args, close_fds=_close_fds,
143
stdin=subprocess.PIPE,
144
stdout=subprocess.PIPE)
146
def send(self, data):
147
return os.write(self.proc.stdin.fileno(), data)
149
def recv_ready(self):
150
# TODO: jam 20051215 this function is necessary to support the
151
# pipelined() function. In reality, it probably should use
152
# poll() or select() to actually return if there is data
153
# available, otherwise we probably don't get any benefit
156
def recv(self, count):
157
return os.read(self.proc.stdout.fileno(), count)
160
self.proc.stdin.close()
161
self.proc.stdout.close()
165
class LoopbackSFTP(object):
166
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
168
def __init__(self, sock):
171
def send(self, data):
172
return self.__socket.send(data)
175
return self.__socket.recv(n)
177
def recv_ready(self):
181
self.__socket.close()
187
# This is a weakref dictionary, so that we can reuse connections
188
# that are still active. Long term, it might be nice to have some
189
# sort of expiration policy, such as disconnect if inactive for
190
# X seconds. But that requires a lot more fanciness.
191
_connected_hosts = weakref.WeakValueDictionary()
194
def load_host_keys():
196
Load system host keys (probably doesn't work on windows) and any
197
"discovered" keys from previous sessions.
199
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
201
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
203
mutter('failed to load system host keys: ' + str(e))
204
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
206
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
208
mutter('failed to load bzr host keys: ' + str(e))
212
def save_host_keys():
214
Save "discovered" host keys in $(config)/ssh_host_keys/.
216
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
217
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
218
ensure_config_dir_exists()
221
f = open(bzr_hostkey_path, 'w')
222
f.write('# SSH host keys collected by bzr\n')
223
for hostname, keys in BZR_HOSTKEYS.iteritems():
224
for keytype, key in keys.iteritems():
225
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
228
mutter('failed to save bzr host keys: ' + str(e))
95
231
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.
232
"""This fakes a lock in a remote location."""
103
233
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
105
234
def __init__(self, path, transport):
235
assert isinstance(transport, SFTPTransport)
106
237
self.lock_file = None
108
239
self.lock_path = path + '.write-lock'
131
262
# 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."""
265
class SFTPTransport (Transport):
267
Transport implementation for SFTP access.
326
269
_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)
271
def __init__(self, base, clone_from=None):
272
assert base.startswith('sftp://')
273
self._parse_url(base)
274
base = self._unparse_url()
277
super(SFTPTransport, self).__init__(base)
278
if clone_from is None:
281
# use the same ssh connection, etc
282
self._sftp = clone_from._sftp
283
# super saves 'self.base'
285
def should_cache(self):
287
Return True if the data pulled across should be cached locally.
291
def clone(self, offset=None):
293
Return a new SFTPTransport with root at self.base + offset.
294
We share the same SFTP session between such transports, because it's
295
fairly expensive to set them up.
298
return SFTPTransport(self.base, self)
300
return SFTPTransport(self.abspath(offset), self)
302
def abspath(self, relpath):
304
Return the full url to the given relative path.
306
@param relpath: the relative path or path components
307
@type relpath: str or list
309
return self._unparse_url(self._remote_path(relpath))
348
311
def _remote_path(self, relpath):
349
312
"""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)
314
relpath is a urlencoded string.
316
# FIXME: share the common code across transports
317
assert isinstance(relpath, basestring)
318
relpath = urllib.unquote(relpath).split('/')
319
basepath = self._path.split('/')
320
if len(basepath) > 0 and basepath[-1] == '':
321
basepath = basepath[:-1]
325
if len(basepath) == 0:
326
# In most filesystems, a request for the parent
327
# of root, just returns root.
335
path = '/'.join(basepath)
338
def relpath(self, abspath):
339
username, password, host, port, path = self._split_url(abspath)
341
if (username != self._username):
342
error.append('username mismatch')
343
if (host != self._host):
344
error.append('host mismatch')
345
if (port != self._port):
346
error.append('port mismatch')
347
if (not path.startswith(self._path)):
348
error.append('path mismatch')
350
extra = ': ' + ', '.join(error)
351
raise PathNotChild(abspath, self.base, extra=extra)
353
return path[pl:].strip('/')
401
355
def has(self, relpath):
403
357
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')
360
self._sftp.stat(self._remote_path(relpath))
413
365
def get(self, relpath):
414
"""Get the file at the given relative path.
367
Get the file at the given relative path.
416
369
: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
372
path = self._remote_path(relpath)
425
f = self._get_sftp().file(path, mode='rb')
373
f = self._sftp.file(path, mode='rb')
426
374
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
429
377
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
378
self._translate_io_exception(e, path, ': error retrieving')
380
def get_partial(self, relpath, start, length=None):
382
Get just part of a file.
384
:param relpath: Path to the file, relative to base
385
:param start: The starting position to read from
386
:param length: The length to read. A length of None indicates
387
read to the end of the file.
388
:return: A file-like object containing at least the specified bytes.
389
Some implementations may return objects which can be read
390
past this length, but this is not guaranteed.
392
# TODO: implement get_partial_multi to help with knit support
435
393
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.
395
if self._do_prefetch and hasattr(f, 'prefetch'):
399
def put(self, relpath, f, mode=None):
401
Copy the file-like or string object into the location.
485
403
:param relpath: Location to put the contents, relative to base.
486
:param f: File-like object.
404
:param f: File-like or string object.
487
405
:param mode: The final mode for the file
489
407
final_path = self._remote_path(relpath)
490
return self._put(final_path, f, mode=mode)
408
self._put(final_path, f, mode=mode)
492
410
def _put(self, abspath, f, mode=None):
493
411
"""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
457
def mkdir(self, relpath, mode=None):
661
458
"""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)
460
path = self._remote_path(relpath)
461
# In the paramiko documentation, it says that passing a mode flag
462
# will filtered against the server umask.
463
# StubSFTPServer does not do this, which would be nice, because it is
464
# what we really want :)
465
# However, real servers do use umask, so we really should do it that way
466
self._sftp.mkdir(path)
468
self._sftp.chmod(path, mode=mode)
680
469
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)
470
self._translate_io_exception(e, path, ': unable to mkdir',
471
failure_exc=FileExists)
686
def _translate_io_exception(self, e, path, more_info='',
687
failure_exc=PathError):
473
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
688
474
"""Translate a paramiko or IOError into a friendlier exception.
690
476
:param e: The original exception
862
605
# that we have taken the lock.
863
606
return SFTPLock(relpath, self)
608
def _unparse_url(self, path=None):
611
path = urllib.quote(path)
612
# handle homedir paths
613
if not path.startswith('/'):
615
netloc = urllib.quote(self._host)
616
if self._username is not None:
617
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
618
if self._port is not None:
619
netloc = '%s:%d' % (netloc, self._port)
620
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
622
def _split_url(self, url):
623
if isinstance(url, unicode):
624
url = url.encode('utf-8')
625
(scheme, netloc, path, params,
626
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
627
assert scheme == 'sftp'
628
username = password = host = port = None
630
username, host = netloc.split('@', 1)
632
username, password = username.split(':', 1)
633
password = urllib.unquote(password)
634
username = urllib.unquote(username)
639
host, port = host.rsplit(':', 1)
643
# TODO: Should this be ConnectionError?
644
raise TransportError('%s: invalid port number' % port)
645
host = urllib.unquote(host)
647
path = urllib.unquote(path)
649
# the initial slash should be removed from the path, and treated
650
# as a homedir relative path (the path begins with a double slash
651
# if it is absolute).
652
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
653
# RBC 20060118 we are not using this as its too user hostile. instead
654
# we are following lftp and using /~/foo to mean '~/foo'.
655
# handle homedir paths
656
if path.startswith('/~/'):
660
return (username, password, host, port, path)
662
def _parse_url(self, url):
663
(self._username, self._password,
664
self._host, self._port, self._path) = self._split_url(url)
666
def _sftp_connect(self):
667
"""Connect to the remote sftp server.
668
After this, self._sftp should have a valid connection (or
669
we raise an TransportError 'could not connect').
671
TODO: Raise a more reasonable ConnectionFailed exception
673
global _connected_hosts
675
idx = (self._host, self._port, self._username)
677
self._sftp = _connected_hosts[idx]
682
vendor = _get_ssh_vendor()
683
if vendor == 'loopback':
684
sock = socket.socket()
685
sock.connect((self._host, self._port))
686
self._sftp = SFTPClient(LoopbackSFTP(sock))
687
elif vendor != 'none':
688
sock = SFTPSubprocess(self._host, vendor, self._port,
690
self._sftp = SFTPClient(sock)
692
self._paramiko_connect()
694
_connected_hosts[idx] = self._sftp
696
def _paramiko_connect(self):
697
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
702
t = paramiko.Transport((self._host, self._port or 22))
703
t.set_log_channel('bzr.paramiko')
705
except paramiko.SSHException, e:
706
raise ConnectionError('Unable to reach SSH host %s:%d' %
707
(self._host, self._port), e)
709
server_key = t.get_remote_server_key()
710
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
711
keytype = server_key.get_name()
712
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
713
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
714
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
715
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
716
our_server_key = BZR_HOSTKEYS[self._host][keytype]
717
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
719
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
720
if not BZR_HOSTKEYS.has_key(self._host):
721
BZR_HOSTKEYS[self._host] = {}
722
BZR_HOSTKEYS[self._host][keytype] = server_key
723
our_server_key = server_key
724
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
726
if server_key != our_server_key:
727
filename1 = os.path.expanduser('~/.ssh/known_hosts')
728
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
729
raise TransportError('Host keys for %s do not match! %s != %s' % \
730
(self._host, our_server_key_hex, server_key_hex),
731
['Try editing %s or %s' % (filename1, filename2)])
736
self._sftp = t.open_sftp_client()
737
except paramiko.SSHException, e:
738
raise ConnectionError('Unable to start sftp client %s:%d' %
739
(self._host, self._port), e)
741
def _sftp_auth(self, transport):
742
# paramiko requires a username, but it might be none if nothing was supplied
743
# use the local username, just in case.
744
# We don't override self._username, because if we aren't using paramiko,
745
# the username might be specified in ~/.ssh/config and we don't want to
746
# force it to something else
747
# Also, it would mess up the self.relpath() functionality
748
username = self._username or getpass.getuser()
750
# Paramiko tries to open a socket.AF_UNIX in order to connect
751
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
752
# so we get an AttributeError exception. For now, just don't try to
753
# connect to an agent if we are on win32
754
if sys.platform != 'win32':
755
agent = paramiko.Agent()
756
for key in agent.get_keys():
757
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
759
transport.auth_publickey(username, key)
761
except paramiko.SSHException, e:
764
# okay, try finding id_rsa or id_dss? (posix only)
765
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
767
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
772
transport.auth_password(username, self._password)
774
except paramiko.SSHException, e:
777
# FIXME: Don't keep a password held in memory if you can help it
778
#self._password = None
780
# give up and ask for a password
781
password = bzrlib.ui.ui_factory.get_password(
782
prompt='SSH %(user)s@%(host)s password',
783
user=username, host=self._host)
785
transport.auth_password(username, password)
786
except paramiko.SSHException, e:
787
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
788
(username, self._host), e)
790
def _try_pkey_auth(self, transport, pkey_class, username, filename):
791
filename = os.path.expanduser('~/.ssh/' + filename)
793
key = pkey_class.from_private_key_file(filename)
794
transport.auth_publickey(username, key)
796
except paramiko.PasswordRequiredException:
797
password = bzrlib.ui.ui_factory.get_password(
798
prompt='SSH %(filename)s password',
801
key = pkey_class.from_private_key_file(filename, password)
802
transport.auth_publickey(username, key)
804
except paramiko.SSHException:
805
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
806
except paramiko.SSHException:
807
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
865
812
def _sftp_open_exclusive(self, abspath, mode=None):
866
813
"""Open a remote path exclusively.
876
823
:param abspath: The remote absolute path where the file should be opened
877
824
: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)
826
path = self._sftp._adjust_cwd(abspath)
885
827
attr = SFTPAttributes()
886
828
if mode is not None:
887
829
attr.st_mode = mode
888
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
830
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
889
831
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
891
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
833
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
892
834
if t != CMD_HANDLE:
893
835
raise TransportError('Expected an SFTP handle')
894
836
handle = msg.get_string()
895
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
837
return SFTPFile(self._sftp, handle, 'wb', -1)
896
838
except (paramiko.SSHException, IOError), e:
897
839
self._translate_io_exception(e, abspath, ': unable to open',
898
840
failure_exc=FileExists)
900
def _can_roundtrip_unix_modebits(self):
901
if sys.platform == 'win32':
843
# ------------- server test implementation --------------
847
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
849
STUB_SERVER_KEY = """
850
-----BEGIN RSA PRIVATE KEY-----
851
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
852
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
853
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
854
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
855
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
856
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
857
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
858
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
859
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
860
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
861
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
862
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
863
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
864
-----END RSA PRIVATE KEY-----
868
class SingleListener(threading.Thread):
870
def __init__(self, callback):
871
threading.Thread.__init__(self)
872
self._callback = callback
873
self._socket = socket.socket()
874
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
875
self._socket.bind(('localhost', 0))
876
self._socket.listen(1)
877
self.port = self._socket.getsockname()[1]
878
self.stop_event = threading.Event()
881
s, _ = self._socket.accept()
882
# now close the listen socket
885
self._callback(s, self.stop_event)
887
pass #Ignore socket errors
889
# probably a failed test
890
warning('Exception from within unit test server thread: %r' % x)
893
self.stop_event.set()
894
# use a timeout here, because if the test fails, the server thread may
895
# never notice the stop_event.
899
class SFTPServer(Server):
900
"""Common code for SFTP server facilities."""
903
self._original_vendor = None
905
self._server_homedir = None
906
self._listener = None
908
self._vendor = 'none'
912
def _get_sftp_url(self, path):
913
"""Calculate an sftp url to this server for path."""
914
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
916
def log(self, message):
917
"""StubServer uses this to log when a new server is created."""
918
self.logs.append(message)
920
def _run_server(self, s, stop_event):
921
ssh_server = paramiko.Transport(s)
922
key_file = os.path.join(self._homedir, 'test_rsa.key')
923
file(key_file, 'w').write(STUB_SERVER_KEY)
924
host_key = paramiko.RSAKey.from_private_key_file(key_file)
925
ssh_server.add_server_key(host_key)
926
server = StubServer(self)
927
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
928
StubSFTPServer, root=self._root,
929
home=self._server_homedir)
930
event = threading.Event()
931
ssh_server.start_server(event, server)
933
stop_event.wait(30.0)
937
self._original_vendor = _ssh_vendor
938
_ssh_vendor = self._vendor
939
self._homedir = os.getcwdu()
940
if self._server_homedir is None:
941
self._server_homedir = self._homedir
943
# FIXME WINDOWS: _root should be _server_homedir[0]:/
944
self._listener = SingleListener(self._run_server)
945
self._listener.setDaemon(True)
946
self._listener.start()
949
"""See bzrlib.transport.Server.tearDown."""
951
self._listener.stop()
952
_ssh_vendor = self._original_vendor
955
class SFTPFullAbsoluteServer(SFTPServer):
956
"""A test server for sftp transports, using absolute urls and ssh."""
959
"""See bzrlib.transport.Server.get_url."""
960
return self._get_sftp_url(urlescape(self._homedir[1:]))
963
class SFTPServerWithoutSSH(SFTPServer):
964
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
967
super(SFTPServerWithoutSSH, self).__init__()
968
self._vendor = 'loopback'
970
def _run_server(self, sock, stop_event):
971
class FakeChannel(object):
972
def get_transport(self):
974
def get_log_channel(self):
978
def get_hexdump(self):
981
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
982
root=self._root, home=self._server_homedir)
983
server.start_subsystem('sftp', None, sock)
984
server.finish_subsystem()
987
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
988
"""A test server for sftp transports, using absolute urls."""
991
"""See bzrlib.transport.Server.get_url."""
992
return self._get_sftp_url(urlescape(self._homedir[1:]))
995
class SFTPHomeDirServer(SFTPServerWithoutSSH):
996
"""A test server for sftp transports, using homedir relative urls."""
999
"""See bzrlib.transport.Server.get_url."""
1000
return self._get_sftp_url("~/")
1003
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1004
"""A test servere for sftp transports, using absolute urls to non-home."""
1007
self._server_homedir = '/dev/noone/runs/tests/here'
1008
super(SFTPSiblingAbsoluteServer, self).setUp()
908
1011
def get_test_permutations():
909
1012
"""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),
1013
return [(SFTPTransport, SFTPAbsoluteServer),
1014
(SFTPTransport, SFTPHomeDirServer),
1015
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
