Skip to content

Commit 44c475c

Browse files
Michalsusmlodic
andauthored
Modified documentation of IntelOwl to include NERD observable analyzer (#6)
Co-authored-by: Matteo Lodi <[email protected]>
1 parent 221edde commit 44c475c

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/IntelOwl/advanced_usage.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,13 @@ Some analyzers could require a special configuration:
241241
- The `repositories` values is what will be used to actually run the analysis: if you have added private repositories, remember to add the url in `repositories` too!
242242
- You can add local rules inside the directory at `/opt/deploy/files_required/yara/YOUR_USERNAME/custom_rules/`. Please remember that these rules are not synced in a cluster deploy: for this reason is advised to upload them on GitHub and use the `repositories` or `private_repositories` attributes.
243243

244+
- `NERD` :
245+
- The `nerd_analysis` parameter allows you to customize the level of detail in the analysis response. Available options are:
246+
- `basic` (default): Provides a simplified response from the database.
247+
- `full`: Includes all available information about the IP from the database.
248+
- `fmp`: Returns only the FMP (Future Misbehavior Probability) score.
249+
- `rep`: Returns only the reputation score of the IP.
250+
244251
## Notifications
245252

246253
Since v4, IntelOwl integrated the notification system from the `certego_saas` package, allowing the admins to create notification that every user will be able to see.

docs/IntelOwl/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ The following is the list of the available analyzers you can run out-of-the-box.
209209
- `Mnemonic_PassiveDNS` : Look up a domain or IP using the [Mnemonic PassiveDNS public API](https://docs.mnemonic.no/display/public/API/Passive+DNS+Overview).
210210
- `MWDB_Get`: [mwdblib](https://mwdb.readthedocs.io/en/latest/) Retrieve malware file analysis by hash from repository maintained by CERT Polska MWDB.
211211
- `Netlas`: search an IP against [Netlas](https://netlas.io/api)
212-
- `NERD_analyzer`: scan an IP address against [NERD](https://nerd.cesnet.cz/) database
212+
- `NERD_analyzer`: search an IP against NERD reputation database [NERD](https://nerd.cesnet.cz/)
213213
- `ONYPHE`: search an observable in [ONYPHE](https://www.onyphe.io/)
214214
- `OpenCTI`: scan an observable on an [OpenCTI](https://github.com/OpenCTI-Platform/opencti) instance
215215
- `OTXQuery`: scan an observable on [Alienvault OTX](https://otx.alienvault.com/)

0 commit comments

Comments
 (0)