Python Paramiko上傳下載sftp檔案及遠端執行命令詳解

2022-07-28 22:03:40

一、簡介

Paramiko模組是基於Python實現的SSH遠端安全連線，用於SSH遠端執行命令、檔案傳輸等功能。

安裝模組

預設Python沒有自帶，需要手動安裝：

pip3 install paramiko

二、上傳檔案

#!/usr/bin/env python3
# coding: utf-8
import paramiko
def sftp_upload_file(host,user,password,server_path, local_path,timeout=10):
    """
    上傳檔案，注意：不支援資料夾
    :param host: 主機名
    :param user: 使用者名稱
    :param password: 密碼
    :param server_path: 遠端路徑，比如：/home/sdn/tmp.txt
    :param local_path: 本地路徑，比如：D:/text.txt
    :param timeout: 超時時間(預設)，必須是int型別
    :return: bool
    """
    try:
        t = paramiko.Transport((host, 22))
        t.banner_timeout = timeout
        t.connect(username=user, password=password)
        sftp = paramiko.SFTPClient.from_transport(t)
        sftp.put(local_path, server_path)
        t.close()
        return True
    except Exception as e:
        print(e)
        return False

測試一下上傳，完整程式碼如下：

#!/usr/bin/env python3
# coding: utf-8
import paramiko
def sftp_upload_file(host, user, password, server_path, local_path, timeout=10):
    """
    上傳檔案，注意：不支援資料夾
    :param host: 主機名
    :param user: 使用者名稱
    :param password: 密碼
    :param server_path: 遠端路徑，比如：/home/sdn/tmp.txt
    :param local_path: 本地路徑，比如：D:/text.txt
    :param timeout: 超時時間(預設)，必須是int型別
    :return: bool
    """
    try:
        t = paramiko.Transport((host, 22))
        t.banner_timeout = timeout
        t.connect(username=user, password=password)
        sftp = paramiko.SFTPClient.from_transport(t)
        sftp.put(local_path, server_path)
        t.close()
        return True
    except Exception as e:
        print(e)
        return False
if __name__ == '__main__':
    host = '192.168.10.1'
    user = 'xiao'
    password = 'xiao@1234'
    server_path = '/tmp/tmp.txt'
    local_path = 'D:/text.txt'
    res = sftp_upload_file(host, user, password, server_path, local_path)
    if not res:
        print("上傳檔案: %s 失敗"%local_path)
    else:
        print("上傳檔案: %s 成功" % local_path)

執行輸出：

上傳檔案: D:/text.txt 成功

三、下載檔案

def sftp_down_file(host,user,password,server_path, local_path,timeout=10):
    """
    下載檔案，注意：不支援資料夾
    :param host: 主機名
    :param user: 使用者名稱
    :param password: 密碼
    :param server_path: 遠端路徑，比如：/home/sdn/tmp.txt
    :param local_path: 本地路徑，比如：D:/text.txt
    :param timeout: 超時時間(預設)，必須是int型別
    :return: bool
    """
    try:
        t = paramiko.Transport((host,22))
        t.banner_timeout = timeout
        t.connect(username=user,password=password)
        sftp = paramiko.SFTPClient.from_transport(t)
        sftp.get(server_path, local_path)
        t.close()
        return True
    except Exception as e:
        print(e)
        return False

測試一下，下載檔案功能，完整程式碼如下：

#!/usr/bin/env python3
# coding: utf-8
import paramiko
def sftp_down_file(host,user,password,server_path, local_path,timeout=10):
    """
    下載檔案，注意：不支援資料夾
    :param host: 主機名
    :param user: 使用者名稱
    :param password: 密碼
    :param server_path: 遠端路徑，比如：/home/sdn/tmp.txt
    :param local_path: 本地路徑，比如：D:/text.txt
    :param timeout: 超時時間(預設)，必須是int型別
    :return: bool
    """
    try:
        t = paramiko.Transport((host,22))
        t.banner_timeout = timeout
        t.connect(username=user,password=password)
        sftp = paramiko.SFTPClient.from_transport(t)
        sftp.get(server_path, local_path)
        t.close()
        return True
    except Exception as e:
        print(e)
        return False
if __name__ == '__main__':
    host = '192.168.10.1'
    user = 'xiao'
    password = 'xiao@1234'
    server_path = '/tmp/tmp.txt'
    local_path = 'D:/text.txt'
    res = sftp_down_file(host, user, password, server_path, local_path)
    if not res:
        print("下載檔案: %s 失敗"%server_path)
    else:
        print("下載檔案: %s 成功" % server_path)

執行輸出：

下載檔案: /tmp/tmp.txt 成功

四、遠端執行命令

def ssh_exec_command(host,user,password, cmd,timeout=10):
    """
    使用ssh連線遠端伺服器執行命令
    :param host: 主機名
    :param user: 使用者名稱
    :param password: 密碼
    :param cmd: 執行的命令
    :param seconds: 超時時間(預設)，必須是int型別
    :return: dict
    """
    result = {'status': 1, 'data': None}  # 返回結果
    try:
        ssh = paramiko.SSHClient()  # 建立一個新的SSHClient範例
        ssh.banner_timeout = timeout
        # 設定host key,如果在"known_hosts"中沒有儲存相關的資訊, SSHClient 預設行為是拒絕連線, 會提示yes/no
        ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
        ssh.connect(host, 22, user, password, timeout=timeout)  # 連線遠端伺服器,超時時間1秒
        stdin, stdout, stderr = ssh.exec_command(cmd,get_pty=True,timeout=timeout)  # 執行命令
        out = stdout.readlines()    # 執行結果,readlines會返回列表
        # 執行狀態,0表示成功，1表示失敗
        channel = stdout.channel
        status = channel.recv_exit_status()
        ssh.close()  # 關閉ssh連線
        # 修改返回結果
        result['status'] = status
        result['data'] = out
        return result
    except Exception as e:
        print(e)
        print("錯誤, 登入伺服器或者執行命令超時!!! ip: {} 命令: {}".format(ip,cmd))return False

測試一下，遠端執行命令功能，完整程式碼如下：

#!/usr/bin/env python3
# coding: utf-8
import paramiko
def ssh_exec_command(host,user,password, cmd,timeout=10):
    """
    使用ssh連線遠端伺服器執行命令
    :param host: 主機名
    :param user: 使用者名稱
    :param password: 密碼
    :param cmd: 執行的命令
    :param seconds: 超時時間(預設)，必須是int型別
    :return: dict
    """
    result = {'status': 1, 'data': None}  # 返回結果
    try:
        ssh = paramiko.SSHClient()  # 建立一個新的SSHClient範例
        ssh.banner_timeout = timeout
        # 設定host key,如果在"known_hosts"中沒有儲存相關的資訊, SSHClient 預設行為是拒絕連線, 會提示yes/no
        ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
        ssh.connect(host, 22, user, password, timeout=timeout)  # 連線遠端伺服器,超時時間1秒
        stdin, stdout, stderr = ssh.exec_command(cmd,get_pty=True,timeout=timeout)  # 執行命令
        out = stdout.readlines()    # 執行結果,readlines會返回列表
        # 執行狀態,0表示成功，1表示失敗
        channel = stdout.channel
        status = channel.recv_exit_status()
        ssh.close()  # 關閉ssh連線
        # 修改返回結果
        result['status'] = status
        result['data'] = out
        return result
    except Exception as e:
        print(e)
        print("錯誤, 登入伺服器或者執行命令超時!!! ip: {} 命令: {}".format(ip,cmd))
        return False
if __name__ == '__main__':
    host = '192.168.10.1'
    user = 'xiao'
    password = 'xiao@1234'
    cmd = "cat /etc/issue | awk '{print $1,$2,$3}'"
    res = ssh_exec_command(host, user, password, cmd)
    # print(res)
    if not res or not res['data'] or res['status'] != 0:
        print("錯誤, ip: {} 執行命令: {} 失敗".format(host, cmd), "red")
        exit()
    value = res['data'][0].strip()  # 獲取實際值
    print("作業系統為: %s"%value)

執行輸出：

作業系統為: Ubuntu 16.04.2 LTS

五、錯誤集錦

1. EllipticCurvePublicKey.public_bytes

Please use EllipticCurvePublicKey.public_bytes to obtain both compressed and uncompressed point encoding.

原因

paramiko 2.4.2 依賴 cryptography，而最新的cryptography==2.5裡有一些棄用的API。

解決

刪掉cryptography，安裝2.4.2，就不會報錯了。

pip uninstall cryptography
pip install cryptography==2.4.2

本文參考連結：https://www.jb51.net/article/257218.htm

2. Error reading SSH protocol banner

Traceback (most recent call last):
File "/python3/lib/python3.5/site-packages/paramiko/transport.py", line 1966, in run
self._check_banner()
File "/python3/lib/python3.5/site-packages/paramiko/transport.py", line 2143, in _check_banner
"Error reading SSH protocol banner" + str(e)
paramiko.ssh_exception.SSHException: Error reading SSH protocol banner
Error reading SSH protocol banner

要解決這個問題，需要將paramiko的響應等待時間調長。修改paramiko/transport.py檔案中的