文章目錄

• • 核心組件
  • • SSHClient常用方法
    • SFTPClient常用方法
  • 使用示例
  • • SSH私鑰創建
    • SSHClient運行命令
    • • 執行多條命令
    • SFTPClient下載文件

paramiko（ https://www.paramiko.org/）實現了SSHv2協議(底層使用cryptography)，用于連接遠程服務器并執行相關操作，使用該模塊可以對遠程服務器進行命令或文件操作。

核心組件

若未安裝，則先安裝pip install paramiko。

paramiko包含兩個核心組件，SSHClient和SFTPClient：

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

涉及的幾個基礎名詞：

• Channel：是一種類Socket，安全的SSH傳輸通道；
• Transport：是一種加密的會話，使用時會同步創建了一個加密的通道（Channel）；
• Session：是client與Server保持連接的對象，用connect()/start_client()/start_server()開始會話。

SSHClient常用方法

SSHClient用于執行ssh命令。

connect()：實現遠程服務器的連接與認證，只有hostname是必傳參數

• hostname：連接的目標主機
• port=SSH_PORT：SSH端口
• username=None：登錄的用戶名
• password=None：用戶密碼
• pkey=None：以私鑰方式進行身份驗證（代替password方式）
• 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文件中記錄時的應對策略

• AutoAddPolicy：自動添加主機名及密鑰到本地HostKeys對象，即新建立ssh連接時不需要輸入yes或no進行確認；
• WarningPolicy：記錄一個未知的主機密鑰時會發出警告，功能上和AutoAddPolicy類似，但是會提示是新連接；
• RejectPolicy：默認選項；自動拒絕未知的主機（本地know_hosts中不存在的）。

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

open_sftp()：在當前ssh會話的基礎上創建一個sftp會話，并返回一個SFTPClient對象

sftp = sshClient.open_sftp()

SFTPClient常用方法

SFTPCLient作為一個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()：列出服務器目錄下的文件

使用示例

SSH私鑰創建

要通過私鑰登錄，需要先生成私鑰（以Windows遠程登錄Linux為例）：

• 生成私鑰：

  打開cmd，執行ssh-keygen；

  全部回車；

  會在‘用戶’目錄下的.ssh目錄下生成id_rsa與id_rsa.pub文件

• 上傳公鑰：

  復制id_rsa.pub到遠端Linux機器的~/.ssh下；

  把公鑰加入authorized_keys中：cat id_rsa.pub >> authorized_keys

SSHClient運行命令

以私鑰方式登錄

def execCmd(host, user, psw, cmd, port=22) -> (str, str):""":param host::param user::param psw::param cmd::param port::return: (stdout string, stderr string)"""with paramiko.SSHClient() as ssh_client:# 自動添加策略，保存服務器的主機名和密鑰信息，須放在connect方法的前面ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())# 連接SSH服務端，以用戶名和密碼進行認證# ssh_client.connect(hostname=host, port=port, username=user, password=psw)# 連接SSH服務端，以用戶名和私鑰進行認證prvKey = paramiko.RSAKey.from_private_key_file(psw)ssh_client.connect(hostname=host, port=port, username=user, pkey=prvKey)# 打開一個Channel并執行命令: 正確輸出放到stdout中，如果有錯誤放到stderr中_, stdout, stderr = ssh_client.exec_command(cmd)result = stdout.read().decode('utf-8')# print("[OUT]:", result)err = stderr.read().decode('utf-8')# print("[ERR]:", err)ssh_client.close()return result, err

以元組方式返回，若有錯誤則返回的err非空。

執行多條命令

要一次執行多條命令，需要把多條命令以分號分割，且get_pty設為True。

def execMultiCmd(host, user, psw, cmds: list, port=22) -> (str, str):with paramiko.SSHClient() as ssh_client:ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())ssh_client.connect(hostname=host, port=port, username=user, password=psw)cmd = ";".join(cmds)_, stdout, stderr = ssh_client.exec_command(cmd, get_pty=True)result = stdout.read().decode('utf-8')err = stderr.read().decode('utf-8')return result, err

SFTPClient下載文件

以用戶名與密碼方式登錄：

def downloadFile(host, user, psw, localFile, remoteFile, port=22):# 實例化一個transport對象with paramiko.Transport((host, port)) as tran:# 連接SSH服務端，，以用戶名和密碼進行認證tran.connect(username=user, password=psw)# 連接SSH服務端，以用戶名和私鑰進行認證# prvKey = paramiko.RSAKey.from_private_key_file(psw)# tran.connect(username=user, pkey=prvKey)# 獲取SFTP實例sftp = paramiko.SFTPClient.from_transport(tran)# 執行下載動作sftp.get(remoteFile, localFile)# 關閉Transport通道tran.close()

默認遠端當前目錄是用戶home目錄，如下載".viminfo"文件：

downloadFile(host, user, psw, "d:\\tmp.conf", ".viminfo")

總結

以上是生活随笔為你收集整理的[Python]远程SSH库Paramiko简介的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。