Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lindsey98 authored Dec 29, 2024
1 parent 1370e7e commit c461e2d
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions Plugin_for_Chrome/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,61 @@
# Plugin_for_Chrome

## Project Overview

`Plugin_for_Chrome` is a Chrome extension project designed to detect phishing websites. The extension automatically retrieves the current webpage's URL and a screenshot when the user presses a predefined hotkey or clicks the extension button, then sends this information to the server for phishing detection. The server utilizes the Flask framework, loads the Phishpedia model for identification, and returns the detection results.

## Directory Structure

```
Plugin_for_Chrome/
├── client/
│ ├── background.js # Handles the extension's background logic, including hotkeys and button click events.
│ ├── manifest.json # Configuration file for the Chrome extension.
│ └── popup/
│ ├── popup.html # HTML file for the extension's popup page.
│ ├── popup.js # JavaScript file for the extension's popup page.
│ └── popup.css # CSS file for the extension's popup page.
└── server/
└── app.py # Main program for the Flask server, handling client requests and invoking the Phishpedia model for detection.
```

## Installation and Usage

### Frontend

1. Open the Chrome browser and navigate to `chrome://extensions/`.
2. Enable Developer Mode.
3. Click on "Load unpacked" and select the `Plugin_for_Chrome` directory.

### Backend

1. Navigate to the `server` directory:
```sh
cd Plugin_for_Chrome/server
```
2. Install the required dependencies:
```sh
pip install flask flask_cors
```
3. Run the Flask server:
```sh
python app.py
```
## Using the Extension

In the Chrome browser, press the hotkey `Ctrl+Shift+H` or click the extension button.
The extension will automatically capture the current webpage's URL and a screenshot, then send them to the server for analysis.
The server will return the detection results, and the extension will display whether the webpage is a phishing site along with the corresponding legitimate website.
## Notes
Ensure that the server is running locally and listening on the default port 5000.
The extension and the server must operate within the same network environment.
## Contributing
Feel free to submit issues and contribute code!
## 项目简介
`Plugin_for_Chrome` 是一个用于检测钓鱼网站的Chrome插件项目。该插件可以在用户按下设置好的快捷键或者点击插件按钮后,自动获取当前网页的网址以及截图,并将其发送到服务端进行钓鱼网站检测。服务端使用Flask框架,加载Phishpedia模型进行识别,并返回检测结果。
Expand Down

0 comments on commit c461e2d

Please sign in to comment.