Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebdraven/IOCmite
Create dataset for suricata with indicators of MISP instances and add sightings in MISP if an indicator of dataset generates an alert
https://github.com/sebdraven/IOCmite
Last synced: about 1 month ago
JSON representation
Create dataset for suricata with indicators of MISP instances and add sightings in MISP if an indicator of dataset generates an alert
- Host: GitHub
- URL: https://github.com/sebdraven/IOCmite
- Owner: sebdraven
- License: mit
- Created: 2021-05-31T09:45:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-09T15:41:50.000Z (about 2 years ago)
- Last Synced: 2024-10-30T03:49:51.256Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 96.7 KB
- Stars: 37
- Watchers: 5
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-suricata - IOCmite - Tool to create dataset for suricata with indicators of MISP instances and add sightings in MISP if an indicator of dataset generates an alert. (Rule/Security Content Management and Handling)
README
# Suricata from to sources CTI
[](https://lgtm.com/projects/g/sebdraven/IOCmite/alerts/)
[](https://lgtm.com/projects/g/sebdraven/IOCmite/context:python)
the purpose of the application is to import attributes from different sources of threat Intelligence into suricata datasets to put them under surveillance.
## Concepts of datasets in Suricata
Indicators can be saved in a suricata dataset and create detection rules on this dataset.
This concept is detailed [here](https://suricata.readthedocs.io/en/suricata-6.0.0/rules/datasets.html).
## Installation
```bash
git clone https://github.com/sebdraven/iocmite.git
cd iocmite
python3 -m'venv' venv && source venv/bin/activate
pip install -r requirements.txt`
python setup.py install
```
or
```bash
cd
python -m'venv' venv && source venv/bin/activate
pip install iocmite
iocmite --help
```
Clone the latest release of Suricata and install `surcatasc`:
```bash
git clone https://github.com/OISF/suricata.git /tmp/suricata-git
cd /tmp/suricata-git/python
cp suricata/config/defaults.py{.in,}
setup install
```
## Json setting and Rule Suricata for MISP source and Sightings
```JSON
{
"misp": {
"url": "",
"key": ""
},
"eve_json": "/var/log/suricata/eve.json",
"metadata": "sightings",
"tmp_file": "/tmp/last_run",
"rule": "",
"datasets": {
"sources": {
"misp": {
"ip-src": {
"name": "ips",
"type": "string"
},
"ip-dst": {
"name": "ips",
"type": "string"
},
"hostname": {
"name": "dbl",
"type": "string"
},
"domain": {
"name": "dbl",
"type": "string"
},
"user-agent": {
"name": "uabl",
"type": "string"
}
}
}
}
}
```
Sample signatures are provided in the rules directory. For example, the one matching on HTTP hostname is:
Please be aware these datasets should be defined within Suricata, for example;
```YAML
datasets:
dbl:
type: string
save: dbl.lst
udbl:
type: string
save: udbl.lst
ips:
type: string
save: ips.lst
```
```
alert http any any -> any any (msg: "domains TA (HTTP)"; http.host; dataset:isset,dbl, type string, state /var/lib/suricata/data/dbl.lst; sid:1100001; rev:1; metadata:sightings http.hostname;)
```
The metadata term in the rule suricata is the same in the setting JSON file. The signatures suppose a standard system wide Suricata installation, you will need to change the path in the `state`
option in the `dataset` keyword if ever you don't have a standard installation.
Setup the url and key of MISP in the json file.
## Usage
### Principles
To synchronize the IOCs in MISP with Suricata datasets, you need to run an import command periodically.
You can use a cron task to do so.
To send sightings back to MISP, you need to run a IOCmite instance that will wait for new events
and publish sightings as soon as they came.
### Example commands
To import indicators from MISP to suricata with redis to store last run time, run the following command:
```bash
iocmite --config /path/to/json/file/settings.json --import --redis
```
To import indicators from MISP to suricata with temp file to store last run time, run the following command:
```bash
iocmite --config /path/to/json/file/settings.json --import --tmp_file
```
To catch alert from redis and send sightings to MISP, run the following command:
```bash
iocmite --config /path/to/json/file/settings.json --redis --sightings
```
To catch alert from eve_json and send sightings to MISP, run the following command:
```bash
iocmite --config /path/to/json/file/settings.json --eve_json --sightings
```