[Python]远程SSH库Paramiko简介
文章目录
-
- 核心组件
-
- SSHClient常用方法
- SFTPClient常用方法
- 使用示例
-
- SSH私钥创建
- SSHClient运行命令
-
- 执行多条命令
- SFTPClient下载文件
paramiko（
https://www.paramiko.org/）实现了SSHv2协议(底层使用cryptography)，用于连接远程服务器并执行相关操作，使用该模块可以对远程服务器进行命令或文件操作。
核心组件
若未安装，则先安装pip install paramiko。
paramiko包含两个核心组件，SSHClient和SFTPClient：
SSHClient：类似于Linux的ssh命令，是对SSH会话的封装；该类封装了传输(Transport)，通道(Channel)及SFTPClient建立的方法(open_sftp)，通常用于执行远程命令。SFTPClient：类似于Linux的sftp命令，是对SFTP客户端的封装，用以实现远程文件操作，如文件上传、下载、修改文件权限等操作。
涉及的几个基础名词：
Channel：是一种类Socket，安全的SSH传输通道；Transport：是一种加密的会话，使用时会同步创建了一个加密的通道（Channel）；Session：是client与Server保持连接的对象，用connect()/start_client()/start_server()开始会话。
SSHClient常用方法
SSHClient用于执行ssh命令。
connect()：实现远程服务器的连接与认证，只有hostname是必传参数
hostname：连接的目标主机port=SSH_PORT：SSH端口username=None：登录的用户名password=None：用户密码pkey=None：以私钥方式进行身份验证（代替password方式）key_filename=None：一个文件名或文件列表，指定私钥文件timeout=None：可选的tcp连接超时时间allow_agent=True：是否允许连接到ssh代理，默认为True允许look_for_keys=True：是否在~/.ssh中搜索私钥文件，默认为True允许compress=False：是否打开压缩
set_missing_host_key_policy()：设置远程服务器没有在know_hosts文件中记录时的应对策略
AutoAddPolicy：自动添加主机名及密钥到本地HostKeys对象，即新建立ssh连接时不需要输入yes或no进行确认；WarningPolicy：记录一个未知的主机密钥时会发出警告，功能上和AutoAddPolicy类似，但是会提示是新连接；RejectPolicy：默认选项；自动拒绝未知的主机（本地know_hosts中不存在的）。
exec_command()：在远程服务器执行Linux命令的方法。
open_sftp()：在当前ssh会话的基础上创建一个sftp会话，并返回一个SFTPClient对象
sftp = sshClient.open_sftp()
SFTPClient常用方法
SFTPCLient作为一个sftp的客户端对象，实现远程文件操作，如上传、下载，查询权限、状态等：
from_transport(cls,t)：创建一个已连通的SFTP客户端通道put(localpath, remotepath, callback=None, confirm=True)：将本地文件上传到服务器 参数confirm：是否调用stat()方法检查文件状态，返回ls -l的结果get(remotepath, localpath, callback=None)：从服务器下载文件到本地mkdir()：在服务器上创建目录remove()：在服务器上删除目录rename()：在服务器上重命名目录stat()：查看服务器文件状态listdir()：列出服务器目录下的文件
使用示例
SSH私钥创建
要通过私钥登录，需要先生成私钥（以Windows远程登录Linux为例）：
-
生成私钥：
打开cmd，执行
ssh-keygen；全部回车；
会在‘用户’目录下的
.ssh目录下生成id_rsa与id_rsa.pub文件 -
上传公钥：
复制id_rsa.pub到远端Linux机器的
~/.ssh下；把公钥加入authorized_keys中：
cat id_rsa.pub >> authorized_keys
SSHClient运行命令
以私钥方式登录
def execCmd(host, user, psw, cmd, port=22) -> (str, str):
"""
:param host:
:param user:
:param psw:
:param cmd:
:param port:
:return: (stdout string, stderr string)
"""
with paramiko.SSHClient() as ssh_client:
# 自动添加策略，保存服务器的主机名和密钥信息，须放在connect方法的前面
ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
# 连接SSH服务端，以用户名和密码进行认证
# ssh_client.connect(hostname=host, port=port, username=user, password=psw)
# 连接SSH服务端，以用户名和私钥进行认证
prvKey = paramiko.RSAKey.from_private_key_file(psw)
ssh_client.connect(hostname=host, port=port, username=user, pkey=prvKey)
# 打开一个Channel并执行命令: 正确输出放到stdout中，如果有错误放到stderr中
_, stdout, stderr = ssh_client.exec_command(cmd)
result = stdout.read().decode('utf-8')
# print("[OUT]:", result)
err = stderr.read().decode('utf-8')
# print("[ERR]:", err)
ssh_client.close()
return result, err
以元组方式返回，若有错误则返回的err非空。
执行多条命令
要一次执行多条命令，需要把多条命令以分号分割，且get_pty设为True。
def execMultiCmd(host, user, psw, cmds: list, port=22) -> (str, str):
with paramiko.SSHClient() as ssh_client:
ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
ssh_client.connect(hostname=host, port=port, username=user, password=psw)
cmd = ";".join(cmds)
_, stdout, stderr = ssh_client.exec_command(cmd, get_pty=True)
result = stdout.read().decode('utf-8')
err = stderr.read().decode('utf-8')
return result, err
SFTPClient下载文件
以用户名与密码方式登录：
def downloadFile(host, user, psw, localFile, remoteFile, port=22):
# 实例化一个transport对象
with paramiko.Transport((host, port)) as tran:
# 连接SSH服务端，，以用户名和密码进行认证
tran.connect(username=user, password=psw)
# 连接SSH服务端，以用户名和私钥进行认证
# prvKey = paramiko.RSAKey.from_private_key_file(psw)
# tran.connect(username=user, pkey=prvKey)
# 获取SFTP实例
sftp = paramiko.SFTPClient.from_transport(tran)
# 执行下载动作
sftp.get(remoteFile, localFile)
# 关闭Transport通道
tran.close()
默认远端当前目录是用户home目录，如下载".viminfo"文件：
downloadFile(host, user, psw, "d:\\tmp.conf", ".viminfo")