【經驗分享】用Python遠程登陸服務器的最佳實戰

在使用 Python 寫一些腳本的時候,在某些情況下,我們需要頻繁登陸遠程服務去執行一次命令,並返回一些結果。

在 shell 環境中,我們是這樣子做的。

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

然後你會發現,你的輸出有很多你並不需要,但是又不去不掉的一些信息(也許有方法,請留言交流),類似這樣

在學習過程中有什麼不懂得可以加我的
python學習qun,855408893
羣裏有不錯的學習視頻教程、開發工具與電子書籍。  
與你分享python企業當下人才需求及怎麼從零基礎學習好python,和學習什麼內容

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("[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]", "-p 22", "ls -l",_tty_in=True, _out_bufsize=0, _out=ssh_interact)
print(output)

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

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

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

爲了感受 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_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 解決,但是我建議你直接放棄,坑太深了。

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-vkpnCBhU-1587976086456)(https://upload-images.jianshu.io/upload_images/22699699-66215844342672ac.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)]

4. 寫在最後

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

爲解決初學者學習上的困難,專門建立的Python學習扣QUN:⑧⑤⑤-④零⑧-⑧⑨③從零基礎開始到Python各領域的項目實戰教程、開發工具與電子書籍。與你分享企業當下對於python人才需求及學好python的高效技巧,不停更新最新教程!點擊加入我們的 python學習圈

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章