|
| 1 | +import * as cvss2 from '../../lib/shared/cvss2.js' |
| 2 | +import * as cvss3 from '../../lib/shared/cvss3.js' |
| 3 | +import * as cvss4 from '../../lib/shared/cvss4.js' |
| 4 | +import Ajv from 'ajv/dist/jtd.js' |
| 5 | + |
| 6 | +/** @typedef {import('ajv/dist/jtd.js').JTDDataType<typeof inputSchema>} InputSchema */ |
| 7 | + |
| 8 | +/** @typedef {InputSchema['vulnerabilities'][number]} Vulnerability */ |
| 9 | + |
| 10 | +/** @typedef {NonNullable<Vulnerability['metrics']>[number]} Metric */ |
| 11 | + |
| 12 | +/** @typedef {NonNullable<Metric['content']>} MetricContent */ |
| 13 | + |
| 14 | +const inputSchema = /** @type {const} */ ({ |
| 15 | + additionalProperties: true, |
| 16 | + properties: { |
| 17 | + vulnerabilities: { |
| 18 | + elements: { |
| 19 | + additionalProperties: true, |
| 20 | + optionalProperties: { |
| 21 | + metrics: { |
| 22 | + elements: { |
| 23 | + additionalProperties: true, |
| 24 | + optionalProperties: { |
| 25 | + content: { |
| 26 | + additionalProperties: true, |
| 27 | + optionalProperties: { |
| 28 | + cvss_v2: { |
| 29 | + additionalProperties: true, |
| 30 | + optionalProperties: { |
| 31 | + vectorString: { type: 'string' }, |
| 32 | + version: { type: 'string' }, |
| 33 | + }, |
| 34 | + }, |
| 35 | + cvss_v3: { |
| 36 | + additionalProperties: true, |
| 37 | + optionalProperties: { |
| 38 | + vectorString: { type: 'string' }, |
| 39 | + version: { type: 'string' }, |
| 40 | + }, |
| 41 | + }, |
| 42 | + cvss_v4: { |
| 43 | + additionalProperties: true, |
| 44 | + optionalProperties: { |
| 45 | + vectorString: { type: 'string' }, |
| 46 | + version: { type: 'string' }, |
| 47 | + }, |
| 48 | + }, |
| 49 | + }, |
| 50 | + }, |
| 51 | + }, |
| 52 | + }, |
| 53 | + }, |
| 54 | + }, |
| 55 | + }, |
| 56 | + }, |
| 57 | + }, |
| 58 | +}) |
| 59 | +const ajv = new Ajv() |
| 60 | +const validateInput = ajv.compile(inputSchema) |
| 61 | + |
| 62 | +/** @type { Record<string, { jsonName:string, optionsByKey:Record<string, string>}>} */ |
| 63 | +const cvssV3MappingByMetricKey = Object.fromEntries( |
| 64 | + cvss3.mapping.map((mapping) => { |
| 65 | + return [ |
| 66 | + mapping[1], |
| 67 | + { |
| 68 | + jsonName: mapping[0], |
| 69 | + optionsByKey: Object.fromEntries( |
| 70 | + Object.entries(mapping[2]).map(([key, value]) => [value, key]) |
| 71 | + ), |
| 72 | + }, |
| 73 | + ] |
| 74 | + }) |
| 75 | +) |
| 76 | + |
| 77 | +/** @type { Record<string, { jsonName:string, optionsByKey:Record<string, string>}>} */ |
| 78 | +const cvssV2MappingByMetricKey = Object.fromEntries( |
| 79 | + cvss2.mapping.map((mapping) => { |
| 80 | + return [ |
| 81 | + mapping[1], |
| 82 | + { |
| 83 | + jsonName: mapping[0], |
| 84 | + optionsByKey: Object.fromEntries( |
| 85 | + Object.entries(mapping[2]).map(([key, value]) => [value.id, key]) |
| 86 | + ), |
| 87 | + }, |
| 88 | + ] |
| 89 | + }) |
| 90 | +) |
| 91 | + |
| 92 | +/** |
| 93 | + * @param {{optionName: string, optionValue: string, optionKey: string}[]} optionsArray |
| 94 | + * @return {Record<string, string>} |
| 95 | + */ |
| 96 | +function convertOptionsArrayToObject(optionsArray) { |
| 97 | + /** @type {Record<string, string>} */ |
| 98 | + const result = {} |
| 99 | + optionsArray.forEach((option) => { |
| 100 | + result[option.optionKey] = option.optionValue |
| 101 | + }) |
| 102 | + return result |
| 103 | +} |
| 104 | + |
| 105 | +/** @type { Record<string, { jsonName:string, optionsByKey:Record<string, string>}>} */ |
| 106 | +const cvssV4MappingByMetricKey = Object.fromEntries( |
| 107 | + cvss4.flatMetrics.map((flatMetric) => { |
| 108 | + return [ |
| 109 | + flatMetric.metricShort, |
| 110 | + { |
| 111 | + jsonName: flatMetric.jsonName, |
| 112 | + optionsByKey: convertOptionsArrayToObject(flatMetric.options), |
| 113 | + }, |
| 114 | + ] |
| 115 | + }) |
| 116 | +) |
| 117 | + |
| 118 | +/** |
| 119 | + * @param {Metric} metric |
| 120 | + */ |
| 121 | +function validateCvss2(metric) { |
| 122 | + if (typeof metric.content?.cvss_v2?.vectorString === 'string') { |
| 123 | + return validateCVSSAttributes( |
| 124 | + cvssV2MappingByMetricKey, |
| 125 | + metric.content.cvss_v2 |
| 126 | + ) |
| 127 | + } else { |
| 128 | + return [] |
| 129 | + } |
| 130 | +} |
| 131 | + |
| 132 | +/** |
| 133 | + * @param {Metric} metric |
| 134 | + */ |
| 135 | +function validateCvss3(metric) { |
| 136 | + if ( |
| 137 | + typeof metric?.content?.cvss_v3?.vectorString === 'string' && |
| 138 | + (metric.content.cvss_v3.version === '3.1' || |
| 139 | + metric.content.cvss_v3.version === '3.0') |
| 140 | + ) { |
| 141 | + return validateCVSSAttributes( |
| 142 | + cvssV3MappingByMetricKey, |
| 143 | + metric.content.cvss_v3 |
| 144 | + ) |
| 145 | + } else { |
| 146 | + return [] |
| 147 | + } |
| 148 | +} |
| 149 | + |
| 150 | +/** |
| 151 | + * @param {Metric} metric |
| 152 | + */ |
| 153 | +function validateCvss4(metric) { |
| 154 | + if (typeof metric?.content?.cvss_v4?.vectorString === 'string') { |
| 155 | + return validateCVSSAttributes( |
| 156 | + cvssV4MappingByMetricKey, |
| 157 | + metric.content.cvss_v4 |
| 158 | + ) |
| 159 | + } else { |
| 160 | + return [] |
| 161 | + } |
| 162 | +} |
| 163 | + |
| 164 | +/** |
| 165 | + * @param {unknown} doc |
| 166 | + */ |
| 167 | +export function mandatoryTest_6_1_10(doc) { |
| 168 | + /** @type {Array<{ message: string; instancePath: string }>} */ |
| 169 | + const errors = [] |
| 170 | + |
| 171 | + if (!validateInput(doc)) { |
| 172 | + return { errors, isValid: true } |
| 173 | + } |
| 174 | + |
| 175 | + if (Array.isArray(doc.vulnerabilities)) { |
| 176 | + /** @type {Array<Vulnerability>} */ |
| 177 | + const vulnerabilities = doc.vulnerabilities |
| 178 | + vulnerabilities.forEach((vulnerability, vulnerabilityIndex) => { |
| 179 | + if (!Array.isArray(vulnerability.metrics)) return |
| 180 | + /** @type {Array<Metric>} */ |
| 181 | + const metrics = vulnerability.metrics |
| 182 | + metrics.forEach((metric, metricIndex) => { |
| 183 | + validateCvss2(metric).forEach((attributeKey) => { |
| 184 | + errors.push({ |
| 185 | + instancePath: `/vulnerabilities/${vulnerabilityIndex}/metrics/${metricIndex}/content/cvss_v2/${attributeKey}`, |
| 186 | + message: 'value is not consistent with the vector string', |
| 187 | + }) |
| 188 | + }) |
| 189 | + |
| 190 | + validateCvss3(metric).forEach((attributeKey) => { |
| 191 | + errors.push({ |
| 192 | + instancePath: `/vulnerabilities/${vulnerabilityIndex}/metrics/${metricIndex}/content/cvss_v3/${attributeKey}`, |
| 193 | + message: 'value is not consistent with the vector string', |
| 194 | + }) |
| 195 | + }) |
| 196 | + |
| 197 | + validateCvss4(metric).forEach((attributeKey) => { |
| 198 | + errors.push({ |
| 199 | + instancePath: `/vulnerabilities/${vulnerabilityIndex}/metrics/${metricIndex}/content/cvss_v4/${attributeKey}`, |
| 200 | + message: 'value is not consistent with the vector string', |
| 201 | + }) |
| 202 | + }) |
| 203 | + }) |
| 204 | + }) |
| 205 | + } |
| 206 | + |
| 207 | + return { errors, isValid: errors.length === 0 } |
| 208 | +} |
| 209 | + |
| 210 | +/** |
| 211 | + * validate the cvss vector against the cvss properties |
| 212 | + * @param {Record<string, { jsonName:string, optionsByKey:Record<string, string>}>}mappingByMetricKey cvss version specific mapping |
| 213 | + * @param {Record<string, unknown>} cvss cvss object |
| 214 | +
|
| 215 | + */ |
| 216 | +function validateCVSSAttributes(mappingByMetricKey, cvss) { |
| 217 | + const vectorString = /** @type {string} */ (cvss.vectorString) |
| 218 | + const vectorValues = vectorString.split('/').slice(1) |
| 219 | + /** |
| 220 | + * @type {string[]} |
| 221 | + */ |
| 222 | + const invalidKeys = [] |
| 223 | + vectorValues.forEach((vectorValue) => { |
| 224 | + const [vectorMetricKey, vectorOptionKey] = vectorValue.split(':') |
| 225 | + const mapping = mappingByMetricKey[vectorMetricKey] |
| 226 | + if (mapping) { |
| 227 | + const metricOptionValue = cvss[mapping.jsonName] |
| 228 | + if (typeof metricOptionValue == 'string') { |
| 229 | + const expectedOptionValue = mapping.optionsByKey[vectorOptionKey] |
| 230 | + if (metricOptionValue !== expectedOptionValue) { |
| 231 | + invalidKeys.push(mapping.jsonName) |
| 232 | + } |
| 233 | + } |
| 234 | + } |
| 235 | + }) |
| 236 | + return invalidKeys |
| 237 | +} |
0 commit comments