Go to file
Raphaël Vinot 12291e267b fix: Typo in cann to eupi 2019-01-11 14:03:29 +01:00
bin chg: Remove RQ dependency, big cleanup. 2019-01-11 14:00:25 +01:00
cache new: Major refactoring to use more recent techniques. Python3.6+ 2018-12-17 16:21:31 +01:00
client chg: Remove RQ dependency, big cleanup. 2019-01-11 14:00:25 +01:00
doc/logo add: [doc] URL Abuse logo added 2018-12-18 11:41:27 +01:00
urlabuse chg: Remove RQ dependency, big cleanup. 2019-01-11 14:00:25 +01:00
website fix: Typo in cann to eupi 2019-01-11 14:03:29 +01:00
.gitignore new: Major refactoring to use more recent techniques. Python3.6+ 2018-12-17 16:21:31 +01:00
.gitmodules new: Major refactoring to use more recent techniques. Python3.6+ 2018-12-17 16:21:31 +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 add: [doc] logo added 2018-12-18 11:41:51 +01:00
requirements.txt chg: Remove RQ dependency, big cleanup. 2019-01-11 14:00:25 +01:00
setup.py new: Use new BGP Ranking & IPASN History 2019-01-08 15:12:43 +01:00

README.md

Build Status

URL Abuse

URL Abuse logo

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.

Online version

If you don't want to use the online version or run your own version of URL Abuse, you can follow the install process below.

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 and Funding

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

URL Abuse is currently supported and funded by CIRCL ( Computer Incident Response Center Luxembourg).