PhishOFF

PhishOFF: Phishing Detection System

Your Inbox's Personal Bodyguard

An intelligent plugin and dashboard system for detecting and analyzing phishing emails using NLP and various methods.

---

About The Project

Phishing remains a significant cybersecurity threat, responsible for substantial financial losses and data breaches globally. PhishOFF provides a robust framework for identifying these threats by leveraging a fine-tuned transformer model for content analysis and a multi-faceted approach to inspecting every component of an email.

This system, developed by Team SweepSquad, is built to be an extensible and powerful platform for email security analysis.

Core Features

• NLP-Based Detection: Utilizes a distilbert-base-uncased model fine-tuned for phishing detection, achieving high accuracy on email text.

• URL and Hyperlink Analysis: Inspects links within an email body for suspicious patterns, obfuscation, or connections to blacklisted domains.

• Attachment Scanning: Checks email attachments for potentially malicious file types or characteristics.

• Direct Email Integration: Provides functionality to connect to the Gmail API for fetching and analyzing emails directly from an inbox.

• Explainable AI: The system architecture is designed to support the integration of LIME, providing transparency into why an email is flagged as malicious.

Getting Started

Follow these steps to set up and run the project on your local machine.

Prerequisites

• Python 3.8 or higher
• Git command-line tools

Installation Guide

1. Clone the Repository

   git clone [https://github.com/your-username/phishoff.git](https://github.com/your-username/phishoff.git)
   cd phishoff

2. Set Up a Virtual Environment It is strongly recommended to use a virtual environment to manage project dependencies.

   # For Windows
   python -m venv venv
   .\venv\Scripts\activate
   
   # For macOS / Linux
   python3 -m venv venv
   source venv/bin/activate

3. Install Dependencies A requirements.txt file should be created to list all necessary packages.

   pip install -r requirements.txt

4. Configure API Credentials This project requires credentials for the Google API to access Gmail.

   • Obtain OAuth 2.0 client credentials from the Google Cloud Console.
   • Place the downloaded credentials.json file in the project's root directory.
   • Upon first execution of gmail.py, the application will prompt for authorization in your browser and generate a token.json file. These files should never be committed to version control.