Gophish 开源项目安装与使用教程
gophish Open-Source Phishing Toolkit 项目地址: https://gitcode.com/gh_mirrors/go/gophish
1. 项目目录结构及介绍
Gophish 是一个开源的钓鱼工具包,其目录结构如下:
gophish/
├── auth/
├── config/
├── context/
├── controllers/
├── db/
├── dialer/
├── doc/
├── docker/
├── imap/
├── logger/
├── mailer/
├── middleware/
├── models/
├── static/
├── templates/
├── util/
├── webhook/
├── worker/
├── .babelrc
├── .gitattributes
├── .gitignore
├── CONTRIBUTING.md
├── Dockerfile
├── ISSUE_TEMPLATE.md
├── LICENSE
├── README.md
├── SECURITY.md
├── VERSION
├── config.json
├── go.mod
├── go.sum
├── gophish
├── gulpfile.js
├── package.json
├── webpack.config.js
└── yarn.lock
目录介绍
- auth/: 包含与身份验证相关的代码。
- config/: 包含项目的配置文件和配置相关的代码。
- context/: 包含上下文相关的代码。
- controllers/: 包含控制器相关的代码。
- db/: 包含数据库相关的代码。
- dialer/: 包含拨号相关的代码。
- doc/: 包含项目的文档文件。
- docker/: 包含 Docker 相关的文件。
- imap/: 包含 IMAP 协议相关的代码。
- logger/: 包含日志记录相关的代码。
- mailer/: 包含邮件发送相关的代码。
- middleware/: 包含中间件相关的代码。
- models/: 包含数据模型相关的代码。
- static/: 包含静态文件,如 CSS、JavaScript 等。
- templates/: 包含 HTML 模板文件。
- util/: 包含实用工具相关的代码。
- webhook/: 包含 Webhook 相关的代码。
- worker/: 包含工作线程相关的代码。
2. 项目启动文件介绍
Gophish 的启动文件是 gophish
二进制文件。在项目根目录下,运行以下命令启动 Gophish:
./gophish
启动后,Gophish 会监听默认的 HTTPS 端口 3333
,并输出日志信息,包括默认的用户名和密码。
3. 项目的配置文件介绍
Gophish 的主要配置文件是 config.json
,位于项目根目录下。以下是 config.json
文件的示例内容:
{
"admin_server": {
"listen_url": "127.0.0.1:3333",
"use_tls": true,
"cert_path": "gophish_admin.crt",
"key_path": "gophish_admin.key"
},
"phish_server": {
"listen_url": "0.0.0.0:80",
"use_tls": false,
"cert_path": "example.crt",
"key_path": "example.key"
},
"db_name": "sqlite3",
"db_path": "gophish.db",
"migrations_prefix": "db/db_",
"contact_address": "",
"logging": {
"filename": "",
"level": ""
}
}
配置项介绍
- admin_server: 配置管理服务器的监听地址、是否使用 TLS 以及证书路径。
- phish_server: 配置钓鱼服务器的监听地址、是否使用 TLS 以及证书路径。
- db_name: 数据库类型,默认为
sqlite3
。 - db_path: 数据库文件路径。
- migrations_prefix: 数据库迁移文件的前缀。
- contact_address: 联系地址。
- logging: 日志文件名和日志级别。
通过修改 config.json
文件,可以自定义 Gophish 的运行配置,如监听地址、TLS 设置、数据库路径等。
gophish Open-Source Phishing Toolkit 项目地址: https://gitcode.com/gh_mirrors/go/gophish