Skip to main content

Peekaboo Extended Email Attachment Behavior Observation Owl

Project description

# PeekabooAV #

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](https://twitter.com/peekabooav).

## Getting Started ##

### Prerequisites ####

### Installation ###

Install from PyPI into a new virtual environment: `shell virtualenv --python=python3 /path/to/venv /path/to/venv/bin/pip install peekabooav `

Or use this repository: `shell 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 `shell /path/to/venv/bin/python tests/test.py `

## Usage ##

Now, you can run PeekabooAV with `shell /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 `shell peekaboo --help `

### Development Quickstart ###

Just install Peekaboo using pip like above but in editable/development mode:

`shell /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](docs/source/development.rst) for details.

## Contributing ## Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning ##

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/scVENUS/PeekabooAV/releases).

## Deprecations ##

Release 2.0 is more than likely the last release to support Cuckoo embed mode and python 2. Update your setup now!

## Past and present Developers and Contributors ##

## License ##

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for PeekabooAV, version 2.0.1
Filename, size File type Python version Upload date Hashes
Filename, size PeekabooAV-2.0.1.tar.gz (80.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page