使用 Python 遠程登錄服務器的最佳實踐

公衆號：《Python編程時光》，做者：明哥

在使用 Python 寫一些腳本的時候，在某些狀況下，咱們須要頻繁登錄遠程服務去執行一次命令，並返回一些結果。

在 shell 環境中，咱們是這樣子作的。

$ sshpass -p ${passwd} ssh -p ${port} -l ${user} -o StrictHostKeyChecking=no xx.xx.xx.xx "ls -l"
複製代碼

而後你會發現，你的輸出有不少你並不須要，可是又不去不掉的一些信息（也許有方法，請留言交流），相似這樣

host: xx.xx.xx.xx, port: xx
Warning: Permanently added '[xx.xx.xx.xx]:xx' (RSA) to the list of known hosts.
Login failure: [Errno 1] This server is not registered to rmp platform, please confirm whether cdn server.
total 4
-rw-r--r-- 1 root root 239 Mar 30  2018 admin-openrc
複製代碼

對於直接使用 shell 命令，來執行命令的，能夠直接使用管道，或者將標準輸出重定向到文件的方法取得執行命令返回的結果

1. 使用 subprocess

如果使用 Python 來作這件事，一般咱們會第一時間，想到使用 os.popen，os.system，commands，subprocess 等一些命令執行庫來間接獲取 。

可是據我所知，這些庫獲取的 output 不只只有標準輸出，還包含標準錯誤（也就是上面那些多餘的信息）

因此每次都要對 output 進行的數據清洗，而後整理格式化，才能獲得咱們想要的數據。

用 subprocess 舉個例子，就像這樣子

import subprocess
ssh_cmd = "sshpass -p ${passwd} ssh -p 22 -l root -o StrictHostKeyChecking=no xx.xx.xx.xx 'ls -l'"
status, output = subprocess.getstatusoutput(ssh_cmd)

# 數據清理，格式化的就不展現了
<code...>
複製代碼

經過以上的文字 + 代碼的展現 ，能夠感受到 ssh 登錄的幾大痛點

• 痛點一：須要額外安裝 sshpass（若是難免密的話）
• 痛點二：干擾信息太多，數據清理、格式化至關麻煩
• 痛點三：代碼實現不夠優雅（有點土），可讀性太差
• 痛點四：ssh 鏈接不能複用，一次鏈接僅能執行一次
• 痛點五：代碼沒法全平臺，僅能在 Linux 和 OSX 上使用

爲了解決這幾個問題，我搜索了全網關於 Python ssh 的文章，沒有看到有完整介紹這方面的技巧的。

爲此，我就翻閱了一個很火的 Github 項目： awesome-python-cn （github.com/BingmingWon…

指望在這裏，找到有一些關於 遠程鏈接 的一些好用的庫。

還真的被我找到了兩個

• sh.ssh
• Paramiko

2. 使用 sh.ssh

首先來介紹第一個，sh.ssh

sh 是一個可讓你經過函數的調用來完成 Linxu/OSX 系統命令的一個庫，很是好用，關於它有機會也寫篇介紹。

$ python3 -m pip install sh
複製代碼

今天只介紹它其中的一個函數：ssh

一般兩臺機器互訪，爲了方便，可設置免密登錄，這樣就不須要輸入密碼。

這段代碼能夠實現免密登錄，並執行咱們的命令 ls -l

from sh import ssh
output=ssh("root@xx.xx.xx.xx", "-p 22", "ls -l")
print(output)
複製代碼

但有可能 ，咱們並不想設置互信免密，爲了使這段代碼更通用，我假定咱們沒有設置免密，只能使用密碼進行登錄。

問題就來了，要輸入密碼，必須得使用交互式的方法來輸入呀，在 Python 中要如何實現呢？

原來 ssh 方法接收一個 _out 參數，這個參數能夠爲一個字符串，表示文件路徑，也能夠是一個文件對象（或者類文件對象），還能夠是一個回調函數，意思是當有標準輸出時，就會調用將輸出內容傳給這個函數。

這就好辦了呀。

我只要識別到有 password: 字樣，就往標準輸入寫入個人密碼就行了呀。

完整代碼以下：

import sys
from sh import ssh

aggregated = ""
def ssh_interact(char, stdin):
    global aggregated
    sys.stdout.write(char.encode())
    sys.stdout.flush()
    aggregated += char
    if aggregated.endswith("password: "):
        stdin.put("you_password\n")

output=ssh("root@xx.xx.xx.xx", "-p 22", "ls -l",_tty_in=True, _out_bufsize=0, _out=ssh_interact)
print(output)
複製代碼

這是官方文檔（amoffat.github.io/sh/tutorial…

嘗試運行後，發現程序會一直在運行中，永遠不會返回，不會退出，回調函數也永遠不會進入。

經過調試查看源代碼，仍然查不到問題所在，因而去 Github 上搜了下，原來在 2017 年就已經存在這個問題了，到如今 2020 年了尚未修復，看來使用 sh.ssh 的人並很少，因而我又「追問」了下，指望能獲得回覆。

以上這個問題，只有在須要輸入密碼纔會出現，若是設置了機器互信是沒有問題的。

爲了感覺 sh.ssh 的使用效果，我設置了機器互信免密，而後使用以下這段代碼。

from sh import ssh

my_server=ssh.bake("root@xx.xx.xx.xx", "-p 22")

# 至關於執行登錄一次執行一次命令，執行完就退出登錄
print(my_server.ls())

# 可在 sleep 期間，手動登錄服務器，使用 top ，查看當前有多少終端在鏈接
time.sleep(5)

# 再次執行這條命令時，登錄終端數將 +1，執行完後，又將 -1
print(my_server.ifconfig())
複製代碼

驚奇地發現使用 bake 這種方式，my_server.ls() 和 my_server.ifconfig() 這種看似是經過同一個ssh鏈接，執行兩次命令，可實際上，你能夠在遠程機器上，執行 top 命令看到已鏈接的終端的變化，會先 +1 再 -1，說明兩次命令的執行是經過兩次鏈接實現的。

如此看來，使用 sh.ssh 能夠解決痛點一（若是上述問題能獲得解決）、痛點2、痛點三。

可是它仍然沒法複用 ssh 鏈接，仍是不太方便，不是我理想中的最佳方案。

最重要的一點是， sh 這個模塊，僅支持 Linxu/OSX ，在 Windows 你得使用它的兄弟庫 - pbs ，而後我又去 pypi 看了一眼 pbs，已經 「年久失修」，沒人維護了。

至此，我離 「卒」，就差最後一根稻草了。

3. 使用 paramiko

帶着最後一絲但願，我嘗試使用了 paramiko 這個庫，終於在 paramiko 這裏，找回了本應屬於 Python 的那種優雅。

你能夠經過以下命令去安裝它

$ python3 -m pip install paramiko
複製代碼

而後接下來，就介紹幾種經常使用的 ssh 登錄的方法

方法1：基於用戶名和密碼的 sshclient 方式登陸

而後你能夠參考以下這段代碼，在 Linux/OSX 系統下進行遠程鏈接

import paramiko

ssh = paramiko.SSHClient()
# 容許鏈接不在know_hosts文件中的主機
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())

# 創建鏈接
ssh.connect("xx.xx.xx.xx", username="root", port=22, password="you_password")

# 使用這個鏈接執行命令
ssh_stdin, ssh_stdout, ssh_stderr = ssh.exec_command("ls -l")

# 獲取輸出
print(ssh_stdout.read())

# 關閉鏈接
ssh.close()
複製代碼

方法2：基於用戶名和密碼的 transport 方式登陸

方法1 是傳統的鏈接服務器、執行命令、關閉的一個操做，多個操做須要鏈接屢次，沒法複用鏈接[痛點四]。

有時候須要登陸上服務器執行多個操做，好比執行命令、上傳/下載文件，方法1 則沒法實現，那就可使用 transport 的方法。

import paramiko

# 創建鏈接
trans = paramiko.Transport(("xx.xx.xx.xx", 22))
trans.connect(username="root", password="you_passwd")

# 將sshclient的對象的transport指定爲以上的trans
ssh = paramiko.SSHClient()
ssh._transport = trans

# 剩下的就和上面同樣了
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
ssh_stdin, ssh_stdout, ssh_stderr = ssh.exec_command("ls -l")
print(ssh_stdout.read())

# 關閉鏈接
trans.close()
複製代碼

方法3：基於公鑰密鑰的 SSHClient 方式登陸

import paramiko

# 指定本地的RSA私鑰文件
# 若是創建密鑰對時設置的有密碼，password爲設定的密碼，如無不用指定password參數
pkey = paramiko.RSAKey.from_private_key_file('/home/you_username/.ssh/id_rsa', password='12345')

# 創建鏈接
ssh = paramiko.SSHClient()
ssh.connect(hostname='xx.xx.xx.xx',
            port=22,
            username='you_username',
            pkey=pkey)

# 執行命令
stdin, stdout, stderr = ssh.exec_command('ls -l')

# 結果放到stdout中，若是有錯誤將放到stderr中
print(stdout.read())

# 關閉鏈接
ssh.close()
複製代碼

方法4：基於密鑰的 Transport 方式登陸

import paramiko

# 指定本地的RSA私鑰文件
# 若是創建密鑰對時設置的有密碼，password爲設定的密碼，如無不用指定password參數
pkey = paramiko.RSAKey.from_private_key_file('/home/you_username/.ssh/id_rsa', password='12345')

# 創建鏈接
trans = paramiko.Transport(('xx.xx.xx.xx', 22))
trans.connect(username='you_username', pkey=pkey)

# 將sshclient的對象的transport指定爲以上的trans
ssh = paramiko.SSHClient()
ssh._transport = trans

# 執行命令，和傳統方法同樣
stdin, stdout, stderr = ssh.exec_command('df -hl')
print(stdout.read().decode())

# 關閉鏈接
trans.close()
複製代碼

以上四種方法，能夠幫助你實現遠程登錄服務器執行命令，若是須要複用鏈接：一次鏈接執行屢次命令，可使用 方法二 和 方法四

用完後，記得關閉鏈接。

實現 sftp 文件傳輸

同時，paramiko 作爲 ssh 的完美解決方案，它很是專業，利用它還能夠實現 sftp 文件傳輸。

import paramiko

# 實例化一個trans對象# 實例化一個transport對象
trans = paramiko.Transport(('xx.xx.xx.xx', 22))

# 創建鏈接
trans.connect(username='you_username', password='you_passwd')

# 實例化一個 sftp對象,指定鏈接的通道
sftp = paramiko.SFTPClient.from_transport(trans)

# 發送文件
sftp.put(localpath='/tmp/11.txt', remotepath='/tmp/22.txt')

# 下載文件
sftp.get(remotepath='/tmp/22.txt', localpath='/tmp/33.txt')
trans.close()
複製代碼

到這裏，Paramiko 已經完勝了，可是仍然有一個痛點咱們沒有說起，就是多平臺，說的就是 Windows，這裏就有一件好事，一件壞事了，。

好事就是：paramiko 支持 windows

壞事就是：你須要作不少複雜的準備，你可 google 解決，可是我建議你直接放棄，坑太深了。

4. 寫在最後

通過了一番對比，和一些實例的展現，能夠看出 Paramiko 是一個專業、讓人省心的 ssh 利器，我的認爲 Paramiko 模塊是運維人員必學模塊之一，若是你剛好須要在 Python 代碼中實現 ssh 到遠程服務器去獲取一些信息，那麼我把 Paramiko 推薦給你。

最後，但願這篇文章，能給你帶來幫助。

5. 參考連接

• github.com/paramiko/pa…
• docs.paramiko.org
• www.liujiangblog.com/blog/15/

本篇文章由一文多發平臺ArtiPub自動發佈