org.owasp.dependencycheck.data.cpe.NpmCpeMemoryIndex 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) 2020 Jeremy Long. All Rights Reserved.
*/
package org.owasp.dependencycheck.data.cpe;
import javax.annotation.concurrent.ThreadSafe;
/**
*
* An in memory Lucene index that contains the vendor/product combinations from
* the CPE (application) identifiers within the NVD CVE data. The intent of the
* index is to hold only products in the NVD associated with NPM/node.js.
*
* This is the last remaining singleton in dependency-check-core; The use of
* this singleton - while it may not technically be thread-safe (one database
* used to build this index may not have the same entries as another) the risk
* of this is currently believed to be small. As this memory index consumes a
* large amount of memory we will remain using the singleton pattern for now.
*
* @author Jeremy Long
*/
@ThreadSafe
public final class NpmCpeMemoryIndex extends AbstractMemoryIndex {
/**
* Singleton instance.
*/
private static final NpmCpeMemoryIndex INSTANCE = new NpmCpeMemoryIndex();
/**
* private constructor for singleton.
*/
private NpmCpeMemoryIndex() {
}
/**
* Gets the singleton instance of the NpmCpeMemoryIndex.
*
* @return the instance of the NpmCpeMemoryIndex
*/
@Override
protected AbstractMemoryIndex instance() {
return INSTANCE;
}
/**
* Gets the singleton instance of the CpeMemoryIndex.
*
* @return the instance of the CpeMemoryIndex
*/
public static NpmCpeMemoryIndex getInstance() {
return INSTANCE;
}
}