Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 3.6 KB

README.md

File metadata and controls

108 lines (72 loc) · 3.6 KB
Raw

PeekabooAV

Testsuite Container CI pipeline

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 @peekabooav@fosstodon.org.

Getting Started

Prerequisites

Installation

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.

Configuration

Take a look at peekaboo.conf.sample and ruleset.conf.sample.

Running the tests

Runs the unit tests

/path/to/venv/bin/python tests/test.py

Usage

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

Development Quickstart

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.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Past and present Developers and Contributors

License

This project is licensed under the GPL 3 license - see the LICENSE.txt file for details.