Devo Query

LAST UPDATED: OCT 31, 2024

Overview

Devo SIEM is a cloud-based data logging and security analytics platform designed to improve access to security data across an enterprise. Security teams have access to real-time and historical data to quickly respond to their organization’s threat landscape. This integration allows organizations to query and manage alerts as well as other data sources.

Devo Query is available for use in:

With the Devo Query integration, D3 SOAR can:

• Automatically ingest events from Devo’s alert tables after configuring scheduled jobs in the Fetch Event command.

• Normalize event log data from Devo after configuring field extraction mapping for better visibility of ingested Devo alerts on D3’s Investigation Dashboard.

• Automatically perform initial enrichment, data cleansing, and correlation on ingested Devo alerts to determine whether they are potential threats with the default Event Playbook. Events marked as threats will be further processed as incidents in an Incident Playbook.

• Execute the Run Query command to gain contextual information for dynamic incident investigations with the ad-hoc command feature. The Run Query command can also be used as automated Incident Playbook tasks.

Connection

To connect to Devo Query from D3 SOAR, please follow this part to collect the required information below:

Permission Requirements

Each endpoint in the Devo Query API requires a certain permission scope. The following are required scopes for each command in this integration:

Configuring Devo Query to Work with D3 SOAR

1. Log in to the Devo Data Analytics Platform with your credentials.

   

READER NOTE

To use a domain API key and API secret to sign the API request, your account must have Admin privileges.

Devo’s login site URL is different depending on your geographic location:

• In North America, use https://us.devo.com/login

• In Europe, use https://eu.devo.com/login

• In Spain, use https://es.devo.com/login

2. Click the Administration tab on the left sidebar menu to expand the submenu, then click Credentials.

   

3. Under the Access Keys tab, click Show to display the API Key and API Secret for the user you will use for the integration connection.

   

4. Copy and save API Key and API Secret for D3 SOAR connection in later steps.

   

Configuring D3 SOAR to Work with Devo Query

1. Log in to D3 SOAR.

2. Find the Devo Query integration.

   

   1. Navigate to Configuration on the top header menu.

   2. Click on the Integration icon on the left sidebar.

   3. Type Devo Query in the search box to find the integration, then click it to select it.

   4. Click + Connection, on the right side of the Connections section. A new connection window will appear.

3. Configure the following fields to create a connection to Devo Query.

   

   1. Connection Name: The desired name for the connection.

   2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.

   3. Recipient site for events from connections Shared to Internal Sites: This field appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.

   4. Agent Name (Optional): Specifies the proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.

   5. Description (Optional): Add your desired description for the connection.

   6. Tenant (Optional): When configuring the connection from a master tenant site, you have the option to choose the specific tenant sites you want to share the connection with. Once you enable this setting, you can filter and select the desired tenant sites from the dropdowns to share the connection.

      

   7. Configure User Permissions: Defines which users have access to the connection.

   8. Active: Check the tick box to ensure the connection is available for use.

      

   9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
      1. Input your domain level Server URL. The default value is https://apiv2-us.devo.com.
      2. Input the API Key. Refer to step 4 of Configuring Devo Query to Work with D3 SOAR.
      3. Input the API Secret. Refer to step 4 of Configuring Devo Query to Work with D3 SOAR.
      Note: The default server URL is set to https://apiv2-us.devo.com. Input the server URL based on your Devo domain’s geographic region:

      • USA: https://apiv2-us.devo.com

      • EU: https://apiv2-eu.devo.com

      • GCP (Spain): https://apiv2-es.devo.com

   10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.

   11. Connection Health Check: Updates the connection status you have created. A connection health check is done by scheduling the Test Connection command of this integration. This can only be done when the connection is active.
       To set up a connection health check, check the Connection Health Check tickbox. You can customize the interval (minutes) for scheduling the health check. An email notification can be set up after a specified number of failed connection attempts.

4. Test the connection.

   1. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.

   2. Click OK to close the alert window.

   3. Click + Add to create and add the configured connection.

Commands

Devo Query includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, you can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the Devo Query API, please refer to the Devo Query API reference.

READER NOTE

Certain permissions are required for each command. Please refer to the Permission Requirements and Configuring Devo Query to Work with D3 SOAR for details.

Integration Designed Query

Some commands require structured input arguments in Language Integrated Query (LINQ). LINQ syntax is similar to that of SQL. Refer to LINQ query examples from Devo’s documentation for detail.

To fit the LINQ query into D3 SOAR commands’ input arguments, you can omit some duplicated inputs. An example of an original LINQ query is as follows:

from siem.logtrust.alert.info

where priority >=1.0 and context = "my.alert.partner_domain.CrowdstrikeAlert"

select * limit 10

The corresponding inputs for integration commands in D3 are as follows:

Note for Time-related parameters

The input format of time-related parameters may vary based on your account settings. As a result, the sample data provided in our commands is different from what you see. To set your preferred time format, follow these steps:

1. Navigate to Configuration > Application Settings. Select Date/Time Format.

   

2. Choose your desired date and time format.

   

After that, you will be able to view your preferred time format when configuring the DateTime input parameters for commands.

Fetch Event

Returns events from Devo SIEM based on specified query criteria.

READER NOTE

If the input is 10 minutes later than the current time for the End Time parameter, the current time will be used. This prevents the command from idling until future events have taken place.

The number of events returned is limited by defining the search criteria. If not specified, all events within the specified time range of the query will be returned. It is recommended to limit the number of events returned because the command might timeout.

Input

Output

{
    "msg": "",
    "timestamp": 1644354691811,
    "cid": "***",
    "status": 0,
    "object": [
        {
            "eventdate": 1644348576728,
            "alertHost": "***",
            "domain": "***",
            "priority": 3,
            "context": "my.alert.***.***",
            "category": "my.context",
            "status": 0,
            "alertId": "***",
            "srcIp": null,
            "srcPort": null,
            "srcHost": "",
            "dstIp": null,
            "dstPort": null,
            "dstHost": "",
            "protocol": "",
            "username": "test@example.com",
            "application": "",
            "engine": "***",
            "extraData": "{\"SensorId\":\"***\",\"***\":\"false\",\"Tactic\":\"Exploit\",\"ParentProcessId\":\"***\",\"quarantined_file_id\":\"null\",\"UTCTimestamp\":\"null\",\"PatternDispositionFlags_ProcessBlocked\":\"false\",\"FalconHostLink\":\"https%3A%2F%2Ffalcon.crowdstrike.com%2Factivity%2Fdetections%2Fdetail%***%**%3F_cid%***\",\"GrandparentImageFileName\":\"\",\"PatternDispositionFlags_OperationBlocked\":\"true\",\"SHA1String\":\"0000000000000000000000000000000000000000\",\"ProcessEndTime\":\"0\",\"IOCValue\":\"null\",\"PatternDispositionFlags_QuarantineFile\":\"false\",\"jsonEvent\":\"%7B%22event%22%3A%7B%22PatternDispositionValue***\",\"ParentCommandLine\":\"\",\"offset\":\"***\",\"ScanResults_ResultName_str\":\"null\",\"PatternDispositionFlags_BootupSafeguardEnabled\":\"false\",\"PatternDispositionFlags_InddetMask\":\"false\",\"PatternDispositionFlags_QuarantineMachine\":\"false\",\"action_taken\":\"null\",\"PatternDispositionDescription\":\"Prevention%2C+operation+blocked.\",\"eventType\":\"DetectionSummaryEvent\",\"PatternDispositionFlags_SensorOnly\":\"false\",\"version\":\"1.0\",\"eventdate\":\"2022-02-08+**\",\"PatternDispositionFlags_PolicyDisabled\":\"false\",\"Objective\":\"Falcon+Detection+Method\",\"PatternDispositionFlags_FsOperationBlocked\":\"false\",\"ServiceName\":\"null\",\"ProcessStartTime\":\"***\",\"ComputerName\":\"***\",\"DetectName\":\"Blocked+Exploit\",\"PatternDispositionFlags_CriticalProcessDisabled\":\"false\",\"Technique\":\"Exploit+Mitigation\",\"ScanResults_Version_str\":\"null\",\"PatternDispositionFlags_SuspendParent\":\"false\",\"QuarantineFiles_ImageFileName_str\":\"null\",\"PatternDispositionFlags_HandleOperationDowngraded\":\"false\",\"QuarantineFiles_SHA256HashData_str\":\"null\",\"FileName\":\"***.exe\",\"PatternDispositionFlags_KillParent\":\"false\",\"customerIDString\":\"***\",\"ParentImageFileName\":\"\",\"MachineDomain\":\"***\",\"PatternDispositionFlags_KillActionFailed\":\"false\",\"PatternDispositionFlags_SuspendProcess\":\"false\",\"ExecutablesWritten\":\"null\",\"LocalIP\":\"1.2.3.4\",\"eventCreationTime\":\"2022-02-08***0\",\"DetectDescription\":\"A+process+using+Force+Data+Execution+Prevention+***+tried+to+execute+non-executable+memory.+The+process+was+blocked.\",\"new_state\":\"null\",\"PatternDispositionFlags_Detect\":\"false\",\"ScanResults_Detected_str\":\"null\",\"FilePath\":\"***\",\"UserIp\":\"null\",\"UserName\":\"administrator\",\"OperationName\":\"null\",\"ScanResults_Engine_str\":\"null\",\"PatternDispositionFlags_Rooting\":\"false\",\"MD5String\":\"***\",\"SeverityName\":\"High\",\"PatternDispositionFlags_RegistryOperationBlocked\":\"false\",\"Severity\":\"4\",\"DetectId\":\"ldt%***%***\",\"PatternDispositionValue\":\"***\",\"SHA256String\":\"***\",\"CommandLine\":\"**\",\"PatternDispositionFlags_KillSubProcess\":\"false\",\"GrandparentCommandLine\":\"\",\"UserId\":\"null\",\"IOCType\":\"null\",\"ProcessId\":\"***\",\"PatternDispositionFlags_Indicator\":\"false\",\"PatternDispositionFlags_BlockingUnsupportedOrDisabled\":\"false\"}"
        }
    ]
}

[
  {
      "eventdate": 1644348576728,
      "alertHost": "***",
      "domain": "***",
      "priority": 3,
      "context": "my.alert.***.***",
      "category": "my.context",
      "status": 0,
      "alertId": "***",
      "srcIp": null,
      "srcPort": null,
      "srcHost": "",
      "dstIp": null,
      "dstPort": null,
      "dstHost": "",
      "protocol": "",
      "username": "test@example.com",
      "application": "",
      "engine": "***",
      "extraData": "{\"SensorId\":\"***\",\"***\":\"false\",\"Tactic\":\"Exploit\",\"ParentProcessId\":\"***\",\"quarantined_file_id\":\"null\",\"UTCTimestamp\":\"null\",\"PatternDispositionFlags_ProcessBlocked\":\"false\",\"FalconHostLink\":\"https%3A%2F%2Ffalcon.crowdstrike.com%2Factivity%2Fdetections%2Fdetail%***%**%3F_cid%***\",\"GrandparentImageFileName\":\"\",\"PatternDispositionFlags_OperationBlocked\":\"true\",\"SHA1String\":\"0000000000000000000000000000000000000000\",\"ProcessEndTime\":\"0\",\"IOCValue\":\"null\",\"PatternDispositionFlags_QuarantineFile\":\"false\",\"jsonEvent\":\"%7B%22event%22%3A%7B%22PatternDispositionValue***\",\"ParentCommandLine\":\"\",\"offset\":\"***\",\"ScanResults_ResultName_str\":\"null\",\"PatternDispositionFlags_BootupSafeguardEnabled\":\"false\",\"PatternDispositionFlags_InddetMask\":\"false\",\"PatternDispositionFlags_QuarantineMachine\":\"false\",\"action_taken\":\"null\",\"PatternDispositionDescription\":\"Prevention%2C+operation+blocked.\",\"eventType\":\"DetectionSummaryEvent\",\"PatternDispositionFlags_SensorOnly\":\"false\",\"version\":\"1.0\",\"eventdate\":\"2022-02-08+**\",\"PatternDispositionFlags_PolicyDisabled\":\"false\",\"Objective\":\"Falcon+Detection+Method\",\"PatternDispositionFlags_FsOperationBlocked\":\"false\",\"ServiceName\":\"null\",\"ProcessStartTime\":\"***\",\"ComputerName\":\"***\",\"DetectName\":\"Blocked+Exploit\",\"PatternDispositionFlags_CriticalProcessDisabled\":\"false\",\"Technique\":\"Exploit+Mitigation\",\"ScanResults_Version_str\":\"null\",\"PatternDispositionFlags_SuspendParent\":\"false\",\"QuarantineFiles_ImageFileName_str\":\"null\",\"PatternDispositionFlags_HandleOperationDowngraded\":\"false\",\"QuarantineFiles_SHA256HashData_str\":\"null\",\"FileName\":\"***.exe\",\"PatternDispositionFlags_KillParent\":\"false\",\"customerIDString\":\"***\",\"ParentImageFileName\":\"\",\"MachineDomain\":\"***\",\"PatternDispositionFlags_KillActionFailed\":\"false\",\"PatternDispositionFlags_SuspendProcess\":\"false\",\"ExecutablesWritten\":\"null\",\"LocalIP\":\"1.2.3.4\",\"eventCreationTime\":\"2022-02-08***0\",\"DetectDescription\":\"A+process+using+Force+Data+Execution+Prevention+***+tried+to+execute+non-executable+memory.+The+process+was+blocked.\",\"new_state\":\"null\",\"PatternDispositionFlags_Detect\":\"false\",\"ScanResults_Detected_str\":\"null\",\"FilePath\":\"***\",\"UserIp\":\"null\",\"UserName\":\"administrator\",\"OperationName\":\"null\",\"ScanResults_Engine_str\":\"null\",\"PatternDispositionFlags_Rooting\":\"false\",\"MD5String\":\"***\",\"SeverityName\":\"High\",\"PatternDispositionFlags_RegistryOperationBlocked\":\"false\",\"Severity\":\"4\",\"DetectId\":\"ldt%***%***\",\"PatternDispositionValue\":\"***\",\"SHA256String\":\"***\",\"CommandLine\":\"**\",\"PatternDispositionFlags_KillSubProcess\":\"false\",\"GrandparentCommandLine\":\"\",\"UserId\":\"null\",\"IOCType\":\"null\",\"ProcessId\":\"***\",\"PatternDispositionFlags_Indicator\":\"false\",\"PatternDispositionFlags_BlockingUnsupportedOrDisabled\":\"false\"}"
      }
]

{
    "AlertIDs": [
        "***"
    ],
    "AlertHosts": [
        "***"
    ],
    "Domains": [
        "***"
    ]
}

Successful

Fetch Event Field Mapping

Please note that Fetch Event commands require event field mapping. Field mapping plays a key role in the data normalization process part of the event pipeline. Field mapping converts the original data fields from the different providers to the D3 fields which are standardized by the D3 Model. Please refer to Event and Incident Intake Field Mapping for details.

If you require a custom field mapping, click +Add Field to add a custom field mapping. You may also remove built-in field mappings by clicking x. Please note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.

As a system integration, the Devo Query integration has some pre-configured field mappings for default field mapping.

• Default Event Source
  The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, you will find a set of field mapping provided by the system. Default event source provides field mappings for common fields from fetched events. The default event source has a “Main Event JSON Path” (i.e., $.object) that is used to extract a batch of events from the response raw data. Click Edit Main JSON Path to view the “Main Event JSON Path”.

  

  • Main Event JSON Path: $.object
    The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $, representing the root element. The path is formed by appending a sequence of child elements to $, each separated by a dot (.). Square brackets with nested quotation marks ([‘...’]) should be used to separate child elements in JSON arrays.
    For example, the root node of a JSON Path is object. The child node denoting the Unique Event Key field would be alertId. Putting it together, the JSON Path expression to extract the Unique Event Key is $.object.alertId.

The pre-configured field mappings are detailed below:

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Run Query

Queries data in the Devo platform tables using LINQ.

Input

Output

{
    "msg": "",
    "timestamp": 1643317577907,
    "cid": "***",
    "status": 0,
    "object": [
        {
            "eventdate": 1643317458889,
            "clientIpAddress": ***,
            "timestamp": "27/Jan/2022:21:04:09 +0000",
            "method": "POST",
            "uri": "/category.screen?category_id=**&***=**",
            "protocol": "HTTP 1.1",
            "statusCode": 404,
            "bytesTransferred": 232,
            "referralUri": "http://www.***.com/",
            "userAgent": "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)",
            "cookie": "***:-",
            "timeTaken": 949
        }
    ]
}

[
  {
      "eventdate": 1643317458889,
      "clientIpAddress": ***,
      "timestamp": "27/Jan/2022:21:04:09 +0000",
      "method": "POST",
      "uri": "/category.screen?category_id=**&***=**",
      "protocol": "HTTP 1.1",
      "statusCode": 404,
      "bytesTransferred": 232,
      "referralUri": "http://www.***.com/",
      "userAgent": "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)",
      "cookie": "***:-",
      "timeTaken": 949
  }
]

{
    "EventDate": [
        ***
    ]
}

Successful

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

Test Connection

Allows you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Successful

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help you locate the root cause of a command failure.

FAQ

Q: What is Devo?

A: Devo is a cloud-based multi-tenant, centralized log management solution designed for large-scale and performance requirements. Devo collects machine data generated by traditional machine data sources and business applications in real-time and provides analytics in a centralized platform. Devo allows organizations to gain insight into their applications, infrastructure, and business systems with built-in applications, real-time dashboards, and alerts. It also provides security and IT professionals and data scientists the tools they need to extract valuable and actionable intelligence from petabytes of data.

Q: How does Devo work with D3 SOAR?

A: Events are retrieved from Devo in JSON format and sent to D3 SOAR via REST API.