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()
147
class LoopbackSFTP(object):
148
"""Simple wrapper for a socket that pretends to be a paramiko Channel."""
150
def __init__(self, sock):
153
def send(self, data):
154
return self.__socket.send(data)
157
return self.__socket.recv(n)
159
def recv_ready(self):
163
self.__socket.close()
169
# This is a weakref dictionary, so that we can reuse connections
170
# that are still active. Long term, it might be nice to have some
171
# sort of expiration policy, such as disconnect if inactive for
172
# X seconds. But that requires a lot more fanciness.
173
_connected_hosts = weakref.WeakValueDictionary()
176
def load_host_keys():
178
Load system host keys (probably doesn't work on windows) and any
179
"discovered" keys from previous sessions.
181
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
183
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
185
mutter('failed to load system host keys: ' + str(e))
186
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
188
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
190
mutter('failed to load bzr host keys: ' + str(e))
194
def save_host_keys():
196
Save "discovered" host keys in $(config)/ssh_host_keys/.
198
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
199
bzr_hostkey_path = pathjoin(config_dir(), 'ssh_host_keys')
200
ensure_config_dir_exists()
203
f = open(bzr_hostkey_path, 'w')
204
f.write('# SSH host keys collected by bzr\n')
205
for hostname, keys in BZR_HOSTKEYS.iteritems():
206
for keytype, key in keys.iteritems():
207
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
210
mutter('failed to save bzr host keys: ' + str(e))
213
class SFTPLock(object):
214
"""This fakes a lock in a remote location."""
215
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
216
def __init__(self, path, transport):
217
assert isinstance(transport, SFTPTransport)
219
self.lock_file = None
221
self.lock_path = path + '.write-lock'
222
self.transport = transport
224
# RBC 20060103 FIXME should we be using private methods here ?
225
abspath = transport._remote_path(self.lock_path)
226
self.lock_file = transport._sftp_open_exclusive(abspath)
228
raise LockError('File %r already locked' % (self.path,))
231
"""Should this warn, or actually try to cleanup?"""
233
warning("SFTPLock %r not explicitly unlocked" % (self.path,))
237
if not self.lock_file:
239
self.lock_file.close()
240
self.lock_file = None
242
self.transport.delete(self.lock_path)
243
except (NoSuchFile,):
244
# What specific errors should we catch here?
248
class SFTPTransport (Transport):
250
Transport implementation for SFTP access.
252
_do_prefetch = False # Right now Paramiko's prefetch support causes things to hang
254
def __init__(self, base, clone_from=None):
255
assert base.startswith('sftp://')
256
self._parse_url(base)
257
base = self._unparse_url()
260
super(SFTPTransport, self).__init__(base)
261
if clone_from is None:
264
# use the same ssh connection, etc
265
self._sftp = clone_from._sftp
266
# super saves 'self.base'
268
def should_cache(self):
270
Return True if the data pulled across should be cached locally.
274
def clone(self, offset=None):
276
Return a new SFTPTransport with root at self.base + offset.
277
We share the same SFTP session between such transports, because it's
278
fairly expensive to set them up.
281
return SFTPTransport(self.base, self)
283
return SFTPTransport(self.abspath(offset), self)
285
def abspath(self, relpath):
287
Return the full url to the given relative path.
289
@param relpath: the relative path or path components
290
@type relpath: str or list
292
return self._unparse_url(self._remote_path(relpath))
294
def _remote_path(self, relpath):
295
"""Return the path to be passed along the sftp protocol for relpath.
297
relpath is a urlencoded string.
299
# FIXME: share the common code across transports
300
assert isinstance(relpath, basestring)
301
relpath = urllib.unquote(relpath).split('/')
302
basepath = self._path.split('/')
303
if len(basepath) > 0 and basepath[-1] == '':
304
basepath = basepath[:-1]
308
if len(basepath) == 0:
309
# In most filesystems, a request for the parent
310
# of root, just returns root.
318
path = '/'.join(basepath)
321
def relpath(self, abspath):
322
username, password, host, port, path = self._split_url(abspath)
324
if (username != self._username):
325
error.append('username mismatch')
326
if (host != self._host):
327
error.append('host mismatch')
328
if (port != self._port):
329
error.append('port mismatch')
330
if (not path.startswith(self._path)):
331
error.append('path mismatch')
333
extra = ': ' + ', '.join(error)
334
raise PathNotChild(abspath, self.base, extra=extra)
336
return path[pl:].strip('/')
338
def has(self, relpath):
340
Does the target location exist?
343
self._sftp.stat(self._remote_path(relpath))
348
def get(self, relpath, decode=False):
350
Get the file at the given relative path.
352
:param relpath: The relative path to the file
355
path = self._remote_path(relpath)
356
f = self._sftp.file(path, mode='rb')
357
if self._do_prefetch and hasattr(f, 'prefetch'):
360
except (IOError, paramiko.SSHException), e:
361
self._translate_io_exception(e, path, ': error retrieving')
363
def get_partial(self, relpath, start, length=None):
365
Get just part of a file.
367
:param relpath: Path to the file, relative to base
368
:param start: The starting position to read from
369
:param length: The length to read. A length of None indicates
370
read to the end of the file.
371
:return: A file-like object containing at least the specified bytes.
372
Some implementations may return objects which can be read
373
past this length, but this is not guaranteed.
375
# TODO: implement get_partial_multi to help with knit support
376
f = self.get(relpath)
378
if self._do_prefetch and hasattr(f, 'prefetch'):
382
def put(self, relpath, f, mode=None):
384
Copy the file-like or string object into the location.
386
:param relpath: Location to put the contents, relative to base.
387
:param f: File-like or string object.
388
:param mode: The final mode for the file
390
final_path = self._remote_path(relpath)
391
self._put(final_path, f, mode=mode)
393
def _put(self, abspath, f, mode=None):
394
"""Helper function so both put() and copy_abspaths can reuse the code"""
395
tmp_abspath = '%s.tmp.%.9f.%d.%d' % (abspath, time.time(),
396
os.getpid(), random.randint(0,0x7FFFFFFF))
397
fout = self._sftp_open_exclusive(tmp_abspath, mode=mode)
401
fout.set_pipelined(True)
403
except (IOError, paramiko.SSHException), e:
404
self._translate_io_exception(e, tmp_abspath)
406
self._sftp.chmod(tmp_abspath, mode)
409
self._rename(tmp_abspath, abspath)
411
# If we fail, try to clean up the temporary file
412
# before we throw the exception
413
# but don't let another exception mess things up
414
# Write out the traceback, because otherwise
415
# the catch and throw destroys it
417
mutter(traceback.format_exc())
421
self._sftp.remove(tmp_abspath)
423
# raise the saved except
425
# raise the original with its traceback if we can.
428
def iter_files_recursive(self):
429
"""Walk the relative paths of all files in this transport."""
430
queue = list(self.list_dir('.'))
432
relpath = urllib.quote(queue.pop(0))
433
st = self.stat(relpath)
434
if stat.S_ISDIR(st.st_mode):
435
for i, basename in enumerate(self.list_dir(relpath)):
436
queue.insert(i, relpath+'/'+basename)
440
def mkdir(self, relpath, mode=None):
441
"""Create a directory at the given path."""
443
path = self._remote_path(relpath)
444
# In the paramiko documentation, it says that passing a mode flag
445
# will filtered against the server umask.
446
# StubSFTPServer does not do this, which would be nice, because it is
447
# what we really want :)
448
# However, real servers do use umask, so we really should do it that way
449
self._sftp.mkdir(path)
451
self._sftp.chmod(path, mode=mode)
452
except (paramiko.SSHException, IOError), e:
453
self._translate_io_exception(e, path, ': unable to mkdir',
454
failure_exc=FileExists)
456
def _translate_io_exception(self, e, path, more_info='', failure_exc=NoSuchFile):
457
"""Translate a paramiko or IOError into a friendlier exception.
459
:param e: The original exception
460
:param path: The path in question when the error is raised
461
:param more_info: Extra information that can be included,
462
such as what was going on
463
:param failure_exc: Paramiko has the super fun ability to raise completely
464
opaque errors that just set "e.args = ('Failure',)" with
466
This sometimes means FileExists, but it also sometimes
469
# paramiko seems to generate detailless errors.
470
self._translate_error(e, path, raise_generic=False)
471
if hasattr(e, 'args'):
472
if (e.args == ('No such file or directory',) or
473
e.args == ('No such file',)):
474
raise NoSuchFile(path, str(e) + more_info)
475
if (e.args == ('mkdir failed',)):
476
raise FileExists(path, str(e) + more_info)
477
# strange but true, for the paramiko server.
478
if (e.args == ('Failure',)):
479
raise failure_exc(path, str(e) + more_info)
480
mutter('Raising exception with args %s', e.args)
481
if hasattr(e, 'errno'):
482
mutter('Raising exception with errno %s', e.errno)
485
def append(self, relpath, f):
487
Append the text in the file-like object into the final
491
path = self._remote_path(relpath)
492
fout = self._sftp.file(path, 'ab')
494
except (IOError, paramiko.SSHException), e:
495
self._translate_io_exception(e, relpath, ': unable to append')
497
def copy(self, rel_from, rel_to):
498
"""Copy the item at rel_from to the location at rel_to"""
499
path_from = self._remote_path(rel_from)
500
path_to = self._remote_path(rel_to)
501
self._copy_abspaths(path_from, path_to)
503
def _copy_abspaths(self, path_from, path_to, mode=None):
504
"""Copy files given an absolute path
506
:param path_from: Path on remote server to read
507
:param path_to: Path on remote server to write
510
TODO: Should the destination location be atomically created?
511
This has not been specified
512
TODO: This should use some sort of remote copy, rather than
513
pulling the data locally, and then writing it remotely
516
fin = self._sftp.file(path_from, 'rb')
518
self._put(path_to, fin, mode=mode)
521
except (IOError, paramiko.SSHException), e:
522
self._translate_io_exception(e, path_from, ': unable copy to: %r' % path_to)
524
def copy_to(self, relpaths, other, mode=None, pb=None):
525
"""Copy a set of entries from self into another Transport.
527
:param relpaths: A list/generator of entries to be copied.
529
if isinstance(other, SFTPTransport) and other._sftp is self._sftp:
530
# Both from & to are on the same remote filesystem
531
# We can use a remote copy, instead of pulling locally, and pushing
533
total = self._get_total(relpaths)
535
for path in relpaths:
536
path_from = self._remote_path(relpath)
537
path_to = other._remote_path(relpath)
538
self._update_pb(pb, 'copy-to', count, total)
539
self._copy_abspaths(path_from, path_to, mode=mode)
543
return super(SFTPTransport, self).copy_to(relpaths, other, mode=mode, pb=pb)
545
def _rename(self, abs_from, abs_to):
546
"""Do a fancy rename on the remote server.
548
Using the implementation provided by osutils.
551
fancy_rename(abs_from, abs_to,
552
rename_func=self._sftp.rename,
553
unlink_func=self._sftp.remove)
554
except (IOError, paramiko.SSHException), e:
555
self._translate_io_exception(e, abs_from, ': unable to rename to %r' % (abs_to))
557
def move(self, rel_from, rel_to):
558
"""Move the item at rel_from to the location at rel_to"""
559
path_from = self._remote_path(rel_from)
560
path_to = self._remote_path(rel_to)
561
self._rename(path_from, path_to)
563
def delete(self, relpath):
564
"""Delete the item at relpath"""
565
path = self._remote_path(relpath)
567
self._sftp.remove(path)
568
except (IOError, paramiko.SSHException), e:
569
self._translate_io_exception(e, path, ': unable to delete')
572
"""Return True if this store supports listing."""
575
def list_dir(self, relpath):
577
Return a list of all files at the given location.
579
# does anything actually use this?
580
path = self._remote_path(relpath)
582
return self._sftp.listdir(path)
583
except (IOError, paramiko.SSHException), e:
584
self._translate_io_exception(e, path, ': failed to list_dir')
586
def stat(self, relpath):
587
"""Return the stat information for a file."""
588
path = self._remote_path(relpath)
590
return self._sftp.stat(path)
591
except (IOError, paramiko.SSHException), e:
592
self._translate_io_exception(e, path, ': unable to stat')
594
def lock_read(self, relpath):
596
Lock the given file for shared (read) access.
597
:return: A lock object, which has an unlock() member function
599
# FIXME: there should be something clever i can do here...
600
class BogusLock(object):
601
def __init__(self, path):
605
return BogusLock(relpath)
607
def lock_write(self, relpath):
609
Lock the given file for exclusive (write) access.
610
WARNING: many transports do not support this, so trying avoid using it
612
:return: A lock object, which has an unlock() member function
614
# This is a little bit bogus, but basically, we create a file
615
# which should not already exist, and if it does, we assume
616
# that there is a lock, and if it doesn't, the we assume
617
# that we have taken the lock.
618
return SFTPLock(relpath, self)
620
def _unparse_url(self, path=None):
623
path = urllib.quote(path)
624
# handle homedir paths
625
if not path.startswith('/'):
627
netloc = urllib.quote(self._host)
628
if self._username is not None:
629
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
630
if self._port is not None:
631
netloc = '%s:%d' % (netloc, self._port)
633
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
635
def _split_url(self, url):
636
if isinstance(url, unicode):
637
url = url.encode('utf-8')
638
(scheme, netloc, path, params,
639
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
640
assert scheme == 'sftp'
641
username = password = host = port = None
643
username, host = netloc.split('@', 1)
645
username, password = username.split(':', 1)
646
password = urllib.unquote(password)
647
username = urllib.unquote(username)
652
host, port = host.rsplit(':', 1)
656
# TODO: Should this be ConnectionError?
657
raise TransportError('%s: invalid port number' % port)
658
host = urllib.unquote(host)
660
path = urllib.unquote(path)
662
# the initial slash should be removed from the path, and treated
663
# as a homedir relative path (the path begins with a double slash
664
# if it is absolute).
665
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
666
# RBC 20060118 we are not using this as its too user hostile. instead
667
# we are following lftp and using /~/foo to mean '~/foo'.
668
# handle homedir paths
669
if path.startswith('/~/'):
673
return (username, password, host, port, path)
675
def _parse_url(self, url):
676
(self._username, self._password,
677
self._host, self._port, self._path) = self._split_url(url)
679
def _sftp_connect(self):
680
"""Connect to the remote sftp server.
681
After this, self._sftp should have a valid connection (or
682
we raise an TransportError 'could not connect').
684
TODO: Raise a more reasonable ConnectionFailed exception
686
global _connected_hosts
688
idx = (self._host, self._port, self._username)
690
self._sftp = _connected_hosts[idx]
695
vendor = _get_ssh_vendor()
696
if vendor == 'loopback':
697
sock = socket.socket()
698
sock.connect((self._host, self._port))
699
self._sftp = SFTPClient(LoopbackSFTP(sock))
700
elif vendor != 'none':
701
sock = SFTPSubprocess(self._host, vendor, self._port,
703
self._sftp = SFTPClient(sock)
705
self._paramiko_connect()
707
_connected_hosts[idx] = self._sftp
709
def _paramiko_connect(self):
710
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
715
t = paramiko.Transport((self._host, self._port or 22))
716
t.set_log_channel('bzr.paramiko')
718
except paramiko.SSHException, e:
719
raise ConnectionError('Unable to reach SSH host %s:%d' %
720
(self._host, self._port), e)
722
server_key = t.get_remote_server_key()
723
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
724
keytype = server_key.get_name()
725
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
726
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
727
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
728
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
729
our_server_key = BZR_HOSTKEYS[self._host][keytype]
730
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
732
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
733
if not BZR_HOSTKEYS.has_key(self._host):
734
BZR_HOSTKEYS[self._host] = {}
735
BZR_HOSTKEYS[self._host][keytype] = server_key
736
our_server_key = server_key
737
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
739
if server_key != our_server_key:
740
filename1 = os.path.expanduser('~/.ssh/known_hosts')
741
filename2 = pathjoin(config_dir(), 'ssh_host_keys')
742
raise TransportError('Host keys for %s do not match! %s != %s' % \
743
(self._host, our_server_key_hex, server_key_hex),
744
['Try editing %s or %s' % (filename1, filename2)])
749
self._sftp = t.open_sftp_client()
750
except paramiko.SSHException, e:
751
raise ConnectionError('Unable to start sftp client %s:%d' %
752
(self._host, self._port), e)
754
def _sftp_auth(self, transport):
755
# paramiko requires a username, but it might be none if nothing was supplied
756
# use the local username, just in case.
757
# We don't override self._username, because if we aren't using paramiko,
758
# the username might be specified in ~/.ssh/config and we don't want to
759
# force it to something else
760
# Also, it would mess up the self.relpath() functionality
761
username = self._username or getpass.getuser()
763
# Paramiko tries to open a socket.AF_UNIX in order to connect
764
# to ssh-agent. That attribute doesn't exist on win32 (it does in cygwin)
765
# so we get an AttributeError exception. For now, just don't try to
766
# connect to an agent if we are on win32
767
if sys.platform != 'win32':
768
agent = paramiko.Agent()
769
for key in agent.get_keys():
770
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
772
transport.auth_publickey(username, key)
774
except paramiko.SSHException, e:
777
# okay, try finding id_rsa or id_dss? (posix only)
778
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
780
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
785
transport.auth_password(username, self._password)
787
except paramiko.SSHException, e:
790
# FIXME: Don't keep a password held in memory if you can help it
791
#self._password = None
793
# give up and ask for a password
794
password = bzrlib.ui.ui_factory.get_password(
795
prompt='SSH %(user)s@%(host)s password',
796
user=username, host=self._host)
798
transport.auth_password(username, password)
799
except paramiko.SSHException, e:
800
raise ConnectionError('Unable to authenticate to SSH host as %s@%s' %
801
(username, self._host), e)
803
def _try_pkey_auth(self, transport, pkey_class, username, filename):
804
filename = os.path.expanduser('~/.ssh/' + filename)
806
key = pkey_class.from_private_key_file(filename)
807
transport.auth_publickey(username, key)
809
except paramiko.PasswordRequiredException:
810
password = bzrlib.ui.ui_factory.get_password(
811
prompt='SSH %(filename)s password',
814
key = pkey_class.from_private_key_file(filename, password)
815
transport.auth_publickey(username, key)
817
except paramiko.SSHException:
818
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
819
except paramiko.SSHException:
820
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
825
def _sftp_open_exclusive(self, abspath, mode=None):
826
"""Open a remote path exclusively.
828
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
829
the file already exists. However it does not expose this
830
at the higher level of SFTPClient.open(), so we have to
833
WARNING: This breaks the SFTPClient abstraction, so it
834
could easily break against an updated version of paramiko.
836
:param abspath: The remote absolute path where the file should be opened
837
:param mode: The mode permissions bits for the new file
839
path = self._sftp._adjust_cwd(abspath)
840
attr = SFTPAttributes()
843
omode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
844
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
846
t, msg = self._sftp._request(CMD_OPEN, path, omode, attr)
848
raise TransportError('Expected an SFTP handle')
849
handle = msg.get_string()
850
return SFTPFile(self._sftp, handle, 'wb', -1)
851
except (paramiko.SSHException, IOError), e:
852
self._translate_io_exception(e, abspath, ': unable to open',
853
failure_exc=FileExists)
856
# ------------- server test implementation --------------
860
from bzrlib.tests.stub_sftp import StubServer, StubSFTPServer
862
STUB_SERVER_KEY = """
863
-----BEGIN RSA PRIVATE KEY-----
864
MIICWgIBAAKBgQDTj1bqB4WmayWNPB+8jVSYpZYk80Ujvj680pOTh2bORBjbIAyz
865
oWGW+GUjzKxTiiPvVmxFgx5wdsFvF03v34lEVVhMpouqPAYQ15N37K/ir5XY+9m/
866
d8ufMCkjeXsQkKqFbAlQcnWMCRnOoPHS3I4vi6hmnDDeeYTSRvfLbW0fhwIBIwKB
867
gBIiOqZYaoqbeD9OS9z2K9KR2atlTxGxOJPXiP4ESqP3NVScWNwyZ3NXHpyrJLa0
868
EbVtzsQhLn6rF+TzXnOlcipFvjsem3iYzCpuChfGQ6SovTcOjHV9z+hnpXvQ/fon
869
soVRZY65wKnF7IAoUwTmJS9opqgrN6kRgCd3DASAMd1bAkEA96SBVWFt/fJBNJ9H
870
tYnBKZGw0VeHOYmVYbvMSstssn8un+pQpUm9vlG/bp7Oxd/m+b9KWEh2xPfv6zqU
871
avNwHwJBANqzGZa/EpzF4J8pGti7oIAPUIDGMtfIcmqNXVMckrmzQ2vTfqtkEZsA
872
4rE1IERRyiJQx6EJsz21wJmGV9WJQ5kCQQDwkS0uXqVdFzgHO6S++tjmjYcxwr3g
873
H0CoFYSgbddOT6miqRskOQF3DZVkJT3kyuBgU2zKygz52ukQZMqxCb1fAkASvuTv
874
qfpH87Qq5kQhNKdbbwbmd2NxlNabazPijWuphGTdW0VfJdWfklyS2Kr+iqrs/5wV
875
HhathJt636Eg7oIjAkA8ht3MQ+XSl9yIJIS8gVpbPxSw5OMfw0PjVE7tBdQruiSc
876
nvuQES5C9BMHjF39LZiGH1iLQy7FgdHyoP+eodI7
877
-----END RSA PRIVATE KEY-----
881
class SingleListener(threading.Thread):
883
def __init__(self, callback):
884
threading.Thread.__init__(self)
885
self._callback = callback
886
self._socket = socket.socket()
887
self._socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
888
self._socket.bind(('localhost', 0))
889
self._socket.listen(1)
890
self.port = self._socket.getsockname()[1]
891
self.stop_event = threading.Event()
894
s, _ = self._socket.accept()
895
# now close the listen socket
898
self._callback(s, self.stop_event)
900
# probably a failed test
901
warning('Exception from within unit test server thread: %r' % x)
904
self.stop_event.set()
905
# use a timeout here, because if the test fails, the server thread may
906
# never notice the stop_event.
910
class SFTPServer(Server):
911
"""Common code for SFTP server facilities."""
914
self._original_vendor = None
916
self._server_homedir = None
917
self._listener = None
919
self._vendor = 'none'
923
def _get_sftp_url(self, path):
924
"""Calculate an sftp url to this server for path."""
925
return 'sftp://foo:bar@localhost:%d/%s' % (self._listener.port, path)
927
def log(self, message):
928
"""StubServer uses this to log when a new server is created."""
929
self.logs.append(message)
931
def _run_server(self, s, stop_event):
932
ssh_server = paramiko.Transport(s)
933
key_file = os.path.join(self._homedir, 'test_rsa.key')
934
file(key_file, 'w').write(STUB_SERVER_KEY)
935
host_key = paramiko.RSAKey.from_private_key_file(key_file)
936
ssh_server.add_server_key(host_key)
937
server = StubServer(self)
938
ssh_server.set_subsystem_handler('sftp', paramiko.SFTPServer,
939
StubSFTPServer, root=self._root,
940
home=self._server_homedir)
941
event = threading.Event()
942
ssh_server.start_server(event, server)
944
stop_event.wait(30.0)
948
self._original_vendor = _ssh_vendor
949
_ssh_vendor = self._vendor
950
self._homedir = os.getcwdu()
951
if self._server_homedir is None:
952
self._server_homedir = self._homedir
954
# FIXME WINDOWS: _root should be _server_homedir[0]:/
955
self._listener = SingleListener(self._run_server)
956
self._listener.setDaemon(True)
957
self._listener.start()
960
"""See bzrlib.transport.Server.tearDown."""
962
self._listener.stop()
963
_ssh_vendor = self._original_vendor
966
class SFTPServerWithoutSSH(SFTPServer):
968
Common code for an SFTP server over a clear TCP loopback socket,
969
instead of over an SSH secured socket.
973
super(SFTPServerWithoutSSH, self).__init__()
974
self._vendor = 'loopback'
976
def _run_server(self, sock, stop_event):
977
class FakeChannel(object):
978
def get_transport(self):
980
def get_log_channel(self):
984
def get_hexdump(self):
987
server = paramiko.SFTPServer(FakeChannel(), 'sftp', StubServer(self), StubSFTPServer,
988
root=self._root, home=self._server_homedir)
989
server.start_subsystem('sftp', None, sock)
990
server.finish_subsystem()
993
class SFTPAbsoluteServer(SFTPServerWithoutSSH):
994
"""A test server for sftp transports, using absolute urls."""
997
"""See bzrlib.transport.Server.get_url."""
998
return self._get_sftp_url(urlescape(self._homedir[1:]))
1001
class SFTPHomeDirServer(SFTPServerWithoutSSH):
1002
"""A test server for sftp transports, using homedir relative urls."""
1005
"""See bzrlib.transport.Server.get_url."""
1006
return self._get_sftp_url("~/")
1009
class SFTPSiblingAbsoluteServer(SFTPAbsoluteServer):
1010
"""A test servere for sftp transports, using absolute urls to non-home."""
1013
self._server_homedir = '/dev/noone/runs/tests/here'
1014
super(SFTPSiblingAbsoluteServer, self).setUp()
1017
def get_test_permutations():
1018
"""Return the permutations to be used in testing."""
1019
return [(SFTPTransport, SFTPAbsoluteServer),
1020
(SFTPTransport, SFTPHomeDirServer),
1021
(SFTPTransport, SFTPSiblingAbsoluteServer),
added
removed
bzrlib/transport/sftp.py
