介绍
paramiko是一个基于SSH用于连接远程服务器并执行相关操作(SSHClient和SFTPClinet,即一个是远程连接,一个是上传下载服务),使用该模块可以对远程服务器进行命令或文件操作,值得一说的是,fabric和ansible内部的远程管理就是使用的paramiko来现实。
安装
Paramiko模块内部依赖pycrypto,所以先下载安装pycrypto,再安装Paramiko
模块使用
SSHClient:
远程连接分为两种:(1)基于用户名密码连接 (2)基于公钥秘钥连接
通过是用paramiko远程操作,其实本质也分为两种:(1)只用SSHClient (2)自己创建一个transport
(1)基于用户名和密码的sshclient连接
import paramiko
# 创建一个sshclient对象
ssh=paramiko.SSHClient()
# 将要连接的主机加入到host_allow信任列表,此方法必须放在connect方法的前面
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
# 调用connect方法连接服务器
ssh.connect(hostname='192.168.2.129', port=22, username='super', password='super')
#执行命令
stdin, stdout, stderr = ssh.exec_command('df -hl')
# 结果放到stdout中,如果有错误将放到stderr中
print (str(stdout.read(),encoding='utf-8'))
ssh.close()
基于用户名和密码的transport连接
上面的方法是传统的连接服务器、执行命令、关闭的一个操作,有时候需要登录上服务器执行多个操作,比如执行命令、上传/下载文件,方法1则无法实现,可以通过如下方式来操作
# 实例化一个transport对象
trans = paramiko.Transport(('192.168.2.129', 22))
# 建立连接
trans.connect(username='super', password='super')
# 将sshclient的对象的transport指定为以上的trans
ssh = paramiko.SSHClient()
ssh._transport = trans
# 执行命令,和传统方法一样
stdin, stdout, stderr = ssh.exec_command('df -hl')
print(stdout.read().decode())
# 关闭连接
trans.close()
(2)基于秘钥sshclient连接
# 指定本地的RSA私钥文件,如果建立密钥对时设置的有密码,password为设定的密码,如无不用指定password参数
pkey = paramiko.RSAKey.from_private_key_file('/home/super/.ssh/id_rsa', password='12345')
# 建立连接
ssh = paramiko.SSHClient()
ssh.connect(hostname='192.168.2.129',
port=22,
username='super',
pkey=pkey)
# 执行命令
stdin, stdout, stderr = ssh.exec_command('df -hl')
# 结果放到stdout中,如果有错误将放到stderr中
print(stdout.read().decode())
# 关闭连接
ssh.close()
以上需要确保被访问的服务器对应用户.ssh目录下有authorized_keys文件,也就是将服务器上生成的公钥文件保存为authorized_keys。并将私钥文件作为paramiko的登陆密钥
基于秘钥transport连接
# 指定本地的RSA私钥文件,如果建立密钥对时设置的有密码,password为设定的密码,如无不用指定password参数
pkey = paramiko.RSAKey.from_private_key_file('/home/super/.ssh/id_rsa', password='12345')
# 建立连接
trans = paramiko.Transport(('192.168.2.129', 22))
trans.connect(username='super', 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()
(3)文件上传
# 实例化一个trans对象# 实例化一个transport对象
trans = paramiko.Transport(('192.168.2.129', 22))
# 建立连接
trans.connect(username='super', password='super')
# 实例化一个 sftp对象,指定连接的通道
sftp = paramiko.SFTPClient.from_transport(trans)
# 发送文件
sftp.put(localpath='/tmp/11.txt', remotepath='/tmp/22.txt')
# 下载文件
# sftp.get(remotepath, localpath)
trans.close()
实现输入命令立马返回结果的功能
以上操作都是基本的连接,如果我们想实现一个类似xshell工具的功能,登录以后可以输入命令回车后就返回结果:


1 import paramiko 2 import os 3 import select 4 import sys 5 6 # 建立一个socket 7 trans = paramiko.Transport(('192.168.2.129', 22)) 8 # 启动一个客户端 9 trans.start_client() 10 11 # 如果使用rsa密钥登录的话 12 ''' 13 default_key_file = os.path.join(os.environ['HOME'], '.ssh', 'id_rsa') 14 prikey = paramiko.RSAKey.from_private_key_file(default_key_file) 15 trans.auth_publickey(username='super', key=prikey) 16 ''' 17 # 如果使用用户名和密码登录 18 trans.auth_password(username='super', password='super') 19 # 打开一个通道 20 channel = trans.open_session() 21 # 获取终端 22 channel.get_pty() 23 # 激活终端,这样就可以登录到终端了,就和我们用类似于xshell登录系统一样 24 channel.invoke_shell() 25 # 下面就可以执行你所有的操作,用select实现 26 # 对输入终端sys.stdin和 通道进行监控, 27 # 当用户在终端输入命令后,将命令交给channel通道,这个时候sys.stdin就发生变化,select就可以感知 28 # channel的发送命令、获取结果过程其实就是一个socket的发送和接受信息的过程 29 while True: 30 readlist, writelist, errlist = select.select([channel, sys.stdin,], [], []) 31 # 如果是用户输入命令了,sys.stdin发生变化 32 if sys.stdin in readlist: 33 # 获取输入的内容 34 input_cmd = sys.stdin.read(1) 35 # 将命令发送给服务器 36 channel.sendall(input_cmd) 37 38 # 服务器返回了结果,channel通道接受到结果,发生变化 select感知到 39 if channel in readlist: 40 # 获取结果 41 result = channel.recv(1024) 42 # 断开连接后退出 43 if len(result) == 0: 44 print("\r\n**** EOF **** \r\n") 45 break 46 # 输出到屏幕 47 sys.stdout.write(result.decode()) 48 sys.stdout.flush() 49 50 # 关闭通道 51 channel.close() 52 # 关闭链接 53 trans.close()
支持tab自动补全


1 import paramiko 2 import os 3 import select 4 import sys 5 import tty 6 import termios 7 8 ''' 9 实现一个xshell登录系统的效果,登录到系统就不断输入命令同时返回结果 10 支持自动补全,直接调用服务器终端 11 12 ''' 13 # 建立一个socket 14 trans = paramiko.Transport(('192.168.2.129', 22)) 15 # 启动一个客户端 16 trans.start_client() 17 18 # 如果使用rsa密钥登录的话 19 ''' 20 default_key_file = os.path.join(os.environ['HOME'], '.ssh', 'id_rsa') 21 prikey = paramiko.RSAKey.from_private_key_file(default_key_file) 22 trans.auth_publickey(username='super', key=prikey) 23 ''' 24 # 如果使用用户名和密码登录 25 trans.auth_password(username='super', password='super') 26 # 打开一个通道 27 channel = trans.open_session() 28 # 获取终端 29 channel.get_pty() 30 # 激活终端,这样就可以登录到终端了,就和我们用类似于xshell登录系统一样 31 channel.invoke_shell() 32 33 # 获取原操作终端属性 34 oldtty = termios.tcgetattr(sys.stdin) 35 try: 36 # 将现在的操作终端属性设置为服务器上的原生终端属性,可以支持tab了 37 tty.setraw(sys.stdin) 38 channel.settimeout(0) 39 40 while True: 41 readlist, writelist, errlist = select.select([channel, sys.stdin,], [], []) 42 # 如果是用户输入命令了,sys.stdin发生变化 43 if sys.stdin in readlist: 44 # 获取输入的内容,输入一个字符发送1个字符 45 input_cmd = sys.stdin.read(1) 46 # 将命令发送给服务器 47 channel.sendall(input_cmd) 48 49 # 服务器返回了结果,channel通道接受到结果,发生变化 select感知到 50 if channel in readlist: 51 # 获取结果 52 result = channel.recv(1024) 53 # 断开连接后退出 54 if len(result) == 0: 55 print("\r\n**** EOF **** \r\n") 56 break 57 # 输出到屏幕 58 sys.stdout.write(result.decode()) 59 sys.stdout.flush() 60 finally: 61 # 执行完后将现在的终端属性恢复为原操作终端属性 62 termios.tcsetattr(sys.stdin, termios.TCSADRAIN, oldtty) 63 64 # 关闭通道 65 channel.close() 66 # 关闭链接 67 trans.close()