python3 paramiko

介绍

1 Paramiko is a Python (2.6+, 3.3+) implementation of the SSHv2 protocol [1],
2 providing both client and server functionality. 
3 While it leverages a Python C extension for low level cryptography (Cryptography), 
4 Paramiko itself is a pure Python interface around SSH networking concepts.

1 paramiko是用python语言写的一个模块，遵循SSH2协议，支持以加密和认证的方式，进行远程服务器的连接
2 
3 paramiko模块提供了ssh及sft进行远程登录服务器执行命令和上传下载文件的功能

安装

pip install paramiko

使用

1、基于用户名、密码的sshclient方式登陆

 1 # 建立一个sshclient对象
 2 ssh = paramiko.SSHClient()
 3 # 允许将信任的主机自动加入到host_allow 列表，此方法必须放在connect方法的前面
 4 ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
 5 # 调用connect方法连接服务器
 6 ssh.connect(hostname='192.168.100.100', port=22, username='admin', password='admin')
 7 # 执行命令
 8 stdin, stdout, stderr = ssh.exec_command('df -hl')
 9 # 结果放到stdout中，如果有错误将放到stderr中
10 print(stdout.read().decode())
11 # 关闭连接
12 ssh.close()

ssh login

2、基于用户名和密码的 transport 方式登录

SSHClient()里面有一个transport变量，这个是用于获取连接的，因此我们也可以单独的获取到transport变量，然后执行连接操作

 1 # 实例化一个transport对象
 2 trans = paramiko.Transport(('192.168.100.100', 22))
 3 # 建立连接
 4 trans.connect(username='admin', password='admin')
 5 
 6 # 将sshclient的对象的transport指定为以上的trans
 7 ssh = paramiko.SSHClient()
 8 ssh._transport = trans
 9 # 执行命令，和传统方法一样
10 stdin, stdout, stderr = ssh.exec_command('df -hl')
11 print(stdout.read().decode())
12 
13 # 关闭连接
14 trans.close()

trans login

3、基于公钥密钥的 SSHClient 方式登录

 1 # 指定本地的RSA私钥文件,如果建立密钥对时设置的有密码，password为设定的密码，如无不用指定password参数
 2 pkey = paramiko.RSAKey.from_private_key_file('/home/super/.ssh/id_rsa', password='abc123')
 3 # 建立连接
 4 ssh = paramiko.SSHClient()
 5 ssh.connect(hostname='192.168.100.100',
 6             port=22,
 7             username='admin',
 8             pkey=pkey)
 9 # 执行命令
10 stdin, stdout, stderr = ssh.exec_command('df -hl')
11 # 结果放到stdout中，如果有错误将放到stderr中
12 print(stdout.read().decode())
13 # 关闭连接
14 ssh.close()

key ssh login

4、基于密钥的 Transport 方式登录

 1 # 指定本地的RSA私钥文件,如果建立密钥对时设置的有密码，password为设定的密码，如无不用指定password参数
 2 pkey = paramiko.RSAKey.from_private_key_file('/home/super/.ssh/id_rsa', password='abc123')
 3 # 建立连接
 4 trans = paramiko.Transport(('192.168.100.100', 22))
 5 trans.connect(username='super', pkey=pkey)
 6 
 7 # 将sshclient的对象的transport指定为以上的trans
 8 ssh = paramiko.SSHClient()
 9 ssh._transport = trans
10 
11 # 执行命令，和传统方法一样
12 stdin, stdout, stderr = ssh.exec_command('df -hl')
13 print(stdout.read().decode())
14 
15 # 关闭连接
16 trans.close()

key trans login

5、文件上传、下载

 1 # 实例化一个transport对象
 2 trans = paramiko.Transport(('192.168.100.100', 22))
 3 
 4 # 建立连接
 5 trans.connect(username='super', password='super')
 6 
 7 # 实例化一个 sftp对象,指定连接的通道
 8 sftp = paramiko.SFTPClient.from_transport(trans)
 9 
10 # 发送文件
11 sftp.put(localpath='localpath', remotepath='remotepath')
12 
13 # 下载文件
14 # sftp.get(remotepath, localpath)
15 
16 trans.close()

sftp put get

 1 import paramiko
 2 
 3 class SshHelper(object):
 4 
 5     def __init__(self,host,port,username,pwd):
 6         self.host = host
 7         self.port = port
 8         self.username = username
 9         self.pwd = pwd
10         self.transport = None
11 
12     def connect(self):
13         try:
14             transport = paramiko.Transport((self.host, self.port,))
15             transport.connect(username=self.username, password=self.pwd)
16             self.transport = transport
17         except Exception:
18             exit('33[31mConnect Failed33[0m')
19 
20     def upload(self,local,target):
21         sftp = paramiko.SFTPClient.from_transport(self.transport)
22         # 将location.py 上传至服务器 /tmp/test.py
23         sftp.put(local, target)
24         # 将remove_path 下载到本地 local_path
25         # sftp.get('remove_path', 'local_path')
26 
27     def cmd(self,shell):
28         ssh = paramiko.SSHClient()
29         ssh._transport = self.transport
30         stdin, stdout, stderr = ssh.exec_command(shell)
31         print(stdout.read().decode())
32 
33     def close(self):
34         self.transport.close()
35 
36 if __name__ == '__main__':
37 
38     obj = SshHelper('192.168.100.101,'username','password')
39     obj.connect()
40     obj.cmd('df -hT')
41     obj.close()

执行命令及上传下载

6、模拟xshell，输入命令返回结果

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

回车即返回

7、tab自动补全

实现一个xshell登录系统的效果，登录到系统就不断输入命令同时返回结果
支持自动补全，直接调用服务器终端

 1 import paramiko
 2 import os
 3 import select
 4 import sys
 5 import tty
 6 import termios
 7 
 8 
 9 # 建立一个socket
10 trans = paramiko.Transport(('192.168.2.129', 22))
11 
12 # 启动一个客户端
13 trans.start_client()
14 
15 # 如果使用rsa密钥登录的话
16 '''
17 default_key_file = os.path.join(os.environ['HOME'], '.ssh', 'id_rsa')
18 prikey = paramiko.RSAKey.from_private_key_file(default_key_file)
19 trans.auth_publickey(username='admin', key=prikey)
20 '''
21 # 如果使用用户名和密码登录
22 trans.auth_password(username='admin', password='admin')
23 
24 # 打开一个通道
25 channel = trans.open_session()
26 
27 # 获取终端
28 channel.get_pty()
29 
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("
**** EOF **** 
")
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 # 关闭链接
68 trans.close()

tab补齐