Skip to content

Latest commit

 

History

History
135 lines (84 loc) · 3.97 KB

README.md

File metadata and controls

135 lines (84 loc) · 3.97 KB
Raw

SafeSurf

A phishing domain detection tool that also allows you to safely view the website without actually visiting it. Built using Python. With SafeSurf, you can quickly identify suspicious websites and protect yourself from phishing attacks.

Features

These are the features provided by SafeSurf to its users.

  • The website is easy to use, with a simple interface that anyone can navigate.
  • Users can see the preview of the website without actually visiting it.
  • SafeSurf gives a trust score to the URL, which will provide the user an understanding of the trustability and authenticity of the domain.
  • The URL is checked with a phish database (PhishTank) to see whether it is a reported phishing link.
  • SafeSurf provides crucial details (WHOIS, SSL and general) regarding the domain, which will help the user to get a basic understanding of the URL.

Demo

https://safesurf.vercel.app


Local Setup

If you find this project useful or interesting, please consider starring it and putting it on your watch list.

To run the application on your system, you can choose one of the following methods:

A. Using Docker (Recommended)

If you have Docker installed on your computer, you can easily run the application by executing the following commands. (Make sure docker engine is up and running before installation)

  1. Clone the repository:
git clone https://github.com/abhizaik/SafeSurf.git
cd SafeSurf
  1. Start the container
docker-compose up -d
  1. Open your web browser and go to http://localhost:5000 to use the application locally.

B. Manual Setup

Alternatively, you can manually set up the project by following these steps. Note that you may encounter issues with Python libraries, depending on your Python version and the libraries already installed on your system.

  1. Clone the repository:
git clone https://github.com/abhizaik/SafeSurf.git
cd SafeSurf
  1. Install the dependencies:
pip install -r requirements.txt
  1. Start the Flask app:
python app.py
  1. Open your web browser and go to http://localhost:5000 to use the application locally.

Learn and Contribute to the Project

Learn How SafeSurf Works

Project Functionality Overview

This section explains the functionality and inner workings of the project, detailing its key components and processes.

API Endpoints

  • /: Homepage of the application where users can input a URL to assess its safety.
  • /preview: Endpoint to view a preview of the website within SafeSurf.
  • /source-code: Endpoint to view the source code of a website.

Detailed code documentaion of SafeSurf

How to Contribute to SafeSurf

Contributing Guidelines

Contributions are always welcome. If you find this project useful or interesting, please consider starring it and putting it on your watch list. If you want to contribute to the project, here's how you can do it:

  1. Fork the repository to your GitHub account
  2. Clone the forked repository to your local machine:
git clone https://github.com/yourusername/SafeSurf.git
  1. Create a new branch for your changes:
git checkout -b name-of-your-branch
  1. Make your changes to the code
  2. Commit your changes:
git commit -m "your commit message"
  1. Push your changes to your forked repository:
git push origin name-of-your-branch

  1. Create a pull request from your forked repository to the main repository

  2. Wait for your changes to be reviewed and merged

Feedback

If you have any feedback or suggestions, please reach out at https://abhishekkp.com/contact/ or start a discussion on SafeSurf Discussions.

Any input is highly appreciated.