使用 Python ssh 遠端登陸伺服器的最佳方案
在使用 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)
# 資料清理，格式化的就不展示了
通過以上的文字 + 程式碼的展示 ，可以感覺到 ssh 登陸的幾大痛點
- 痛點一：需要額外安裝 sshpass（如果不免密的話）
- 痛點二：干擾資訊太多，資料清理、格式化相當麻煩
- 痛點三：程式碼實現不夠優雅（有點土），可讀性太差
- 痛點四：ssh 連線不能複用，一次連線僅能執行一次
- 痛點五：程式碼無法全平臺，僅能在 Linux 和 OSX 上使用
為了解決這幾個問題，我搜索了全網關於 Python ssh 的文章，沒有看到有完整介紹這方面的技巧的。
為此，我就翻閱了一個很火的 Github 專案： awesome-python-cn （https://github.com/BingmingWong/awesome-python-cn）。
期望在這裡，找到有一些關於 遠端連線 的一些好用的庫。
還真的被我找到了兩個
- 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("[email protected]","-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("[email protected]","ls -l",_tty_in=True,_out_bufsize=0,_out=ssh_interact)
print(output)
這是官方文件（http://amoffat.github.io/sh/tutorials/interacting_with_processes.html?highlight=ssh）給的一些資訊，寫的一個demo。
嘗試執行後，發現程式會一直在執行中，永遠不會返回，不會退出，回撥函式也永遠不會進入。
通過除錯檢視原始碼，仍然查不到問題所在，於是去 Github 上搜了下，原來在 2017 年就已經存在這個問題了，到現在 2020 年了還沒有修復，看來使用 sh.ssh 的人並不多，於是我又“追問”了下，期望能得到回覆。
以上這個問題，只有在需要輸入密碼才會出現，如果設定了機器互信是沒有問題的。
為了感受 sh.ssh 的使用效果，我設定了機器互信免密，然後使用如下這段程式碼。
from sh import ssh
my_server=ssh.bake("[email protected]","-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 可以解決痛點一（如果上述問題能得到解決）、痛點二、痛點三。
但是它仍然無法複用 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_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',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,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. 參考連結
https://github.com/paramiko/paramiko
http://docs.paramiko.org
https://www.jb51.net/article/182044.htm
到此這篇關於使用 Python ssh 遠端登陸伺服器的最佳方案的文章就介紹到這了,更多相關使用 Python ssh 遠端登陸伺服器的最佳方案內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！