Skip to content

Commit b2ed8b7

Browse files
committed
chg: [mkdocs] updated
1 parent 3b2a671 commit b2ed8b7

4 files changed

Lines changed: 112 additions & 31 deletions

File tree

documentation/mkdocs/action_mod.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ Simplistic module to send message to a Mattermost channel.
1212
1313
-----
1414

15+
#### [Nextcloud talk](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/action_mod/nextcloud_talk.py)
16+
17+
Simplistic module to send a message to a Nextcloud talk conversation.
18+
[[source code](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/action_mod/nextcloud_talk.py)]
19+
20+
- **features**:
21+
>
22+
23+
- **config**:
24+
>{'params': {'nextcloud_baseurl': {'type': 'string', 'description': 'The Nexctloud domain or URL', 'value': 'https://example.nextcloud.org:443'}, 'nextcloud_app_uuid_login': {'type': 'string', 'description': 'The nextcloud username'}, 'app_access_token': {'type': 'string', 'description': 'The nextcloud application token'}, 'nextcloud_conversation_token': {'type': 'string', 'description': 'The token of the conversation the message should be sent to'}, 'message_template': {'type': 'large_string', 'description': 'The template to be used to generate the message to be posted', 'value': 'The **template** will be rendered using *Jinja2*!', 'jinja_supported': True}}, 'blocking': False, 'support_filters': True, 'expect_misp_core_format': False}
25+
26+
-----
27+
1528
#### [Slack](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/action_mod/slack.py)
1629

1730
Simplistic module to send messages to a Slack channel.

documentation/mkdocs/expansion.md

Lines changed: 67 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,52 @@ AbuseIPDB MISP expansion module
1414
1515
-----
1616

17+
#### [ANYRUN Sandbox Submit](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/anyrun_sandbox_submit.py)
18+
19+
A module designed to submit URLs or files to the ANY.RUN Sandbox for analysis and return the unique analysis link and ID.
20+
[[source code](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/anyrun_sandbox_submit.py)]
21+
22+
- **features**:
23+
>Supports submission of URLs and files via the ANY.RUN API; requires an API key for authentication; returns the task ID and permanent URL for tracking analysis progress; integrates seamlessly with MISP events by enriching attributes with submission results.
24+
25+
- **config**:
26+
> - api_key
27+
> - os_type
28+
> - opt_timeout
29+
> - opt_network_connect
30+
> - opt_network_fakenet
31+
> - opt_network_tor
32+
> - opt_network_geo
33+
> - opt_network_mitm
34+
> - opt_network_residential_proxy
35+
> - opt_network_residential_proxy_geo
36+
> - opt_privacy_type
37+
> - obj_ext_extension
38+
> - obj_ext_browser
39+
> - env_locale
40+
> - env_version
41+
> - env_bitness
42+
> - env_type
43+
> - obj_ext_startfolder
44+
> - obj_ext_cmd
45+
> - obj_force_elevation
46+
> - run_as_root
47+
48+
- **input**:
49+
>Attachment, malware-sample or url to submit to ANY.RUN Sandbox.
50+
51+
- **output**:
52+
>ANY.RUN Sandbox analysis URL and UUID.
53+
54+
- **references**:
55+
>https://any.run
56+
57+
- **requirements**:
58+
> - anyrun-sdk: ANY.RUN API python3 library
59+
> - ANY.RUN Sandbox API-KEY
60+
61+
-----
62+
1763
#### [OSINT DigitalSide](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/apiosintds.py)
1864

1965
On demand query API for OSINT.digitalside.it project.
@@ -107,9 +153,6 @@ A module tu query the AssemblyLine API with a submission ID to get the submissio
107153
- **references**:
108154
>https://www.cyber.gc.ca/en/assemblyline
109155
110-
- **requirements**:
111-
>assemblyline_client: Python library to query the AssemblyLine rest API.
112-
113156
-----
114157

115158
#### [AssemblyLine Submit](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/assemblyline_submit.py)
@@ -140,9 +183,6 @@ A module to submit samples and URLs to AssemblyLine for advanced analysis, and r
140183
- **references**:
141184
>https://www.cyber.gc.ca/en/assemblyline
142185
143-
- **requirements**:
144-
>assemblyline_client: Python library to query the AssemblyLine rest API.
145-
146186
-----
147187

148188
#### [Backscatter.io](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/backscatter_io.py)
@@ -1572,6 +1612,9 @@ Query Malware Bazaar to get additional information about the input hash.
15721612
>
15731613
>The module is using the new format of modules able to return object since the result is one or multiple MISP object(s).
15741614
1615+
- **config**:
1616+
>auth_key
1617+
15751618
- **input**:
15761619
>A hash attribute (md5, sha1 or sha256).
15771620
@@ -2028,37 +2071,23 @@ Module to access the ransomcoinDB (see https://ransomcoindb.concinnity-risks.com
20282071

20292072
-----
20302073

2031-
#### [Rapid7 AttackerKB lookup](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/rapid7_attackerkb.py)
2074+
#### [r7_akb](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/rapid7_attackerkb.py)
20322075

2033-
<img src=../logos/rapid7.png height=45>
2034-
2035-
Module to lookup CVE attributes in **Rapid7 AttackerKB**.
2076+
Enrich CVEs via AttackerKB and return structured MISP events. Handles rate limits, regex CVE detection, and markdown cleanup.
20362077
[[source code](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/rapid7_attackerkb.py)]
20372078

2038-
- **features**:
2039-
>The module takes a CVE attribute and queries Rapid7 AttackerKB to retrieve information about the vulnerability.
2040-
>It returns details such as the CVSS score, exploitability, attacker value, available references, Rapid7 analysis, and community assessments.
2041-
2042-
- **config**:
2043-
> api_key
2044-
2045-
- **input**:
2046-
>A vulnerability attribute containing a CVE ID, or a comment that includes one or more CVEs.
2079+
- **config**:
2080+
>api_key
20472081

2048-
- **output**:
2049-
> Enriched information about the CVE, including:
2050-
> - Vulnerability description and link to Rapid7 AttackerKB topic
2051-
> - CVSS base score
2052-
> - Attacker value and exploitability ratings
2053-
> - External references related to the CVE
2054-
> - Rapid7’s analysis (if available)
2055-
> - Community assessments with contributor names, scores, and notes
2082+
- **input**:
2083+
>Vulnerability attribute (CVE ID or comment containing CVE).
20562084

2057-
- **references**:
2058-
> https://attackerkb.com/
2085+
- **output**:
2086+
>Structured MISP Objects.
20592087

2060-
- **requirements**:
2061-
> A valid public Rapid7 AttackerKB API key https://api.attackerkb.com/v1/api-docs/docs
2088+
- **requirements**:
2089+
> - pymisp
2090+
> - requests
20622091

20632092
-----
20642093

@@ -2313,6 +2342,7 @@ An expansion module to query the Sophoslabs intelix API to get additional inform
23132342
- **config**:
23142343
> - client_id
23152344
> - client_secret
2345+
> - region
23162346
23172347
- **input**:
23182348
>An ip address, url, domain or sha256 attribute.
@@ -2457,6 +2487,9 @@ Module to search for an IOC on ThreatFox by abuse.ch.
24572487
- **features**:
24582488
>
24592489

2490+
- **config**:
2491+
>auth_key
2492+
24602493
-----
24612494

24622495
#### [ThreatMiner Lookup](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/expansion/threatminer.py)
@@ -2566,6 +2599,9 @@ Query of the URLhaus API to get additional information about the input attribute
25662599
>
25672600
>The module takes one of the attribute type specified as input, and query the URLhaus API with it. If any result is returned by the API, attributes and objects are created accordingly.
25682601

2602+
- **config**:
2603+
>auth_key
2604+
25692605
- **input**:
25702606
>A domain, hostname, url, ip, md5 or sha256 attribute.
25712607

documentation/mkdocs/import_mod.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,32 @@
11

2+
#### [ANYRUN Sandbox Import](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/anyrun_sandbox_import.py)
3+
4+
<img src=../logos/anyrun.png height=60>
5+
6+
A module designed to retrieve an analysis report from the ANY.RUN Sandbox by its unique ID and extract results (such as verdict, malware tags, and IOCs), converting them into MISP attributes within your event.
7+
[[source code](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/anyrun_sandbox_import.py)]
8+
9+
- **features**:
10+
>Fetches detailed JSON reports using the ANY.RUN API; parses key elements like verdict, extracted IOCs (hashes, IPs, URLs), malware tags; maps data to MISP attributes and galaxies (e.g., malware family or MITRE ATT&CK Techniques).
11+
12+
- **config**:
13+
>api_key
14+
15+
- **input**:
16+
>ANY.RUN Sandbox analysis UUID.
17+
18+
- **output**:
19+
>Analysis external references, verdict, IOCs (hashes, IPs, URLs), malware tags, MITRE ATT&CK Techniques
20+
21+
- **references**:
22+
>https://any.run
23+
24+
- **requirements**:
25+
> - anyrun-sdk: ANY.RUN API python3 library
26+
> - ANY.RUN Sandbox API-KEY
27+
28+
-----
29+
230
#### [PDNS COF Importer](https://github.com/MISP/misp-modules/tree/main/misp_modules/modules/import_mod/cof2misp.py)
331

432
Passive DNS Common Output Format (COF) MISP importer

documentation/mkdocs/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj
1616

1717
### Expansion Modules
1818
* [Abuse IPDB](https://misp.github.io/misp-modules/expansion/#abuse-ipdb) - AbuseIPDB MISP expansion module
19+
* [ANYRUN Sandbox Submit](https://misp.github.io/misp-modules/expansion/#anyrun-sandbox-submit) - A module designed to submit URLs or files to the ANY.RUN Sandbox for analysis and return the unique analysis link and ID.
1920
* [OSINT DigitalSide](https://misp.github.io/misp-modules/expansion/#osint-digitalside) - On demand query API for OSINT.digitalside.it project.
2021
* [APIVoid](https://misp.github.io/misp-modules/expansion/#apivoid) - Module to query APIVoid with some domain attributes.
2122
* [AssemblyLine Query](https://misp.github.io/misp-modules/expansion/#assemblyline-query) - A module tu query the AssemblyLine API with a submission ID to get the submission report and parse it.
@@ -88,6 +89,7 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj
8889
* [Qintel QSentry Lookup](https://misp.github.io/misp-modules/expansion/#qintel-qsentry-lookup) - A hover and expansion module which queries Qintel QSentry for ip reputation data
8990
* [QR Code Decode](https://misp.github.io/misp-modules/expansion/#qr-code-decode) - Module to decode QR codes.
9091
* [RandomcoinDB Lookup](https://misp.github.io/misp-modules/expansion/#randomcoindb-lookup) - Module to access the ransomcoinDB (see https://ransomcoindb.concinnity-risks.com)
92+
* [r7_akb](https://misp.github.io/misp-modules/expansion/#r7_akb) - Enrich CVEs via AttackerKB and return structured MISP events. Handles rate limits, regex CVE detection, and markdown cleanup.
9193
* [Real-time Blackhost Lists Lookup](https://misp.github.io/misp-modules/expansion/#real-time-blackhost-lists-lookup) - Module to check an IPv4 address against known RBLs.
9294
* [Recorded Future Enrich](https://misp.github.io/misp-modules/expansion/#recorded-future-enrich) - Module to enrich attributes with threat intelligence from Recorded Future.
9395
* [Reverse DNS](https://misp.github.io/misp-modules/expansion/#reverse-dns) - Simple Reverse DNS expansion service to resolve reverse DNS from MISP attributes.
@@ -145,6 +147,7 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj
145147
* [YARA Rule Export](https://misp.github.io/misp-modules/export_mod/#yara-rule-export) - This module is used to export MISP events to YARA.
146148

147149
### Import Modules
150+
* [ANYRUN Sandbox Import](https://misp.github.io/misp-modules/import_mod/#anyrun-sandbox-import) - A module designed to retrieve an analysis report from the ANY.RUN Sandbox by its unique ID and extract results (such as verdict, malware tags, and IOCs), converting them into MISP attributes within your event.
148151
* [PDNS COF Importer](https://misp.github.io/misp-modules/import_mod/#pdns-cof-importer) - Passive DNS Common Output Format (COF) MISP importer
149152
* [CSV Import](https://misp.github.io/misp-modules/import_mod/#csv-import) - Module to import MISP attributes from a csv file.
150153
* [Cuckoo Sandbox Import](https://misp.github.io/misp-modules/import_mod/#cuckoo-sandbox-import) - Module to import Cuckoo JSON.
@@ -165,6 +168,7 @@ For more information: [Extending MISP with Python modules](https://www.misp-proj
165168

166169
### Action Modules
167170
* [Mattermost](https://misp.github.io/misp-modules/action_mod/#mattermost) - Simplistic module to send message to a Mattermost channel.
171+
* [Nextcloud talk](https://misp.github.io/misp-modules/action_mod/#nextcloud-talk) - Simplistic module to send a message to a Nextcloud talk conversation.
168172
* [Slack](https://misp.github.io/misp-modules/action_mod/#slack) - Simplistic module to send messages to a Slack channel.
169173
* [Test action](https://misp.github.io/misp-modules/action_mod/#test-action) - This module is merely a test, always returning true. Triggers on event publishing.
170174

0 commit comments

Comments
 (0)