From 4af4642d8a0d212b4dd4b7d9a3c5c30cd6d6f105 Mon Sep 17 00:00:00 2001
From: Alexandre Dulaunoy
Date: Fri, 7 Jan 2022 12:10:21 +0100
Subject: [PATCH 1/2] new: [REQUIREMENTS] for the documentation generation
---
DOC-REQUIREMENTS | 3 +++
1 file changed, 3 insertions(+)
create mode 100644 DOC-REQUIREMENTS
diff --git a/DOC-REQUIREMENTS b/DOC-REQUIREMENTS
new file mode 100644
index 0000000..8373cb7
--- /dev/null
+++ b/DOC-REQUIREMENTS
@@ -0,0 +1,3 @@
+mkdocs
+pymdown-extensions
+mkdocs-material
From ae4221723a031157dd10ce71f2ab2a7e5350d47d Mon Sep 17 00:00:00 2001
From: Alexandre Dulaunoy
Date: Fri, 7 Jan 2022 12:10:56 +0100
Subject: [PATCH 2/2] chg: [doc] updated
---
documentation/README.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/documentation/README.md b/documentation/README.md
index 8936fbf..c9fd62e 100644
--- a/documentation/README.md
+++ b/documentation/README.md
@@ -916,6 +916,20 @@ Query the MALWAREbazaar API to get additional information about the input hash a
-----
+#### [mwdb](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/mwdb.py)
+
+Module to push malware samples to a MWDB instance
+- **features**:
+>An expansion module to push malware samples to a MWDB (https://github.com/CERT-Polska/mwdb-core) instance. This module does not push samples to a sandbox. This can be achieved via Karton (connected to the MWDB). Does: * Upload of attachment or malware sample to MWDB * Tags of events and/or attributes are added to MWDB. * Comment of the MISP attribute is added to MWDB. * A link back to the MISP event is added to MWDB via the MWDB attribute. * A link to the MWDB attribute is added as an enrichted attribute to the MISP event.
+- **input**:
+>Attachment or malware sample
+- **output**:
+>Link attribute that points to the sample at the MWDB instane
+- **requirements**:
+>* mwdblib installed (pip install mwdblib) ; * (optional) keys.py file to add tags of events/attributes to MWDB * (optional) MWDB attribute created for the link back to MISP (defined in mwdb_misp_attribute)
+
+-----
+
#### [ocr_enrich](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/ocr_enrich.py)
Module to process some optical character recognition on pictures.