Phishing Email Classifier Chrome Extension

A Simple Chrome Extension to classify emails as phishing or non-phishing

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contact
5. Acknowledgments

About The Project

A simple Chrome extension application built to communicate with a backend API. Works by scraping the text from emails on GMail.
The email is then sent to a backend API (Flask App), found here, that exposes a catboost email classifier which then classifies the email as either a phishing or non-phishing email after processing the text from the email.
The result of the classification is then displayed to the user on the extension popup.

(back to top)

Built With

This project was built using the following Libraries and frameworks

• React.js
• Webpack
• Babel
• Sass

(back to top)

Getting Started

The working extension is contained in the build folder of the repository.
Load the extension on Chrome by following these steps after cloning the repository.

1. On your chrome browser, navigate to chrome://extensions/
2. Enable developer mode (Top right corner).
3. Select load unpacked (Top left corner).
4. Navigate to the repository folder and select the build folder.
5. Click on the extensions icon to the right of the URL bar and select the phishing detector icon.
6. Click on the extension to reveal the pop up page.
7. The extension only works on an open Gmail email tab.

Prerequisites

Node.js => 14

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/your_username_/Project-Name.git

2. Navigate to the repository directory

   cd Phishing_Detector

3. Install NPM packages

   npm install

4. Run the application using

   npm run start

(back to top)

Contact

John Anwana - john2.anwana@live.uwe.ac.uk.com

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

I would like to thank [Lxieyang]((https://github.com/lxieyang/) for the boilerplate for this extension located here

(back to top)