MockSSH - Mock an SSH server and define all commands it supp

项目说明

MockSSH
=======

Mock SSH servers and all commands they support.

Purpose
-------
This project was de to emulate operating systems
behind SSH servers in order to test task automation without
having access to the real servers.

Finally Mock SSH has been fully modernized as of 2.0.0,
requiring Python 3.12+ and featuring a robust, type-safe
architecture with modern testing and linting (pytest, Ruff).
It provides a threaded for performing end-to-end
unit tests against mocked SSH services.

Installation
------------
MockSSH requires Python 3.12+. It uses a modern pyproject.toml based build system.

De
-----------
The project provides several de commands via make:

To install the de dependencies (Ruff, mypy, pytest, pre-commit):

To run the linters and format the code (using Ruff):

To run static type checking (using mypy):

To run the tests:

To build source and wheel distributions:

To install the pre-commit hooks:

Mock SSH in Python
-----------------
MockSSH aims to be as easy to use as possible.

Refer to the mock_cisco.py and mock_F5.py in the examples/
directory for an o on how to use it.

Mock SSH in LISP
---------------
Efforts were in in simplifying the use of MockSSH
with HyLang.

As a result a DSL is released with this project and
resides in the *mocksshy/* directory.

Using the DSL will allow you to Mock SSH by writing
something that is closer to a configuration file than
a program.

For comparison, here are two ways to Mock SSH servers
implementations pro the same functionality:

*Python*

*HyLang*

Unit Testing with MockSSH
-------------------------
As shown from the unit tests in the tests/ directory, it is possible to use
a threaded MockSSH server to perform end-to-end unit tests against mocked
SSH services.

MockSSH now uses pytest and pytest-twisted to manage the Twisted
reactor lifecycle cleanly. This allows the entire test suite to run in a
single process.

Documentation (Wiki)
--------------------
Comprehensi is a in the docs/wiki/ directory,
co foundational concepts, architecture, custom command definition,
and testing strategies.

AI-Powered Automation
---------------------
MockSSH is integrated with the Gemini CLI to automate routine de tasks:
* Automated Issue Triage: New issues are automatically analyzed and labeled.
* Intelligent Code Review: Pull requests receive an initial automated review from Gemini.
* Autonomous Implementation: Appro can be executed by Gemini to speed up de.

Refer to GEMINI.md for more details on the automation workflows.

Security
--------
MockSSH is designed for testing and emulation. When implementing custom commands:
* Avoid Sensiti: Do not use print() or log to output raw user input or passwords.
* Host Key Permissions: Ensure your host keys (in generated-keys/) ha permissions (chmod 600).
* Secret Management: Do not store sensiti (like Service Account keys) in the repository.

License
-------
MockSSH is released under the LGPL-3.0-or-later license.

Credits
-------
MockSSH was inspired by kippo, an SSH honeypot, and

项目信息

开发语言：Python

Star 数：129

技术要点

该项目属于红蓝攻防方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕Mock an SSH server and define all commands it supports (Python, Twisted)展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。