Skip to content

Commit 32c3975

Browse files
feat(misp): Update MISP plugin page
1 parent 54a78bf commit 32c3975

File tree

7 files changed

+41
-16
lines changed

7 files changed

+41
-16
lines changed
62.9 KB
Loading
10.1 KB
Loading
202 KB
Loading
176 KB
Loading
-59.1 KB
Binary file not shown.
-30.6 KB
Binary file not shown.

crowdsec-docs/unversioned/cti_api/integration_misp.md

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,66 @@ title: MISP Plugin
44
sidebar_position: 2
55
---
66

7-
MISP hover plugin allows you to get knowledge from CrowdSec's CTI API upon hovering an IP in your MISP instance.
7+
MISP plugin lets you enrich the knowledge of IP attributes using CrowdSec's CTI API.
88

99
## Installation
1010

11+
### Requirements
12+
13+
- A CrowdSec CTI API key. See [instructions to obtain it](https://docs.crowdsec.net/docs/next/cti_api/getting_started/#getting-an-api-key)
14+
1115
### Setting up plugin server
1216

1317
The plugin is included in MISP's [official plugin repo](https://github.com/MISP/misp-modules).
1418

15-
The development version can be found on [crowdsec's fork](https://github.com/crowdsecurity/misp-modules).
16-
17-
Install the fork via by following instructions given [here](https://github.com/MISP/misp-modules#how-to-install-and-start-misp-modules-in-a-python-virtualenv-recommended)
18-
. Make sure to subsitute repository address as required.
1919

2020
### Configure the plugin
2121

22-
1. Navigate to plugin settings page at `http://<your_misp_address>/servers/serverSettings/Plugin`
22+
You can activate this module by accessing the “Plugins” tab of your MISP instance:
2323

24-
2. Click on Enrichment.
24+
1. Navigate to plugin settings page at `http://<your-misp-address>/servers/serverSettings/Plugin`
25+
2. Click on Enrichment
26+
3. Set the value of `Plugin.Enrichment_crowdsec_enabled` to `true`
27+
4. Set the value of `Plugin.Enrichment_crowdsec_api_key` to your CrowdSec CTI API key
28+
29+
For more details on the settings available, please refer to the [Configurations](#configurations) part.
2530

26-
3. Set the value of Plugin.Enrichment_crowdsec_enabled to `true`
2731

28-
4. Set the value of Plugin.Enrichment_crowdsec_api_key to your CTI API key. See [instructions to obtain it](/cti_api/getting_started.mdx)
32+
## Usage
2933

30-
5. Set the value of Plugin.Enrichment_crowdsec_api_version to "v2".
34+
Thanks to the CrowdSec Threat Intelligence, you can enrich your IP attributes.
3135

32-
Done !
36+
![Enrich IP](/img/misp/enrich-event-from-left-menu-popup.png)
3337

38+
Once enriched, you will find a `crowdsec-ip-context` object with all attributes retrieved from CrowdSec.
3439

35-
## Usage
40+
For more details about this object, please refer to the [Misp project documentation](https://www.misp-project.org/objects.html#_crowdsec_ip_context).
41+
42+
43+
![Enriched IP part 1](/img/misp/enriched-ip-event.png)
44+
45+
![Enriched IP part 2](/img/misp/enriched-ip-event-2.png)
46+
47+
48+
## Configurations
49+
50+
You will find the settings page at `http://<your-misp-address>/servers/serverSettings/Plugin`
51+
52+
![Configurations](/img/misp/config.png)
53+
54+
Configuration parameters are described below:
3655

37-
1. Simply click on hover button on any IP attribute.
3856

39-
![MISP hover](/img/misp_hover.png)
57+
| Setting name | Mandatory | Type | Description |
58+
|------------------------------------------------------|-----------|---------|--------------------------------------------------------------------------------------------------------------------------------------------|
59+
| `Plugin.Enrichment_crowdsec_enabled` | Yes | Boolean | Enable or disable the crowdsec module |
60+
| `Plugin.Enrichment_crowdsec_restrict` | No | String | Restrict the crowdsec module to the given organisation. |
61+
| `Plugin.Enrichment_crowdsec_api_key` | Yes | String | CrowdSec CTI API key. See [instructions to obtain it](https://docs.crowdsec.net/docs/next/cti_api/getting_started/#getting-an-api-key) |
62+
| `Plugin.Enrichment_crowdsec_add_reputation_tag` | No | String | Enable/disable the creation of a reputation tag for the IP attribute. You can use `True` or `False` as string value. Default: `True` |
63+
| `Plugin.Enrichment_crowdsec_add_behavior_tag` | No | String | Enable/disable the creation of a behavior tag for the IP attribute. You can use `True` or `False` as string value. Default: `True` |
64+
| `Plugin.Enrichment_crowdsec_add_classification_tag` | No | String | Enable/disable the creation of a classification tag for the IP attribute. You can use `True` or `False` as string value. Default: `True` |
65+
| `Plugin.Enrichment_crowdsec_add_mitre_technique_tag` | No | String | Enable/disable the creation of a mitre technique tag for the IP attribute. You can use `True` or `False` as string value. Default: `True` |
66+
| `Plugin.Enrichment_crowdsec_add_cve_tag` | No | String | Enable/disable the creation of a cve tag for the IP attribute. You can use `True` or `False` as string value. Default: `True` |
4067

41-
2. Upon clicking the hover icon, you will see the enrichements on this IP obtained from CrowdSec's CTI.
4268

43-
![MISP CrowdSec Hover](/img/misp_crowdsec_knowledge.png)
4469

0 commit comments

Comments
 (0)