Skip to content

Commit

Permalink
New release
Browse files Browse the repository at this point in the history
More options for editorconfig
  • Loading branch information
fedelemantuano committed Jul 1, 2017
1 parent 6f918eb commit b6dd81b
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 19 deletions.
12 changes: 9 additions & 3 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@

root = true

[*.py]
# Unix-style newlines
[*]
end_of_line = lf
insert_final_newline = false

# Set default charset
[*.{yml,py,json,txt,clj,md}]
charset = utf-8

[*.py]
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
end_of_line = lf
insert_final_newline = false
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ It's possible to analyze more than 5 milions of mails (without attachments post
- It's distributed: SpamScope uses Apache Storm, free and open source distributed realtime computation system.
- It makes JSON output that you can save where you want.
- It's easy to setup: there are docker images and docker-compose ready for use.
- It's integrated with Apache Tika, VirusTotal and Thug (for now).
- It's integrated with Apache Tika, VirusTotal, Thug and Shodan (for now).
- It's free (for special functions you can contact me).

### Distributed
SpamScope use Apache Storm that allows you to start small and scale horizontally as you grow. Simply add more worker.
SpamScope uses Apache Storm that allows you to start small and scale horizontally as you grow. Simply add more workers.

### Flexibility
You can chose your mails input sources (with spouts) and your functionalities (with bolts). SpamScope come with a tokenizer (split mail in token: headers, body, attachments), attachments and phishing analyzer (Which is the target of mails? Is there a malware in attachment?) and JSON output.
You can chose your mails input sources (with spouts) and your functionalities (with bolts). SpamScope comes with a tokenizer (split mail in token: headers, body, attachments), attachments and phishing analyzer (Which is the target of mails? Is there a malware in attachment?) and JSON output.

### Store where you want
You can build your custom output bolts and store your data in Elasticsearch, Mongo, filesystem, etc.
Expand All @@ -46,6 +46,14 @@ SpamScope can be downloaded, used, and modified free of charge. It is available



## SpamScope on Web
- [Shodan Applications & Integrations](https://developer.shodan.io/apps)
- [The Honeynet Project](http://honeynet.org/node/1329)
- [securityonline.info](http://securityonline.info/pcileech-direct-memory-access-dma-attack-software/)
- [jekil/awesome-hacking](https://github.com/jekil/awesome-hacking)



## Output example
- [Raw mail](https://goo.gl/wMBfbF).
- [SpamScope output](https://goo.gl/MS7ugy).
Expand Down Expand Up @@ -135,7 +143,6 @@ If you want submit SpamScope topology use `spamscope-topology submit` tool. For
$ spamscope-topology submit --topology {spamscope_debug,spamscope_elasticsearch,spamscope_redis,spamscope_testing}
```

There are some options that you can use.

### Important
It's very important to set the main configuration file. The default value is `/etc/spamscope/spamscope.yml`, but it's possible to set the environment variable `SPAMSCOPE_CONF_FILE`:
Expand All @@ -153,7 +160,7 @@ It's possible change the default settings for all Apache Storm options. I sugges
- **topology.max.spout.pending**: Apache Storm framework will then throttle your spout as needed to meet the `topology.max.spout.pending` requirement
- **topology.sleep.spout.wait.strategy.time.ms**: max sleep for emit new tuple (mail)

If you don't enable Apache Tika, Thug and VirusTotal, could use:
If you don't enable Apache Tika, Thug and VirusTotal, you could use:

```
topology.tick.tuple.freq.secs: 60
Expand Down Expand Up @@ -213,21 +220,14 @@ $ export SHODAN_APIKEY="your key"
```



## SpamScope on Web
- [Shodan Applications & Integrations](https://developer.shodan.io/apps)
- [The Honeynet Project](http://honeynet.org/node/1329)
- [securityonline.info](http://securityonline.info/pcileech-direct-memory-access-dma-attack-software/)
- [jekil/awesome-hacking](https://github.com/jekil/awesome-hacking)



## Docker images
It's possible to use complete Docker images with Apache Storm and SpamScope. Take the following images:

- [Root](https://hub.docker.com/r/fmantuano/spamscope-root/)
- [Elasticsearch](https://hub.docker.com/r/fmantuano/spamscope-elasticsearch/)

For each image there are two tags: **develop** and **latest**.



## Screenshots
Expand Down
2 changes: 1 addition & 1 deletion project.clj
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(defproject spamscope "1.5.4-SNAPSHOT"
(defproject spamscope "1.5.5-SNAPSHOT"
:resource-paths ["_resources"]
:target-path "_build"
:min-lein-version "2.0.0"
Expand Down
2 changes: 1 addition & 1 deletion src/options.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

from os.path import join

__version__ = "1.5.4"
__version__ = "1.5.5"
__configuration_path__ = "/etc/spamscope"

__defaults__ = {
Expand Down

0 comments on commit b6dd81b

Please sign in to comment.