org.owasp.dependencycheck.dependency.CweSet 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.dependency;
import java.io.Serializable;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.owasp.dependencycheck.data.cwe.CweDB;
/**
* Collection of CWEs with a pretty print implemented in the toString().
*
* @author Jeremy Long
*/
public class CweSet implements Serializable {
/**
* Serial version UID.
*/
private static final long serialVersionUID = 7884812602736995362L;
/**
* The set of CWE entries.
*/
private final Set cwes = new HashSet<>();
/**
* Get the value of CWEs.
*
* @return the value of CWEs
*/
public Set getEntries() {
return cwes;
}
/**
* Adds a CWE to the set.
*
* @param cwe new CWE to add
*/
public void addCwe(String cwe) {
if (cwe != null) {
this.cwes.add(cwe);
}
}
@Override
public String toString() {
if (cwes.isEmpty()) {
return "";
}
return cwes.stream().map(CweDB::getFullName).collect(Collectors.joining(", "));
}
/**
* Streams the CWEs.
*
* @return the stream of CWE
*/
public Stream stream() {
return cwes.stream();
}
/**
* Returns a map of CWE-ID and title.
*
* @return a map of CWE-ID and title.
*/
public Map getFullCwes() {
final Map map = new HashMap<>();
cwes.forEach((cwe) -> map.put(cwe, CweDB.getName(cwe)));
return map;
}
/**
* Returns true
if there are no CWEs; otherwise
* false
.
*
* @return true
if there are no CWEs; otherwise
* false
*/
public boolean isEmpty() {
return cwes.isEmpty();
}
}