Phishing Campaign Toolkit
King Phisher is a tool for testing and promoting user awareness by simulating real world phishing attacks. It features an easy to use, yet very flexible architecture allowing full control over both emails and server content. King Phisher can be used to run campaigns ranging from simple awareness training to more complicated scenarios in which user aware content is served for harvesting credentials.
King Phisher is only to be used for legal applications when the explicit permission of the targeted organization has been obtained.
Get the latest stable version from the GitHub Releases Page or use git to checkout the project from source.
For instructions on how to install, please see the INSTALL.md file. After installing, for instructions on how to get started please see the wiki.
King Phisher is released under the BSD 3-clause license, for more details see the LICENSE file.
Special Thanks (QA / Beta Testing):
-
Jake Garlie - jagar
-
Ken Smith - p4tchw0rk
-
Brianna Whittaker
King Phisher Development Team:
-
Brandan Geise - coldfusion (@coldfusion39)
-
Jeff McCutchan - jamcut (@jamcut)
-
Spencer McIntyre - zeroSteiner (@zeroSteiner)
King Phisher uses Sphinx for internal code documentation. This
documentation can be generated from source with the command
sphinx-build docs/source docs/html. The latest documentation is
kindly hosted on ReadTheDocs at
king-phisher.readthedocs.org.
The client configuration file is encoded in JSON and most options are configurable through the GUI interface.
The following options will be honored but are not configurable through the GUI:
- gui.refresh_frequency (Default: 5 minutes)
- mailer.max_messages_per_connection (Default: 5)
- rpc.serializer (Default: Automatically determined)
- ssh_preferred_key (Default: N/A)
The client message templates are formatted using the Jinja2 templating engine and support a number of variables. These are included here as a reference, check the templates wiki page for comprehensive documentation.
| Variable Name | Variable Value |
|---|---|
| client.company_name | The target's company name |
| client.email_address | The target's email address |
| client.first_name | The target's first name |
| client.last_name | The target's last name |
| client.message_id | The unique tracking identifier (this is the same as uid) |
| url.tracking_dot | URL of an image used for message tracking |
| url.webserver | Phishing server URL with the uid parameter |
| url.webserver_raw | Phishing server URL without any parameters |
| tracking_dot_image_tag | The tracking image in a preformatted <img /> tag |
| uid | The unique tracking identifier (this is the same as client.message_id) |
The uid is the most important, and must be present in links that the messages contain.