Python模塊學習 - Paramiko

時間 2019-11-07

原文原文鏈接

簡介

ssh是一個協議，OpenSSH是其中一個開源實現，paramiko是Python的一個庫，實現了SSHv2協議(底層使用cryptography)。html

有了Paramiko之後，咱們就能夠在Python代碼中直接使用SSH協議對遠程服務器執行操做，而不是經過ssh命令對遠程服務器進行操做。python

因爲paramiko屬於第三方庫，因此須要使用以下命令先行安裝shell

pip3 install paramiko

Paramiko介紹

paramiko包含兩個核心組件：SSHClient和SFTPClient。安全

SSHClient的做用相似於Linux的ssh命令，是對SSH會話的封裝，該類封裝了傳輸(Transport)，通道(Channel)及SFTPClient創建的方法(open_sftp)，一般用於執行遠程命令。
SFTPClient的做用相似與Linux的sftp命令，是對SFTP客戶端的封裝，用以實現遠程文件操做，如文件上傳、下載、修改文件權限等操做。

# Paramiko中的幾個基礎名詞：

一、Channel：是一種類Socket，一種安全的SSH傳輸通道；
二、Transport：是一種加密的會話，使用時會同步建立了一個加密的Tunnels(通道)，這個Tunnels叫作Channel；
三、Session：是client與Server保持鏈接的對象，用connect()/start_client()/start_server()開始會話。

Paramiko的基本使用

SSHClient經常使用的方法介紹

connect()：實現遠程服務器的鏈接與認證，對於該方法只有hostname是必傳參數。服務器

經常使用參數
hostname 鏈接的目標主機
port=SSH_PORT 指定端口
username=None 驗證的用戶名
password=None 驗證的用戶密碼
pkey=None 私鑰方式用於身份驗證
key_filename=None 一個文件名或文件列表，指定私鑰文件
timeout=None 可選的tcp鏈接超時時間
allow_agent=True, 是否容許鏈接到ssh代理，默認爲True 容許
look_for_keys=True 是否在~/.ssh中搜索私鑰文件，默認爲True 容許
compress=False, 是否打開壓縮

set_missing_host_key_policy()：設置遠程服務器沒有在know_hosts文件中記錄時的應對策略。目前支持三種策略：ssh

設置鏈接的遠程主機沒有本地主機密鑰或HostKeys對象時的策略，目前支持三種：

AutoAddPolicy 自動添加主機名及主機密鑰到本地HostKeys對象，不依賴load_system_host_key的配置。即新創建ssh鏈接時不須要再輸入yes或no進行確認
WarningPolicy 用於記錄一個未知的主機密鑰的python警告。並接受，功能上和AutoAddPolicy相似，可是會提示是新鏈接
RejectPolicy 自動拒絕未知的主機名和密鑰，依賴load_system_host_key的配置。此爲默認選項

exec_command()：在遠程服務器執行Linux命令的方法。tcp

open_sftp()：在當前ssh會話的基礎上建立一個sftp會話。該方法會返回一個SFTPClient對象。加密

# 利用SSHClient對象的open_sftp()方法，能夠直接返回一個基於當前鏈接的sftp對象，能夠進行文件的上傳等操做.

sftp = client.open_sftp()
sftp.put('test.txt','text.txt')

SSHClient經常使用的方法舉例

 import paramiko

    # 實例化SSHClient
    client = paramiko.SSHClient()

    # 自動添加策略，保存服務器的主機名和密鑰信息，若是不添加，那麼再也不本地know_hosts文件中記錄的主機將沒法鏈接
    client.set_missing_host_key_policy(paramiko.AutoAddPolicy())

    # 鏈接SSH服務端，以用戶名和密碼進行認證
    client.connect(hostname='192.168.1.105', port=22, username='root', password='123456')

    # 打開一個Channel並執行命令
    stdin, stdout, stderr = client.exec_command('df -h ')  # stdout 爲正確輸出，stderr爲錯誤輸出，同時是有1個變量有值

    # 打印執行結果
    print(stdout.read().decode('utf-8'))

    # 關閉SSHClient
    client.close()

密鑰鏈接方式代理

# 配置私人密鑰文件位置
private = paramiko.RSAKey.from_private_key_file('/Users/ch/.ssh/id_rsa')

#實例化SSHClient
client = paramiko.SSHClient()

#自動添加策略，保存服務器的主機名和密鑰信息，若是不添加，那麼再也不本地know_hosts文件中記錄的主機將沒法鏈接
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())

#鏈接SSH服務端，以用戶名和密碼進行認證
client.connect(hostname='10.0.0.1',port=22,username='root',pkey=private)

　SSHClient 封裝 Transportcode

 import paramiko

    # 建立一個通道
    transport = paramiko.Transport(('hostname', 22))
    transport.connect(username='root', password='123')

    ssh = paramiko.SSHClient()
    ssh._transport = transport

    stdin, stdout, stderr = ssh.exec_command('df -h')
    print(stdout.read().decode('utf-8'))

    transport.close()

SFTPClient經常使用方法介紹

SFTPCLient做爲一個sftp的客戶端對象，根據ssh傳輸協議的sftp會話，實現遠程文件操做，如上傳、下載、權限、狀態

from_transport(cls,t) 建立一個已連通的SFTP客戶端通道
put(localpath, remotepath, callback=None, confirm=True) 將本地文件上傳到服務器 參數confirm：是否調用stat()方法檢查文件狀態，返回ls -l的結果
get(remotepath, localpath, callback=None) 從服務器下載文件到本地
mkdir() 在服務器上建立目錄
remove() 在服務器上刪除目錄
rename() 在服務器上重命名目錄
stat() 查看服務器文件狀態
listdir() 列出服務器目錄下的文件

SFTPClient經常使用方法舉例

    import paramiko

    # 獲取Transport實例
    tran = paramiko.Transport(('10.0.0.3', 22))

    # 鏈接SSH服務端，使用password
    tran.connect(username="root", password='123456')
    # 或使用
    # 配置私人密鑰文件位置
    private = paramiko.RSAKey.from_private_key_file('/Users/root/.ssh/id_rsa')
    # 鏈接SSH服務端，使用pkey指定私鑰
    tran.connect(username="root", pkey=private)

    # 獲取SFTP實例
    sftp = paramiko.SFTPClient.from_transport(tran)

    # 設置上傳的本地/遠程文件路徑
    localpath = "/Users/root/Downloads/1.txt"
    remotepath = "/tmp/1.txt"

    # 執行上傳動做
    sftp.put(localpath, remotepath)
    # 執行下載動做
    sftp.get(remotepath, localpath)

    tran.close()

Paramiko的綜合使用例子

class SSHConnection(object):

    def __init__(self, host_dict):
        self.host = host_dict['host']
        self.port = host_dict['port']
        self.username = host_dict['username']
        self.pwd = host_dict['pwd']
        self.__k = None

    def connect(self):
        transport = paramiko.Transport((self.host,self.port))
        transport.connect(username=self.username,password=self.pwd)
        self.__transport = transport

    def close(self):
        self.__transport.close()

    def run_cmd(self, command):
        """
         執行shell命令,返回字典
         return {'color': 'red','res':error}或
         return {'color': 'green', 'res':res}
        :param command:
        :return:
        """
        ssh = paramiko.SSHClient()
        ssh._transport = self.__transport
        # 執行命令
        stdin, stdout, stderr = ssh.exec_command(command)
        # 獲取命令結果
        res = unicode_utils.to_str(stdout.read())
        # 獲取錯誤信息
        error = unicode_utils.to_str(stderr.read())
        # 若是有錯誤信息，返回error
        # 不然返回res
        if error.strip():
            return {'color':'red','res':error}
        else:
            return {'color': 'green', 'res':res}

    def upload(self,local_path, target_path):
        # 鏈接，上傳
        sftp = paramiko.SFTPClient.from_transport(self.__transport)
        # 將location.py 上傳至服務器 /tmp/test.py
        sftp.put(local_path, target_path, confirm=True)
        # print(os.stat(local_path).st_mode)
        # 增長權限
        # sftp.chmod(target_path, os.stat(local_path).st_mode)
        sftp.chmod(target_path, 0o755)  # 注意這裏的權限是八進制的，八進制須要使用0o做爲前綴

    def download(self,target_path, local_path):
        # 鏈接，下載
        sftp = paramiko.SFTPClient.from_transport(self.__transport)
        # 將location.py 下載至服務器 /tmp/test.py
        sftp.get(target_path, local_path)

    # 銷燬
    def __del__(self):
        self.close()

　　
#unicode_utils.py
def to_str(bytes_or_str):
    """
    把byte類型轉換爲str
    :param bytes_or_str:
    :return:
    """
    if isinstance(bytes_or_str, bytes):
        value = bytes_or_str.decode('utf-8')
    else:
        value = bytes_or_str
    return value