SecurityScorecard 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.0.1 |
| Compatible with ThreatQ Versions | >= 5.12.0 |
| Support Tier | ThreatQ Supported |
Introduction
The SecurityScorecard CDF for ThreatQ enables analysts to automatically ingest scorecard summaries and events into ThreatQ.
The integration provides the following feeds:
- SecurityScorecard Summary Reports - pulls scorecard reports for registered domains, into ThreatQ.
- SecurityScorecard Events - pulls events for a given domain.
The integration ingests the following system objects:
- Assets
- Asset Attributes
- Events
- Event Attributes
- Indicators
- Indicator Attributes
Prerequisites
The following is required to run the integration:
- A Security Scorecard license.
- A Security Scorecard API key.
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 yaml file
- Navigate to the integrations management page on your ThreatQ instance.
- Click on the Add New Integration button.
- Upload the yaml 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.
- Select the individual feeds to install, when prompted, 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 Commercial 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:
SecurityScorecard Events Parameters
Parameter Description SecurityScorecard API Key Your API Key for SecurityScorecard, found in your user-profile. 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. Scorecard Domains A comma-separated list of scorecard domains (sites) to fetch the scorecard summaries. Event Type Filter Select the event types for events to ingest into ThreatQ. Options include: - Issue - indicates the arrival or departure of issues to this scorecard (default)
- Breach - a breach was associated to this company (default)
- Recalibration - indicates a recalibration event (default)
Group Status Filter
Select the group status for events to ingest into ThreatQ. Options include - Active - new issues have been observed (default)
- Resolved - issues were refuted and resolution confirmed
- Departed - issues are not observed anymore
Severity Filter
Select the severity for events to ingest into ThreatQ. Options include: - Low (default)
- Medium (default)
- High (default)
- Positive
- Informational
SecurityScorecard Summary Reports Parameters
Parameter Description SecurityScorecard API Key Your API Key for SecurityScorecard, found in your user-profile. 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. Scorecard Domains A comma-separated list of scorecard domains (sites) to fetch the scorecard summaries.
- Review any additional 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
Security Scorecard Summary Reports
The Summary Reports feed periodically pulls scorecard reports for registered domains into ThreatQ.
GET https://api.securityscorecard.io/companies/{{domain}}
Sample Response:
{
"name": "ThreatQuotient Inc",
"description": "",
"domain": "threatq.com",
"grade_url": "https://s3.amazonaws.com/ssc-static/grades/factor_a.svg",
"industry": "information_services",
"size": "unknown",
"score": 91,
"grade": "A",
"last30day_score_change": -5,
"is_entity": false,
"is_un_published": true,
"created_at": "2018-01-04T20:19:31.077Z",
"disputed": false
}
ThreatQuotient provides the following default mapping for this feed:
The factors key is data pulled from the SecurityScorecard - Get Factors supplemental feed
| Feed Data Path | ThreatQ Entity | ThreatQ Object Type or Attribute Key | Published Date | Examples | Notes |
|---|---|---|---|---|---|
.domain |
Asset Value | N/A | .created_at |
threatq.com |
N/A |
.factors[][.name,.grade,.score,.total_score_impact] |
Asset Description | N/A | N/A | SecurityScorecard Summary {{factors}} | The factors are built into an HTML description |
.domain |
Asset Attribute | Domain | N/A | threatq.com |
N/A |
.description |
Asset Attribute | Description | N/A | N/A | This is different from the "built" description |
.disputed |
Asset Attribute | Is Disputed | N/A | False | Bool -> True/False |
.grade |
Asset Attribute | Grade | N/A | A |
N/A |
.score |
Asset Attribute | Score | N/A | 91 |
N/A |
.industry |
Asset Attribute | Industry | N/A | information_services |
N/A |
.last30day_score_change |
Asset Attribute | Last 30 Day Score Change | N/A | -5 |
N/A |
.name |
Asset Attribute | Scorecard Name | N/A | ThreatQuotient Inc |
N/A |
.size |
Asset Attribute | Size | N/A | unknown |
N/A |
Security Scorecard Events
The Events feed periodically pulls events for a given domain. This includes breach events, recalibration events, new issue events, etc.
GET https://api.securityscorecard.io/companies/{{domain}}/history/events
Sample Response:
{
"entries": [
{
"id": 1500171,
"date": "2022-05-28T00:00:00.000Z",
"event_type": "issues",
"group_status": "departed",
"issue_count": 1,
"total_score_impact": 0,
"issue_type": "service_vuln_host_info",
"severity": "info",
"factor": "patching_cadence",
"detail_url": "https://api.securityscorecard.io/companies/threatq.com/history/events/2022-05-28/issues/service_vuln_host_info?group_status=departed"
}
]
}
ThreatQuotient provides the following default mapping for this feed:
The details key is data pulled from the SecurityScorecard - Generic Request supplemental feed, using this URL: https://api.securityscorecard.io/companies/{{domain}}/factors.
| Feed Data Path | ThreatQ Entity | ThreatQ Object Type or Attribute Key | Published Date | Examples | Notes |
|---|---|---|---|---|---|
.vulnerability_id |
Indicator Value | CVE | .effective_date |
CVE-2022-23943 |
extracted from SecurityScorecard - Generic Request (Supplemental) |
.vulnerability_description |
Indicator Attribute | Description | .effective_date |
Product: Apache httpd\nSeverity: HIGH\nOut-of-bounds Write vulnerability in mod_sed of Apache HTTP Server allows an attacker to overwrite heap memory with possibly attacker provided data. This issue affects Apache HTTP Server 2.4 version 2.4.52 and prior versions. |
extracted from SecurityScorecard - Generic Request (Supplemental) |
.vulnerability_url |
Indicator Attribute | External Reference | .effective_date |
https://nvd.nist.gov/vuln/detail/CVE-2022-23943 |
extracted from SecurityScorecard - Generic Request (Supplemental) |
.details_url |
Asset Value | N/A | N/A | threatq.com |
domain is extracted from detail_url after /companies/ |
.group_status,.factor,.issue_type,.severity |
Event Value | N/A | .date |
SecurityScorecard Departed Event: PATCHING CADENCE - service_vuln_host_info (Severity: Info) |
SecurityScorecard {{.group_status}} Event: {{.factor}} - {{.issue_type}} (Severity: {{.severity}}) |
.details |
Event Description | Description | .date |
SecurityScorecard - Generic Request (Supplemental) sample response entries |
The evidence is put into pre tags for the description |
.event_type |
Event Type | N/A | .date |
Scorecard Issue |
map[issues] see below Event Table Mapping |
.detail_url |
Event Attribute | Domain | N/A | threatq.com |
N/A |
.event_type |
Event Attribute | Event Type | N/A | issues |
N/A |
.group_status |
Event Attribute | Group Status | N/A | departed |
N/A |
.issue_count |
Event Attribute | Issue Count | N/A | 1 |
N/A |
.total_score_impact |
Event Attribute | Total Score Impact | N/A | 0 |
N/A |
.issue_type |
Event Attribute | Issue Type | N/A | service_vuln_host_info |
N/A |
.severity |
Event Attribute | Severity | N/A | info |
N/A |
.factor |
Event Attribute | Factor | N/A | patching_cadence |
N/A |
Event Table Mapping
ThreatQuotient provides the follow Event mapping:
| Key | Value |
|---|---|
issues |
Scorecard Issue |
breach |
Breach |
recalibration |
Scorecard Recalibration |
SecurityScorecard - Get Factors (Supplemental)
This supplemental feed fetches "factors" for a given site's scorecard
GET https://api.securityscorecard.io/companies/{{domain}}/factors
Sample Response:
{
"entries": [
{
"name": "application_security",
"score": 71,
"grade": "C",
"grade_url": "https://s3.amazonaws.com/ssc-static/grades/factor_c.svg",
"issue_summary": [
{
"type": "csp_no_policy_v2",
"count": 1,
"severity": "medium",
"total_score_impact": 1.8012391326456623,
"detail_url": "https://api.securityscorecard.io/companies/threatq.com/issues/csp_no_policy_v2/"
},
{
"type": "csp_too_broad_v2",
"count": 4,
"severity": "low",
"total_score_impact": 2.2783649729965845,
"detail_url": "https://api.securityscorecard.io/companies/threatq.com/issues/csp_too_broad_v2/"
}
]
}
]
}
The mapping for this supplemental will be handled by the primary feed.
SecurityScorecard - Generic Request (Supplemental)
The Generic Requests supplemental feed fetches any data from the SecurityScorecard API.
GET {{url}}
Sample Response:
Using url=https://api.securityscorecard.io/companies/threatq.com/history/events/2022-05-28/issues/service_vuln_host_info?group_status=departed:
{
"entries": [
{
"parent_domain": "threatq.com",
"count": 1,
"first_seen_time": "2022-05-25T02:43:02.000Z",
"last_seen_time": "2022-05-25T02:43:02.000Z",
"vulnerability_id": "CVE-2022-23943",
"vulnerability_url": "https://nvd.nist.gov/vuln/detail/CVE-2022-23943",
"vulnerability_description": "Product: Apache httpd\nSeverity: HIGH\nOut-of-bounds Write vulnerability in mod_sed of Apache HTTP Server allows an attacker to overwrite heap memory with possibly attacker provided data. This issue affects Apache HTTP Server 2.4 version 2.4.52 and prior versions.",
"vulnerability_publish_date": "2022-03-14T00:00:00.000Z",
"connection_attributes": {
"protocol": "tcp",
"dst_ip": "52.86.146.20",
"dst_port": 443,
"dst_host": "ec2-52-86-146-20.compute-1.amazonaws.com"
},
"effective_date": "2022-05-28T00:00:00.000Z",
"group_status": "departed",
"issue_id": "9651bf4c-6206-59ad-8c0f-9cba63ecf6b0"
}
]
}
The response for this supplemental feed will vary based on the URL. The mapping for this supplemental will be handled by the secondary feed.
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.
Summary Reports
| Metric | Result |
|---|---|
| Run Time | 1 minute |
| Assets | 1 |
| Asset Attributes | 8 |
Events
| Metric | Result |
|---|---|
| Run Time | 1 minute |
| Assets | 1 |
| Events | 42 |
| Event Attributes | 314 |
| Indicators | 21 |
| Indicator Attributes | 42 |
Change Log
- Version 1.0.1
- Changed the Scorecard Domains (Sites) configuration parameter from a single line to a textarea field for both feeds. This allows you to enter multiple domains into the parameter field. This parameter was previously capped at a 255 character limit due to it being a single line field.
- Added the following configuration parameters for both feeds:
- Enable SSL Certificate Verification - determine if the feed should validate the host-provided SSL certificate.
- Disable Proxies - determine if the feed should honor proxies set in the ThreatQ UI.
- Updated the minimum ThreatQ version to 5.12.0.
- Version 1.0.0
- Initial release
PDF Guides
| Document | ThreatQ Version |
|---|---|
| SecurityScorecard CDF Guide v1.0.1 | 5.12.0 or Greater |
| SecurityScorecard CDF Guide v1.0.0 | 5.6 or Greater |