来源 | Python编程时光(ID: Cool-Python)
在使用 Python 写一些脚本的时候,在某些情况下,我们需要频繁登陆远程服务去执行一次命令,并返回一些结果。
在 shell 环境中,我们是这样子做的。T v F
$ sshpass -p ${passwd} ssh -p ${port} -l $q E g T{user} -o StrictHostKeyChecking=no xx.xxb 3 P o @ _ , W.xx.xx \"ls -l\"
然后你会发现,你的输出有很多你并不需要,但是又不去不掉的一些信息(也许有方法,请留言交流),类似这样。
host: xx.xx.xx.xx, port: xx
Warning: Permanently added \'[ e Z j K 4xx.xx.F c 0 p Z * c Mxx.xx]:xx\' (RSA) to the list of known hosts.
Login failure: [Errno 1] This server is n2 N n e ! o ^ot registered to rmp platform, please confirm whether cdn server.
total 4
-rw-r--r-- 1 root root 2395 y A : Mar 30 2018 admin-openrc
对于直接使用 shel u ! wll 命令,来执行命令的,可 J o r / - 以直接使用管道,或者q J #将标准输出重^ C ?定向到文件的方法取得p ~ d执行命令返回的结果。
使用 subprocess
若是使用 Py Q 6 | 3 xthon 来做这件事,通常我们会第一时间,想到使用 os.popen,os.system,commands,subprh { ,ocess 等一些命令执行库来间接获取 。
但是据我所知,这些库获取的 output 不仅只有标准输出,还包含标准错误(也就是上面那些多余的信息)
所以每次都^ P N要对 output 进行的数t Q K o @ E a据清洗,然后整理格式化,才能得到我们想要的数据。
用 s~ ( u X N iubprocess 举个例子,就像这样子
i^ I z M a amport subprocess
ssh_cmd = \"sshpass -p ${p1 P 2 q o g 8 xasswd} ssh -p 22 -l root -o StrictHostKeyChecking=no xx.xx.xx.xx \'ls -l\'\"
status, output = subpr@ ) U W / R d # ocess.getstatusoutput(ssh_cmd)
# 数据清理,格式化的就不展示了
<code1 & l 1 L...>
通过以上的文字 + 代码的展示 ,可以感觉到 ssh 登陆的几大痛点
-
痛点一:需要8 ] - b G .额外安装 ssf [ O h , g n hpass(如果不免密+ u *的话)
-
痛点二:干扰r P B J Q a )信息太多,数据清理、格式化相当麻烦
-
痛点三:代码实现不够优雅(有点土),可读性太差
-
痛点四:ssh 连接不能复用,一次连接仅能执行一次
-
痛点五:代码无法全平台,仅能在 Linux 和 OSX 上使用
为了解决这几个问题,我搜索了全网关于 PI e T ^ = ! d | tython ssh 的文章,没有看到有完整介绍这方面的技巧的。
为此,我就翻阅了一个很火的? S o GiP R lthub 项目:awesome-python-cn (https://github.S b C s _ Qcom/BingmingWong/awesome-python-cn)。
期望在这里,找到有一些关于 远程连接 的一些好用的库。
还真的被我找到了两个] 7 ` u + % j 2 :
-
sh.ssh
-
Paramiko
使用 sh.ssh
首先来介绍第一个,sh.sshsh是一个可以让你通过函数的调用来完成 Linxu/OSX 系统命令的一个库,非常好用,关于它有机会也写篇介绍。
$ python3 -m pip install sh
今天只介绍它其中的一个函数:ssh
通常两台机器1 6 1 P d ~ H # E互访,为了方便,可设置免密登陆,这样就不需要输入密码。
这段代码可以实现免密登陆,并执# S w k 5 ( j M行我们的命令 ls -l
from shL c 2 e import ssh
output=ssh(\"root@xx.xx.xx.xx\", \"-p 22\", \"ls -l\")
print! l * 8 b 1 } 1 $(output)
但有可能 ,我们并不想设置互信免密,为了使Q ! j S t Y这段代码更通用,我假定我l W ] Q !们没有设置免密,只能使用密码进行登陆。
问题就来了,要输入密码,必须得使用交互式的方法来输入呀,在 PythonV ^ % ? d 0 Z 中要如何实现呢?
原来 ssh 方法接收一个 _out参数,这个参数可以为一个字符串,表示文件路径,也可以是y m $一个文件对象(或者类文件对象),还可以是一个回调函数,意思是当有标准输L @ Y _出时,就会调用将输出内容传给这个函数。
这就好办了呀。
我只要识别K V i j P b ^ Q $到有 password:字样,就往标准输入写入我的密码就好了呀。
完整代码如下:
import sys
from sh import ssh
aggregated = \"\b A ! A R"
def ssh_interact(char, st] P +din):
global aggregated
sys.stdout.write(char.encode)
sys.stdout.flush
aggregated += char
if aggregated.endsw { hwG z (ith(\Q K d O $ [ y H ="password: \"):
stdin.put(k ] b ^ S\"you_password\\n\")
output=ssh(\"root@xx.xx.xx.x. 4 r j o i Px\", \"-L * G 3 h Sp 22\", \"ls -l\",_tty_iD u o 5 2 j D Cn=True, _out_bufsize=0, _out=ssh_interact)B q * 9 ! r V
print(output)
这是根据官方文档(http://amoffat.github.io/sw 9 3h/tutorials/interacting_with_processes.html?highlight=ssh)W L g b K给的一些信息,写的一个demo。
尝试运行后,发现程序会一直在运行中,永远不会返回,不会退出,回调函数也永远不会进入。
通过调试查看源代码,仍然查不到问题所在,于是去+ = 8 w Github 上搜了下,原来在 2017 年就已经存在这个问题了,到现在 2020 年了还没有修复,看来使用 sh.ssh的人并不多,于是我又“追问”了下a l Z - | | { [,期望能得到回复。
以上这个问题,只有在需要输入密码才会出现,如果设置了机器互信是没有问题的。
为了感受 sh.ssh的使用效果,我设置了机A % o Z L F ~ ,器互信免密,然^ f z后使用如下这段代码。
from sh import ssh
my_server=ssh.bake(\"root@xx.xx.xx.xx\0 1 Z v i I _ -", \"-p 22\")
# 相当于执行登陆一次执行一次命令,执行完就退出登陆
print(my_server.ls)
# 可在 sleep 期间,手动登陆服务器,使用 top ,查看当前有多少终端在} v b e 连接
time.sleep(5)
# 再次执行这条命令时,登陆终端数将 +1,执行完后,又将 -1
print(my_serverD 4 r d.ifconfig)
惊奇地发现使用 bake这种方式,my_server.ls和my_server.ifcoN 9 M vnfig这种看似是t X J 1 B ~ r ;通过同一个ssh连接,执行两次命令,可实际上,你可以在远程机器上,执行 top 命令看到已连接的终端的变化,会先+1再-1,说明两次命令的执行是通过两次连接实现的。如此看来,使用sh.ssh可以解决痛点一(如果上述问题能得到解决)、痛点二、痛点Z m ~三。
但是它仍然无法复用 ssh 连接,还是不太方便,不是我理想中的最佳方案。
最重要的一点是, sh这个模块,仅支持 Linxu/OSX ,在 Windows 你得使用它的+ Y L D兄弟库 -pbs,然后| + #我又去 pypi 看了一眼 pbs,已经 “年久失修”,没人维护了。
至此,我离 “卒”,就差最后一根稻草R k | W r W s i 7了。
使用 paramiko
带着最后一丝希望,我尝试使用了 paramiko这个库,终于在parame e i ; ) } } O Hikop + 2 ~ n u J这里,找回了本应属于 Python 的那种优A I E d w雅。
你可以通过如下命令去安装它
$ python31 J [ S ( n Z -m pip install paramiko
然后接下来,就介绍几种常用的 ssh 登陆的方法
方法1:基于用户名x ; x g _ n u 3 g和密码的 sshclient 方式登录
然后你可以参考如下这段代码,在 Linux/OSX 系统下进行远程连接
importV J c g [ ] v paramiko
ssh = paramiko.SSHClient
# 允许连接不在know_hosts文件中的主机
ssh.set_missing_host_key_policy(p? D 1 garamiko.AutoAddPolicy)
# 建立连接
ssh.connect(\"xx.xx.xx.xx\", username=\"root\", port=22, pac * B h 4ssword=\"you_O _ 7password\")
# 使用这个连接执行命令
ssh_stdin, ssh_stdout, ssh_stderr = sA r Y g S e ` wsh.exec_command(\"ls -l\")
# 获取输出
print(ssh_stdout.read)
# 关闭连接
ssh.close
方法2:基于用户名和密码的 transport 方式登录
方法1 是C ! e I [传统的连接服务器、执行命令、关闭的一个操作,多个操作需要连接多次,无法复用连接[痛点四]。
有时候需要登录上服务器执行多个操作,K l b V F比如执行命令、上传/下载文件,方法1 则无法实现,那就可以( D U N R 9 U H使用 transport 的方法。
import paramiko
# 建立连接
trans = paramikoI p E M #.Transp} = o 3 xort((\"xx.xx.xx.^ ^ K q V } Exx\", 22))
trans.connect(u/ a 2 j ( _ Fsp s $ Xername=\"root\", password=\"you_passwd\"i W S)
# 将sshcd g e = ] { (lient的对象的transport指定为以上的trans
ssh = paramiko.SSHClient
ssh._transport = trr P ` 3 W jans
# 剩下的就和上面一样了
ssh.set_missing_host_key_policy(paramikq z C 1o.Auto. $ o *AddPolicy)
ssh_stdin, ssh_std+ V bout, ssh_stderr = ssh.exec_command(\"ls -l\")
print(ssh_stdouT = Gt.read)
# 关闭连接
trans.close
方法3:基于公钥密钥的 SSHClient 方式登s F @ G V录
import paramiko
# 指定本地的RJ 8 wSA私钥文件@ 2 O 2
# 如果建立密钥对时设C P { o置的有密码,password为设定的密码,如无不用指定password参数
pkey = paramiko.RSAKey.froy t C 8 j % L bm_private_key_file(\'/home/you_username/.ssh/id_rsa\', password=\'12345\')
# 建立连接
ssh = paramiko.SSHClient
ssh.connect(hostname=\'xx.xx.xx.xx\',
por] u n $ $ & /t=22,
username=\'you_user1 t F 0 m Aname\',
pkey=pkk ` { 7 T A / Key)
# 执行命令
stdin, stdout, stderr = ssh.exec_command(\'ls -l\')
# 结果放到stdout中,如果有错误将放到sZ s 1 Z itderr中) i 4 v n v E r
print(stdout.read)
# 关闭连接
ssh.close
方法4:基于密钥的 TransD D = ^ / } F Mport 方式登录
iy 7 ) ; $ i ~ jmport paramiko
# 指定本地的RSA私钥文件
# 如果建立密钥对时设置的有密码,password为3 W {设定的密码,如无不用指定passwoM f c M #rd参数
pkey = paramiko.RSAKey.from_privatp C _ F L ( we_key_file(\'/home/you_username/.ssh/id_rsa\', password=\'123451 c a Y D *\')
# 建立连接
trans = paramiko.Transport((\'xx.xx.xx.xx\', 2M - J r N 0 {2))
trans.connect(username=\/ 0 u X g'you_username\', pkey=pkey)
# 将sshclient的对象的transport指定为以上的trans
ssh = paramiko.SSHClient
ssh._transport = trans
# 执行命令,和传统方法一样
stdinX q q + / H 4 =, stdout, stderr = ssh.exec_command(\'df -hl\')
print(stdout.read.N u y y y 0 ` !decode)
# 关闭连接
trans.close
以上四种方法,可以帮助你实现远程登陆服务器执行命令,如果需要复用连接:一次连接执行多次命令,可以使用 方法二和方法四。
用完后,记得关闭连接。
实现 sftp 文件传输
同时,paramiko 做为 ssh 的完美解决方案,它非常专业,利用它还可以实现 sftp 文件传输。
import paramiko
# 实例化一个trans对象# 实例化一个transport对象
trans = paramiko.TraW T v ? P H Yn` U t 0 bsport(4 _ t r w j / ?(\'xx.xx.xx.xx\', 22))
# 建立连接
trans.connect(username=\'you_username\', password=\'you{ H r_passwd\')
# 实例化一个 sftp对象,指定连接的通道
sftp = paramiko.SFTPClient.from_transport(trans)
# 发送文件
sftp.put(localpath=\'/tmp/11.txt\', remotepath=\K u 4 6 + X P v .'/tmp/22.txt\')
# 下载文件
sftZ l c j v ~ op.get(remotG ; + N t &epath=\'/tmp/22.txt\'G c ^ s W 4 Y {, localpath=\'/tmp/33.txt\')
trans.close
到这里,Paramiko 已经完胜了,但是仍然有一个痛点我们没有提及,就是多平台,说的就是 Windows,这里就有一件好事,一件坏事了,。
好事就是:pal & W w . [ramiko 支持 windows坏事就是:你需要做很多复杂的准备,你8 ^ c b W可 googl1 O # Y W te 解决,但是我建议你直接放弃,坑太深了。
写在最后
经过了一番对比,和一些实例的展示,可以看出 Paramikq M ) 2 8 , = 8o 是一个专业、让人省心R M 的 ssh 利器,个人认为 Paramiko 模* c Y 9块是运维人员必学模块之一: I 0 | @ j P 2,如果你恰好需要在 Python 代码中实) & x 8 W 4现 ssh 到远程服务器去获取一些信息,那么我把 Paramiko 推荐给你。; P J D
最后,希望这篇文章,能a ? ` $给你带来帮助。
参考链接
-
https://gith8 F g ( 5 ]ub.com/paramiko/paramiko
-
http://docs.paramiko.org
-
https://www.liujiangblog.com/blog/15/
【end】
《原力计划【第二季】- 学习力挑战》正式开始% W 7 . H K b (!
即日起至 3月21日,千万流量支持原创作者更有专属【勋章】等你来挑战
-
大脑芯片公司Neuralink计划在人脑内植入芯片,他们到底想干什么?
-
机器学习新闻综述:2019年AI领域不得不看的6篇文章
-
近一半程序员单身、年薪低于 15 万,程序员扎C W T心现状大7 k ? V z P R t调查!
-
Spark大数据分布式机器学习处理实战k a 8 y + r ` P | 博文精选
-
程W a 6 /序员删库跑路不可防,但是这你应该防了......
-
深耕技术,与实践赛跑:一文告诉你如何稳妥/ S h N快速完善区块链技术并有序推动商用?