Class SuppressionHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.owasp.dependencycheck.xml.suppression.SuppressionHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

@NotThreadSafe
public class SuppressionHandler
extends DefaultHandler

A handler to load suppression rules. In the input xml a suppression rule can be part of a suppressionGroup. In that case the attributes set on group element will act as default values for child suppressions.

Author:

Jeremy Long

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CPE	The CPE element name.
static final String	CVE	The CVE element name.
static final String	CVSS_BELOW	The cvssBelow element name.
static final String	CVSS_V2_BELOW	The cvssV2Below element name.
static final String	CVSS_V3_BELOW	The cvssV3Below element name.
static final String	CVSS_V4_BELOW	The cvssV4Below element name.
static final String	CWE	The CWE element name.
static final String	FILE_PATH	The file path element name.
static final String	GAV	The GAV element name.
static final String	NOTES	The CVE element name.
static final String	PACKAGE_URL	The Package URL element name.
static final String	SHA1	The sha1 hash element name.
static final String	SUPPRESS	The suppress node, indicates the start of a new rule.
static final String	SUPPRESSION_GROUP	The suppressionGroup node, indicates the start of a new suppressionGroup.
static final String	VULNERABILITY_NAME	The vulnerabilityName element name.

Constructor Summary

Constructors

Constructor	Description
SuppressionHandler()

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	Collects the body text of the node being processed.
void	endElement(String uri, String localName, String qName)	Handles the end element event.
List<SuppressionRule>	getSuppressionRules()	Get the value of suppressionRules.
void	startElement(String uri, String localName, String qName, Attributes attributes)	Handles the start element event.

Methods inherited from class DefaultHandler

endDocument, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SUPPRESSION_GROUP

public static final String SUPPRESSION_GROUP

The suppressionGroup node, indicates the start of a new suppressionGroup.

See Also:

• Constant Field Values

SUPPRESS

public static final String SUPPRESS

The suppress node, indicates the start of a new rule.

See Also:

• Constant Field Values

FILE_PATH

public static final String FILE_PATH

The file path element name.

See Also:

• Constant Field Values

SHA1

public static final String SHA1

The sha1 hash element name.

See Also:

• Constant Field Values

CVE

public static final String CVE

The CVE element name.

See Also:

• Constant Field Values

VULNERABILITY_NAME

public static final String VULNERABILITY_NAME

The vulnerabilityName element name.

See Also:

• Constant Field Values

NOTES

public static final String NOTES

The CVE element name.

See Also:

• Constant Field Values

CPE

public static final String CPE

The CPE element name.

See Also:

• Constant Field Values

CWE

public static final String CWE

The CWE element name.

See Also:

• Constant Field Values

GAV

public static final String GAV

The GAV element name.

See Also:

• Constant Field Values

PACKAGE_URL

public static final String PACKAGE_URL

The Package URL element name.

See Also:

• Constant Field Values

CVSS_BELOW

public static final String CVSS_BELOW

The cvssBelow element name.

See Also:

• Constant Field Values

CVSS_V2_BELOW

public static final String CVSS_V2_BELOW

The cvssV2Below element name.

See Also:

• Constant Field Values

CVSS_V3_BELOW

public static final String CVSS_V3_BELOW

The cvssV3Below element name.

See Also:

• Constant Field Values

CVSS_V4_BELOW

public static final String CVSS_V4_BELOW

The cvssV4Below element name.

See Also:

• Constant Field Values

Constructor Details

SuppressionHandler

public SuppressionHandler()

Method Details

getSuppressionRules

public List<SuppressionRule> getSuppressionRules()

Get the value of suppressionRules.

Returns:

the value of suppressionRules

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attributes)
                  throws SAXException

Handles the start element event.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Parameters:

uri - the URI of the element being processed

localName - the local name of the element being processed

qName - the qName of the element being processed

attributes - the attributes of the element being processed

Throws:

SAXException - thrown if there is an exception processing

endElement

public void endElement(String uri,
 String localName,
 String qName)
                throws SAXException

Handles the end element event.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Parameters:

uri - the URI of the element

localName - the local name of the element

qName - the qName of the element

Throws:

SAXException - thrown if there is an exception processing

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Collects the body text of the node being processed.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Parameters:

ch - the char array of text

start - the start position to copy text from in the char array

length - the number of characters to copy from the char array

Throws:

SAXException - thrown if there is a parsing exception