~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/transport/ssh.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 00:49:50 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909004950-43z4zdicb5u91iet
tweak quick reference naming to make it consistent with other PDFs

Show diffs side-by-side

added added

removed removed

Lines of Context:
94
94
            try:
95
95
                vendor = self._ssh_vendors[vendor_name]
96
96
            except KeyError:
97
 
                vendor = self._get_vendor_from_path(vendor_name)
98
 
                if vendor is None:
99
 
                    raise errors.UnknownSSH(vendor_name)
100
 
                vendor.executable_path = vendor_name
 
97
                raise errors.UnknownSSH(vendor_name)
101
98
            return vendor
102
99
        return None
103
100
 
113
110
            stdout = stderr = ''
114
111
        return stdout + stderr
115
112
 
116
 
    def _get_vendor_by_version_string(self, version, progname):
 
113
    def _get_vendor_by_version_string(self, version, args):
117
114
        """Return the vendor or None based on output from the subprocess.
118
115
 
119
116
        :param version: The output of 'ssh -V' like command.
126
123
        elif 'SSH Secure Shell' in version:
127
124
            trace.mutter('ssh implementation is SSH Corp.')
128
125
            vendor = SSHCorpSubprocessVendor()
129
 
        # As plink user prompts are not handled currently, don't auto-detect
130
 
        # it by inspection below, but keep this vendor detection for if a path
131
 
        # is given in BZR_SSH. See https://bugs.launchpad.net/bugs/414743
132
 
        elif 'plink' in version and progname == 'plink':
133
 
            # Checking if "plink" was the executed argument as Windows
134
 
            # sometimes reports 'ssh -V' incorrectly with 'plink' in it's
135
 
            # version.  See https://bugs.launchpad.net/bzr/+bug/107155
136
 
            trace.mutter("ssh implementation is Putty's plink.")
137
 
            vendor = PLinkSubprocessVendor()
 
126
        # Auto-detect of plink vendor disabled, on Windows recommended
 
127
        # default ssh-client is paramiko
 
128
        # see https://bugs.launchpad.net/bugs/414743
 
129
        #~elif 'plink' in version and args[0] == 'plink':
 
130
        #~    # Checking if "plink" was the executed argument as Windows
 
131
        #~    # sometimes reports 'ssh -V' incorrectly with 'plink' in it's
 
132
        #~    # version.  See https://bugs.launchpad.net/bzr/+bug/107155
 
133
        #~    trace.mutter("ssh implementation is Putty's plink.")
 
134
        #~    vendor = PLinkSubprocessVendor()
138
135
        return vendor
139
136
 
140
137
    def _get_vendor_by_inspection(self):
141
138
        """Return the vendor or None by checking for known SSH implementations."""
142
 
        version = self._get_ssh_version_string(['ssh', '-V'])
143
 
        return self._get_vendor_by_version_string(version, "ssh")
144
 
 
145
 
    def _get_vendor_from_path(self, path):
146
 
        """Return the vendor or None using the program at the given path"""
147
 
        version = self._get_ssh_version_string([path, '-V'])
148
 
        return self._get_vendor_by_version_string(version, 
149
 
            os.path.splitext(os.path.basename(path))[0])
 
139
        for args in (['ssh', '-V'], ['plink', '-V']):
 
140
            version = self._get_ssh_version_string(args)
 
141
            vendor = self._get_vendor_by_version_string(version, args)
 
142
            if vendor is not None:
 
143
                return vendor
 
144
        return None
150
145
 
151
146
    def get_vendor(self, environment=None):
152
147
        """Find out what version of SSH is on the system.
409
404
class OpenSSHSubprocessVendor(SubprocessVendor):
410
405
    """SSH vendor that uses the 'ssh' executable from OpenSSH."""
411
406
 
412
 
    executable_path = 'ssh'
413
 
 
414
407
    def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
415
408
                                  command=None):
416
 
        args = [self.executable_path,
 
409
        args = ['ssh',
417
410
                '-oForwardX11=no', '-oForwardAgent=no',
418
411
                '-oClearAllForwardings=yes', '-oProtocol=2',
419
412
                '-oNoHostAuthenticationForLocalhost=yes']
433
426
class SSHCorpSubprocessVendor(SubprocessVendor):
434
427
    """SSH vendor that uses the 'ssh' executable from SSH Corporation."""
435
428
 
436
 
    executable_path = 'ssh'
437
 
 
438
429
    def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
439
430
                                  command=None):
440
 
        args = [self.executable_path, '-x']
 
431
        args = ['ssh', '-x']
441
432
        if port is not None:
442
433
            args.extend(['-p', str(port)])
443
434
        if username is not None:
448
439
            args.extend([host] + command)
449
440
        return args
450
441
 
451
 
register_ssh_vendor('sshcorp', SSHCorpSubprocessVendor())
 
442
register_ssh_vendor('ssh', SSHCorpSubprocessVendor())
452
443
 
453
444
 
454
445
class PLinkSubprocessVendor(SubprocessVendor):
455
446
    """SSH vendor that uses the 'plink' executable from Putty."""
456
447
 
457
 
    executable_path = 'plink'
458
 
 
459
448
    def _get_vendor_specific_argv(self, username, host, port, subsystem=None,
460
449
                                  command=None):
461
 
        args = [self.executable_path, '-x', '-a', '-ssh', '-2', '-batch']
 
450
        args = ['plink', '-x', '-a', '-ssh', '-2', '-batch']
462
451
        if port is not None:
463
452
            args.extend(['-P', str(port)])
464
453
        if username is not None:
515
504
    except paramiko.SSHException, e:
516
505
        # Don't know what happened, but just ignore it
517
506
        pass
518
 
    # We treat 'keyboard-interactive' and 'password' auth methods identically,
519
 
    # because Paramiko's auth_password method will automatically try
520
 
    # 'keyboard-interactive' auth (using the password as the response) if
521
 
    # 'password' auth is not available.  Apparently some Debian and Gentoo
522
 
    # OpenSSH servers require this.
523
 
    # XXX: It's possible for a server to require keyboard-interactive auth that
524
 
    # requires something other than a single password, but we currently don't
525
 
    # support that.
526
 
    if ('password' not in supported_auth_types and
527
 
        'keyboard-interactive' not in supported_auth_types):
 
507
    if 'password' not in supported_auth_types:
528
508
        raise errors.ConnectionError('Unable to authenticate to SSH host as'
529
509
            '\n  %s@%s\nsupported auth types: %s'
530
510
            % (username, host, supported_auth_types))
638
618
                'close_fds': True,
639
619
                }
640
620
 
641
 
import weakref
642
 
_subproc_weakrefs = set()
643
 
 
644
 
def _close_ssh_proc(proc):
645
 
    for func in [proc.stdin.close, proc.stdout.close, proc.wait]:
646
 
        try:
647
 
            func()
648
 
        except OSError:
649
 
            pass
650
 
 
651
621
 
652
622
class SSHSubprocess(object):
653
623
    """A socket-like object that talks to an ssh subprocess via pipes."""
654
624
 
655
625
    def __init__(self, proc):
656
626
        self.proc = proc
657
 
        # Add a weakref to proc that will attempt to do the same as self.close
658
 
        # to avoid leaving processes lingering indefinitely.
659
 
        def terminate(ref):
660
 
            _subproc_weakrefs.remove(ref)
661
 
            _close_ssh_proc(proc)
662
 
        _subproc_weakrefs.add(weakref.ref(self, terminate))
663
627
 
664
628
    def send(self, data):
665
629
        return os.write(self.proc.stdin.fileno(), data)
668
632
        return os.read(self.proc.stdout.fileno(), count)
669
633
 
670
634
    def close(self):
671
 
        _close_ssh_proc(self.proc)
 
635
        self.proc.stdin.close()
 
636
        self.proc.stdout.close()
 
637
        self.proc.wait()
672
638
 
673
639
    def get_filelike_channels(self):
674
640
        return (self.proc.stdout, self.proc.stdin)