贡献Recog项目：从提交新指纹到参与社区协作完整指南

【免费下载链接】recogPattern recognition for hosts, services, and content项目地址: https://gitcode.com/gh_mirrors/re/recog

Recog是一个强大的开源指纹识别框架，用于通过匹配网络探测返回的数据来识别产品、服务和操作系统。如果你是网络安全爱好者或开发人员，想要为这个实用的指纹识别工具贡献力量，本指南将为你提供从入门到精通的全流程指导。🎯

为什么贡献Recog项目？🤔

Recog作为网络安全领域的重要工具，其价值在于不断更新的指纹数据库。每个新指纹的添加都让整个网络安全社区受益，帮助安全研究人员和渗透测试人员更准确地识别目标系统。通过贡献指纹，你不仅提升了自己的技术能力，还为全球网络安全防御体系添砖加瓦。

准备工作：搭建本地开发环境

在开始贡献之前，你需要建立本地开发环境。首先克隆项目仓库：

git clone https://gitcode.com/gh_mirrors/re/recog.git cd recog bundle install

确保你安装了Ruby 2.31+版本以及bundler gem。项目使用Git进行版本控制，建议配置上游仓库以便同步最新更改：

git remote add upstream git@github.com:rapid7/recog.git

理解Recog指纹文件结构 📁

Recog的指纹存储在XML文件中，每个文件针对特定的协议响应字符串或字段。指纹文件位于xml/目录下，例如：

• xml/ssh_banners.xml- SSH服务指纹
• xml/http_servers.xml- HTTP服务器指纹
• xml/ftp_banners.xml- FTP服务指纹

每个指纹文件遵循特定的XML结构，包含匹配规则、描述信息和示例数据。让我们看看一个典型的指纹文件结构：

<fingerprints matches="ssh.banner"> <fingerprint pattern="^OpenSSH_([\d\.]+[a-z]*)"> <description>OpenSSH server</description> <example service.version="8.9p1">OpenSSH_8.9p1</example> <param pos="0" name="service.vendor" value="OpenBSD"/> <param pos="0" name="service.product" value="OpenSSH"/> <param pos="1" name="service.version"/> </fingerprint> </fingerprints>

创建新指纹：分步教程 📝

步骤1：识别目标服务

首先，你需要收集目标服务的banner信息。例如，通过nmap扫描获取SSH服务banner：

nmap -sV -script=banner -p 22 target_ip

假设你发现一个不常见的SSH服务，banner为"MyCustomSSH_2.1.3"。

步骤2：选择合适的指纹文件

根据服务类型选择对应的指纹文件。对于SSH服务，编辑xml/ssh_banners.xml文件。

步骤3：编写指纹规则

在文件末尾添加新的指纹条目。使用正则表达式捕获关键信息：

<fingerprint pattern="^MyCustomSSH_([\d\.]+)$"> <description>MyCustom SSH Server</description> <example service.version="2.1.3">MyCustomSSH_2.1.3</example> <param pos="0" name="service.vendor" value="MyCompany"/> <param pos="0" name="service.product" value="MyCustomSSH"/> <param pos="1" name="service.version"/> </fingerprint>

步骤4：添加多个示例

为了提高匹配准确性，建议添加多个示例：

<example service.version="2.0.1">MyCustomSSH_2.0.1</example> <example service.version="2.1.0">MyCustomSSH_2.1.0</example>

指纹编写最佳实践 ✨

正则表达式技巧

1. 保持灵活性：使用[\d\.]+而不是\d+\.\d+来匹配各种版本格式
2. 忽略大小写：使用(?i)标志进行不区分大小写匹配
3. 避免过度匹配：使用^和$锚定字符串边界

参数命名规范

遵循项目已有的命名约定：

• service.vendor- 服务提供商
• service.product- 产品名称
• service.version- 版本号
• os.vendor- 操作系统厂商
• os.product- 操作系统产品

临时参数的使用

对于复杂的匹配场景，可以使用临时参数：

<fingerprint pattern="^foo baz switchThing-(\d{4})$"> <description>NetCorp NX series switches</description> <example hw.product="NX8200">foo baz switchThing-8200</example> <param pos="0" name="hw.vendor" value="NetCorp"/> <param pos="0" name="hw.product" value="NX{_tmp.001}"/> <param pos="2" name="_tmp.001"/> </fingerprint>

测试你的指纹 ✅

使用recog_verify工具

在提交前，务必测试你的指纹：

bin/recog_verify xml/ssh_banners.xml

这个命令会验证所有示例是否能够正确匹配，并检查XML格式是否正确。

手动测试匹配

使用recog_match工具测试具体字符串：

echo 'MyCustomSSH_2.1.3' | bin/recog_match xml/ssh_banners.xml -

预期输出应该显示匹配成功的信息。

运行完整测试套件

执行项目的测试套件确保没有破坏现有功能：

rake tests

标准化标识符 📋

Recog使用标识符文件来保持一致性。在identifiers/目录下，你可以找到各种标准化的名称列表：

• identifiers/vendor.txt- 厂商名称列表
• identifiers/service_product.txt- 服务产品名称列表
• identifiers/os_product.txt- 操作系统产品列表

运行标准化工具检查你的贡献：

ruby bin/recog_standardize -w xml/*.xml

这会自动更新标识符文件，确保你的命名与现有标准一致。

提交Pull Request流程 🔄

1. 创建功能分支

git checkout -b add-mycustom-ssh-fingerprint

2. 提交更改

git add xml/ssh_banners.xml git commit -m "Add fingerprint for MyCustomSSH server"

3. 推送到你的fork

git push origin add-mycustom-ssh-fingerprint

4. 创建Pull Request

访问GitCode平台，选择你的分支，填写清晰的PR描述：

• 说明添加的指纹类型
• 提供测试示例
• 解释为什么需要这个指纹

参与社区协作 🤝

报告问题

如果你发现了bug或有功能建议，可以通过问题模板报告。提供尽可能详细的信息：

• 复现步骤
• 预期行为
• 实际行为
• 相关日志或截图

审核他人贡献

作为社区成员，你可以：

1. 审查他人的PR，提供建设性反馈
2. 测试新指纹的实际效果
3. 帮助改进文档和示例

保持同步

定期更新你的本地仓库：

git fetch --all git checkout main git rebase upstream/main

高级贡献：CPE更新 🔧

对于更高级的贡献者，可以参与CPE（通用平台枚举）更新：

1. 设置Python虚拟环境
2. 下载最新的CPE字典
3. 运行CPE更新脚本

详细步骤参考CONTRIBUTING.md中的"Updating CPEs"部分。

常见问题解答 ❓

Q: 我的指纹为什么匹配失败？

A: 检查正则表达式是否正确，确保示例字符串完全匹配。使用bin/recog_match进行调试。

Q: 如何添加base64编码的示例？

A: 使用_encoding="base64"属性：

<example _encoding="base64">dGllczGEAAAAlQQWMS4yLjg0MC4xMTM1NTYuMS40LjgwMAQuZGF0YS5yZW1vdmVkLjCEAAAAKAQdZG9tYWluQ29udHJvbGxlc...</example>

Q: 可以添加外部示例文件吗？

A: 是的，使用_filename属性引用外部文件：

<example _filename="long_banner_example.txt"/>

贡献的价值与意义 🌟

每个贡献都是Recog项目生态系统的重要部分。你的指纹可能帮助：

• 安全研究人员识别易受攻击的系统
• 渗透测试人员准确评估目标环境
• 系统管理员了解网络中的服务
• 整个网络安全社区提高威胁检测能力

记住，开源贡献不仅是技术展示，更是社区建设。即使你是初学者，简单的指纹添加也能产生巨大影响。Recog社区欢迎所有级别的贡献者，从修复错别字到添加复杂指纹，每一份贡献都值得赞赏。

现在就开始你的Recog贡献之旅吧！🚀 选择你熟悉的协议，收集一些banner数据，编写你的第一个指纹，体验为开源网络安全项目贡献力量的成就感。

【免费下载链接】recogPattern recognition for hosts, services, and content项目地址: https://gitcode.com/gh_mirrors/re/recog