From 03f9cf0199fc75fa9d2ce26c9a43290d2337bf4b Mon Sep 17 00:00:00 2001 From: Azure Pipeline Date: Mon, 27 May 2024 19:48:29 +0000 Subject: [PATCH] Pipeline: Release 4.5.0.stable27 documentation --- docs/odm/models/config.md | 203 +++++++++++++++++++++++++++++++++++++- 1 file changed, 201 insertions(+), 2 deletions(-) diff --git a/docs/odm/models/config.md b/docs/odm/models/config.md index 687470fd6..544235572 100644 --- a/docs/odm/models/config.md +++ b/docs/odm/models/config.md @@ -30,6 +30,7 @@ | internal | [Internal](/assemblyline4_docs/odm/models/config/#internal) | Internal authentication settings |
:material-checkbox-marked-outline: Yes
| See [Internal](/assemblyline4_docs/odm/models/config/#internal) for more details. | | ldap | [LDAP](/assemblyline4_docs/odm/models/config/#ldap) | LDAP settings |
:material-checkbox-marked-outline: Yes
| See [LDAP](/assemblyline4_docs/odm/models/config/#ldap) for more details. | | oauth | [OAuth](/assemblyline4_docs/odm/models/config/#oauth) | OAuth settings |
:material-checkbox-marked-outline: Yes
| See [OAuth](/assemblyline4_docs/odm/models/config/#oauth) for more details. | +| saml | [SAML](/assemblyline4_docs/odm/models/config/#saml) | SAML settings |
:material-checkbox-marked-outline: Yes
| See [SAML](/assemblyline4_docs/odm/models/config/#saml) for more details. | [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) @@ -214,6 +215,178 @@ | value | List [Keyword] | Assigned property value |
:material-checkbox-marked-outline: Yes
| `[]` | +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +### SAML +> SAML Configuration + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| enabled | Boolean | Enable use of SAML? |
:material-checkbox-marked-outline: Yes
| `False` | +| auto_create | Boolean | Auto-create users if they are missing |
:material-checkbox-marked-outline: Yes
| `True` | +| auto_sync | Boolean | Should we automatically sync with SAML server on each login? |
:material-checkbox-marked-outline: Yes
| `True` | +| lowercase_urlencoding | Boolean | Enable lowercase encoding if using ADFS as IdP |
:material-checkbox-marked-outline: Yes
| `False` | +| attributes | [SAMLAttributes](/assemblyline4_docs/odm/models/config/#samlattributes) | SAML attributes |
:material-checkbox-marked-outline: Yes
| See [SAMLAttributes](/assemblyline4_docs/odm/models/config/#samlattributes) for more details. | +| settings | [SAMLSettings](/assemblyline4_docs/odm/models/config/#samlsettings) | SAML settings method |
:material-checkbox-marked-outline: Yes
| See [SAMLSettings](/assemblyline4_docs/odm/models/config/#samlsettings) for more details. | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +#### SAMLAttributes +> SAML Attributes + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| username_attribute | Keyword | SAML attribute name for AL username |
:material-minus-box-outline: Optional
| `uid` | +| email_attribute | Keyword | SAML attribute name for a user's email address |
:material-checkbox-marked-outline: Yes
| `email` | +| fullname_attribute | Keyword | SAML attribute name for a user's first name |
:material-checkbox-marked-outline: Yes
| `name` | +| groups_attribute | Keyword | SAML attribute name for the groups |
:material-checkbox-marked-outline: Yes
| `groups` | +| roles_attribute | Keyword | SAML attribute name for the roles |
:material-checkbox-marked-outline: Yes
| `roles` | +| group_type_mapping | Mapping [String, Keyword] | SAML group to role mapping |
:material-checkbox-marked-outline: Yes
| `{}` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +#### SAMLSettings +> SAML Settings + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| strict | Boolean | Should we be strict in our SAML checks? |
:material-checkbox-marked-outline: Yes
| `False` | +| debug | Boolean | Should we be in debug mode? |
:material-checkbox-marked-outline: Yes
| `False` | +| sp | [SAMLServiceProvider](/assemblyline4_docs/odm/models/config/#samlserviceprovider) | SP settings |
:material-checkbox-marked-outline: Yes
| `None` | +| idp | [SAMLIdentityProvider](/assemblyline4_docs/odm/models/config/#samlidentityprovider) | IDP settings |
:material-checkbox-marked-outline: Yes
| `None` | +| security | [SAMLSecurity](/assemblyline4_docs/odm/models/config/#samlsecurity) | Security settings |
:material-minus-box-outline: Optional
| `None` | +| contact_person | [SAMLContacts](/assemblyline4_docs/odm/models/config/#samlcontacts) | Contact settings |
:material-minus-box-outline: Optional
| `None` | +| organization | Mapping [String, [SAMLOrganization](/assemblyline4_docs/odm/models/config/#samlorganization)] | Organization settings |
:material-minus-box-outline: Optional
| `None` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +##### SAMLContacts +> SAML Contacts + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| technical | [SAMLContactPerson](/assemblyline4_docs/odm/models/config/#samlcontactperson) | Technical Contact |
:material-checkbox-marked-outline: Yes
| `None` | +| support | [SAMLContactPerson](/assemblyline4_docs/odm/models/config/#samlcontactperson) | Support Contact |
:material-checkbox-marked-outline: Yes
| `None` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +###### SAMLContactPerson +> SAML Contact Entry + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| given_name | Keyword | Given Name |
:material-checkbox-marked-outline: Yes
| `None` | +| email_address | Keyword | Email Address |
:material-checkbox-marked-outline: Yes
| `None` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +##### SAMLIdentityProvider +> SAML Identity Provider + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| entity_id | Keyword | Entity ID |
:material-checkbox-marked-outline: Yes
| `None` | +| single_sign_on_service | [SAMLSingleSignOnService](/assemblyline4_docs/odm/models/config/#samlsinglesignonservice) | Single Sign On Service |
:material-checkbox-marked-outline: Yes
| `None` | +| x509cert | Keyword | X509 Certificate |
:material-minus-box-outline: Optional
| `None` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +###### SAMLSingleSignOnService +> SAML Single Sign On Service + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| url | Keyword | URL |
:material-checkbox-marked-outline: Yes
| `None` | +| binding | Keyword | Binding |
:material-checkbox-marked-outline: Yes
| `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +##### SAMLOrganization +> SAML Organization + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| name | Keyword | Name |
:material-checkbox-marked-outline: Yes
| `None` | +| display_name | Keyword | Display Name |
:material-checkbox-marked-outline: Yes
| `None` | +| url | Keyword | URL |
:material-checkbox-marked-outline: Yes
| `None` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +##### SAMLSecurity +> SAML Security + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| name_id_encrypted | Boolean | Name ID Encrypted |
:material-minus-box-outline: Optional
| `None` | +| authn_requests_signed | Boolean | Authn Requests Signed |
:material-minus-box-outline: Optional
| `None` | +| logout_request_signed | Boolean | Logout Request Signed |
:material-minus-box-outline: Optional
| `None` | +| logout_response_signed | Boolean | Logout Response Signed |
:material-minus-box-outline: Optional
| `None` | +| sign_metadata | Boolean | Sign Metadata |
:material-minus-box-outline: Optional
| `None` | +| want_messages_signed | Boolean | Want Messages Signed |
:material-minus-box-outline: Optional
| `None` | +| want_assertions_signed | Boolean | Want Assertions Signed |
:material-minus-box-outline: Optional
| `None` | +| want_assertions_encrypted | Boolean | Want Assertions Encrypted |
:material-minus-box-outline: Optional
| `None` | +| want_name_id | Boolean | Want Name ID |
:material-minus-box-outline: Optional
| `None` | +| want_name_id_encrypted | Boolean | Want Name ID Encrypted |
:material-minus-box-outline: Optional
| `None` | +| want_attribute_statement | Boolean | Want Attribute Statement |
:material-minus-box-outline: Optional
| `None` | +| requested_authn_context | Boolean | Requested Authn Context |
:material-minus-box-outline: Optional
| `None` | +| requested_authn_context_comparison | Keyword | Requested Authn Context Comparison |
:material-minus-box-outline: Optional
| `None` | +| fail_on_authn_context_mismatch | Boolean | Fail On Authn Context Mismatch |
:material-minus-box-outline: Optional
| `None` | +| metadata_valid_until | Keyword | Metadata Valid Until |
:material-minus-box-outline: Optional
| `None` | +| metadata_cache_duration | Keyword | Metadata Cache Duration |
:material-minus-box-outline: Optional
| `None` | +| allow_single_label_domains | Boolean | Allow Single Label Domains |
:material-minus-box-outline: Optional
| `None` | +| signature_algorithm | Keyword | Signature Algorithm |
:material-minus-box-outline: Optional
| `None` | +| digest_algorithm | Keyword | Digest Algorithm |
:material-minus-box-outline: Optional
| `None` | +| allow_repeat_attribute_name | Boolean | Allow Repeat Attribute Name |
:material-minus-box-outline: Optional
| `None` | +| reject_deprecated_algorithm | Boolean | Reject Deprecated Algorithm |
:material-minus-box-outline: Optional
| `None` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +##### SAMLServiceProvider +> SAML Service Provider + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| entity_id | Keyword | Entity ID |
:material-checkbox-marked-outline: Yes
| `None` | +| assertion_consumer_service | [SAMLAssertionConsumerService](/assemblyline4_docs/odm/models/config/#samlassertionconsumerservice) | Assertion Consumer Service |
:material-checkbox-marked-outline: Yes
| `None` | +| attribute_consuming_service | [SAMLAttributeConsumingService](/assemblyline4_docs/odm/models/config/#samlattributeconsumingservice) | Attribute Consuming Service |
:material-minus-box-outline: Optional
| `None` | +| name_id_format | Keyword | Name ID Format |
:material-checkbox-marked-outline: Yes
| `urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified` | +| x509cert | Keyword | X509 Certificate |
:material-minus-box-outline: Optional
| `None` | +| private_key | Keyword | Private Key |
:material-minus-box-outline: Optional
| `None` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +###### SAMLAssertionConsumerService +> SAML Assertion Consumer Service + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| url | Keyword | URL |
:material-checkbox-marked-outline: Yes
| `None` | +| binding | Keyword | Binding |
:material-checkbox-marked-outline: Yes
| `urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +###### SAMLAttributeConsumingService +> SAML Attribute Consuming Service + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| service_name | Keyword | Service Name |
:material-checkbox-marked-outline: Yes
| `None` | +| service_description | Keyword | Service Description |
:material-checkbox-marked-outline: Yes
| `None` | +| requested_attributes | List [[SAMLRequestedAttribute](/assemblyline4_docs/odm/models/config/#samlrequestedattribute)] | Requested Attributes |
:material-checkbox-marked-outline: Yes
| `[]` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +####### SAMLRequestedAttribute +> SAML Attribute + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| name | Keyword | Name |
:material-checkbox-marked-outline: Yes
| `None` | +| is_required | Boolean | Is required? |
:material-checkbox-marked-outline: Yes
| `False` | +| name_format | Keyword | Name Format |
:material-checkbox-marked-outline: Yes
| `urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified` | +| friendly_name | Keyword | Friendly Name |
:material-checkbox-marked-outline: Yes
| `` | +| attribute_value | List [Keyword] | Attribute Value |
:material-checkbox-marked-outline: Yes
| `[]` | + + [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) ## Core > Core Component Configuration @@ -257,10 +430,10 @@ | Field | Type | Description | Required | Default | | :--- | :--- | :--- | :--- | :--- | | alternate_dtl | Integer | Alternate number of days to keep the data in the malware archive. (0: Disabled, will keep data forever) |
:material-checkbox-marked-outline: Yes
| `0` | -| metadata | Mapping [String, [ArchiverMetadata](/assemblyline4_docs/odm/models/config/#archivermetadata)] | Proxy configuration that is passed to Python Requests |
:material-checkbox-marked-outline: Yes
| `None` | +| metadata | Mapping [String, [ArchiverMetadata](/assemblyline4_docs/odm/models/config/#archivermetadata)] | Proxy configuration that is passed to Python Requests
:material-alert-outline: The configuration for the archive metadata validation and requirements has moved to`submission.metadata.archive`. |
:material-checkbox-marked-outline: Yes
| `None` | | minimum_required_services | List [Keyword] | List of minimum required service before archiving takes place |
:material-checkbox-marked-outline: Yes
| `[]` | | webhook | [Webhook](/assemblyline4_docs/odm/models/config/#webhook) | Webhook to call before triggering the archiving process |
:material-minus-box-outline: Optional
| `None` | -| use_metadata | Boolean | Should the UI ask form metadata to be filed out when archiving |
:material-checkbox-marked-outline: Yes
| `False` | +| use_metadata | Boolean | Should the UI ask form metadata to be filed out when archiving
:material-alert-outline: This field is no longer required... |
:material-checkbox-marked-outline: Yes
| `False` | | use_webhook | Boolean | None |
:material-minus-box-outline: Optional
| `False` | @@ -695,6 +868,7 @@ | max_file_size | Integer | Maximum size for files submitted in the system |
:material-checkbox-marked-outline: Yes
| `104857600` | | max_metadata_length | Integer | Maximum length for each metadata values |
:material-checkbox-marked-outline: Yes
| `4096` | | max_temp_data_length | Integer | Maximum length for each temporary data values |
:material-checkbox-marked-outline: Yes
| `4096` | +| metadata | [MetadataConfig](/assemblyline4_docs/odm/models/config/#metadataconfig) | Metadata compliance rules |
:material-checkbox-marked-outline: Yes
| See [MetadataConfig](/assemblyline4_docs/odm/models/config/#metadataconfig) for more details. | | sha256_sources | List [[Sha256Source](/assemblyline4_docs/odm/models/config/#sha256source)] | List of external source to fetch file via their SHA256 hashes
:material-alert-outline: Use submission.file_sources which is an extension of this configuration |
:material-checkbox-marked-outline: Yes
| `[]` | | file_sources | List [[FileSource](/assemblyline4_docs/odm/models/config/#filesource)] | List of external source to fetch file |
:material-checkbox-marked-outline: Yes
| `[]` | | tag_types | [TagTypes](/assemblyline4_docs/odm/models/config/#tagtypes) | Tag types that show up in the submission summary |
:material-checkbox-marked-outline: Yes
| See [TagTypes](/assemblyline4_docs/odm/models/config/#tagtypes) for more details. | @@ -708,6 +882,7 @@ | Field | Type | Description | Required | Default | | :--- | :--- | :--- | :--- | :--- | | name | Keyword | Name of the sha256 source |
:material-checkbox-marked-outline: Yes
| `None` | +| auto_select | Boolean | Should we force the source to be auto-selected for the user ? |
:material-checkbox-marked-outline: Yes
| `False` | | hash_types | List [Keyword] | Method(s) of fetching file from source by string input(ie. ['sha256', 'sha1', 'md5', 'tlsh', 'ssdeep']). This also supports custom types. |
:material-checkbox-marked-outline: Yes
| `['sha256']` | | hash_patterns | Mapping [String, Text] | Custom types to regex pattern definition for input detection/validation |
:material-minus-box-outline: Optional
| `None` | | classification | ClassificationString | None |
:material-minus-box-outline: Optional
| `None` | @@ -721,6 +896,30 @@ | verify | Boolean | Should the download function Verify SSL connections? |
:material-checkbox-marked-outline: Yes
| `True` | +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +### MetadataConfig +> Configuration for metadata compliance with APIs + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| archive | Mapping [String, [Metadata](/assemblyline4_docs/odm/models/config/#metadata)] | Metadata specification for archiving |
:material-checkbox-marked-outline: Yes
| `None` | +| submit | Mapping [String, [Metadata](/assemblyline4_docs/odm/models/config/#metadata)] | Metadata specification for submission |
:material-checkbox-marked-outline: Yes
| `None` | +| ingest | Mapping [String, Mapping [String, [Metadata](/assemblyline4_docs/odm/models/config/#metadata)]] | Metadata specification for certain ingestion based on ingest_type |
:material-checkbox-marked-outline: Yes
| `None` | + + +[comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) +#### Metadata +> Metadata configuration + +| Field | Type | Description | Required | Default | +| :--- | :--- | :--- | :--- | :--- | +| validator_type | Enum | Type of validation to apply to metadata value
Values:
`"boolean", "date", "domain", "email", "enum", "integer", "ip", "keyword", "regex", "text", "uri"` |
:material-checkbox-marked-outline: Yes
| `str` | +| validator_params | Mapping [String, Any] | Configuration parameters to apply to validator |
:material-checkbox-marked-outline: Yes
| `{}` | +| suggestions | List [Keyword] | List of suggestions for this field |
:material-checkbox-marked-outline: Yes
| `[]` | +| default | Keyword | None |
:material-minus-box-outline: Optional
| `None` | +| required | Boolean | Is this field required? |
:material-checkbox-marked-outline: Yes
| `False` | + + [comment]: # (AUTOGENERATED MARKDOWN CONTENT. UPDATES TO ODM DOCUMENTATION SHOULD BE DONE THROUGH ASSEMBLYLINE-BASE REPO!) ### Sha256Source > A source entry for the sha256 downloader