- evilgophish
- A Word About Sponsorship
- Credits
- Prerequisites
- Disclaimer
- Why?
- Background
- Infrastructure Layout
- setup.sh
- Cloudflare Turnstile Setup
- Cloudflare Turnstile HTML Template Guide
- replace_rid.sh
- Email Campaign Setup
- QR Code Generator
- SMS Campaign Setup
- Live Feed Setup
- A Word About Phishlets
- A Word About The Evilginx3 Update
- Debugging
- Installation Notes
- A Note About Campaign Testing And Tracking
- A Note About The Blacklist and Tracking
- Changes to GoPhish
- Changelog
- Issues and Support
- Future Goals
- Contributing
Combination of evilginx3 and GoPhish.
This is the public, free version of the repository, IT IS NOT THE LATEST VERSION. I am purposefully keeping this public version of the repository behind my version for people that sponsor me via GitHub Sponsors
. This means this version may be lacking bug fixes or features and there should be no expectations for bug fixes, adding features, or support here. Become a sponsor to gain access to the latest version.
Before I begin, I would like to say that I am in no way bashing Kuba Gretzky and his work. I thank him personally for releasing evilginx3 to the public. In fact, without his work this work would not exist. I must also thank Jordan Wright for developing/maintaining the incredible GoPhish toolkit. Kuba's Gophish fork was also used as inspiration for some parts of this project after creating his own integration.
You should have a fundamental understanding of how to use GoPhish
and evilginx3
.
I shall not be responsible or liable for any misuse or illegitimate use of this software. This software is only to be used in authorized penetration testing or red team engagements where the operator(s) has(ve) been given explicit written permission to carry out social engineering.
As a penetration tester or red teamer, you may have heard of evilginx3
as a proxy man-in-the-middle framework capable of bypassing two-factor/multi-factor authentication
. This is enticing to us to say the least, but when trying to use it for social engineering engagements, there are some pain points.
-
Lack of tracking -
evilginx3
does not provide unique tracking statistics per victim (e.g. opened email, clicked link, etc.), this is problematic for clients who want/need/pay for these statistics when signing up for a social engineering engagement. -
Not a full social engineering toolkit -
evilginx3
only provides proxy man-in-the-middle capabilities, it does not provide all of the functionality required for a social engineering campaign via email/SMS. For example, it does not send emails to targets or provide this functionality. -
No GUI - do we really need to explain this one further? We all love our GUIs and the visual representation of data for a social engineering campaign is invaluable. Operators can really get a thorough understanding as to the success of their social engineering campaigns by being able to view a visual representation of the data.
In this setup, GoPhish
is used to send emails and provide a dashboard for evilginx3
campaign statistics, but it is not used for any landing pages. Your phishing links sent from GoPhish
will point to an evilginx3
lure path and evilginx3
will be used for landing pages. This provides the ability to still bypass 2FA/MFA
with evilginx3
, without losing those precious stats. Realtime campaign event notifications have been provided with a local websocket/http server I have developed and full usable JSON
strings containing tokens/cookies from evilginx3
are displayed directly in the GoPhish
GUI (and feed):
evilginx3
will listen on an externally accessible address on port443
(or whatever port you choose inevilginx3
configuration)GoPhish
will listen locally on port8080
and3333
(phishing server on port8080
is not used)Cloudflare Turnstile
server will listen locally on port80
setup.sh
has been provided to automate the needed configurations for you. Once this script is run and you've fed it the right values, you should be ready to get started. Below is the setup help:
Usage:
./setup <root domain> <subdomain(s)> <root domain bool> <feed bool> <rid replacement>
- root domain - the root domain to be used for the campaign
- subdomains - a space separated list of evilginx3 subdomains, can be one if only one
- root domain bool - true or false to proxy root domain to evilginx3
- feed bool - true or false if you plan to use the live feed
- rid replacement - replace the gophish default "rid" in phishing URLs with this value
Example:
./setup.sh example.com "accounts myaccount" false true user_id
Cloudflare Turnstile
integration has superseded redirect rules and an IP blacklist with Apache2
. The Apache2
approach relied on a predefined list of redirect rules and an IP blacklist. We may miss certain user agents, hosts, or IP addresses that end up detecting our infrastructure. This is usually done through bots and automated software that scans phishing infrastructure. Cloudflare Turnstile
technology is one of the best defenses against bots at the time of writing and verifying an actual user is accessing your site.
- Create a Cloudflare account
- Select the
Turnstile
tab in the dashboard - Add a new site and use the domain for your phishing site/campaign
- Edit the
evilginx3/templates/forbidden.html
&evilginx3/templates/turnstile.html
files with your own changes - When starting
evilginx3
, include the public/private keys with theturnstile
flag separated by a:
. For example:
./evilginx3 -feed -g ../gophish/gophish.db -turnstile <PUBLIC_KEY>:<PRIVATE_KEY>
Blog post here.
If I were to include a static HTML page for the Cloudflare Turnstile
functionality, everyone's phishing infrastructure would have the same page and it would lead to static HTML code detections. In comes Go HTML templates. I have included a starter template in evilginx3/templates/turnstile.html
as a guideline YOU WANT TO CHANGE THIS. Here are the rules around how the template code is setup, failure to follow these rules will likely result in breaking the Cloudflare Turnstile
functionality:
- You must include the
{{.FormActionURL}}
,{{.ErrorMessage}}
, and{{.TurnstilePublicKey}}
template variables - The form action URL for submitting the
Turnstile
challenge must be the{{.FormActionURL}}
template variable - The
data-sitekey
value for thecf-turnstile
div
class must be the{{.TurnstilePublicKey}}
template variable - You must save the template at
evilginx3/templates/turnstile.html
- The button to submit the challenge form must have its name attribute equal
button
In case you ran setup.sh
once and already replaced the default RId
value throughout the project, replace_rid.sh
was created to replace the RId
value again.
Usage:
./replace_rid <previous rid> <new rid>
- previous rid - the previous rid value that was replaced
- new rid - the new rid value to replace the previous
Example:
./replace_rid.sh user_id client_id
Once setup.sh
is run, the next steps are:
- Start
GoPhish
and configure email template, email sending profile, and groups - Start
evilginx3
and configure phishlet and lure (must specify full path toGoPhish
sqlite3
database with-g
flag) - Launch campaign from
GoPhish
and make the landing URL your lure path forevilginx3
phishlet - PROFIT
The QR Code Generator
feature allows you to generate QR codes to deploy QR code social engineering campaigns. Here are the steps to use it:
- When editing an email HTML template, you can now include the
{{.QR}}
template variable:
- When starting a new campaign, enter a size for the QR code images:
- The outcome will be similar to the following, but you can adjust the size to meet your needs:
- PROFIT
Note that this feature is only supported for email campaigns and HTML email templates at the moment
Blog post here.
An entire reworking of GoPhish
was performed in order to provide SMS
campaign support with Twilio
. Your new evilgophish
dashboard will look like below:
Once you have run setup.sh
, the next steps are:
- Configure
SMS
message template. You will useText
only when creating aSMS
message template, and you should not include a tracking link as it will appear in theSMS
message. LeaveEnvelope Sender
andSubject
blank like below:
- Configure
SMS Sending Profile
. Enter your phone number fromTwilio
,Account SID
, andAuth Token
:
- Import groups. The
CSV
template values have been kept the same for compatibility, so keep theCSV
column names the same and place your target phone numbers into theEmail
column. Note thatTwilio
accepts the following phone number formats, so they must be in one of these three:
- Start
evilginx3
and configure phishlet and lure (must specify full path toGoPhish
sqlite3
database with-g
flag) - Launch campaign from
GoPhish
and make the landing URL your lure path forevilginx3
phishlet - PROFIT
Blog post here.
Realtime campaign event notifications are handled by a local websocket/http server and live feed app. To get setup:
-
Select
true
forfeed bool
when runningsetup.sh
-
cd
into theevilfeed
directory and start the app with./evilfeed
-
When starting
evilginx3
, supply the-feed
flag to enable the feed. For example:
./evilginx3 -feed -g /opt/evilgophish/gophish/gophish.db
- You can begin viewing the live feed at:
http://localhost:1337/
. The feed dashboard will look like below:
IMPORTANT NOTES
- The live feed page hooks a websocket for events with
JavaScript
and you DO NOT need to refresh the page. If you refresh the page, you will LOSE all events up to that point.
I will add phishlets
to this repository at my own discretion. There should be no expectation of me creating phishlets
as part of this repository, you are expected to create your own. DO NOT OPEN ISSUES IN THIS REPOSITORY FOR PHISHLETS
On May 10, 2023
Kuba Gretzky updated evilginx
2.4.0
to version 3.0.0
. You can find a detailed blog post about changes to the tool here: evilginx3+mastery. Most notably, changes to the phishlet
file format will most likely break phishlets
before version 3.0.0
and they will have to be rewritten. While it may be work to rewrite them, there are added benefits with the new phishlet
file format. Documentation on the phishlet
format for version 3.0.0
can be found here: Phishlet Format v3.0.0. Phishlets
in the legacy format will still be kept in this repository in the folder evilginx3/legacy_phishlets
. Phishlets
compatible with version 3.0.0
will be stored in evilginx3/phishlets
. Not all of the legacy phishlets
have been converted to version 3.x.x
format yet, I will continue to update them as time allows!
The installation script was tested on Ubuntu Focal/Jammy and installs the latest version of Go
from source. Binaries may fail to build depending on your Go
environment and what you have installed i.e. installing the original versions this project combines then trying to install this version of them. It also makes changes to DNS so evilginx3
can take it over. You should understand the implications of this and review it. A fresh environment is recommended and other operating systems haven't been tested.
It is not uncommon to test the tracking for a campaign before it is launched and I encourage you to do so, I will just leave you with a warning. evilginx3
will create a cookie and establish a session for each new victim's browser. If you continue to test multiple campaigns and multiple phishing links within the same browser, you will confuse the tracking process since the RId
value is parsed out of requests and set at the start of a new session. If you are doing this, you are not truly simulating a victim as a victim would never have access to another phishing link besides their own and goes without saying that this will never happen during a live campaign. This is to fair warn you not to open an issue for this as you are not using the tool the way it was intended to be used. If you would like to simulate a new victim, you can test the tracking process by using a new browser/tab in incognito mode.
GoPhish
is never used in any of your actual phishing pages and email headers have been stripped, so there's no need to worry about IOCs within it.
- Default
rid
string in phishing URLs is chosen by the operator insetup.sh
- Added
SMS
Campaign Support - Added additional
Captured Session
campaign event for capturedevilginx3
sessions/tokens
See the CHANGELOG.md
file for changes made since the initial release.
There should be no expectation for me to respond to issues in this public version of the repository. You're not sponsoring me or funding the development of the project, so there should be no expectations for support. Sponsor me for increased support.
- Additions to IP blacklist and redirect rules
- Convert legacy phishlets to
evilginx
3.x.x
format - Add more phishlets
I would like to see this project improve and grow over time. If you have improvement ideas, new redirect rules, new IP addresses/blocks to blacklist, phishlets, or suggestions, please open a pull request.