Publisher: Splunk
Connector Version: 3.0.0
Product Vendor: MISP
Product Name: MISP
Product Version Supported (regex): ".*"
Minimum Product Version: 5.2.0
Take action with Malware Information Sharing Platform
This app uses the pymisp module, which is licensed under an open source license. A simplified 2-BSD License, Copyright (c) 2017 Raphaël Vinot.
This app uses the jsonschema module, which is licensed under the MIT License, Copyright (c) 2013 Julian Berman.
This app uses the Deprecated module, which is licensed under the MIT License, Copyright (c) 2017 Laurent LAPORTE.
This app uses the cachetools module, which is licensed under the MIT License, Copyright (c) 2014-2021 Thomas Kemmer.
Misp will return integers which correspond to various values. Here is the complete list:
For distribution :
- 0: Your Org Only
- 1: This Community Only
- 2: Connected Communities
- 3: All Communities
- 4: Sharing Group
- 5: Inherit
For threat level id :
- 1: High
- 2: Medium
- 3: Low
- 4: Undefined
For analysis :
- 0: Initial
- 1: Ongoing
- 2: Completed
Note:
-
Create new events with the
create event
action. -
To add a single attribute to an existing event use the
add attribute
action. -
To add multiple attributes to an event, use the
bulk add attributes
action. -
In the 'run query' action, tags containing a comma (,) in its value can be passed through the 'other' action parameter. For example:
- other: {"tags": ["tag1, tag11", "tag_2"]}
"tag1, tag11" will be considered a single tag.
The app uses HTTP/HTTPS protocol for communicating with the Misp Server. Below are the default ports used by Splunk SOAR.
Service Name | Transport Protocol | Port |
---|---|---|
http | tcp | 80 |
https | tcp | 443 |
The below configuration variables are required for this Connector to operate. These variables are specified when configuring a MISP asset in SOAR.
VARIABLE | REQUIRED | TYPE | DESCRIPTION |
---|---|---|---|
base_url | required | string | MISP instance URL (http://misp_instance.company.com/) |
verify_server_cert | optional | boolean | Verify server certificate |
api_key | required | password | API Key found under Event Actions: Automation |
test connectivity - Validate the asset configuration for connectivity
bulk add attributes - Add multiple attributes to an existing MISP event
add attribute - Add an attribute to an existing MISP event
create event - Create a new event in MISP
run query - Run a query to find events or attributes
get attributes - Get attributes for a specific event
Validate the asset configuration for connectivity
Type: test
Read only: True
No parameters are required for this action
No Output
Add multiple attributes to an existing MISP event
Type: generic
Read only: False
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS |
---|---|---|---|---|
event_id | required | Event ID | string | |
json | required | JSON list of attribute objects to add to the event. Example: [{"category": "Network activity", "type": "ip-src", "value": "1.2.3.4"}] | string |
DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES |
---|---|---|---|
action_result.status | string | success failed | |
action_result.data.*.updated_event | string |
Add an attribute to an existing MISP event
Type: generic
Read only: False
To add multiple attributes to an event, use the 'bulk add attributes' action
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS |
---|---|---|---|---|
event_id | required | Event ID | string | |
attribute_category | optional | Attribute Category | string | |
attribute_type | optional | Attribute Type | string | |
attribute_value | optional | Attribute Value | string | |
attribute_comment | optional | Attribute Comment | string | |
json | optional | JSON key-value object of additional attribute fields. Example: {"to_ids" : true}. For list of available parameters see: https://www.misp-project.org/openapi/#tag/Attributes/operation/addAttribute | string |
DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES |
---|---|---|---|
action_result.status | string | success failed | |
action_result.data.*.updated_event | string | ||
action_result.data.*.response | string |
Create a new event in MISP
Type: generic
Read only: False
This action first creates an event, then adds attributes to that event. Parameters urls, domains, source_ips, dest_ips, source_emails, dest_emails accept comma-separated values.
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS |
---|---|---|---|---|
distribution | required | Distribution level for sharing | string | |
threat_level_id | required | Threat level id | string | |
analysis | required | Current stage of analysis for event | string | |
info | required | Information / Description for Event | string |
DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES |
---|---|---|---|
action_result.status | string | success failed | |
action_result.parameter.analysis | string | Initial | |
action_result.parameter.distribution | string | This Community Only | |
action_result.parameter.info | string | Event Info Goes Here | |
action_result.parameter.threat_level_id | string | undefined | |
action_result.data.*.Org.id | string | 1 | |
action_result.data.*.Org.local | boolean | True False | |
action_result.data.*.Org.name | string | ORGNAME | |
action_result.data.*.Org.uuid | string | 2af87aa3-a713-4ca5-83f7-03ae949c8459 | |
action_result.data.*.Orgc.id | string | 1 | |
action_result.data.*.Orgc.local | boolean | True False | |
action_result.data.*.Orgc.name | string | ORGNAME | |
action_result.data.*.Orgc.uuid | string | 2af87aa3-a713-4ca5-83f7-03ae949c8459 | |
action_result.data.*.analysis | string | 0 | |
action_result.data.*.attribute_count | string | ||
action_result.data.*.category | string | Network activity | |
action_result.data.*.comment | string | ||
action_result.data.*.date | string | 2021-06-09 | |
action_result.data.*.deleted | boolean | True False | |
action_result.data.*.disable_correlation | boolean | True False | |
action_result.data.*.distribution | string | ||
action_result.data.*.event_creator_email | string | [email protected] | |
action_result.data.*.event_id | string | misp event id |
2052 |
action_result.data.*.extends_uuid | string | ||
action_result.data.*.id | string | ||
action_result.data.*.info | string | ||
action_result.data.*.locked | boolean | True False | |
action_result.data.*.object_id | string | 0 | |
action_result.data.*.org_id | string | 1 | |
action_result.data.*.orgc_id | string | 1 | |
action_result.data.*.proposal_email_lock | boolean | True False | |
action_result.data.*.publish_timestamp | numeric | 0 | |
action_result.data.*.published | boolean | True False | |
action_result.data.*.sharing_group_id | string | 0 | |
action_result.data.*.threat_level_id | string | ||
action_result.data.*.timestamp | string | 1623206691 | |
action_result.data.*.to_ids | boolean | True False | |
action_result.data.*.type | string | url | |
action_result.data.*.uuid | string | 82c82204-4ebd-42cb-a913-4df726b5d7fe | |
action_result.data.*.value | string | url domain ip email hash md5 sha256 md1 |
8.8.8.8 |
action_result.data.0.id | string | misp event id |
|
action_result.summary.errors | string | 'test' is/are invalid attribute name/names in 'json' action parameter | |
action_result.summary.message | string | Event created with id: 2139 | |
action_result.message | string | Message: Event created with id: 2139, Errors: 'test' is/are invalid attribute name/names in 'json' action parameter | |
summary.total_objects | numeric | 1 | |
summary.total_objects_successful | numeric | 1 |
Run a query to find events or attributes
Type: investigate
Read only: True
By setting max_results to 0, you can get every result. It is recommended you do not do this, as MISP can return a lot of data. The default is 10, and this will be the oldest 10 results.
The other field expects a json string, which can have the key value pairs of any field which the search API supports.
By giving max results as a negative number, n, it will take the last n results from the query. From there, you can take the timestamp from the first object in the resulting list, then pass it in the other field like so: {"timestamp": <timestamp + 1>}. All the results will now be after that specified timestamp.
Also note that when searching for events, events with no attributes will not be returned.
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS |
---|---|---|---|---|
controller | required | Search for events or attributes | string | |
max_results | optional | Max results to return | numeric | |
event_id | optional | Comma seperated list of Event IDs | string | misp event id |
tags | optional | Comma seperated list of tags | string | |
other | optional | Other search parameters, as a JSON object | string |
DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES |
---|---|---|---|
action_result.status | string | success failed | |
action_result.parameter.controller | string | events attributes | |
action_result.parameter.event_id | string | misp event id |
1 |
action_result.parameter.max_results | numeric | 1000 | |
action_result.parameter.other | string | ||
action_result.parameter.tags | string | test_1 | |
action_result.data.*.*.Event.Attribute.*.category | string | Network activity | |
action_result.data.*.*.Event.Attribute.*.comment | string | ||
action_result.data.*.*.Event.Attribute.*.deleted | numeric | True False | |
action_result.data.*.*.Event.Attribute.*.disable_correlation | numeric | True False | |
action_result.data.*.*.Event.Attribute.*.distribution | string | 5 | |
action_result.data.*.*.Event.Attribute.*.event_id | string | 1 | |
action_result.data.*.*.Event.Attribute.*.first_seen | string | ||
action_result.data.*.*.Event.Attribute.*.id | string | 4265 | |
action_result.data.*.*.Event.Attribute.*.last_seen | string | ||
action_result.data.*.*.Event.Attribute.*.object_id | string | 0 | |
action_result.data.*.*.Event.Attribute.*.object_relation | string | ||
action_result.data.*.*.Event.Attribute.*.sharing_group_id | string | 0 | |
action_result.data.*.*.Event.Attribute.*.timestamp | string | 1622191169 | |
action_result.data.*.*.Event.Attribute.*.to_ids | numeric | True False | |
action_result.data.*.*.Event.Attribute.*.type | string | url |
email-dst |
action_result.data.*.*.Event.Attribute.*.uuid | string | 03fa856e-b6f9-4e34-82ac-1e50dd058f37 | |
action_result.data.*.*.Event.Attribute.*.value | string | url domain ip email hash md5 sha256 md1 |
[email protected] |
action_result.data.*.*.Event.Object.*.Attribute.*.category | string | Payload delivery | |
action_result.data.*.*.Event.Object.*.Attribute.*.comment | string | ||
action_result.data.*.*.Event.Object.*.Attribute.*.deleted | numeric | True False | |
action_result.data.*.*.Event.Object.*.Attribute.*.disable_correlation | numeric | True False | |
action_result.data.*.*.Event.Object.*.Attribute.*.distribution | string | 5 | |
action_result.data.*.*.Event.Object.*.Attribute.*.event_id | string | 2020 | |
action_result.data.*.*.Event.Object.*.Attribute.*.first_seen | string | ||
action_result.data.*.*.Event.Object.*.Attribute.*.id | string | 4953 | |
action_result.data.*.*.Event.Object.*.Attribute.*.last_seen | string | ||
action_result.data.*.*.Event.Object.*.Attribute.*.object_id | string | 10 | |
action_result.data.*.*.Event.Object.*.Attribute.*.object_relation | string | filename | |
action_result.data.*.*.Event.Object.*.Attribute.*.sharing_group_id | string | 0 | |
action_result.data.*.*.Event.Object.*.Attribute.*.timestamp | string | 1623078296 | |
action_result.data.*.*.Event.Object.*.Attribute.*.to_ids | numeric | True False | |
action_result.data.*.*.Event.Object.*.Attribute.*.type | string | filename | |
action_result.data.*.*.Event.Object.*.Attribute.*.uuid | string | 2fd53a9b-44fd-4ebc-af93-0e1605cf3b64 | |
action_result.data.*.*.Event.Object.*.Attribute.*.value | string | url domain ip email hash md5 sha256 md1 |
6.43.3.2 |
action_result.data.*.*.Event.Object.*.comment | string | ||
action_result.data.*.*.Event.Object.*.deleted | numeric | True False | |
action_result.data.*.*.Event.Object.*.description | string | File object describing a file with meta-information | |
action_result.data.*.*.Event.Object.*.distribution | string | 5 | |
action_result.data.*.*.Event.Object.*.event_id | string | 2020 | |
action_result.data.*.*.Event.Object.*.first_seen | string | ||
action_result.data.*.*.Event.Object.*.id | string | 10 | |
action_result.data.*.*.Event.Object.*.last_seen | string | ||
action_result.data.*.*.Event.Object.*.meta-category | string | file | |
action_result.data.*.*.Event.Object.*.name | string | file | |
action_result.data.*.*.Event.Object.*.sharing_group_id | string | 0 | |
action_result.data.*.*.Event.Object.*.template_uuid | string | 688c46fb-5edb-40a3-8273-1af7923e2215 | |
action_result.data.*.*.Event.Object.*.template_version | string | 24 | |
action_result.data.*.*.Event.Object.*.timestamp | string | 1623078296 | |
action_result.data.*.*.Event.Object.*.uuid | string | 4b5cb238-9e55-40eb-b60e-b30f71cab6f6 | |
action_result.data.*.*.Event.Org.id | string | 1 | |
action_result.data.*.*.Event.Org.local | numeric | True False | |
action_result.data.*.*.Event.Org.name | string | ORGNAME | |
action_result.data.*.*.Event.Org.uuid | string | 2af87aa3-a713-4ca5-83f7-03ae949c8459 | |
action_result.data.*.*.Event.Orgc.id | string | 1 | |
action_result.data.*.*.Event.Orgc.local | numeric | True False | |
action_result.data.*.*.Event.Orgc.name | string | ORGNAME | |
action_result.data.*.*.Event.Orgc.uuid | string | 2af87aa3-a713-4ca5-83f7-03ae949c8459 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.Org.id | string | 1 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.Org.name | string | ORGNAME | |
action_result.data.*.*.Event.RelatedEvent.*.Event.Org.uuid | string | 2af87aa3-a713-4ca5-83f7-03ae949c8459 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.Orgc.id | string | 1 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.Orgc.name | string | ORGNAME | |
action_result.data.*.*.Event.RelatedEvent.*.Event.Orgc.uuid | string | 2af87aa3-a713-4ca5-83f7-03ae949c8459 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.analysis | string | 0 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.date | string | 2021-06-14 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.distribution | string | 1 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.id | string | 2161 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.info | string | Event created by test | |
action_result.data.*.*.Event.RelatedEvent.*.Event.org_id | string | 1 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.orgc_id | string | 1 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.published | numeric | True False | |
action_result.data.*.*.Event.RelatedEvent.*.Event.threat_level_id | string | 4 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.timestamp | string | 1623645286 | |
action_result.data.*.*.Event.RelatedEvent.*.Event.uuid | string | f346cd43-ef47-4401-b725-a5f4f45a4ed3 | |
action_result.data.*.*.Event.Tag.*.colour | string | #7ab870 | |
action_result.data.*.*.Event.Tag.*.exportable | numeric | True False | |
action_result.data.*.*.Event.Tag.*.hide_tag | numeric | True False | |
action_result.data.*.*.Event.Tag.*.id | string | 8 | |
action_result.data.*.*.Event.Tag.*.is_custom_galaxy | numeric | True False | |
action_result.data.*.*.Event.Tag.*.is_galaxy | numeric | True False | |
action_result.data.*.*.Event.Tag.*.local | numeric | 1 | |
action_result.data.*.*.Event.Tag.*.name | string | test_1 | |
action_result.data.*.*.Event.Tag.*.numerical_value | string | ||
action_result.data.*.*.Event.Tag.*.user_id | string | 1 | |
action_result.data.*.*.Event.analysis | string | 0 | |
action_result.data.*.*.Event.attribute_count | string | 7 | |
action_result.data.*.*.Event.date | string | 2021-03-17 | |
action_result.data.*.*.Event.disable_correlation | numeric | True False | |
action_result.data.*.*.Event.distribution | string | 1 | |
action_result.data.*.*.Event.event_creator_email | string | email |
[email protected] |
action_result.data.*.*.Event.extends_uuid | string | ||
action_result.data.*.*.Event.id | string | 1 | |
action_result.data.*.*.Event.info | string | Event created by test | |
action_result.data.*.*.Event.locked | numeric | True False | |
action_result.data.*.*.Event.org_id | string | 1 | |
action_result.data.*.*.Event.orgc_id | string | 1 | |
action_result.data.*.*.Event.proposal_email_lock | numeric | True False | |
action_result.data.*.*.Event.publish_timestamp | string | 0 | |
action_result.data.*.*.Event.published | numeric | True False | |
action_result.data.*.*.Event.sharing_group_id | string | 0 | |
action_result.data.*.*.Event.threat_level_id | string | 4 | |
action_result.data.*.*.Event.timestamp | string | 1623657727 | |
action_result.data.*.*.Event.uuid | string | 15483d56-fc32-4e54-a8b4-e9f56e7818bd | |
action_result.data.*.Attribute.*.Event.distribution | string | 1 | |
action_result.data.*.Attribute.*.Event.id | string | 2020 | |
action_result.data.*.Attribute.*.Event.info | string | Event created by test | |
action_result.data.*.Attribute.*.Event.org_id | string | 1 | |
action_result.data.*.Attribute.*.Event.orgc_id | string | 1 | |
action_result.data.*.Attribute.*.Event.uuid | string | 342c12ab-32ad-41d0-aea2-1c3dccc6ce09 | |
action_result.data.*.Attribute.*.Object.distribution | string | 5 | |
action_result.data.*.Attribute.*.Object.id | string | 10 | |
action_result.data.*.Attribute.*.Object.sharing_group_id | string | 0 | |
action_result.data.*.Attribute.*.category | string | Other Payload delivery | |
action_result.data.*.Attribute.*.comment | string | ||
action_result.data.*.Attribute.*.deleted | numeric | True False | |
action_result.data.*.Attribute.*.disable_correlation | numeric | False True | |
action_result.data.*.Attribute.*.distribution | string | 5 | |
action_result.data.*.Attribute.*.event_id | string | misp event id |
1 |
action_result.data.*.Attribute.*.first_seen | string | ||
action_result.data.*.Attribute.*.id | string | misp attribute id |
164201 |
action_result.data.*.Attribute.*.last_seen | string | ||
action_result.data.*.Attribute.*.object_id | string | 0 10 | |
action_result.data.*.Attribute.*.object_relation | string | filename | |
action_result.data.*.Attribute.*.sharing_group_id | string | 0 | |
action_result.data.*.Attribute.*.timestamp | string | 1498505296 | |
action_result.data.*.Attribute.*.to_ids | boolean | True False | |
action_result.data.*.Attribute.*.type | string | comment filename | |
action_result.data.*.Attribute.*.uuid | string | 56e96919-ad18-4f68-8aa1-539002de0b81 | |
action_result.data.*.Attribute.*.value | string | url domain ip email hash md5 sha256 md1 |
[email protected] |
action_result.data.*.attribute_count | string | 103 | |
action_result.summary | string | ||
action_result.message | string | Successfully ran query | |
summary.total_objects | numeric | 1 | |
summary.total_objects_successful | numeric | 1 |
Get attributes for a specific event
Type: investigate
Read only: True
download_samples will only download files which are marked as a 'malware-sample'.
PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS |
---|---|---|---|---|
event_id | required | An Event ID | numeric | misp event id |
download_samples | optional | Download malware samples to vault | boolean |
DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES |
---|---|---|---|
action_result.status | string | success failed | |
action_result.parameter.download_samples | boolean | True False | |
action_result.parameter.event_id | numeric | misp event id |
686 |
action_result.data.*.Attribute.*.Event.distribution | string | 1 | |
action_result.data.*.Attribute.*.Event.id | string | misp event id |
2028 |
action_result.data.*.Attribute.*.Event.info | string | Event created by test | |
action_result.data.*.Attribute.*.Event.org_id | string | 1 | |
action_result.data.*.Attribute.*.Event.orgc_id | string | 1 | |
action_result.data.*.Attribute.*.Event.uuid | string | 552d93e4-fa0d-48cb-810e-a5f56c0af5ea 342c12ab-32ad-41d0-aea2-1c3dccc6ce09 | |
action_result.data.*.Attribute.*.Object.distribution | string | 5 | |
action_result.data.*.Attribute.*.Object.id | string | 10 | |
action_result.data.*.Attribute.*.Object.sharing_group_id | string | 0 | |
action_result.data.*.Attribute.*.category | string | Network activity | |
action_result.data.*.Attribute.*.comment | string | ||
action_result.data.*.Attribute.*.deleted | boolean | False True | |
action_result.data.*.Attribute.*.disable_correlation | boolean | False True | |
action_result.data.*.Attribute.*.distribution | string | 5 | |
action_result.data.*.Attribute.*.event_id | string | misp event id |
686 |
action_result.data.*.Attribute.*.first_seen | string | ||
action_result.data.*.Attribute.*.id | string | misp attribute id |
164191 |
action_result.data.*.Attribute.*.last_seen | string | ||
action_result.data.*.Attribute.*.object_id | string | 0 10 | |
action_result.data.*.Attribute.*.object_relation | string | filename | |
action_result.data.*.Attribute.*.sharing_group_id | string | 0 | |
action_result.data.*.Attribute.*.timestamp | string | 1498002097 | |
action_result.data.*.Attribute.*.to_ids | boolean | True False | |
action_result.data.*.Attribute.*.type | string | ip-src | |
action_result.data.*.Attribute.*.uuid | string | 5949b2b1-35b4-4152-a633-7e530a10000d | |
action_result.data.*.Attribute.*.value | string | url domain ip email hash md5 sha256 md1 |
192.162.8.1 |
action_result.summary | string | ||
action_result.message | string | Successfully retrieved attributes | |
summary.total_objects | numeric | 1 | |
summary.total_objects_successful | numeric | 1 |