README
¶
Gophish
Gophish: Open-Source Phishing Toolkit
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.
Install
Installation of Gophish is dead-simple - just download and extract the zip containing the release for your system, and run the binary. Gophish has binary releases for Windows, Mac, and Linux platforms.
Building From Source
If you are building from source, please note that Gophish requires Go v1.10 or above!
To build Gophish from source, simply run go install github.com/gophish/gophish@latest and cd into the project source directory. Then, run go build. After this, you should have a binary called gophish in the current directory.
Docker
You can also use Gophish via the official Docker container here.
Setup
After running the Gophish binary, open an Internet browser to https://localhost:3333 and login with the default username and password listed in the log output. e.g.
time="2020-07-29T01:24:08Z" level=info msg="Please login with the username admin and the password 4304d5255378177d"
Releases of Gophish prior to v0.10.1 have a default username of admin and password of gophish.
Documentation
Documentation can be found on our site. Find something missing? Let us know by filing an issue!
Issues
Find 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.
License
Gophish - Open-Source Phishing Framework
The MIT License (MIT)
Copyright (c) 2013 - 2020 Jordan Wright
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software ("Gophish Community Edition") 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.
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. |