Collect Trellix Endpoint Security (HX) Bulk Acquisition Result Packages

Supported in:

This document explains how to collect Trellix Endpoint Security (HX) bulk data acquisition results by setting up a Google Security Operations feed using the Third-Party API.

You can acquire data from a host using the Endpoint Security (HX) Web UI. Multiple data acquisitions can be requested simultaneously from a host. In addition, you can select multiple hosts and request data acquisitions from them.

This feed supports the following types of event buffer audit results:

  • ipv4NetworkEvent
  • processEvent
  • fileWriteEvent
  • dnsLookupEvent
  • imageLoadEvent
  • regKeyEvent
  • urlMonitorEvent

Before you begin

Ensure that you have the following prerequisites:

  • A Google SecOps instance
  • Privileged access to the Trellix Endpoint Security (HX) management console
  • Trellix Endpoint Security (HX) with API access enabled
  • One of the following authentication credentials configured (see next section)

Configure Trellix HX API access

To enable Google SecOps to pull audit event data, you need API credentials from your Trellix HX environment. Trellix Local authentication uses a local user account on the HX appliance to generate an API token.

  1. Sign in to the Endpoint Security (HX) Web UI as an administrator.
  2. Go to Admin > Appliance Settings > User Accounts.
  3. Add a new user account with the api_analyst role for use with Google SecOps. Do not reuse the built-in api_analyst account.
  4. Copy and save the following values:
    • Username: The local HX account username.
    • Password: The local HX account password.

Configure a feed in Google SecOps to ingest Trellix HX audit event logs

  1. Go to SIEM Settings > Feeds.
  2. Click Add New Feed.
  3. On the next page, click Configure a single feed.
  4. In the Feed name field, enter a name for the feed (for example, Trellix HX Audit Events).
  5. Select Third-Party API as the Source type.
  6. Select Trellix HX Audit Events as the Log type.
  7. Click Next.
  8. Specify values for the following input parameters:

    • HX Device URL: The URL of your HX device (for example, https://irbvzh7894.hex3.helix.apps.fireeye.com/).
    • Authentication: Trellix Local Auth

      • Username: Enter the local HX account username created for this integration.
      • Password: Enter the password for the username.
      • Token API Endpoint Path: /hx/api/v3/token
      • Token Header: X-FeApi-Token
    • Asset namespace: The asset namespace.

    • Ingestion labels: The label to be applied to the events from this feed.

  9. Click Next.

  10. Review your new feed configuration in the Finalize screen, and then click Submit.

After setup, the feed begins to retrieve audit event logs from the Trellix HX instance in chronological order.

UDM mapping table

Log field UDM mapping Logic
__event_timestamp metadata.event_timestamp Parsed as RFC3339
__evtype metadata.event_type Mapped: startGENERIC_EVENT, startPROCESS_LAUNCH
__reg_key_event_type metadata.event_type Mapped: 0/1/5REGISTRY_MODIFICATION, 2/4REGISTRY_DELETION, 3 → `REGISTRY_CREA...
__appliance_id metadata.product_deployment_id Mapped when __appliance_id != ``
__event_type metadata.product_event_type Mapped when __event_type != ``
__product_log_id metadata.product_log_id Mapped when __product_log_id != ``
__product_log_id_event_item metadata.product_log_id Mapped when __product_log_id_event_item != ``
__evtype metadata.product_name Mapped: startHX
__url metadata.url_back_to_product Mapped when __url != ``
__evtype metadata.vendor_name Mapped: startTrellix
__dns_lookup_event_question network.dns.questions Merged
__agent_data principal Renamed/mapped
event_values.__localIP principal.ip Merged
event_values.__localPort principal.port Renamed/mapped
__parent_process_path principal.process.file.full_path Mapped when __evtype == start
__process_full_path principal.process.file.full_path Mapped when __process_full_path != ``
__evtype principal.process.file.names Mapped: startevent_values.__parentProcess
__process principal.process.file.names Merged
event_values.__parentProcess principal.process.file.names Merged
__parent_process_path principal.process.parent_process.file.full_path Mapped when __parent_process_path != ``
__parent_process principal.process.parent_process.file.names Merged
__parent_pid principal.process.parent_process.pid Mapped when __parent_pid != ``
__parent_pid principal.process.pid Mapped when __evtype == start
__pid principal.process.pid Mapped when __pid != ``
__domain_user principal.user.userid Mapped when __domain_user != ``
__agent_data target Renamed/mapped
event_values.__fileName target.file.names Merged
event_values.__size target.file.size Renamed/mapped
event_values.__remoteIP target.ip Merged
event_values.__remoteIpAddress target.ip Merged
__file_write_event_label_closed target.labels Merged
__file_write_event_label_data_at_lowest_offset target.labels Merged
__file_write_event_label_event_reason target.labels Merged
__file_write_event_label_lowest_file_offset_seen target.labels Merged
__file_write_event_label_num_bytes_seen_written target.labels Merged
__file_write_event_label_open_duration target.labels Merged
__file_write_event_label_open_time target.labels Merged
__file_write_event_label_text_at_lowest_offset target.labels Merged
__file_write_event_label_writes target.labels Merged
__image_load_event_value_device_path_label target.labels Merged
__reg_key_event_type_label target.labels Merged
__reg_key_event_value_basesf_label target.labels Merged
__url_monitor_event_headers target.labels Merged
event_values.__remotePort target.port Renamed/mapped
event_values.__processCmdLine target.process.command_line Mapped when __evtype == start
__process_full_path target.process.file.full_path Mapped when __evtype == start
event_values.__md5 target.process.file.md5 Mapped when __evtype == start
__evtype target.process.file.names Mapped: start__process
__process target.process.file.names Merged
event_values.__fileName target.process.file.names Merged
__parent_process_path target.process.parent_process.file.full_path Mapped when __evtype == start
__evtype target.process.parent_process.file.names Mapped: startevent_values.__parentProcess
event_values.__parentProcess target.process.parent_process.file.names Merged
__parent_pid target.process.parent_process.pid Mapped when __evtype == start
__pid target.process.pid Mapped when __evtype == start
__agent_id target.process.product_specific_process_id Mapped when __evtype == start
__pid target.process.product_specific_process_id Mapped when __evtype == start
event_values.__startTime target.process.product_specific_process_id Mapped when __evtype == start

Change Log

View the Change Log for this parser

Need more help? Get answers from Community members and Google SecOps professionals.