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,
51
import bzrlib.urlutils as urlutils
55
except ImportError, e:
56
raise ParamikoNotPresent(e)
58
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
59
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
61
from paramiko.sftp_attr import SFTPAttributes
62
from paramiko.sftp_file import SFTPFile
63
from paramiko.sftp_client import SFTPClient
66
register_urlparse_netloc_protocol('sftp')
70
# TODO: This should possibly ignore SIGHUP as well, but bzr currently
71
# doesn't handle it itself.
72
# <https://launchpad.net/products/bzr/+bug/41433/+index>
74
signal.signal(signal.SIGINT, signal.SIG_IGN)
77
def os_specific_subprocess_params():
78
"""Get O/S specific subprocess parameters."""
79
if sys.platform == 'win32':
80
# setting the process group and closing fds is not supported on
84
# We close fds other than the pipes as the child process does not need
87
# We also set the child process to ignore SIGINT. Normally the signal
88
# would be sent to every process in the foreground process group, but
89
# this causes it to be seen only by bzr and not by ssh. Python will
90
# generate a KeyboardInterrupt in bzr, and we will then have a chance
91
# to release locks or do other cleanup over ssh before the connection
93
# <https://launchpad.net/products/bzr/+bug/5987>
95
# Running it in a separate process group is not good because then it
96
# can't get non-echoed input of a password or passphrase.
97
# <https://launchpad.net/products/bzr/+bug/40508>
98
return {'preexec_fn': _ignore_sigint,
103
# don't use prefetch unless paramiko version >= 1.5.2 (there were bugs earlier)
104
_default_do_prefetch = False
105
if getattr(paramiko, '__version_info__', (0, 0, 0)) >= (1, 5, 5):
106
_default_do_prefetch = True
110
def _get_ssh_vendor():
111
"""Find out what version of SSH is on the system."""
113
if _ssh_vendor is not None:
118
if 'BZR_SSH' in os.environ:
119
_ssh_vendor = os.environ['BZR_SSH']
120
if _ssh_vendor == 'paramiko':
125
p = subprocess.Popen(['ssh', '-V'],
126
stdin=subprocess.PIPE,
127
stdout=subprocess.PIPE,
128
stderr=subprocess.PIPE,
129
**os_specific_subprocess_params())
130
returncode = p.returncode
131
stdout, stderr = p.communicate()
135
if 'OpenSSH' in stderr:
136
mutter('ssh implementation is OpenSSH')
137
_ssh_vendor = 'openssh'
138
elif 'SSH Secure Shell' in stderr:
139
mutter('ssh implementation is SSH Corp.')
142
if _ssh_vendor != 'none':
145
# XXX: 20051123 jamesh
146
# A check for putty's plink or lsh would go here.
148
mutter('falling back to paramiko implementation')
152
class SFTPSubprocess:
153
"""A socket-like object that talks to an ssh subprocess via pipes."""
154
def __init__(self, hostname, vendor, port=None, user=None):
155
assert vendor in ['openssh', 'ssh']
156
if vendor == 'openssh':
158
'-oForwardX11=no', '-oForwardAgent=no',
159
'-oClearAllForwardings=yes', '-oProtocol=2',
160
'-oNoHostAuthenticationForLocalhost=yes']
162
args.extend(['-p', str(port)])
164
args.extend(['-l', user])
165
args.extend(['-s', hostname, 'sftp'])
166
elif vendor == 'ssh':
169
args.extend(['-p', str(port)])
171
args.extend(['-l', user])
172
args.extend(['-s', 'sftp', hostname])
174
self.proc = subprocess.Popen(args,
175
stdin=subprocess.PIPE,
176
stdout=subprocess.PIPE,
177
**os_specific_subprocess_params())
179
def send(self, data):
180
return os.write(self.proc.stdin.fileno(), data)
182
def recv_ready(self):
183
# TODO: jam 20051215 this function is necessary to support the
184
# pipelined() function. In reality, it probably should use
185
# poll() or select() to actually return if there is data
186
# available, otherwise we probably don't get any benefit
189
def recv(self, count):
190
return os.read(self.proc.stdout.fileno(), count)
193
self.proc.stdin.close()
194
self.proc.stdout.close()
198
class LoopbackSFTP(object):
199
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
201
def __init__(self, sock):
204
def send(self, data):
205
return self.__socket.send(data)
208
return self.__socket.recv(n)
210
def recv_ready(self):
214
self.__socket.close()
220
# This is a weakref dictionary, so that we can reuse connections
221
# that are still active. Long term, it might be nice to have some
222
# sort of expiration policy, such as disconnect if inactive for
223
# X seconds. But that requires a lot more fanciness.
224
_connected_hosts = weakref.WeakValueDictionary()
226
def clear_connection_cache():
227
"""Remove all hosts from the SFTP connection cache.
229
Primarily useful for test cases wanting to force garbage collection.
231
_connected_hosts.clear()
234
def load_host_keys():
236
Load system host keys (probably doesn't work on windows) and any
237
"discovered" keys from previous sessions.
239
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
241
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
243
mutter('failed to load system host keys: ' + str(e))
244
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
246
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
248
mutter('failed to load bzr host keys: ' + str(e))
252
def save_host_keys():
254
Save "discovered" host keys in $(config)/ssh_host_keys/.
256
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
257
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
258
ensure_config_dir_exists()
261
f = open(bzr_hostkey_path, 'w')
262
f.write('# SSH host keys collected by bzr\n')
263
for hostname, keys in BZR_HOSTKEYS.iteritems():
264
for keytype, key in keys.iteritems():
265
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
268
mutter('failed to save bzr host keys: ' + str(e))
271
class SFTPLock(object):
272
"""This fakes a lock in a remote location."""
273
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
274
def __init__(self, path, transport):
275
assert isinstance(transport, SFTPTransport)
277
self.lock_file = None
279
self.lock_path = path + '.write-lock'
280
self.transport = transport
282
# RBC 20060103 FIXME should we be using private methods here ?
283
abspath = transport._remote_path(self.lock_path)
284
self.lock_file = transport._sftp_open_exclusive(abspath)
286
raise LockError('File %r already locked' % (self.path,))
289
"""Should this warn, or actually try to cleanup?"""
291
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
295
if not self.lock_file:
297
self.lock_file.close()
298
self.lock_file = None
300
self.transport.delete(self.lock_path)
301
except (NoSuchFile,):
302
# What specific errors should we catch here?
305
class SFTPTransport (Transport):
307
Transport implementation for SFTP access.
309
_do_prefetch = _default_do_prefetch
311
def __init__(self, base, clone_from=None):
312
assert base.startswith('sftp://')
313
self._parse_url(base)
314
base = self._unparse_url()
317
super(SFTPTransport, self).__init__(base)
318
if clone_from is None:
321
# use the same ssh connection, etc
322
self._sftp = clone_from._sftp
323
# super saves 'self.base'
325
def should_cache(self):
327
Return True if the data pulled across should be cached locally.
331
def clone(self, offset=None):
333
Return a new SFTPTransport with root at self.base + offset.
334
We share the same SFTP session between such transports, because it's
335
fairly expensive to set them up.
338
return SFTPTransport(self.base, self)
340
return SFTPTransport(self.abspath(offset), self)
342
def abspath(self, relpath):
344
Return the full url to the given relative path.
346
@param relpath: the relative path or path components
347
@type relpath: str or list
349
return self._unparse_url(self._remote_path(relpath))
351
def _remote_path(self, relpath):
352
"""Return the path to be passed along the sftp protocol for relpath.
354
relpath is a urlencoded string.
356
# FIXME: share the common code across transports
357
assert isinstance(relpath, basestring)
358
relpath = urlutils.unescape(relpath).split('/')
359
basepath = self._path.split('/')
360
if len(basepath) > 0 and basepath[-1] == '':
361
basepath = basepath[:-1]
365
if len(basepath) == 0:
366
# In most filesystems, a request for the parent
367
# of root, just returns root.
375
path = '/'.join(basepath)
378
def relpath(self, abspath):
379
username, password, host, port, path = self._split_url(abspath)
381
if (username != self._username):
382
error.append('username mismatch')
383
if (host != self._host):
384
error.append('host mismatch')
385
if (port != self._port):
386
error.append('port mismatch')
387
if (not path.startswith(self._path)):
388
error.append('path mismatch')
390
extra = ': ' + ', '.join(error)
391
raise PathNotChild(abspath, self.base, extra=extra)
393
return path[pl:].strip('/')
395
def has(self, relpath):
397
Does the target location exist?
400
self._sftp.stat(self._remote_path(relpath))
405
def get(self, relpath):
407
Get the file at the given relative path.
409
:param relpath: The relative path to the file
412
path = self._remote_path(relpath)
413
f = self._sftp.file(path, mode='rb')
414
if self._do_prefetch and (getattr(f, 'prefetch', None) is not None):
417
except (IOError, paramiko.SSHException), e:
418
self._translate_io_exception(e, path, ': error retrieving')
420
def get_partial(self, relpath, start, length=None):
422
Get just part of a file.
424
:param relpath: Path to the file, relative to base
425
:param start: The starting position to read from
426
:param length: The length to read. A length of None indicates
427
read to the end of the file.
428
:return: A file-like object containing at least the specified bytes.
429
Some implementations may return objects which can be read
430
past this length, but this is not guaranteed.
432
# TODO: implement get_partial_multi to help with knit support
433
f = self.get(relpath)
435
if self._do_prefetch and hasattr(f, 'prefetch'):
439
def put(self, relpath, f, mode=None):
441
Copy the file-like or string object into the location.
443
:param relpath: Location to put the contents, relative to base.
444
:param f: File-like or string object.
445
:param mode: The final mode for the file
447
final_path = self._remote_path(relpath)
448
self._put(final_path, f, mode=mode)
450
def _put(self, abspath, f, mode=None):
451
"""Helper function so both put() and copy_abspaths can reuse the code"""
452
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
453
os.getpid(), random.randint(0,0x7FFFFFFF))
454
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
458
fout.set_pipelined(True)
460
except (IOError, paramiko.SSHException), e:
461
self._translate_io_exception(e, tmp_abspath)
463
self._sftp.chmod(tmp_abspath, mode)
466
self._rename_and_overwrite(tmp_abspath, abspath)
468
# If we fail, try to clean up the temporary file
469
# before we throw the exception
470
# but don't let another exception mess things up
471
# Write out the traceback, because otherwise
472
# the catch and throw destroys it
474
mutter(traceback.format_exc())
478
self._sftp.remove(tmp_abspath)
480
# raise the saved except
482
# raise the original with its traceback if we can.
485
def iter_files_recursive(self):
486
"""Walk the relative paths of all files in this transport."""
487
queue = list(self.list_dir('.'))
489
relpath = urllib.quote(queue.pop(0))
490
st = self.stat(relpath)
491
if stat.S_ISDIR(st.st_mode):
492
for i, basename in enumerate(self.list_dir(relpath)):
493
queue.insert(i, relpath+'/'+basename)
497
def mkdir(self, relpath, mode=None):
498
"""Create a directory at the given path."""
500
path = self._remote_path(relpath)
501
# In the paramiko documentation, it says that passing a mode flag
502
# will filtered against the server umask.
503
# StubSFTPServer does not do this, which would be nice, because it is
504
# what we really want :)
505
# However, real servers do use umask, so we really should do it that way
506
self._sftp.mkdir(path)
508
self._sftp.chmod(path, mode=mode)
509
except (paramiko.SSHException, IOError), e:
510
self._translate_io_exception(e, path, ': unable to mkdir',
511
failure_exc=FileExists)
513
def _translate_io_exception(self, e, path, more_info='',
514
failure_exc=PathError):
515
"""Translate a paramiko or IOError into a friendlier exception.
517
:param e: The original exception
518
:param path: The path in question when the error is raised
519
:param more_info: Extra information that can be included,
520
such as what was going on
521
:param failure_exc: Paramiko has the super fun ability to raise completely
522
opaque errors that just set "e.args = ('Failure',)" with
524
If this parameter is set, it defines the exception
525
to raise in these cases.
527
# paramiko seems to generate detailless errors.
528
self._translate_error(e, path, raise_generic=False)
529
if hasattr(e, 'args'):
530
if (e.args == ('No such file or directory',) or
531
e.args == ('No such file',)):
532
raise NoSuchFile(path, str(e) + more_info)
533
if (e.args == ('mkdir failed',)):
534
raise FileExists(path, str(e) + more_info)
535
# strange but true, for the paramiko server.
536
if (e.args == ('Failure',)):
537
raise failure_exc(path, str(e) + more_info)
538
mutter('Raising exception with args %s', e.args)
539
if hasattr(e, 'errno'):
540
mutter('Raising exception with errno %s', e.errno)
543
def append(self, relpath, f, mode=None):
545
Append the text in the file-like object into the final
549
path = self._remote_path(relpath)
550
fout = self._sftp.file(path, 'ab')
552
self._sftp.chmod(path, mode)
556
except (IOError, paramiko.SSHException), e:
557
self._translate_io_exception(e, relpath, ': unable to append')
559
def rename(self, rel_from, rel_to):
560
"""Rename without special overwriting"""
562
self._sftp.rename(self._remote_path(rel_from),
563
self._remote_path(rel_to))
564
except (IOError, paramiko.SSHException), e:
565
self._translate_io_exception(e, rel_from,
566
': unable to rename to %r' % (rel_to))
568
def _rename_and_overwrite(self, abs_from, abs_to):
569
"""Do a fancy rename on the remote server.
571
Using the implementation provided by osutils.
574
fancy_rename(abs_from, abs_to,
575
rename_func=self._sftp.rename,
576
unlink_func=self._sftp.remove)
577
except (IOError, paramiko.SSHException), e:
578
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
580
def move(self, rel_from, rel_to):
581
"""Move the item at rel_from to the location at rel_to"""
582
path_from = self._remote_path(rel_from)
583
path_to = self._remote_path(rel_to)
584
self._rename_and_overwrite(path_from, path_to)
586
def delete(self, relpath):
587
"""Delete the item at relpath"""
588
path = self._remote_path(relpath)
590
self._sftp.remove(path)
591
except (IOError, paramiko.SSHException), e:
592
self._translate_io_exception(e, path, ': unable to delete')
595
"""Return True if this store supports listing."""
598
def list_dir(self, relpath):
600
Return a list of all files at the given location.
602
# does anything actually use this?
603
path = self._remote_path(relpath)
605
return self._sftp.listdir(path)
606
except (IOError, paramiko.SSHException), e:
607
self._translate_io_exception(e, path, ': failed to list_dir')
609
def rmdir(self, relpath):
610
"""See Transport.rmdir."""
611
path = self._remote_path(relpath)
613
return self._sftp.rmdir(path)
614
except (IOError, paramiko.SSHException), e:
615
self._translate_io_exception(e, path, ': failed to rmdir')
617
def stat(self, relpath):
618
"""Return the stat information for a file."""
619
path = self._remote_path(relpath)
621
return self._sftp.stat(path)
622
except (IOError, paramiko.SSHException), e:
623
self._translate_io_exception(e, path, ': unable to stat')
625
def lock_read(self, relpath):
627
Lock the given file for shared (read) access.
628
:return: A lock object, which has an unlock() member function
630
# FIXME: there should be something clever i can do here...
631
class BogusLock(object):
632
def __init__(self, path):
636
return BogusLock(relpath)
638
def lock_write(self, relpath):
640
Lock the given file for exclusive (write) access.
641
WARNING: many transports do not support this, so trying avoid using it
643
:return: A lock object, which has an unlock() member function
645
# This is a little bit bogus, but basically, we create a file
646
# which should not already exist, and if it does, we assume
647
# that there is a lock, and if it doesn't, the we assume
648
# that we have taken the lock.
649
return SFTPLock(relpath, self)
651
def _unparse_url(self, path=None):
654
path = urllib.quote(path)
655
# handle homedir paths
656
if not path.startswith('/'):
658
netloc = urllib.quote(self._host)
659
if self._username is not None:
660
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
661
if self._port is not None:
662
netloc = '%s:%d' % (netloc, self._port)
663
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
665
def _split_url(self, url):
666
(scheme, username, password, host, port, path) = split_url(url)
667
assert scheme == 'sftp'
669
# the initial slash should be removed from the path, and treated
670
# as a homedir relative path (the path begins with a double slash
671
# if it is absolute).
672
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
673
# RBC 20060118 we are not using this as its too user hostile. instead
674
# we are following lftp and using /~/foo to mean '~/foo'.
675
# handle homedir paths
676
if path.startswith('/~/'):
680
return (username, password, host, port, path)
682
def _parse_url(self, url):
683
(self._username, self._password,
684
self._host, self._port, self._path) = self._split_url(url)
686
def _sftp_connect(self):
687
"""Connect to the remote sftp server.
688
After this, self._sftp should have a valid connection (or
689
we raise an TransportError 'could not connect').
691
TODO: Raise a more reasonable ConnectionFailed exception
693
global _connected_hosts
695
idx = (self._host, self._port, self._username)
697
self._sftp = _connected_hosts[idx]
702
vendor = _get_ssh_vendor()
703
if vendor == 'loopback':
704
sock = socket.socket()
706
sock.connect((self._host, self._port))
707
except socket.error, e:
708
raise ConnectionError('Unable to connect to SSH host %s:%s: %s'
709
% (self._host, self._port, e))
710
self._sftp = SFTPClient(LoopbackSFTP(sock))
711
elif vendor != 'none':
712
sock = SFTPSubprocess(self._host, vendor, self._port,
714
self._sftp = SFTPClient(sock)
716
self._paramiko_connect()
718
_connected_hosts[idx] = self._sftp
720
def _paramiko_connect(self):
721
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
726
t = paramiko.Transport((self._host, self._port or 22))
727
t.set_log_channel('bzr.paramiko')
729
except paramiko.SSHException, e:
730
raise ConnectionError('Unable to reach SSH host %s:%s: %s'
731
% (self._host, self._port, e))
733
server_key = t.get_remote_server_key()
734
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
735
keytype = server_key.get_name()
736
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
737
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
738
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
739
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
740
our_server_key = BZR_HOSTKEYS[self._host][keytype]
741
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
743
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
744
if not BZR_HOSTKEYS.has_key(self._host):
745
BZR_HOSTKEYS[self._host] = {}
746
BZR_HOSTKEYS[self._host][keytype] = server_key
747
our_server_key = server_key
748
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
750
if server_key != our_server_key:
751
filename1 = os.path.expanduser('~/.ssh/known_hosts')
752
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
753
raise TransportError('Host keys for %s do not match! %s != %s' % \
754
(self._host, our_server_key_hex, server_key_hex),
755
['Try editing %s or %s' % (filename1, filename2)])
760
self._sftp = t.open_sftp_client()
761
except paramiko.SSHException, e:
762
raise ConnectionError('Unable to start sftp client %s:%d' %
763
(self._host, self._port), e)
765
def _sftp_auth(self, transport):
766
# paramiko requires a username, but it might be none if nothing was supplied
767
# use the local username, just in case.
768
# We don't override self._username, because if we aren't using paramiko,
769
# the username might be specified in ~/.ssh/config and we don't want to
770
# force it to something else
771
# Also, it would mess up the self.relpath() functionality
772
username = self._username or getpass.getuser()
774
# Paramiko tries to open a socket.AF_UNIX in order to connect
775
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
776
# so we get an AttributeError exception. For now, just don't try to
777
# connect to an agent if we are on win32
778
if sys.platform != 'win32':
779
agent = paramiko.Agent()
780
for key in agent.get_keys():
781
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
783
transport.auth_publickey(username, key)
785
except paramiko.SSHException, e:
788
# okay, try finding id_rsa or id_dss? (posix only)
789
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
791
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
796
transport.auth_password(username, self._password)
798
except paramiko.SSHException, e:
801
# FIXME: Don't keep a password held in memory if you can help it
802
#self._password = None
804
# give up and ask for a password
805
password = bzrlib.ui.ui_factory.get_password(
806
prompt='SSH %(user)s@%(host)s password',
807
user=username, host=self._host)
809
transport.auth_password(username, password)
810
except paramiko.SSHException, e:
811
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
812
(username, self._host), e)
814
def _try_pkey_auth(self, transport, pkey_class, username, filename):
815
filename = os.path.expanduser('~/.ssh/' + filename)
817
key = pkey_class.from_private_key_file(filename)
818
transport.auth_publickey(username, key)
820
except paramiko.PasswordRequiredException:
821
password = bzrlib.ui.ui_factory.get_password(
822
prompt='SSH %(filename)s password',
825
key = pkey_class.from_private_key_file(filename, password)
826
transport.auth_publickey(username, key)
828
except paramiko.SSHException:
829
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
830
except paramiko.SSHException:
831
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
836
def _sftp_open_exclusive(self, abspath, mode=None):
837
"""Open a remote path exclusively.
839
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
840
the file already exists. However it does not expose this
841
at the higher level of SFTPClient.open(), so we have to
844
WARNING: This breaks the SFTPClient abstraction, so it
845
could easily break against an updated version of paramiko.
847
:param abspath: The remote absolute path where the file should be opened
848
:param mode: The mode permissions bits for the new file
850
path = self._sftp._adjust_cwd(abspath)
851
attr = SFTPAttributes()
854
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
855
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
857
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
859
raise TransportError('Expected an SFTP handle')
860
handle = msg.get_string()
861
return SFTPFile(self._sftp, handle, 'wb', -1)
862
except (paramiko.SSHException, IOError), e:
863
self._translate_io_exception(e, abspath, ': unable to open',
864
failure_exc=FileExists)
867
# ------------- server test implementation --------------
871
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
873
STUB_SERVER_KEY = """
874
-----BEGIN RSA PRIVATE KEY-----
875
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
876
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
877
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
878
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
879
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
880
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
881
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
882
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
883
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
884
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
885
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
886
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
887
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
888
-----END RSA PRIVATE KEY-----
892
class SingleListener(threading.Thread):
894
def __init__(self, callback):
895
threading.Thread.__init__(self)
896
self._callback = callback
897
self._socket = socket.socket()
898
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
899
self._socket.bind(('localhost', 0))
900
self._socket.listen(1)
901
self.port = self._socket.getsockname()[1]
902
self.stop_event = threading.Event()
905
s, _ = self._socket.accept()
906
# now close the listen socket
909
self._callback(s, self.stop_event)
911
pass #Ignore socket errors
913
# probably a failed test
914
warning('Exception from within unit test server thread: %r' % x)
917
self.stop_event.set()
918
# use a timeout here, because if the test fails, the server thread may
919
# never notice the stop_event.
923
class SFTPServer(Server):
924
"""Common code for SFTP server facilities."""
927
self._original_vendor = None
929
self._server_homedir = None
930
self._listener = None
932
self._vendor = 'none'
936
def _get_sftp_url(self, path):
937
"""Calculate an sftp url to this server for path."""
938
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
940
def log(self, message):
941
"""StubServer uses this to log when a new server is created."""
942
self.logs.append(message)
944
def _run_server(self, s, stop_event):
945
ssh_server = paramiko.Transport(s)
946
key_file = os.path.join(self._homedir, 'test_rsa.key')
947
file(key_file, 'w').write(STUB_SERVER_KEY)
948
host_key = paramiko.RSAKey.from_private_key_file(key_file)
949
ssh_server.add_server_key(host_key)
950
server = StubServer(self)
951
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
952
StubSFTPServer, root=self._root,
953
home=self._server_homedir)
954
event = threading.Event()
955
ssh_server.start_server(event, server)
957
stop_event.wait(30.0)
961
self._original_vendor = _ssh_vendor
962
_ssh_vendor = self._vendor
963
self._homedir = os.getcwd()
964
if self._server_homedir is None:
965
self._server_homedir = self._homedir
967
# FIXME WINDOWS: _root should be _server_homedir[0]:/
968
self._listener = SingleListener(self._run_server)
969
self._listener.setDaemon(True)
970
self._listener.start()
973
"""See bzrlib.transport.Server.tearDown."""
975
self._listener.stop()
976
_ssh_vendor = self._original_vendor
978
def get_bogus_url(self):
979
"""See bzrlib.transport.Server.get_bogus_url."""
980
# this is chosen to try to prevent trouble with proxies, wierd dns,
982
return 'sftp://127.0.0.1:1/'
986
class SFTPFullAbsoluteServer(SFTPServer):
987
"""A test server for sftp transports, using absolute urls and ssh."""
990
"""See bzrlib.transport.Server.get_url."""
991
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
994
class SFTPServerWithoutSSH(SFTPServer):
995
"""An SFTP server that uses a simple TCP socket pair rather than SSH."""
998
super(SFTPServerWithoutSSH, self).__init__()
999
self._vendor = 'loopback'
1001
def _run_server(self, sock, stop_event):
1002
class FakeChannel(object):
1003
def get_transport(self):
1005
def get_log_channel(self):
1009
def get_hexdump(self):
1014
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
1015
root=self._root, home=self._server_homedir)
1016
server.start_subsystem('sftp', None, sock)
1017
server.finish_subsystem()
1020
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
1021
"""A test server for sftp transports, using absolute urls."""
1024
"""See bzrlib.transport.Server.get_url."""
1025
return self._get_sftp_url(urlutils.escape(self._homedir[1:]))
1028
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1029
"""A test server for sftp transports, using homedir relative urls."""
1032
"""See bzrlib.transport.Server.get_url."""
1033
return self._get_sftp_url("~/")
1036
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1037
"""A test servere for sftp transports, using absolute urls to non-home."""
1040
self._server_homedir = '/dev/noone/runs/tests/here'
1041
super(SFTPSiblingAbsoluteServer, self).setUp()
1044
def get_test_permutations():
1045
"""Return the permutations to be used in testing."""
1046
return [(SFTPTransport, SFTPAbsoluteServer),
1047
(SFTPTransport, SFTPHomeDirServer),
1048
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
