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 ##############################################################################
13 import opnfv.utils.OPNFVLogger as OPNFVLogger
16 logger = OPNFVLogger.Logger('SSHUtils').getLogger()
19 def get_ssh_client(hostname, username, password=None, proxy=None):
23 client = paramiko.SSHClient()
25 client = ProxyHopClient()
26 client.configure_jump_host(proxy['ip'],
31 raise Exception('Could not connect to client')
33 client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
34 client.connect(hostname,
43 def get_file(ssh_conn, src, dest):
45 sftp = ssh_conn.open_sftp()
49 logger.error("Error [get_file(ssh_conn, '%s', '%s']: %s" %
54 def put_file(ssh_conn, src, dest):
56 sftp = ssh_conn.open_sftp()
60 logger.error("Error [put_file(ssh_conn, '%s', '%s']: %s" %
65 class ProxyHopClient(paramiko.SSHClient):
67 Connect to a remote server using a proxy hop
69 def __init__(self, *args, **kwargs):
70 self.logger = OPNFVLogger.Logger("ProxyHopClient").getLogger()
72 self.proxy_transport = None
73 self.proxy_channel = 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)
79 def configure_jump_host(self, jh_ip, jh_user, jh_pass,
80 jh_ssh_key='/root/.ssh/id_rsa'):
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,
88 self.proxy_transport = self.proxy_ssh.get_transport()
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,
96 if self.proxy_ssh is None:
97 raise Exception('You must configure the jump '
98 'host before calling connect')
100 get_file_res = get_file(self.proxy_ssh,
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))
108 self.proxy_channel = self.proxy_transport.open_channel(
113 self.set_missing_host_key_policy(paramiko.AutoAddPolicy())
114 super(ProxyHopClient, self).connect(hostname,
117 sock=self.proxy_channel)
118 os.remove(self.local_ssh_key)