1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Implementation of Transport over SFTP, using paramiko."""
32
from bzrlib.config import config_dir, ensure_config_dir_exists
33
from bzrlib.errors import (ConnectionError,
35
TransportNotPossible, NoSuchFile, PathNotChild,
37
LockError, ParamikoNotPresent
39
from bzrlib.osutils import pathjoin, fancy_rename
40
from bzrlib.trace import mutter, warning, error
41
from bzrlib.transport import (
42
register_urlparse_netloc_protocol,
51
except ImportError, e:
52
raise ParamikoNotPresent(e)
54
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
55
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
57
from paramiko.sftp_attr import SFTPAttributes
58
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, 5):
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()
193
def clear_connection_cache():
194
"""Remove all hosts from the SFTP connection cache.
196
Primarily useful for test cases wanting to force garbage collection.
198
_connected_hosts.clear()
201
def load_host_keys():
203
Load system host keys (probably doesn't work on windows) and any
204
"discovered" keys from previous sessions.
206
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
208
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
210
mutter('failed to load system host keys: ' + str(e))
211
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
213
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
215
mutter('failed to load bzr host keys: ' + str(e))
219
def save_host_keys():
221
Save "discovered" host keys in $(config)/ssh_host_keys/.
223
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
224
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
225
ensure_config_dir_exists()
228
f = open(bzr_hostkey_path, 'w')
229
f.write('# SSH host keys collected by bzr\n')
230
for hostname, keys in BZR_HOSTKEYS.iteritems():
231
for keytype, key in keys.iteritems():
232
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
235
mutter('failed to save bzr host keys: ' + str(e))
238
class SFTPLock(object):
239
"""This fakes a lock in a remote location."""
240
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
241
def __init__(self, path, transport):
242
assert isinstance(transport, SFTPTransport)
244
self.lock_file = None
246
self.lock_path = path + '.write-lock'
247
self.transport = transport
249
# RBC 20060103 FIXME should we be using private methods here ?
250
abspath = transport._remote_path(self.lock_path)
251
self.lock_file = transport._sftp_open_exclusive(abspath)
253
raise LockError('File %r already locked' % (self.path,))
256
"""Should this warn, or actually try to cleanup?"""
258
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
262
if not self.lock_file:
264
self.lock_file.close()
265
self.lock_file = None
267
self.transport.delete(self.lock_path)
268
except (NoSuchFile,):
269
# What specific errors should we catch here?
272
class SFTPTransport (Transport):
274
Transport implementation for SFTP access.
276
_do_prefetch = _default_do_prefetch
278
def __init__(self, base, clone_from=None):
279
assert base.startswith('sftp://')
280
self._parse_url(base)
281
base = self._unparse_url()
284
super(SFTPTransport, self).__init__(base)
285
if clone_from is None:
288
# use the same ssh connection, etc
289
self._sftp = clone_from._sftp
290
# super saves 'self.base'
292
def should_cache(self):
294
Return True if the data pulled across should be cached locally.
298
def clone(self, offset=None):
300
Return a new SFTPTransport with root at self.base + offset.
301
We share the same SFTP session between such transports, because it's
302
fairly expensive to set them up.
305
return SFTPTransport(self.base, self)
307
return SFTPTransport(self.abspath(offset), self)
309
def abspath(self, relpath):
311
Return the full url to the given relative path.
313
@param relpath: the relative path or path components
314
@type relpath: str or list
316
return self._unparse_url(self._remote_path(relpath))
318
def _remote_path(self, relpath):
319
"""Return the path to be passed along the sftp protocol for relpath.
321
relpath is a urlencoded string.
323
# FIXME: share the common code across transports
324
assert isinstance(relpath, basestring)
325
relpath = urllib.unquote(relpath).split('/')
326
basepath = self._path.split('/')
327
if len(basepath) > 0 and basepath[-1] == '':
328
basepath = basepath[:-1]
332
if len(basepath) == 0:
333
# In most filesystems, a request for the parent
334
# of root, just returns root.
342
path = '/'.join(basepath)
345
def relpath(self, abspath):
346
username, password, host, port, path = self._split_url(abspath)
348
if (username != self._username):
349
error.append('username mismatch')
350
if (host != self._host):
351
error.append('host mismatch')
352
if (port != self._port):
353
error.append('port mismatch')
354
if (not path.startswith(self._path)):
355
error.append('path mismatch')
357
extra = ': ' + ', '.join(error)
358
raise PathNotChild(abspath, self.base, extra=extra)
360
return path[pl:].strip('/')
362
def has(self, relpath):
364
Does the target location exist?
367
self._sftp.stat(self._remote_path(relpath))
372
def get(self, relpath):
374
Get the file at the given relative path.
376
:param relpath: The relative path to the file
379
path = self._remote_path(relpath)
380
f = self._sftp.file(path, mode='rb')
381
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
384
except (IOError, paramiko.SSHException), e:
385
self._translate_io_exception(e, path, ': error retrieving')
387
def get_partial(self, relpath, start, length=None):
389
Get just part of a file.
391
:param relpath: Path to the file, relative to base
392
:param start: The starting position to read from
393
:param length: The length to read. A length of None indicates
394
read to the end of the file.
395
:return: A file-like object containing at least the specified bytes.
396
Some implementations may return objects which can be read
397
past this length, but this is not guaranteed.
399
# TODO: implement get_partial_multi to help with knit support
400
f = self.get(relpath)
402
if self._do_prefetch and hasattr(f, 'prefetch'):
406
def put(self, relpath, f, mode=None):
408
Copy the file-like or string object into the location.
410
:param relpath: Location to put the contents, relative to base.
411
:param f: File-like or string object.
412
:param mode: The final mode for the file
414
final_path = self._remote_path(relpath)
415
self._put(final_path, f, mode=mode)
417
def _put(self, abspath, f, mode=None):
418
"""Helper function so both put() and copy_abspaths can reuse the code"""
419
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
420
os.getpid(), random.randint(0,0x7FFFFFFF))
421
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
425
fout.set_pipelined(True)
427
except (IOError, paramiko.SSHException), e:
428
self._translate_io_exception(e, tmp_abspath)
430
self._sftp.chmod(tmp_abspath, mode)
433
self._rename_and_overwrite(tmp_abspath, abspath)
435
# If we fail, try to clean up the temporary file
436
# before we throw the exception
437
# but don't let another exception mess things up
438
# Write out the traceback, because otherwise
439
# the catch and throw destroys it
441
mutter(traceback.format_exc())
445
self._sftp.remove(tmp_abspath)
447
# raise the saved except
449
# raise the original with its traceback if we can.
452
def iter_files_recursive(self):
453
"""Walk the relative paths of all files in this transport."""
454
queue = list(self.list_dir('.'))
456
relpath = urllib.quote(queue.pop(0))
457
st = self.stat(relpath)
458
if stat.S_ISDIR(st.st_mode):
459
for i, basename in enumerate(self.list_dir(relpath)):
460
queue.insert(i, relpath+'/'+basename)
464
def mkdir(self, relpath, mode=None):
465
"""Create a directory at the given path."""
467
path = self._remote_path(relpath)
468
# In the paramiko documentation, it says that passing a mode flag
469
# will filtered against the server umask.
470
# StubSFTPServer does not do this, which would be nice, because it is
471
# what we really want :)
472
# However, real servers do use umask, so we really should do it that way
473
self._sftp.mkdir(path)
475
self._sftp.chmod(path, mode=mode)
476
except (paramiko.SSHException, IOError), e:
477
self._translate_io_exception(e, path, ': unable to mkdir',
478
failure_exc=FileExists)
480
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
481
"""Translate a paramiko or IOError into a friendlier exception.
483
:param e: The original exception
484
:param path: The path in question when the error is raised
485
:param more_info: Extra information that can be included,
486
such as what was going on
487
:param failure_exc: Paramiko has the super fun ability to raise completely
488
opaque errors that just set "e.args = ('Failure',)" with
490
This sometimes means FileExists, but it also sometimes
493
# paramiko seems to generate detailless errors.
494
self._translate_error(e, path, raise_generic=False)
495
if hasattr(e, 'args'):
496
if (e.args == ('No such file or directory',) or
497
e.args == ('No such file',)):
498
raise NoSuchFile(path, str(e) + more_info)
499
if (e.args == ('mkdir failed',)):
500
raise FileExists(path, str(e) + more_info)
501
# strange but true, for the paramiko server.
502
if (e.args == ('Failure',)):
503
raise failure_exc(path, str(e) + more_info)
504
mutter('Raising exception with args %s', e.args)
505
if hasattr(e, 'errno'):
506
mutter('Raising exception with errno %s', e.errno)
509
def append(self, relpath, f, mode=None):
511
Append the text in the file-like object into the final
515
path = self._remote_path(relpath)
516
fout = self._sftp.file(path, 'ab')
518
self._sftp.chmod(path, mode)
522
except (IOError, paramiko.SSHException), e:
523
self._translate_io_exception(e, relpath, ': unable to append')
525
def rename(self, rel_from, rel_to):
526
"""Rename without special overwriting"""
528
self._sftp.rename(self._remote_path(rel_from),
529
self._remote_path(rel_to))
530
except (IOError, paramiko.SSHException), e:
531
self._translate_io_exception(e, rel_from,
532
': unable to rename to %r' % (rel_to))
534
def _rename_and_overwrite(self, abs_from, abs_to):
535
"""Do a fancy rename on the remote server.
537
Using the implementation provided by osutils.
540
fancy_rename(abs_from, abs_to,
541
rename_func=self._sftp.rename,
542
unlink_func=self._sftp.remove)
543
except (IOError, paramiko.SSHException), e:
544
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
546
def move(self, rel_from, rel_to):
547
"""Move the item at rel_from to the location at rel_to"""
548
path_from = self._remote_path(rel_from)
549
path_to = self._remote_path(rel_to)
550
self._rename_and_overwrite(path_from, path_to)
552
def delete(self, relpath):
553
"""Delete the item at relpath"""
554
path = self._remote_path(relpath)
556
self._sftp.remove(path)
557
except (IOError, paramiko.SSHException), e:
558
self._translate_io_exception(e, path, ': unable to delete')
561
"""Return True if this store supports listing."""
564
def list_dir(self, relpath):
566
Return a list of all files at the given location.
568
# does anything actually use this?
569
path = self._remote_path(relpath)
571
return self._sftp.listdir(path)
572
except (IOError, paramiko.SSHException), e:
573
self._translate_io_exception(e, path, ': failed to list_dir')
575
def rmdir(self, relpath):
576
"""See Transport.rmdir."""
577
path = self._remote_path(relpath)
579
return self._sftp.rmdir(path)
580
except (IOError, paramiko.SSHException), e:
581
self._translate_io_exception(e, path, ': failed to rmdir')
583
def stat(self, relpath):
584
"""Return the stat information for a file."""
585
path = self._remote_path(relpath)
587
return self._sftp.stat(path)
588
except (IOError, paramiko.SSHException), e:
589
self._translate_io_exception(e, path, ': unable to stat')
591
def lock_read(self, relpath):
593
Lock the given file for shared (read) access.
594
:return: A lock object, which has an unlock() member function
596
# FIXME: there should be something clever i can do here...
597
class BogusLock(object):
598
def __init__(self, path):
602
return BogusLock(relpath)
604
def lock_write(self, relpath):
606
Lock the given file for exclusive (write) access.
607
WARNING: many transports do not support this, so trying avoid using it
609
:return: A lock object, which has an unlock() member function
611
# This is a little bit bogus, but basically, we create a file
612
# which should not already exist, and if it does, we assume
613
# that there is a lock, and if it doesn't, the we assume
614
# that we have taken the lock.
615
return SFTPLock(relpath, self)
617
def _unparse_url(self, path=None):
620
path = urllib.quote(path)
621
# handle homedir paths
622
if not path.startswith('/'):
624
netloc = urllib.quote(self._host)
625
if self._username is not None:
626
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
627
if self._port is not None:
628
netloc = '%s:%d' % (netloc, self._port)
629
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
631
def _split_url(self, url):
632
if isinstance(url, unicode):
633
url = url.encode('utf-8')
634
(scheme, netloc, path, params,
635
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
636
assert scheme == 'sftp'
637
username = password = host = port = None
639
username, host = netloc.split('@', 1)
641
username, password = username.split(':', 1)
642
password = urllib.unquote(password)
643
username = urllib.unquote(username)
648
host, port = host.rsplit(':', 1)
652
# TODO: Should this be ConnectionError?
653
raise TransportError('%s: invalid port number' % port)
654
host = urllib.unquote(host)
656
path = urllib.unquote(path)
658
# the initial slash should be removed from the path, and treated
659
# as a homedir relative path (the path begins with a double slash
660
# if it is absolute).
661
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
662
# RBC 20060118 we are not using this as its too user hostile. instead
663
# we are following lftp and using /~/foo to mean '~/foo'.
664
# handle homedir paths
665
if path.startswith('/~/'):
669
return (username, password, host, port, path)
671
def _parse_url(self, url):
672
(self._username, self._password,
673
self._host, self._port, self._path) = self._split_url(url)
675
def _sftp_connect(self):
676
"""Connect to the remote sftp server.
677
After this, self._sftp should have a valid connection (or
678
we raise an TransportError 'could not connect').
680
TODO: Raise a more reasonable ConnectionFailed exception
682
global _connected_hosts
684
idx = (self._host, self._port, self._username)
686
self._sftp = _connected_hosts[idx]
691
vendor = _get_ssh_vendor()
692
if vendor == 'loopback':
693
sock = socket.socket()
694
sock.connect((self._host, self._port))
695
self._sftp = SFTPClient(LoopbackSFTP(sock))
696
elif vendor != 'none':
697
sock = SFTPSubprocess(self._host, vendor, self._port,
699
self._sftp = SFTPClient(sock)
701
self._paramiko_connect()
703
_connected_hosts[idx] = self._sftp
705
def _paramiko_connect(self):
706
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
711
t = paramiko.Transport((self._host, self._port or 22))
712
t.set_log_channel('bzr.paramiko')
714
except paramiko.SSHException, e:
715
raise ConnectionError('Unable to reach SSH host %s:%d' %
716
(self._host, self._port), e)
718
server_key = t.get_remote_server_key()
719
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
720
keytype = server_key.get_name()
721
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
722
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
723
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
724
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
725
our_server_key = BZR_HOSTKEYS[self._host][keytype]
726
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
728
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
729
if not BZR_HOSTKEYS.has_key(self._host):
730
BZR_HOSTKEYS[self._host] = {}
731
BZR_HOSTKEYS[self._host][keytype] = server_key
732
our_server_key = server_key
733
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
735
if server_key != our_server_key:
736
filename1 = os.path.expanduser('~/.ssh/known_hosts')
737
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
738
raise TransportError('Host keys for %s do not match! %s != %s' % \
739
(self._host, our_server_key_hex, server_key_hex),
740
['Try editing %s or %s' % (filename1, filename2)])
745
self._sftp = t.open_sftp_client()
746
except paramiko.SSHException, e:
747
raise ConnectionError('Unable to start sftp client %s:%d' %
748
(self._host, self._port), e)
750
def _sftp_auth(self, transport):
751
# paramiko requires a username, but it might be none if nothing was supplied
752
# use the local username, just in case.
753
# We don't override self._username, because if we aren't using paramiko,
754
# the username might be specified in ~/.ssh/config and we don't want to
755
# force it to something else
756
# Also, it would mess up the self.relpath() functionality
757
username = self._username or getpass.getuser()
759
# Paramiko tries to open a socket.AF_UNIX in order to connect
760
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
761
# so we get an AttributeError exception. For now, just don't try to
762
# connect to an agent if we are on win32
763
if sys.platform != 'win32':
764
agent = paramiko.Agent()
765
for key in agent.get_keys():
766
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
768
transport.auth_publickey(username, key)
770
except paramiko.SSHException, e:
773
# okay, try finding id_rsa or id_dss? (posix only)
774
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
776
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
781
transport.auth_password(username, self._password)
783
except paramiko.SSHException, e:
786
# FIXME: Don't keep a password held in memory if you can help it
787
#self._password = None
789
# give up and ask for a password
790
password = bzrlib.ui.ui_factory.get_password(
791
prompt='SSH %(user)s@%(host)s password',
792
user=username, host=self._host)
794
transport.auth_password(username, password)
795
except paramiko.SSHException, e:
796
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
797
(username, self._host), e)
799
def _try_pkey_auth(self, transport, pkey_class, username, filename):
800
filename = os.path.expanduser('~/.ssh/' + filename)
802
key = pkey_class.from_private_key_file(filename)
803
transport.auth_publickey(username, key)
805
except paramiko.PasswordRequiredException:
806
password = bzrlib.ui.ui_factory.get_password(
807
prompt='SSH %(filename)s password',
810
key = pkey_class.from_private_key_file(filename, password)
811
transport.auth_publickey(username, key)
813
except paramiko.SSHException:
814
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
815
except paramiko.SSHException:
816
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
821
def _sftp_open_exclusive(self, abspath, mode=None):
822
"""Open a remote path exclusively.
824
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
825
the file already exists. However it does not expose this
826
at the higher level of SFTPClient.open(), so we have to
829
WARNING: This breaks the SFTPClient abstraction, so it
830
could easily break against an updated version of paramiko.
832
:param abspath: The remote absolute path where the file should be opened
833
:param mode: The mode permissions bits for the new file
835
path = self._sftp._adjust_cwd(abspath)
836
attr = SFTPAttributes()
839
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
840
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
842
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
844
raise TransportError('Expected an SFTP handle')
845
handle = msg.get_string()
846
return SFTPFile(self._sftp, handle, 'wb', -1)
847
except (paramiko.SSHException, IOError), e:
848
self._translate_io_exception(e, abspath, ': unable to open',
849
failure_exc=FileExists)
852
# ------------- server test implementation --------------
856
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
858
STUB_SERVER_KEY = """
859
-----BEGIN RSA PRIVATE KEY-----
860
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
861
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
862
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
863
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
864
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
865
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
866
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
867
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
868
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
869
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
870
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
871
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
872
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
873
-----END RSA PRIVATE KEY-----
877
class SingleListener(threading.Thread):
879
def __init__(self, callback):
880
threading.Thread.__init__(self)
881
self._callback = callback
882
self._socket = socket.socket()
883
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
884
self._socket.bind(('localhost', 0))
885
self._socket.listen(1)
886
self.port = self._socket.getsockname()[1]
887
self.stop_event = threading.Event()
890
s, _ = self._socket.accept()
891
# now close the listen socket
894
self._callback(s, self.stop_event)
896
pass #Ignore socket errors
898
# probably a failed test
899
warning('Exception from within unit test server thread: %r' % x)
902
self.stop_event.set()
903
# use a timeout here, because if the test fails, the server thread may
904
# never notice the stop_event.
908
class SFTPServer(Server):
909
"""Common code for SFTP server facilities."""
912
self._original_vendor = None
914
self._server_homedir = None
915
self._listener = None
917
self._vendor = 'none'
921
def _get_sftp_url(self, path):
922
"""Calculate an sftp url to this server for path."""
923
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
925
def log(self, message):
926
"""StubServer uses this to log when a new server is created."""
927
self.logs.append(message)
929
def _run_server(self, s, stop_event):
930
ssh_server = paramiko.Transport(s)
931
key_file = os.path.join(self._homedir, 'test_rsa.key')
932
file(key_file, 'w').write(STUB_SERVER_KEY)
933
host_key = paramiko.RSAKey.from_private_key_file(key_file)
934
ssh_server.add_server_key(host_key)
935
server = StubServer(self)
936
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
937
StubSFTPServer, root=self._root,
938
home=self._server_homedir)
939
event = threading.Event()
940
ssh_server.start_server(event, server)
942
stop_event.wait(30.0)
946
self._original_vendor = _ssh_vendor
947
_ssh_vendor = self._vendor
948
self._homedir = os.getcwdu()
949
if self._server_homedir is None:
950
self._server_homedir = self._homedir
952
# FIXME WINDOWS: _root should be _server_homedir[0]:/
953
self._listener = SingleListener(self._run_server)
954
self._listener.setDaemon(True)
955
self._listener.start()
958
"""See bzrlib.transport.Server.tearDown."""
960
self._listener.stop()
961
_ssh_vendor = self._original_vendor
964
class SFTPFullAbsoluteServer(SFTPServer):
965
"""A test server for sftp transports, using absolute urls and ssh."""
968
"""See bzrlib.transport.Server.get_url."""
969
return self._get_sftp_url(urlescape(self._homedir[1:]))
972
class SFTPServerWithoutSSH(SFTPServer):
973
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
976
super(SFTPServerWithoutSSH, self).__init__()
977
self._vendor = 'loopback'
979
def _run_server(self, sock, stop_event):
980
class FakeChannel(object):
981
def get_transport(self):
983
def get_log_channel(self):
987
def get_hexdump(self):
990
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
991
root=self._root, home=self._server_homedir)
992
server.start_subsystem('sftp', None, sock)
993
server.finish_subsystem()
996
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
997
"""A test server for sftp transports, using absolute urls."""
1000
"""See bzrlib.transport.Server.get_url."""
1001
return self._get_sftp_url(urlescape(self._homedir[1:]))
1004
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1005
"""A test server for sftp transports, using homedir relative urls."""
1008
"""See bzrlib.transport.Server.get_url."""
1009
return self._get_sftp_url("~/")
1012
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1013
"""A test servere for sftp transports, using absolute urls to non-home."""
1016
self._server_homedir = '/dev/noone/runs/tests/here'
1017
super(SFTPSiblingAbsoluteServer, self).setUp()
1020
def get_test_permutations():
1021
"""Return the permutations to be used in testing."""
1022
return [(SFTPTransport, SFTPAbsoluteServer),
1023
(SFTPTransport, SFTPHomeDirServer),
1024
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
