文档更新

README.md

@@ -1,4 +1,4 @@
-![1.png](./images/1.png)
+![dashboard.png](./images/dashboard.png)
 
 # 介绍
 
@@ -6,7 +6,7 @@
 
 **HFish** 是一款基于 Golang 开发的跨平台多功能主动诱导型蜜罐框架系统，为了企业安全防护测试做出了精心的打造
 
-- 多功能 不仅仅支持 HTTP(S) 蜜罐，还支持 SSH、SFTP、Redis、Mysql 等
+- 多功能 不仅仅支持 HTTP(S) 蜜罐，还支持 SSH、SFTP、Redis、Mysql、FTP、Telnet、暗网 等
 - 扩展性 提供 API 接口，使用者可以随意扩展蜜罐模块 ( WEB、PC、APP )
 - 便捷性 使用 Golang 开发，使用者可以在 Win + Mac + Linux 上快速部署一套蜜罐平台
 
@@ -14,40 +14,76 @@
 
 - Github: https://github.com/hacklcx/HFish
 - Download: https://github.com/hacklcx/HFish/releases
+- 码云(Gitee): https://gitee.com/lauix/HFish
+- Download: https://gitee.com/lauix/HFish/releases
 
 # 快速部署
 
-### 部署说明
+## 部署说明
 
 - 下载当前系统二进制包
 - cd 到程序根目录，修改 config.ini 配置文件
 - 执行 ./HFish run 启动服务
 - 浏览器输入 http://localhost:9001 打开
 
-### 帮助页面
+## 集群部署
+
+- 复制 HFish、config.ini、web(不启动WEB蜜罐可以不复制) 目录文件到服务器上
+- 修改 config.ini -> rpc -> status 为 2
+- 修改 config.ini -> rpc -> addr  地址为 HFish 服务端地址
+
+## 命令行帮助
 
 ![help.png](./images/help.png)
 
-### 启动服务
+## 启动服务
 
 ![run.png](./images/run.png)
 
 # 部分界面展示
 
-![3.png](./images/3.png)
+## 登录页
 
-![2.png](./images/2.png)
+![login.png](./images/login.png)
+
+## 上钩页
+
+![fish.png](./images/fish.png)
+
+## 分布式集群
+
+![colony.png](./images/colony.png)
+
+## 邮件群发
+
+![mail.png](./images/mail.png)
 
 # 部分功能使用演示
 
-### Redis 蜜罐
+## WEB 蜜罐
+
+![web.png](./images/web.png)
+
+## SSH 蜜罐
+
+![ssh.png](./images/ssh.png)
+
+## Redis 蜜罐
 
 ![redis.png](./images/redis.png)
 
-### Mysql 蜜罐
+## Mysql 蜜罐
 
 ![mysql.png](./images/mysql.png)
 
+## FTP 蜜罐
+
+![ftp.png](./images/ftp.png)
+
+## Telnet 蜜罐
+
+![telnet.png](./images/telnet.png)
+
 # 注意事项
 
 - 邮箱 SMTP 配置后需要开启方可使用
@@ -55,9 +91,14 @@
 - 启动 WEB 蜜罐，请先启动 API 模块
 - WEB 插件 需在 WEB 目录下 编写
 - WEB 插件 下面必须存在两个目录
+- 集群 心跳为60秒,断开显示会延迟60秒
+- 暗网蜜罐是支持的，但是目前Tor服务网上找不到，无法提供演示
+-
 
 # API 接口
 
+## WEB 蜜罐
+
 ```
 URL: http://localhost:9001/api/v1/post/report
 
@@ -73,6 +114,33 @@ POST：
     sec_key 可在 config.ini 配置里修改，修改后 WEB 模板也需要同时修改
 ```
 
+## 暗网 蜜罐
+
+```
+URL: http://localhost:9001/api/v1/post/deep_report
+
+POST：
+
+    name    :   暗网后台蜜罐                        # 项目名
+    info    :   admin&&12345                      # 上报信息，&& 为换行符号
+    sec_key :   9cbf8a4dcb8e30682b927f352d6559a0  # API 安全密钥
+
+特殊说明：
+
+    URL api/v1/post/deep_report 可在 config.ini 配置里修改
+    sec_key 可在 config.ini 配置里修改，修改后 暗网 模板也需要同时修改
+```
+
+## 黑名单IP
+
+```
+URL(Get): http://localhost:9001/api/v1/get/ip
+
+特殊说明：
+
+    提供此接口为了配合防火墙使用，具体方案欢迎来讨论！
+```
+
 # TODO
 
 - [x] 登录模块
@@ -82,21 +150,20 @@ POST：
 - [x] 命令行优化
 - [x] 支持自定义 WEB 模板
 - [x] 支持 Mysql 服务端获取连接客户端电脑任意文件
-- [x] 支持 HTTP(S)、SSH、SFTP、Redis、Mysql 协议
-- [ ] 支持 FTP、Telnet、SMTP、POP3、TFTP、Oracle、VPN 等
-- [ ] 暗网蜜罐支持
+- [x] 支持 HTTP(S)、SSH、SFTP、Redis、Mysql、FTP、Telnet、暗网 蜜罐
+- [x] 日记完善优化
+- [x] 支持分布式架构
+- [x] 支持分页
+- [x] 支持 ip 地理信息
+- [x] 提供黑名单IP接口
+- [ ] 支持 SMTP、POP3、TFTP、Oracle、VPN 等
 - [ ] WIFI 蜜罐支持
 - [ ] 自动化蜜罐支持
 - [ ] 蜜罐报告生成
-- [ ] 支持更多的 WEB 模块
-- [ ] 日记完善优化
 - [ ] 邮件发送支持编辑器
 - [ ] 支持邮件模板选择
 - [ ] 蜜罐高交互完善
 - [ ] 支持 Ngrok 一键映射
-- [ ] 支持分布式架构
-- [ ] 支持分页
-- [ ] 支持 ip 地理信息 和 地图数据展示
 - [ ] 支持更多的图表统计
 - [ ] Mysql 支持
 - [ ] 规划更多的功能...

admin/header.html

@@ -6,7 +6,7 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <link rel="shortcut icon" href="/static/favicon.ico">
-    <title>HFish - 一款企业安全主动攻击型蜜罐钓鱼框架系统</title>
+    <title>HFish - 扩展企业安全测试主动诱导型蜜罐框架系统</title>
     <link href="/static/css/style.css" rel="stylesheet" type="text/css"/>
     <link href="/static/libs/bootstrap-sweetalert/sweet-alert.css" rel="stylesheet" type="text/css"/>
     <link href="/static/libs/switchery/switchery.min.css" rel="stylesheet"/>

admin/login.html

@@ -4,7 +4,7 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <link rel="shortcut icon" href="/static/favicon.ico">
-    <title>HFish - 一款企业安全主动攻击型蜜罐钓鱼框架系统</title>
+    <title>HFish - 扩展企业安全测试主动诱导型蜜罐框架系统</title>
     <link href="/static/css/style.css" rel="stylesheet" type="text/css"/>
     <link href="/static/libs/bootstrap-sweetalert/sweet-alert.css" rel="stylesheet" type="text/css"/>
     <style>

config.ini

@@ -1,9 +1,9 @@
 [rpc]
 status = 1                                   # 是否启动 0 关闭 1服务端 2客户端
-addr = 127.0.0.1:7879                        # RPC 服务端地址
+addr = 127.0.0.1:7879                        # RPC 服务端地址 or 客户端地址
 name = Server                                # 状态1 服务端 名称 状态2 客户端 名称
 
-[admin]
+[admin]                                      # RPC 状态为2 集群客户端的时候 admin 可以删掉
 addr = 127.0.0.1:9001                        # 管理后台启动地址
 account = admin                              # 登录账号
 password = admin                             # 登录密码
@@ -23,7 +23,7 @@ static = wordPress/static                    # WEB 静态文件路径  注意：
 url = /                                      # WEB 访问目录，默认 / 可更改成 index.html index.asp index.php
 
 [deep]
-status = 1                                   # 是否启动 暗网 1 启动 0 关闭, 启动 API 后 方可上报结果
+status = 0                                   # 是否启动 暗网 1 启动 0 关闭, 启动 API 后 方可上报结果
 addr = 0.0.0.0:9002                          # 暗网 WEB 启动地址
 template = deep/html                         # 暗网 WEB 模板路径
 index = index.html                           # 暗网 WEB 首页文件

view/url.go

@@ -98,7 +98,7 @@ func LoadUrl(r *gin.Engine) {
 			r.POST(webUrl, api.ReportWeb)
 			r.POST(deepUrl, api.ReportDeepWeb)
 
-			r.GET("/api/v1/get/ip", login.Jump, api.GetIpList)
+			r.GET("/api/v1/get/ip", api.GetIpList)
 		}
 	}
 }