modules/opnfv/utils/ssh_utils.py

   1 ##############################################################################
   2 # Copyright (c) 2015 Ericsson AB and others.
   3 # Authors: George Paraskevopoulos (geopar@intracom-telecom.com)
   4 #          Jose Lausuch (jose.lausuch@ericsson.com)
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 ##############################################################################
  10
  11
  12 import os
  13 import paramiko
  14
  15 from opnfv.utils import opnfv_logger as logger
  16
  17 logger = logger.Logger("SSH utils").getLogger()
  18
  19
  20 def get_ssh_client(hostname,
  21                    username,
  22                    password=None,
  23                    proxy=None,
  24                    pkey_file=None):
  25     client = None
  26     try:
  27         if proxy is None:
  28             client = paramiko.SSHClient()
  29         else:
  30             client = ProxyHopClient()
  31             client.configure_jump_host(proxy['ip'],
  32                                        proxy['username'],
  33                                        proxy['password'])
  34         if client is None:
  35             raise Exception('Could not connect to client')
  36
  37         client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
  38         if pkey_file is not None:
  39             key = paramiko.RSAKey.from_private_key_file(pkey_file)
  40             client.load_system_host_keys()
  41             client.connect(hostname,
  42                            username=username,
  43                            pkey=key)
  44         else:
  45             client.connect(hostname,
  46                            username=username,
  47                            password=password)
  48
  49         return client
  50     except Exception as e:
  51         logger.error(e)
  52         return None
  53
  54
  55 def get_file(ssh_conn, src, dest):
  56     try:
  57         sftp = ssh_conn.open_sftp()
  58         sftp.get(src, dest)
  59         return True
  60     except Exception as e:
  61         logger.error("Error [get_file(ssh_conn, '%s', '%s']: %s" %
  62                      (src, dest, e))
  63         return None
  64
  65
  66 def put_file(ssh_conn, src, dest):
  67     try:
  68         sftp = ssh_conn.open_sftp()
  69         sftp.put(src, dest)
  70         return True
  71     except Exception as e:
  72         logger.error("Error [put_file(ssh_conn, '%s', '%s']: %s" %
  73                      (src, dest, e))
  74         return None
  75
  76
  77 class ProxyHopClient(paramiko.SSHClient):
  78     '''
  79     Connect to a remote server using a proxy hop
  80     '''
  81
  82     def __init__(self, *args, **kwargs):
  83         self.proxy_ssh = None
  84         self.proxy_transport = None
  85         self.proxy_channel = None
  86         self.proxy_ip = None
  87         self.proxy_ssh_key = None
  88         self.local_ssh_key = os.path.join(os.getcwd(), 'id_rsa')
  89         super(ProxyHopClient, self).__init__(*args, **kwargs)
  90
  91     def configure_jump_host(self, jh_ip, jh_user, jh_pass,
  92                             jh_ssh_key='/root/.ssh/id_rsa'):
  93         self.proxy_ip = jh_ip
  94         self.proxy_ssh_key = jh_ssh_key
  95         self.proxy_ssh = paramiko.SSHClient()
  96         self.proxy_ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
  97         self.proxy_ssh.connect(jh_ip,
  98                                username=jh_user,
  99                                password=jh_pass)
 100         self.proxy_transport = self.proxy_ssh.get_transport()
 101
 102     def connect(self, hostname, port=22, username='root', password=None,
 103                 pkey=None, key_filename=None, timeout=None, allow_agent=True,
 104                 look_for_keys=True, compress=False, sock=None, gss_auth=False,
 105                 gss_kex=False, gss_deleg_creds=True, gss_host=None,
 106                 banner_timeout=None):
 107         try:
 108             if self.proxy_ssh is None:
 109                 raise Exception('You must configure the jump '
 110                                 'host before calling connect')
 111
 112             get_file_res = get_file(self.proxy_ssh,
 113                                     self.proxy_ssh_key,
 114                                     self.local_ssh_key)
 115             if get_file_res is None:
 116                 raise Exception('Could\'t fetch SSH key from jump host')
 117             proxy_key = (paramiko.RSAKey
 118                          .from_private_key_file(self.local_ssh_key))
 119
 120             self.proxy_channel = self.proxy_transport.open_channel(
 121                 "direct-tcpip",
 122                 (hostname, 22),
 123                 (self.proxy_ip, 22))
 124
 125             self.set_missing_host_key_policy(paramiko.AutoAddPolicy())
 126             super(ProxyHopClient, self).connect(hostname,
 127                                                 username=username,
 128                                                 pkey=proxy_key,
 129                                                 sock=self.proxy_channel)
 130             os.remove(self.local_ssh_key)
 131         except Exception as e:
 132             logger.error(e)