Python建立ssh连接|paramiko实践

一时失言乱红尘 2022-12-28 06:21 494阅读 0赞

![format_png][]

之前写了一篇[Python调用系统命令的六种方法][Python]，但是执行linux命令时，需要在本地运行，如果想远程执行命令，就要用到另一个库paramiko。

paramiko是python的第三方库，遵循SSH2协议，支持以加密和认证的方式，进行远程服务器的连接，不仅可以远程执行shell命令，还可以实现服务器文件的上传、下载。相当于一个Python版本的xshell和xftp工具。

安装

`pip install paramiko`

项目地址： https://github.com/paramiko/paramiko

官方文档： http://docs.paramiko.org/

paramiko主要包含两个类：SSHClient、SFTPClient

SSHClient是对SSH会话的封装，该类封装了传输(Transport)，通道(Channel)等，通常用于执行远程命令。

SFTPClient是对SFTP客户端的封装，用以实现远程文件操作，如文件上传、下载、修改文件权限等操作。

## SSHClient类的使用 ##

SSHClient类的主要方法：

1.connect方法，实现远程ssh连接并校验

connect()
    常用参数：
    hostname 连接的目标主机
    port=SSH_PORT 指定端口
    username=None 验证的用户名
    password=None 验证的用户密码
    pkey=None 私钥方式用于身份验证
    key_filename=None 一个文件名或文件列表，指定私钥文件
    timeout=None 可选的tcp连接超时时间
    allow_agent=True, 是否允许连接到ssh代理，默认为True 允许
    look_for_keys=True 是否在~/.ssh中搜索私钥文件，默认为True 允许
    compress=False, 是否打开压缩

2.exec\_command方法，执行远程命令的方法

exec_command(command)
    参数：
    Command str :命令串
    # 执行多个命令，可使用以下方法：
    ssh.exec_command('cd /home;ls -l')

3.set\_missing\_host\_key\_policy

连接主机没有本地主机秘钥或者HostKeys对象时策略，目前支持三种：

*  AutoAddPolicy:自动添加主机名以及主机秘钥
 *  RejectPolicy（默认）：自动拒绝未知的主机名和秘钥
 *  WarningPolicy：用于记录一个未知主机秘钥的Python警告

ssh = paramiko.SSHClient()
    ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())

#### 使用实例 ####

1.基于用户名和密码的 sshclient 方式登录

# 创建SSH对象
    ssh = paramiko.SSHClient()
    
    # 允许连接不在know_hosts文件中的主机
    ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    
    # 连接服务器
    ssh.connect('192.168.1.120',22,'root','123456')
    
    # 执行命令
    stdin, stdout, stderr = ssh.exec_command('date')
    
    # 获取命令结果
    res, err = stdout.read(), stderr.read()
    result = res if res else err
    print(result.decode('utf-8'))
    
    # 关闭连接
    ssh.close()

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

import paramiko
    
    # 实例化一个transport对象
    transport = paramiko.Transport(('192.168.1.120', 22))
    
    # 建立连接
    transport.connect(username='root', password='123456')
    
    # 将sshclient的对象的transport指定为以上的transport
    ssh = paramiko.SSHClient()
    ssh._transport = transport
    
    # 执行命令，和传统方法一样
    stdin, stdout, stderr = ssh.exec_command('date')
    print (stdout.read().decode())
    
    # 关闭连接
    transport.close()

3.基于密钥连接方式登录

import paramiko
    
    # 配置私人密钥文件位置
    private = paramiko.RSAKey.from_private_key_file('/Users/ch/.ssh/id_rsa')
    #实例化SSHClient
    client = paramiko.SSHClient()
    #自动添加策略，保存服务器的主机名和密钥信息，如果不添加，那么不再本地know_hosts文件中记录的主机将无法连接
    client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
    
    #连接SSH服务端，以用户名和密码进行认证
    client.connect(hostname='192.168.1.1',port=22,username='root',pkey=private)

## SFTPClient类的使用 ##

#### 常用方法 ####

1、from\_transport方法，创建一个已经连通的sftp客户端通道

2、put方法

put(self,localpath,remotepath) #将本地文件上传到服务器 
    Localpath  str : 上传文件本地源
    Remotepath str : 远程路径

3、get方法

get(remotepath, localpath, callback``=``None``) #从服务器下载文件到本地

4、其他方法

mkdir 创建目录 sftp.mkdr(‘/home/user’,0755)
    remove 删除主机端指定目录 sftp.remove(‘/home/user’)
    rename 从命名服务端的文件或者目录 sftp.rename(“/home/test.sh”,”/home/newtest.sh”)
    listdir  获取远程SFTP服务器端指定的目录列表，返回list形式 sftp.listdir(“/home”)
    stat 获取远程主机指定文件信息 sftp.stat(“/home/test.sh”)

#### 使用实例 ####

import paramiko
    
    transport = paramiko.Transport(('192.168.1.120',22))
    transport.connect(username='root',password='123456')
    
    sftp = paramiko.SFTPClient.from_transport(transport)
    
    # 将localfile.txt 上传至服务器 /home/remotefile.txt
    
    sftp.put('D:\localfile.txt', '/home/remotefile.txt')
    
    # 将/home/testa.txt 下载到本地 D:\helloword.txt
    
    sftp.get('/home/testa.txt', 'D:\helloword.txt')
    transport.close()

可以根据需要，将常用的功能封装，比如实现一个类似xshell工具的功能，登录以后可以输入命令回车后就返回结果，具体实现逻辑如下：

import paramiko
    import os
    
    import sys
    
    # 建立一个socket
    trans = paramiko.Transport(('192.168.1.120', 22))
    
    # 启动一个客户端
    trans.start_client()
    
    # 使用用户名和密码登录
    trans.auth_password(username='super', password='super')
    
    # 打开一个通道
    channel = trans.open_session()
    
    # 获取终端
    channel.get_pty()
    
    # 激活终端，这样就可以登录到终端了，就和我们用类似于xshell登录系统一样
    channel.invoke_shell()
    
    # 下面就可以执行你所有的操作
    
    
    # 关闭通道
    channel.close()
    
    # 关闭链接
    trans.close()

这里有一个简单的paramiko方法封装，可以实现shell命令执行、文件上传下载等操作，点击**阅读原文**获取。

![format_png 1][]

[format_png]: /images/20221120/88a2f7260e0c49e8a5ea5ea6099d25ac.png
[Python]: http://mp.weixin.qq.com/s?__biz=MzI5NzIyMjQwNA%3D%3D&chksm=ecb9347adbcebd6cdf9c48072dd88143e935945f13df48b2762dee5132cb29695d1dbf92a646&idx=2&mid=2247490577&scene=21&sn=66d12a79c0d2724f8a241c2198226a71#wechat_redirect
[format_png 1]: /images/20221120/22866b42d1d14a8ea92089b7e064ee94.png