|
| 1 | +--- |
| 2 | +id: zerofox-intel-source |
| 3 | +title: ZeroFox Threat Intel Source |
| 4 | +sidebar_label: ZeroFox Threat Intel |
| 5 | +tags: |
| 6 | + - cloud-to-cloud |
| 7 | + - zerofox-threat-intel |
| 8 | +description: This integration collects threat indicators using the ZeroFox API and sends them to Sumo Logic for analysis. |
| 9 | +--- |
| 10 | +import CodeBlock from '@theme/CodeBlock'; |
| 11 | +import ExampleJSON from '/files/c2c/zerofox/example.json'; |
| 12 | +import MyComponentSource from '!!raw-loader!/files/c2c/zerofox/example.json'; |
| 13 | +import TerraformExample from '!!raw-loader!/files/c2c/zerofox/example.tf'; |
| 14 | +import useBaseUrl from '@docusaurus/useBaseUrl'; |
| 15 | + |
| 16 | +<head> |
| 17 | + <meta name="robots" content="noindex" /> |
| 18 | +</head> |
| 19 | + |
| 20 | +<p><a href="/docs/beta"><span className="beta">Beta</span></a></p> |
| 21 | + |
| 22 | +<img src={useBaseUrl('img/integrations/security-threat-detection/ZeroFox_logo.png')} alt="ZeroFox-threat-intel.png" width="50" /> |
| 23 | + |
| 24 | +ZeroFox is a cybersecurity firm specializing in providing cyber threat intelligence services. |
| 25 | + |
| 26 | +The ZeroFox source collects threat indicators using the [ZeroFox CTI API](https://api.zerofox.com/cti/docs/) and sends them to Sumo Logic as normalized threat indicators for analysis. |
| 27 | + |
| 28 | +## Data collected |
| 29 | + |
| 30 | +| Polling Interval | API Endpoint | |
| 31 | +|:-----------------|:------------------| |
| 32 | +| 1 hour | `/cti/botnet` | |
| 33 | +| 1 hour | `/cti/c2-domains` | |
| 34 | +| 1 hour | `/cti/disruption` | |
| 35 | +| 1 hour | `/cti/malware` | |
| 36 | +| 1 hour | `/cti/phishing` | |
| 37 | +| 1 hour | `/cti/ransomware` | |
| 38 | + |
| 39 | +## Setup |
| 40 | + |
| 41 | +### Vendor configuration |
| 42 | + |
| 43 | +The ZeroFox Threat Intel source requires you to provide your ZeroFox account username and password. |
| 44 | + |
| 45 | +### Source configuration |
| 46 | + |
| 47 | +When you create an ZeroFox Threat Intel source, you add it to a Hosted Collector. Before creating the source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see [Configure a Hosted Collector and Source](/docs/send-data/hosted-collectors/configure-hosted-collector). |
| 48 | + |
| 49 | +To configure an ZeroFox Threat Intel source: |
| 50 | + |
| 51 | +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Collection**. You can also click the **Go To...** menu at the top of the screen and select **Collection**. |
| 52 | +1. On the Collectors page, click **Add Source** next to a Hosted Collector. |
| 53 | +1. Search for and select **ZeroFox Threat Intel**. |
| 54 | +1. Enter a **Name** to display for the Source in the Sumo web application. The description is optional. |
| 55 | +1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called `_sourceCategory`. |
| 56 | +1. (Optional) **Fields.** Click the **+Add Field** link to define the fields you want to associate, each field needs a name (key) and value. |
| 57 | + *  A green circle with a check mark is shown when the field exists in the Fields table schema. |
| 58 | + *  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema it is ignored, known as dropped. |
| 59 | +1. **Username**. Enter your ZeroFox username. |
| 60 | +1. **Password**. Enter your Zerofox password. |
| 61 | +1. **Sumo Logic Threat Intel Source ID**. Enter the Sumo Logic namespace where the indicators will be stored. |
| 62 | +1. **Polling Interval**. The polling interval is set for one hour by default. You can adjust it based on your needs. This sets how often the source checks for new data. |
| 63 | +1. **Processing Rules for Logs**. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in [Create a Processing Rule](/docs/send-data/collection/processing-rules/create-processing-rule). |
| 64 | +1. When you are finished configuring the source, click **Save**. |
| 65 | + |
| 66 | +## JSON schema |
| 67 | + |
| 68 | +Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See [Use JSON to Configure Sources](/docs/send-data/use-json-configure-sources) for details. |
| 69 | + |
| 70 | +| Parameter | Type | Value | Required | Description | |
| 71 | +|:-----------|:------------|:----------------------------------------------|:---------|:---------------------------------| |
| 72 | +| schemaRef | JSON Object | `{“type”: “ZeroFox Threat Intel”}` | Yes | Define the specific schema type. | |
| 73 | +| sourceType | String | `"Universal"` | Yes | Type of source. | |
| 74 | +| config | JSON Object | [Configuration object](#configuration-object) | Yes | Source type specific values. | |
| 75 | + |
| 76 | +### Configuration Object |
| 77 | + |
| 78 | +| Parameter | Type | Required | Default | Description | Example | |
| 79 | +|:----------|:-------|:---------|:--------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------| |
| 80 | +| name | String | Yes | `null` | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_source`. | `"mySource"` | |
| 81 | +| description | String | No | `null` | Type a description of the source. | `"Testing source"` |
| 82 | +| category | String | No | `null` | Type a category of the source. This value is assigned to the [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) field `_sourceCategory`. See [best practices](/docs/send-data/best-practices) for details. | `"mySource/test"` |
| 83 | +| fields | JSON Object | No | `null` | JSON map of key-value fields (metadata) to apply to the Collector or source. Use the boolean field `_siemForward` to enable forwarding to SIEM.|`{"_siemForward": false, "fieldA": "valueA"}` | |
| 84 | +| username | String | Yes | `null` | ZeroFox username. | | |
| 85 | +| password | String | Yes | `null` | Zerofox password. | | |
| 86 | +| userSourceId | String | Yes | `null` | The Sumo Logic namespace in which the indicators will be stored. | | |
| 87 | +| pollingIntervalHour | integer | Yes | `1 hour` | Time interval (in hours) after which the source will check for new data. | | |
| 88 | + |
| 89 | +### JSON example |
| 90 | + |
| 91 | +<CodeBlock language="json">{MyComponentSource}</CodeBlock> |
| 92 | + |
| 93 | +<a href="/files/c2c/zerofox/example.json" target="_blank">Download example</a> |
| 94 | + |
| 95 | +### Terraform example |
| 96 | + |
| 97 | +<CodeBlock language="json">{TerraformExample}</CodeBlock> |
| 98 | + |
| 99 | +<a href="/files/c2c/zerofox/example.tf" target="_blank">Download example</a> |
| 100 | + |
| 101 | +## FAQ |
| 102 | + |
| 103 | +:::info |
| 104 | +Click [here](/docs/c2c/info) for more information about Cloud-to-Cloud sources. |
| 105 | +::: |
0 commit comments