异步 SSH:初探 asyncssh

前言

在网络编程中，SSH（Secure Shell）是一种广泛应用的协议，用于安全地在网络上执行命令和管理远程服务器。asyncssh 是Python社区中的一个库，它提供了异步版本的SSH客户端和服务器功能，使得我们可以在不阻塞主线程的情况下进行SSH操作

什么是 asyncssh？

asyncssh 是一个用于异步 SSH 客户端和服务器的 Python 库。它基于 asyncio 库，允许我们在 Python 中进行异步的 SSH 通信。无论是连接到远程设备执行命令，还是创建自己的 SSH 服务器，asyncssh 都能提供简洁且高效的解决方案。

一.安装 asyncssh

pip install asyncssh

二.快速入门

1.连接到 SSH 服务器，并且执行命令

让我们先看一个简单的例子，展示如何连接到一个 SSH 服务器：

import asyncssh
import asyncio




async def connect_ssh():


    try:


        async with asyncssh.connect('192.168.31.230', username='kali', password='kali') as conn:


            result = await conn.run('ls') # 执行ls命令


            print(result.stdout) # 打印输出结果


    except asyncssh.Error as e:


        print('连接失败:', str(e))






asyncio.run(connect_ssh())

输出结果如下

在这个例子中，我们使用 asyncssh.connect() 建立到 SSH 服务器的连接，然后使用 conn.run() 方法执行远程命令。最后，我们打印出执行命令后的输出结果。

2.连接服务器方法

要连接到远程服务器，你需要提供主机名、用户名和密码（或密钥）。以下是一些示例，展示了如何使用不同的身份验证方法连接到远程服务器：

# 使用密码进行身份验证
async with asyncssh.connect('example.com', username='user', password='password') as conn:
    # ...


# 使用密钥进行身份验证
async with asyncssh.connect('example.com', username='user', client_keys='/path/to/private_key') as conn:
    # ...


# 使用密码和密钥进行身份验证
async with asyncssh.connect('example.com', username='user', password='password', client_keys='/path/to/private_key') as conn:
    # ...

asyncssh 也允许我们轻松地创建自己的 SSH 服务器。下面是一个简单的示例：

import asyncssh
import asyncio




async def connect_ssh():


    try:


        async with asyncssh.connect('192.168.31.230', username='kali', password='kali') as conn:


            result = await conn.run('ls') # 执行ls命令


            print(result.stdout) # 打印输出结果


    except asyncssh.Error as e:


        print('连接失败:', str(e))






asyncio.run(connect_ssh())

三.注意事项

1.asyncssh是建立在Python 3.6+的asyncio框架之上的，因此它遵循异步编程的原则。这意味着你需要对asyncio有一定的了解，包括协程、事件循环和异步上下文管理器等概念。asyncssh提供的同步元（synchronization primitives）并不是线程安全的，因此它们不应该用于操作系统的线程同步。对于这种情况，应该使用threading模块。

2.asyncssh支持SSHv2、SFTP和SCP的客户端和服务器功能，以及本地和远程UNIX域套接字转发。在使用asyncssh.connect()函数时，默认情况下会传入当前用户~/.ssh/目录下的known_hosts和id_dsa进行认证。如果需要自定义这些选项，可以在调用connect()时指定相应的参数。

3.在实现基于asyncssh的SSH服务时，需要继承并实现SSHServer类。常见的需要重载的方法包括connection_made、begin_auth、connection_lost等。认证完成后，客户端与服务之间的连接行为则需要通过SSHServerSession类来完成，业务需要继承这个类并重载相关方法如connection_made、pty_requested、shell_requested等。

4.在使用asyncssh时，应当注意异常处理和资源管理。由于asyncssh是基于异步IO的，因此在处理网络请求时可能会遇到各种异常情况，如连接失败、超时等。合理地处理这些异常对于保证程序的稳定性至关重要。同时，使用async with语句可以确保即使在发生异常时也能正确关闭连接，避免资源泄露。

asyncssh 的更多功能

除了上述示例之外，asyncssh 还提供了许多其他功能，比如文件传输、代理功能等。你可以根据自己的需求进一步探索和学习这些功能，深入了解 asyncssh 提供的强大功能请参考官方文档。

https://asyncssh.readthedocs.io/en/latest/