Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/t0mer/SafeUrl
SafeUrl is a small and lite [FastAPI]( https://fastapi.tiangolo.com/) based web application intended to help us validate any URL safely before clicking it.
https://github.com/t0mer/SafeUrl
docker fastapi ipinfo python security spam virustotal
Last synced: about 2 months ago
JSON representation
SafeUrl is a small and lite [FastAPI]( https://fastapi.tiangolo.com/) based web application intended to help us validate any URL safely before clicking it.
- Host: GitHub
- URL: https://github.com/t0mer/SafeUrl
- Owner: t0mer
- License: apache-2.0
- Created: 2022-01-24T09:36:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-19T06:17:16.000Z (almost 2 years ago)
- Last Synced: 2024-04-16T13:16:15.905Z (5 months ago)
- Topics: docker, fastapi, ipinfo, python, security, spam, virustotal
- Language: HTML
- Homepage:
- Size: 4.9 MB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
- awesome-opensource-israel - SafeUrl - Lite web application intended to help us validate any URL safely before clicking it.   (Projects by main language / html)
README
*Please :star: this repo if you find it useful*
# SafeUrl
## Safely check the URL befor clicking it.
With the growing amount of Spam, Fishing, and Malicious messages, I needed a tool that would help me safely check the URL before I clicked it.
Correct, there are other options like VirusTotal, but I wanted something more, like getting a Preview of the final URL or even getting IP Information of the hosted service,
So I combined them all into one lite and simple application.
## Features
With SafeUrl, you can get the following information:
* Report Summary Using [VirusTotal)](https://www.virustotal.com/gui/home/url)
* Report Info.
* Site Preview
* Website Info:
* Final URL.
* Redirect Chain (If there are redirections).
* Outgoing Links.
* HTML Meta information.
* Trackers (Google Tag, Analytics, Pixels, and more).
* Ip Information Using [IpInfo](https://ipinfo.io/).
### Limatations
* [VirusTotal)](https://www.virustotal.com/gui/home/url) free API is limited to 4 calls/minute.
* [IpInfo](https://ipinfo.io/) free API is limited to 50,000 calls/moneh.
## Usage
In order to start working with SafeUrl, you need to register for free [VirusTotal)] (https://www.virustotal.com/gui/home/url) account and get a valid Free API Key.
[](https://raw.githubusercontent.com/t0mer/SafeUrl/main/Images/SafeUrl%20-%20VirusTotal%20API.PNG?raw=true)
Now, add the VirusTotal API key to the docker environment and you are ready to go.
### Run from hub
#### docker-compose from hub
```yaml
version: "3.6"
services:
safeurl:
image: techblog/safeurl
container_name: safeurl
restart: always
ports:
- "8080:8080"
environment:
- VT_API_KEY=[Your VirusTotal API Key] #Required
- IPINFO_API_KEY=[Your IPInfo API Key] #Optional
```
## Checking URL
So now, after you installed SafeURL, It's time to give it a try.
Navigate to you server address and you shuold see the following screen:
[](https://raw.githubusercontent.com/t0mer/SafeUrl/main/Images/SafeUrl%20-%20Index.PNG?raw=true)
Enter the Requested URL and hit the "Check URL" button.
The Scan process will start and then you will see the folllowing screen:
[](https://raw.githubusercontent.com/t0mer/SafeUrl/main/Images/SafeUrl%20-%20Scanning.PNG?raw=true)
When the scan process will end, you will be able to see all the data collected during the scan process, Like Report summary:
[](https://raw.githubusercontent.com/t0mer/SafeUrl/main/Images/SafeUrl%20-%20Report%20Summary.PNG?raw=true)
Site preview:
[](https://raw.githubusercontent.com/t0mer/SafeUrl/main/Images/SafeUrl%20-%20Preview.PNG?raw=true)
And much much more.