Peekaboo Extended Email Attachment Behavior Observation Owl
-
PeekabooAV is an Anti Virus software
-
It gets email attachments from AMaViSd, checks them, uses Cuckoo for behavioral checks, and evaluates and rates fully automatic
-
PeekabooAV is written in Python, multi-threaded, scalable, has a very powerful ruleset, and is easy to extend and personalize
-
It is able to detect: malware by its behavior, exploitation of zero days, and targeted attacks
-
We develop and work in Germany
-
PeekabooAV is entirely open source
-
can run 100% local and does not require any external service
-
any file with any application can be scanned
If you run mail on-site, distrust security vendors and need a high level of security and secrecy PeekabooAV is for you.
For news and announcements follow us on twitter @peekabooAV and Fosstodon @[email protected].
- Python (3.6+ required)
- Cuckoo 2.0
- AMaViSd 2.11.0
- Installer is available: PeekabooAV-Installer
Install from PyPI into a new virtual environment:
virtualenv --python=python3 /path/to/venv
/path/to/venv/bin/pip install peekabooav
Or use this repository:
git clone https://github.com/scVENUS/PeekabooAV.git
virtualenv --python=python3 /path/to/venv
/path/to/venv/bin/pip install .
This will pull in all required packages and install them into the virtualenv.
Take a look at peekaboo.conf.sample
and ruleset.conf.sample
.
Runs the unit tests
/path/to/venv/bin/python tests/test.py
Now, you can run PeekabooAV with
/path/to/venv/bin/peekaboo -c /path/to/your/peekaboo.conf
Note: If you put your PeekabooAV configuration file at
/opt/peekaboo/etc/peekaboo.conf
you can omit the -c
option.
Also, for detailed command line options run
peekaboo --help
Just install Peekaboo using pip like above but in editable/development mode:
/path/to/venv/bin/pip install -e .
Now you can run it as before but changes to the source code will take effect without reinstallation. See the development documentation for details.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Felix Bauer - Security Analyst and Project Leader - @Jack28
- Michael Weiser - Developer - @michaelweiser
- Sebastian Deiss - Former Technical Lead - @SebastianDeiss
This project is licensed under the GPL 3 license - see the LICENSE.txt file for details.