Awesome Open Source
Awesome Open Source


See my blog @ for more details. This API has three main features. One allows you to easily deploy cloned landing pages for credential stealing, another is weaponized Word doc creation, and the third is saved email campaign templates. Both attack methods are integrated into Slack for real-time alerting. Unfortunately, I'm no longer running this code as a free service @ due to cost, sorry!


This latest version no longer redirects users of the landing pages to the API directly by default, but instead sends an AJAX request to the API server prior to posting the form data to the legitimate target site. This provides for a more seamless experience for the "victim" and will actually log them into the target site when they submit their credentials, instead of performing what appears to be a refresh on the login page. CSRF protection is bypassed by the API grabbing the token beforehand! However, I haven't yet gotten around to updating all of the cloned portal pages to use this new method so many will still perform the redirect. FYI!

Auto-Generate Fake Portal

Create Word Maldoc

Weaponize Existing Word Doc

Create or Leverage Saved Email Campaigns

To Setup (Ubuntu/Debian) :

  1. It's all in Docker now! Clone this repo (git clone, and cd PhishAPI. I typically host on an AWS EC2 Ubuntu instance or on WSL2 locally on Win 10 but you can host it anywhere. Be sure to open up ports TCP/80, 443, 445, & 137-139 to the Internet.

  2. Install docker-compose on Ubuntu with sudo apt-get install docker-compose -y and start Docker with sudo systemctl start docker.

  3. For HTTPS (RECOMMENDED!), replace the certificate and key (keeping the filenames the same) in /certs/ssl/ with yours (LetsEncrypt?) and update the domain (ServerName) in 000-default-le-ssl.conf. Otherwise, skip this step but browsers will warn against POSTing to insecure sites and web push notifications won't work.

  4. Run docker-compose via docker-compose build from within the PhishAPI directory. Then, docker-compose up -d. (docker-compose down will kill it)

  5. Visit your URL and configure your settings for notifications first. The Default User/Pass for basic auth is PhishAPI:PhishAPI for the config and reporting pages but I recommend changing this by editing .htpasswd. You should be good to go! (By default the web server listens on HTTP/80 and HTTPS/443)

OR, Copy and Paste the Following in Ubuntu:

sudo apt-get update
sudo apt-get install docker-compose letsencrypt git -y
git clone
cd PhishAPI
certbot certonly --standalone


cp `find /etc/letsencrypt/live/ -name cert.pem` certs/ssl/crt/phishapi.crt
cp `find /etc/letsencrypt/live/ -name privkey.pem` certs/ssl/key/phishapi.key
sudo systemctl start docker
docker-compose build
docker-compose up -d

1) To Use the API for Capturing Credentials from Fake Sites :

Rapid & Easy Deployment API for Phishing During Pentest Engagements. Output to MySQL/Web Table & Slack Bot. Supports BEEF Hooking & HaveIBeenPwned!

Figure 1: Choose "Fake Portal" From API Options

Figure 2: Choose a Pre-Designed Generic Portal for Landing Page

Figure 3: Fill Out API Details for Landing Page HTML and Optionally Include Your Own Logo

Figure 4: Download Automatically Created Source HTML to Host on a Standalone Server

Figure 5: The Hosted Site's Contents


If you don't wish to use a pre-populated landing page template or one doesn't exist that you would like to use, feel free to create or clone your own. Simply :

  1. Add the external script source in the <head> element

    <script src=""></script>

  2. Change or add an "onclick" attribute to the submit button for the login form and fill out the arguments


    PhishAPI_URL_HERE = (wherever you're hosting the API)
    NAME/ID_OF_LOGIN_FORM = Whatever the cloned <form name=""> is set to for the page you cloned
    PROJECT_NAME = Self explanatory. The name of the org/client you're targeting (ex. Walmart)
    SLACK_BOT_NAME = I use "PhishBot"
    SLACK_EMOJI = I use 🎣
    USER_FIELD_NAME/ID = Name or ID of the username/email field (ID Preferred) (<input name="username"> or <input id="user">)
    PASS_FIELD_NAME/ID = Name or ID of the password field (ID Preferred) (<input name="password"> or <input id="pass">)
    SOURCE_URL_HERE = Original Address You Cloned the Site From (ex.
    CSRF_TOKEN_HERE = Leave blank unless the site you're cloning has a CSRF token. If so provide the Name/ID here (<input type="hidden" name="csrf_token" value="XDLKJSDLKJLDKJDLKJFSLKLSF"> so "csrf_token" is what you would use)

  3. Sit back and wait for the Slack bot to notify you. When you want to see the credentials visit https://YOUR-API-HERE/results using your basic auth credentials or click the link in the Slack notification.

Figure 6: Someone Entered Credentials into the Fake Portal - Slack Alert

Figure 7: BeEF Hook Slack Alert (Optional in Case You Want to React Quickly w/ Modules)

Figure 8: Captured NTLMv2 Hash Exposed via Browser

Figure 9: Clicking the Slack Link Allows Viewing Credentials

2) To Use the API for Generating Word Doc Payloads :

  1. Create /var/www/uploads Path and sudo chmod 777 /var/www/uploads -R the path

  2. Browse out to your hosted API ( and select "Weaponized Documents" to generate your DOCX

  3. Optionally set up Responder in a background process and run every minute or so with cron

  4. Set up your php.ini to allow uploads of at least 15MB and enable browscap.ini for parsing UserAgent strings, otherwise some functionality may be limited.

  5. Email your doc and wait for the Slack alerts!

Bonus points if you use your docs as honeypot bait! :)

Figure 1: Web Based Payload Generation - Create New Doc or Upload Existing w/ Payload Options

Figure 2: Opening Document Generated (New) by Service

Figure 3: If "Auth Prompt" is Selected in Payload Options, Display Basic Auth Prompt to User for Credential Capturing (like Phishery)

Figure 4: HTTP Beacon is Selected by Default and Alerts When the Target Opens the Document

Figure 5: If Credentials are Entered from Figure 3 Above, Notify via Slack When Captured

Figure 6: Clicking on the Slack Alert Displays Captured Details (Hashes, Credentials, Client Details)

Figure 7: Slack Alert when UNC/SMB Hashes are Received from Word Document

Currently, I'm running Responder in a Screen session with scheduled via Cron to run every minute to pick up hashes, correlate phished users, and alert via Slack. You can also relay those hashes with another tool if you'd like to take things even further. Enjoy! :)

3) To Use the API to Store and Generate Email Campaign Templates :

Leverage a template by creating or choosing an existing template from the local repository, or, you can compose a blank email and embed the invisible HTML beacon to be notified when the recipient opens their email.

Figure 1: Existing, New, or No Campaign Choices

If a new campaign is chosen, you can create variables for dynamic re-use in the future and store them as HTML templates in a database. The WYSIWYG editor makes things simple, but you can also copy and paste from a text editor or another source if you'd like!

Figure 2: New Campaign w/ Variables & Images

Next time, choosing the existing template will dynamically provide input fields for the stored variables. They can be applied in real time using JavaScript to update the email body. Checking the "Embed Notification for Opened Email" box will automatically append invisible code to your template that will alert you when your recipient opens their email. (Images must be allowed to render for this to work)

Figure 3: Existing Campaign

Sit back and watch as your target opens their email and cross your fingers you later recieve another alert for BeEF, Maldocs, or your captured credentials!

Figure 4: Notification of Email Opened by Recipient

Enjoy! :)

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Security (9,047
Hacking (2,480
Cybersecurity (1,519
Pentesting (1,396
Infosec (766
Phishing (378
Social Engineering (99
Phishing Kit (30
Phish (14
Related Projects