Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions lib/HTMLTemplate2_0.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import {
DOCUMENT_NOTE,
REFERENCE,
REMEDIATION,
SCOPE,
THREAT,
URL,
VULNERABILITY_NOTE,
Expand Down Expand Up @@ -41,6 +42,7 @@ export default function HTMLTemplate2_0({ document }) {
document_note: DOCUMENT_NOTE,
acknowledgment: ACKNOWLEDGEMENT,
reference: REFERENCE,
scope: SCOPE,
url: URL,
})
}
4 changes: 4 additions & 0 deletions lib/HTMLTemplate2_1.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@ import Mustache from 'mustache'
import Template from './templates/csaf_2_1.js'
import {
ACKNOWLEDGEMENT,
CONTACT,
DOCUMENT_NOTE,
REFERENCE,
REMEDIATION,
SCOPE,
THREAT,
URL,
VULNERABILITY_NOTE,
Expand Down Expand Up @@ -43,6 +45,8 @@ export default function HTMLTemplate2_1({ document }) {
document_note: DOCUMENT_NOTE,
acknowledgment: ACKNOWLEDGEMENT,
reference: REFERENCE,
scope: SCOPE,
contact: CONTACT,
url: URL,
})
}
213 changes: 206 additions & 7 deletions lib/enrichDocument.js
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,20 @@ const collectProductIds = (document) => {
}
}

const productPaths = document.product_tree?.product_paths
if (productPaths) {
for (let i = 0; i < productPaths.length; ++i) {
const fullProductName = productPaths[i]?.full_product_name
if (fullProductName?.product_id) {
entries.push({
id: fullProductName.product_id,
name: fullProductName.name ?? '',
instancePath: `/product_tree/product_paths/${i}/full_product_name/product_id`,
})
}
}
}

const branches = document.product_tree?.branches
if (branches) {
traverseBranches(branches, entries, '/product_tree/branches')
Expand Down Expand Up @@ -147,8 +161,10 @@ const collectGroupIds = (document) => {

/**
* @param {any} document
* @param {Map<string, {id: string, name: string}>} productIds
* @param {Map<string, {id: string, name: string}>} groupIds
*/
const addDocumentNotesPreviewAttributes = (document) => {
const addDocumentNotesPreviewAttributes = (document, productIds, groupIds) => {
const summary = []
const details = []
const general = []
Expand All @@ -162,6 +178,7 @@ const addDocumentNotesPreviewAttributes = (document) => {
if (notes) {
for (let i = 0; i < notes.length; ++i) {
const note = notes[i]
extendScopedItem(note, productIds, groupIds)
switch (note.category) {
case 'summary':
summary.push(note)
Expand Down Expand Up @@ -202,8 +219,14 @@ const addDocumentNotesPreviewAttributes = (document) => {

/**
* @param {any} vulnerability
* @param {Map<string, {id: string, name: string}>} productIds
* @param {Map<string, {id: string, name: string}>} groupIds
*/
const addVulnerabilityNotesPreviewAttributes = (vulnerability) => {
const addVulnerabilityNotesPreviewAttributes = (
vulnerability,
productIds,
groupIds,
) => {
const summary = []
const details = []
const general = []
Expand All @@ -217,6 +240,7 @@ const addVulnerabilityNotesPreviewAttributes = (vulnerability) => {
if (notes) {
for (let i = 0; i < notes.length; ++i) {
const note = notes[i]
extendScopedItem(note, productIds, groupIds)
switch (note.category) {
case 'summary':
summary.push(note)
Expand Down Expand Up @@ -378,6 +402,23 @@ const extendRemediationOrThreat = (
}
}

/**
* Like `extendRemediationOrThreat`, but for items where `product_ids` and
* `group_ids` are optional extras (e.g. CSAF 2.1 notes, vulnerability ids,
* first known exploitation dates, involvement actions): items without either
* property are left untouched, so documents that don't use them (all of CSAF
* 2.0) keep their exact shape.
*
* @param {any} item
* @param {Map<string, {id: string, name: string}>} extProductIds
* @param {Map<string, {id: string, name: string}>} extGroupIds
*/
const extendScopedItem = (item, extProductIds, extGroupIds) => {
if (item && (item.product_ids || item.group_ids)) {
extendRemediationOrThreat(item, extProductIds, extGroupIds)
}
}

/**
* Sorts by `date` descending (most recent first), with entries that have no
* `date` at all (a valid, optional field on CSAF remediations/threats)
Expand Down Expand Up @@ -410,8 +451,10 @@ const addRemediationsPreviewAttributes = (
groupIds,
) => {
const vendorFix = []
const optionalPatch = []
const mitigation = []
const workaround = []
const fixPlanned = []
const noneAvailable = []
const noFixPlanned = []
const unknown = []
Expand All @@ -424,12 +467,18 @@ const addRemediationsPreviewAttributes = (
case 'vendor_fix':
vendorFix.push(remediation)
break
case 'optional_patch':
optionalPatch.push(remediation)
break
case 'mitigation':
mitigation.push(remediation)
break
case 'workaround':
workaround.push(remediation)
break
case 'fix_planned':
fixPlanned.push(remediation)
break
case 'none_available':
noneAvailable.push(remediation)
break
Expand All @@ -443,8 +492,10 @@ const addRemediationsPreviewAttributes = (
}

vulnerability.remediations_vendor_fix = vendorFix.sort(sortByDate)
vulnerability.remediations_optional_patch = optionalPatch.sort(sortByDate)
vulnerability.remediations_mitigation = mitigation.sort(sortByDate)
vulnerability.remediations_workaround = workaround.sort(sortByDate)
vulnerability.remediations_fix_planned = fixPlanned.sort(sortByDate)
vulnerability.remediations_none_available = noneAvailable.sort(sortByDate)
vulnerability.remediations_no_fix_planned = noFixPlanned.sort(sortByDate)
vulnerability.remediations_unknown = unknown.sort(sortByDate)
Expand Down Expand Up @@ -746,7 +797,132 @@ const addProductStatusPreviewAttributesV2_1 = (
extendedMetricIds,
productIds,
)
productStatus.unknown = extendProductStatus(
productStatus.unknown,
extendedMetricIds,
productIds,
)
}
}

/**
* Resolves the CSAF 2.1 `document.involvement` references into display names:
* entity/entity group refs in actions and entity ids in entity groups become
* `{id, name}` pairs (falling back to the id when the entity has no `name`),
* and product/group ids of actions are resolved like for remediations.
*
* @param {any} document
* @param {Map<string, {id: string, name: string}>} productIds
* @param {Map<string, {id: string, name: string}>} groupIds
*/
const addInvolvementPreviewAttributes = (document, productIds, groupIds) => {
const involvement = document?.involvement
if (!involvement) return

/** @type {Map<string, string>} */
const entityNames = new Map()
for (const entity of involvement.entities ?? []) {
entity.display_name = entity.name ?? entity.entity_id
entityNames.set(entity.entity_id, entity.display_name)
}
for (const group of involvement.entity_groups ?? []) {
entityNames.set(group.entity_group_id, group.name ?? group.entity_group_id)
}

/** @param {string[] | undefined} ids */
const toEntityRefs = (ids) =>
ids
? ids
.filter(Boolean)
.map((id) => ({ id, name: entityNames.get(id) ?? id }))
: undefined

for (const group of involvement.entity_groups ?? []) {
group.entity_ids = toEntityRefs(group.entity_ids)
}
for (const action of involvement.actions ?? []) {
action.acting_entity_refs = toEntityRefs(action.acting_entity_refs)
action.receiving_entity_refs = toEntityRefs(action.receiving_entity_refs)
extendScopedItem(action, productIds, groupIds)
}
}

/**
* Condenses a (SSVC v2 selection list) into plain strings the template can
* print without having to pick between optional `name` and required `key`
* fields itself.
*
* @param {any} ssvc
*/
const summarizeSsvc = (ssvc) => ({
timestamp: ssvc.timestamp,
selections: (ssvc.selections ?? []).map((/** @type {any} */ selection) => ({
label: selection.name ?? selection.key,
namespace: selection.namespace,
version: selection.version,
values: (selection.values ?? [])
.map((/** @type {any} */ value) => value.name ?? value.key)
.join(', '),
})),
})

/**
* Collects the parts of CSAF 2.1 `vulnerability.metrics[]` that are not CVSS
* (which is already shown in the product status tables): the qualitative
* severity rating, EPSS and SSVC v2 data, together with the products and
* source they belong to. Written to `vulnerability.metrics_details`.
*
* @param {any} vulnerability
* @param {Map<string, {id: string, name: string}>} productIds
*/
const addMetricsDetailsPreviewAttributes = (vulnerability, productIds) => {
const details = []
for (const metric of vulnerability.metrics ?? []) {
const content = metric?.content
if (!content) continue
const rating = content.qualitative_severity_rating
const epss = content.epss
const ssvc = content.ssvc_v2
if (!rating && !epss && !ssvc) continue
details.push({
products: (metric.products ?? [])
.filter(Boolean)
.map((/** @type {string} */ id) => ({
id,
name: productIds.get(id)?.name || id,
})),
source: metric.source,
qualitative_severity_rating: rating,
epss,
ssvc: ssvc ? summarizeSsvc(ssvc) : undefined,
})
}
vulnerability.metrics_details = details
}

/**
* Resolves product/group ids of the CSAF 2.1 vulnerability properties that
* can be scoped to products (`ids`, `first_known_exploitation_dates`) and
* collects the `ids` that actually are scoped in `vulnerability.ids_scoped`.
*
* @param {any} vulnerability
* @param {Map<string, {id: string, name: string}>} productIds
* @param {Map<string, {id: string, name: string}>} groupIds
*/
const addVulnerabilityScopePreviewAttributes = (
vulnerability,
productIds,
groupIds,
) => {
for (const item of vulnerability.first_known_exploitation_dates ?? []) {
extendScopedItem(item, productIds, groupIds)
}
const scopedIds = []
for (const id of vulnerability.ids ?? []) {
extendScopedItem(id, productIds, groupIds)
if (id?.product_ids?.length || id?.group_ids?.length) scopedIds.push(id)
}
vulnerability.ids_scoped = scopedIds
}

// ---------------------------------------------------------------------------
Expand All @@ -769,7 +945,11 @@ export function enrichDocumentV2_0(document) {
templateDoc.document.max_base_score = retrieveMaxBaseScoreV2_0(
templateDoc.vulnerabilities,
)
addDocumentNotesPreviewAttributes(templateDoc.document)
addDocumentNotesPreviewAttributes(
templateDoc.document,
productIds,
groupIds,
)
}

if (templateDoc.product_tree) {
Expand All @@ -787,7 +967,11 @@ export function enrichDocumentV2_0(document) {
)
addRemediationsPreviewAttributes(vulnerability, productIds, groupIds)
addThreatsPreviewAttributes(vulnerability, productIds, groupIds)
addVulnerabilityNotesPreviewAttributes(vulnerability)
addVulnerabilityNotesPreviewAttributes(
vulnerability,
productIds,
groupIds,
)
}
}

Expand All @@ -801,7 +985,7 @@ export function enrichDocumentV2_0(document) {

/**
* Enriches a CSAF 2.1 document for use with HTMLTemplate2_1.
* Uses `vulnerability.metrics[i].content.cvss_v3` for CVSS data.
* Uses `vulnerability.metrics[i].content` (CVSS v2/v3/v4) for CVSS data.
*
* @param {any} document
* @returns {{ document: any }}
Expand All @@ -819,7 +1003,12 @@ export function enrichDocumentV2_1(document) {
templateDoc.document.max_base_score_cvss_label = maxBaseScoreCvssVersion
? `CVSSv${maxBaseScoreCvssVersion}`
: 'CVSS'
addDocumentNotesPreviewAttributes(templateDoc.document)
addDocumentNotesPreviewAttributes(
templateDoc.document,
productIds,
groupIds,
)
addInvolvementPreviewAttributes(templateDoc.document, productIds, groupIds)
}

if (templateDoc.product_tree) {
Expand All @@ -837,7 +1026,17 @@ export function enrichDocumentV2_1(document) {
)
addRemediationsPreviewAttributes(vulnerability, productIds, groupIds)
addThreatsPreviewAttributes(vulnerability, productIds, groupIds)
addVulnerabilityNotesPreviewAttributes(vulnerability)
addVulnerabilityNotesPreviewAttributes(
vulnerability,
productIds,
groupIds,
)
addVulnerabilityScopePreviewAttributes(
vulnerability,
productIds,
groupIds,
)
addMetricsDetailsPreviewAttributes(vulnerability, productIds)
}
}

Expand Down
12 changes: 12 additions & 0 deletions lib/markdownParser.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ const { get, set } = lodash
const markdownFields = [
'document.acknowledgments.*.summary',
'document.distribution.text',
'document.involvement.actions.*.summary',
'document.involvement.entities.*.contact.details',
'document.involvement.entity_groups.*.summary',
'document.notes.*.text',
'document.publisher.contact.details',
'document.publisher.issuing_authority',
'document.references.*.summary',
'document.tracking.revision_history.*.summary',
Expand All @@ -36,6 +40,14 @@ const markdownFields = [
// as raw, unrendered markdown wherever it's referenced via group_ids.
'vulnerabilities.*.remediations.*.group_ids.*.name',
'vulnerabilities.*.threats.*.group_ids.*.name',
// CSAF 2.1: same reasoning as above, for every other item enrichDocument
// resolves `group_ids` on (notes, involvement actions, vulnerability ids
// and first known exploitation dates).
'document.notes.*.group_ids.*.name',
'document.involvement.actions.*.group_ids.*.name',
'vulnerabilities.*.notes.*.group_ids.*.name',
'vulnerabilities.*.ids.*.group_ids.*.name',
'vulnerabilities.*.first_known_exploitation_dates.*.group_ids.*.name',
]

/**
Expand Down
Loading
Loading