summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSebastian Deiss <sebastian.deiss@atos.net>2018-05-28 12:50:28 +0200
committerSebastian Deiss <sebastian.deiss@atos.net>2018-05-28 12:50:28 +0200
commitfede12d9ac6d61d543a8731a318d636dcbfec394 (patch)
tree4ea19e663a805fabe14fbac6537f6149832c4d9e /README.md
parent04a11e8d7daedbc35b36b1a1ec75e4e285359f03 (diff)
Update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md61
1 files changed, 40 insertions, 21 deletions
diff --git a/README.md b/README.md
index 30e02fe..51b80ff 100644
--- a/README.md
+++ b/README.md
@@ -1,63 +1,62 @@
# PeekabooAV #
-Peekaboo Extended Email Attachment Behavior Observation Owl
+**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
-**The main developers are:**
-
-* Felix Bauer
-* Sebastian Deiss
-* Christoph Herrmann
-
For news and announcements follow us on twitter [@peekabooAV](https://twitter.com/peekabooav).
-## Requirements ##
+## Getting Started ##
+
+### Prerequisites ####
* [Python 2.7](https://www.python.org/downloads/)
* [Cuckoo 2.0](https://github.com/cuckoosandbox/cuckoo)
-* Our patched version of AMaViSd 2.11.0
+* Our [AMaViSd](https://github.com/scVENUS/PeekabooAV-amavisd) Fork
-## Installation ##
-
-### Get PeekabooAV ###
-Clone the repository.
+### Installation ###
+Clone the repository
```shell
git clone https://github.com/scVENUS/PeekabooAV.git
```
-### Install Dependencies ###
+Install dependencies
```shell
pip install -r requirements.txt
```
-#### Compile ``chown2me`` ####
+Compile ``chown2me``
```shell
cd bin/
make chown2me
sudo setcap cap_chown+ep chown2me
```
-### Install PeekabooAV ###
+Install PeekabooAV
```shell
python setup.py install
```
-### Advanced Installations ###
-For a more advanced installation, please refer to our documentation located in the ``docs`` folder.
+### Configuration ###
+Take a look at ``peekaboo.conf.sample`` and ``ruleset.conf.sample``.
-## Configuration ##
-Take a look at ``peekaboo.conf.sample``.
+## Running the tests ##
+
+Runs the unit tests
+```shell
+python test.py
+```
## Usage ##
+
Now, you can run PeekabooAV with
```shell
peekaboo -c /path/to/your/peekaboo.conf
@@ -71,7 +70,8 @@ peekaboo --help
```
### Usage without Installation ###
-You can run PeekabooAV without installing it using the ``peekaboo_debug.py`` script.
+
+You can now run PeekabooAV without installing it using the ``peekaboo_debug.py`` script.
```shell
python peekaboo_debug.py -c /path/to/your/peekaboo.conf
```
@@ -82,3 +82,22 @@ They can be displayed by running
```shell
python peekaboo_debug.py --help
```
+
+
+## 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).
+
+## Authors ##
+
+* **Felix Bauer** - *Security Analyst and Project Leader* - [@Jack28](https://github.com/Jack28)
+* **Sebastian Deiss** - *Technical Lead* - [@SebastianDeiss](https://github.com/SebastianDeiss)
+
+## License ##
+
+This project is licensed under the GPL 3 license - see the [LICENSE.txt](LICENSE.txt) file for details.