Pipeline: Release 4.5.0.stable1 documentation

CybercentreCanada · Feb 19, 2024 · d411bb7 · d411bb7
1 parent 7739828
commit d411bb7
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 1 deletion.
diff --git a/docs/odm/models/config.md b/docs/odm/models/config.md
@@ -115,6 +115,7 @@
 | classification_mappings | Any | Classification mapping | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | email_field | Keyword | Name of the field containing the email address | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `mail` |
 | group_lookup_query | Keyword | How the group lookup is queried | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `(&(objectClass=Group)(member=%s))` |
+| group_lookup_with_uid | Boolean | Use username/uid instead of dn for group lookup | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | image_field | Keyword | Name of the field containing the user's avatar | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `jpegPhoto` |
 | image_format | Keyword | Type of image used to store the avatar | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `jpeg` |
 | name_field | Keyword | Name of the field containing the user's name | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `cn` |
@@ -760,9 +761,10 @@
 | detailed_report | [AIQueryParams](/assemblyline4_docs/odm/models/config/#aiqueryparams) | Parameters used for detailed reports | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | executive_summary | [AIQueryParams](/assemblyline4_docs/odm/models/config/#aiqueryparams) | Parameters used for executive summaries | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | enabled | Boolean | Is AI support enabled? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
-| headers | Mapping [String, Keyword] | Headers used by the url_download method | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+| headers | Mapping [String, Keyword] | Headers used by the _call_ai_backend method | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | model_name | Keyword | Name of the model to be used for the AI analysis. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `gpt-3.5-turbo` |
 | verify | Boolean | Should the SSL connection to the AI API be verified. | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `True` |
+| proxies | Mapping [String, Keyword] | Proxies used by the _call_ai_backend method | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 
 
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)

diff --git a/docs/odm/models/replay.md b/docs/odm/models/replay.md
@@ -16,7 +16,10 @@
 | :--- | :--- | :--- | :--- | :--- |
 | client | [Client](/assemblyline4_docs/odm/models/replay/#client) | None | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [Client](/assemblyline4_docs/odm/models/replay/#client) for more details. |
 | alert_input | [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) | None | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) for more details. |
+| badlist_input | [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) | None | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) for more details. |
+| safelist_input | [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) | None | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) for more details. |
 | submission_input | [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) | None | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) for more details. |
+| workflow_input | [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) | None | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | See [InputModule](/assemblyline4_docs/odm/models/replay/#inputmodule) for more details. |
 | lookback_time | Keyword | None | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `*` |
 | output_filestore | Keyword | None | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `file:///tmp/replay/output` |
 | working_directory | Keyword | None | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `/tmp/replay/work` |

diff --git a/docs/odm/models/tagging.md b/docs/odm/models/tagging.md
@@ -398,6 +398,7 @@
 | Field | Type | Description | Required | Default |
 | :--- | :--- | :--- | :--- | :--- |
 | api_vector | List [Keyword] | API Vector | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+| authenticode | [FilePEAuthenticode](/assemblyline4_docs/odm/models/tagging/#filepeauthenticode) | PE Authenticode Information | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | debug | [FilePEDebug](/assemblyline4_docs/odm/models/tagging/#filepedebug) | PE Debug Information | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | exports | [FilePEExports](/assemblyline4_docs/odm/models/tagging/#filepeexports) | PE Exports Information | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | imports | [FilePEImports](/assemblyline4_docs/odm/models/tagging/#filepeimports) | PE Imports Information | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
@@ -410,6 +411,24 @@
 | versions | [FilePEVersions](/assemblyline4_docs/odm/models/tagging/#filepeversions) | PE Versions Information | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 
 
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+#### FilePEAuthenticode
+> PE Authenticode Model
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| spc_sp_opus_info | [FilePEAuthenticodeSpcSpOpusInfo](/assemblyline4_docs/odm/models/tagging/#filepeauthenticodespcspopusinfo) | AAA | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+
+
+[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
+##### FilePEAuthenticodeSpcSpOpusInfo
+> PE SpcSpOpusInfo Attribute Model
+
+| Field | Type | Description | Required | Default |
+| :--- | :--- | :--- | :--- | :--- |
+| program_name | List [Keyword] | Program Name | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
+
+
 [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!)
 #### FilePEDebug
 > PE Debug Model

diff --git a/docs/odm/models/user_settings.md b/docs/odm/models/user_settings.md
@@ -10,6 +10,7 @@
 | download_encoding | Enum | Default download encoding when downloading files<br>Values:<br>`"cart", "raw", "zip"` | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `cart` |
 | default_external_sources | List [Keyword] | List of sha256 sources to check by default | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |
 | default_zip_password | Text | Default user-defined password for creating password protected ZIPs when downloading files | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `zippy` |
+| executive_summary | Boolean | Should executive summary sections be shown? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `True` |
 | expand_min_score | Integer | Auto-expand section when score bigger then this | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `500` |
 | generate_alert | Boolean | Generate an alert? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |
 | ignore_cache | Boolean | Ignore service caching? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `False` |

diff --git a/docs/odm/models/workflow.md b/docs/odm/models/workflow.md
@@ -8,6 +8,7 @@
 | creation_date | Date | Creation date of the workflow | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `NOW` |
 | creator | Keyword | UID of the creator of the workflow | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
 | edited_by | Keyword | UID of the last user to edit the workflow | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `None` |
+| enabled | Boolean | Is this workflow enabled? | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `True` |
 | first_seen | Date | Date of first hit on workflow | <div style="width:100px">:material-minus-box-outline: Optional</div> | `None` |
 | hit_count | Integer | Number of times there was a workflow hit | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `0` |
 | labels | List [Keyword] | Labels applied by the workflow | <div style="width:100px">:material-checkbox-marked-outline: Yes</div> | `[]` |