modules/opnfv/utils/SSHUtils.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 paramiko
  13 import opnfv.utils.OPNFVLogger as OPNFVLogger
  14 import os
  15
  16 logger = OPNFVLogger.Logger('SSHUtils').getLogger()
  17
  18
  19 def get_ssh_client(hostname, username, password=None, proxy=None):
  20     client = None
  21     try:
  22         if proxy is None:
  23             client = paramiko.SSHClient()
  24         else:
  25             client = ProxyHopClient()
  26             client.configure_jump_host(proxy['ip'],
  27                                        proxy['username'],
  28                                        proxy['password'])
  29
  30         if client is None:
  31             raise Exception('Could not connect to client')
  32
  33         client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
  34         client.connect(hostname,
  35                        username=username,
  36                        password=password)
  37         return client
  38     except Exception, e:
  39         logger.error(e)
  40         return None
  41
  42
  43 def get_file(ssh_conn, src, dest):
  44     try:
  45         sftp = ssh_conn.open_sftp()
  46         sftp.get(src, dest)
  47         return True
  48     except Exception, e:
  49         logger.error("Error [get_file(ssh_conn, '%s', '%s']: %s" %
  50                      (src, dest, e))
  51         return None
  52
  53
  54 def put_file(ssh_conn, src, dest):
  55     try:
  56         sftp = ssh_conn.open_sftp()
  57         sftp.put(src, dest)
  58         return True
  59     except Exception, e:
  60         logger.error("Error [put_file(ssh_conn, '%s', '%s']: %s" %
  61                      (src, dest, e))
  62         return None
  63
  64
  65 class ProxyHopClient(paramiko.SSHClient):
  66     '''
  67     Connect to a remote server using a proxy hop
  68     '''
  69     def __init__(self, *args, **kwargs):
  70         self.logger = OPNFVLogger.Logger("ProxyHopClient").getLogger()
  71         self.proxy_ssh = None
  72         self.proxy_transport = None
  73         self.proxy_channel = None
  74         self.proxy_ip = None
  75         self.proxy_ssh_key = None
  76         self.local_ssh_key = os.path.join(os.getcwd(), 'id_rsa')
  77         super(ProxyHopClient, self).__init__(*args, **kwargs)
  78
  79     def configure_jump_host(self, jh_ip, jh_user, jh_pass,
  80                             jh_ssh_key='/root/.ssh/id_rsa'):
  81         self.proxy_ip = jh_ip
  82         self.proxy_ssh_key = jh_ssh_key
  83         self.proxy_ssh = paramiko.SSHClient()
  84         self.proxy_ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
  85         self.proxy_ssh.connect(jh_ip,
  86                                username=jh_user,
  87                                password=jh_pass)
  88         self.proxy_transport = self.proxy_ssh.get_transport()
  89
  90     def connect(self, hostname, port=22, username='root', password=None,
  91                 pkey=None, key_filename=None, timeout=None, allow_agent=True,
  92                 look_for_keys=True, compress=False, sock=None, gss_auth=False,
  93                 gss_kex=False, gss_deleg_creds=True, gss_host=None,
  94                 banner_timeout=None):
  95         try:
  96             if self.proxy_ssh is None:
  97                 raise Exception('You must configure the jump '
  98                                 'host before calling connect')
  99
 100             get_file_res = get_file(self.proxy_ssh,
 101                                     self.proxy_ssh_key,
 102                                     self.local_ssh_key)
 103             if get_file_res is None:
 104                 raise Exception('Could\'t fetch SSH key from jump host')
 105             proxy_key = (paramiko.RSAKey
 106                          .from_private_key_file(self.local_ssh_key))
 107
 108             self.proxy_channel = self.proxy_transport.open_channel(
 109                 "direct-tcpip",
 110                 (hostname, 22),
 111                 (self.proxy_ip, 22))
 112
 113             self.set_missing_host_key_policy(paramiko.AutoAddPolicy())
 114             super(ProxyHopClient, self).connect(hostname,
 115                                                 username=username,
 116                                                 pkey=proxy_key,
 117                                                 sock=self.proxy_channel)
 118             os.remove(self.local_ssh_key)
 119         except Exception, e:
 120             self.logger.error(e)