54
78
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
55
79
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
80
SFTP_OK, CMD_HANDLE, CMD_OPEN)
57
81
from paramiko.sftp_attr import SFTPAttributes
58
82
from paramiko.sftp_file import SFTPFile
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))
85
_paramiko_version = getattr(paramiko, '__version_info__', (0, 0, 0))
86
# don't use prefetch unless paramiko version >= 1.5.5 (there were bugs earlier)
87
_default_do_prefetch = (_paramiko_version >= (1, 5, 5))
231
90
class SFTPLock(object):
232
"""This fakes a lock in a remote location."""
91
"""This fakes a lock in a remote location.
93
A present lock is indicated just by the existence of a file. This
94
doesn't work well on all transports and they are only used in
95
deprecated storage formats.
233
98
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
234
100
def __init__(self, path, transport):
235
assert isinstance(transport, SFTPTransport)
237
101
self.lock_file = None
239
103
self.lock_path = path + '.write-lock'
262
120
# What specific errors should we catch here?
265
class SFTPTransport (Transport):
267
Transport implementation for SFTP access.
124
class _SFTPReadvHelper(object):
125
"""A class to help with managing the state of a readv request."""
127
# See _get_requests for an explanation.
128
_max_request_size = 32768
130
def __init__(self, original_offsets, relpath, _report_activity):
131
"""Create a new readv helper.
133
:param original_offsets: The original requests given by the caller of
135
:param relpath: The name of the file (if known)
136
:param _report_activity: A Transport._report_activity bound method,
137
to be called as data arrives.
139
self.original_offsets = list(original_offsets)
140
self.relpath = relpath
141
self._report_activity = _report_activity
143
def _get_requests(self):
144
"""Break up the offsets into individual requests over sftp.
146
The SFTP spec only requires implementers to support 32kB requests. We
147
could try something larger (openssh supports 64kB), but then we have to
148
handle requests that fail.
149
So instead, we just break up our maximum chunks into 32kB chunks, and
150
asyncronously requests them.
151
Newer versions of paramiko would do the chunking for us, but we want to
152
start processing results right away, so we do it ourselves.
154
# TODO: Because we issue async requests, we don't 'fudge' any extra
155
# data. I'm not 100% sure that is the best choice.
157
# The first thing we do, is to collapse the individual requests as much
158
# as possible, so we don't issues requests <32kB
159
sorted_offsets = sorted(self.original_offsets)
160
coalesced = list(ConnectedTransport._coalesce_offsets(sorted_offsets,
161
limit=0, fudge_factor=0))
163
for c_offset in coalesced:
164
start = c_offset.start
165
size = c_offset.length
167
# Break this up into 32kB requests
169
next_size = min(size, self._max_request_size)
170
requests.append((start, next_size))
173
if 'sftp' in debug.debug_flags:
174
mutter('SFTP.readv(%s) %s offsets => %s coalesced => %s requests',
175
self.relpath, len(sorted_offsets), len(coalesced),
179
def request_and_yield_offsets(self, fp):
180
"""Request the data from the remote machine, yielding the results.
182
:param fp: A Paramiko SFTPFile object that supports readv.
183
:return: Yield the data requested by the original readv caller, one by
186
requests = self._get_requests()
187
offset_iter = iter(self.original_offsets)
188
cur_offset, cur_size = offset_iter.next()
189
# paramiko .readv() yields strings that are in the order of the requests
190
# So we track the current request to know where the next data is
191
# being returned from.
197
# This is used to buffer chunks which we couldn't process yet
198
# It is (start, end, data) tuples.
200
# Create an 'unlimited' data stream, so we stop based on requests,
201
# rather than just because the data stream ended. This lets us detect
203
data_stream = itertools.chain(fp.readv(requests),
204
itertools.repeat(None))
205
for (start, length), data in itertools.izip(requests, data_stream):
207
if cur_coalesced is not None:
208
raise errors.ShortReadvError(self.relpath,
209
start, length, len(data))
210
if len(data) != length:
211
raise errors.ShortReadvError(self.relpath,
212
start, length, len(data))
213
self._report_activity(length, 'read')
215
# This is the first request, just buffer it
216
buffered_data = [data]
217
buffered_len = length
219
elif start == last_end:
220
# The data we are reading fits neatly on the previous
221
# buffer, so this is all part of a larger coalesced range.
222
buffered_data.append(data)
223
buffered_len += length
225
# We have an 'interrupt' in the data stream. So we know we are
226
# at a request boundary.
228
# We haven't consumed the buffer so far, so put it into
229
# data_chunks, and continue.
230
buffered = ''.join(buffered_data)
231
data_chunks.append((input_start, buffered))
233
buffered_data = [data]
234
buffered_len = length
235
last_end = start + length
236
if input_start == cur_offset and cur_size <= buffered_len:
237
# Simplify the next steps a bit by transforming buffered_data
238
# into a single string. We also have the nice property that
239
# when there is only one string ''.join([x]) == x, so there is
241
buffered = ''.join(buffered_data)
242
# Clean out buffered data so that we keep memory
246
# TODO: We *could* also consider the case where cur_offset is in
247
# in the buffered range, even though it doesn't *start*
248
# the buffered range. But for packs we pretty much always
249
# read in order, so you won't get any extra data in the
251
while (input_start == cur_offset
252
and (buffered_offset + cur_size) <= buffered_len):
253
# We've buffered enough data to process this request, spit it
255
cur_data = buffered[buffered_offset:buffered_offset + cur_size]
256
# move the direct pointer into our buffered data
257
buffered_offset += cur_size
258
# Move the start-of-buffer pointer
259
input_start += cur_size
260
# Yield the requested data
261
yield cur_offset, cur_data
262
cur_offset, cur_size = offset_iter.next()
263
# at this point, we've consumed as much of buffered as we can,
264
# so break off the portion that we consumed
265
if buffered_offset == len(buffered_data):
266
# No tail to leave behind
270
buffered = buffered[buffered_offset:]
271
buffered_data = [buffered]
272
buffered_len = len(buffered)
273
# now that the data stream is done, close the handle
276
buffered = ''.join(buffered_data)
278
data_chunks.append((input_start, buffered))
280
if 'sftp' in debug.debug_flags:
281
mutter('SFTP readv left with %d out-of-order bytes',
282
sum(map(lambda x: len(x[1]), data_chunks)))
283
# We've processed all the readv data, at this point, anything we
284
# couldn't process is in data_chunks. This doesn't happen often, so
285
# this code path isn't optimized
286
# We use an interesting process for data_chunks
287
# Specifically if we have "bisect_left([(start, len, entries)],
289
# If start == qstart, then we get the specific node. Otherwise we
290
# get the previous node
292
idx = bisect.bisect_left(data_chunks, (cur_offset,))
293
if idx < len(data_chunks) and data_chunks[idx][0] == cur_offset:
294
# The data starts here
295
data = data_chunks[idx][1][:cur_size]
297
# The data is in a portion of a previous page
299
sub_offset = cur_offset - data_chunks[idx][0]
300
data = data_chunks[idx][1]
301
data = data[sub_offset:sub_offset + cur_size]
303
# We are missing the page where the data should be found,
306
if len(data) != cur_size:
307
raise AssertionError('We must have miscalulated.'
308
' We expected %d bytes, but only found %d'
309
% (cur_size, len(data)))
310
yield cur_offset, data
311
cur_offset, cur_size = offset_iter.next()
314
class SFTPTransport(ConnectedTransport):
315
"""Transport implementation for SFTP access."""
269
317
_do_prefetch = _default_do_prefetch
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))
318
# TODO: jam 20060717 Conceivably these could be configurable, either
319
# by auto-tuning at run-time, or by a configuration (per host??)
320
# but the performance curve is pretty flat, so just going with
321
# reasonable defaults.
322
_max_readv_combine = 200
323
# Having to round trip to the server means waiting for a response,
324
# so it is better to download extra bytes.
325
# 8KiB had good performance for both local and remote network operations
326
_bytes_to_read_before_seek = 8192
328
# The sftp spec says that implementations SHOULD allow reads
329
# to be at least 32K. paramiko.readv() does an async request
330
# for the chunks. So we need to keep it within a single request
331
# size for paramiko <= 1.6.1. paramiko 1.6.2 will probably chop
332
# up the request itself, rather than us having to worry about it
333
_max_request_size = 32768
311
335
def _remote_path(self, relpath):
312
336
"""Return the path to be passed along the sftp protocol for relpath.
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('/')
338
:param relpath: is a urlencoded string.
340
remote_path = self._parsed_url.clone(relpath).path
341
# the initial slash should be removed from the path, and treated as a
342
# homedir relative path (the path begins with a double slash if it is
343
# absolute). see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
344
# RBC 20060118 we are not using this as its too user hostile. instead
345
# we are following lftp and using /~/foo to mean '~/foo'
346
# vila--20070602 and leave absolute paths begin with a single slash.
347
if remote_path.startswith('/~/'):
348
remote_path = remote_path[3:]
349
elif remote_path == '/~':
353
def _create_connection(self, credentials=None):
354
"""Create a new connection with the provided credentials.
356
:param credentials: The credentials needed to establish the connection.
358
:return: The created connection and its associated credentials.
360
The credentials are only the password as it may have been entered
361
interactively by the user and may be different from the one provided
362
in base url at transport creation time.
364
if credentials is None:
365
password = self._parsed_url.password
367
password = credentials
369
vendor = ssh._get_ssh_vendor()
370
user = self._parsed_url.user
372
auth = config.AuthenticationConfig()
373
user = auth.get_user('ssh', self._parsed_url.host,
374
self._parsed_url.port)
375
connection = vendor.connect_sftp(self._parsed_url.user, password,
376
self._parsed_url.host, self._parsed_url.port)
377
return connection, (user, password)
379
def disconnect(self):
380
connection = self._get_connection()
381
if connection is not None:
385
"""Ensures that a connection is established"""
386
connection = self._get_connection()
387
if connection is None:
388
# First connection ever
389
connection, credentials = self._create_connection()
390
self._set_connection(connection, credentials)
355
393
def has(self, relpath):
357
395
Does the target location exist?
360
self._sftp.stat(self._remote_path(relpath))
398
self._get_sftp().stat(self._remote_path(relpath))
399
# stat result is about 20 bytes, let's say
400
self._report_activity(20, 'read')
365
405
def get(self, relpath):
367
Get the file at the given relative path.
406
"""Get the file at the given relative path.
369
408
:param relpath: The relative path to the file
372
411
path = self._remote_path(relpath)
373
f = self._sftp.file(path, mode='rb')
412
f = self._get_sftp().file(path, mode='rb')
374
413
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
377
416
except (IOError, paramiko.SSHException), e:
417
self._translate_io_exception(e, path, ': error retrieving',
418
failure_exc=errors.ReadError)
420
def get_bytes(self, relpath):
421
# reimplement this here so that we can report how many bytes came back
422
f = self.get(relpath)
425
self._report_activity(len(bytes), 'read')
430
def _readv(self, relpath, offsets):
431
"""See Transport.readv()"""
432
# We overload the default readv() because we want to use a file
433
# that does not have prefetch enabled.
434
# Also, if we have a new paramiko, it implements an async readv()
439
path = self._remote_path(relpath)
440
fp = self._get_sftp().file(path, mode='rb')
441
readv = getattr(fp, 'readv', None)
443
return self._sftp_readv(fp, offsets, relpath)
444
if 'sftp' in debug.debug_flags:
445
mutter('seek and read %s offsets', len(offsets))
446
return self._seek_and_read(fp, offsets, relpath)
447
except (IOError, paramiko.SSHException), e:
378
448
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
393
f = self.get(relpath)
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.
450
def recommended_page_size(self):
451
"""See Transport.recommended_page_size().
453
For SFTP we suggest a large page size to reduce the overhead
454
introduced by latency.
458
def _sftp_readv(self, fp, offsets, relpath):
459
"""Use the readv() member of fp to do async readv.
461
Then read them using paramiko.readv(). paramiko.readv()
462
does not support ranges > 64K, so it caps the request size, and
463
just reads until it gets all the stuff it wants.
465
helper = _SFTPReadvHelper(offsets, relpath, self._report_activity)
466
return helper.request_and_yield_offsets(fp)
468
def put_file(self, relpath, f, mode=None):
470
Copy the file-like object into the location.
403
472
:param relpath: Location to put the contents, relative to base.
404
:param f: File-like or string object.
473
:param f: File-like object.
405
474
:param mode: The final mode for the file
407
476
final_path = self._remote_path(relpath)
408
self._put(final_path, f, mode=mode)
477
return self._put(final_path, f, mode=mode)
410
479
def _put(self, abspath, f, mode=None):
411
480
"""Helper function so both put() and copy_abspaths can reuse the code"""
618
def _mkdir(self, abspath, mode=None):
624
self._report_activity(len(abspath), 'write')
625
self._get_sftp().mkdir(abspath, local_mode)
626
self._report_activity(1, 'read')
628
# chmod a dir through sftp will erase any sgid bit set
629
# on the server side. So, if the bit mode are already
630
# set, avoid the chmod. If the mode is not fine but
631
# the sgid bit is set, report a warning to the user
632
# with the umask fix.
633
stat = self._get_sftp().lstat(abspath)
634
mode = mode & 0777 # can't set special bits anyway
635
if mode != stat.st_mode & 0777:
636
if stat.st_mode & 06000:
637
warning('About to chmod %s over sftp, which will result'
638
' in its suid or sgid bits being cleared. If'
639
' you want to preserve those bits, change your '
640
' environment on the server to use umask 0%03o.'
641
% (abspath, 0777 - mode))
642
self._get_sftp().chmod(abspath, mode=mode)
643
except (paramiko.SSHException, IOError), e:
644
self._translate_io_exception(e, abspath, ': unable to mkdir',
645
failure_exc=FileExists)
457
647
def mkdir(self, relpath, mode=None):
458
648
"""Create a directory at the given path."""
649
self._mkdir(self._remote_path(relpath), mode=mode)
651
def open_write_stream(self, relpath, mode=None):
652
"""See Transport.open_write_stream."""
653
# initialise the file to zero-length
654
# this is three round trips, but we don't use this
655
# api more than once per write_group at the moment so
656
# it is a tolerable overhead. Better would be to truncate
657
# the file after opening. RBC 20070805
658
self.put_bytes_non_atomic(relpath, "", mode)
659
abspath = self._remote_path(relpath)
660
# TODO: jam 20060816 paramiko doesn't publicly expose a way to
661
# set the file mode at create time. If it does, use it.
662
# But for now, we just chmod later anyway.
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)
665
handle = self._get_sftp().file(abspath, mode='wb')
666
handle.set_pipelined(True)
469
667
except (paramiko.SSHException, IOError), e:
470
self._translate_io_exception(e, path, ': unable to mkdir',
471
failure_exc=FileExists)
668
self._translate_io_exception(e, abspath,
670
_file_streams[self.abspath(relpath)] = handle
671
return FileFileStream(self, relpath, handle)
473
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
673
def _translate_io_exception(self, e, path, more_info='',
674
failure_exc=PathError):
474
675
"""Translate a paramiko or IOError into a friendlier exception.
476
677
:param e: The original exception
605
851
# that we have taken the lock.
606
852
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),))
812
854
def _sftp_open_exclusive(self, abspath, mode=None):
813
855
"""Open a remote path exclusively.
823
865
:param abspath: The remote absolute path where the file should be opened
824
866
:param mode: The mode permissions bits for the new file
826
path = self._sftp._adjust_cwd(abspath)
868
# TODO: jam 20060816 Paramiko >= 1.6.2 (probably earlier) supports
869
# using the 'x' flag to indicate SFTP_FLAG_EXCL.
870
# However, there is no way to set the permission mode at open
871
# time using the sftp_client.file() functionality.
872
path = self._get_sftp()._adjust_cwd(abspath)
873
# mutter('sftp abspath %s => %s', abspath, path)
827
874
attr = SFTPAttributes()
828
875
if mode is not None:
829
876
attr.st_mode = mode
830
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
877
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
831
878
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
833
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
880
t, msg = self._get_sftp()._request(CMD_OPEN, path, omode, attr)
834
881
if t != CMD_HANDLE:
835
882
raise TransportError('Expected an SFTP handle')
836
883
handle = msg.get_string()
837
return SFTPFile(self._sftp, handle, 'wb', -1)
884
return SFTPFile(self._get_sftp(), handle, 'wb', -1)
838
885
except (paramiko.SSHException, IOError), e:
839
886
self._translate_io_exception(e, abspath, ': unable to open',
840
887
failure_exc=FileExists)
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()
889
def _can_roundtrip_unix_modebits(self):
890
if sys.platform == 'win32':
1011
897
def get_test_permutations():
1012
898
"""Return the permutations to be used in testing."""
1013
return [(SFTPTransport, SFTPAbsoluteServer),
1014
(SFTPTransport, SFTPHomeDirServer),
1015
(SFTPTransport, SFTPSiblingAbsoluteServer),
899
from bzrlib.tests import stub_sftp
900
return [(SFTPTransport, stub_sftp.SFTPAbsoluteServer),
901
(SFTPTransport, stub_sftp.SFTPHomeDirServer),
902
(SFTPTransport, stub_sftp.SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
