Back to Scanner

Documentation

Introduction

CyberShield is a real-time URL security scanner designed to identify potentially harmful websites before you visit them. By leveraging the Google Safe Browsing API, CyberShield provides instant feedback on whether a link is associated with phishing, malware, or other social engineering threats.

CyberShield also includes an AI-powered Scam Text Detector, which uses the Google Gemini API to analyze suspicious messages, emails, job offers, and SMS texts for fraud patterns.

How to Use

Using CyberShield is straightforward:

  • Step 1: Copy the URL you wish to check.
  • Step 2: Paste it into the scanner input box on the home page.
  • Step 3: Press Enter or click Scan URL.
  • Step 4: Review the result and any flagged threat categories.

For text/message scanning, head to the Scam Detector Chat and paste any suspicious message.

Understanding Results

CyberShield categorizes URLs into two states:

SAFENo Threats Detected

The URL is not currently listed in the Google Safe Browsing database as a threat. While highly reliable, always exercise caution with unfamiliar websites.

DANGERThreat Detected

The URL has been flagged as malicious. Common threat types include:

  • Malware — Sites that install harmful software on your device.
  • Phishing (Social Engineering) — Sites that trick you into revealing passwords or card details.
  • Unwanted Software — Sites pushing deceptive or potentially harmful programs.

For Developers

To run CyberShield locally, ensure Node.js v14+ is installed, then:

git clone https://github.com/Mrinalray/Cybershield_URL.git
cd Cybershield_URL
npm install
node server.js

Environment Variables

Create a .env file in the project root:

API_KEY=your_google_safe_browsing_key
GEMINI_API_KEY=your_gemini_api_key
CORS_ORIGINS=http://localhost:3000,https://yourdomain.com
REQUEST_TIMEOUT_MS=8000
REQUEST_RETRIES=2

Get your Google Safe Browsing key at Google Cloud Console. Never commit the .env file — it is in .gitignore.

API Endpoints

POST /check             — URL threat scan (Google Safe Browsing)
POST /api/scam-detect   — Text scam analysis (Gemini AI)
GET  /                  — Health check