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, 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))
231
class SFTPLock(object):
232
"""This fakes a lock in a remote location."""
233
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
234
def __init__(self, path, transport):
235
assert isinstance(transport, SFTPTransport)
237
self.lock_file = None
239
self.lock_path = path + '.write-lock'
240
self.transport = transport
242
# RBC 20060103 FIXME should we be using private methods here ?
243
abspath = transport._remote_path(self.lock_path)
244
self.lock_file = transport._sftp_open_exclusive(abspath)
246
raise LockError('File %r already locked' % (self.path,))
249
"""Should this warn, or actually try to cleanup?"""
251
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
255
if not self.lock_file:
257
self.lock_file.close()
258
self.lock_file = None
260
self.transport.delete(self.lock_path)
261
except (NoSuchFile,):
262
# What specific errors should we catch here?
265
class SFTPTransport (Transport):
267
Transport implementation for SFTP access.
269
_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))
311
def _remote_path(self, relpath):
312
"""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('/')
355
def has(self, relpath):
357
Does the target location exist?
360
self._sftp.stat(self._remote_path(relpath))
365
def get(self, relpath):
367
Get the file at the given relative path.
369
:param relpath: The relative path to the file
372
path = self._remote_path(relpath)
373
f = self._sftp.file(path, mode='rb')
374
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
377
except (IOError, paramiko.SSHException), e:
378
self._translate_io_exception(e, path, ': error retrieving')
380
def get_partial(self, relpath, start, length=None):
382
Get just part of a file.
384
:param relpath: Path to the file, relative to base
385
:param start: The starting position to read from
386
:param length: The length to read. A length of None indicates
387
read to the end of the file.
388
:return: A file-like object containing at least the specified bytes.
389
Some implementations may return objects which can be read
390
past this length, but this is not guaranteed.
392
# TODO: implement get_partial_multi to help with knit support
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.
403
:param relpath: Location to put the contents, relative to base.
404
:param f: File-like or string object.
405
:param mode: The final mode for the file
407
final_path = self._remote_path(relpath)
408
self._put(final_path, f, mode=mode)
410
def _put(self, abspath, f, mode=None):
411
"""Helper function so both put() and copy_abspaths can reuse the code"""
412
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
413
os.getpid(), random.randint(0,0x7FFFFFFF))
414
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
418
fout.set_pipelined(True)
420
except (IOError, paramiko.SSHException), e:
421
self._translate_io_exception(e, tmp_abspath)
423
self._sftp.chmod(tmp_abspath, mode)
426
self._rename_and_overwrite(tmp_abspath, abspath)
428
# If we fail, try to clean up the temporary file
429
# before we throw the exception
430
# but don't let another exception mess things up
431
# Write out the traceback, because otherwise
432
# the catch and throw destroys it
434
mutter(traceback.format_exc())
438
self._sftp.remove(tmp_abspath)
440
# raise the saved except
442
# raise the original with its traceback if we can.
445
def iter_files_recursive(self):
446
"""Walk the relative paths of all files in this transport."""
447
queue = list(self.list_dir('.'))
449
relpath = urllib.quote(queue.pop(0))
450
st = self.stat(relpath)
451
if stat.S_ISDIR(st.st_mode):
452
for i, basename in enumerate(self.list_dir(relpath)):
453
queue.insert(i, relpath+'/'+basename)
457
def mkdir(self, relpath, mode=None):
458
"""Create a directory at the given path."""
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)
469
except (paramiko.SSHException, IOError), e:
470
self._translate_io_exception(e, path, ': unable to mkdir',
471
failure_exc=FileExists)
473
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
474
"""Translate a paramiko or IOError into a friendlier exception.
476
:param e: The original exception
477
:param path: The path in question when the error is raised
478
:param more_info: Extra information that can be included,
479
such as what was going on
480
:param failure_exc: Paramiko has the super fun ability to raise completely
481
opaque errors that just set "e.args = ('Failure',)" with
483
This sometimes means FileExists, but it also sometimes
486
# paramiko seems to generate detailless errors.
487
self._translate_error(e, path, raise_generic=False)
488
if hasattr(e, 'args'):
489
if (e.args == ('No such file or directory',) or
490
e.args == ('No such file',)):
491
raise NoSuchFile(path, str(e) + more_info)
492
if (e.args == ('mkdir failed',)):
493
raise FileExists(path, str(e) + more_info)
494
# strange but true, for the paramiko server.
495
if (e.args == ('Failure',)):
496
raise failure_exc(path, str(e) + more_info)
497
mutter('Raising exception with args %s', e.args)
498
if hasattr(e, 'errno'):
499
mutter('Raising exception with errno %s', e.errno)
502
def append(self, relpath, f):
504
Append the text in the file-like object into the final
508
path = self._remote_path(relpath)
509
fout = self._sftp.file(path, 'ab')
513
except (IOError, paramiko.SSHException), e:
514
self._translate_io_exception(e, relpath, ': unable to append')
516
def rename(self, rel_from, rel_to):
517
"""Rename without special overwriting"""
519
self._sftp.rename(self._remote_path(rel_from),
520
self._remote_path(rel_to))
521
except (IOError, paramiko.SSHException), e:
522
self._translate_io_exception(e, rel_from,
523
': unable to rename to %r' % (rel_to))
525
def _rename_and_overwrite(self, abs_from, abs_to):
526
"""Do a fancy rename on the remote server.
528
Using the implementation provided by osutils.
531
fancy_rename(abs_from, abs_to,
532
rename_func=self._sftp.rename,
533
unlink_func=self._sftp.remove)
534
except (IOError, paramiko.SSHException), e:
535
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
537
def move(self, rel_from, rel_to):
538
"""Move the item at rel_from to the location at rel_to"""
539
path_from = self._remote_path(rel_from)
540
path_to = self._remote_path(rel_to)
541
self._rename_and_overwrite(path_from, path_to)
543
def delete(self, relpath):
544
"""Delete the item at relpath"""
545
path = self._remote_path(relpath)
547
self._sftp.remove(path)
548
except (IOError, paramiko.SSHException), e:
549
self._translate_io_exception(e, path, ': unable to delete')
552
"""Return True if this store supports listing."""
555
def list_dir(self, relpath):
557
Return a list of all files at the given location.
559
# does anything actually use this?
560
path = self._remote_path(relpath)
562
return self._sftp.listdir(path)
563
except (IOError, paramiko.SSHException), e:
564
self._translate_io_exception(e, path, ': failed to list_dir')
566
def rmdir(self, relpath):
567
"""See Transport.rmdir."""
568
path = self._remote_path(relpath)
570
return self._sftp.rmdir(path)
571
except (IOError, paramiko.SSHException), e:
572
self._translate_io_exception(e, path, ': failed to rmdir')
574
def stat(self, relpath):
575
"""Return the stat information for a file."""
576
path = self._remote_path(relpath)
578
return self._sftp.stat(path)
579
except (IOError, paramiko.SSHException), e:
580
self._translate_io_exception(e, path, ': unable to stat')
582
def lock_read(self, relpath):
584
Lock the given file for shared (read) access.
585
:return: A lock object, which has an unlock() member function
587
# FIXME: there should be something clever i can do here...
588
class BogusLock(object):
589
def __init__(self, path):
593
return BogusLock(relpath)
595
def lock_write(self, relpath):
597
Lock the given file for exclusive (write) access.
598
WARNING: many transports do not support this, so trying avoid using it
600
:return: A lock object, which has an unlock() member function
602
# This is a little bit bogus, but basically, we create a file
603
# which should not already exist, and if it does, we assume
604
# that there is a lock, and if it doesn't, the we assume
605
# that we have taken the lock.
606
return SFTPLock(relpath, self)
608
def _unparse_url(self, path=None):
611
path = urllib.quote(path)
612
# handle homedir paths
613
if not path.startswith('/'):
615
netloc = urllib.quote(self._host)
616
if self._username is not None:
617
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
618
if self._port is not None:
619
netloc = '%s:%d' % (netloc, self._port)
620
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
622
def _split_url(self, url):
623
if isinstance(url, unicode):
624
url = url.encode('utf-8')
625
(scheme, netloc, path, params,
626
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
627
assert scheme == 'sftp'
628
username = password = host = port = None
630
username, host = netloc.split('@', 1)
632
username, password = username.split(':', 1)
633
password = urllib.unquote(password)
634
username = urllib.unquote(username)
639
host, port = host.rsplit(':', 1)
643
# TODO: Should this be ConnectionError?
644
raise TransportError('%s: invalid port number' % port)
645
host = urllib.unquote(host)
647
path = urllib.unquote(path)
649
# the initial slash should be removed from the path, and treated
650
# as a homedir relative path (the path begins with a double slash
651
# if it is absolute).
652
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
653
# RBC 20060118 we are not using this as its too user hostile. instead
654
# we are following lftp and using /~/foo to mean '~/foo'.
655
# handle homedir paths
656
if path.startswith('/~/'):
660
return (username, password, host, port, path)
662
def _parse_url(self, url):
663
(self._username, self._password,
664
self._host, self._port, self._path) = self._split_url(url)
666
def _sftp_connect(self):
667
"""Connect to the remote sftp server.
668
After this, self._sftp should have a valid connection (or
669
we raise an TransportError 'could not connect').
671
TODO: Raise a more reasonable ConnectionFailed exception
673
global _connected_hosts
675
idx = (self._host, self._port, self._username)
677
self._sftp = _connected_hosts[idx]
682
vendor = _get_ssh_vendor()
683
if vendor == 'loopback':
684
sock = socket.socket()
685
sock.connect((self._host, self._port))
686
self._sftp = SFTPClient(LoopbackSFTP(sock))
687
elif vendor != 'none':
688
sock = SFTPSubprocess(self._host, vendor, self._port,
690
self._sftp = SFTPClient(sock)
692
self._paramiko_connect()
694
_connected_hosts[idx] = self._sftp
696
def _paramiko_connect(self):
697
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
702
t = paramiko.Transport((self._host, self._port or 22))
703
t.set_log_channel('bzr.paramiko')
705
except paramiko.SSHException, e:
706
raise ConnectionError('Unable to reach SSH host %s:%d' %
707
(self._host, self._port), e)
709
server_key = t.get_remote_server_key()
710
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
711
keytype = server_key.get_name()
712
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
713
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
714
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
715
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
716
our_server_key = BZR_HOSTKEYS[self._host][keytype]
717
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
719
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
720
if not BZR_HOSTKEYS.has_key(self._host):
721
BZR_HOSTKEYS[self._host] = {}
722
BZR_HOSTKEYS[self._host][keytype] = server_key
723
our_server_key = server_key
724
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
726
if server_key != our_server_key:
727
filename1 = os.path.expanduser('~/.ssh/known_hosts')
728
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
729
raise TransportError('Host keys for %s do not match! %s != %s' % \
730
(self._host, our_server_key_hex, server_key_hex),
731
['Try editing %s or %s' % (filename1, filename2)])
736
self._sftp = t.open_sftp_client()
737
except paramiko.SSHException, e:
738
raise ConnectionError('Unable to start sftp client %s:%d' %
739
(self._host, self._port), e)
741
def _sftp_auth(self, transport):
742
# paramiko requires a username, but it might be none if nothing was supplied
743
# use the local username, just in case.
744
# We don't override self._username, because if we aren't using paramiko,
745
# the username might be specified in ~/.ssh/config and we don't want to
746
# force it to something else
747
# Also, it would mess up the self.relpath() functionality
748
username = self._username or getpass.getuser()
750
# Paramiko tries to open a socket.AF_UNIX in order to connect
751
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
752
# so we get an AttributeError exception. For now, just don't try to
753
# connect to an agent if we are on win32
754
if sys.platform != 'win32':
755
agent = paramiko.Agent()
756
for key in agent.get_keys():
757
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
759
transport.auth_publickey(username, key)
761
except paramiko.SSHException, e:
764
# okay, try finding id_rsa or id_dss? (posix only)
765
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
767
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
772
transport.auth_password(username, self._password)
774
except paramiko.SSHException, e:
777
# FIXME: Don't keep a password held in memory if you can help it
778
#self._password = None
780
# give up and ask for a password
781
password = bzrlib.ui.ui_factory.get_password(
782
prompt='SSH %(user)s@%(host)s password',
783
user=username, host=self._host)
785
transport.auth_password(username, password)
786
except paramiko.SSHException, e:
787
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
788
(username, self._host), e)
790
def _try_pkey_auth(self, transport, pkey_class, username, filename):
791
filename = os.path.expanduser('~/.ssh/' + filename)
793
key = pkey_class.from_private_key_file(filename)
794
transport.auth_publickey(username, key)
796
except paramiko.PasswordRequiredException:
797
password = bzrlib.ui.ui_factory.get_password(
798
prompt='SSH %(filename)s password',
801
key = pkey_class.from_private_key_file(filename, password)
802
transport.auth_publickey(username, key)
804
except paramiko.SSHException:
805
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
806
except paramiko.SSHException:
807
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
812
def _sftp_open_exclusive(self, abspath, mode=None):
813
"""Open a remote path exclusively.
815
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
816
the file already exists. However it does not expose this
817
at the higher level of SFTPClient.open(), so we have to
820
WARNING: This breaks the SFTPClient abstraction, so it
821
could easily break against an updated version of paramiko.
823
:param abspath: The remote absolute path where the file should be opened
824
:param mode: The mode permissions bits for the new file
826
path = self._sftp._adjust_cwd(abspath)
827
attr = SFTPAttributes()
830
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
831
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
833
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
835
raise TransportError('Expected an SFTP handle')
836
handle = msg.get_string()
837
return SFTPFile(self._sftp, handle, 'wb', -1)
838
except (paramiko.SSHException, IOError), e:
839
self._translate_io_exception(e, abspath, ': unable to open',
840
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()
1011
def get_test_permutations():
1012
"""Return the permutations to be used in testing."""
1013
return [(SFTPTransport, SFTPAbsoluteServer),
1014
(SFTPTransport, SFTPHomeDirServer),
1015
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
