python基於paramiko庫遠程執行 SSH 命令,實現 sftp 下載文件

Posted on by

楔子

我們使用 Python 避免不瞭和 Linux 打交道，而有時我們需要執行一些 shell 命令。如果在本地的話，那麼可以通過調用 os.system 或者 subprocess.Popen 來執行，但如果我們希望遠程執行其它機器上的 shell 命令，這個時候該怎麼做呢？下面我們就來推薦一個第三方庫 paramiko，看看如何使用 Python 遠程操作其它機器。

paramiko

網絡傳輸是遵循協議的，比如 SSH，paramiko 則是實現瞭 SSHv2 協議的一個 Python 第三方庫（底層使用的是 cryptography）。有瞭 paramiko 之後，我們便可以通過 Python 使用 SSH 協議來連接遠程服務器執行操作，和 xshell 本質上是類似的。

註意：我們在 Python 代碼中是直接通過 SSH 協議對遠程服務器執行操作，而不是調用 ssh 命令對遠程服務器進行操作。

既然要使用，那麼首先要安裝，直接 pip install paramiko 即可。

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

SSHClient 的作用類似於 Linux 下的 ssh 命令，是對 SSH 會話的封裝，通常用於執行遠程命令。

SFTPClient 的作用類似於 Linux 下的 sftp 命令，是對 SFTP 客戶端的封裝，用於實現遠程文件的操作。比如：文件上傳，下載、修改文件權限等操作。

下面我們就來介紹它們的用法。

SSHClient 的使用

首先創建一個客戶端實例， client = paramiko.SSHClient()，然後這個 client 下有很多方法。

connect：實現遠程服務器的連接與認證

def connect(
 self,
 hostname,
 port=SSH_PORT,
 username=None,
 password=None,
 pkey=None,
 key_filename=None,
 timeout=None,
 allow_agent=True,
 look_for_keys=True,
 compress=False,
 sock=None,
 gss_auth=False,
 gss_kex=False,
 gss_deleg_creds=True,
 gss_host=None,
 banner_timeout=None,
 auth_timeout=None,
 gss_trust_dns=True,
 passphrase=None,
 disabled_algorithms=None,
):
 """"""

裡面參數很多，但常用的參數如下：

  • hostname：連接的目的主機, 這個參數是必須的
  • port=SSH_PORT：指定的端口, 默認是 22
  • 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：當遠程服務器沒有本地秘鑰或 HostKeys 對象時的應對策略，目前支持三種：

  • AutoAddPolicy：自動添加主機名以及主機秘鑰到本地 HostKeys 對象, 不依賴 load_system_host_key 的配置, 即新建立 ssh 連接時不需要再輸入 yes 或 no 進行確認
  • WarningPolicy：用於記錄一個未知的主機秘鑰的 Python 警告、並且接收; 所以它的功能和 AutoAddPolicy 是類似的, 隻不過會提示這是新連接
  • RejectPolicy：自動拒絕未知的主機名和秘鑰, 依賴 load_system_host_key 的配置, 該選項為默認選項

所以我們一般都會將策略改成 AutoAddPolicy，不然還需要在本地進行配置。

exec_command：遠程執行的具體 Linux 命令

open_sftp：在當前 ssh 會話的基礎上創建一個 sftp 會話，該方法會返回一個 SFTPClient 對象，可以執行文件的上傳、下載等操作。我們後面在 SFTPClient 的時候會說。

下面我們來演示一下：

import paramiko

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

# 自動添加策略, 保存服務器的主機名和密鑰信息; 如果不添加, 那麼不再本地 know_hosts 文件中的主機將無法連接
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())

# 連接 SSH 服務端, 通過用戶名和密碼進行認證
# 該過程會創建一個 session, 它是 client 和 server 保持連接的對象
client.connect(hostname='47.94.174.89', port=22, username='root', password='xxxxxxx')

# 執行遠程命令, 該方法會打開一個 paramiko.Channel 對象(類 socket, 一種安全的 SSH 傳輸通道)
# 會返回三個值, 分別是 stdin(標準輸入)、stdout(標準輸出)、stderr(錯誤輸出)
stdin, stdout, stderr = client.exec_command("ls /")

# 打印執行結果, 顯然我們要通過 stdout 來查看, 我們可以調用 stdout.read 獲取執行的結果
# 但是返回的是字節, 所以需要先獲取對應的編碼, 然後再進行 decode
print(stdout.read().decode("utf-8"))
"""
bin
boot
dev
etc
home
lib
lib64
lost+found
media
mnt
opt
proc
root
run
sbin
srv
sys
tmp
usr
var

"""
# 最後關閉 SSHClient 對象
client.close()

還是很簡單的，如果我們輸入瞭一條錯誤的命令，那麼 stdout 裡面就不會有內容瞭，因為錯誤信息會保存是在 stderr 中。

import paramiko

client = paramiko.SSHClient()
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
client.connect(hostname='47.94.174.89', port=22, username='root', password='xxxxxxx')
stdin, stdout, stderr = client.exec_command("xxxxx")
print(stderr.read().decode("utf-8"))
"""
bash: xxxxx: command not found

"""
client.close()

SFTPClient 的使用

SFTPClient 作為一個 sftp 的客戶端對象，根據 ssh 傳輸協議的 sftp 會話，可以實現遠程文件的操作，例如：上傳、下載、查看權限和狀態等等。

import paramiko

# 創建一個 Transport 對象, 使用時會同步創建一個 paramiko.Channel 對象
# 參數傳遞一個由 IP 和 PORT 組成的元組即可
transport = paramiko.Transport(("47.94.174.89", 22))

# 連接 ssh, 通過 username 和 password
transport.connect(username="root", password="xxxxxxx")

# 獲取 SFTPClient 實例, 它便相當於 Linux 下的 sftp, 我們通過它可以進行文件的一些操作
sftp = paramiko.SFTPClient.from_transport(transport)

以上我們便得到的 sftp，那麼它都支持哪些操作呢？

  • put(self, localpath, remotepath, callback=None, confirm=True)：將本地文件上傳到服務器, callback 表示回調函數, 上傳成功後調用; confirm 表示是否調用 stat 方法檢查文件狀態, 返回 ls -l 的結果
  • get(self, remotepath, localpath, callback=None)：將文件從服務器下載到本地
  • mkdir(self, path, mode=o777)：在服務器上創建目錄, mode 表示權限, 默認為 511(o777 是一個變量, 等於 511)
  • rmdir(self, path)：刪除服務器上的目錄
  • remove(self, path)：刪除服務器上的文件
  • rename(self, oldpath, newpath)：對服務器上目錄進行重命名
  • stat(self, path)：查看文件或目錄的狀態
  • listdir(self, path=’.’)：列出服務器目錄下的文件
  • getcwd(self)：查看工作區, 也就是當前所在路徑
  • chmod(self, path, mode)：改變權限
  • chown(self, path, uid, gid): 改變用戶和組
  • chdir(self, path)：改變工作區

常用的大概以上這些，我們來演示一下。

# 1. 改變工作區
sftp.chdir("/usr/local/bin")

# 2. 查看工作區
print(sftp.getcwd()) # /usr/local/bin
sftp.chdir("/root")
print(sftp.getcwd()) # /root
"""
如果不調用 sftp.chdir(path) 的時候, 那麼打印 sftp.getcwd() 時結果為 None
但我們知道登陸 Linux 時, 默認會在 /root 目錄(對於 root 用戶而言)
對於當前的 sftp 而言也確實如此, 隻不過打印 sftp.getcwd() 的時候結果為 None 罷瞭 
"""

# 3. 列出當前目錄下的文件
print(sftp.listdir("/usr/local")) # ['lib', 'lib64', 'games', 'aegis', ...]

# 4. 查看文件或目錄狀態
print(sftp.stat("/root/.ssh/authorized_keys"))
"""
-rw------- 1 0  0    0 16 Dec 13:26 ?
"""

# 5. 改變權限
sftp.chmod("/root/.ssh/authorized_keys", 0o777)
print(sftp.stat("/root/.ssh/authorized_keys"))
"""
-rwxrwxrwx 1 0  0    0 16 Dec 13:26 ?
"""

# 6. 創建目錄
print("dir" in sftp.listdir("/root")) # False
sftp.mkdir("/root/dir", mode=0o777)
print("dir" in sftp.listdir("/root")) # True

# 7. 刪除目錄
sftp.rmdir("/root/dir")
print("dir" in sftp.listdir("/root")) # False

# 8. 刪除文件
sftp.remove("/root/1.py")

# 9. 下載文件
sftp.get("/root/makefile", r"makefile")

# 10. 上傳文件
sftp.put("dockerfile", "/root/dockerfile")

# 最後關閉 sftp 和 transport
sftp.close()
transport.close()

當然我們在介紹 SSHClient 的時候說過，還可以通過 open_sftp 的方式來創建 sftp 客戶端。

import paramiko

client = paramiko.SSHClient()
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
client.connect(hostname='47.94.174.89', port=22, username='root', password='xxxxxxx')
# 這種方式創建也是可以的
sftp = client.open_sftp()

以上就是python基於paramiko庫遠程執行 SSH 命令,實現 sftp 下載文件的詳細內容，更多關於python paramiko庫的資料請關註WalkonNet其它相關文章！

推薦閱讀：