org.owasp.dependencycheck.reporting.ReportTool Maven / Gradle / Ivy
/*
* This file is part of dependency-check-core.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Copyright (c) 2018 Jeremy Long. All Rights Reserved.
*/
package org.owasp.dependencycheck.reporting;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.owasp.dependencycheck.dependency.Dependency;
import org.owasp.dependencycheck.dependency.Vulnerability;
import org.owasp.dependencycheck.dependency.naming.CpeIdentifier;
import org.owasp.dependencycheck.dependency.naming.GenericIdentifier;
import org.owasp.dependencycheck.dependency.naming.Identifier;
import org.owasp.dependencycheck.dependency.naming.PurlIdentifier;
import org.owasp.dependencycheck.utils.SeverityUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import us.springett.parsers.cpe.Cpe;
import us.springett.parsers.cpe.exceptions.CpeEncodingException;
import us.springett.parsers.cpe.util.Convert;
/**
* Utilities to format items in the Velocity reports.
*
* @author Jeremy Long
*/
public class ReportTool {
/**
* The logger.
*/
private static final Logger LOGGER = LoggerFactory.getLogger(ReportTool.class);
/**
* Converts an identifier into the Suppression string when possible.
*
* @param id the Identifier to format
* @return the formatted suppression string when possible; otherwise
* null.
*/
public String identifierToSuppressionId(Identifier id) {
if (id instanceof PurlIdentifier) {
final PurlIdentifier purl = (PurlIdentifier) id;
return purl.toString();
} else if (id instanceof CpeIdentifier) {
try {
final CpeIdentifier cpeId = (CpeIdentifier) id;
final Cpe cpe = cpeId.getCpe();
return String.format("cpe:/%s:%s:%s", Convert.wellFormedToCpeUri(cpe.getPart()),
Convert.wellFormedToCpeUri(cpe.getWellFormedVendor()),
Convert.wellFormedToCpeUri(cpe.getWellFormedProduct()));
} catch (CpeEncodingException ex) {
LOGGER.debug("Unable to convert to cpe URI", ex);
}
} else if (id instanceof GenericIdentifier) {
return id.getValue();
}
return null;
}
/**
* Estimates the CVSS V2 score for the given severity.
*
* @param severity the text representation of a score
* @return the estimated score
*/
public Double estimateSeverity(String severity) {
return SeverityUtil.estimateCvssV2(severity);
}
/**
* Creates a list of SARIF rules for the SARIF report.
*
* @param dependencies the list of dependencies to extract rules from
* @return the list of SARIF rules
*/
public Collection convertToSarifRules(List dependencies) {
final Map rules = new HashMap<>();
for (Dependency d : dependencies) {
for (Vulnerability v : d.getVulnerabilities()) {
if (!rules.containsKey(v.getName())) {
final SarifRule r = new SarifRule(v.getName(),
buildShortDescription(d, v, v.getKnownExploitedVulnerability() != null),
buildDescription(v.getDescription(), v.getKnownExploitedVulnerability()),
v.getSource().name(),
v.getCvssV2(),
v.getCvssV3());
rules.put(v.getName(), r);
}
}
}
return rules.values();
}
private String determineScore(Vulnerability vuln) {
if (vuln.getUnscoredSeverity() != null) {
if ("0.0".equals(vuln.getUnscoredSeverity())) {
return "unknown";
} else {
return normalizeSeverity(vuln.getUnscoredSeverity().toLowerCase());
}
} else if (vuln.getCvssV3() != null && vuln.getCvssV3().getCvssData().getBaseSeverity() != null) {
return normalizeSeverity(vuln.getCvssV3().getCvssData().getBaseSeverity().value().toLowerCase());
} else if (vuln.getCvssV2() != null && vuln.getCvssV2().getCvssData().getBaseSeverity() != null) {
return normalizeSeverity(vuln.getCvssV2().getCvssData().getBaseSeverity());
}
return "unknown";
}
public String normalizeSeverity(String sev) {
switch (sev.toLowerCase()) {
case "critical":
return "critical";
case "high":
return "high";
case "medium":
case "moderate":
return "medium";
case "low":
case "informational":
case "info":
return "low";
default:
return "unknown";
}
}
/**
* Builds the short description for the Sarif format.
*
* @param d the dependency
* @param vuln the vulnerability
* @param knownExploited true if the vulnerability is known to be exploited
* @return the short description
*/
private String buildShortDescription(Dependency d, Vulnerability vuln, boolean knownExploited) {
final StringBuilder sb = new StringBuilder();
sb.append(determineScore(vuln))
.append(" severity - ")
.append(vuln.getName());
if (vuln.getCwes() != null && !vuln.getCwes().isEmpty()) {
final String cwe = vuln.getCwes().getFullCwes().values().iterator().next();
if (cwe != null && !"NVD-CWE-Other".equals(cwe) && !"NVD-CWE-noinfo".equals(cwe)) {
sb.append(" ").append(cwe);
}
}
sb.append(" vulnerability in ");
if (d.getSoftwareIdentifiers() != null && !d.getSoftwareIdentifiers().isEmpty()) {
sb.append(d.getSoftwareIdentifiers().iterator().next());
} else {
sb.append(d.getDisplayFileName());
}
if (knownExploited) {
sb.append(" *Known Exploited Vulnerability*");
}
return sb.toString();
}
private String buildDescription(String description,
org.owasp.dependencycheck.data.knownexploited.json.Vulnerability knownExploitedVulnerability) {
final StringBuilder sb = new StringBuilder();
if (knownExploitedVulnerability != null) {
sb.append("CISA Known Exploited Vulnerability\n");
if (knownExploitedVulnerability.getVendorProject() != null) {
sb.append("Vendor/Project: ").append(knownExploitedVulnerability.getVendorProject()).append("\n");
}
if (knownExploitedVulnerability.getProduct() != null) {
sb.append("Product: ").append(knownExploitedVulnerability.getProduct()).append("\n");
}
if (knownExploitedVulnerability.getVulnerabilityName() != null) {
sb.append("Vulnerability Name: ").append(knownExploitedVulnerability.getVulnerabilityName()).append("\n");
}
if (knownExploitedVulnerability.getDateAdded() != null) {
sb.append("Date Added: ").append(knownExploitedVulnerability.getDateAdded()).append("\n");
}
if (knownExploitedVulnerability.getShortDescription() != null) {
sb.append("Short Description: ").append(knownExploitedVulnerability.getShortDescription()).append("\n");
}
if (knownExploitedVulnerability.getRequiredAction() != null) {
sb.append("Required Action: ").append(knownExploitedVulnerability.getRequiredAction()).append("\n");
}
if (knownExploitedVulnerability.getDueDate() != null) {
sb.append("Due Date").append(knownExploitedVulnerability.getDueDate()).append("\n");
}
if (knownExploitedVulnerability.getNotes() != null) {
sb.append("Notes: ").append(knownExploitedVulnerability.getNotes()).append("\n");
}
sb.append("\n");
}
sb.append(description);
return sb.toString();
}
}