Merge pull request hacklcx#1 from hacklcx/dev

重新开始

.gitattributes

@@ -0,0 +1,3 @@
+*.js linguist-language=Go
+*.css linguist-language=Go
+*.html linguist-language=Go

.gitignore

@@ -0,0 +1,19 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+.idea
+vendor
+.DS_Store
+*/.DS_Store
+*/.idea/%
+*/vendor/%

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 HackLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,113 @@
-# HFish
-企业安全测试主动攻击型蜜罐钓鱼框架系统
+![1.png](./images/1.png)
+
+# 介绍
+
+> *本 Team 研发此平台，仅为企业安全测试使用，禁止其他人员使用非法用途！一切行为与本 Team 无关。*
+
+**HFish** 是一款基于 Golang 开发的跨平台多功能主动攻击型蜜罐钓鱼平台框架系统，为了企业安全防护测试做出了精心的打造
+
+- 多功能 不仅仅支持 HTTP(S) 钓鱼，还支持 SSH、SFTP、Redis、Mysql 等
+- 扩展性 提供 API 接口，使用者可以随意扩展钓鱼模块 ( WEB、PC、APP )
+- 便捷性 使用 Golang 开发，使用者可以在 Win + Mac + Linux 上快速部署一套钓鱼平台
+
+# 地址
+
+- Github: https://github.com/hacklcs/HFish
+- Download: https://github.com/hacklcs/HFish/releases
+
+# 快速部署
+
+### 部署说明
+
+- 下载当前系统二进制包
+- cd 到程序根目录，修改 config.ini 配置文件
+- 执行 ./HFish run 启动服务
+- 浏览器输入 http://localhost:9001 打开
+
+### 帮助页面
+
+![help.png](./images/help.png)
+
+### 启动服务
+
+![run.png](./images/run.png)
+
+# 部分界面展示
+
+![3.png](./images/3.png)
+
+![2.png](./images/2.png)
+
+# 部分功能使用演示
+
+### Redis 钓鱼
+
+![redis.png](./images/redis.png)
+
+### Mysql 钓鱼
+
+![mysql.png](./images/mysql.png)
+
+# 注意事项
+
+- 邮箱 SMTP 配置后需要开启方可使用
+- API 接口 info 字段，&& 为换行符
+- 启动 WEB 钓鱼，请先启动 API 模块
+- WEB 插件 需在 WEB 目录下 编写
+- WEB 插件 下面必须存在两个目录
+
+# API 接口
+
+```
+URL: http://localhost:9001/api/v1/post/report
+
+POST：
+
+    name    :   Github 钓鱼                        # 项目名
+    info    :   admin&&12345                      # 上报信息，&& 为换行符号
+    sec_key :   9cbf8a4dcb8e30682b927f352d6559a0  # API 安全密钥
+
+特殊说明：
+
+    URL api/v1/post/report 可在 config.ini 配置里修改
+    sec_key 可在 config.ini 配置里修改，修改后 WEB 模板也需要同时修改
+```
+
+# TODO
+
+- [x] 登录模块
+- [x] 仪表盘模块
+- [x] 上钩列表
+- [x] 邮件群发
+- [x] 命令行优化
+- [x] 支持自定义 WEB 模板
+- [x] 支持 Mysql 服务端获取连接客户端电脑任意文件
+- [x] 支持 HTTP(S)、SSH、SFTP、Redis、Mysql 协议
+- [ ] 支持 FTP、Telnet、SMTP、POP3、TFTP、Oracle、VPN 等
+- [ ] 暗网钓鱼支持
+- [ ] WIFI 钓鱼支持
+- [ ] 自动化钓鱼支持
+- [ ] 钓鱼报告生成
+- [ ] 支持更多的 WEB 模块
+- [ ] 日记完善优化
+- [ ] 邮件发送支持编辑器
+- [ ] 支持邮件模板选择
+- [ ] 蜜罐高交互完善
+- [ ] 支持 Ngrok 一键映射
+- [ ] 支持分布式架构
+- [ ] 支持分页
+- [ ] 支持 ip 地理信息 和 地图数据展示
+- [ ] 支持更多的图表统计
+- [ ] Mysql 支持
+- [ ] 规划更多的功能...
+
+# 关于
+
+- Team: HackLC
+- URL: https://hack.lc
+
+# 反馈群
+
+加微信拉人，请备注 **HackLC**
+
+![wechat.png](./images/wechat.jpg)