python_api.md

Cerberus Python API 参考

本文档详细介绍了 Cerberus 的 Python API，主要用于编写插件和进行二次开发。

核心模块 cerberus

Cerberus 类

这是连接 C++ 核心的主要接口类。

from cerberus import Cerberus

core = Cerberus()

方法

greet(name: str) -> str

仅作示例用途 向核心发送问候并接收响应。

• 参数: name (str) - 要问候的名称。
• 返回: (str) 来自 C++ 核心的问候语。

scan(target: str, ports: List[int]) -> Dict

(计划中) 执行端口扫描。

• 参数:
  • target (str): 目标 IP 或域名。
  • ports (List[int]): 要扫描的端口列表。
• 返回: 包含开放端口和服务信息的字典。

---

插件开发接口

BasePlugin 类

(计划中 - 位于 cerberus.plugins.base)

所有自定义插件都应继承此类。

class BasePlugin:
    def __init__(self):
        pass

    def get_info(self) -> dict:
        """返回插件元数据"""
        raise NotImplementedError

    def run(self, target: str, context: dict) -> dict:
        """执行插件逻辑"""
        raise NotImplementedError