Skip to content

A simple, interactive phishing awareness training application that helps train users to identify phishing emails vs legitimate ones.

License

Notifications You must be signed in to change notification settings

StateLibraryofOhio/phishing-sim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Phishing Simulator - Security Awareness Training Tool

An interactive phishing awareness training application that helps users identify phishing emails vs legitimate ones.

Features

  • 12 Realistic Email Examples - 6 legitimate and 6 phishing emails
  • Interactive Learning - Immediate feedback with detailed explanations
  • Real Links - Evaluable URLs that demonstrate legitimate vs suspicious domains
  • Performance Tracking - Separate scoring for legitimate vs phishing email detection
  • Responsive Design - Works on desktop and mobile devices
  • Single-Page App - No scrolling required, fits in viewport

Files

  • phishing-simulator.html - Main application file
  • emails.json - Email samples database (easily customizable)

Deployment to GitHub Pages

Option 1: Quick Deploy

  1. Fork or create a new repository
  2. Upload both files to the repository root:
    • phishing-simulator.html
    • emails.json
  3. Go to Settings > Pages
  4. Under "Source", select the branch (usually main)
  5. Click Save
  6. Your site will be live at: https://[username].github.io/[repository-name]/phishing-simulator.html

Option 2: Custom Domain

  1. Follow steps 1-5 from Option 1
  2. Add a CNAME file with your custom domain
  3. Configure your DNS provider to point to GitHub Pages
  4. Access at your custom domain

Customization

Adding or Modifying Email Examples

Edit the emails.json file. Each email object contains:

{
  "subject": "Email subject line",
  "from": "Sender Name <[email protected]>",
  "to": "[email protected]",
  "date": "MM/DD/YYYY HH:MM AM/PM",
  "icon": "Letter or emoji for sender icon",
  "isPhishing": true or false,
  "content": "HTML content of the email body",
  "explanation": "Text explaining why this is legitimate or phishing"
}

Styling

The application uses inline CSS. To customize colors, fonts, or layout:

  1. Open phishing-simulator.html
  2. Locate the <style> section in the <head>
  3. Modify CSS variables and classes as needed

Email Content Styling

Email content supports these CSS classes:

  • .email-brand-header - Branded header bar (Microsoft, PayPal, etc.)
  • .email-text - Body text paragraphs
  • .email-list - Bulleted lists
  • .email-button - Call-to-action buttons/links
  • .email-footer - Footer text

Add modifiers like .paypal, .amazon, .google to .email-brand-header for brand-specific colors.

Usage Instructions

For Training Administrators

  1. Share the deployed URL with your team
  2. Recommend users complete all 12 examples
  3. Review common mistakes in team meetings
  4. Update emails.json periodically with new examples

For Users

  1. Read each email carefully
  2. Look for red flags:
    • Suspicious sender domains
    • Generic greetings
    • Urgent/threatening language
    • Requests for sensitive information
    • Misspellings or poor grammar
    • Suspicious link URLs (hover to preview)
  3. Click "Legit 👍" or "Phish 👎"
  4. Review the explanation
  5. Click "Next" to continue
  6. Review your final score and breakdown

Tips for Spotting Phishing

Legitimate Email Indicators

  • Official company domain (e.g., @microsoft.com, not @microsoft-security.net)
  • Personalized greeting with your name
  • Professional formatting and grammar
  • No requests for passwords or sensitive data
  • Reasonable timeframes (not "within 1 hour!")
  • Contact information that can be verified

Phishing Red Flags

  • Suspicious domain names (look-alikes, extra words, wrong TLDs)
  • Generic greetings ("Dear User", "Dear Customer")
  • Urgent threats ("account will be closed", "verify immediately")
  • Requests for passwords, SSN, account numbers
  • Poor grammar or spelling errors
  • Mismatched or suspicious URLs
  • Too good to be true offers

Browser Compatibility

  • Chrome/Edge (recommended)
  • Firefox
  • Safari
  • Mobile browsers (iOS Safari, Chrome Mobile)

License

This training tool is provided as-is for educational purposes. Feel free to modify and adapt for your organization's needs.

Contributing

To add new email examples:

  1. Fork the repository
  2. Edit emails.json with your new examples
  3. Test locally by opening the HTML file
  4. Submit a pull request

Support

For issues or questions:

  • Check that both HTML and JSON files are in the same directory
  • Verify JSON syntax is valid (use a JSON validator)
  • Check browser console for error messages
  • Ensure files are being served over HTTP/HTTPS (not file://)

Credits

Created as an open-source security awareness tool to help organizations train employees in phishing detection.

About

A simple, interactive phishing awareness training application that helps train users to identify phishing emails vs legitimate ones.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages