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