1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
|
# Copyright (C) 2005 Robey Pointer <robey@lag.net>, Canonical Ltd
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""Implementation of Transport over SFTP, using paramiko."""
import errno
import getpass
import os
import re
import stat
import sys
import urllib
import urlparse
import time
import random
import subprocess
import weakref
from bzrlib.errors import (FileExists,
TransportNotPossible, NoSuchFile, NonRelativePath,
TransportError,
LockError)
from bzrlib.config import config_dir
from bzrlib.trace import mutter, warning, error
from bzrlib.transport import Transport, register_transport
from bzrlib.ui import ui_factory
try:
import paramiko
except ImportError:
error('The SFTP transport requires paramiko.')
raise
else:
from paramiko.sftp import (SFTP_FLAG_WRITE, SFTP_FLAG_CREATE,
SFTP_FLAG_EXCL, SFTP_FLAG_TRUNC,
CMD_HANDLE, CMD_OPEN)
from paramiko.sftp_attr import SFTPAttributes
from paramiko.sftp_file import SFTPFile
from paramiko.sftp_client import SFTPClient
if 'sftp' not in urlparse.uses_netloc: urlparse.uses_netloc.append('sftp')
_close_fds = True
if sys.platform == 'win32':
# close_fds not supported on win32
_close_fds = False
_ssh_vendor = None
def _get_ssh_vendor():
"""Find out what version of SSH is on the system."""
global _ssh_vendor
if _ssh_vendor is not None:
return _ssh_vendor
_ssh_vendor = 'none'
try:
p = subprocess.Popen(['ssh', '-V'],
close_fds=_close_fds,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
returncode = p.returncode
stdout, stderr = p.communicate()
except OSError:
returncode = -1
stdout = stderr = ''
if 'OpenSSH' in stderr:
mutter('ssh implementation is OpenSSH')
_ssh_vendor = 'openssh'
elif 'SSH Secure Shell' in stderr:
mutter('ssh implementation is SSH Corp.')
_ssh_vendor = 'ssh'
if _ssh_vendor != 'none':
return _ssh_vendor
# XXX: 20051123 jamesh
# A check for putty's plink or lsh would go here.
mutter('falling back to paramiko implementation')
return _ssh_vendor
class SFTPSubprocess:
"""A socket-like object that talks to an ssh subprocess via pipes."""
def __init__(self, hostname, port=None, user=None):
vendor = _get_ssh_vendor()
assert vendor in ['openssh', 'ssh']
if vendor == 'openssh':
args = ['ssh',
'-oForwardX11=no', '-oForwardAgent=no',
'-oClearAllForwardings=yes', '-oProtocol=2',
'-oNoHostAuthenticationForLocalhost=yes']
if port is not None:
args.extend(['-p', str(port)])
if user is not None:
args.extend(['-l', user])
args.extend(['-s', hostname, 'sftp'])
elif vendor == 'ssh':
args = ['ssh', '-x']
if port is not None:
args.extend(['-p', str(port)])
if user is not None:
args.extend(['-l', user])
args.extend(['-s', 'sftp', hostname])
self.proc = subprocess.Popen(args, close_fds=_close_fds,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE)
def send(self, data):
return os.write(self.proc.stdin.fileno(), data)
def recv(self, count):
return os.read(self.proc.stdout.fileno(), count)
def close(self):
self.proc.stdin.close()
self.proc.stdout.close()
self.proc.wait()
SYSTEM_HOSTKEYS = {}
BZR_HOSTKEYS = {}
# This is a weakref dictionary, so that we can reuse connections
# that are still active. Long term, it might be nice to have some
# sort of expiration policy, such as disconnect if inactive for
# X seconds. But that requires a lot more fanciness.
_connected_hosts = weakref.WeakValueDictionary()
def load_host_keys():
"""
Load system host keys (probably doesn't work on windows) and any
"discovered" keys from previous sessions.
"""
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
try:
SYSTEM_HOSTKEYS = paramiko.util.load_host_keys(os.path.expanduser('~/.ssh/known_hosts'))
except Exception, e:
mutter('failed to load system host keys: ' + str(e))
bzr_hostkey_path = os.path.join(config_dir(), 'ssh_host_keys')
try:
BZR_HOSTKEYS = paramiko.util.load_host_keys(bzr_hostkey_path)
except Exception, e:
mutter('failed to load bzr host keys: ' + str(e))
save_host_keys()
def save_host_keys():
"""
Save "discovered" host keys in $(config)/ssh_host_keys/.
"""
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
bzr_hostkey_path = os.path.join(config_dir(), 'ssh_host_keys')
if not os.path.isdir(config_dir()):
os.mkdir(config_dir())
try:
f = open(bzr_hostkey_path, 'w')
f.write('# SSH host keys collected by bzr\n')
for hostname, keys in BZR_HOSTKEYS.iteritems():
for keytype, key in keys.iteritems():
f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
f.close()
except IOError, e:
mutter('failed to save bzr host keys: ' + str(e))
class SFTPTransportError (TransportError):
pass
class SFTPLock(object):
"""This fakes a lock in a remote location."""
__slots__ = ['path', 'lock_path', 'lock_file', 'transport']
def __init__(self, path, transport):
assert isinstance(transport, SFTPTransport)
self.lock_file = None
self.path = path
self.lock_path = path + '.write-lock'
self.transport = transport
try:
self.lock_file = transport._sftp_open_exclusive(self.lock_path)
except FileExists:
raise LockError('File %r already locked' % (self.path,))
def __del__(self):
"""Should this warn, or actually try to cleanup?"""
if self.lock_file:
warn("SFTPLock %r not explicitly unlocked" % (self.path,))
self.unlock()
def unlock(self):
if not self.lock_file:
return
self.lock_file.close()
self.lock_file = None
try:
self.transport.delete(self.lock_path)
except (NoSuchFile,):
# What specific errors should we catch here?
pass
class SFTPTransport (Transport):
"""
Transport implementation for SFTP access.
"""
_do_prefetch = False # Right now Paramiko's prefetch support causes things to hang
def __init__(self, base, clone_from=None):
assert base.startswith('sftp://')
self._parse_url(base)
base = self._unparse_url()
super(SFTPTransport, self).__init__(base)
if clone_from is None:
self._sftp_connect()
else:
# use the same ssh connection, etc
self._sftp = clone_from._sftp
# super saves 'self.base'
def should_cache(self):
"""
Return True if the data pulled across should be cached locally.
"""
return True
def clone(self, offset=None):
"""
Return a new SFTPTransport with root at self.base + offset.
We share the same SFTP session between such transports, because it's
fairly expensive to set them up.
"""
if offset is None:
return SFTPTransport(self.base, self)
else:
return SFTPTransport(self.abspath(offset), self)
def abspath(self, relpath):
"""
Return the full url to the given relative path.
@param relpath: the relative path or path components
@type relpath: str or list
"""
return self._unparse_url(self._abspath(relpath))
def _abspath(self, relpath):
"""Return the absolute path segment without the SFTP URL."""
# FIXME: share the common code across transports
assert isinstance(relpath, basestring)
relpath = [urllib.unquote(relpath)]
basepath = self._path.split('/')
if len(basepath) > 0 and basepath[-1] == '':
basepath = basepath[:-1]
for p in relpath:
if p == '..':
if len(basepath) == 0:
# In most filesystems, a request for the parent
# of root, just returns root.
continue
basepath.pop()
elif p == '.':
continue # No-op
else:
basepath.append(p)
path = '/'.join(basepath)
# could still be a "relative" path here, but relative on the sftp server
return path
def relpath(self, abspath):
username, password, host, port, path = self._split_url(abspath)
error = []
if (username != self._username):
error.append('username mismatch')
if (host != self._host):
error.append('host mismatch')
if (port != self._port):
error.append('port mismatch')
if (not path.startswith(self._path)):
error.append('path mismatch')
if error:
raise NonRelativePath('path %r is not under base URL %r: %s'
% (abspath, self.base, ', '.join(error)))
pl = len(self._path)
return path[pl:].lstrip('/')
def has(self, relpath):
"""
Does the target location exist?
"""
try:
self._sftp.stat(self._abspath(relpath))
return True
except IOError:
return False
def get(self, relpath, decode=False):
"""
Get the file at the given relative path.
:param relpath: The relative path to the file
"""
try:
path = self._abspath(relpath)
f = self._sftp.file(path)
if self._do_prefetch and hasattr(f, 'prefetch'):
f.prefetch()
return f
except (IOError, paramiko.SSHException), x:
raise NoSuchFile('Error retrieving %s: %s' % (path, str(x)), x)
def get_partial(self, relpath, start, length=None):
"""
Get just part of a file.
:param relpath: Path to the file, relative to base
:param start: The starting position to read from
:param length: The length to read. A length of None indicates
read to the end of the file.
:return: A file-like object containing at least the specified bytes.
Some implementations may return objects which can be read
past this length, but this is not guaranteed.
"""
# TODO: implement get_partial_multi to help with knit support
f = self.get(relpath)
f.seek(start)
if self._do_prefetch and hasattr(f, 'prefetch'):
f.prefetch()
return f
def put(self, relpath, f):
"""
Copy the file-like or string object into the location.
:param relpath: Location to put the contents, relative to base.
:param f: File-like or string object.
"""
final_path = self._abspath(relpath)
tmp_relpath = '%s.tmp.%.9f.%d.%d' % (relpath, time.time(),
os.getpid(), random.randint(0,0x7FFFFFFF))
tmp_abspath = self._abspath(tmp_relpath)
fout = self._sftp_open_exclusive(tmp_relpath)
try:
try:
self._pump(f, fout)
except IOError, e:
self._translate_io_exception(e, relpath)
except paramiko.SSHException, x:
raise SFTPTransportError('Unable to write file %r' % (relpath,), x)
except Exception, e:
# If we fail, try to clean up the temporary file
# before we throw the exception
# but don't let another exception mess things up
try:
fout.close()
self._sftp.remove(tmp_abspath)
except:
pass
raise e
else:
# sftp rename doesn't allow overwriting, so play tricks:
tmp_safety = 'bzr.tmp.%.9f.%d.%d' % (time.time(), os.getpid(), random.randint(0, 0x7FFFFFFF))
tmp_safety = self._abspath(tmp_safety)
try:
self._sftp.rename(final_path, tmp_safety)
file_existed = True
except:
file_existed = False
success = False
try:
try:
self._sftp.rename(tmp_abspath, final_path)
except IOError, e:
self._translate_io_exception(e, relpath)
except paramiko.SSHException, x:
raise SFTPTransportError('Unable to rename into file %r' % (path,), x)
else:
success = True
finally:
if file_existed:
if success:
self._sftp.unlink(tmp_safety)
else:
self._sftp.rename(tmp_safety, final_path)
def iter_files_recursive(self):
"""Walk the relative paths of all files in this transport."""
queue = list(self.list_dir('.'))
while queue:
relpath = urllib.quote(queue.pop(0))
st = self.stat(relpath)
if stat.S_ISDIR(st.st_mode):
for i, basename in enumerate(self.list_dir(relpath)):
queue.insert(i, relpath+'/'+basename)
else:
yield relpath
def mkdir(self, relpath):
"""Create a directory at the given path."""
try:
path = self._abspath(relpath)
self._sftp.mkdir(path)
except IOError, e:
self._translate_io_exception(e, relpath)
except (IOError, paramiko.SSHException), x:
raise SFTPTransportError('Unable to mkdir %r' % (path,), x)
def _translate_io_exception(self, e, relpath):
# paramiko seems to generate detailless errors.
if (e.errno == errno.ENOENT or
e.args == ('No such file or directory',) or
e.args == ('No such file',)):
raise NoSuchFile(relpath)
if (e.args == ('mkdir failed',)):
raise FileExists(relpath)
# strange but true, for the paramiko server.
if (e.args == ('Failure',)):
raise FileExists(relpath)
raise
def append(self, relpath, f):
"""
Append the text in the file-like object into the final
location.
"""
try:
path = self._abspath(relpath)
fout = self._sftp.file(path, 'ab')
self._pump(f, fout)
except (IOError, paramiko.SSHException), x:
raise SFTPTransportError('Unable to append file %r' % (path,), x)
def copy(self, rel_from, rel_to):
"""Copy the item at rel_from to the location at rel_to"""
path_from = self._abspath(rel_from)
path_to = self._abspath(rel_to)
self._copy_abspaths(path_from, path_to)
def _copy_abspaths(self, path_from, path_to):
"""Copy files given an absolute path
:param path_from: Path on remote server to read
:param path_to: Path on remote server to write
:return: None
TODO: Should the destination location be atomically created?
This has not been specified
TODO: This should use some sort of remote copy, rather than
pulling the data locally, and then writing it remotely
"""
try:
fin = self._sftp.file(path_from, 'rb')
try:
fout = self._sftp.file(path_to, 'wb')
try:
fout.set_pipelined(True)
self._pump(fin, fout)
finally:
fout.close()
finally:
fin.close()
except (IOError, paramiko.SSHException), x:
raise SFTPTransportError('Unable to copy %r to %r' % (path_from, path_to), x)
def copy_to(self, relpaths, other, pb=None):
"""Copy a set of entries from self into another Transport.
:param relpaths: A list/generator of entries to be copied.
"""
if isinstance(other, SFTPTransport) and other._sftp is self._sftp:
# Both from & to are on the same remote filesystem
# We can use a remote copy, instead of pulling locally, and pushing
total = self._get_total(relpaths)
count = 0
for path in relpaths:
path_from = self._abspath(relpath)
path_to = other._abspath(relpath)
self._update_pb(pb, 'copy-to', count, total)
self._copy_abspaths(path_from, path_to)
count += 1
return count
else:
return super(SFTPTransport, self).copy_to(relpaths, other, pb=pb)
# The dummy implementation just does a simple get + put
def copy_entry(path):
other.put(path, self.get(path))
return self._iterate_over(relpaths, copy_entry, pb, 'copy_to', expand=False)
def move(self, rel_from, rel_to):
"""Move the item at rel_from to the location at rel_to"""
path_from = self._abspath(rel_from)
path_to = self._abspath(rel_to)
try:
self._sftp.rename(path_from, path_to)
except (IOError, paramiko.SSHException), x:
raise SFTPTransportError('Unable to move %r to %r' % (path_from, path_to), x)
def delete(self, relpath):
"""Delete the item at relpath"""
path = self._abspath(relpath)
try:
self._sftp.remove(path)
except (IOError, paramiko.SSHException), x:
raise SFTPTransportError('Unable to delete %r' % (path,), x)
def listable(self):
"""Return True if this store supports listing."""
return True
def list_dir(self, relpath):
"""
Return a list of all files at the given location.
"""
# does anything actually use this?
path = self._abspath(relpath)
try:
return self._sftp.listdir(path)
except (IOError, paramiko.SSHException), x:
raise SFTPTransportError('Unable to list folder %r' % (path,), x)
def stat(self, relpath):
"""Return the stat information for a file."""
path = self._abspath(relpath)
try:
return self._sftp.stat(path)
except (IOError, paramiko.SSHException), x:
raise SFTPTransportError('Unable to stat %r' % (path,), x)
def lock_read(self, relpath):
"""
Lock the given file for shared (read) access.
:return: A lock object, which has an unlock() member function
"""
# FIXME: there should be something clever i can do here...
class BogusLock(object):
def __init__(self, path):
self.path = path
def unlock(self):
pass
return BogusLock(relpath)
def lock_write(self, relpath):
"""
Lock the given file for exclusive (write) access.
WARNING: many transports do not support this, so trying avoid using it
:return: A lock object, which has an unlock() member function
"""
# This is a little bit bogus, but basically, we create a file
# which should not already exist, and if it does, we assume
# that there is a lock, and if it doesn't, the we assume
# that we have taken the lock.
return SFTPLock(relpath, self)
def _unparse_url(self, path=None):
if path is None:
path = self._path
path = urllib.quote(path)
if path.startswith('/'):
path = '/%2F' + path[1:]
else:
path = '/' + path
netloc = urllib.quote(self._host)
if self._username is not None:
netloc = '%s@%s' % (urllib.quote(self._username), netloc)
if self._port is not None:
netloc = '%s:%d' % (netloc, self._port)
return urlparse.urlunparse(('sftp', netloc, path, '', '', ''))
def _split_url(self, url):
if isinstance(url, unicode):
url = url.encode('utf-8')
(scheme, netloc, path, params,
query, fragment) = urlparse.urlparse(url, allow_fragments=False)
assert scheme == 'sftp'
username = password = host = port = None
if '@' in netloc:
username, host = netloc.split('@', 1)
if ':' in username:
username, password = username.split(':', 1)
password = urllib.unquote(password)
username = urllib.unquote(username)
else:
host = netloc
if ':' in host:
host, port = host.rsplit(':', 1)
try:
port = int(port)
except ValueError:
raise SFTPTransportError('%s: invalid port number' % port)
host = urllib.unquote(host)
path = urllib.unquote(path)
# the initial slash should be removed from the path, and treated
# as a homedir relative path (the path begins with a double slash
# if it is absolute).
# see draft-ietf-secsh-scp-sftp-ssh-uri-03.txt
if path.startswith('/'):
path = path[1:]
return (username, password, host, port, path)
def _parse_url(self, url):
(self._username, self._password,
self._host, self._port, self._path) = self._split_url(url)
def _sftp_connect(self):
"""Connect to the remote sftp server.
After this, self._sftp should have a valid connection (or
we raise an SFTPTransportError 'could not connect').
TODO: Raise a more reasonable ConnectionFailed exception
"""
global _connected_hosts
idx = (self._host, self._port, self._username)
try:
self._sftp = _connected_hosts[idx]
return
except KeyError:
pass
vendor = _get_ssh_vendor()
if vendor != 'none':
sock = SFTPSubprocess(self._host, self._port, self._username)
self._sftp = SFTPClient(sock)
else:
self._paramiko_connect()
_connected_hosts[idx] = self._sftp
def _paramiko_connect(self):
global SYSTEM_HOSTKEYS, BZR_HOSTKEYS
load_host_keys()
try:
t = paramiko.Transport((self._host, self._port))
t.start_client()
except paramiko.SSHException:
raise SFTPTransportError('Unable to reach SSH host %s:%d' % (self._host, self._port))
server_key = t.get_remote_server_key()
server_key_hex = paramiko.util.hexify(server_key.get_fingerprint())
keytype = server_key.get_name()
if SYSTEM_HOSTKEYS.has_key(self._host) and SYSTEM_HOSTKEYS[self._host].has_key(keytype):
our_server_key = SYSTEM_HOSTKEYS[self._host][keytype]
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
elif BZR_HOSTKEYS.has_key(self._host) and BZR_HOSTKEYS[self._host].has_key(keytype):
our_server_key = BZR_HOSTKEYS[self._host][keytype]
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
else:
warning('Adding %s host key for %s: %s' % (keytype, self._host, server_key_hex))
if not BZR_HOSTKEYS.has_key(self._host):
BZR_HOSTKEYS[self._host] = {}
BZR_HOSTKEYS[self._host][keytype] = server_key
our_server_key = server_key
our_server_key_hex = paramiko.util.hexify(our_server_key.get_fingerprint())
save_host_keys()
if server_key != our_server_key:
filename1 = os.path.expanduser('~/.ssh/known_hosts')
filename2 = os.path.join(config_dir(), 'ssh_host_keys')
raise SFTPTransportError('Host keys for %s do not match! %s != %s' % \
(self._host, our_server_key_hex, server_key_hex),
['Try editing %s or %s' % (filename1, filename2)])
self._sftp_auth(t)
try:
self._sftp = t.open_sftp_client()
except paramiko.SSHException:
raise BzrError('Unable to find path %s on SFTP server %s' % \
(self._path, self._host))
def _sftp_auth(self, transport):
# paramiko requires a username, but it might be none if nothing was supplied
# use the local username, just in case.
# We don't override self._username, because if we aren't using paramiko,
# the username might be specified in ~/.ssh/config and we don't want to
# force it to something else
# Also, it would mess up the self.relpath() functionality
username = self._username or getpass.getuser()
agent = paramiko.Agent()
for key in agent.get_keys():
mutter('Trying SSH agent key %s' % paramiko.util.hexify(key.get_fingerprint()))
try:
transport.auth_publickey(username, key)
return
except paramiko.SSHException, e:
pass
# okay, try finding id_rsa or id_dss? (posix only)
if self._try_pkey_auth(transport, paramiko.RSAKey, username, 'id_rsa'):
return
if self._try_pkey_auth(transport, paramiko.DSSKey, username, 'id_dsa'):
return
if self._password:
try:
transport.auth_password(username, self._password)
return
except paramiko.SSHException, e:
pass
# FIXME: Don't keep a password held in memory if you can help it
#self._password = None
# give up and ask for a password
password = ui_factory.get_password(prompt='SSH %(user)s@%(host)s password',
user=username, host=self._host)
try:
transport.auth_password(username, password)
except paramiko.SSHException:
raise SFTPTransportError('Unable to authenticate to SSH host as %s@%s' % \
(username, self._host))
def _try_pkey_auth(self, transport, pkey_class, username, filename):
filename = os.path.expanduser('~/.ssh/' + filename)
try:
key = pkey_class.from_private_key_file(filename)
transport.auth_publickey(username, key)
return True
except paramiko.PasswordRequiredException:
password = ui_factory.get_password(prompt='SSH %(filename)s password',
filename=filename)
try:
key = pkey_class.from_private_key_file(filename, password)
transport.auth_publickey(username, key)
return True
except paramiko.SSHException:
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
except paramiko.SSHException:
mutter('SSH authentication via %s key failed.' % (os.path.basename(filename),))
except IOError:
pass
return False
def _sftp_open_exclusive(self, relpath):
"""Open a remote path exclusively.
SFTP supports O_EXCL (SFTP_FLAG_EXCL), which fails if
the file already exists. However it does not expose this
at the higher level of SFTPClient.open(), so we have to
sneak away with it.
WARNING: This breaks the SFTPClient abstraction, so it
could easily break against an updated version of paramiko.
:param relpath: The relative path, where the file should be opened
"""
path = self._sftp._adjust_cwd(self._abspath(relpath))
attr = SFTPAttributes()
mode = (SFTP_FLAG_WRITE | SFTP_FLAG_CREATE
| SFTP_FLAG_TRUNC | SFTP_FLAG_EXCL)
try:
t, msg = self._sftp._request(CMD_OPEN, path, mode, attr)
if t != CMD_HANDLE:
raise SFTPTransportError('Expected an SFTP handle')
handle = msg.get_string()
return SFTPFile(self._sftp, handle, 'w', -1)
except IOError, e:
self._translate_io_exception(e, relpath)
except paramiko.SSHException, x:
raise SFTPTransportError('Unable to open file %r' % (path,), x)
|