Package x2go :: Module _paramiko

[frames] | no frames]

# Source Code for Module x2go._paramiko

      1  # -*- coding: utf-8 -*-
      2
      3  # Copyright (C) 2010-2015 by Mike Gabriel <mike.gabriel@das-netzwerkteam.de>
      4  #
      5  # Python X2Go is free software; you can redistribute it and/or modify
      6  # it under the terms of the GNU Affero General Public License as published by
      7  # the Free Software Foundation; either version 3 of the License, or
      8  # (at your option) any later version.
      9  #
     10  # Python X2Go is distributed in the hope that it will be useful,
     11  # but WITHOUT ANY WARRANTY; without even the implied warranty of
     12  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     13  # GNU Affero General Public License for more details.
     14  #
     15  # You should have received a copy of the GNU Affero General Public License
     16  # along with this program; if not, write to the
     17  # Free Software Foundation, Inc.,
     18  # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
     19
     20  """\
     21  Monkey Patch and feature map for Python Paramiko
     22
     23  """
     24
     25  import paramiko
     26  import re
     27  try:
     28      from paramiko.config import SSH_PORT
     29  except ImportError:
     30      SSH_PORT=22
     31  import platform
     32  from utils import compare_versions
     33
     34  PARAMIKO_VERSION = paramiko.__version__.split()[0]
     35  PARAMIKO_FEATURE = {
     36      'forward-ssh-agent': compare_versions(PARAMIKO_VERSION, ">=", '1.8.0') and (platform.system() != "Windows"),
     37      'use-compression': compare_versions(PARAMIKO_VERSION, ">=", '1.7.7.1'),
     38      'hash-host-entries': compare_versions(PARAMIKO_VERSION, ">=", '99'),
     39      'host-entries-reloadable': compare_versions(PARAMIKO_VERSION, ">=", '1.11.0'),
     40      'preserve-known-hosts': compare_versions(PARAMIKO_VERSION, ">=", '1.11.0'),
     41      'ecdsa-hostkeys': compare_versions(PARAMIKO_VERSION, ">=", '1.11.6'),
     42  }
     43
     44 -def _SSHClient_save_host_keys(self, filename):
     45      """\
     46      Available since paramiko 1.11.0...
     47
     48      This method has been taken from SSHClient class in Paramiko and
     49      has been improved and adapted to latest SSH implementations.
     50
     51      Save the host keys back to a file.
     52      Only the host keys loaded with
     53      L{load_host_keys} (plus any added directly) will be saved -- not any
     54      host keys loaded with L{load_system_host_keys}.
     55
     56      @param filename: the filename to save to
     57      @type filename: str
     58
     59      @raise IOError: if the file could not be written
     60
     61      """
     62      # update local host keys from file (in case other SSH clients
     63      # have written to the known_hosts file meanwhile.
     64      if self.known_hosts is not None:
     65          self.load_host_keys(self.known_hosts)
     66
     67      f = open(filename, 'w')
     68      #f.write('# SSH host keys collected by paramiko\n')
     69      _host_keys = self.get_host_keys()
     70      for hostname, keys in _host_keys.iteritems():
     71
     72          for keytype, key in keys.iteritems():
     73              f.write('%s %s %s\n' % (hostname, keytype, key.get_base64()))
     74
     75      f.close()
     76
     77
     78 -def _HostKeys_load(self, filename):
     79      """\
     80      Available since paramiko 1.11.0...
     81
     82      Read a file of known SSH host keys, in the format used by openssh.
     83      This type of file unfortunately doesn't exist on Windows, but on
     84      posix, it will usually be stored in
     85      C{os.path.expanduser("~/.ssh/known_hosts")}.
     86
     87      If this method is called multiple times, the host keys are merged,
     88      not cleared. So multiple calls to C{load} will just call L{add},
     89      replacing any existing entries and adding new ones.
     90
     91      @param filename: name of the file to read host keys from
     92      @type filename: str
     93
     94      @raise IOError: if there was an error reading the file
     95
     96      """
     97      f = open(filename, 'r')
     98      for line in f:
     99          line = line.strip()
    100          if (len(line) == 0) or (line[0] == '#'):
    101              continue
    102          e = paramiko.hostkeys.HostKeyEntry.from_line(line)
    103          if e is not None:
    104              _hostnames = e.hostnames
    105              for h in _hostnames:
    106                  if self.check(h, e.key):
    107                      e.hostnames.remove(h)
    108              if len(e.hostnames):
    109                  self._entries.append(e)
    110      f.close()
    111
    112
    113 -def _HostKeys_add(self, hostname, keytype, key, hash_hostname=True):
    114      """\
    115      Add a host key entry to the table. Any existing entry for a
    116      C{(hostname, keytype)} pair will be replaced.
    117
    118      @param hostname: the hostname (or IP) to add
    119      @type hostname: str
    120      @param keytype: key type (C{"ssh-rsa"}, C{"ssh-dss"} or C{"ecdsa-sha2-nistp256"})
    121      @type keytype: str
    122      @param key: the key to add
    123      @type key: L{PKey}
    124
    125      """
    126      # IPv4 and IPv6 addresses using the SSH default port need to be stripped off the port number
    127      if re.match('^\[.*\]\:'+str(SSH_PORT)+'$', hostname):
    128          # so stripping off the port and the square brackets here...
    129          hostname = hostname.split(':')[-2].lstrip('[').rstrip(']')
    130
    131      for e in self._entries:
    132          if (hostname in e.hostnames) and (e.key.get_name() == keytype):
    133              e.key = key
    134              return
    135      if not hostname.startswith('|1|') and hash_hostname:
    136          hostname = self.hash_host(hostname)
    137      self._entries.append(paramiko.hostkeys.HostKeyEntry([hostname], key))
    138
    139
    140 -def monkey_patch_paramiko():
    141      if not PARAMIKO_FEATURE['preserve-known-hosts']:
    142          paramiko.SSHClient.save_host_keys = _SSHClient_save_host_keys
    143      if not PARAMIKO_FEATURE['host-entries-reloadable']:
    144          paramiko.hostkeys.HostKeys.load = _HostKeys_load
    145      if not PARAMIKO_FEATURE['hash-host-entries']:
    146          paramiko.hostkeys.HostKeys.add = _HostKeys_add
    147