添加 README.md Disclaimer.md LICENSE.md BomDemo.gif

Disclaimer.md

@@ -0,0 +1,29 @@
+## 免责声明
+
+本工具仅面向**合法授权**的企业安全建设行为，如您需要测试本工具的可用性，请自行搭建测试环境。
+
+在使用本工具进行检测时，您应确保该行为符合当地的法律法规，并且已经取得了足够的授权。**请勿对非授权目标进行爆破。**
+
+禁止对本软件实施逆向工程、反编译、试图破译源代码等行为。
+
+**如果发现上述禁止行为，我们将保留追究您法律责任的权利。**
+
+如您在使用本工具的过程中存在任何非法行为，您需自行承担相应后果，本项目作者将不承担任何法律及连带责任。
+
+在安装并使用本工具前，请您**务必审慎阅读、充分理解各条款内容**，限制、免责条款或者其他涉及您重大权益的条款可能会以加粗、加下划线等形式提示您重点注意。
+除非您已充分阅读、完全理解并接受本协议所有条款，否则，请您不要安装并使用本工具。您的使用行为或者您以其他任何明示或者默示方式表示接受本协议的，即视为您已阅读并同意本协议的约束。
+
+
+## Disclaimer
+
+This tool is only intended for enterprise security construction behaviors that are **legally authorized**. If you need to test the tool's functionality, please set up your own testing environment.
+
+When using this tool for testing, you should ensure that your behavior complies with local laws and regulations, and that you have obtained sufficient authorization. **Do not perform brute-force attacks on unauthorized targets.**
+
+Reverse engineering, decompiling, attempting to crack the source code, and other such behaviors are strictly prohibited.
+
+**If any of the above prohibited behaviors are discovered, we reserve the right to pursue legal action against you.**
+
+If you engage in any illegal behavior while using this tool, you will bear the corresponding consequences yourself, and the project author will not be responsible for any legal or joint liability.
+
+Before installing and using this tool, please **carefully read and fully understand** all terms and conditions, including restrictions, disclaimers, or other terms related to your significant interests that may be highlighted in bold or underlined. Unless you have fully read, completely understood, and accepted all the terms and conditions of this agreement, do not install and use this tool. Your use or any other express or implied acceptance of this agreement shall be deemed as your acknowledgment and acceptance of the binding force of this agreement.

LICENSE.md

@@ -0,0 +1,9 @@
+在符合以下条件的情况下，我们欢迎任何人以任何形式使用本项目（包括商用）。
+
+- 注明集成了本项目（注明方式： 在项目介绍页附上本项目 repo 地址）
+- 同意 https://github.com/Fly-Playgroud/Boom/blob/master/Disclaimer.md 免责声明
+
+Anyone is welcome to use this program in any form provided the following conditions are met (Including commercial).
+
+- Indicate the integration of the project (indicate: attach the repo address of the project on the project introduction page)
+- Agree to https://github.com/Fly-Playgroud/Boom/blob/master/Disclaimer.md disclaimer

README.md

@@ -1,2 +1,94 @@
-# Boom
-Boom
+<h1 align="center">💥 I'm Boom 💥</h1>
+<p>
+  <img src="https://img.shields.io/github/release/Fly-Playgroud/Boom.svg" />
+  <img src="https://img.shields.io/github/release-date/Fly-Playgroud/Boom.svg?color=blue&label=update" />
+  <img src="https://img.shields.io/badge/go report-A+-brightgreen.svg" />
+</p>
+
+
+
+## 👑 Boom 简介
+
+**Boom** 是一款基于无头浏览器的 Web 弱口令爆破工具。它具有以下特性：
+
+- 自动识别网页是否是登录页面
+- 支持 URL 批量并发爆破
+- 支持单 URL 并发爆破
+- 多种爆破模式：**密码优先**和**用户名优先**
+
+- [ ] 支持验证码组件识别
+
+
+
+## ✨ Demo
+
+![BoomDemo](./images/BoomDemo.gif)
+
+
+
+## 🚀 快速使用
+
+**在使用之前，请务必阅读并同意 [License](https://github.com/chaitin/xray/blob/master/LICENSE.md) 文件中的条款，否则请勿安装使用本工具。**
+
+1. 单个URL爆破：
+
+   ```bash
+   Boom -t https://www.example.com/login.html --us users.txt --ps ./passwords.txt
+   ```
+
+    - `-t` ：指定单个爆破目标
+    - `--us` ：指定用户名字典
+    - `--ps`：指定密码字典
+
+   > 注意：在未显示使用 `-m` 参数时将使用默认爆破模式——**密码优先**
+
+2. URL 批量爆破
+
+   ```bash
+   Boom --ts targets.txt --us users.txt --ps passwords.txt
+   ```
+
+    - `--ts` ：指定爆破目标的字典
+    - `--us` ：指定用户名字典
+    - `--ps`：指定密码字典
+
+
+
+## 📒 配置文件介绍
+
+```yaml
+# Version: 0.1
+
+max_boom_concurrent: 2                                                  # 最大同时爆破的目标个数
+boom_target_path: "" 													# 爆破目标字典路径
+browser_config:															# 浏览器配置
+    browser_model: local												# 浏览器模式
+    chrome_bin_path: ""													# 浏览器可执行文件所在路径
+    chrome_temp_dir: ./chrome_temp										# 浏览器临时文件存储目录
+    disable_headless: false												# 禁用无头模式
+    disable_images: true												# 禁用图片
+    leak_less: true														# 实验性参数：防止内存泄露
+    no_sandbox: true									                # 是否使用沙盒：Linux 以 root 用户运行的情况下设置为 true 
+    proxy: ""															# 浏览器代理
+    running_chrome:														# 正在运行的浏览器：如果启用， Boom 将会接管正在使用的浏览器
+        enable: false
+        ip: ""
+        port: 0
+    user_agent: ""														# 浏览器 UA
+logger_config:															# 日志配置
+    logger_level: "info"												# 默认日志等级	
+    logger_time_format: 2006/01/02 15:04:05								# 日志输出时间格式
+    logger_file_name: ./log/boom.log									# 日志文件存储路径
+    logger_output_level: []												# 输出到文件中的日志等级
+    logger_file_max_size: 50											# 日志文件最大体积：单位 MB
+    logger_file_max_backups: 5											# 日志文件最大备份个数：单位 个
+    logger_file_max_age: 30												# 日志文件最大存储时长：单位 天
+    logger_prefix: ""													# 日志前缀
+global_boom_config:														# 全局爆破配置
+    boomConCurrent: 2													# 单个爆破目标的爆破并发数
+    boomModel: 2														# 爆破模式：1.用户名优先--用户名跑字典，密码固定；2.密码优先--密码跑字典，用户名固定
+    boomTarget: ""														# 爆破的目标
+    userNamePath: ""													# 用户名字典路径
+    passwordPath: ""													# 密码字典路径
+```
+