s452649
/
PhishGuardian
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
s452624 2024-06-10 11:33:46 +02:00
parent 6e81fa844c
commit 521fd5e75f
1 changed files with 23 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -23,7 +23,7 @@ PhishGuardian is a browser extension designed to detect and manage phishing emai
1. Clone the repository:
```sh
git clone https://your-repository-url
git clone https://git.wmi.amu.edu.pl/s452649/PhishGuardian.git
cd PhishGuardian/backend
```
@ -38,33 +38,37 @@ PhishGuardian is a browser extension designed to detect and manage phishing emai
python backend.py
```
### Extension Setup
1. Open Chrome and go to `chrome://extensions/`
2. Enable "Developer mode" by toggling the switch in the top right corner.
3. Click on "Load unpacked" and select the `PhishGuardian` directory.
### Setting up Gmail API
### To integrate the Gmail API, follow these steps:
1. Visit the Google Cloud Console at https://console.cloud.google.com/apis/credentials.
2. Click on "Create Project" and fill in the required fields.
3. Navigate to the library, find the Gmail API, and enable it.
4. Go to the Credentials tab and click on "Create Credentials". Then, select "OAuth client ID", choose "Web application", and fill in the following fields:
3. Navigate to the Library, find the Gmail API, and enable it.
4. Go to the OAuth consent screen and select the "External" option in the User Type field and click "Create". Enter the application name and your email address. Skip the "App logo" and "App domain" fields. Also, skip all the following windows until the last step "Summary", where click "Back to dashboard". Then, in the "Publishing status" field, click "Publish app".
5. Go to the Credentials tab and click on "Create Credentials". Then, select "OAuth client ID", choose "Web application", and fill in the following fields:
- redirect_uris: ["http://localhost:5000/oauth2callback"]
- javascript_origins: ["http://localhost:5000"]
- redirect_uris: ["http://localhost:5000/oauth2callback"]
5. A popup window will appear where you can obtain the client_id which must be noted in manifest.json. There will also be a button to download a JSON file. Place this file in the backend folder for convenience. Name the file "client_secret.json", or you can rename it in backend.py as needed.
6. These setup instructions will assist you in integrating and using the Gmail API effectively in your project.
6. A popup window will appear where you can obtain the "Client_id" which must be noted in 'manifest.json'. There will also be a button to download a JSON file. Place this file in the backend folder for convenience, name the file "client_secret.json", or you can rename it in backend.py as needed.
7. These setup instructions will assist you in integrating and using the Gmail API effectively in your project.
### Extension Setup
1. Open Chrome and go to `chrome://extensions/`
2. Enable "Developer mode" by toggling the switch in the top right corner.
3. Click on "Load unpacked" and select the `PhishGuardian` directory.
## Usage
1. Click on the PhishGuardian extension icon in the Chrome toolbar.
2. Login with your email credentials. Currently, the extension supports credentials for the wp.pl mailing service and Outlook.
3. Use the "Check Mail" button to scan for phishing emails.
4. If a phishing email is detected, a notification will appear with options to mark the email as safe or move it to the trash.
2. Select the email system from the list - either Gmail or Outlook.
3. Login with your email credentials.
4. Use the "Check Mail" button to scan for phishing emails.
5. If a phishing email is detected, a popup window will appear with list of mails with options to mark the email as "Safe" or "Move" it to the trash.
6. After use, you can close the additional popup window, and you will see the changes made in your email service.
7. To use it again, follow steps 4-6 of this list.
## Code Overview
@ -100,6 +104,10 @@ PhishGuardian is a browser extension designed to detect and manage phishing emai
- Safe Emails: Stored in a JSON file safe_emails.json.
#### Data Collection for Custom Training Model:
- All emails that the user marks to be moved to the trash are recorded in a separate CSV file - safe_trash.csv, which is used as a database in the future for training the model to better recognize phishing.
### Frontend
- `popup.html`: The main interface of the extension.