Skip to content

SSH Connector

SshConnector

Instantiate an SSH connector. Args: host (str): SSH host port (str): SSH port private_key (str): SSH private key file path username (str): SSH user disable_rsa_512_256 (boolean): If the value is True, then rsa-sha2-512 and rsa-sha2-256 algorithm will be disabled

Source code in honeydew/ssh.py
Python
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class SshConnector:
    """Instantiate an SSH connector.
    Args:
        host (str): SSH host
        port (str): SSH port
        private_key (str): SSH private key file path
        username (str): SSH user
        disable_rsa_512_256 (boolean): If the value is True, then rsa-sha2-512 and rsa-sha2-256 algorithm will be disabled
    """    
    def __init__(self, host, port, private_key, username, disable_rsa_512_256=False):
        self.host = host
        self.port = port
        self.private_key = private_key
        self.username = username
        self.disable_rsa_512_256 = disable_rsa_512_256

        self.ssh = SSHClient()
        self.ssh.load_system_host_keys()
        self.ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
        self.key = paramiko.RSAKey.from_private_key_file(self.private_key)
        if self.disable_rsa_512_256 == False:
            self.ssh.connect(self.host, port=self.port, username=self.username, pkey=self.key, timeout=3600)
        else:
            self.ssh.connect(self.host, port=self.port, username=self.username, pkey=self.key, timeout=3600, disabled_algorithms=dict(pubkeys=["rsa-sha2-512", "rsa-sha2-256"]))

    def scp_upload(self, src, dst):
        """
        Upload a file with SCP
        Args:
            src (str): Path of source file
            dst (str): Path of destination file
        Returns:
            result (str): The result of function
        """        
        scp = SCPClient(self.ssh.get_transport())
        scp.put(src, dst)    
        return """{src} has been uploaded!""".format(src=src)

    def scp_download(self, src, dst):
        """
        Download a file with SCP
        Args:
            src (str): Path of source file
            dst (str): Path of destination file
        Returns:
            result (str): The result of function
        """                
        scp = SCPClient(self.ssh.get_transport())
        scp.get(src, dst)    
        return """{src} has been downloaded!""".format(src=src)

scp_download(src, dst)

Download a file with SCP Args: src (str): Path of source file dst (str): Path of destination file Returns: result (str): The result of function

Source code in honeydew/ssh.py
Python
42
43
44
45
46
47
48
49
50
51
52
53
def scp_download(self, src, dst):
    """
    Download a file with SCP
    Args:
        src (str): Path of source file
        dst (str): Path of destination file
    Returns:
        result (str): The result of function
    """                
    scp = SCPClient(self.ssh.get_transport())
    scp.get(src, dst)    
    return """{src} has been downloaded!""".format(src=src)

scp_upload(src, dst)

Upload a file with SCP Args: src (str): Path of source file dst (str): Path of destination file Returns: result (str): The result of function

Source code in honeydew/ssh.py
Python
29
30
31
32
33
34
35
36
37
38
39
40
def scp_upload(self, src, dst):
    """
    Upload a file with SCP
    Args:
        src (str): Path of source file
        dst (str): Path of destination file
    Returns:
        result (str): The result of function
    """        
    scp = SCPClient(self.ssh.get_transport())
    scp.put(src, dst)    
    return """{src} has been uploaded!""".format(src=src)