ThreatQ Bulk Changes Action Bundle
The web format of this guide reflects the most current release. Guides for older iterations are available in PDF format.
Integration Details
ThreatQuotient provides the following details for this integration:
Current Integration Version | 1.1.2 |
Compatible with ThreatQ Versions | >= 5.24.0 |
ThreatQ TQO License Required | Yes |
Support Tier | ThreatQ Supported |
Introduction
The ThreatQ Bulk Changes Action Bundle allows you to automate the bulk update process of your system objects by creating a workflow that will execute bulk updates on objects that meet the specified criteria.
The integration provides the following actions:
- Add / Remove Tags - add or remove Tags for an object in the Threat Library.
- Add / Remove Attributes - add or remove Attributes for an object in the Threat Library.
- Change Status - change the Status of Indicators, Events, Malware, Reports, Signatures, and Tasks in the Threat Library.
- Change Expiration Policy - change the Expiration Policy for Indicators in the Threat Library.
- Add / Remove Relationships - add or remove Relationships for an object in the Threat Library.
- Change Point of Contact - change the Point of Contact from the Threat Library.
The action is compatible with the following system object types:
- Adversaries
- Assets
- Attack Patterns
- Campaigns
- Courses of Action
- Events
- Exploit Targets
- Files
- Identities
- Indicators
- Intrusion Sets
- Malware
- Reports
- Signatures
- Tools
- TTPs
- Vulnerabilities
This action is intended for use with ThreatQ TDR Orchestrator (TQO). An active TQO license is required for this feature.
Prerequisites
- An active ThreatQ TDR Orchestrator (TQO) license.
- A data collection containing at least one of the following object types:
- Adversaries
- Assets
- Attack Patterns
- Campaigns
- Courses of Action
- Events
- Exploit Targets
- Files
- Identities
- Indicators
- Intrusion Sets
- Malware
- Reports
- Signatures
- Tools
- TTPs
- Vulnerabilities
The Change Expiration Policy action is only compatible with indicator objects and the Change Status action is compatible with indicator, malware, report, signature, and task objects. All other objects types included in data collections submitted to these two actions will be ignored.
Installation
Perform the following steps to install the integration:
The same steps can be used to upgrade the integration to a new version.
- Log into https://marketplace.threatq.com/.
- Locate and download the action zip file.
- Navigate to the integrations management page on your ThreatQ instance.
- Click on the Add New Integration button.
- Upload the action zip file using one of the following methods:
- Drag and drop the zip file into the dialog box
- Select Click to Browse to locate the zip file on your local machine
- When prompted, select which actions to install on your instance.
ThreatQ will inform you if the action already exists on the platform and will require user confirmation before proceeding. ThreatQ will also inform you if the new version of the action contains changes to the user configuration. The new user configurations will overwrite the existing ones for the action and will require user confirmation before proceeding.
You will still need to configure the action(s).
Configuration
ThreatQuotient does not issue API keys for third-party vendors. Contact the specific vendor to obtain API keys and other integration-related credentials.
To configure the integration:
- Navigate to your integrations management page in ThreatQ.
- Select the Actions option from the Category dropdown (optional).
- Click on the action entry to open its details page.
- Enter the following parameters under the Configuration tab:
The configurations set on this page will be used as the default settings when inserting this action into a new workflow. Updating the configurations on this page will not update any instances of this action that have already been deployed to a workflow. In that scenario, you must update the action’s configurations within the workflow itself.
Add / Remove Attributes
Parameter Description Object Selection Select the objects to apply these changes to from the list provided. Options include: - Adversaries
- Assets
- Attack Patterns
- Campaigns
- Courses of Action
- Events
- Exploit Targets
- Files
- Identities
- Indicators
- Intrusion Sets
- Malware
- Reports
- Signatures
- Tools
- TTPs
- Vulnerabilities
Add Attributes Enter a line-separated list of attributes to add to the selected objects. You must provide both a name and value, separated by an equals sign (i.e. "Confidence=High").
To provide a Source & TLP marking, append the Source & TLP to the attribute name, in brackets, separated by a colon (i.e. "Confidence[Analyst:RED]=High").Remove Attributes Enter a line-separated list of attributes to remove from the selected objects. You can provide just the name, or the name and value, separated by an equals sign (i.e. "Confidence=High"). If no value is specified, all attributes with the given name will be removed. Add / Remove Relationships
Parameter Description Object Selection Select the object types to bulk update based on the data collection filters. Options include: - Adversaries
- Assets
- Attack Patterns
- Campaigns
- Courses of Action
- Events
- Exploit Targets
- Files
- Identities
- Indicators
- Intrusion Sets
- Malware
- Reports
- Signatures
- Tools
- TTPs
- Vulnerabilities
Add Relationships Enter a line-separated list of relationships to add to the selected objects. You must provide both a name and value, separated by an equals sign (i.e. "Malware=Lockbit"). Remove Relationships Enter a line-separated list of relationships to remove from the selected objects. You must provide both a name and value, separated by an equals sign (i.e. "Adversary=APT1"). Add / Remove Tags
Parameter Description Object Selection Select the object types to bulk update based on the data collection filters. Options include: - Adversaries
- Assets
- Attack Patterns
- Campaigns
- Courses of Action
- Events
- Exploit Targets
- Files
- Identities
- Indicators
- Intrusion Sets
- Malware
- Reports
- Signatures
- Tools
- TTPs
- Vulnerabilities
Add Tags Enter a line-separated list of tags to add to the selected objects. Remove Tags Enter a line-separated list of tags to remove from the selected objects. Change Expiration Policy
Parameter Description Select Expiration Status Select the type of expiration change to apply to the indicators. Options include: - Extend the Expiration Date (default)
- Protect from Auto-Expiration
- Remove Expiration Date
Enter Days to Extend Enter the number of days to extend the expiration for the selected indicators. This field is only visible when the Select Expiration Status field is set to Extend the expiration date.
Change Status
Parameter Description Object Selection Select the object types you want to bulk update based on the data collection filters. Options include: - Events
- Indicators
- Malware
- Reports
- Signatures
- Tasks
New Event Status Enter the name of the new status to be applied to the event objects. This status must already exist under Object Statuses page (located under Site Settings > Object Management > Object Statuses).
This parameter is only accessible if you have selected theEvents
option for the Object Selection parameter.New Indicator Status Select the status to apply to the selected objects. This parameter is only accessible if you have selected the
Indicators
option for the Object Selection parameter.New Malware Status Enter the name of the new status to be applied to the malware objects. This status must already exist under Object Statuses page (located under Site Settings > Object Management > Object Statuses).
This parameter is only accessible if you have selected theMalware
option for the Object Selection parameter.New Report Status Enter the name of the new status to be applied to the report objects. This status must already exist under Object Statuses page (located under Site Settings > Object Management > Object Statuses).
This parameter is only accessible if you have selected theReports
option for the Object Selection parameter.New Signature Status Select the status to apply to the selected objects. This parameter is only accessible if you have selected the
Signatures
option for the Object Selection parameter.New Task Status Enter the name of the new status to be applied to the tasks objects. This status must already exist under Object Statuses page (located under Site Settings > Object Management > Object Statuses).
This parameter is only accessible if you have selected theTasks
option for the Object Selection parameter.Change Point of Contact
Parameter Description Change Point of Contact to Type the name of the Point of Contact to add/change. Object Selection Select the object types you want to bulk update based on the data collection filters. Select a Function Select the function you want to perform (Change Point of Contact/Remove Point of Contact). Objects Per Run Select the number of objects to process per run of the workflow. - Review any additional settings, make any changes if needed, and click on Save.
Actions
The following actions are available:
Action | Description | Object Type |
---|---|---|
Add / Remove Tags | Add or remove tags from objects | Adversaries, Assets, Attack Patterns, Campaigns, Courses of Action, Events, Exploit Targets, Files, Identities, Indicators, Intrusion Sets, Malware, Reports, Signatures, Tools, TTPs, Vulnerabilities |
Add / Remove Attributes | Add or remove attributes from objects | Adversaries, Assets, Attack Patterns, Campaigns, Courses of Action, Events, Exploit Targets, Files, Identities, Indicators, Intrusion Sets, Malware, Reports, Signatures, Tools, TTPs, Vulnerabilities |
Add / Remove Relationships | Add or remove relationships from objects | Adversaries, Assets, Attack Patterns, Campaigns, Courses of Action, Events, Exploit Targets, Files, Identities, Indicators, Intrusion Sets, Malware, Reports, Signatures, Tools, TTPs, Vulnerabilities |
Change Status | Change the status of objects | Indicators, Events, Malware, Reports, Signatures, Tasks |
Change Expiration Policy | Change the expiration of indicators | Indicators |
Change Point of Contact | Change the point of contact of indicators | Asset, Attack Pattern, Campaign, Course Of Action, Event, Exploit Target, Identity, Incident, Intrusion Set, Malware, Note, Report, Tool, TTP, Vulnerability |
This action bundle guide does not have a mapping section as data is not being submitted or ingested in the ThreatQ platform.
Use Case Examples
Add / Remove Attributes
- As an analyst, I want to automatically add an attribute to all indicators with a Malware Relationship so I can score them higher in my ThreatQ Scoring Policy.
- As an analyst, I want to automatically add an attribute to all objects with a specific attribute so I can normalize it for a specific downstream tool.
Add / Remove Relationships
- As an analyst, I want to automatically add a relationship to an attack pattern to all reports that contain a specific MITRE ATT&CK Technique ID (TID).
- As an analyst, I want to automatically remove a relationship to a specific adversary, and switch it to a different adversary entry (alias).
Add / Remove Tags
- As an analyst, I want to automatically add a tag to all reports that contain keywords related to my organization's industry, so that I can easily identify them in the Threat Library.
- As an analyst, I want to automatically tag all indicators that have have a relation to a specific adversary or malware family, so that I can easily identify them in the Threat Library.
Change Expiration Policy
- As an analyst, I want to set specific indicators to never expire, when they are related to a specific adversary or malware family, so that I can ensure they are always being monitored and alerted on.
Change Status
- As an analyst, I want to automatically change the status of all indicators related to a specific ransomware family to 'Active' so that I can ensure they are being monitored and alerted on.
- As an analyst, I want to automatically change the status of all indicators with a specific attribute to 'Whitelisted' so that I can ensure they are not being accidentally blocked.
Change Point of Contact
- As an analyst, I want to automatically change the Point Of Contact of all supported object related to a specific ransomware family.
Known Issues / Limitations
- The actions provided in this bundle are not compatible with custom objects or tasks.
- For point of contact changes, only valid users can be assigned. If an invalid user is typed, the function will fail and return a Point Of Contact is not valid error.
Change Log
- Version 1.1.2
- Added support for the following object types for the Change Status action:
- Malware
- Reports
- Tasks
- Added the following new configuration parameters for the Change Status action:
- New Malware Status - enter a status defined in the Object Statuses to apply to the selected malware objects.
- New Report Status - enter a status defined in the Object Statuses to apply to the selected report objects.
- New Task Status - enter a status defined in the Object Statuses to apply to the selected task objects.
- Added support for the following object types for the Change Status action:
- Version 1.1.1
- Added event object type support for the Change Status action. Users can now apply statuses set on the Object Statuses page to selected event objects.
- Version 1.1.0
- Adds the option to change points of contact.
- Version 1.0.0
- Initial release
PDF Guides
Document | ThreatQ Version |
---|---|
ThreatQ Bulk Changes Action Bundle Guide v1.1.2 | 5.24.0 or Greater |
ThreatQ Bulk Changes Action Bundle Guide v1.1.1 | 5.24.0 or Greater |
ThreatQ Bulk Changes Action Bundle Guide v1.1.0 | 5.24.0 or Greater |
ThreatQ Bulk Changes Action Bundle Guide v1.1.0 | 5.24.0 or Greater |
ThreatQ Bulk Changes Action Bundle Guide v1.0.0 | 5.24.0 or Greater |