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 ##############################################################################
15 from opnfv.utils import opnfv_logger as logger
17 logger = logger.Logger("SSH utils").getLogger()
21 def get_ssh_client(hostname,
29 client = paramiko.SSHClient()
31 client = ProxyHopClient()
32 client.configure_jump_host(proxy['ip'],
36 raise Exception('Could not connect to client')
38 client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
39 if pkey_file is not None:
40 key = paramiko.RSAKey.from_private_key_file(pkey_file)
41 client.load_system_host_keys()
42 client.connect(hostname,
47 client.connect(hostname,
53 except Exception as e:
58 def get_file(ssh_conn, src, dest):
60 sftp = ssh_conn.open_sftp()
63 except Exception as e:
64 logger.error("Error [get_file(ssh_conn, '%s', '%s']: %s" %
69 def put_file(ssh_conn, src, dest):
71 sftp = ssh_conn.open_sftp()
74 except Exception as e:
75 logger.error("Error [put_file(ssh_conn, '%s', '%s']: %s" %
80 class ProxyHopClient(paramiko.SSHClient):
82 Connect to a remote server using a proxy hop
85 def __init__(self, *args, **kwargs):
87 self.proxy_transport = None
88 self.proxy_channel = None
90 self.proxy_ssh_key = None
91 self.local_ssh_key = os.path.join(os.getcwd(), 'id_rsa')
92 super(ProxyHopClient, self).__init__(*args, **kwargs)
94 def configure_jump_host(self, jh_ip, jh_user, jh_pass,
95 jh_ssh_key='/root/.ssh/id_rsa'):
97 self.proxy_ssh_key = jh_ssh_key
98 self.proxy_ssh = paramiko.SSHClient()
99 self.proxy_ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
100 self.proxy_ssh.connect(jh_ip,
104 self.proxy_transport = self.proxy_ssh.get_transport()
106 def connect(self, hostname, port=22, username='root', password=None,
107 pkey=None, key_filename=None, timeout=None, allow_agent=True,
108 look_for_keys=True, compress=False, sock=None, gss_auth=False,
109 gss_kex=False, gss_deleg_creds=True, gss_host=None,
110 banner_timeout=None):
112 if self.proxy_ssh is None:
113 raise Exception('You must configure the jump '
114 'host before calling connect')
116 get_file_res = get_file(self.proxy_ssh,
119 if get_file_res is None:
120 raise Exception('Could\'t fetch SSH key from jump host')
121 proxy_key = (paramiko.RSAKey
122 .from_private_key_file(self.local_ssh_key))
124 self.proxy_channel = self.proxy_transport.open_channel(
129 self.set_missing_host_key_policy(paramiko.AutoAddPolicy())
130 super(ProxyHopClient, self).connect(hostname,
133 sock=self.proxy_channel,
135 os.remove(self.local_ssh_key)
136 except Exception as e: