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,
39
from bzrlib.osutils import pathjoin, fancy_rename
40
from bzrlib.trace import mutter, warning, error
41
from bzrlib.transport import Transport, Server, urlescape
47
error('The SFTP transport requires paramiko.')
50
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
51
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
53
from paramiko.sftp_attr import SFTPAttributes
54
from paramiko.sftp_file import SFTPFile
55
from paramiko.sftp_client import SFTPClient
57
if 'sftp' not in urlparse.uses_netloc: urlparse.uses_netloc.append('sftp')
61
if sys.platform == 'win32':
62
# close_fds not supported on win32
66
def _get_ssh_vendor():
67
"""Find out what version of SSH is on the system."""
69
if _ssh_vendor is not None:
75
p = subprocess.Popen(['ssh', '-V'],
77
stdin=subprocess.PIPE,
78
stdout=subprocess.PIPE,
79
stderr=subprocess.PIPE)
80
returncode = p.returncode
81
stdout, stderr = p.communicate()
85
if 'OpenSSH' in stderr:
86
mutter('ssh implementation is OpenSSH')
87
_ssh_vendor = 'openssh'
88
elif 'SSH Secure Shell' in stderr:
89
mutter('ssh implementation is SSH Corp.')
92
if _ssh_vendor != 'none':
95
# XXX: 20051123 jamesh
96
# A check for putty's plink or lsh would go here.
98
mutter('falling back to paramiko implementation')
102
class SFTPSubprocess:
103
"""A socket-like object that talks to an ssh subprocess via pipes."""
104
def __init__(self, hostname, vendor, port=None, user=None):
105
assert vendor in ['openssh', 'ssh']
106
if vendor == 'openssh':
108
'-oForwardX11=no', '-oForwardAgent=no',
109
'-oClearAllForwardings=yes', '-oProtocol=2',
110
'-oNoHostAuthenticationForLocalhost=yes']
112
args.extend(['-p', str(port)])
114
args.extend(['-l', user])
115
args.extend(['-s', hostname, 'sftp'])
116
elif vendor == 'ssh':
119
args.extend(['-p', str(port)])
121
args.extend(['-l', user])
122
args.extend(['-s', 'sftp', hostname])
124
self.proc = subprocess.Popen(args, close_fds=_close_fds,
125
stdin=subprocess.PIPE,
126
stdout=subprocess.PIPE)
128
def send(self, data):
129
return os.write(self.proc.stdin.fileno(), data)
131
def recv_ready(self):
132
# TODO: jam 20051215 this function is necessary to support the
133
# pipelined() function. In reality, it probably should use
134
# poll() or select() to actually return if there is data
135
# available, otherwise we probably don't get any benefit
138
def recv(self, count):
139
return os.read(self.proc.stdout.fileno(), count)
142
self.proc.stdin.close()
143
self.proc.stdout.close()
150
# This is a weakref dictionary, so that we can reuse connections
151
# that are still active. Long term, it might be nice to have some
152
# sort of expiration policy, such as disconnect if inactive for
153
# X seconds. But that requires a lot more fanciness.
154
_connected_hosts = weakref.WeakValueDictionary()
156
def load_host_keys():
158
Load system host keys (probably doesn't work on windows) and any
159
"discovered" keys from previous sessions.
161
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
163
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
165
mutter('failed to load system host keys: ' + str(e))
166
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
168
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
170
mutter('failed to load bzr host keys: ' + str(e))
173
def save_host_keys():
175
Save "discovered" host keys in $(config)/ssh_host_keys/.
177
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
178
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
179
ensure_config_dir_exists()
182
f = open(bzr_hostkey_path, 'w')
183
f.write('# SSH host keys collected by bzr\n')
184
for hostname, keys in BZR_HOSTKEYS.iteritems():
185
for keytype, key in keys.iteritems():
186
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
189
mutter('failed to save bzr host keys: ' + str(e))
192
class SFTPLock(object):
193
"""This fakes a lock in a remote location."""
194
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
195
def __init__(self, path, transport):
196
assert isinstance(transport, SFTPTransport)
198
self.lock_file = None
200
self.lock_path = path + '.write-lock'
201
self.transport = transport
203
# RBC 20060103 FIXME should we be using private methods here ?
204
abspath = transport._remote_path(self.lock_path)
205
self.lock_file = transport._sftp_open_exclusive(abspath)
207
raise LockError('File %r already locked' % (self.path,))
210
"""Should this warn, or actually try to cleanup?"""
212
warn("SFTPLock %r not explicitly unlocked" % (self.path,))
216
if not self.lock_file:
218
self.lock_file.close()
219
self.lock_file = None
221
self.transport.delete(self.lock_path)
222
except (NoSuchFile,):
223
# What specific errors should we catch here?
228
class SFTPTransport (Transport):
230
Transport implementation for SFTP access.
232
_do_prefetch = False # Right now Paramiko's prefetch support causes things to hang
234
def __init__(self, base, clone_from=None):
235
assert base.startswith('sftp://')
236
self._parse_url(base)
237
base = self._unparse_url()
240
super(SFTPTransport, self).__init__(base)
241
if clone_from is None:
244
# use the same ssh connection, etc
245
self._sftp = clone_from._sftp
246
# super saves 'self.base'
248
def should_cache(self):
250
Return True if the data pulled across should be cached locally.
254
def clone(self, offset=None):
256
Return a new SFTPTransport with root at self.base + offset.
257
We share the same SFTP session between such transports, because it's
258
fairly expensive to set them up.
261
return SFTPTransport(self.base, self)
263
return SFTPTransport(self.abspath(offset), self)
265
def abspath(self, relpath):
267
Return the full url to the given relative path.
269
@param relpath: the relative path or path components
270
@type relpath: str or list
272
return self._unparse_url(self._remote_path(relpath))
274
def _remote_path(self, relpath):
275
"""Return the path to be passed along the sftp protocol for relpath.
277
relpath is a urlencoded string.
279
# FIXME: share the common code across transports
280
assert isinstance(relpath, basestring)
281
relpath = urllib.unquote(relpath).split('/')
282
basepath = self._path.split('/')
283
if len(basepath) > 0 and basepath[-1] == '':
284
basepath = basepath[:-1]
288
if len(basepath) == 0:
289
# In most filesystems, a request for the parent
290
# of root, just returns root.
298
path = '/'.join(basepath)
301
def relpath(self, abspath):
302
username, password, host, port, path = self._split_url(abspath)
304
if (username != self._username):
305
error.append('username mismatch')
306
if (host != self._host):
307
error.append('host mismatch')
308
if (port != self._port):
309
error.append('port mismatch')
310
if (not path.startswith(self._path)):
311
error.append('path mismatch')
313
extra = ': ' + ', '.join(error)
314
raise PathNotChild(abspath, self.base, extra=extra)
316
return path[pl:].strip('/')
318
def has(self, relpath):
320
Does the target location exist?
323
self._sftp.stat(self._remote_path(relpath))
328
def get(self, relpath, decode=False):
330
Get the file at the given relative path.
332
:param relpath: The relative path to the file
335
path = self._remote_path(relpath)
336
f = self._sftp.file(path, mode='rb')
337
if self._do_prefetch and hasattr(f, 'prefetch'):
340
except (IOError, paramiko.SSHException), e:
341
self._translate_io_exception(e, path, ': error retrieving')
343
def get_partial(self, relpath, start, length=None):
345
Get just part of a file.
347
:param relpath: Path to the file, relative to base
348
:param start: The starting position to read from
349
:param length: The length to read. A length of None indicates
350
read to the end of the file.
351
:return: A file-like object containing at least the specified bytes.
352
Some implementations may return objects which can be read
353
past this length, but this is not guaranteed.
355
# TODO: implement get_partial_multi to help with knit support
356
f = self.get(relpath)
358
if self._do_prefetch and hasattr(f, 'prefetch'):
362
def put(self, relpath, f, mode=None):
364
Copy the file-like or string object into the location.
366
:param relpath: Location to put the contents, relative to base.
367
:param f: File-like or string object.
368
:param mode: The final mode for the file
370
final_path = self._remote_path(relpath)
371
self._put(final_path, f, mode=mode)
373
def _put(self, abspath, f, mode=None):
374
"""Helper function so both put() and copy_abspaths can reuse the code"""
375
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
376
os.getpid(), random.randint(0,0x7FFFFFFF))
377
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
381
fout.set_pipelined(True)
383
except (IOError, paramiko.SSHException), e:
384
self._translate_io_exception(e, tmp_abspath)
386
self._sftp.chmod(tmp_abspath, mode)
389
self._rename(tmp_abspath, abspath)
391
# If we fail, try to clean up the temporary file
392
# before we throw the exception
393
# but don't let another exception mess things up
394
# Write out the traceback, because otherwise
395
# the catch and throw destroys it
397
mutter(traceback.format_exc())
401
self._sftp.remove(tmp_abspath)
403
# raise the saved except
405
# raise the original with its traceback if we can.
408
def iter_files_recursive(self):
409
"""Walk the relative paths of all files in this transport."""
410
queue = list(self.list_dir('.'))
412
relpath = urllib.quote(queue.pop(0))
413
st = self.stat(relpath)
414
if stat.S_ISDIR(st.st_mode):
415
for i, basename in enumerate(self.list_dir(relpath)):
416
queue.insert(i, relpath+'/'+basename)
420
def mkdir(self, relpath, mode=None):
421
"""Create a directory at the given path."""
423
path = self._remote_path(relpath)
424
# In the paramiko documentation, it says that passing a mode flag
425
# will filtered against the server umask.
426
# StubSFTPServer does not do this, which would be nice, because it is
427
# what we really want :)
428
# However, real servers do use umask, so we really should do it that way
429
self._sftp.mkdir(path)
431
self._sftp.chmod(path, mode=mode)
432
except (paramiko.SSHException, IOError), e:
433
self._translate_io_exception(e, path, ': unable to mkdir',
434
failure_exc=FileExists)
436
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
437
"""Translate a paramiko or IOError into a friendlier exception.
439
:param e: The original exception
440
:param path: The path in question when the error is raised
441
:param more_info: Extra information that can be included,
442
such as what was going on
443
:param failure_exc: Paramiko has the super fun ability to raise completely
444
opaque errors that just set "e.args = ('Failure',)" with
446
This sometimes means FileExists, but it also sometimes
449
# paramiko seems to generate detailless errors.
450
self._translate_error(e, path, raise_generic=False)
451
if hasattr(e, 'args'):
452
if (e.args == ('No such file or directory',) or
453
e.args == ('No such file',)):
454
raise NoSuchFile(path, str(e) + more_info)
455
if (e.args == ('mkdir failed',)):
456
raise FileExists(path, str(e) + more_info)
457
# strange but true, for the paramiko server.
458
if (e.args == ('Failure',)):
459
raise failure_exc(path, str(e) + more_info)
460
mutter('Raising exception with args %s', e.args)
461
if hasattr(e, 'errno'):
462
mutter('Raising exception with errno %s', e.errno)
465
def append(self, relpath, f):
467
Append the text in the file-like object into the final
471
path = self._remote_path(relpath)
472
fout = self._sftp.file(path, 'ab')
474
except (IOError, paramiko.SSHException), e:
475
self._translate_io_exception(e, relpath, ': unable to append')
477
def copy(self, rel_from, rel_to):
478
"""Copy the item at rel_from to the location at rel_to"""
479
path_from = self._remote_path(rel_from)
480
path_to = self._remote_path(rel_to)
481
self._copy_abspaths(path_from, path_to)
483
def _copy_abspaths(self, path_from, path_to, mode=None):
484
"""Copy files given an absolute path
486
:param path_from: Path on remote server to read
487
:param path_to: Path on remote server to write
490
TODO: Should the destination location be atomically created?
491
This has not been specified
492
TODO: This should use some sort of remote copy, rather than
493
pulling the data locally, and then writing it remotely
496
fin = self._sftp.file(path_from, 'rb')
498
self._put(path_to, fin, mode=mode)
501
except (IOError, paramiko.SSHException), e:
502
self._translate_io_exception(e, path_from, ': unable copy to: %r' % path_to)
504
def copy_to(self, relpaths, other, mode=None, pb=None):
505
"""Copy a set of entries from self into another Transport.
507
:param relpaths: A list/generator of entries to be copied.
509
if isinstance(other, SFTPTransport) and other._sftp is self._sftp:
510
# Both from & to are on the same remote filesystem
511
# We can use a remote copy, instead of pulling locally, and pushing
513
total = self._get_total(relpaths)
515
for path in relpaths:
516
path_from = self._remote_path(relpath)
517
path_to = other._remote_path(relpath)
518
self._update_pb(pb, 'copy-to', count, total)
519
self._copy_abspaths(path_from, path_to, mode=mode)
523
return super(SFTPTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
525
def _rename(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(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 stat(self, relpath):
567
"""Return the stat information for a file."""
568
path = self._remote_path(relpath)
570
return self._sftp.stat(path)
571
except (IOError, paramiko.SSHException), e:
572
self._translate_io_exception(e, path, ': unable to stat')
574
def lock_read(self, relpath):
576
Lock the given file for shared (read) access.
577
:return: A lock object, which has an unlock() member function
579
# FIXME: there should be something clever i can do here...
580
class BogusLock(object):
581
def __init__(self, path):
585
return BogusLock(relpath)
587
def lock_write(self, relpath):
589
Lock the given file for exclusive (write) access.
590
WARNING: many transports do not support this, so trying avoid using it
592
:return: A lock object, which has an unlock() member function
594
# This is a little bit bogus, but basically, we create a file
595
# which should not already exist, and if it does, we assume
596
# that there is a lock, and if it doesn't, the we assume
597
# that we have taken the lock.
598
return SFTPLock(relpath, self)
600
def _unparse_url(self, path=None):
603
path = urllib.quote(path)
604
# handle homedir paths
605
if not path.startswith('/'):
607
netloc = urllib.quote(self._host)
608
if self._username is not None:
609
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
610
if self._port is not None:
611
netloc = '%s:%d' % (netloc, self._port)
613
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
615
def _split_url(self, url):
616
if isinstance(url, unicode):
617
url = url.encode('utf-8')
618
(scheme, netloc, path, params,
619
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
620
assert scheme == 'sftp'
621
username = password = host = port = None
623
username, host = netloc.split('@', 1)
625
username, password = username.split(':', 1)
626
password = urllib.unquote(password)
627
username = urllib.unquote(username)
632
host, port = host.rsplit(':', 1)
636
# TODO: Should this be ConnectionError?
637
raise TransportError('%s: invalid port number' % port)
638
host = urllib.unquote(host)
640
path = urllib.unquote(path)
642
# the initial slash should be removed from the path, and treated
643
# as a homedir relative path (the path begins with a double slash
644
# if it is absolute).
645
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
646
# RBC 20060118 we are not using this as its too user hostile. instead
647
# we are following lftp and using /~/foo to mean '~/foo'.
648
# handle homedir paths
649
if path.startswith('/~/'):
653
return (username, password, host, port, path)
655
def _parse_url(self, url):
656
(self._username, self._password,
657
self._host, self._port, self._path) = self._split_url(url)
659
def _sftp_connect(self):
660
"""Connect to the remote sftp server.
661
After this, self._sftp should have a valid connection (or
662
we raise an TransportError 'could not connect').
664
TODO: Raise a more reasonable ConnectionFailed exception
666
global _connected_hosts
668
idx = (self._host, self._port, self._username)
670
self._sftp = _connected_hosts[idx]
675
vendor = _get_ssh_vendor()
677
sock = SFTPSubprocess(self._host, vendor, self._port,
679
self._sftp = SFTPClient(sock)
681
self._paramiko_connect()
683
_connected_hosts[idx] = self._sftp
685
def _paramiko_connect(self):
686
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
691
t = paramiko.Transport((self._host, self._port or 22))
693
except paramiko.SSHException, e:
694
raise ConnectionError('Unable to reach SSH host %s:%d' %
695
(self._host, self._port), e)
697
server_key = t.get_remote_server_key()
698
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
699
keytype = server_key.get_name()
700
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
701
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
702
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
703
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
704
our_server_key = BZR_HOSTKEYS[self._host][keytype]
705
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
707
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
708
if not BZR_HOSTKEYS.has_key(self._host):
709
BZR_HOSTKEYS[self._host] = {}
710
BZR_HOSTKEYS[self._host][keytype] = server_key
711
our_server_key = server_key
712
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
714
if server_key != our_server_key:
715
filename1 = os.path.expanduser('~/.ssh/known_hosts')
716
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
717
raise TransportError('Host keys for %s do not match! %s != %s' % \
718
(self._host, our_server_key_hex, server_key_hex),
719
['Try editing %s or %s' % (filename1, filename2)])
724
self._sftp = t.open_sftp_client()
725
except paramiko.SSHException, e:
726
raise ConnectionError('Unable to start sftp client %s:%d' %
727
(self._host, self._port), e)
729
def _sftp_auth(self, transport):
730
# paramiko requires a username, but it might be none if nothing was supplied
731
# use the local username, just in case.
732
# We don't override self._username, because if we aren't using paramiko,
733
# the username might be specified in ~/.ssh/config and we don't want to
734
# force it to something else
735
# Also, it would mess up the self.relpath() functionality
736
username = self._username or getpass.getuser()
738
# Paramiko tries to open a socket.AF_UNIX in order to connect
739
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
740
# so we get an AttributeError exception. For now, just don't try to
741
# connect to an agent if we are on win32
742
if sys.platform != 'win32':
743
agent = paramiko.Agent()
744
for key in agent.get_keys():
745
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
747
transport.auth_publickey(username, key)
749
except paramiko.SSHException, e:
752
# okay, try finding id_rsa or id_dss? (posix only)
753
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
755
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
760
transport.auth_password(username, self._password)
762
except paramiko.SSHException, e:
765
# FIXME: Don't keep a password held in memory if you can help it
766
#self._password = None
768
# give up and ask for a password
769
password = bzrlib.ui.ui_factory.get_password(
770
prompt='SSH %(user)s@%(host)s password',
771
user=username, host=self._host)
773
transport.auth_password(username, password)
774
except paramiko.SSHException, e:
775
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
776
(username, self._host), e)
778
def _try_pkey_auth(self, transport, pkey_class, username, filename):
779
filename = os.path.expanduser('~/.ssh/' + filename)
781
key = pkey_class.from_private_key_file(filename)
782
transport.auth_publickey(username, key)
784
except paramiko.PasswordRequiredException:
785
password = bzrlib.ui.ui_factory.get_password(
786
prompt='SSH %(filename)s password',
789
key = pkey_class.from_private_key_file(filename, password)
790
transport.auth_publickey(username, key)
792
except paramiko.SSHException:
793
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
794
except paramiko.SSHException:
795
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
800
def _sftp_open_exclusive(self, abspath, mode=None):
801
"""Open a remote path exclusively.
803
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
804
the file already exists. However it does not expose this
805
at the higher level of SFTPClient.open(), so we have to
808
WARNING: This breaks the SFTPClient abstraction, so it
809
could easily break against an updated version of paramiko.
811
:param abspath: The remote absolute path where the file should be opened
812
:param mode: The mode permissions bits for the new file
814
path = self._sftp._adjust_cwd(abspath)
815
attr = SFTPAttributes()
818
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
819
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
821
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
823
raise TransportError('Expected an SFTP handle')
824
handle = msg.get_string()
825
return SFTPFile(self._sftp, handle, 'wb', -1)
826
except (paramiko.SSHException, IOError), e:
827
self._translate_io_exception(e, abspath, ': unable to open',
828
failure_exc=FileExists)
831
# ------------- server test implementation --------------
835
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
837
STUB_SERVER_KEY = """
838
-----BEGIN RSA PRIVATE KEY-----
839
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
840
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
841
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
842
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
843
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
844
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
845
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
846
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
847
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
848
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
849
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
850
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
851
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
852
-----END RSA PRIVATE KEY-----
856
class SingleListener(threading.Thread):
858
def __init__(self, callback):
859
threading.Thread.__init__(self)
860
self._callback = callback
861
self._socket = socket.socket()
862
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
863
self._socket.bind(('localhost', 0))
864
self._socket.listen(1)
865
self.port = self._socket.getsockname()[1]
866
self.stop_event = threading.Event()
869
s, _ = self._socket.accept()
870
# now close the listen socket
872
self._callback(s, self.stop_event)
875
self.stop_event.set()
876
# We should consider waiting for the other thread
877
# to stop, because otherwise we get spurious
878
# bzr: ERROR: Socket exception: Connection reset by peer (54)
879
# because the test suite finishes before the thread has a chance
880
# to close. (Especially when only running a few tests)
883
class SFTPServer(Server):
884
"""Common code for SFTP server facilities."""
886
def _get_sftp_url(self, path):
887
"""Calculate a sftp url to this server for path."""
888
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
891
self._original_vendor = None
893
self._server_homedir = None
894
self._listener = None
899
def log(self, message):
900
"""What to do here? do we need this? Its for the StubServer.."""
901
self.logs.append(message)
903
def _run_server(self, s, stop_event):
904
ssh_server = paramiko.Transport(s)
905
key_file = os.path.join(self._homedir, 'test_rsa.key')
906
file(key_file, 'w').write(STUB_SERVER_KEY)
907
host_key = paramiko.RSAKey.from_private_key_file(key_file)
908
ssh_server.add_server_key(host_key)
909
server = StubServer(self)
910
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
911
StubSFTPServer, root=self._root,
912
home=self._server_homedir)
913
event = threading.Event()
914
ssh_server.start_server(event, server)
916
stop_event.wait(30.0)
919
"""See bzrlib.transport.Server.setUp."""
920
# XXX: 20051124 jamesh
921
# The tests currently pop up a password prompt when an external ssh
922
# is used. This forces the use of the paramiko implementation.
924
self._original_vendor = _ssh_vendor
926
self._homedir = os.getcwdu()
927
if self._server_homedir is None:
928
self._server_homedir = self._homedir
930
# FIXME WINDOWS: _root should be _server_homedir[0]:/
931
self._listener = SingleListener(self._run_server)
932
self._listener.setDaemon(True)
933
self._listener.start()
936
"""See bzrlib.transport.Server.tearDown."""
938
self._listener.stop()
939
_ssh_vendor = self._original_vendor
942
class SFTPAbsoluteServer(SFTPServer):
943
"""A test server for sftp transports, using absolute urls."""
946
"""See bzrlib.transport.Server.get_url."""
947
return self._get_sftp_url(urlescape(self._homedir[1:]))
950
class SFTPHomeDirServer(SFTPServer):
951
"""A test server for sftp transports, using homedir relative urls."""
954
"""See bzrlib.transport.Server.get_url."""
955
return self._get_sftp_url("~/")
958
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
959
"""A test servere for sftp transports, using absolute urls to non-home."""
962
self._server_homedir = '/dev/noone/runs/tests/here'
963
super(SFTPSiblingAbsoluteServer, self).setUp()
966
def get_test_permutations():
967
"""Return the permutations to be used in testing."""
968
return [(SFTPTransport, SFTPAbsoluteServer),
969
(SFTPTransport, SFTPHomeDirServer),
970
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
