Coverage Report

Coverage Report - org.owasp.dependencycheck.xml.suppression.SuppressionHandler

Classes in this File

Line Coverage

Branch Coverage

Complexity

SuppressionHandler

95%

44/46

78%

22/28

3.8

 /*
  * 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) 2013 Jeremy Long. All Rights Reserved.
  */
 package org.owasp.dependencycheck.xml.suppression;
 
 import java.util.ArrayList;
 import java.util.List;
 import org.xml.sax.Attributes;
 import org.xml.sax.SAXException;
 import org.xml.sax.helpers.DefaultHandler;
 
 /**
  * A handler to load suppression rules.
  *
  * @author Jeremy Long
  */
 public class SuppressionHandler extends DefaultHandler {
 
     /**
      * The suppress node, indicates the start of a new rule.
      */
     public static final String SUPPRESS = "suppress";
     /**
      * The file path element name.
      */
     public static final String FILE_PATH = "filePath";
     /**
      * The sha1 hash element name.
      */
     public static final String SHA1 = "sha1";
     /**
      * The CVE element name.
      */
     public static final String CVE = "cve";
     /**
      * The CPE element name.
      */
     public static final String CPE = "cpe";
     /**
      * The CWE element name.
      */
     public static final String CWE = "cwe";
     /**
      * The GAV element name.
      */
     public static final String GAV = "gav";
     /**
      * The cvssBelow element name.
      */
     public static final String CVSS_BELOW = "cvssBelow";
     /**
      * A list of suppression rules.
      */
     private final List<SuppressionRule> suppressionRules = new ArrayList<SuppressionRule>();
 
     /**
      * Get the value of suppressionRules.
      *
      * @return the value of suppressionRules
      */
     public List<SuppressionRule> getSuppressionRules() {
         return suppressionRules;
     }
     /**
      * The current rule being read.
      */
     private SuppressionRule rule;
     /**
      * The attributes of the node being read.
      */
     private Attributes currentAttributes;
     /**
      * The current node text being extracted from the element.
      */
     private StringBuilder currentText;
 
     /**
      * Handles the start element event.
      *
      * @param uri the uri of the element being processed
      * @param localName the local name of the element being processed
      * @param qName the qName of the element being processed
      * @param attributes the attributes of the element being processed
      * @throws SAXException thrown if there is an exception processing
      */
     @Override
     public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
         currentAttributes = attributes;
         currentText = new StringBuilder();
         if (SUPPRESS.equals(qName)) {
             rule = new SuppressionRule();
             final String base = currentAttributes.getValue("base");
             if (base != null) {
                 rule.setBase(Boolean.parseBoolean(base));
             } else {
                 rule.setBase(false);
             }
         }
     }
 
     /**
      * Handles the end element event.
      *
      * @param uri the URI of the element
      * @param localName the local name of the element
      * @param qName the qName of the element
      * @throws SAXException thrown if there is an exception processing
      */
     @Override
     public void endElement(String uri, String localName, String qName) throws SAXException {
         if (SUPPRESS.equals(qName)) {
             suppressionRules.add(rule);
             rule = null;
         } else if (FILE_PATH.equals(qName)) {
             final PropertyType pt = processPropertyType();
             rule.setFilePath(pt);
         } else if (SHA1.equals(qName)) {
             rule.setSha1(currentText.toString());
         } else if (GAV.equals(qName)) {
             final PropertyType pt = processPropertyType();
             rule.setGav(pt);
         } else if (CPE.equals(qName)) {
             final PropertyType pt = processPropertyType();
             rule.addCpe(pt);
         } else if (CWE.equals(qName)) {
             rule.addCwe(currentText.toString());
         } else if (CVE.equals(qName)) {
             rule.addCve(currentText.toString());
         } else if (CVSS_BELOW.equals(qName)) {
             final float cvss = Float.parseFloat(currentText.toString());
             rule.addCvssBelow(cvss);
         }
     }
 
     /**
      * Collects the body text of the node being processed.
      *
      * @param ch the char array of text
      * @param start the start position to copy text from in the char array
      * @param length the number of characters to copy from the char array
      * @throws SAXException thrown if there is a parsing exception
      */
     @Override
     public void characters(char[] ch, int start, int length) throws SAXException {
         currentText.append(ch, start, length);
     }
 
     /**
      * Processes field members that have been collected during the characters and startElement method to construct a
      * PropertyType object.
      *
      * @return a PropertyType object
      */
     private PropertyType processPropertyType() {
         final PropertyType pt = new PropertyType();
         pt.setValue(currentText.toString());
         if (currentAttributes != null && currentAttributes.getLength() > 0) {
             final String regex = currentAttributes.getValue("regex");
             if (regex != null) {
                 pt.setRegex(Boolean.parseBoolean(regex));
             }
             final String caseSensitive = currentAttributes.getValue("caseSensitive");
             if (caseSensitive != null) {
                 pt.setCaseSensitive(Boolean.parseBoolean(caseSensitive));
             }
         }
         return pt;
     }
 }

1		/*
2		* This file is part of dependency-check-core.
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*
16		* Copyright (c) 2013 Jeremy Long. All Rights Reserved.
17		*/
18		package org.owasp.dependencycheck.xml.suppression;
19
20		import java.util.ArrayList;
21		import java.util.List;
22		import org.xml.sax.Attributes;
23		import org.xml.sax.SAXException;
24		import org.xml.sax.helpers.DefaultHandler;
25
26		/**
27		* A handler to load suppression rules.
28		*
29		* @author Jeremy Long
30		*/
31	14	public class SuppressionHandler extends DefaultHandler {
32
33		/**
34		* The suppress node, indicates the start of a new rule.
35		*/
36		public static final String SUPPRESS = "suppress";
37		/**
38		* The file path element name.
39		*/
40		public static final String FILE_PATH = "filePath";
41		/**
42		* The sha1 hash element name.
43		*/
44		public static final String SHA1 = "sha1";
45		/**
46		* The CVE element name.
47		*/
48		public static final String CVE = "cve";
49		/**
50		* The CPE element name.
51		*/
52		public static final String CPE = "cpe";
53		/**
54		* The CWE element name.
55		*/
56		public static final String CWE = "cwe";
57		/**
58		* The GAV element name.
59		*/
60		public static final String GAV = "gav";
61		/**
62		* The cvssBelow element name.
63		*/
64		public static final String CVSS_BELOW = "cvssBelow";
65		/**
66		* A list of suppression rules.
67		*/
68	14	private final List<SuppressionRule> suppressionRules = new ArrayList<SuppressionRule>();
69
70		/**
71		* Get the value of suppressionRules.
72		*
73		* @return the value of suppressionRules
74		*/
75		public List<SuppressionRule> getSuppressionRules() {
76	11	return suppressionRules;
77		}
78		/**
79		* The current rule being read.
80		*/
81		private SuppressionRule rule;
82		/**
83		* The attributes of the node being read.
84		*/
85		private Attributes currentAttributes;
86		/**
87		* The current node text being extracted from the element.
88		*/
89		private StringBuilder currentText;
90
91		/**
92		* Handles the start element event.
93		*
94		* @param uri the uri of the element being processed
95		* @param localName the local name of the element being processed
96		* @param qName the qName of the element being processed
97		* @param attributes the attributes of the element being processed
98		* @throws SAXException thrown if there is an exception processing
99		*/
100		@Override
101		public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
102	2187	currentAttributes = attributes;
103	2187	currentText = new StringBuilder();
104	2187	if (SUPPRESS.equals(qName)) {
105	482	rule = new SuppressionRule();
106	482	final String base = currentAttributes.getValue("base");
107	482	if (base != null) {
108	482	rule.setBase(Boolean.parseBoolean(base));
109		} else {
110	0	rule.setBase(false);
111		}
112		}
113	2187	}
114
115		/**
116		* Handles the end element event.
117		*
118		* @param uri the URI of the element
119		* @param localName the local name of the element
120		* @param qName the qName of the element
121		* @throws SAXException thrown if there is an exception processing
122		*/
123		@Override
124		public void endElement(String uri, String localName, String qName) throws SAXException {
125	2187	if (SUPPRESS.equals(qName)) {
126	482	suppressionRules.add(rule);
127	482	rule = null;
128	1705	} else if (FILE_PATH.equals(qName)) {
129	89	final PropertyType pt = processPropertyType();
130	89	rule.setFilePath(pt);
131	89	} else if (SHA1.equals(qName)) {
132	4	rule.setSha1(currentText.toString());
133	1612	} else if (GAV.equals(qName)) {
134	385	final PropertyType pt = processPropertyType();
135	385	rule.setGav(pt);
136	385	} else if (CPE.equals(qName)) {
137	701	final PropertyType pt = processPropertyType();
138	701	rule.addCpe(pt);
139	701	} else if (CWE.equals(qName)) {
140	0	rule.addCwe(currentText.toString());
141	526	} else if (CVE.equals(qName)) {
142	29	rule.addCve(currentText.toString());
143	497	} else if (CVSS_BELOW.equals(qName)) {
144	4	final float cvss = Float.parseFloat(currentText.toString());
145	4	rule.addCvssBelow(cvss);
146		}
147	2187	}
148
149		/**
150		* Collects the body text of the node being processed.
151		*
152		* @param ch the char array of text
153		* @param start the start position to copy text from in the char array
154		* @param length the number of characters to copy from the char array
155		* @throws SAXException thrown if there is a parsing exception
156		*/
157		@Override
158		public void characters(char[] ch, int start, int length) throws SAXException {
159	4922	currentText.append(ch, start, length);
160	4922	}
161
162		/**
163		* Processes field members that have been collected during the characters and startElement method to construct a
164		* PropertyType object.
165		*
166		* @return a PropertyType object
167		*/
168		private PropertyType processPropertyType() {
169	1175	final PropertyType pt = new PropertyType();
170	1175	pt.setValue(currentText.toString());
171	1175	if (currentAttributes != null && currentAttributes.getLength() > 0) {
172	1175	final String regex = currentAttributes.getValue("regex");
173	1175	if (regex != null) {
174	1175	pt.setRegex(Boolean.parseBoolean(regex));
175		}
176	1175	final String caseSensitive = currentAttributes.getValue("caseSensitive");
177	1175	if (caseSensitive != null) {
178	1175	pt.setCaseSensitive(Boolean.parseBoolean(caseSensitive));
179		}
180		}
181	1175	return pt;
182		}
183		}