org.owasp.dependencycheck.data.cwe.CweDB Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dependency-check-core Show documentation
Show all versions of dependency-check-core Show documentation
dependency-check-core is the engine and reporting tool used to identify and report if there are any known, publicly disclosed vulnerabilities in the scanned project's dependencies. The engine extracts meta-data from the dependencies and uses this to do fuzzy key-word matching against the Common Platfrom Enumeration (CPE), if any CPE identifiers are found the associated Common Vulnerability and Exposure (CVE) entries are added to the generated report.
/*
* 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.data.cwe;
import org.owasp.dependencycheck.utils.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.concurrent.ThreadSafe;
/**
*
* @author Jeremy Long
*/
@ThreadSafe
public final class CweDB {
/**
* The Logger.
*/
private static final Logger LOGGER = LoggerFactory.getLogger(CweDB.class);
/**
* A HashMap of the CWE data.
*/
private static final Map CWE = loadData();
/**
* Empty private constructor as this is a utility class.
*/
private CweDB() {
//empty
}
/**
* Loads a HashMap containing the CWE data from a resource found in the jar.
*
* @return a HashMap of CWE data
*/
@SuppressWarnings("unchecked")
private static Map loadData() {
final String filePath = "data/cwe.hashmap.serialized";
try (InputStream input = FileUtils.getResourceAsStream(filePath);
ObjectInputStream oin = new ObjectInputStream(input)) {
return (HashMap) oin.readObject();
} catch (ClassNotFoundException ex) {
LOGGER.warn("Unable to load CWE data. This should not be an issue.");
LOGGER.debug("", ex);
} catch (IOException ex) {
LOGGER.warn("Unable to load CWE data due to an IO Error. This should not be an issue.");
LOGGER.debug("", ex);
}
return null;
}
/**
*
* Returns the full CWE name from the CWE ID.
*
* @param cweId the CWE ID
* @return the full name of the CWE
*/
public static synchronized String getName(String cweId) {
if (cweId != null) {
return CWE.get(cweId);
}
return null;
}
/**
*
* Returns the full CWE name from the CWE ID.
*
* @param cweId the CWE ID
* @return the full name of the CWE
*/
public static synchronized String getFullName(String cweId) {
final String name = getName(cweId);
if (name != null) {
return cweId + " " + name;
}
return cweId;
}
}