Skip to content

Latest commit

 

History

History
632 lines (517 loc) · 17.4 KB

diff.md

File metadata and controls

632 lines (517 loc) · 17.4 KB

Bomly Diff JSON Schema Reference

Complete reference for the bomly diff JSON output.

Document

Field Type Description
schema_version string
command string
project ProjectDescriptor
comparison DiffComparison
results DiffResults
summary DiffSummary
packages Array<Package>
audit DiffAudit
warnings Array<DetectorWarning>
metadata Metadata

Types

Affected

Field Type Description
ranges Array<VersionRange>
versions Array<string>
ecosystem_specific object
database_specific object

AffectedSymbol

Field Type Description
symbol string
kind string
package string
module string
definition SourcePosition

Assertions

Field Type Description
description string
homepage string
supplier Contact
originator Contact
external_references Array<ExternalReference>
cpes Array<string>
digests Array<Digest>
licenses Array<PackageLicense>
copyright string

AuditSummary

Field Type Description
critical integer
high integer
medium integer
low integer
unknown integer
total integer

CVSSScore

Field Type Description
vector string
score number
version string
source string

CWE

Field Type Description
cve string
id string
source string
type string

CallFrame

Field Type Description
function string
package string
receiver string
position SourcePosition

CallPath

Field Type Description
sink AffectedSymbol
frames Array<CallFrame>

Contact

Field Type Description
kind string
name string
url string

Coordinates

Field Type Description
purl string
ecosystem string
package_manager string
type string
org string
name string
version string
language string

DependencyOrigin

Field Type Description
artifact_url string
repository string
revision string

DetectorWarning

Field Type Description
type string
code string
source string
subproject string
manifest string
message string

DiffAudit

Field Type Description
introduced Array<Finding>
resolved Array<Finding>
persisted Array<Finding>
audit_summary AuditSummary

DiffChangedPackage

Field Type Description
after PackageRef
before PackageRef

DiffComparison

Field Type Description
base string
head string

DiffDependencyResults

Field Type Description
added Array<DiffPackageChange>
removed Array<DiffPackageChange>
changed Array<DiffChangedPackage>
transitions Array<DiffDependencyTransition>

DiffDependencyTransition

Field Type Description
before DiffDependencyTransitionState
after DiffDependencyTransitionState
changed_fields Array<string>

DiffDependencyTransitionState

Field Type Description
id string
name string
version string
purl string
scope string
relationship string
source string
registry_eligible boolean

DiffLicenseChange

Field Type Description
package PackageRef
licenses Array<PackageLicense>

DiffLicenseDelta

Field Type Description
package PackageRef
before Array<PackageLicense>
after Array<PackageLicense>

DiffLicenseResults

Field Type Description
added Array<DiffLicenseChange>
removed Array<DiffLicenseChange>
changed Array<DiffLicenseDelta>

DiffManifestResult

Field Type Description
status string
path string
kind string
subproject string
ecosystem string
package_manager string
added Array<DiffPackageChange>
removed Array<DiffPackageChange>
changed Array<DiffChangedPackage>
transitions Array<DiffDependencyTransition>

DiffPackageChange

Field Type Description
package PackageRef

DiffResults

Field Type Description
dependencies DiffDependencyResults
licenses DiffLicenseResults
vulnerabilities DiffVulnerabilityResults
manifests Array<DiffManifestResult>

DiffSummary

Field Type Description
added_manifest_count integer
changed_manifest_count integer
removed_manifest_count integer
unchanged_manifest_count integer
added_package_count integer
changed_package_count integer
transitioned_package_count integer
removed_package_count integer
exact_match_count integer
fuzzy_match_count integer
unmatched_package_count integer

DiffVulnerabilityChange

Field Type Description
package PackageRef
vulnerability Vulnerability

DiffVulnerabilityResults

Field Type Description
added Array<DiffVulnerabilityChange>
removed Array<DiffVulnerabilityChange>
persisted Array<DiffVulnerabilityChange>

Digest

Field Type Description
algorithm string
value string
subject string

EPSSScore

Field Type Description
cve string
epss number
percentile number
date string

ExternalReference

Field Type Description
category string
type string
locator string
comment string
hashes Array<Digest>

Finding

Field Type Description
id string
kind string
title string
severity string
policy_status string
reasons Array<string>
source string
auditor string
rule_id string
vex_status string
vex_justification string
package_ref string
dependency_refs Array<string>
vulnerability_id string
decision FindingPolicyDecision

FindingPolicyDecision

Field Type Description
status string
source string
reason string

FixAvailable

Field Type Description
version string
date string
kind string

KnownExploited

Field Type Description
cve string
vendor_project string
product string
date_added string
required_action string
due_date string
known_ransomware_campaign_use string
notes string
urls Array<string>
cwes Array<string>

Metadata

Field Type Description
duration_ms integer
reachability_enabled boolean
scorecard_enabled boolean
analyzer_runs Array<string>
analyzer_stats object

Package

Field Type Description
purl string
ecosystem string
package_manager string
type string
org string
name string
version string
language string
description string
homepage string
supplier Contact
originator Contact
external_references Array<ExternalReference>
cpes Array<string>
digests Array<Digest>
licenses Array<PackageLicense>
copyright string
id string
resolved_url string
detected_origins Array<DependencyOrigin>
vulnerabilities Array<Vulnerability>
attestations Array<PackageAttestation>
scorecard PackageScorecard
eol PackageEOL
remediation PackageRemediation
matched boolean
metadata object

PackageAttestation

Field Type Description
predicate_type string
source string
url string
digest Digest
issuer string
verified boolean

PackageEOL

Field Type Description
source string
cycle string
eol boolean
eol_date string
latest_version string
release_date string
supported boolean

PackageLicense

Field Type Description
value string
spdx_expression string
type string
source string
name string
extracted_text string

PackageLocation

Field Type Description
real_path string
access_path string
position SourcePosition
module_root string
scopes Array<string>
relationship string

PackageRef

Field Type Description
name string
version string
scope string
purl string
id string
metadata object
locations Array<PackageLocation>
licenses Array<PackageLicense>
vulnerabilities Array<Vulnerability>
scorecard PackageScorecard
relationship string
direct boolean

PackageRemediation

Field Type Description
status string
recommended_version string
suggestions Array<PackageRemediationSuggestion>

PackageRemediationSuggestion

Field Type Description
affected_dependency_refs Array<string>
suggested_action_dependency_ref string
manifest_path string
action string
override_advice string

PackageScorecard

Field Type Description
source string
repository string
commitSha string
scorecardVersion string
runDate string (RFC 3339 timestamp)
aggregateScore number
checks Array<PackageScorecardCheck>

PackageScorecardCheck

Field Type Description
name string
score integer
reason string
documentation string

ProjectDescriptor

Field Type Description
name string
path string
target_type string
target_ref string
ecosystem string
package_manager string

RangeEvent

Field Type Description
introduced string
fixed string
last_affected string
limit string

Reachability

Field Type Description
status string
tier string
analyzer string
reason string
symbols Array<AffectedSymbol>
call_paths Array<CallPath>
hops integer
confidence string
dynamic_imports_detected boolean
analyzed_at string
evidence Array<ReachabilityEvidence>

ReachabilityEvidence

Field Type Description
module_root string
dependency_refs Array<string>
status string
tier string
analyzer string
reason string
symbols Array<AffectedSymbol>
call_paths Array<CallPath>
hops integer
confidence string
dynamic_imports_detected boolean
analyzed_at string

Reference

Field Type Description
url string
type string

Severity

Field Type Description
type string
score string

SourcePosition

Field Type Description
file string
line integer
column integer
end_line integer

VersionRange

Field Type Description
type string
repo string
events Array<RangeEvent>

Vulnerability

Field Type Description
id string
aliases Array<string>
related Array<string>
summary string
details string
severity Array<Severity>
affected Array<Affected>
references Array<Reference>
published string
modified string
withdrawn string
database_specific object
source string
data_source string
namespace string
title string
reasons Array<string>
parsed_severity string
severity_source string
cvss Array<CVSSScore>
epss Array<EPSSScore>
cwes Array<CWE>
kev_exploited boolean
known_exploited Array<KnownExploited>
risk_score number
fix_state string
fixed_in string
fixed_versions Array<string>
fix_available Array<FixAvailable>
affected_version_range string
cpes Array<string>
affected_symbols Array<AffectedSymbol>
reachability Reachability
analysis VulnerabilityAnalysis
recommendation string

VulnerabilityAnalysis

Field Type Description
state string
justification string
response Array<string>
detail string
first_issued string
last_updated string