pybl/README.md
Paul Lecuq ffa099a059 Code refactoring
3 classes : Runner, Importer, Config
Improved speed using CDB
Several files renamed
ConfigParser object used for configuration
2016-02-29 10:02:01 +01:00

57 lines
1.7 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# py-squid-blacklists
Squid helper handling squidguard blacklists written in python
* Only supports domains blacklists actually (ie : google.com, www.google.com, mail.google.com, etc.)
* In config specified blacklists are loaded in RAM or CDB backend using https://github.com/acg/python-cdb
* Usable as an external acl plugin of squid
* Written because of poor development on squidguard and some issues using blacklists on squid3
## Usage
Add this configuration to squid.conf :
```
external_acl_type urlblacklist_lookup ttl=5 %URI /usr/bin/python /usr/local/py-squid-blacklists/py-squid-blacklists.py
...
acl urlblacklist external urlblacklist_lookup
...
http_access deny urlblacklist
```
Config file must be include following statements
```
url = http://dsi.ut-capitole.fr/blacklists/download/blacklists.tar.gz
base_dir = /usr/local/py-squid-blacklists/
categories = adult,malware
db_backend = cdb
```
* url : squidguard-like blacklists files, this variable is not already usable
* base_dir : root path containing blacklists files, metadata (update datetime)
* categories : blacklists to use for filtering
* db_backend : database flavour (ram|cdb)
## TODO
* Auto-fetcher using url if blacklists are not already downloaded or stored on the squid machine (wip)
* Compatibility with python3 only
* Filters for regex urls
* Code optimisation (profiling) and cleaning (wip)
* Tests (wip)
* ...
## DBs support ideas
* High performance but heavy RAM usage when using dict()
* Sqlite3 tested, small memory footprint, but very slow
* CDB backend seems to be as fast as attended, with a very small footprint
## DBs Benchmarks
RAM usage For one thread with categories ["adult","malware"]
Debian 8 / python 2.7.9 / squid 3.4.8
* ram : 90Mo
* cdb : 6Mo