ThreatExchange Deprecated

Deprecated. Use the ThreatExchange v2 integration instead.

Data Enrichment & Threat Intelligence · ThreatExchange

Details

IDThreatExchange
ProviderMeta
CategoryData Enrichment & Threat Intelligence
From Version5.0.0
Supported ModulesAgentix XSIAM

README

Receive threat intelligence about applications, IP addresses, URLs and hashes, a service by Facebook

Configure ThreatExchange in Cortex

Parameter Description Required
Server URL (e.g. https://192.168.0.1)   True
App ID   True
App Secret   True
Source Reliability Reliability of the source providing the intelligence data. True
Use system proxy settings   False
Trust any certificate (not secure)   False
Api version   True

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

file


Checks the file reputation of the given hash.

Base Command

file

Input

Argument Name Description Required
file Hash of the file to query. Supports MD5, SHA1 and SHA256 hashes. Required
limit The maximum number of results per page. The maximum is 1000. Default is 20. Default is 20. Optional
headers A comma-separated list of headers to display in human-readable format. For example: header1,header2,header3. Optional
since The start timestamp for collecting malware, format: 1391813489. Optional
until The end timestamp for collecting malware, format: 1391813489. Optional

Context Output

Path Type Description
File.MD5 unknown Bad MD5 hash found.
File.SHA1 unknown Bad SHA1 hash found.
File.SHA256 unknown Bad SHA256 hash found.
DBotScore.Indicator unknown The indicator that was tested.
DBotScore.Type unknown The indicator type.
DBotScore.Vendor unknown The vendor used to calculate the score.
DBotScore.Score unknown The actual score.
File.Malicious.Vendor unknown For malicious files, the vendor that made the decision
File.Malicious.Description unknown For malicious files, the reason that the vendor made the decision.
File.Malicious.Score unknown For malicious files, the score from the vendor.

Command Example

!file file=bf4692a98a658dd7fb3599a47b6b48188a12345

Context Example

{
    "DBotScore": [
        {
            "Indicator": "bf4692a98a658dd7fb3599a47b6b48188a12345",
            "Reliability": "C - Fairly reliable",
            "Score": 0,
            "Type": "hash",
            "Vendor": "ThreatExchange"
        },
        {
            "Indicator": "bf4692a98a658dd7fb3599a47b6b48188a12345",
            "Reliability": "C - Fairly reliable",
            "Score": 0,
            "Type": "file",
            "Vendor": "ThreatExchange"
        }
    ]
}

Human Readable Output

ThreatExchange does not have details about bf4692a98a658dd7fb3599a47b6b48188a12345

ip


Checks the reputation of the given IP address.

Base Command

ip

Input

Argument Name Description Required
ip IP address to check. Required
headers A comma-separated list of headers to display in human-readable format. For example: header1,header2,header3. Optional

Context Output

Path Type Description
IP.Address unknown Bad IP address found.
IP.Malicious.Vendor unknown For malicious IPs addresse, the vendor that made the decision.
IP.Malicious.Description unknown For malicious IP addresses, the reason that the vendor made the decision.
DBotScore.Indicator unknown The indicator that was tested.
DBotScore.Type unknown The indicator type.
DBotScore.Vendor unknown The vendor used to calculate the score.
DBotScore.Score unknown The actual score.
IP.Malicious.Score unknown For malicious IP addresses, the score from the vendor.

Command Example

!ip ip=8.8.8.8

Context Example

{
    "DBotScore": [
        {
            "Indicator": "8.8.8.8",
            "Reliability": "C - Fairly reliable",
            "Score": 1,
            "Type": "ip",
            "Vendor": "ThreatExchange"
        },
        {
            "Indicator": "8.8.8.8",
            "Reliability": "C - Fairly reliable",
            "Score": 0,
            "Type": "ip",
            "Vendor": "ThreatExchange"
        }
    ],
    "IP": null
}

Human Readable Output

ThreatExchange IP Reputation

added_on confidence description id indicator last_updated owner privacy_type raw_indicator review_status severity share_level status type
2015-07-07T22:36:04+0000 50 Known DNS server 881335228606937 {“id”:”501655576609539”,”indicator”:”8.8.8.8”,”type”:”IP_ADDRESS”} 2020-07-24T05:25:48+0000 {“id”:”588498724619612”,”email”:”threatexchange@support.facebook.com”,”name”:”Facebook CERT ThreatExchange”} VISIBLE 8.8.8.8 REVIEWED_AUTOMATICALLY INFO GREEN NON_MALICIOUS IP_ADDRESS
2018-04-09T23:00:40+0000 50   1521082241333529 {“id”:”501655576609539”,”indicator”:”8.8.8.8”,”type”:”IP_ADDRESS”} 2020-07-24T21:52:30+0000 {“id”:”1656584897716085”,”email”:”threatexchange@support.facebook.com”,”name”:”JoeSandbox Analysis”} HAS_PRIVACY_GROUP 8.8.8.8 REVIEWED_AUTOMATICALLY INFO RED UNKNOWN IP_ADDRESS

url


Check URL Reputation

Base Command

url

Input

Argument Name Description Required
url URL to be checked. Required
limit The maximum number of results per page. The maximum is 1000. Default is 20. Default is 20. Optional
headers Headers to display in Human readable format, comma separated format, for example: header1,header2,header3. Optional
since The start timestamp for collecting malware, format: 1391813489. Optional
until The end timestamp for collecting malware, format: 1391813489. Optional

Context Output

Path Type Description
URL.Data unknown Bad URLs found
DBotScore.Indicator unknown The indicator that was tested.
DBotScore.Type unknown The indicator type.
DBotScore.Vendor unknown The vendor used to calculate the score.
DBotScore.Score unknown The actual score.
URL.Malicious.Vendor unknown For malicious URLs, the vendor that made the decision
URL.Malicious.Description unknown For malicious URLs, the reason for the vendor to make the decision
URL.Malicious.Score unknown For malicious URLs, the score from the vendor

Command Example

!url url=https://www.test.com/

Context Example

{
    "DBotScore": [
        {
            "Indicator": "https://www.test.com/",
            "Reliability": "C - Fairly reliable",
            "Score": 0,
            "Type": "url",
            "Vendor": "ThreatExchange"
        }
    ],
    "URL": null
}

Human Readable Output

ThreatExchange URL Reputation

added_on confidence id indicator last_updated owner privacy_type raw_indicator review_status severity share_level status type
2018-07-11T09:50:34+0000 25 1904903709602326 {“id”:”838258172933557”,”indicator”:”https://www.test.com/”,”type”:”URI”} 2020-07-24T19:24:35+0000 {“id”:”210126779388350”,”email”:”threatexchange@support.facebook.com”,”name”:”URLQueryThreatData Feed”} VISIBLE https://www.test.com/ REVIEWED_AUTOMATICALLY WARNING WHITE UNKNOWN URI
2015-07-09T03:04:19+0000 1 835880593160550 {“id”:”838258172933557”,”indicator”:”https://www.test.com/”,”type”:”URI”} 2020-07-24T03:37:14+0000 {“id”:”820763734618599”,”email”:”threatexchange@support.facebook.com”,”name”:”Facebook Administrator”} HAS_PRIVACY_GROUP https://www.test.com/ REVIEWED_AUTOMATICALLY INFO RED UNKNOWN URI

domain


Check domain reputation

Base Command

domain

Input

Argument Name Description Required
domain Domain name to check reputation. Required
limit The maximum number of results per page. The maximum is 1000. Default is 20. Default is 20. Optional
headers Headers to display in Human readable format, comma separated format, for example: header1,header2,header3. Optional
since The start timestamp for collecting malware, format: 1391813489. Optional
until The end timestamp for collecting malware, format: 1391813489. Optional

Context Output

Path Type Description
Domain.Name unknown Bad domain found
DBotScore.Indicator unknown The indicator that was tested.
DBotScore.Type unknown The indicator type.
DBotScore.Vendor unknown The vendor used to calculate the score.
DBotScore.Score unknown The actual score.
Domain.Malicious.Vendor unknown For malicious domains, the vendor that made the decision
Domain.Malicious.Description unknown For malicious domains, the reason that the vendor made the decision.

Command Example

!domain domain=google.com

Context Example

{
    "DBotScore": [
        {
            "Indicator": "google.com",
            "Reliability": "C - Fairly reliable",
            "Score": 0,
            "Type": "domain",
            "Vendor": "ThreatExchange"
        },
        {
            "Indicator": "google.com",
            "Reliability": "C - Fairly reliable",
            "Score": 1,
            "Type": "domain",
            "Vendor": "ThreatExchange"
        }
    ],
    "Domain": null
}

Human Readable Output

ThreatExchange Domain Reputation

added_on confidence id indicator last_updated owner privacy_type raw_indicator review_status severity share_level status type
2018-05-02T18:05:33+0000 75 1688788781168786 {“id”:”826838047363868”,”indicator”:”google.com”,”type”:”DOMAIN”} 2020-07-24T21:13:36+0000 {“id”:”1656584897716085”,”email”:”threatexchange@support.facebook.com”,”name”:”JoeSandbox Analysis”} HAS_PRIVACY_GROUP google.com UNREVIEWED INFO RED UNKNOWN DOMAIN
2015-09-04T22:03:24+0000 50 955242124521797 {“id”:”826838047363868”,”indicator”:”google.com”,”type”:”DOMAIN”} 2020-07-24T01:04:11+0000 {“id”:”588498724619612”,”email”:”threatexchange@support.facebook.com”,”name”:”Facebook CERT ThreatExchange”} VISIBLE google.com REVIEWED_MANUALLY INFO WHITE NON_MALICIOUS DOMAIN

threatexchange-query


Searches for subjective opinions on indicators of compromise stored in ThreatExchange

Base Command

threatexchange-query

Input

Argument Name Description Required
text Free-form text field with a value to search for. This can be a file hash or a string found in other fields of the objects. Optional
type The type of descriptor to search for. For more information see: https://developers.facebook.com/docs/threat-exchange/reference/apis/indicator-type/v2.9. Optional
limit The maximum number of results per page. The maximum is 1000. Default is 20. Default is 20. Optional
headers Headers to display in Human readable format, comma separated format, for example: header1,header2,header3. Optional
since The start timestamp for collecting malware, format: 1391813489. Optional
until The end timestamp for collecting malware, format: 1391813489. Optional

Context Output

There is no context output for this command.

Command Example

!threatexchange-query text=geektime type=URI limit=3

Context Example

{
    "queryResult": [
        {
            "added_on": "2018-08-30T07:12:28+0000",
            "confidence": 50,
            "id": "2036544083043163",
            "indicator": {
                "id": "2036543926376512",
                "indicator": "http://www.geektime.co.il/wp-content/uploads/2016/09/",
                "type": "URI"
            },
            "last_updated": "2021-03-03T02:41:06+0000",
            "owner": {
                "email": "threatexchange@support.facebook.com",
                "id": "820763734618599",
                "name": "Facebook Administrator"
            },
            "privacy_type": "VISIBLE",
            "raw_indicator": "http://www.geektime.co.il/wp-content/uploads/2016/09/",
            "review_status": "REVIEWED_AUTOMATICALLY",
            "severity": "INFO",
            "share_level": "GREEN",
            "status": "UNKNOWN",
            "type": "URI"
        }
    ]
}

Human Readable Output

ThreatExchange Query Result

added_on confidence id indicator last_updated owner privacy_type raw_indicator review_status severity share_level status type
2018-08-30T07:12:28+0000 50 2036544083043163 {“id”:”2036543926376512”,”indicator”:”http://www.geektime.co.il/wp-content/uploads/2016/09/”,”type”:”URI”} 2021-03-03T02:41:06+0000 {“id”:”820763734618599”,”email”:”threatexchange@support.facebook.com”,”name”:”Facebook Administrator”} VISIBLE http://www.geektime.co.il/wp-content/uploads/2016/09/ REVIEWED_AUTOMATICALLY INFO GREEN UNKNOWN URI
2018-08-28T14:59:24+0000 50 1799344580151062 {“id”:”1799344400151080”,”indicator”:”http://www.geektime.co.il/wp-content/uploads/2016/05/”,”type”:”URI”} 2020-07-24T20:12:26+0000 {“id”:”820763734618599”,”email”:”threatexchange@support.facebook.com”,”name”:”Facebook Administrator”} VISIBLE http://www.geektime.co.il/wp-content/uploads/2016/05/ REVIEWED_AUTOMATICALLY INFO GREEN UNKNOWN URI
2018-08-24T20:16:16+0000 50 2265237266824665 {“id”:”2265236920158033”,”indicator”:”http://www.geektime.co.il/wp-content/uploads/2016/07/”,”type”:”URI”} 2020-07-24T18:45:09+0000 {“id”:”820763734618599”,”email”:”threatexchange@support.facebook.com”,”name”:”Facebook Administrator”} VISIBLE http://www.geektime.co.il/wp-content/uploads/2016/07/ REVIEWED_AUTOMATICALLY INFO GREEN UNKNOWN URI

threatexchange-members


Returns a list of current members of the ThreatExchange, alphabetized by application name. Each application may also include an optional contact email address. You can set this address, if desired, under the settings panel for your application

Base Command

threatexchange-members

Input

| Argument Name | Description | Required |
| — | — | — |

Context Output

There is no context output for this command.

Command Example

!threatexchange-members

Human Readable Output

ThreatExchange Members

email id name
example@example.com example_id_1 Example Name 1
example2@example.com example_id_2 Example Name 2
example3@example.com example_id_3 Example Name 3
example4@example.com example_id_4 Example Name4

Configuration parameters

  • Server — Server URL (e.g. https://192.168.0.1) (required)
  • appID — App ID (required)
  • appSecret — App Secret (required)
  • integrationReliability — Source Reliability (required)
  • useproxy — Use system proxy settings
  • insecure — Trust any certificate (not secure)
  • apiVersion — Api version (required)

Commands (6)

  • domain

    Check domain reputation

  • file

    Checks the file reputation of the given hash.

  • ip

    Checks the reputation of the given IP address.

  • threatexchange-members

    Returns a list of current members of the ThreatExchange, alphabetized by application name. Each application may also include an optional contact email address. You can set this address, if desired, under the settings panel for your application

  • threatexchange-query

    Searches for subjective opinions on indicators of compromise stored in ThreatExchange

  • url

    Check URL Reputation

commonfields:
  id: ThreatExchange
  version: -1
name: ThreatExchange
display: ThreatExchange (Deprecated)
deprecated: true
fromversion: 5.0.0
category: Data Enrichment & Threat Intelligence
provider: Meta
description: Deprecated. Use the ThreatExchange v2 integration instead.
configuration:
- display: Server URL (e.g. https://192.168.0.1)
  name: Server
  defaultvalue: https://graph.facebook.com
  type: 0
  required: true
- display: App ID
  name: appID
  defaultvalue: ""
  type: 0
  required: true
- display: App Secret
  name: appSecret
  defaultvalue: ""
  type: 4
  required: true
- additionalinfo: Reliability of the source providing the intelligence data.
  defaultvalue: C - Fairly reliable
  display: Source Reliability
  name: integrationReliability
  options:
  - A+ - 3rd party enrichment
  - A - Completely reliable
  - B - Usually reliable
  - C - Fairly reliable
  - D - Not usually reliable
  - E - Unreliable
  - F - Reliability cannot be judged
  required: true
  type: 15
- display: Use system proxy settings
  name: useproxy
  defaultvalue: "true"
  type: 8
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  defaultvalue: "false"
  type: 8
  required: false
- display: Api version
  name: apiVersion
  defaultvalue: v2.8
  type: 0
  required: true
script:
  script: ''
  type: javascript
  commands:
  - name: file
    arguments:
    - name: file
      required: true
      default: true
      description: Hash of the file to query. Supports MD5, SHA1 and SHA256 hashes.
    - name: limit
      description: The maximum number of results per page. The maximum is 1000. Default is 20.
      defaultValue: "20"
    - name: headers
      description: 'A comma-separated list of headers to display in human-readable format. For example: header1,header2,header3'
    - name: since
      description: 'The start timestamp for collecting malware, format: 1391813489'
    - name: until
      description: 'The end timestamp for collecting malware, format: 1391813489'
    outputs:
    - contextPath: File.MD5
      description: Bad MD5 hash found.
    - contextPath: File.SHA1
      description: Bad SHA1 hash found.
    - contextPath: File.SHA256
      description: Bad SHA256 hash found.
    - contextPath: DBotScore.Indicator
      description: The indicator that was tested.
    - contextPath: DBotScore.Type
      description: The indicator type.
    - contextPath: DBotScore.Vendor
      description: The vendor used to calculate the score.
    - contextPath: DBotScore.Score
      description: The actual score.
    - contextPath: File.Malicious.Vendor
      description: For malicious files, the vendor that made the decision
    - contextPath: File.Malicious.Description
      description: For malicious files, the reason that the vendor made the decision.
    - contextPath: File.Malicious.Score
      description: For malicious files, the score from the vendor.
    description: Checks the file reputation of the given hash.
  - name: ip
    arguments:
    - name: ip
      required: true
      default: true
      description: IP address to check.
    - name: headers
      description: 'A comma-separated list of headers to display in human-readable format. For example: header1,header2,header3.'
    outputs:
    - contextPath: IP.Address
      description: Bad IP address found.
    - contextPath: IP.Malicious.Vendor
      description: For malicious IPs addresse, the vendor that made the decision.
    - contextPath: IP.Malicious.Description
      description: For malicious IP addresses, the reason that the vendor made the decision.
    - contextPath: DBotScore.Indicator
      description: The indicator that was tested.
    - contextPath: DBotScore.Type
      description: The indicator type.
    - contextPath: DBotScore.Vendor
      description: The vendor used to calculate the score.
    - contextPath: DBotScore.Score
      description: The actual score.
    - contextPath: IP.Malicious.Score
      description: For malicious IP addresses, the score from the vendor.
    description: Checks the reputation of the given IP address.
  - name: url
    arguments:
    - name: url
      required: true
      description: URL to be checked
    - name: limit
      description: The maximum number of results per page. The maximum is 1000. Default is 20.
      defaultValue: "20"
    - name: headers
      description: 'Headers to display in Human readable format, comma separated format, for example: header1,header2,header3'
    - name: since
      description: 'The start timestamp for collecting malware, format: 1391813489'
    - name: until
      description: 'The end timestamp for collecting malware, format: 1391813489'
    outputs:
    - contextPath: URL.Data
      description: Bad URLs found
    - contextPath: DBotScore.Indicator
      description: The indicator that was tested.
    - contextPath: DBotScore.Type
      description: The indicator type.
    - contextPath: DBotScore.Vendor
      description: The vendor used to calculate the score.
    - contextPath: DBotScore.Score
      description: The actual score.
    - contextPath: URL.Malicious.Vendor
      description: For malicious URLs, the vendor that made the decision
    - contextPath: URL.Malicious.Description
      description: For malicious URLs, the reason for the vendor to make the decision
    - contextPath: URL.Malicious.Score
      description: For malicious URLs, the score from the vendor
    description: Check URL Reputation
  - name: domain
    arguments:
    - name: domain
      required: true
      default: true
      description: Domain name to check reputation
    - name: limit
      description: The maximum number of results per page. The maximum is 1000. Default is 20.
      defaultValue: "20"
    - name: headers
      description: 'Headers to display in Human readable format, comma separated format, for example: header1,header2,header3'
    - name: since
      description: 'The start timestamp for collecting malware, format: 1391813489'
    - name: until
      description: 'The end timestamp for collecting malware, format: 1391813489'
    outputs:
    - contextPath: Domain.Name
      description: Bad domain found
    - contextPath: DBotScore.Indicator
      description: The indicator that was tested.
    - contextPath: DBotScore.Type
      description: The indicator type.
    - contextPath: DBotScore.Vendor
      description: The vendor used to calculate the score.
    - contextPath: DBotScore.Score
      description: The actual score.
    - contextPath: Domain.Malicious.Vendor
      description: For malicious domains, the vendor that made the decision
    - contextPath: Domain.Malicious.Description
      description: For malicious domains, the reason that the vendor made the decision.
    description: Check domain reputation
  - name: threatexchange-query
    arguments:
    - name: text
      default: true
      description: Free-form text field with a value to search for. This can be a file hash or a string found in other fields of the objects.
    - name: type
      description: 'The type of descriptor to search for. For more information see: https://developers.facebook.com/docs/threat-exchange/reference/apis/indicator-type/v2.9'
    - name: limit
      description: The maximum number of results per page. The maximum is 1000. Default is 20.
      defaultValue: "20"
    - name: headers
      description: 'Headers to display in Human readable format, comma separated format, for example: header1,header2,header3'
    - name: since
      description: 'The start timestamp for collecting malware, format: 1391813489'
    - name: until
      description: 'The end timestamp for collecting malware, format: 1391813489'
    description: ' Searches for subjective opinions on indicators of compromise stored in ThreatExchange'
  - name: threatexchange-members
    arguments: []
    description: Returns a list of current members of the ThreatExchange, alphabetized by application name. Each application may also include an optional contact email address. You can set this address, if desired, under the settings panel for your application
tests:
- ThreatExchange-test