README
¶
BluePhish
BluePhish: Open-Source Phishing Toolkit (Direct Fork of GoPhish)
Gophish is an open-source phishing toolkit designed for businesses and penetration testers. It provides the ability to quickly and easily setup and execute phishing engagements and security awareness training.
Database
The BluePhish version of GoPhish supports currently only sqlite3.
Deployment
Environment Variables
You can define the following env variables for configuring the BluePhish instance:
| Variable | Purpose | Default Value |
|---|---|---|
BLUEPHISH_INITIAL_ADMIN_PASSWORD |
set an initial admin password | bluephish |
BLUEPHISH_INITIAL_ADMIN_API_TOKEN |
set an initial admin api token | randomly generated |
Docker
docker pull ghcr.io/bluestoneag/bluephish:latest
sample docker-compose file: docker-compose.yaml
Kubernetes
Edit and apply the kustomization files in the kubernetes directory.
For every campagne you have to create a specific ingress ressource in the ingress.yaml.
The ingress ressource should refer to the bluephish-webserver service on port 80 defined in the services.yaml.
Documentation
Documentation can be found on our site. Find something missing? Let us know by filing an issue!
Issues
- Found a bug?
- Want more features?
- Find something missing in the documentation?
Let us know! Please don't hesitate to file an issue and we'll get right on it.
GoPhish License
As mentioned before BluePhish is a direct fork of the GoPhish Version 0.11.0 (https://github.com/gophish/gophish).
This means that a the most code is provided by GoPhish and the license of the GoPhish is the same as the license of the BluePhish.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package auth implements the authentication in use for gophish.
|
Package auth implements the authentication in use for gophish. |
|
Package config implements a global configuration to be used with gophish.
|
Package config implements a global configuration to be used with gophish. |
|
Package context provides the ability to store request-scoped values on an http.Request instance.
|
Package context provides the ability to store request-scoped values on an http.Request instance. |
|
Package controllers is responsible for setting up the routing and controllers (http.Handlers) for gophish.
|
Package controllers is responsible for setting up the routing and controllers (http.Handlers) for gophish. |
|
Package logger contains a wrapper around logrus to support a centralized logging config.
|
Package logger contains a wrapper around logrus to support a centralized logging config. |
|
Package middleware is responsible for the definition/implementation of middleware functionality.
|
Package middleware is responsible for the definition/implementation of middleware functionality. |
|
ratelimit
Package ratelimit provides a simple token-bucket rate limiting middleware which only allows n POST requests every minute.
|
Package ratelimit provides a simple token-bucket rate limiting middleware which only allows n POST requests every minute. |
|
Package models implements the types and structs needed in gophish.
|
Package models implements the types and structs needed in gophish. |
|
Package util provides misc utility functions for gophish
|
Package util provides misc utility functions for gophish |
|
Package webhook contains the functionality for handling outcoming webhooks.
|
Package webhook contains the functionality for handling outcoming webhooks. |
|
Package worker contains the functionality for the background worker process.
|
Package worker contains the functionality for the background worker process. |