-
Notifications
You must be signed in to change notification settings - Fork 515
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11955 from Security-Onion-Solutions/fix/sublime_a…
…nalyzer_documentation Sublime Analyzer Documentation
- Loading branch information
Showing
2 changed files
with
40 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Sublime | ||
|
||
## Description | ||
Submit a base64-encoded EML file to Sublime Platform for analysis. | ||
|
||
## Configuration Requirements | ||
In SOC, navigate to `Administration`, toggle `Show all configurable settings, including advanced settings.`, and navigate to `sensoroni` -> `analyzers` -> `sublime_platform`. | ||
|
||
![image](https://github.com/Security-Onion-Solutions/securityonion/assets/16829864/a914f59d-c09f-40b6-ae8b-d644df236b81) | ||
|
||
|
||
The following configuration options are available for: | ||
|
||
``api_key`` - API key used for communication with the Sublime Platform API (Required) | ||
|
||
``base_url`` - URL used for communication with Sublime Platform. If no value is supplied, the default of `https://api.platform.sublimesecurity.com` will be used. | ||
|
||
The following options relate to [Live Flow](https://docs.sublimesecurity.com/reference/analyzerawmessageliveflow-1) analysis only: | ||
|
||
``live_flow`` - Determines if live flow analysis should be used. Defaults to `False`. | ||
|
||
``mailbox_email_address`` - The mailbox address to use for during live flow analysis. (Required for live flow analysis) | ||
|
||
``message_source_id`` - The ID of the message source to use during live flow analysis. (Required for live flow analysis) |