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 Transport, Server, urlescape, ensure_netloc
46
except ImportError, e:
47
raise ParamikoNotPresent(e)
49
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
50
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
52
from paramiko.sftp_attr import SFTPAttributes
53
from paramiko.sftp_file import SFTPFile
54
from paramiko.sftp_client import SFTPClient
60
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
61
_default_do_prefetch = False
62
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 2):
63
_default_do_prefetch = True
67
if sys.platform == 'win32':
68
# close_fds not supported on win32
73
def _get_ssh_vendor():
74
"""Find out what version of SSH is on the system."""
76
if _ssh_vendor is not None:
81
if 'BZR_SSH' in os.environ:
82
_ssh_vendor = os.environ['BZR_SSH']
83
if _ssh_vendor == 'paramiko':
88
p = subprocess.Popen(['ssh', '-V'],
90
stdin=subprocess.PIPE,
91
stdout=subprocess.PIPE,
92
stderr=subprocess.PIPE)
93
returncode = p.returncode
94
stdout, stderr = p.communicate()
98
if 'OpenSSH' in stderr:
99
mutter('ssh implementation is OpenSSH')
100
_ssh_vendor = 'openssh'
101
elif 'SSH Secure Shell' in stderr:
102
mutter('ssh implementation is SSH Corp.')
105
if _ssh_vendor != 'none':
108
# XXX: 20051123 jamesh
109
# A check for putty's plink or lsh would go here.
111
mutter('falling back to paramiko implementation')
115
class SFTPSubprocess:
116
"""A socket-like object that talks to an ssh subprocess via pipes."""
117
def __init__(self, hostname, vendor, port=None, user=None):
118
assert vendor in ['openssh', 'ssh']
119
if vendor == 'openssh':
121
'-oForwardX11=no', '-oForwardAgent=no',
122
'-oClearAllForwardings=yes', '-oProtocol=2',
123
'-oNoHostAuthenticationForLocalhost=yes']
125
args.extend(['-p', str(port)])
127
args.extend(['-l', user])
128
args.extend(['-s', hostname, 'sftp'])
129
elif vendor == 'ssh':
132
args.extend(['-p', str(port)])
134
args.extend(['-l', user])
135
args.extend(['-s', 'sftp', hostname])
137
self.proc = subprocess.Popen(args, close_fds=_close_fds,
138
stdin=subprocess.PIPE,
139
stdout=subprocess.PIPE)
141
def send(self, data):
142
return os.write(self.proc.stdin.fileno(), data)
144
def recv_ready(self):
145
# TODO: jam 20051215 this function is necessary to support the
146
# pipelined() function. In reality, it probably should use
147
# poll() or select() to actually return if there is data
148
# available, otherwise we probably don't get any benefit
151
def recv(self, count):
152
return os.read(self.proc.stdout.fileno(), count)
155
self.proc.stdin.close()
156
self.proc.stdout.close()
160
class LoopbackSFTP(object):
161
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
163
def __init__(self, sock):
166
def send(self, data):
167
return self.__socket.send(data)
170
return self.__socket.recv(n)
172
def recv_ready(self):
176
self.__socket.close()
182
# This is a weakref dictionary, so that we can reuse connections
183
# that are still active. Long term, it might be nice to have some
184
# sort of expiration policy, such as disconnect if inactive for
185
# X seconds. But that requires a lot more fanciness.
186
_connected_hosts = weakref.WeakValueDictionary()
189
def load_host_keys():
191
Load system host keys (probably doesn't work on windows) and any
192
"discovered" keys from previous sessions.
194
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
196
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
198
mutter('failed to load system host keys: ' + str(e))
199
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
201
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
203
mutter('failed to load bzr host keys: ' + str(e))
207
def save_host_keys():
209
Save "discovered" host keys in $(config)/ssh_host_keys/.
211
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
212
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
213
ensure_config_dir_exists()
216
f = open(bzr_hostkey_path, 'w')
217
f.write('# SSH host keys collected by bzr\n')
218
for hostname, keys in BZR_HOSTKEYS.iteritems():
219
for keytype, key in keys.iteritems():
220
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
223
mutter('failed to save bzr host keys: ' + str(e))
226
class SFTPLock(object):
227
"""This fakes a lock in a remote location."""
228
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
229
def __init__(self, path, transport):
230
assert isinstance(transport, SFTPTransport)
232
self.lock_file = None
234
self.lock_path = path + '.write-lock'
235
self.transport = transport
237
# RBC 20060103 FIXME should we be using private methods here ?
238
abspath = transport._remote_path(self.lock_path)
239
self.lock_file = transport._sftp_open_exclusive(abspath)
241
raise LockError('File %r already locked' % (self.path,))
244
"""Should this warn, or actually try to cleanup?"""
246
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
250
if not self.lock_file:
252
self.lock_file.close()
253
self.lock_file = None
255
self.transport.delete(self.lock_path)
256
except (NoSuchFile,):
257
# What specific errors should we catch here?
260
class SFTPTransport (Transport):
262
Transport implementation for SFTP access.
264
_do_prefetch = _default_do_prefetch
266
def __init__(self, base, clone_from=None):
267
assert base.startswith('sftp://')
268
self._parse_url(base)
269
base = self._unparse_url()
272
super(SFTPTransport, self).__init__(base)
273
if clone_from is None:
276
# use the same ssh connection, etc
277
self._sftp = clone_from._sftp
278
# super saves 'self.base'
280
def should_cache(self):
282
Return True if the data pulled across should be cached locally.
286
def clone(self, offset=None):
288
Return a new SFTPTransport with root at self.base + offset.
289
We share the same SFTP session between such transports, because it's
290
fairly expensive to set them up.
293
return SFTPTransport(self.base, self)
295
return SFTPTransport(self.abspath(offset), self)
297
def abspath(self, relpath):
299
Return the full url to the given relative path.
301
@param relpath: the relative path or path components
302
@type relpath: str or list
304
return self._unparse_url(self._remote_path(relpath))
306
def _remote_path(self, relpath):
307
"""Return the path to be passed along the sftp protocol for relpath.
309
relpath is a urlencoded string.
311
# FIXME: share the common code across transports
312
assert isinstance(relpath, basestring)
313
relpath = urllib.unquote(relpath).split('/')
314
basepath = self._path.split('/')
315
if len(basepath) > 0 and basepath[-1] == '':
316
basepath = basepath[:-1]
320
if len(basepath) == 0:
321
# In most filesystems, a request for the parent
322
# of root, just returns root.
330
path = '/'.join(basepath)
333
def relpath(self, abspath):
334
username, password, host, port, path = self._split_url(abspath)
336
if (username != self._username):
337
error.append('username mismatch')
338
if (host != self._host):
339
error.append('host mismatch')
340
if (port != self._port):
341
error.append('port mismatch')
342
if (not path.startswith(self._path)):
343
error.append('path mismatch')
345
extra = ': ' + ', '.join(error)
346
raise PathNotChild(abspath, self.base, extra=extra)
348
return path[pl:].strip('/')
350
def has(self, relpath):
352
Does the target location exist?
355
self._sftp.stat(self._remote_path(relpath))
360
def get(self, relpath):
362
Get the file at the given relative path.
364
:param relpath: The relative path to the file
367
path = self._remote_path(relpath)
368
f = self._sftp.file(path, mode='rb')
369
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
372
except (IOError, paramiko.SSHException), e:
373
self._translate_io_exception(e, path, ': error retrieving')
375
def get_partial(self, relpath, start, length=None):
377
Get just part of a file.
379
:param relpath: Path to the file, relative to base
380
:param start: The starting position to read from
381
:param length: The length to read. A length of None indicates
382
read to the end of the file.
383
:return: A file-like object containing at least the specified bytes.
384
Some implementations may return objects which can be read
385
past this length, but this is not guaranteed.
387
# TODO: implement get_partial_multi to help with knit support
388
f = self.get(relpath)
390
if self._do_prefetch and hasattr(f, 'prefetch'):
394
def put(self, relpath, f, mode=None):
396
Copy the file-like or string object into the location.
398
:param relpath: Location to put the contents, relative to base.
399
:param f: File-like or string object.
400
:param mode: The final mode for the file
402
final_path = self._remote_path(relpath)
403
self._put(final_path, f, mode=mode)
405
def _put(self, abspath, f, mode=None):
406
"""Helper function so both put() and copy_abspaths can reuse the code"""
407
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
408
os.getpid(), random.randint(0,0x7FFFFFFF))
409
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
413
fout.set_pipelined(True)
415
except (IOError, paramiko.SSHException), e:
416
self._translate_io_exception(e, tmp_abspath)
418
self._sftp.chmod(tmp_abspath, mode)
421
self._rename_and_overwrite(tmp_abspath, abspath)
423
# If we fail, try to clean up the temporary file
424
# before we throw the exception
425
# but don't let another exception mess things up
426
# Write out the traceback, because otherwise
427
# the catch and throw destroys it
429
mutter(traceback.format_exc())
433
self._sftp.remove(tmp_abspath)
435
# raise the saved except
437
# raise the original with its traceback if we can.
440
def iter_files_recursive(self):
441
"""Walk the relative paths of all files in this transport."""
442
queue = list(self.list_dir('.'))
444
relpath = urllib.quote(queue.pop(0))
445
st = self.stat(relpath)
446
if stat.S_ISDIR(st.st_mode):
447
for i, basename in enumerate(self.list_dir(relpath)):
448
queue.insert(i, relpath+'/'+basename)
452
def mkdir(self, relpath, mode=None):
453
"""Create a directory at the given path."""
455
path = self._remote_path(relpath)
456
# In the paramiko documentation, it says that passing a mode flag
457
# will filtered against the server umask.
458
# StubSFTPServer does not do this, which would be nice, because it is
459
# what we really want :)
460
# However, real servers do use umask, so we really should do it that way
461
self._sftp.mkdir(path)
463
self._sftp.chmod(path, mode=mode)
464
except (paramiko.SSHException, IOError), e:
465
self._translate_io_exception(e, path, ': unable to mkdir',
466
failure_exc=FileExists)
468
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
469
"""Translate a paramiko or IOError into a friendlier exception.
471
:param e: The original exception
472
:param path: The path in question when the error is raised
473
:param more_info: Extra information that can be included,
474
such as what was going on
475
:param failure_exc: Paramiko has the super fun ability to raise completely
476
opaque errors that just set "e.args = ('Failure',)" with
478
This sometimes means FileExists, but it also sometimes
481
# paramiko seems to generate detailless errors.
482
self._translate_error(e, path, raise_generic=False)
483
if hasattr(e, 'args'):
484
if (e.args == ('No such file or directory',) or
485
e.args == ('No such file',)):
486
raise NoSuchFile(path, str(e) + more_info)
487
if (e.args == ('mkdir failed',)):
488
raise FileExists(path, str(e) + more_info)
489
# strange but true, for the paramiko server.
490
if (e.args == ('Failure',)):
491
raise failure_exc(path, str(e) + more_info)
492
mutter('Raising exception with args %s', e.args)
493
if hasattr(e, 'errno'):
494
mutter('Raising exception with errno %s', e.errno)
497
def append(self, relpath, f):
499
Append the text in the file-like object into the final
503
path = self._remote_path(relpath)
504
fout = self._sftp.file(path, 'ab')
508
except (IOError, paramiko.SSHException), e:
509
self._translate_io_exception(e, relpath, ': unable to append')
511
def rename(self, rel_from, rel_to):
512
"""Rename without special overwriting"""
514
self._sftp.rename(self._remote_path(rel_from),
515
self._remote_path(rel_to))
516
except (IOError, paramiko.SSHException), e:
517
self._translate_io_exception(e, rel_from,
518
': unable to rename to %r' % (rel_to))
520
def _rename_and_overwrite(self, abs_from, abs_to):
521
"""Do a fancy rename on the remote server.
523
Using the implementation provided by osutils.
526
fancy_rename(abs_from, abs_to,
527
rename_func=self._sftp.rename,
528
unlink_func=self._sftp.remove)
529
except (IOError, paramiko.SSHException), e:
530
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
532
def move(self, rel_from, rel_to):
533
"""Move the item at rel_from to the location at rel_to"""
534
path_from = self._remote_path(rel_from)
535
path_to = self._remote_path(rel_to)
536
self._rename_and_overwrite(path_from, path_to)
538
def delete(self, relpath):
539
"""Delete the item at relpath"""
540
path = self._remote_path(relpath)
542
self._sftp.remove(path)
543
except (IOError, paramiko.SSHException), e:
544
self._translate_io_exception(e, path, ': unable to delete')
547
"""Return True if this store supports listing."""
550
def list_dir(self, relpath):
552
Return a list of all files at the given location.
554
# does anything actually use this?
555
path = self._remote_path(relpath)
557
return self._sftp.listdir(path)
558
except (IOError, paramiko.SSHException), e:
559
self._translate_io_exception(e, path, ': failed to list_dir')
561
def rmdir(self, relpath):
562
"""See Transport.rmdir."""
563
path = self._remote_path(relpath)
565
return self._sftp.rmdir(path)
566
except (IOError, paramiko.SSHException), e:
567
self._translate_io_exception(e, path, ': failed to rmdir')
569
def stat(self, relpath):
570
"""Return the stat information for a file."""
571
path = self._remote_path(relpath)
573
return self._sftp.stat(path)
574
except (IOError, paramiko.SSHException), e:
575
self._translate_io_exception(e, path, ': unable to stat')
577
def lock_read(self, relpath):
579
Lock the given file for shared (read) access.
580
:return: A lock object, which has an unlock() member function
582
# FIXME: there should be something clever i can do here...
583
class BogusLock(object):
584
def __init__(self, path):
588
return BogusLock(relpath)
590
def lock_write(self, relpath):
592
Lock the given file for exclusive (write) access.
593
WARNING: many transports do not support this, so trying avoid using it
595
:return: A lock object, which has an unlock() member function
597
# This is a little bit bogus, but basically, we create a file
598
# which should not already exist, and if it does, we assume
599
# that there is a lock, and if it doesn't, the we assume
600
# that we have taken the lock.
601
return SFTPLock(relpath, self)
603
def _unparse_url(self, path=None):
606
path = urllib.quote(path)
607
# handle homedir paths
608
if not path.startswith('/'):
610
netloc = urllib.quote(self._host)
611
if self._username is not None:
612
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
613
if self._port is not None:
614
netloc = '%s:%d' % (netloc, self._port)
615
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
617
def _split_url(self, url):
618
if isinstance(url, unicode):
619
url = url.encode('utf-8')
620
(scheme, netloc, path, params,
621
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
622
assert scheme == 'sftp'
623
username = password = host = port = None
625
username, host = netloc.split('@', 1)
627
username, password = username.split(':', 1)
628
password = urllib.unquote(password)
629
username = urllib.unquote(username)
634
host, port = host.rsplit(':', 1)
638
# TODO: Should this be ConnectionError?
639
raise TransportError('%s: invalid port number' % port)
640
host = urllib.unquote(host)
642
path = urllib.unquote(path)
644
# the initial slash should be removed from the path, and treated
645
# as a homedir relative path (the path begins with a double slash
646
# if it is absolute).
647
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
648
# RBC 20060118 we are not using this as its too user hostile. instead
649
# we are following lftp and using /~/foo to mean '~/foo'.
650
# handle homedir paths
651
if path.startswith('/~/'):
655
return (username, password, host, port, path)
657
def _parse_url(self, url):
658
(self._username, self._password,
659
self._host, self._port, self._path) = self._split_url(url)
661
def _sftp_connect(self):
662
"""Connect to the remote sftp server.
663
After this, self._sftp should have a valid connection (or
664
we raise an TransportError 'could not connect').
666
TODO: Raise a more reasonable ConnectionFailed exception
668
global _connected_hosts
670
idx = (self._host, self._port, self._username)
672
self._sftp = _connected_hosts[idx]
677
vendor = _get_ssh_vendor()
678
if vendor == 'loopback':
679
sock = socket.socket()
680
sock.connect((self._host, self._port))
681
self._sftp = SFTPClient(LoopbackSFTP(sock))
682
elif vendor != 'none':
683
sock = SFTPSubprocess(self._host, vendor, self._port,
685
self._sftp = SFTPClient(sock)
687
self._paramiko_connect()
689
_connected_hosts[idx] = self._sftp
691
def _paramiko_connect(self):
692
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
697
t = paramiko.Transport((self._host, self._port or 22))
698
t.set_log_channel('bzr.paramiko')
700
except paramiko.SSHException, e:
701
raise ConnectionError('Unable to reach SSH host %s:%d' %
702
(self._host, self._port), e)
704
server_key = t.get_remote_server_key()
705
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
706
keytype = server_key.get_name()
707
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
708
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
709
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
710
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
711
our_server_key = BZR_HOSTKEYS[self._host][keytype]
712
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
714
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
715
if not BZR_HOSTKEYS.has_key(self._host):
716
BZR_HOSTKEYS[self._host] = {}
717
BZR_HOSTKEYS[self._host][keytype] = server_key
718
our_server_key = server_key
719
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
721
if server_key != our_server_key:
722
filename1 = os.path.expanduser('~/.ssh/known_hosts')
723
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
724
raise TransportError('Host keys for %s do not match! %s != %s' % \
725
(self._host, our_server_key_hex, server_key_hex),
726
['Try editing %s or %s' % (filename1, filename2)])
731
self._sftp = t.open_sftp_client()
732
except paramiko.SSHException, e:
733
raise ConnectionError('Unable to start sftp client %s:%d' %
734
(self._host, self._port), e)
736
def _sftp_auth(self, transport):
737
# paramiko requires a username, but it might be none if nothing was supplied
738
# use the local username, just in case.
739
# We don't override self._username, because if we aren't using paramiko,
740
# the username might be specified in ~/.ssh/config and we don't want to
741
# force it to something else
742
# Also, it would mess up the self.relpath() functionality
743
username = self._username or getpass.getuser()
745
# Paramiko tries to open a socket.AF_UNIX in order to connect
746
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
747
# so we get an AttributeError exception. For now, just don't try to
748
# connect to an agent if we are on win32
749
if sys.platform != 'win32':
750
agent = paramiko.Agent()
751
for key in agent.get_keys():
752
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
754
transport.auth_publickey(username, key)
756
except paramiko.SSHException, e:
759
# okay, try finding id_rsa or id_dss? (posix only)
760
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
762
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
767
transport.auth_password(username, self._password)
769
except paramiko.SSHException, e:
772
# FIXME: Don't keep a password held in memory if you can help it
773
#self._password = None
775
# give up and ask for a password
776
password = bzrlib.ui.ui_factory.get_password(
777
prompt='SSH %(user)s@%(host)s password',
778
user=username, host=self._host)
780
transport.auth_password(username, password)
781
except paramiko.SSHException, e:
782
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
783
(username, self._host), e)
785
def _try_pkey_auth(self, transport, pkey_class, username, filename):
786
filename = os.path.expanduser('~/.ssh/' + filename)
788
key = pkey_class.from_private_key_file(filename)
789
transport.auth_publickey(username, key)
791
except paramiko.PasswordRequiredException:
792
password = bzrlib.ui.ui_factory.get_password(
793
prompt='SSH %(filename)s password',
796
key = pkey_class.from_private_key_file(filename, password)
797
transport.auth_publickey(username, key)
799
except paramiko.SSHException:
800
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
801
except paramiko.SSHException:
802
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
807
def _sftp_open_exclusive(self, abspath, mode=None):
808
"""Open a remote path exclusively.
810
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
811
the file already exists. However it does not expose this
812
at the higher level of SFTPClient.open(), so we have to
815
WARNING: This breaks the SFTPClient abstraction, so it
816
could easily break against an updated version of paramiko.
818
:param abspath: The remote absolute path where the file should be opened
819
:param mode: The mode permissions bits for the new file
821
path = self._sftp._adjust_cwd(abspath)
822
attr = SFTPAttributes()
825
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
826
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
828
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
830
raise TransportError('Expected an SFTP handle')
831
handle = msg.get_string()
832
return SFTPFile(self._sftp, handle, 'wb', -1)
833
except (paramiko.SSHException, IOError), e:
834
self._translate_io_exception(e, abspath, ': unable to open',
835
failure_exc=FileExists)
838
# ------------- server test implementation --------------
842
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
844
STUB_SERVER_KEY = """
845
-----BEGIN RSA PRIVATE KEY-----
846
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
847
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
848
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
849
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
850
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
851
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
852
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
853
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
854
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
855
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
856
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
857
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
858
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
859
-----END RSA PRIVATE KEY-----
863
class SingleListener(threading.Thread):
865
def __init__(self, callback):
866
threading.Thread.__init__(self)
867
self._callback = callback
868
self._socket = socket.socket()
869
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
870
self._socket.bind(('localhost', 0))
871
self._socket.listen(1)
872
self.port = self._socket.getsockname()[1]
873
self.stop_event = threading.Event()
876
s, _ = self._socket.accept()
877
# now close the listen socket
880
self._callback(s, self.stop_event)
882
pass #Ignore socket errors
884
# probably a failed test
885
warning('Exception from within unit test server thread: %r' % x)
888
self.stop_event.set()
889
# use a timeout here, because if the test fails, the server thread may
890
# never notice the stop_event.
894
class SFTPServer(Server):
895
"""Common code for SFTP server facilities."""
898
self._original_vendor = None
900
self._server_homedir = None
901
self._listener = None
903
self._vendor = 'none'
907
def _get_sftp_url(self, path):
908
"""Calculate an sftp url to this server for path."""
909
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
911
def log(self, message):
912
"""StubServer uses this to log when a new server is created."""
913
self.logs.append(message)
915
def _run_server(self, s, stop_event):
916
ssh_server = paramiko.Transport(s)
917
key_file = os.path.join(self._homedir, 'test_rsa.key')
918
file(key_file, 'w').write(STUB_SERVER_KEY)
919
host_key = paramiko.RSAKey.from_private_key_file(key_file)
920
ssh_server.add_server_key(host_key)
921
server = StubServer(self)
922
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
923
StubSFTPServer, root=self._root,
924
home=self._server_homedir)
925
event = threading.Event()
926
ssh_server.start_server(event, server)
928
stop_event.wait(30.0)
932
self._original_vendor = _ssh_vendor
933
_ssh_vendor = self._vendor
934
self._homedir = os.getcwdu()
935
if self._server_homedir is None:
936
self._server_homedir = self._homedir
938
# FIXME WINDOWS: _root should be _server_homedir[0]:/
939
self._listener = SingleListener(self._run_server)
940
self._listener.setDaemon(True)
941
self._listener.start()
944
"""See bzrlib.transport.Server.tearDown."""
946
self._listener.stop()
947
_ssh_vendor = self._original_vendor
950
class SFTPFullAbsoluteServer(SFTPServer):
951
"""A test server for sftp transports, using absolute urls and ssh."""
954
"""See bzrlib.transport.Server.get_url."""
955
return self._get_sftp_url(urlescape(self._homedir[1:]))
958
class SFTPServerWithoutSSH(SFTPServer):
959
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
962
super(SFTPServerWithoutSSH, self).__init__()
963
self._vendor = 'loopback'
965
def _run_server(self, sock, stop_event):
966
class FakeChannel(object):
967
def get_transport(self):
969
def get_log_channel(self):
973
def get_hexdump(self):
976
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
977
root=self._root, home=self._server_homedir)
978
server.start_subsystem('sftp', None, sock)
979
server.finish_subsystem()
982
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
983
"""A test server for sftp transports, using absolute urls."""
986
"""See bzrlib.transport.Server.get_url."""
987
return self._get_sftp_url(urlescape(self._homedir[1:]))
990
class SFTPHomeDirServer(SFTPServerWithoutSSH):
991
"""A test server for sftp transports, using homedir relative urls."""
994
"""See bzrlib.transport.Server.get_url."""
995
return self._get_sftp_url("~/")
998
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
999
"""A test servere for sftp transports, using absolute urls to non-home."""
1002
self._server_homedir = '/dev/noone/runs/tests/here'
1003
super(SFTPSiblingAbsoluteServer, self).setUp()
1006
def get_test_permutations():
1007
"""Return the permutations to be used in testing."""
1008
return [(SFTPTransport, SFTPAbsoluteServer),
1009
(SFTPTransport, SFTPHomeDirServer),
1010
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
