King Phisher插件开发教程：扩展你的钓鱼工具包功能

King Phisher插件开发教程：扩展你的钓鱼工具包功能

【免费下载链接】king-phisherPhishing Campaign Toolkit项目地址: https://gitcode.com/gh_mirrors/ki/king-phisher

King Phisher是一款功能强大的钓鱼活动工具包，从1.3.0版本开始引入了插件系统，支持客户端和服务器端插件扩展。本文将为你提供完整的King Phisher插件开发指南，帮助你轻松扩展钓鱼工具包功能。

插件系统概述

King Phisher插件系统允许用户添加主流应用之外的额外功能，这些插件以Python模块形式实现，定义一个Plugin类作为入口点，并通过类属性提供各种元数据。插件核心功能由plugins模块提供，客户端和服务器端实现分别位于king_phisher/client/plugins.py和king_phisher/server/plugins.py。

客户端插件基础

插件结构

客户端插件需要继承自king_phisher.client.plugins.ClientPlugin类，通过config属性访问持久化配置存储。插件元数据通过类属性提供，包括作者、标题、描述等信息，无需初始化类即可访问。

插件管理器

插件管理器窗口加载时会导入所有可用插件以获取元数据，启用插件时会创建Plugin类实例。右键点击插件可选择"Reload"选项重新加载，已启用的插件会先禁用再重新启用，可能丢失状态信息。

兼容性检查

插件可通过信息面板查看兼容性，包括是否满足所有依赖要求。点击"Compatible"链接可查看具体要求及满足情况，帮助用户判断插件无法使用的原因。

插件开发步骤

1. 环境准备

确保已安装King Phisher 1.3.0或更高版本，建议使用Python 3.3.0以上环境。克隆仓库：

git clone https://gitcode.com/gh_mirrors/ki/king-phisher

2. 基本插件模板

以下是一个简单的"Hello World"插件示例：

import king_phisher.client.plugins as plugins import king_phisher.client.gui_utilities as gui_utilities class Plugin(plugins.ClientPlugin): authors = ['Your Name'] title = 'Hello World!' description = """ 一个基础的插件模板，演示King Phisher插件开发的基本结构。 当King Phisher退出时，此插件将显示一个消息框。 """ options = [ plugins.ClientOptionString( 'name', '要问候的名称', default='用户', display_name='你的名字' ), plugins.ClientOptionBoolean( 'show_message', '是否显示告别消息', default=True, display_name='显示消息' ) ] req_min_version = '1.4.0' version = '1.0' def initialize(self): print('Hello World!') self.signal_connect('exit', self.signal_exit) return True def finalize(self): print('Good Bye World!') def signal_exit(self, app): if not self.config['show_message']: return gui_utilities.show_dialog_info( f"再见 {self.config['name']}！", app.get_active_window() )

3. 插件选项类型

客户端插件支持多种选项类型，可通过GUI配置：

• ClientOptionBoolean：布尔值选项
• ClientOptionEnum：枚举选项
• ClientOptionInteger：整数选项
• ClientOptionPath：路径选择
• ClientOptionPort：端口号
• ClientOptionString：字符串选项

这些选项类在king_phisher/client/plugins.py中定义，可通过display_name参数自定义显示名称。

4. 信号与事件处理

插件可以连接到应用程序的信号，如示例中的exit信号。更多信号可参考官方文档docs/source/king_phisher/client/server_events.rst。

5. 依赖管理

插件可通过req_packages指定依赖包，通过req_min_version指定King Phisher最低版本要求，通过req_platforms指定支持的平台。例如：

req_packages = { 'requests': True, 'pyyaml': False } req_min_version = '1.5.0' req_platforms = ('Linux', 'Windows')

插件安装与测试

1. 将插件保存为.py文件
2. 打开King Phisher客户端
3. 导航到插件管理器（Plugins → Plugin Manager）
4. 点击"Add"按钮选择插件文件
5. 启用插件并测试功能

高级开发技巧

• 状态保持：使用self.config存储持久化数据
• UI集成：通过gui_utilities模块创建自定义对话框
• 服务器交互：使用self.application.rpc进行RPC调用
• 错误处理：实现except块捕获异常，确保插件稳定性

开发资源

• 官方插件文档：docs/source/plugins/index.rst
• 客户端插件参考：docs/source/plugins/client.rst
• 服务器插件参考：docs/source/plugins/server.rst
• 示例插件：data/client/king_phisher/plugins/check_for_updates.py

通过本教程，你已掌握King Phisher插件开发的基础知识。开始创建你自己的插件，扩展这个强大钓鱼工具包的功能吧！无论是自动化任务、添加新功能还是集成第三方服务，插件系统都能帮你实现。

【免费下载链接】king-phisherPhishing Campaign Toolkit项目地址: https://gitcode.com/gh_mirrors/ki/king-phisher