[python] 基于paramiko库操作远程服务器

SSH（Secure Shell）是一种网络安全协议，能够使两台计算机安全地通信和共享数据。目前，SSH协议已在世界各地广泛使用，大多数设备都支持SSH功能。SSH的进一步说明见：深入了解SSH。SSH作为一种协议，存在多种实现，既有商业实现，也有开源实现。OpenSSH是一种流行的SSH协议开源实现，它提供了服务端后台程序和客户端工具，以在远程控制和文件传输期间加密数据。OpenSSH服务端程序一般开发者用不到，OpenSSH提供了以下工具：

• 通过ssh，scp和sftp完成远程操作
• 通过ssh-add，ssh-keysign，ssh-keyscan和ssh-keygen进行密钥管理
• 服务端由sshd，sftp-server和ssh-agent组成

Paramiko是SSHv2协议的Python实现，我们可以在Python代码中直接使用SSH协议对远程服务器执行操作，而不是像OpenSSH通过ssh命令对远程服务器进行操作。Paramiko官方仓库见：paramiko。Paramiko支持Python2.7或者Python3.7版本及以上，安装命令如下：

pip install paramiko

目录

• 1 Paramiko使用
  • 1.1 Paramiko介绍
  • 1.2 SSHClient使用
    • 1.2.1 接口介绍
    • 1.2.2 应用实例
  • 1.3 SFTPClient使用
    • 1.3.1 接口介绍
    • 1.3.2 应用实例
• 2 参考

1 Paramiko使用

1.1 Paramiko介绍

Paramiko提供了实现SSHv2服务端和客户端的核心组件，本文主要介绍在linux下Paramiko客户端连接代码的使用，Paramiko客户端代码包括两个核心类：

• SSHClient实现了OpenSSH中ssh命令所包含的功能，用于远程连接服务器。
• SFTPClient实现了OpenSSH中sftp命令所包含的功能，用于远程操作文件。

Paramiko没有提供scp命令的相关功能，scp和sftp功能类似，都是用于远程操作文件。不同的地方在于scp是轻量级的，scp传输速度通常比sftp快，但是sftp提供了断点续传功能。scp与sftp详细比较见：SCP or SFTP。

1.2 SSHClient使用

1.2.1 接口介绍

SSHClient提供以下常用方法：

# 连接远程服务器
def connect(
    self,
    hostname, # 远程服务器地址，必须
    port=22, # 远程服务器端口
    username=None, # 用户名
    password=None, # 密码
    pkey=None, # 用于身份验证的私钥
    key_filename=None, # 私钥文件
    timeout=None, # 超时时间/s
)

# 加载主机密钥
def load_system_host_keys(self, filename=None)

# 在远程服务器上执行命令
# 返回标准输入stdin,标准输出stdout和标准错误stderr
# 每个exec_command都是单独作用的，先调用的命令不会影响后面命令的结果
def exec_command(
    self,
    command, # 要执行的命令
    timeout=None, # 超时时间/s
)

# 关闭连接
def close(self)

# 在当前ssh连接上，创建一个sftp会话
# 返回SFTPClient对象
def open_sftp(self)

1.2.2 应用实例

下面例子展示了通过Paramiko在远程主机上执行命令。在Paramiko中，要注意的是SSHClient每条cmd命令是单独作用的，前一条cmd命令的执行不会影响后一条命令的结果。关于Paramiko私钥使用见paramiko模块介绍及使用。

import paramiko

# 服务器地址
hostname = '114.114.114.114'
port = 22

username = 'admin'
password = '123456'
# 超时时间/s
timeout = 2
# 每条cmd命令都是单独作用的
# 进入data文件夹，并打印该目录下的文件信息
cmd = 'cd data && ls -l'

# 实例化SSHClient
client = paramiko.SSHClient()
# 加载系统主机密钥,需要在连接服务器前执行该命令
client.load_system_host_keys()
# 连接服务器
client.connect(hostname, port, username, password, timeout=timeout)

# 执行命令获得结果
(stdin, stdout, stderr) = client.exec_command(cmd)

output = stdout.readlines()
# 打印结果
for line in output:
    print(line.strip())

# 关闭连接
client.close()

1.3 SFTPClient使用

1.3.1 接口介绍

SFTPClient提供以下常用方法：

# --- 所有的命令都对应于linux命令
# 关闭连接
def close(self)
# 列出path路径下所有目录文件的名字，相当于执行ls
def listdir(self, path=".")
# 列出path路径下所有目录文件的信息，相当于执行ls -l
def listdir_attr(self, path=".")
# 以mode形式打开远程服务器上某个文件
def open(self, filename, mode="r")
# 删除path文件，path只能是文件
def remove(self, path)
# 将目录或文件从oldpath移动到newpath
def rename(self, oldpath, newpath)
# 创建path目录
def mkdir(self, path)
# 删除空目录path
def rmdir(self, path)
# 返回文件状态
def stat(self, path)
# 创建符号连接
def symlink(self, source, dest)
# 修改文件或目录权限
def chmod(self, path, mode)
# 修改文件拥有者
def chown(self, path, uid, gid)
# 将文件设置为指定大小，类似linux truncate命令
def truncate(self, path, size)
# 返回path的完整路径
def normalize(self, path)
# 将工作路径改为path，该命令会影响SFTPClient的其他命令
def chdir(self, path=None)
# 获得当前工作路径，如果没有调用过chdir函数，则返回None
def getcwd()
# 将本地单个文件上传到服务器
def put(self, localpath, remotepath)
# 将服务器单个文件下载到本地
def get(self, remotepath, localpath)

1.3.2 应用实例

下面例子展示了通过Paramiko连接远程主机，然后通过SFTPClient管理文件。在Paramiko中，SFTPClient不同于SSHClient，SFTPClient各条命令会互相作用。

import paramiko

# 服务器地址
hostname = '114.114.114.114'
port = 22

username = 'admin'
password = '123456'
# 超时时间/s
timeout = 2

# 使用with关键字就不需要主动close了
with paramiko.SSHClient() as client:
    
    client.load_system_host_keys()
    client.connect(hostname, port, username, password,timeout=timeout)
    # 打开sftp连接
    sftp_client = client.open_sftp()
    # 改变工作目录为'data'
    sftp_client.chdir('data')
    # 查看data目录下所有文件
    contents = sftp_client.listdir()
    
    for line in contents:
        print(line)
    # 获得get.py的实际路径
    remote_path = sftp_client.normalize('get.py')
    # 将remote_path下载到本地，并存为data.txt
    output_file = 'data.txt'
    # get和put函数只能对单个文件操作，如果是目录，可以用循环的方式依次处理。
    sftp_client.get(remote_path, output_file)

2 参考

• 什么是SSH？
• paramiko
• SCP or SFTP
• paramiko模块介绍及使用