Go to file
Raphaël Vinot f0d9e5d29f Merge branch 'master' into travis 2016-01-19 15:36:44 +01:00
faup@9a1440d232 Merge branch 'master' into travis 2016-01-19 15:36:44 +01:00
pyurlabuse Use POST to send email and to get content the cache 2015-03-12 16:37:59 +01:00
redis@83b862a30e Merge branch 'master' into travis 2016-01-19 15:36:44 +01:00
uwhoisd@eefb13ffa6 Update travis 2016-01-19 14:48:32 +01:00
web Post submission to EUPI, hide response if the URL is unknown. 2015-09-09 15:32:24 +02:00
.gitignore Use POST to send email and to get content the cache 2015-03-12 16:37:59 +01:00
.gitmodules Merge branch 'master' into travis 2016-01-19 15:36:44 +01:00
.travis.yml Merge branch 'master' into travis 2016-01-19 15:36:44 +01:00
LICENSE Initial commit 2015-03-02 14:55:34 +01:00
README.md EU-PI Partnership added 2015-03-05 10:38:33 +01:00
config.ini.sample Update default URL for EUPI 2015-10-29 17:35:53 +01:00
install.sh Initial commit 2015-03-02 14:55:34 +01:00
requirements.txt Update deps, use psslv2. 2015-09-09 14:38:56 +02:00
run_redis.sh Initial commit 2015-03-02 14:55:34 +01:00
runapp.py Initial commit 2015-03-02 14:55:34 +01:00
stats_generator.py Add a script to generate stats 2015-12-11 10:20:30 +01:00
update_deps.sh Update deps, use psslv2. 2015-09-09 14:38:56 +02:00
url_abuse_async.py Post submission to EUPI, hide response if the URL is unknown. 2015-09-09 15:32:24 +02:00
worker.py Make code compatible with python 3 2015-05-03 23:28:08 +02:00

README.md

#URL Abuse

URL Abuse is a versatile free software for URL review, analysis and black-list reporting. URL Abuse is composed of a web interface where requests are submitted asynchronously and a back-end system to process the URLs into features modules.

Features

Please note that some of the API services will require an API key. The API keys should be located in the root of the URL Abuse directory.

Demo

CIRCL URL Abuse is online.

Install

Install the requirements

pip install -r requirements.txt

Copy and review the configuration:

cp config.ini.sample config.ini

Install Redis and update the configuration.

Start the Redis back-end

./run_redis.sh

Start the workers (at least 10)

seq 10 | parallel -u -j 10 ./worker.py

Start the web interface

python runapp.py

Contributing

We welcome pull requests for new extensions, bug fixes.

Add a new module

Look at the existings functions/modules. The changes will have to be made in the following files:

  • Add the function you want to execure in url_abuse_async.py
  • Add a route in web/__init__.py. This route will do an async call to the function defined in url_abuse_async.py. The parameter of the function is sent in an POST object
  • Add a statement in web/templates/url-report.html. The data option is the parameter to pass to the javascript directive
  • Add a directive in web/static/main.js, it will take care of passing the parameter to the backend and regularly pull for the response of the async call

Partner

URL Abuse is being developed as part of the “European Union anti-Phishing Initiative” (EU PI) project. This project is coordinated by Cert-Lexsi and co-funded by the Prevention of and Fight against Crime programme of the European Union.