Python 遠程連接服務器，用它就夠了
在 shell 環(huán)境中，我們是這樣子做的。
$?sshpass?-p?${passwd}?ssh?-p?${port}?-l?${user}?-o?StrictHostKeyChecking=no?xx.xx.xx.xx?"ls?-l"
然后你會發(fā)現(xiàn)，你的輸出有很多你并不需要，但是又不去不掉的一些信息（也許有方法，請留言交流），類似這樣
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 命令，來執(zhí)行命令的，可以直接使用管道，或者將標準輸出重定向到文件的方法取得執(zhí)行命令返回的結(jié)果
# 1. 使用 subprocess
若是使用 Python 來做這件事，通常我們會第一時間，想到使用 os.popen，os.system，commands，subprocess 等一些命令執(zhí)行庫來間接獲取 。
但是據(jù)我所知，這些庫獲取的 output 不僅只有標準輸出，還包含標準錯誤（也就是上面那些多余的信息）
所以每次都要對 output 進行的數(shù)據(jù)清洗，然后整理格式化，才能得到我們想要的數(shù)據(jù)。
用 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)
#?數(shù)據(jù)清理，格式化的就不展示了
通過以上的文字 + 代碼的展示 ，可以感覺到 ssh 登陸的幾大痛點
痛點一：需要額外安裝 sshpass（如果不免密的話）
痛點二：干擾信息太多，數(shù)據(jù)清理、格式化相當麻煩
痛點三：代碼實現(xiàn)不夠優(yōu)雅（有點土），可讀性太差
痛點四：ssh 連接不能復用，一次連接僅能執(zhí)行一次
痛點五：代碼無法全平臺，僅能在 Linux 和 OSX 上使用
為了解決這幾個問題，我搜索了全網(wǎng)關(guān)于 Python?SSH?的文章，還真的被我找到了兩個庫
sh.ssh
Paramiko
# 2. 使用 sh.ssh
首先來介紹第一個，sh.ssh
sh 是一個可以讓你通過函數(shù)的調(diào)用來完成 Linxu/OSX 系統(tǒng)命令的一個庫，非常好用，關(guān)于它有機會也寫篇介紹。
$?python3?-m?pip?install?sh
今天只介紹它其中的一個函數(shù)：ssh
通常兩臺機器互訪，為了方便，可設置免密登陸，這樣就不需要輸入密碼。
這段代碼可以實現(xiàn)免密登陸，并執(zhí)行我們的命令 ls -l
from?sh?import?ssh
output=ssh("[email protected]",?"-p?22",?"ls?-l")
print(output)
但有可能 ，我們并不想設置互信免密，為了使這段代碼更通用，我假定我們沒有設置免密，只能使用密碼進行登陸。
問題就來了，要輸入密碼，必須得使用交互式的方法來輸入呀，在 Python 中要如何實現(xiàn)呢？
原來 ssh 方法接收一個 _out 參數(shù)，這個參數(shù)可以為一個字符串，表示文件路徑，也可以是一個文件對象（或者類文件對象），還可以是一個回調(diào)函數(shù)，意思是當有標準輸出時，就會調(diào)用將輸出內(nèi)容傳給這個函數(shù)。
這就好辦了呀。
我只要識別到有 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]",?"-p?22",?"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。
嘗試運行后，發(fā)現(xiàn)程序會一直在運行中，永遠不會返回，不會退出，回調(diào)函數(shù)也永遠不會進入。
通過調(diào)試查看源代碼，仍然查不到問題所在，于是去 Github 上搜了下，原來在 2017 年就已經(jīng)存在這個問題了，到現(xiàn)在 2020 年了還沒有修復，看來使用 sh.ssh 的人并不多，于是我又“追問”了下，期望能得到回復。
以上這個問題，只有在需要輸入密碼才會出現(xiàn)，如果設置了機器互信是沒有問題的。
為了感受 sh.ssh 的使用效果，我設置了機器互信免密，然后使用如下這段代碼。
from?sh?import?ssh
my_server=ssh.bake("[email protected]",?"-p?22")
#?相當于執(zhí)行登陸一次執(zhí)行一次命令，執(zhí)行完就退出登陸
print(my_server.ls())
#?可在?sleep?期間，手動登陸服務器，使用?top?，查看當前有多少終端在連接
time.sleep(5)
#?再次執(zhí)行這條命令時，登陸終端數(shù)將?+1，執(zhí)行完后，又將?-1
print(my_server.ifconfig())
驚奇地發(fā)現(xiàn)使用 bake 這種方式，my_server.ls() 和 my_server.ifconfig() 這種看似是通過同一個ssh連接，執(zhí)行兩次命令，可實際上，你可以在遠程機器上，執(zhí)行 top 命令看到已連接的終端的變化，會先 +1 再 -1，說明兩次命令的執(zhí)行是通過兩次連接實現(xiàn)的。
如此看來，使用 sh.ssh 可以解決痛點一（如果上述問題能得到解決）、痛點二、痛點三。
但是它仍然無法復用 ssh 連接，還是不太方便，不是我理想中的最佳方案。
最重要的一點是， sh 這個模塊，僅支持 ?Linxu/OSX ，在 Windows 你得使用它的兄弟庫 - pbs ，然后我又去 ?pypi 看了一眼 pbs，已經(jīng) “年久失修”，沒人維護了。
至此，我離 “卒”，就差最后一根稻草了。
# 3. 使用 paramiko
帶著最后一絲希望，我嘗試使用了 paramiko 這個庫，終于在 paramiko 這里，找回了本應屬于 Python 的那種優(yōu)雅。
你可以通過如下命令去安裝它
$?python3?-m?pip?install?paramiko
然后接下來，就介紹幾種常用的 ssh 登陸的方法
?方法1：基于用戶名和密碼的 sshclient 方式登錄
然后你可以參考如下這段代碼，在 Linux/OSX 系統(tǒng)下進行遠程連接
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")
#?使用這個連接執(zhí)行命令
ssh_stdin,?ssh_stdout,?ssh_stderr?=?ssh.exec_command("ls?-l")
#?獲取輸出
print(ssh_stdout.read())
#?關(guān)閉連接
ssh.close()
?方法2：基于用戶名和密碼的 transport 方式登錄
方法1 是傳統(tǒng)的連接服務器、執(zhí)行命令、關(guān)閉的一個操作，多個操作需要連接多次，無法復用連接[痛點四]。
有時候需要登錄上服務器執(zhí)行多個操作，比如執(zhí)行命令、上傳/下載文件，方法1 則無法實現(xiàn)，那就可以使用 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())
#?關(guān)閉連接
trans.close()
?方法3：基于公鑰密鑰的 SSHClient 方式登錄
import?paramiko
#?指定本地的RSA私鑰文件
#?如果建立密鑰對時設置的有密碼，password為設定的密碼，如無不用指定password參數(shù)
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)
#?執(zhí)行命令
stdin,?stdout,?stderr?=?ssh.exec_command('ls?-l')
#?結(jié)果放到stdout中，如果有錯誤將放到stderr中
print(stdout.read())
#?關(guān)閉連接
ssh.close()
?方法4：基于密鑰的 Transport 方式登錄
import?paramiko
#?指定本地的RSA私鑰文件
#?如果建立密鑰對時設置的有密碼，password為設定的密碼，如無不用指定password參數(shù)
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
#?執(zhí)行命令，和傳統(tǒng)方法一樣
stdin,?stdout,?stderr?=?ssh.exec_command('df?-hl')
print(stdout.read().decode())
#?關(guān)閉連接
trans.close()
以上四種方法，可以幫助你實現(xiàn)遠程登陸服務器執(zhí)行命令，如果需要復用連接：一次連接執(zhí)行多次命令，可以使用 方法二 和 方法四
用完后，記得關(guān)閉連接。
?實現(xiàn) sftp 文件傳輸
同時，paramiko 做為 ssh 的完美解決方案，它非常專業(yè)，利用它還可以實現(xiàn) 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)
#?發(fā)送文件
sftp.put(localpath='/tmp/11.txt',?remotepath='/tmp/22.txt')
#?下載文件
sftp.get(remotepath='/tmp/22.txt',?localpath='/tmp/33.txt')
trans.close()
到這里，Paramiko 已經(jīng)完勝了，但是仍然有一個痛點我們沒有提及，就是多平臺，說的就是 Windows，這里就有一件好事，一件壞事了，。
好事就是：paramiko 支持 windows
壞事就是：你需要做很多復雜的準備，你可 google 解決，但是我建議你直接放棄，坑太深了。
?注意事項
使用 paramiko 的時候，有一點需要注意一下，這個也是我自己 "踩坑" 后才發(fā)現(xiàn)的，其實我覺得這個設計挺好的，如果你不需要等待它返回數(shù)據(jù)，可以直接實現(xiàn)異步效果，只不過對于不知道這個設計的人，確實是個容易掉坑的點
就是在執(zhí)行 ssh.exec_command(cmd) 時，這個命令并不是同步阻塞的。
比如下面這段代碼，執(zhí)行時，你會發(fā)現(xiàn) 腳本立馬就結(jié)束退出了，并不會等待 5 s 后，再 執(zhí)行 ssh.close()
import?paramiko
trans?=?paramiko.Transport(("172.20.42.1",?57891))
trans.connect(username="root",?password="youpassword")
ssh?=?paramiko.SSHClient()
ssh._transport?=?trans
stdin,?stdout,?stderr?=?ssh.exec_command("sleep?5;echo?ok")
ssh.close()
但是如果改成這樣，加上一行 stdout.read()， paramiko 就知道，你需要這個執(zhí)行的結(jié)果，就會在 read() 進行阻塞。
import?paramiko
trans?=?paramiko.Transport(("172.20.42.1",?57891))
trans.connect(username="root",?password="youpassword")
ssh?=?paramiko.SSHClient()
ssh._transport?=?trans
stdin,?stdout,?stderr?=?ssh.exec_command("sleep?5;echo?ok")
#?加上一行?read()
print(stdout.read())
ssh.close()
# 4. 寫在最后
經(jīng)過了一番對比，和一些實例的展示，可以看出 Paramiko 是一個專業(yè)、讓人省心的 ssh 利器，個人認為 Paramiko 模塊是運維人員必學模塊之一，如果你恰好需要在 Python 代碼中實現(xiàn) ssh 到遠程服務器去獲取一些信息，那么我把 Paramiko 推薦給你。
最后，希望這篇文章，能給你帶來幫助。
# 5. 參考鏈接
https://github.com/paramiko/paramiko
http://docs.paramiko.org
https://www.liujiangblog.com/blog/15/
http://docs.paramiko.org/en/stable/
