开源项目OSINT Framework使用教程

开源项目OSINT Framework使用教程

osint-framework OSINT Framework : A python based Open Source Intelligence CLI framework similar to Metasploit. 项目地址: https://gitcode.com/gh_mirrors/osi/osint-framework

1. 项目的目录结构及介绍

OSINT Framework 是一个基于 Python 的开源情报CLI框架，其目录结构如下：

• banners: 存放项目启动时的欢迎横幅。
• commands: 包含框架可执行的命令。
• db: 数据库相关文件，用于存储项目运行中的数据。
• modules: 框架的功能模块，包括攻击面分析、区块链、电子邮件、主机枚举、IoC、移动设备、社交媒体和网页枚举等。
• screenshots: 项目功能展示的截图。
• .DS_Store: Mac系统下Finder创建的目录文件，无关紧要。
• .env.example: 配置文件示例。
• .gitignore: Git忽略文件列表。
• CONTRIBUTING.md: 贡献指南，说明如何为项目贡献代码。
• Dockerfile: Docker构建文件，用于创建项目镜像。
• LICENSE.md: 项目许可证文件。
• README.md: 项目说明文件。
• docker-compose.yaml: Docker Compose配置文件，用于定义和运行多容器Docker应用。
• osif: 主程序文件，用于启动和运行框架。
• requirements.txt: 项目依赖的Python包列表。

2. 项目的启动文件介绍

项目的启动主要通过osif文件进行。运行osif文件后，会加载项目的欢迎横幅，并进入命令行交互界面。用户可以通过此界面输入命令来使用框架提供的不同模块和功能。

启动框架的命令如下（在Docker环境下）：

docker-compose up -d
docker exec -ti osif bash
./osif

如果不使用Docker，可以直接在项目目录下运行以下命令：

pip3 install -r requirements.txt
./osif

3. 项目的配置文件介绍

项目使用.env.example文件作为配置文件示例。用户需要根据实际情况创建一个.env文件，并配置相应的API密钥和参数。

配置文件中可能包含以下内容：

VT_API=""
CENSYS_APPID=""
CENSYS_SECRET=""
ABUSECH_API_KEY=""
SHODAN_API_KEY=""
HUNTER_API_KEY=""
BITCOINABUSE_API_KEY=""
WIGLE_API_NAME=""
WIGLE_API_TOKEN=""
SECURITY_TRAIL_API=""

用户需要根据官方文档或API提供商获取相应的API密钥，并填入上述配置项中。配置完成后，框架将使用这些API密钥来访问外部服务和数据。

osint-framework OSINT Framework : A python based Open Source Intelligence CLI framework similar to Metasploit. 项目地址: https://gitcode.com/gh_mirrors/osi/osint-framework