Coverage Report

Coverage Report - org.owasp.dependencycheck.dependency.VulnerableSoftware

Classes in this File

Line Coverage

Branch Coverage

Complexity

VulnerableSoftware

70%

70/99

79%

57/72

3.15

 /*
  * 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) 2012 Jeremy Long. All Rights Reserved.
  */
 package org.owasp.dependencycheck.dependency;
 
 import java.io.Serializable;
 import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
 import org.owasp.dependencycheck.data.cpe.IndexEntry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
  * A record containing information about vulnerable software. This is referenced from a vulnerability.
  *
  * @author Jeremy Long
  */
 public class VulnerableSoftware extends IndexEntry implements Serializable, Comparable<VulnerableSoftware> {
 
     /**
      * The logger.
      */
     private static final Logger LOGGER = LoggerFactory.getLogger(VulnerableSoftware.class);
     /**
      * The serial version UID.
      */
     private static final long serialVersionUID = 307319490326651052L;
 
     /**
      * Parse a CPE entry from the cpe string representation.
      *
      * @param cpe a cpe entry (e.g. cpe:/a:vendor:software:version)
      */
     public void setCpe(String cpe) {
         try {
             parseName(cpe);
         } catch (UnsupportedEncodingException ex) {
             LOGGER.warn("Character encoding is unsupported for CPE '{}'.", cpe);
             LOGGER.debug("", ex);
             setName(cpe);
         }
     }
 
     /**
      * <p>
      * Parses a name attribute value, from the cpe.xml, into its corresponding parts: vendor, product, version, update.</p>
      * <p>
      * Example:</p>
      * <code>&nbsp;&nbsp;&nbsp;cpe:/a:apache:struts:1.1:rc2</code>
      *
      * <p>
      * Results in:</p> <ul> <li>Vendor: apache</li> <li>Product: struts</li>
      * <li>Version: 1.1</li> <li>Revision: rc2</li> </ul>
      *
      * @param cpeName the cpe name
      * @throws UnsupportedEncodingException should never be thrown...
      */
     @Override
     public void parseName(String cpeName) throws UnsupportedEncodingException {
         this.name = cpeName;
         if (cpeName != null && cpeName.length() > 7) {
             final String[] data = cpeName.substring(7).split(":");
             if (data.length >= 1) {
                 this.setVendor(urlDecode(data[0]));
             }
             if (data.length >= 2) {
                 this.setProduct(urlDecode(data[1]));
             }
             if (data.length >= 3) {
                 version = urlDecode(data[2]);
             }
             if (data.length >= 4) {
                 update = urlDecode(data[3]);
             }
             if (data.length >= 5) {
                 edition = urlDecode(data[4]);
             }
         }
     }
     /**
      * If present, indicates that previous version are vulnerable.
      */
     private String previousVersion;
 
     /**
      * Indicates if previous versions of this software are vulnerable.
      *
      * @return if previous versions of this software are vulnerable
      */
     public boolean hasPreviousVersion() {
         return previousVersion != null;
     }
 
     /**
      * Get the value of previousVersion.
      *
      * @return the value of previousVersion
      */
     public String getPreviousVersion() {
         return previousVersion;
     }
 
     /**
      * Set the value of previousVersion.
      *
      * @param previousVersion new value of previousVersion
      */
     public void setPreviousVersion(String previousVersion) {
         this.previousVersion = previousVersion;
     }
 
     /**
      * Standard equals implementation to compare this VulnerableSoftware to another object.
      *
      * @param obj the object to compare
      * @return whether or not the objects are equal
      */
     @Override
     public boolean equals(Object obj) {
         if (obj == null) {
             return false;
         }
         if (getClass() != obj.getClass()) {
             return false;
         }
         final VulnerableSoftware other = (VulnerableSoftware) obj;
         if ((this.name == null) ? (other.getName() != null) : !this.name.equals(other.getName())) {
             return false;
         }
         return true;
     }
 
     /**
      * Standard implementation of hashCode.
      *
      * @return the hashCode for the object
      */
     @Override
     public int hashCode() {
         int hash = 7;
         hash = 83 * hash + (this.name != null ? this.name.hashCode() : 0);
         return hash;
     }
 
     /**
      * Standard toString() implementation display the name and whether or not previous versions are also affected.
      *
      * @return a string representation of the object
      */
     @Override
     public String toString() {
         return "VulnerableSoftware{" + name + "[" + previousVersion + "]}";
     }
 
     /**
      * Implementation of the comparable interface.
      *
      * @param vs the VulnerableSoftware to compare
      * @return an integer indicating the ordering of the two objects
      */
     @Override
     public int compareTo(VulnerableSoftware vs) {
         int result = 0;
         final String[] left = this.name.split(":");
         final String[] right = vs.getName().split(":");
         final int max = (left.length <= right.length) ? left.length : right.length;
         if (max > 0) {
             for (int i = 0; result == 0 && i < max; i++) {
                 final String[] subLeft = left[i].split("(\\.|-)");
                 final String[] subRight = right[i].split("(\\.|-)");
                 final int subMax = (subLeft.length <= subRight.length) ? subLeft.length : subRight.length;
                 if (subMax > 0) {
                     for (int x = 0; result == 0 && x < subMax; x++) {
                         if (isPositiveInteger(subLeft[x]) && isPositiveInteger(subRight[x])) {
                             try {
                                 result = Long.valueOf(subLeft[x]).compareTo(Long.valueOf(subRight[x]));
                             } catch (NumberFormatException ex) {
                                 //ignore the exception - they obviously aren't numbers
                                 if (!subLeft[x].equalsIgnoreCase(subRight[x])) {
                                     result = subLeft[x].compareToIgnoreCase(subRight[x]);
                                 }
                             }
                         } else {
                             result = subLeft[x].compareToIgnoreCase(subRight[x]);
                         }
                     }
                     if (result == 0) {
                         if (subLeft.length > subRight.length) {
                             result = 2;
                         }
                         if (subRight.length > subLeft.length) {
                             result = -2;
                         }
                     }
                 } else {
                     result = left[i].compareToIgnoreCase(right[i]);
                 }
             }
             if (result == 0) {
                 if (left.length > right.length) {
                     result = 2;
                 }
                 if (right.length > left.length) {
                     result = -2;
                 }
             }
         } else {
             result = this.getName().compareToIgnoreCase(vs.getName());
         }
         return result;
     }
 
     /**
      * Determines if the string passed in is a positive integer.
      *
      * @param str the string to test
      * @return true if the string only contains 0-9, otherwise false.
      */
     private static boolean isPositiveInteger(final String str) {
         if (str == null || str.isEmpty()) {
             return false;
         }
         for (int i = 0; i < str.length(); i++) {
             final char c = str.charAt(i);
             if (c < '0' || c > '9') {
                 return false;
             }
         }
         return true;
     }
     /**
      * The name of the cpe.
      */
     private String name;
 
     /**
      * Get the value of name.
      *
      * @return the value of name
      */
     public String getName() {
         return name;
     }
 
     /**
      * Set the value of name.
      *
      * @param name new value of name
      */
     public void setName(String name) {
         this.name = name;
     }
     /**
      * The product version number.
      */
     private String version;
 
     /**
      * Get the value of version.
      *
      * @return the value of version
      */
     public String getVersion() {
         return version;
     }
 
     /**
      * Set the value of version.
      *
      * @param version new value of version
      */
     public void setVersion(String version) {
         this.version = version;
     }
     /**
      * The product update version.
      */
     private String update;
 
     /**
      * Get the value of update.
      *
      * @return the value of update
      */
     public String getUpdate() {
         return update;
     }
 
     /**
      * Set the value of update.
      *
      * @param update new value of update
      */
     public void setUpdate(String update) {
         this.update = update;
     }
     /**
      * The product edition.
      */
     private String edition;
 
     /**
      * Get the value of edition.
      *
      * @return the value of edition
      */
     public String getEdition() {
         return edition;
     }
 
     /**
      * Set the value of edition.
      *
      * @param edition new value of edition
      */
     public void setEdition(String edition) {
         this.edition = edition;
     }
 
     /**
      * Replaces '+' with '%2B' and then URL Decodes the string attempting first UTF-8, then ASCII, then default.
      *
      * @param string the string to URL Decode
      * @return the URL Decoded string
      */
     private String urlDecode(String string) {
         final String text = string.replace("+", "%2B");
         String result;
         try {
             result = URLDecoder.decode(text, "UTF-8");
         } catch (UnsupportedEncodingException ex) {
             try {
                 result = URLDecoder.decode(text, "ASCII");
             } catch (UnsupportedEncodingException ex1) {
                 result = defaultUrlDecode(text);
             }
         }
         return result;
     }
 
     /**
      * Call {@link java.net.URLDecoder#decode(String)} to URL decode using the default encoding.
      *
      * @param text www-form-encoded URL to decode
      * @return the newly decoded String
      */
     @SuppressWarnings("deprecation")
     private String defaultUrlDecode(final String text) {
         return URLDecoder.decode(text);
     }
 }

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) 2012 Jeremy Long. All Rights Reserved.
17		*/
18		package org.owasp.dependencycheck.dependency;
19
20		import java.io.Serializable;
21		import java.io.UnsupportedEncodingException;
22		import java.net.URLDecoder;
23		import org.owasp.dependencycheck.data.cpe.IndexEntry;
24		import org.slf4j.Logger;
25		import org.slf4j.LoggerFactory;
26
27		/**
28		* A record containing information about vulnerable software. This is referenced from a vulnerability.
29		*
30		* @author Jeremy Long
31		*/
32	24636	public class VulnerableSoftware extends IndexEntry implements Serializable, Comparable<VulnerableSoftware> {
33
34		/**
35		* The logger.
36		*/
37	2	private static final Logger LOGGER = LoggerFactory.getLogger(VulnerableSoftware.class);
38		/**
39		* The serial version UID.
40		*/
41		private static final long serialVersionUID = 307319490326651052L;
42
43		/**
44		* Parse a CPE entry from the cpe string representation.
45		*
46		* @param cpe a cpe entry (e.g. cpe:/a:vendor:software:version)
47		*/
48		public void setCpe(String cpe) {
49		try {
50	2164	parseName(cpe);
51	0	} catch (UnsupportedEncodingException ex) {
52	0	LOGGER.warn("Character encoding is unsupported for CPE '{}'.", cpe);
53	0	LOGGER.debug("", ex);
54	0	setName(cpe);
55	2164	}
56	2164	}
57
58		/**
59		* <p>
60		* Parses a name attribute value, from the cpe.xml, into its corresponding parts: vendor, product, version, update.</p>
61		* <p>
62		* Example:</p>
63		* <code>   cpe:/a:apache:struts:1.1:rc2</code>
64		*
65		* <p>
66		* Results in:</p> <ul> <li>Vendor: apache</li> <li>Product: struts</li>
67		* <li>Version: 1.1</li> <li>Revision: rc2</li> </ul>
68		*
69		* @param cpeName the cpe name
70		* @throws UnsupportedEncodingException should never be thrown...
71		*/
72		@Override
73		public void parseName(String cpeName) throws UnsupportedEncodingException {
74	3198	this.name = cpeName;
75	3198	if (cpeName != null && cpeName.length() > 7) {
76	3188	final String[] data = cpeName.substring(7).split(":");
77	3188	if (data.length >= 1) {
78	3188	this.setVendor(urlDecode(data[0]));
79		}
80	3188	if (data.length >= 2) {
81	3186	this.setProduct(urlDecode(data[1]));
82		}
83	3188	if (data.length >= 3) {
84	3186	version = urlDecode(data[2]);
85		}
86	3188	if (data.length >= 4) {
87	464	update = urlDecode(data[3]);
88		}
89	3188	if (data.length >= 5) {
90	0	edition = urlDecode(data[4]);
91		}
92		}
93	3198	}
94		/**
95		* If present, indicates that previous version are vulnerable.
96		*/
97		private String previousVersion;
98
99		/**
100		* Indicates if previous versions of this software are vulnerable.
101		*
102		* @return if previous versions of this software are vulnerable
103		*/
104		public boolean hasPreviousVersion() {
105	0	return previousVersion != null;
106		}
107
108		/**
109		* Get the value of previousVersion.
110		*
111		* @return the value of previousVersion
112		*/
113		public String getPreviousVersion() {
114	0	return previousVersion;
115		}
116
117		/**
118		* Set the value of previousVersion.
119		*
120		* @param previousVersion new value of previousVersion
121		*/
122		public void setPreviousVersion(String previousVersion) {
123	28	this.previousVersion = previousVersion;
124	28	}
125
126		/**
127		* Standard equals implementation to compare this VulnerableSoftware to another object.
128		*
129		* @param obj the object to compare
130		* @return whether or not the objects are equal
131		*/
132		@Override
133		public boolean equals(Object obj) {
134	8	if (obj == null) {
135	0	return false;
136		}
137	8	if (getClass() != obj.getClass()) {
138	0	return false;
139		}
140	8	final VulnerableSoftware other = (VulnerableSoftware) obj;
141	8	if ((this.name == null) ? (other.getName() != null) : !this.name.equals(other.getName())) {
142	2	return false;
143		}
144	6	return true;
145		}
146
147		/**
148		* Standard implementation of hashCode.
149		*
150		* @return the hashCode for the object
151		*/
152		@Override
153		public int hashCode() {
154	220	int hash = 7;
155	220	hash = 83 * hash + (this.name != null ? this.name.hashCode() : 0);
156	220	return hash;
157		}
158
159		/**
160		* Standard toString() implementation display the name and whether or not previous versions are also affected.
161		*
162		* @return a string representation of the object
163		*/
164		@Override
165		public String toString() {
166	0	return "VulnerableSoftware{" + name + "[" + previousVersion + "]}";
167		}
168
169		/**
170		* Implementation of the comparable interface.
171		*
172		* @param vs the VulnerableSoftware to compare
173		* @return an integer indicating the ordering of the two objects
174		*/
175		@Override
176		public int compareTo(VulnerableSoftware vs) {
177	21472	int result = 0;
178	21472	final String[] left = this.name.split(":");
179	21472	final String[] right = vs.getName().split(":");
180	21472	final int max = (left.length <= right.length) ? left.length : right.length;
181	21472	if (max > 0) {
182	129238	for (int i = 0; result == 0 && i < max; i++) {
183	107766	final String[] subLeft = left[i].split("(\\.\|-)");
184	107766	final String[] subRight = right[i].split("(\\.\|-)");
185	107766	final int subMax = (subLeft.length <= subRight.length) ? subLeft.length : subRight.length;
186	107766	if (subMax > 0) {
187	246638	for (int x = 0; result == 0 && x < subMax; x++) {
188	138890	if (isPositiveInteger(subLeft[x]) && isPositiveInteger(subRight[x])) {
189		try {
190	51138	result = Long.valueOf(subLeft[x]).compareTo(Long.valueOf(subRight[x]));
191	0	} catch (NumberFormatException ex) {
192		//ignore the exception - they obviously aren't numbers
193	0	if (!subLeft[x].equalsIgnoreCase(subRight[x])) {
194	0	result = subLeft[x].compareToIgnoreCase(subRight[x]);
195		}
196	51138	}
197		} else {
198	87752	result = subLeft[x].compareToIgnoreCase(subRight[x]);
199		}
200		}
201	107748	if (result == 0) {
202	86938	if (subLeft.length > subRight.length) {
203	312	result = 2;
204		}
205	86938	if (subRight.length > subLeft.length) {
206	106	result = -2;
207		}
208		}
209		} else {
210	18	result = left[i].compareToIgnoreCase(right[i]);
211		}
212		}
213	21472	if (result == 0) {
214	232	if (left.length > right.length) {
215	136	result = 2;
216		}
217	232	if (right.length > left.length) {
218	20	result = -2;
219		}
220		}
221		} else {
222	0	result = this.getName().compareToIgnoreCase(vs.getName());
223		}
224	21472	return result;
225		}
226
227		/**
228		* Determines if the string passed in is a positive integer.
229		*
230		* @param str the string to test
231		* @return true if the string only contains 0-9, otherwise false.
232		*/
233		private static boolean isPositiveInteger(final String str) {
234	190200	if (str == null \|\| str.isEmpty()) {
235	28	return false;
236		}
237	309718	for (int i = 0; i < str.length(); i++) {
238	207270	final char c = str.charAt(i);
239	207270	if (c < '0' \|\| c > '9') {
240	87724	return false;
241		}
242		}
243	102448	return true;
244		}
245		/**
246		* The name of the cpe.
247		*/
248		private String name;
249
250		/**
251		* Get the value of name.
252		*
253		* @return the value of name
254		*/
255		public String getName() {
256	21574	return name;
257		}
258
259		/**
260		* Set the value of name.
261		*
262		* @param name new value of name
263		*/
264		public void setName(String name) {
265	0	this.name = name;
266	0	}
267		/**
268		* The product version number.
269		*/
270		private String version;
271
272		/**
273		* Get the value of version.
274		*
275		* @return the value of version
276		*/
277		public String getVersion() {
278	3940	return version;
279		}
280
281		/**
282		* Set the value of version.
283		*
284		* @param version new value of version
285		*/
286		public void setVersion(String version) {
287	0	this.version = version;
288	0	}
289		/**
290		* The product update version.
291		*/
292		private String update;
293
294		/**
295		* Get the value of update.
296		*
297		* @return the value of update
298		*/
299		public String getUpdate() {
300	2858	return update;
301		}
302
303		/**
304		* Set the value of update.
305		*
306		* @param update new value of update
307		*/
308		public void setUpdate(String update) {
309	0	this.update = update;
310	0	}
311		/**
312		* The product edition.
313		*/
314		private String edition;
315
316		/**
317		* Get the value of edition.
318		*
319		* @return the value of edition
320		*/
321		public String getEdition() {
322	0	return edition;
323		}
324
325		/**
326		* Set the value of edition.
327		*
328		* @param edition new value of edition
329		*/
330		public void setEdition(String edition) {
331	0	this.edition = edition;
332	0	}
333
334		/**
335		* Replaces '+' with '%2B' and then URL Decodes the string attempting first UTF-8, then ASCII, then default.
336		*
337		* @param string the string to URL Decode
338		* @return the URL Decoded string
339		*/
340		private String urlDecode(String string) {
341	10024	final String text = string.replace("+", "%2B");
342		String result;
343		try {
344	10024	result = URLDecoder.decode(text, "UTF-8");
345	0	} catch (UnsupportedEncodingException ex) {
346		try {
347	0	result = URLDecoder.decode(text, "ASCII");
348	0	} catch (UnsupportedEncodingException ex1) {
349	0	result = defaultUrlDecode(text);
350	0	}
351	10024	}
352	10024	return result;
353		}
354
355		/**
356		* Call {@link java.net.URLDecoder#decode(String)} to URL decode using the default encoding.
357		*
358		* @param text www-form-encoded URL to decode
359		* @return the newly decoded String
360		*/
361		@SuppressWarnings("deprecation")
362		private String defaultUrlDecode(final String text) {
363	0	return URLDecoder.decode(text);
364		}
365		}