1
# Copyright (C) 2005 Robey Pointer <robey@lag.net>
2
# Copyright (C) 2005, 2006 Canonical Ltd
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Implementation of Transport over SFTP, using paramiko."""
33
from bzrlib.config import config_dir, ensure_config_dir_exists
34
from bzrlib.errors import (ConnectionError,
36
TransportNotPossible, NoSuchFile, PathNotChild,
42
from bzrlib.osutils import pathjoin, fancy_rename
43
from bzrlib.trace import mutter, warning, error
44
from bzrlib.transport import (
45
register_urlparse_netloc_protocol,
50
import bzrlib.urlutils as urlutils
54
except ImportError, e:
55
raise ParamikoNotPresent(e)
57
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
58
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
60
from paramiko.sftp_attr import SFTPAttributes
61
from paramiko.sftp_file import SFTPFile
62
from paramiko.sftp_client import SFTPClient
65
register_urlparse_netloc_protocol('sftp')
69
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
70
# doesn't handle it itself.
71
# <https://launchpad.net/products/bzr/+bug/41433/+index>
73
signal.signal(signal.SIGINT, signal.SIG_IGN)
76
def os_specific_subprocess_params():
77
"""Get O/S specific subprocess parameters."""
78
if sys.platform == 'win32':
79
# setting the process group and closing fds is not supported on
83
# We close fds other than the pipes as the child process does not need
86
# We also set the child process to ignore SIGINT. Normally the signal
87
# would be sent to every process in the foreground process group, but
88
# this causes it to be seen only by bzr and not by ssh. Python will
89
# generate a KeyboardInterrupt in bzr, and we will then have a chance
90
# to release locks or do other cleanup over ssh before the connection
92
# <https://launchpad.net/products/bzr/+bug/5987>
94
# Running it in a separate process group is not good because then it
95
# can't get non-echoed input of a password or passphrase.
96
# <https://launchpad.net/products/bzr/+bug/40508>
97
return {'preexec_fn': _ignore_sigint,
102
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
103
_default_do_prefetch = False
104
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 5):
105
_default_do_prefetch = True
109
def _get_ssh_vendor():
110
"""Find out what version of SSH is on the system."""
112
if _ssh_vendor is not None:
117
if 'BZR_SSH' in os.environ:
118
_ssh_vendor = os.environ['BZR_SSH']
119
if _ssh_vendor == 'paramiko':
124
p = subprocess.Popen(['ssh', '-V'],
125
stdin=subprocess.PIPE,
126
stdout=subprocess.PIPE,
127
stderr=subprocess.PIPE,
128
**os_specific_subprocess_params())
129
returncode = p.returncode
130
stdout, stderr = p.communicate()
134
if 'OpenSSH' in stderr:
135
mutter('ssh implementation is OpenSSH')
136
_ssh_vendor = 'openssh'
137
elif 'SSH Secure Shell' in stderr:
138
mutter('ssh implementation is SSH Corp.')
141
if _ssh_vendor != 'none':
144
# XXX: 20051123 jamesh
145
# A check for putty's plink or lsh would go here.
147
mutter('falling back to paramiko implementation')
151
class SFTPSubprocess:
152
"""A socket-like object that talks to an ssh subprocess via pipes."""
153
def __init__(self, hostname, vendor, port=None, user=None):
154
assert vendor in ['openssh', 'ssh']
155
if vendor == 'openssh':
157
'-oForwardX11=no', '-oForwardAgent=no',
158
'-oClearAllForwardings=yes', '-oProtocol=2',
159
'-oNoHostAuthenticationForLocalhost=yes']
161
args.extend(['-p', str(port)])
163
args.extend(['-l', user])
164
args.extend(['-s', hostname, 'sftp'])
165
elif vendor == 'ssh':
168
args.extend(['-p', str(port)])
170
args.extend(['-l', user])
171
args.extend(['-s', 'sftp', hostname])
173
self.proc = subprocess.Popen(args,
174
stdin=subprocess.PIPE,
175
stdout=subprocess.PIPE,
176
**os_specific_subprocess_params())
178
def send(self, data):
179
return os.write(self.proc.stdin.fileno(), data)
181
def recv_ready(self):
182
# TODO: jam 20051215 this function is necessary to support the
183
# pipelined() function. In reality, it probably should use
184
# poll() or select() to actually return if there is data
185
# available, otherwise we probably don't get any benefit
188
def recv(self, count):
189
return os.read(self.proc.stdout.fileno(), count)
192
self.proc.stdin.close()
193
self.proc.stdout.close()
197
class LoopbackSFTP(object):
198
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
200
def __init__(self, sock):
203
def send(self, data):
204
return self.__socket.send(data)
207
return self.__socket.recv(n)
209
def recv_ready(self):
213
self.__socket.close()
219
# This is a weakref dictionary, so that we can reuse connections
220
# that are still active. Long term, it might be nice to have some
221
# sort of expiration policy, such as disconnect if inactive for
222
# X seconds. But that requires a lot more fanciness.
223
_connected_hosts = weakref.WeakValueDictionary()
225
def clear_connection_cache():
226
"""Remove all hosts from the SFTP connection cache.
228
Primarily useful for test cases wanting to force garbage collection.
230
_connected_hosts.clear()
233
def load_host_keys():
235
Load system host keys (probably doesn't work on windows) and any
236
"discovered" keys from previous sessions.
238
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
240
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
242
mutter('failed to load system host keys: ' + str(e))
243
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
245
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
247
mutter('failed to load bzr host keys: ' + str(e))
251
def save_host_keys():
253
Save "discovered" host keys in $(config)/ssh_host_keys/.
255
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
256
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
257
ensure_config_dir_exists()
260
f = open(bzr_hostkey_path, 'w')
261
f.write('# SSH host keys collected by bzr\n')
262
for hostname, keys in BZR_HOSTKEYS.iteritems():
263
for keytype, key in keys.iteritems():
264
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
267
mutter('failed to save bzr host keys: ' + str(e))
270
class SFTPLock(object):
271
"""This fakes a lock in a remote location."""
272
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
273
def __init__(self, path, transport):
274
assert isinstance(transport, SFTPTransport)
276
self.lock_file = None
278
self.lock_path = path + '.write-lock'
279
self.transport = transport
281
# RBC 20060103 FIXME should we be using private methods here ?
282
abspath = transport._remote_path(self.lock_path)
283
self.lock_file = transport._sftp_open_exclusive(abspath)
285
raise LockError('File %r already locked' % (self.path,))
288
"""Should this warn, or actually try to cleanup?"""
290
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
294
if not self.lock_file:
296
self.lock_file.close()
297
self.lock_file = None
299
self.transport.delete(self.lock_path)
300
except (NoSuchFile,):
301
# What specific errors should we catch here?
304
class SFTPTransport (Transport):
306
Transport implementation for SFTP access.
308
_do_prefetch = _default_do_prefetch
310
def __init__(self, base, clone_from=None):
311
assert base.startswith('sftp://')
312
self._parse_url(base)
313
base = self._unparse_url()
316
super(SFTPTransport, self).__init__(base)
317
if clone_from is None:
320
# use the same ssh connection, etc
321
self._sftp = clone_from._sftp
322
# super saves 'self.base'
324
def should_cache(self):
326
Return True if the data pulled across should be cached locally.
330
def clone(self, offset=None):
332
Return a new SFTPTransport with root at self.base + offset.
333
We share the same SFTP session between such transports, because it's
334
fairly expensive to set them up.
337
return SFTPTransport(self.base, self)
339
return SFTPTransport(self.abspath(offset), self)
341
def abspath(self, relpath):
343
Return the full url to the given relative path.
345
@param relpath: the relative path or path components
346
@type relpath: str or list
348
return self._unparse_url(self._remote_path(relpath))
350
def _remote_path(self, relpath):
351
"""Return the path to be passed along the sftp protocol for relpath.
353
relpath is a urlencoded string.
355
# FIXME: share the common code across transports
356
assert isinstance(relpath, basestring)
357
relpath = urlutils.unescape(relpath).split('/')
358
basepath = self._path.split('/')
359
if len(basepath) > 0 and basepath[-1] == '':
360
basepath = basepath[:-1]
364
if len(basepath) == 0:
365
# In most filesystems, a request for the parent
366
# of root, just returns root.
374
path = '/'.join(basepath)
377
def relpath(self, abspath):
378
username, password, host, port, path = self._split_url(abspath)
380
if (username != self._username):
381
error.append('username mismatch')
382
if (host != self._host):
383
error.append('host mismatch')
384
if (port != self._port):
385
error.append('port mismatch')
386
if (not path.startswith(self._path)):
387
error.append('path mismatch')
389
extra = ': ' + ', '.join(error)
390
raise PathNotChild(abspath, self.base, extra=extra)
392
return path[pl:].strip('/')
394
def has(self, relpath):
396
Does the target location exist?
399
self._sftp.stat(self._remote_path(relpath))
404
def get(self, relpath):
406
Get the file at the given relative path.
408
:param relpath: The relative path to the file
411
path = self._remote_path(relpath)
412
f = self._sftp.file(path, mode='rb')
413
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
416
except (IOError, paramiko.SSHException), e:
417
self._translate_io_exception(e, path, ': error retrieving')
419
def get_partial(self, relpath, start, length=None):
421
Get just part of a file.
423
:param relpath: Path to the file, relative to base
424
:param start: The starting position to read from
425
:param length: The length to read. A length of None indicates
426
read to the end of the file.
427
:return: A file-like object containing at least the specified bytes.
428
Some implementations may return objects which can be read
429
past this length, but this is not guaranteed.
431
# TODO: implement get_partial_multi to help with knit support
432
f = self.get(relpath)
434
if self._do_prefetch and hasattr(f, 'prefetch'):
438
def put(self, relpath, f, mode=None):
440
Copy the file-like or string object into the location.
442
:param relpath: Location to put the contents, relative to base.
443
:param f: File-like or string object.
444
:param mode: The final mode for the file
446
final_path = self._remote_path(relpath)
447
self._put(final_path, f, mode=mode)
449
def _put(self, abspath, f, mode=None):
450
"""Helper function so both put() and copy_abspaths can reuse the code"""
451
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
452
os.getpid(), random.randint(0,0x7FFFFFFF))
453
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
457
fout.set_pipelined(True)
459
except (IOError, paramiko.SSHException), e:
460
self._translate_io_exception(e, tmp_abspath)
462
self._sftp.chmod(tmp_abspath, mode)
465
self._rename_and_overwrite(tmp_abspath, abspath)
467
# If we fail, try to clean up the temporary file
468
# before we throw the exception
469
# but don't let another exception mess things up
470
# Write out the traceback, because otherwise
471
# the catch and throw destroys it
473
mutter(traceback.format_exc())
477
self._sftp.remove(tmp_abspath)
479
# raise the saved except
481
# raise the original with its traceback if we can.
484
def iter_files_recursive(self):
485
"""Walk the relative paths of all files in this transport."""
486
queue = list(self.list_dir('.'))
488
relpath = urllib.quote(queue.pop(0))
489
st = self.stat(relpath)
490
if stat.S_ISDIR(st.st_mode):
491
for i, basename in enumerate(self.list_dir(relpath)):
492
queue.insert(i, relpath+'/'+basename)
496
def mkdir(self, relpath, mode=None):
497
"""Create a directory at the given path."""
499
path = self._remote_path(relpath)
500
# In the paramiko documentation, it says that passing a mode flag
501
# will filtered against the server umask.
502
# StubSFTPServer does not do this, which would be nice, because it is
503
# what we really want :)
504
# However, real servers do use umask, so we really should do it that way
505
self._sftp.mkdir(path)
507
self._sftp.chmod(path, mode=mode)
508
except (paramiko.SSHException, IOError), e:
509
self._translate_io_exception(e, path, ': unable to mkdir',
510
failure_exc=FileExists)
512
def _translate_io_exception(self, e, path, more_info='',
513
failure_exc=PathError):
514
"""Translate a paramiko or IOError into a friendlier exception.
516
:param e: The original exception
517
:param path: The path in question when the error is raised
518
:param more_info: Extra information that can be included,
519
such as what was going on
520
:param failure_exc: Paramiko has the super fun ability to raise completely
521
opaque errors that just set "e.args = ('Failure',)" with
523
If this parameter is set, it defines the exception
524
to raise in these cases.
526
# paramiko seems to generate detailless errors.
527
self._translate_error(e, path, raise_generic=False)
528
if hasattr(e, 'args'):
529
if (e.args == ('No such file or directory',) or
530
e.args == ('No such file',)):
531
raise NoSuchFile(path, str(e) + more_info)
532
if (e.args == ('mkdir failed',)):
533
raise FileExists(path, str(e) + more_info)
534
# strange but true, for the paramiko server.
535
if (e.args == ('Failure',)):
536
raise failure_exc(path, str(e) + more_info)
537
mutter('Raising exception with args %s', e.args)
538
if hasattr(e, 'errno'):
539
mutter('Raising exception with errno %s', e.errno)
542
def append(self, relpath, f, mode=None):
544
Append the text in the file-like object into the final
548
path = self._remote_path(relpath)
549
fout = self._sftp.file(path, 'ab')
551
self._sftp.chmod(path, mode)
555
except (IOError, paramiko.SSHException), e:
556
self._translate_io_exception(e, relpath, ': unable to append')
558
def rename(self, rel_from, rel_to):
559
"""Rename without special overwriting"""
561
self._sftp.rename(self._remote_path(rel_from),
562
self._remote_path(rel_to))
563
except (IOError, paramiko.SSHException), e:
564
self._translate_io_exception(e, rel_from,
565
': unable to rename to %r' % (rel_to))
567
def _rename_and_overwrite(self, abs_from, abs_to):
568
"""Do a fancy rename on the remote server.
570
Using the implementation provided by osutils.
573
fancy_rename(abs_from, abs_to,
574
rename_func=self._sftp.rename,
575
unlink_func=self._sftp.remove)
576
except (IOError, paramiko.SSHException), e:
577
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
579
def move(self, rel_from, rel_to):
580
"""Move the item at rel_from to the location at rel_to"""
581
path_from = self._remote_path(rel_from)
582
path_to = self._remote_path(rel_to)
583
self._rename_and_overwrite(path_from, path_to)
585
def delete(self, relpath):
586
"""Delete the item at relpath"""
587
path = self._remote_path(relpath)
589
self._sftp.remove(path)
590
except (IOError, paramiko.SSHException), e:
591
self._translate_io_exception(e, path, ': unable to delete')
594
"""Return True if this store supports listing."""
597
def list_dir(self, relpath):
599
Return a list of all files at the given location.
601
# does anything actually use this?
602
path = self._remote_path(relpath)
604
return self._sftp.listdir(path)
605
except (IOError, paramiko.SSHException), e:
606
self._translate_io_exception(e, path, ': failed to list_dir')
608
def rmdir(self, relpath):
609
"""See Transport.rmdir."""
610
path = self._remote_path(relpath)
612
return self._sftp.rmdir(path)
613
except (IOError, paramiko.SSHException), e:
614
self._translate_io_exception(e, path, ': failed to rmdir')
616
def stat(self, relpath):
617
"""Return the stat information for a file."""
618
path = self._remote_path(relpath)
620
return self._sftp.stat(path)
621
except (IOError, paramiko.SSHException), e:
622
self._translate_io_exception(e, path, ': unable to stat')
624
def lock_read(self, relpath):
626
Lock the given file for shared (read) access.
627
:return: A lock object, which has an unlock() member function
629
# FIXME: there should be something clever i can do here...
630
class BogusLock(object):
631
def __init__(self, path):
635
return BogusLock(relpath)
637
def lock_write(self, relpath):
639
Lock the given file for exclusive (write) access.
640
WARNING: many transports do not support this, so trying avoid using it
642
:return: A lock object, which has an unlock() member function
644
# This is a little bit bogus, but basically, we create a file
645
# which should not already exist, and if it does, we assume
646
# that there is a lock, and if it doesn't, the we assume
647
# that we have taken the lock.
648
return SFTPLock(relpath, self)
650
def _unparse_url(self, path=None):
653
path = urllib.quote(path)
654
# handle homedir paths
655
if not path.startswith('/'):
657
netloc = urllib.quote(self._host)
658
if self._username is not None:
659
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
660
if self._port is not None:
661
netloc = '%s:%d' % (netloc, self._port)
662
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
664
def _split_url(self, url):
665
if isinstance(url, unicode):
666
# TODO: Disallow unicode urls
667
#raise InvalidURL(url, 'urls must not be unicode.')
668
url = url.encode('ascii')
669
(scheme, netloc, path, params,
670
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
671
assert scheme == 'sftp'
672
username = password = host = port = None
674
username, host = netloc.split('@', 1)
676
username, password = username.split(':', 1)
677
password = urllib.unquote(password)
678
username = urllib.unquote(username)
683
host, port = host.rsplit(':', 1)
687
# TODO: Should this be ConnectionError?
688
raise TransportError('%s: invalid port number' % port)
689
host = urllib.unquote(host)
691
path = urlutils.unescape(path)
693
# the initial slash should be removed from the path, and treated
694
# as a homedir relative path (the path begins with a double slash
695
# if it is absolute).
696
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
697
# RBC 20060118 we are not using this as its too user hostile. instead
698
# we are following lftp and using /~/foo to mean '~/foo'.
699
# handle homedir paths
700
if path.startswith('/~/'):
704
return (username, password, host, port, path)
706
def _parse_url(self, url):
707
(self._username, self._password,
708
self._host, self._port, self._path) = self._split_url(url)
710
def _sftp_connect(self):
711
"""Connect to the remote sftp server.
712
After this, self._sftp should have a valid connection (or
713
we raise an TransportError 'could not connect').
715
TODO: Raise a more reasonable ConnectionFailed exception
717
global _connected_hosts
719
idx = (self._host, self._port, self._username)
721
self._sftp = _connected_hosts[idx]
726
vendor = _get_ssh_vendor()
727
if vendor == 'loopback':
728
sock = socket.socket()
729
sock.connect((self._host, self._port))
730
self._sftp = SFTPClient(LoopbackSFTP(sock))
731
elif vendor != 'none':
732
sock = SFTPSubprocess(self._host, vendor, self._port,
734
self._sftp = SFTPClient(sock)
736
self._paramiko_connect()
738
_connected_hosts[idx] = self._sftp
740
def _paramiko_connect(self):
741
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
746
t = paramiko.Transport((self._host, self._port or 22))
747
t.set_log_channel('bzr.paramiko')
749
except paramiko.SSHException, e:
750
raise ConnectionError('Unable to reach SSH host %s:%d' %
751
(self._host, self._port), e)
753
server_key = t.get_remote_server_key()
754
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
755
keytype = server_key.get_name()
756
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
757
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
758
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
759
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
760
our_server_key = BZR_HOSTKEYS[self._host][keytype]
761
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
763
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
764
if not BZR_HOSTKEYS.has_key(self._host):
765
BZR_HOSTKEYS[self._host] = {}
766
BZR_HOSTKEYS[self._host][keytype] = server_key
767
our_server_key = server_key
768
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
770
if server_key != our_server_key:
771
filename1 = os.path.expanduser('~/.ssh/known_hosts')
772
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
773
raise TransportError('Host keys for %s do not match! %s != %s' % \
774
(self._host, our_server_key_hex, server_key_hex),
775
['Try editing %s or %s' % (filename1, filename2)])
780
self._sftp = t.open_sftp_client()
781
except paramiko.SSHException, e:
782
raise ConnectionError('Unable to start sftp client %s:%d' %
783
(self._host, self._port), e)
785
def _sftp_auth(self, transport):
786
# paramiko requires a username, but it might be none if nothing was supplied
787
# use the local username, just in case.
788
# We don't override self._username, because if we aren't using paramiko,
789
# the username might be specified in ~/.ssh/config and we don't want to
790
# force it to something else
791
# Also, it would mess up the self.relpath() functionality
792
username = self._username or getpass.getuser()
794
# Paramiko tries to open a socket.AF_UNIX in order to connect
795
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
796
# so we get an AttributeError exception. For now, just don't try to
797
# connect to an agent if we are on win32
798
if sys.platform != 'win32':
799
agent = paramiko.Agent()
800
for key in agent.get_keys():
801
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
803
transport.auth_publickey(username, key)
805
except paramiko.SSHException, e:
808
# okay, try finding id_rsa or id_dss? (posix only)
809
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
811
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
816
transport.auth_password(username, self._password)
818
except paramiko.SSHException, e:
821
# FIXME: Don't keep a password held in memory if you can help it
822
#self._password = None
824
# give up and ask for a password
825
password = bzrlib.ui.ui_factory.get_password(
826
prompt='SSH %(user)s@%(host)s password',
827
user=username, host=self._host)
829
transport.auth_password(username, password)
830
except paramiko.SSHException, e:
831
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
832
(username, self._host), e)
834
def _try_pkey_auth(self, transport, pkey_class, username, filename):
835
filename = os.path.expanduser('~/.ssh/' + filename)
837
key = pkey_class.from_private_key_file(filename)
838
transport.auth_publickey(username, key)
840
except paramiko.PasswordRequiredException:
841
password = bzrlib.ui.ui_factory.get_password(
842
prompt='SSH %(filename)s password',
845
key = pkey_class.from_private_key_file(filename, password)
846
transport.auth_publickey(username, key)
848
except paramiko.SSHException:
849
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
850
except paramiko.SSHException:
851
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
856
def _sftp_open_exclusive(self, abspath, mode=None):
857
"""Open a remote path exclusively.
859
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
860
the file already exists. However it does not expose this
861
at the higher level of SFTPClient.open(), so we have to
864
WARNING: This breaks the SFTPClient abstraction, so it
865
could easily break against an updated version of paramiko.
867
:param abspath: The remote absolute path where the file should be opened
868
:param mode: The mode permissions bits for the new file
870
path = self._sftp._adjust_cwd(abspath)
871
attr = SFTPAttributes()
874
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
875
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
877
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
879
raise TransportError('Expected an SFTP handle')
880
handle = msg.get_string()
881
return SFTPFile(self._sftp, handle, 'wb', -1)
882
except (paramiko.SSHException, IOError), e:
883
self._translate_io_exception(e, abspath, ': unable to open',
884
failure_exc=FileExists)
887
# ------------- server test implementation --------------
891
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
893
STUB_SERVER_KEY = """
894
-----BEGIN RSA PRIVATE KEY-----
895
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
896
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
897
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
898
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
899
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
900
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
901
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
902
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
903
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
904
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
905
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
906
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
907
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
908
-----END RSA PRIVATE KEY-----
912
class SingleListener(threading.Thread):
914
def __init__(self, callback):
915
threading.Thread.__init__(self)
916
self._callback = callback
917
self._socket = socket.socket()
918
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
919
self._socket.bind(('localhost', 0))
920
self._socket.listen(1)
921
self.port = self._socket.getsockname()[1]
922
self.stop_event = threading.Event()
925
s, _ = self._socket.accept()
926
# now close the listen socket
929
self._callback(s, self.stop_event)
931
pass #Ignore socket errors
933
# probably a failed test
934
warning('Exception from within unit test server thread: %r' % x)
937
self.stop_event.set()
938
# use a timeout here, because if the test fails, the server thread may
939
# never notice the stop_event.
943
class SFTPServer(Server):
944
"""Common code for SFTP server facilities."""
947
self._original_vendor = None
949
self._server_homedir = None
950
self._listener = None
952
self._vendor = 'none'
956
def _get_sftp_url(self, path):
957
"""Calculate an sftp url to this server for path."""
958
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
960
def log(self, message):
961
"""StubServer uses this to log when a new server is created."""
962
self.logs.append(message)
964
def _run_server(self, s, stop_event):
965
ssh_server = paramiko.Transport(s)
966
key_file = os.path.join(self._homedir, 'test_rsa.key')
967
file(key_file, 'w').write(STUB_SERVER_KEY)
968
host_key = paramiko.RSAKey.from_private_key_file(key_file)
969
ssh_server.add_server_key(host_key)
970
server = StubServer(self)
971
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
972
StubSFTPServer, root=self._root,
973
home=self._server_homedir)
974
event = threading.Event()
975
ssh_server.start_server(event, server)
977
stop_event.wait(30.0)
981
self._original_vendor = _ssh_vendor
982
_ssh_vendor = self._vendor
983
self._homedir = os.getcwdu()
984
if self._server_homedir is None:
985
self._server_homedir = self._homedir
987
# FIXME WINDOWS: _root should be _server_homedir[0]:/
988
self._listener = SingleListener(self._run_server)
989
self._listener.setDaemon(True)
990
self._listener.start()
993
"""See bzrlib.transport.Server.tearDown."""
995
self._listener.stop()
996
_ssh_vendor = self._original_vendor
999
class SFTPFullAbsoluteServer(SFTPServer):
1000
"""A test server for sftp transports, using absolute urls and ssh."""
1003
"""See bzrlib.transport.Server.get_url."""
1004
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1007
class SFTPServerWithoutSSH(SFTPServer):
1008
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
1011
super(SFTPServerWithoutSSH, self).__init__()
1012
self._vendor = 'loopback'
1014
def _run_server(self, sock, stop_event):
1015
class FakeChannel(object):
1016
def get_transport(self):
1018
def get_log_channel(self):
1022
def get_hexdump(self):
1025
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1026
root=self._root, home=self._server_homedir)
1027
server.start_subsystem('sftp', None, sock)
1028
server.finish_subsystem()
1031
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1032
"""A test server for sftp transports, using absolute urls."""
1035
"""See bzrlib.transport.Server.get_url."""
1036
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1039
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1040
"""A test server for sftp transports, using homedir relative urls."""
1043
"""See bzrlib.transport.Server.get_url."""
1044
return self._get_sftp_url("~/")
1047
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1048
"""A test servere for sftp transports, using absolute urls to non-home."""
1051
self._server_homedir = '/dev/noone/runs/tests/here'
1052
super(SFTPSiblingAbsoluteServer, self).setUp()
1055
def get_test_permutations():
1056
"""Return the permutations to be used in testing."""
1057
return [(SFTPTransport, SFTPAbsoluteServer),
1058
(SFTPTransport, SFTPHomeDirServer),
1059
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
