URL Research Tool

This Proof of Concept (PoC) project provides an integrated security analysis tool that checks URLs and domains against multiple security threat databases. It uses APIs from VirusTotal, Google Safe Browsing, IPQualityScore, and URLHaus to assess and compile data on potential threats, providing outputs in both CSV and HTML formats.

Features

API Integration: Seamless use of VirusTotal, Google Safe Browsing, IPQualityScore, and URLHaus APIs.

Comprehensive Reports: Outputs are provided in CSV for data analysis and HTML for user-friendly views.

Configurable: Uses a configuration file (api_config.txt) to manage API keys and endpoints, allowing for easy updates.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• Python
• Virus Total
• Google Safe Browsing (v4)
• URLHaus
• IP Quality Score

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Configuration

To configure the tool, edit the api_config.txt file as follows:

{
  "virustotal": {"key": "YOUR_API_KEY", "url": "API_ENDPOINT"},
  "googlesafebrowser": {"key": "YOUR_API_KEY", "url": "API_ENDPOINT", "ID": "YOUR_CLIENT_ID"},
  "ipqualityscore": {"key": "YOUR_API_KEY", "url": "API_ENDPOINT"},
  "urlhaus": {"key": "YOUR_API_KEY", "url": "API_ENDPOINT"}
}
### Prerequisites

This is an example of how to list things you need to use the software and how to install them.
* requests
  ```sh
  pip install requests

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/JochiRaider/URL_Research_Tool.git

3. Install requests library

   pip install requests

4. Enter your API in api_config.txt

   {  
      "virustotal":{"key":"=","url_url":"https://www.virustotal.com/api/v3/urls/"},
      "googlesafebrowser":{"key":"=","ID":"domain-reputation-408400","url":"https://safebrowsing.googleapis.com/v4/threatMatches:find"},
      "ipqualityscore":{"key":"=","url":"https://www.ipqualityscore.com/api/json/url/"},
      "urlscanio":{"key":"=","url":"https://urlscan.io/api/v1/scan/"}
   }

(back to top)

Usage

To run the project, execute the main.py script:

(back to top)

Roadmap

• [] Feature 1
• [] Feature 2
• [] Feature 3
  • [] Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/JochiRaider/URL_Research_Tool

(back to top)

Acknowledgments

(back to top)

https://github.com/JochiRaider/URL_Research_Tool

[product-screenshot]: images/Screenshot 2023-12-26.png