BBOT项目模块开发指南：从入门到实践

前言

BBOT作为一个功能强大的安全扫描框架，其模块化设计允许开发者轻松扩展功能。本文将详细介绍如何为BBOT开发自定义模块，帮助安全研究人员和技术人员快速上手模块开发。

模块基础结构

1. 创建模块文件

在BBOT模块目录下创建新的Python文件，文件名将自动成为模块名（不区分大小写）。每个模块必须继承自BaseModule基类。

from bbot.modules.base import BaseModule

class my_module(BaseModule):
    # 模块配置将在这里定义
    pass

2. 核心属性定义

每个模块需要定义几个关键属性：

• watched_events: 指定模块监听的事件类型
• produced_events: 指定模块产生的事件类型
• flags: 定义模块特性（如passive/active, safe/aggressive）
• meta: 模块元信息，如描述等

class whois(BaseModule):
    watched_events = ["DNS_NAME"]
    produced_events = ["WHOIS"]
    flags = ["passive", "safe"]
    meta = {"description": "Query WhoisXMLAPI for WHOIS data"}

模块生命周期方法

1. setup()方法

setup()在扫描开始时执行一次，用于初始化操作：

async def setup(self):
    self.api_key = self.config.get("api_key")
    if not self.api_key:
        return None, "Must set API key"  # 软失败
    return True  # 初始化成功

setup()可以返回三种状态：

• True: 初始化成功
• None: 软失败（模块禁用但扫描继续）
• False: 硬失败（中止整个扫描）

2. handle_event()方法

这是模块的核心逻辑所在，处理接收到的每个事件：

async def handle_event(self, event):
    # 处理事件逻辑
    response = await self.helpers.request(url)
    if response:
        await self.emit_event(response.json(), "WHOIS", parent=event)

模块配置系统

BBOT提供了灵活的配置系统：

1. 定义配置选项

options = {
    "api_key": "",
    "timeout": 10
}
options_desc = {
    "api_key": "WhoisXMLAPI Key",
    "timeout": "Request timeout in seconds"
}

2. 使用配置

配置可以通过多种方式传递：

1. 命令行参数：

bbot -m my_module -c modules.my_module.timeout=15

2. 配置文件：

modules:
  my_module:
    timeout: 15

3. 模块内获取：

timeout = self.config.get("timeout", 10)

依赖管理

BBOT使用Ansible管理模块依赖：

deps_apt = ["chromium-browser"]  # APT包依赖
deps_pip = ["requests"]  # Python包依赖
deps_ansible = [  # 复杂依赖安装
    {
        "name": "Install dev tools",
        "package": {"name": ["gcc", "git", "make"], "state": "present"},
        "become": True
    }
]

调试与测试

BBOT提供了丰富的日志方法：

self.hugesuccess("操作成功")  # 亮绿色
self.hugewarning("警告信息")  # 亮橙色
self.hugeinfo("信息提示")  # 亮蓝色
self.debug("调试信息")  # 灰色（需-d参数）

测试模块：

bbot -t example.com -m my_module -v

自定义模块目录

可以将模块放在自定义目录，无需修改BBOT安装目录：

module_dirs:
  - /path/to/my/modules

最佳实践

1. 事件处理：确保handle_event高效且不会阻塞
2. 错误处理：合理捕获和处理异常
3. 资源管理：及时释放网络连接等资源
4. 日志记录：适当使用不同级别的日志
5. 配置验证：在setup()中验证配置有效性

结语

通过本文，您应该已经掌握了BBOT模块开发的核心概念。模块化设计是BBOT强大扩展能力的基础，合理利用这一特性可以极大丰富扫描功能。建议从简单模块开始，逐步掌握更复杂的开发模式。