Skip to content

Commit

Permalink
Add Kibana Dashboard for Filebeat MISP module (elastic#14147)
Browse files Browse the repository at this point in the history
* Add Kibana Dashboard for MISP module
  • Loading branch information
Lei Qiu authored Oct 21, 2019
1 parent be6b124 commit 7f89974
Show file tree
Hide file tree
Showing 14 changed files with 516 additions and 23 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- Add ELB fileset to AWS module. {pull}14020[14020]
- Add module for MISP (Malware Information Sharing Platform). {pull}13805[13805]
- Add `source.bytes` and `source.packets` for uni-directional netflow events. {pull}14111[14111]
- Add Kibana Dashboard for MISP module. {pull}14147[14147]

*Heartbeat*
- Add non-privileged icmp on linux and darwin(mac). {pull}13795[13795] {issue}11498[11498]
Expand Down
Binary file added filebeat/docs/images/kibana-misp.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 14 additions & 3 deletions filebeat/docs/modules/misp.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,22 @@ beta[]
This is a filebeat module for reading threat intel information from the MISP platform (https://www.circl.lu/doc/misp/). It uses the httpjson input to access the MISP REST API interface.

The configuration in the config.yml file uses the following format:
var.api_key: specifies the API key to access MISP.
var.json_objects_array: specifies the array object in MISP response, e.g., "response.Attribute".
var.url: URI of the MISP REST API, e.g., "http://x.x.x.x/attributes/restSearch"

* var.api_key: specifies the API key to access MISP.
* var.json_objects_array: specifies the array object in MISP response, e.g., "response.Attribute".
* var.url: URI of the MISP REST API, e.g., "http://x.x.x.x/attributes/restSearch"

[float]
=== Example dashboard

This module comes with a sample dashboard. For example:

[role="screenshot"]
image::./images/kibana-misp.png[]

:has-dashboards!:

:modulename!:


[float]
Expand Down
5 changes: 0 additions & 5 deletions x-pack/filebeat/filebeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -409,11 +409,6 @@ filebeat.modules:
threat:
enabled: true

# MISP Configuration
var.api_key: "XXXXXXXXXXXXXX" # API key for MISP
var.json_objects_array: "response.Attribute"
var.url: "http://X.X.X.X/attributes/restSearch" # X.X.X.X is the IP address of the MISP server

#------------------------------- Mongodb Module -------------------------------
#- module: mongodb
# Logs
Expand Down
27 changes: 27 additions & 0 deletions x-pack/filebeat/module/misp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# MISP module

## Caveats

* Module is to be considered _beta_.

## How to try the module from distribution install

You should already have MISP installed and running. Information about the MISP platform can be found here: https://www.circl.lu/doc/misp.

```
./filebeat setup --modules=misp -e --dashboards
```

Enable the MISP module

```
./filebeat modules enable misp
```

Start Filebeat

```
./filebeat -e
```

You can see the MISP Overview dashboard and the imported threat indicators in Kibana.
5 changes: 0 additions & 5 deletions x-pack/filebeat/module/misp/_meta/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
- module: misp
threat:
enabled: true

# MISP Configuration
var.api_key: "XXXXXXXXXXXXXX" # API key for MISP
var.json_objects_array: "response.Attribute"
var.url: "http://X.X.X.X/attributes/restSearch" # X.X.X.X is the IP address of the MISP server
17 changes: 14 additions & 3 deletions x-pack/filebeat/module/misp/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,19 @@ beta[]
This is a filebeat module for reading threat intel information from the MISP platform (https://www.circl.lu/doc/misp/). It uses the httpjson input to access the MISP REST API interface.

The configuration in the config.yml file uses the following format:
var.api_key: specifies the API key to access MISP.
var.json_objects_array: specifies the array object in MISP response, e.g., "response.Attribute".
var.url: URI of the MISP REST API, e.g., "http://x.x.x.x/attributes/restSearch"

* var.api_key: specifies the API key to access MISP.
* var.json_objects_array: specifies the array object in MISP response, e.g., "response.Attribute".
* var.url: URI of the MISP REST API, e.g., "http://x.x.x.x/attributes/restSearch"

[float]
=== Example dashboard

This module comes with a sample dashboard. For example:

[role="screenshot"]
image::./images/kibana-misp.png[]

:has-dashboards!:

:modulename!:
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7f89974

Please sign in to comment.