abuse.ch ThreatFox CDF
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.0 |
Compatible with ThreatQ Versions | >= 5.5.0 |
Support Tier | ThreatQ Supported |
Introduction
ThreatFox is a project of abuse.ch with the goal of sharing indicators of compromise (IOCs) associated with malware with the infosec community, AV vendors and threat intelligence providers.
The integration provides the following feed:
- abuse.ch ThreatFox - retrieves a copy of the current IOC dataset from ThreatFox.
The integration ingests indicator type system objects.
Prerequisites
The following is required in order to use the integration:
- An Abuse.ch ThreatFox API Key. You can create one for free by signing up at https://auth.abuse.ch/.
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 integration file.
- Navigate to the integrations management page on your ThreatQ instance.
- Click on the Add New Integration button.
- Upload the integration file using one of the following methods:
- Drag and drop the file into the dialog box
- Select Click to Browse to locate the integration file on your local machine
ThreatQ will inform you if the feed already exists on the platform and will require user confirmation before proceeding. ThreatQ will also inform you if the new version of the feed contains changes to the user configuration. The new user configurations will overwrite the existing ones for the feed and will require user confirmation before proceeding.
- If prompted, select the individual feeds to install and click Install. The feed will be added to the integrations page.
You will still need to configure and then enable the feed.
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 OSINT option from the Category dropdown (optional).
If you are installing the integration for the first time, it will be located under the Disabled tab.
- Click on the integration entry to open its details page.
- Enter the following parameters under the Configuration tab:
Parameter Description Auth Key Your Abuse.ch ThreatFox Auth Key. Context Selection Select which pieces of context to ingest into ThreatQ with each indicator. Options include: - Tags
- Confidence
- Reporter
- Port
- Threat Type
- Malware Family
- Malware Alias
Normalize Confidence Score Enable this option to normalize the numeric confidence score from the API to a friendly value which you can use within your ThreatQ Scoring Policy. When disabled, the numeric confidence score will be used as is.
Confidence Score Normalization Mapping A mapping to normalize the numeric confidence score values to the scorable attribute, Normalized Confidence
. The numeric Confidence itself will be ingested if checked. This mapping should contain a line-separated CSV formatted string with the following columns: Minimum, Maximum, Normalized Value.Example:
0,25,Low
The default values for this parameter are:
0,25,Low 26,59,Medium 60,89,High 90,100,Critical
This parameter is only accessible if the Normalize Confidence Score parameter is enabled.
Enable SSL Certificate Verification Enable this parameter if the feed should validate the host-provided SSL certificate. Disable Proxies Enable this parameter if the feed should not honor proxies set in the ThreatQ UI.
- Review all settings, make any changes if needed, and click on Save.
- Click on the toggle switch, located above the Additional Information section, to enable it.
ThreatQ Mapping
abuse.ch ThreatFox
The abuse.ch ThreatFox feed retrieves a copy of the current IOC dataset from ThreatFox.
POST https://threatfox-api.abuse.ch/api/v1/
Sample Request:
{
"query": "get_iocs",
"days": 1
}
Sample Response:
{
"data":[
{
"id":"1020675",
"ioc":"http://116.202.5.101/1679",
"threat_type":"botnet_cc",
"threat_type_desc":"Indicator that identifies a botnet command&control server (C&C)",
"ioc_type":"url",
"ioc_type_desc":"URL that is used for botnet Command&control (C&C)",
"malware":"win.vidar",
"malware_printable":"Vidar",
"malware_alias":null,
"malware_malpedia":"https://malpedia.caad.fkie.fraunhofer.de/details/win.vidar",
"confidence_level":100,
"first_seen":"2022-11-18 07:48:30 UTC",
"last_seen":null,
"reference":null,
"reporter":"crep1x",
"tags":[
"Vidar"
]
},
{
"id":"1020674",
"ioc":"185.132.53.205:1312",
"threat_type":"botnet_cc",
"threat_type_desc":"Indicator that identifies a botnet command&control server (C&C)",
"ioc_type":"ip:port",
"ioc_type_desc":"ip:port combination that is used for botnet Command&control (C&C)",
"malware":"elf.mirai",
"malware_printable":"Mirai",
"malware_alias":"Katana",
"malware_malpedia":"https://malpedia.caad.fkie.fraunhofer.de/details/elf.mirai",
"confidence_level":75,
"first_seen":"2022-11-18 06:50:05 UTC",
"last_seen":null,
"reference":"https://bazaar.abuse.ch/sample/b0aed60367755280b88f0efd6d64083ac5d29ac095851ab0f013a6397ec5bcad/",
"reporter":"abuse_ch",
"tags":[
"Mirai"
]
}
]
}
ThreatQuotient provides the following default mapping for this feed:
Feed Data Path | ThreatQ Entity | ThreatQ Object Type or Attribute Key | Published Date | Examples | Notes |
---|---|---|---|---|---|
.data[].ioc | Indicator Value | See Indicator Type Map | .data[].first_seen |
185.132.53.205 | IOC value depends on type. Check Indicator Type Map |
.data[].tags | Indicator Tag | N/A | N/A | "dll", "QakBot", "qbot", "SilentBuilder", "TR" | User-Configurable |
.data[].threat_type_desc | Indicator Description | N/A | .data[].first_seen |
Indicator that identifies a malware distribution server (payload delivery) | Describes Indicator |
.data[].id | Indicator Description | N/A | N/A | https://threatfox.abuse.ch/ioc/1000/ |
Formatted into the HTML description as “View Indicator in ThreatFox” link constructed from: https://threatfox.abuse.ch/ioc/ + .data[].id |
.data[].reference | Indicator Description | N/A | N/A | https://twitter.com/JAMESWT_MHT/status/1336229725082177536 |
Formatted into the HTML description |
.data[].malware_malpedia | Indicator Description | N/A | N/A | https://malpedia.caad.fkie.fraunhofer.de/details/win.qakbot |
Formatted into the HTML description |
.data[].reporter | Indicator Attribute | Reporter | .data[].first_seen |
abuse_ch | User-Configurable |
.data[].confidence_level | Indicator Attribute | Confidence | .data[].first_seen |
100 | Value between 0-100. Updatable. User-Configurable |
.data[].confidence_level | Indicator Attribute | Normalized Confidence | .data[].first_seen |
Critical | Normalised value based on Confidence Score Normalization Mapping user field, ingested when Confidence is checked. Updatable. User-Configurable |
.data[].ioc | Indicator Attribute | Port | .data[].first_seen |
4003 | If IOC type is ip:port . Indicates port for server payload. Split ip and port on condition ioc_type is "ip:port". User-Configurable |
.data[].threat_type | Indicator Attribute | Threat Type | .data[].first_seen |
payload_delivery | Describes the delievery method of the threat. User-Configurable |
.data[].malware_printable | Indicator Attribute | Malware Family | .data[].first_seen |
QakBot | User-Configurable |
.data[].malware_alias | Indicator Attribute | Malware Alias | .data[].first_seen |
Katana | User-Configurable |
Indicator Type Mapping
The following table shows abuse.ch to ThreatQ indicator mapping:
abuse.ch value | ThreatQ value |
---|---|
URL | URL |
ip:port | IP Address |
domain | URL |
sha1_hash | SHA-1 |
sha3_384_hash | SHA-384 |
sha256_hash | SHA-256 |
sha512_hash | SHA-512 |
md5_hash | MD5 |
envelope_from | Email Address |
body_from | Email Address |
Average Feed Run
Object counts and Feed runtime are supplied as generalities only - objects returned by a provider can differ based on credential configurations and Feed runtime may vary based on system resources and load.
Metric | Result |
---|---|
Run Time | 3 min |
Indicators | 2,275 |
Indicator Attributes | 20,521 |
Known Issues / Limitations
- API data fetching is restricted from 1 to 7 days with the time unit of 1 day.
Change Log
- Version 1.1.0
- Added support for authenticating with the API.
- Added the following configuration parameters:
- Auth Key - authenticate with the abuse.ch ThreatFox API using an Auth Key.
- Context Selection - select which pieces of context to ingest into ThreatQ with each indicator.
- Normalize Confidence Score - normalize the confidence score to a "friendly" value for the ThreatQ Scoring Policy.
- Confidence Score Normalization Mapping - allows you to provide normalization mapping if utilizing the Normalize Confidence Score parameter.
- Disable Proxies - determine if the feed should not honor proxies set in the ThreatQ UI.
- Enable SSL Certificate Verification - determine if the feed should validate the host-provided SSL certificate.
- Added the ability to update attributes instead of duplicating them.
- The following fields have been moved from attributes to the indicator description:
- Description (attribute)
- ThreatFox Link
- Reference
- Malpedia Reference
- Resolved an error that caused the malware aliases to be ingested as a comma-separated list.
- Updated the minimum ThreatQ version to 5.5.0.
- Version 1.0.2
- Resolved a date parsing issue that customers on ThreatQ version 5.26 experienced when running the CDF.
- Version 1.0.1
- The Attribute Confidence is now updated when a new value is ingested.
- Version 1.0.0
- Initial release
PDF Guides
Document | ThreatQ Version |
---|---|
abuse.ch ThreatFox CDF Guide v1.1.0 | 5.5.0 or Greater |
abuse.ch ThreatFox CDF Guide v1.0.2 | 4.50 or Greater |
abuse.ch ThreatFox CDF Guide v1.0.1 | 4.50 or Greater |
abuse.ch ThreatFox CDF Guide v1.0.0 | 4.50 or Greater |