Coverage Report

Coverage Report - org.owasp.dependencycheck.analyzer.RubyBundleAuditAnalyzer

Classes in this File

Line Coverage

Branch Coverage

Complexity

RubyBundleAuditAnalyzer

16%

32/200

2/74

5.154

 /*
  * 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) 2015 Institute for Defense Analyses. All Rights Reserved.
  */
 package org.owasp.dependencycheck.analyzer;
 
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileFilter;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.nio.charset.Charset;
 import org.apache.commons.io.FileUtils;
 import org.owasp.dependencycheck.Engine;
 import org.owasp.dependencycheck.analyzer.exception.AnalysisException;
 import org.owasp.dependencycheck.data.nvdcve.CveDB;
 import org.owasp.dependencycheck.dependency.Confidence;
 import org.owasp.dependencycheck.dependency.Dependency;
 import org.owasp.dependencycheck.dependency.Reference;
 import org.owasp.dependencycheck.dependency.Vulnerability;
 import org.owasp.dependencycheck.utils.FileFilterBuilder;
 import org.owasp.dependencycheck.utils.Settings;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
 
 /**
  * Used to analyze Ruby Bundler Gemspec.lock files utilizing the 3rd party
  * bundle-audit tool.
  *
  * @author Dale Visser
  */
 @Experimental
 public class RubyBundleAuditAnalyzer extends AbstractFileTypeAnalyzer {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(RubyBundleAuditAnalyzer.class);
 
     /**
      * The name of the analyzer.
      */
     private static final String ANALYZER_NAME = "Ruby Bundle Audit Analyzer";
 
     /**
      * The phase that this analyzer is intended to run in.
      */
     private static final AnalysisPhase ANALYSIS_PHASE = AnalysisPhase.PRE_INFORMATION_COLLECTION;
     /**
      * The filter defining which files will be analyzed.
      */
     private static final FileFilter FILTER = FileFilterBuilder.newInstance().addFilenames("Gemfile.lock").build();
     /**
      * Name.
      */
     public static final String NAME = "Name: ";
     /**
      * Version.
      */
     public static final String VERSION = "Version: ";
     /**
      * Advisory.
      */
     public static final String ADVISORY = "Advisory: ";
     /**
      * Criticality.
      */
     public static final String CRITICALITY = "Criticality: ";
 
     /**
      * The DAL.
      */
     private CveDB cvedb;
 
     /**
      * @return a filter that accepts files named Gemfile.lock
      */
     @Override
     protected FileFilter getFileFilter() {
         return FILTER;
     }
 
     /**
      * Launch bundle-audit.
      *
      * @param folder directory that contains bundle audit
      * @return a handle to the process
      * @throws AnalysisException thrown when there is an issue launching bundle
      * audit
      */
     private Process launchBundleAudit(File folder) throws AnalysisException {
         if (!folder.isDirectory()) {
             throw new AnalysisException(String.format("%s should have been a directory.", folder.getAbsolutePath()));
         }
         final List<String> args = new ArrayList<String>();
         final String bundleAuditPath = Settings.getString(Settings.KEYS.ANALYZER_BUNDLE_AUDIT_PATH);
         args.add(null == bundleAuditPath ? "bundle-audit" : bundleAuditPath);
         args.add("check");
         args.add("--verbose");
         final ProcessBuilder builder = new ProcessBuilder(args);
         builder.directory(folder);
         try {
             LOGGER.info("Launching: " + args + " from " + folder);
             return builder.start();
         } catch (IOException ioe) {
             throw new AnalysisException("bundle-audit failure", ioe);
         }
     }
 
     /**
      * Initialize the analyzer. In this case, extract GrokAssembly.exe to a
      * temporary location.
      *
      * @throws Exception if anything goes wrong
      */
     @Override
     public void initializeFileTypeAnalyzer() throws Exception {
         try {
             cvedb = new CveDB();
             cvedb.open();
         } catch (DatabaseException ex) {
             LOGGER.warn("Exception opening the database");
             LOGGER.debug("error", ex);
             setEnabled(false);
             throw ex;
         }
         // Now, need to see if bundle-audit actually runs from this location.
         Process process = null;
         try {
             process = launchBundleAudit(Settings.getTempDirectory());
         } catch (AnalysisException ae) {
             LOGGER.warn("Exception from bundle-audit process: {}. Disabling {}", ae.getCause(), ANALYZER_NAME);
             setEnabled(false);
             cvedb.close();
             cvedb = null;
             throw ae;
         }
 
         final int exitValue = process.waitFor();
         if (0 == exitValue) {
             LOGGER.warn("Unexpected exit code from bundle-audit process. Disabling {}: {}", ANALYZER_NAME, exitValue);
             setEnabled(false);
             throw new AnalysisException("Unexpected exit code from bundle-audit process.");
         } else {
             BufferedReader reader = null;
             try {
                 reader = new BufferedReader(new InputStreamReader(process.getErrorStream(), "UTF-8"));
                 if (!reader.ready()) {
                     LOGGER.warn("Bundle-audit error stream unexpectedly not ready. Disabling " + ANALYZER_NAME);
                     setEnabled(false);
                     throw new AnalysisException("Bundle-audit error stream unexpectedly not ready.");
                 } else {
                     final String line = reader.readLine();
                     if (line == null || !line.contains("Errno::ENOENT")) {
                         LOGGER.warn("Unexpected bundle-audit output. Disabling {}: {}", ANALYZER_NAME, line);
                         setEnabled(false);
                         throw new AnalysisException("Unexpected bundle-audit output.");
                     }
                 }
             } finally {
                 if (null != reader) {
                     reader.close();
                 }
             }
         }
 
         if (isEnabled()) {
             LOGGER.info(ANALYZER_NAME + " is enabled. It is necessary to manually run \"bundle-audit update\" "
                     + "occasionally to keep its database up to date.");
         }
     }
 
     /**
      * Returns the name of the analyzer.
      *
      * @return the name of the analyzer.
      */
     @Override
     public String getName() {
         return ANALYZER_NAME;
     }
 
     /**
      * Returns the phase that the analyzer is intended to run in.
      *
      * @return the phase that the analyzer is intended to run in.
      */
     @Override
     public AnalysisPhase getAnalysisPhase() {
         return ANALYSIS_PHASE;
     }
 
     /**
      * Returns the key used in the properties file to reference the analyzer's
      * enabled property.
      *
      * @return the analyzer's enabled property setting key
      */
     @Override
     protected String getAnalyzerEnabledSettingKey() {
         return Settings.KEYS.ANALYZER_BUNDLE_AUDIT_ENABLED;
     }
 
     /**
      * If {@link #analyzeFileType(Dependency, Engine)} is called, then we have
      * successfully initialized, and it will be necessary to disable
      * {@link RubyGemspecAnalyzer}.
      */
     private boolean needToDisableGemspecAnalyzer = true;
 
     /**
      * Determines if the analyzer can analyze the given file type.
      *
      * @param dependency the dependency to determine if it can analyze
      * @param engine the dependency-check engine
      * @throws AnalysisException thrown if there is an analysis exception.
      */
     @Override
     protected void analyzeFileType(Dependency dependency, Engine engine)
             throws AnalysisException {
         if (needToDisableGemspecAnalyzer) {
             boolean failed = true;
             final String className = RubyGemspecAnalyzer.class.getName();
             for (FileTypeAnalyzer analyzer : engine.getFileTypeAnalyzers()) {
                 if (analyzer instanceof RubyBundlerAnalyzer) {
                     ((RubyBundlerAnalyzer) analyzer).setEnabled(false);
                     LOGGER.info("Disabled " + RubyBundlerAnalyzer.class.getName() + " to avoid noisy duplicate results.");
                 } else if (analyzer instanceof RubyGemspecAnalyzer) {
                     ((RubyGemspecAnalyzer) analyzer).setEnabled(false);
                     LOGGER.info("Disabled " + className + " to avoid noisy duplicate results.");
                     failed = false;
                 }
             }
             if (failed) {
                 LOGGER.warn("Did not find " + className + '.');
             }
             needToDisableGemspecAnalyzer = false;
         }
         final File parentFile = dependency.getActualFile().getParentFile();
         final Process process = launchBundleAudit(parentFile);
         try {
             process.waitFor();
         } catch (InterruptedException ie) {
             throw new AnalysisException("bundle-audit process interrupted", ie);
         }
         BufferedReader rdr = null;
         BufferedReader errReader = null;
         try {
             errReader = new BufferedReader(new InputStreamReader(process.getErrorStream(), "UTF-8"));
             while (errReader.ready()) {
                 final String error = errReader.readLine();
                 LOGGER.warn(error);
             }
             rdr = new BufferedReader(new InputStreamReader(process.getInputStream(), "UTF-8"));
             processBundlerAuditOutput(dependency, engine, rdr);
         } catch (IOException ioe) {
             LOGGER.warn("bundle-audit failure", ioe);
         } finally {
             if (errReader != null) {
                 try {
                     errReader.close();
                 } catch (IOException ioe) {
                     LOGGER.warn("bundle-audit close failure", ioe);
                 }
             }
             if (null != rdr) {
                 try {
                     rdr.close();
                 } catch (IOException ioe) {
                     LOGGER.warn("bundle-audit close failure", ioe);
                 }
             }
         }
 
     }
 
     /**
      * Processes the bundler audit output.
      *
      * @param original the dependency
      * @param engine the dependency-check engine
      * @param rdr the reader of the report
      * @throws IOException thrown if the report cannot be read.
      */
     private void processBundlerAuditOutput(Dependency original, Engine engine, BufferedReader rdr) throws IOException {
         final String parentName = original.getActualFile().getParentFile().getName();
         final String fileName = original.getFileName();
         final String filePath = original.getFilePath();
         Dependency dependency = null;
         Vulnerability vulnerability = null;
         String gem = null;
         final Map<String, Dependency> map = new HashMap<String, Dependency>();
         boolean appendToDescription = false;
         while (rdr.ready()) {
             final String nextLine = rdr.readLine();
             if (null == nextLine) {
                 break;
             } else if (nextLine.startsWith(NAME)) {
                 appendToDescription = false;
                 gem = nextLine.substring(NAME.length());
                 if (!map.containsKey(gem)) {
                     map.put(gem, createDependencyForGem(engine, parentName, fileName, filePath, gem));
                 }
                 dependency = map.get(gem);
                 LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
             } else if (nextLine.startsWith(VERSION)) {
                 vulnerability = createVulnerability(parentName, dependency, gem, nextLine);
             } else if (nextLine.startsWith(ADVISORY)) {
                 setVulnerabilityName(parentName, dependency, vulnerability, nextLine);
             } else if (nextLine.startsWith(CRITICALITY)) {
                 addCriticalityToVulnerability(parentName, vulnerability, nextLine);
             } else if (nextLine.startsWith("URL: ")) {
                 addReferenceToVulnerability(parentName, vulnerability, nextLine);
             } else if (nextLine.startsWith("Description:")) {
                 appendToDescription = true;
                 if (null != vulnerability) {
                     vulnerability.setDescription("*** Vulnerability obtained from bundle-audit verbose report. "
                             + "Title link may not work. CPE below is guessed. CVSS score is estimated (-1.0 "
                             + " indicates unknown). See link below for full details. *** ");
                 }
             } else if (appendToDescription) {
                 if (null != vulnerability) {
                     vulnerability.setDescription(vulnerability.getDescription() + nextLine + "\n");
                 }
             }
         }
     }
 
     /**
      * Sets the vulnerability name.
      *
      * @param parentName the parent name
      * @param dependency the dependency
      * @param vulnerability the vulnerability
      * @param nextLine the line to parse
      */
     private void setVulnerabilityName(String parentName, Dependency dependency, Vulnerability vulnerability, String nextLine) {
         final String advisory = nextLine.substring((ADVISORY.length()));
         if (null != vulnerability) {
             vulnerability.setName(advisory);
         }
         if (null != dependency) {
             dependency.getVulnerabilities().add(vulnerability); // needed to wait for vulnerability name to avoid NPE
         }
         LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
     }
 
     /**
      * Adds a reference to the vulnerability.
      *
      * @param parentName the parent name
      * @param vulnerability the vulnerability
      * @param nextLine the line to parse
      */
     private void addReferenceToVulnerability(String parentName, Vulnerability vulnerability, String nextLine) {
         final String url = nextLine.substring(("URL: ").length());
         if (null != vulnerability) {
             final Reference ref = new Reference();
             ref.setName(vulnerability.getName());
             ref.setSource("bundle-audit");
             ref.setUrl(url);
             vulnerability.getReferences().add(ref);
         }
         LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
     }
 
     /**
      * Adds the criticality to the vulnerability
      *
      * @param parentName the parent name
      * @param vulnerability the vulnerability
      * @param nextLine the line to parse
      */
     private void addCriticalityToVulnerability(String parentName, Vulnerability vulnerability, String nextLine) {
         if (null != vulnerability) {
             final String criticality = nextLine.substring(CRITICALITY.length()).trim();
             float score = -1.0f;
             Vulnerability v = null;
             try {
                 v = cvedb.getVulnerability(vulnerability.getName());
             } catch (DatabaseException ex) {
                 LOGGER.debug("Unable to look up vulnerability {}", vulnerability.getName());
             }
             if (v != null) {
                 score = v.getCvssScore();
             } else if ("High".equalsIgnoreCase(criticality)) {
                 score = 8.5f;
             } else if ("Medium".equalsIgnoreCase(criticality)) {
                 score = 5.5f;
             } else if ("Low".equalsIgnoreCase(criticality)) {
                 score = 2.0f;
             }
             vulnerability.setCvssScore(score);
         }
         LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
     }
 
     /**
      * Creates a vulnerability.
      *
      * @param parentName the parent name
      * @param dependency the dependency
      * @param gem the gem name
      * @param nextLine the line to parse
      * @return the vulnerability
      */
     private Vulnerability createVulnerability(String parentName, Dependency dependency, String gem, String nextLine) {
         Vulnerability vulnerability = null;
         if (null != dependency) {
             final String version = nextLine.substring(VERSION.length());
             dependency.getVersionEvidence().addEvidence(
                     "bundler-audit",
                     "Version",
                     version,
                     Confidence.HIGHEST);
             vulnerability = new Vulnerability(); // don't add to dependency until we have name set later
             vulnerability.setMatchedCPE(
                     String.format("cpe:/a:%1$s_project:%1$s:%2$s::~~~ruby~~", gem, version),
                     null);
             vulnerability.setCvssAccessVector("-");
             vulnerability.setCvssAccessComplexity("-");
             vulnerability.setCvssAuthentication("-");
             vulnerability.setCvssAvailabilityImpact("-");
             vulnerability.setCvssConfidentialityImpact("-");
             vulnerability.setCvssIntegrityImpact("-");
         }
         LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
         return vulnerability;
     }
 
     /**
      * Creates the dependency based off of the gem.
      *
      * @param engine the engine used for scanning
      * @param parentName the gem parent
      * @param fileName the file name
      * @param filePath the file path
      * @param gem the gem name
      * @return the dependency to add
      * @throws IOException thrown if a temporary gem file could not be written
      */
     private Dependency createDependencyForGem(Engine engine, String parentName, String fileName, String filePath, String gem) throws IOException {
         final File gemFile = new File(Settings.getTempDirectory(), gem + "_Gemfile.lock");
         gemFile.createNewFile();
         final String displayFileName = String.format("%s%c%s:%s", parentName, File.separatorChar, fileName, gem);
 
         FileUtils.write(gemFile, displayFileName, Charset.defaultCharset()); // unique contents to avoid dependency bundling
         final Dependency dependency = new Dependency(gemFile);
         dependency.getProductEvidence().addEvidence("bundler-audit", "Name", gem, Confidence.HIGHEST);
         dependency.setDisplayFileName(displayFileName);
         dependency.setFileName(fileName);
         dependency.setFilePath(filePath);
         engine.getDependencies().add(dependency);
         return dependency;
     }
 }

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) 2015 Institute for Defense Analyses. All Rights Reserved.
17		*/
18		package org.owasp.dependencycheck.analyzer;
19
20		import java.io.BufferedReader;
21		import java.io.File;
22		import java.io.FileFilter;
23		import java.io.IOException;
24		import java.io.InputStreamReader;
25		import java.util.ArrayList;
26		import java.util.HashMap;
27		import java.util.List;
28		import java.util.Map;
29		import java.nio.charset.Charset;
30		import org.apache.commons.io.FileUtils;
31		import org.owasp.dependencycheck.Engine;
32		import org.owasp.dependencycheck.analyzer.exception.AnalysisException;
33		import org.owasp.dependencycheck.data.nvdcve.CveDB;
34		import org.owasp.dependencycheck.dependency.Confidence;
35		import org.owasp.dependencycheck.dependency.Dependency;
36		import org.owasp.dependencycheck.dependency.Reference;
37		import org.owasp.dependencycheck.dependency.Vulnerability;
38		import org.owasp.dependencycheck.utils.FileFilterBuilder;
39		import org.owasp.dependencycheck.utils.Settings;
40		import org.slf4j.Logger;
41		import org.slf4j.LoggerFactory;
42		import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
43
44		/**
45		* Used to analyze Ruby Bundler Gemspec.lock files utilizing the 3rd party
46		* bundle-audit tool.
47		*
48		* @author Dale Visser
49		*/
50		@Experimental
51	24	public class RubyBundleAuditAnalyzer extends AbstractFileTypeAnalyzer {
52
53	2	private static final Logger LOGGER = LoggerFactory.getLogger(RubyBundleAuditAnalyzer.class);
54
55		/**
56		* The name of the analyzer.
57		*/
58		private static final String ANALYZER_NAME = "Ruby Bundle Audit Analyzer";
59
60		/**
61		* The phase that this analyzer is intended to run in.
62		*/
63	2	private static final AnalysisPhase ANALYSIS_PHASE = AnalysisPhase.PRE_INFORMATION_COLLECTION;
64		/**
65		* The filter defining which files will be analyzed.
66		*/
67	2	private static final FileFilter FILTER = FileFilterBuilder.newInstance().addFilenames("Gemfile.lock").build();
68		/**
69		* Name.
70		*/
71		public static final String NAME = "Name: ";
72		/**
73		* Version.
74		*/
75		public static final String VERSION = "Version: ";
76		/**
77		* Advisory.
78		*/
79		public static final String ADVISORY = "Advisory: ";
80		/**
81		* Criticality.
82		*/
83		public static final String CRITICALITY = "Criticality: ";
84
85		/**
86		* The DAL.
87		*/
88		private CveDB cvedb;
89
90		/**
91		* @return a filter that accepts files named Gemfile.lock
92		*/
93		@Override
94		protected FileFilter getFileFilter() {
95	1720	return FILTER;
96		}
97
98		/**
99		* Launch bundle-audit.
100		*
101		* @param folder directory that contains bundle audit
102		* @return a handle to the process
103		* @throws AnalysisException thrown when there is an issue launching bundle
104		* audit
105		*/
106		private Process launchBundleAudit(File folder) throws AnalysisException {
107	8	if (!folder.isDirectory()) {
108	0	throw new AnalysisException(String.format("%s should have been a directory.", folder.getAbsolutePath()));
109		}
110	8	final List<String> args = new ArrayList<String>();
111	8	final String bundleAuditPath = Settings.getString(Settings.KEYS.ANALYZER_BUNDLE_AUDIT_PATH);
112	8	args.add(null == bundleAuditPath ? "bundle-audit" : bundleAuditPath);
113	8	args.add("check");
114	8	args.add("--verbose");
115	8	final ProcessBuilder builder = new ProcessBuilder(args);
116	8	builder.directory(folder);
117		try {
118	8	LOGGER.info("Launching: " + args + " from " + folder);
119	8	return builder.start();
120	8	} catch (IOException ioe) {
121	8	throw new AnalysisException("bundle-audit failure", ioe);
122		}
123		}
124
125		/**
126		* Initialize the analyzer. In this case, extract GrokAssembly.exe to a
127		* temporary location.
128		*
129		* @throws Exception if anything goes wrong
130		*/
131		@Override
132		public void initializeFileTypeAnalyzer() throws Exception {
133		try {
134	8	cvedb = new CveDB();
135	8	cvedb.open();
136	0	} catch (DatabaseException ex) {
137	0	LOGGER.warn("Exception opening the database");
138	0	LOGGER.debug("error", ex);
139	0	setEnabled(false);
140	0	throw ex;
141	8	}
142		// Now, need to see if bundle-audit actually runs from this location.
143	8	Process process = null;
144		try {
145	8	process = launchBundleAudit(Settings.getTempDirectory());
146	8	} catch (AnalysisException ae) {
147	8	LOGGER.warn("Exception from bundle-audit process: {}. Disabling {}", ae.getCause(), ANALYZER_NAME);
148	8	setEnabled(false);
149	8	cvedb.close();
150	8	cvedb = null;
151	8	throw ae;
152	0	}
153
154	0	final int exitValue = process.waitFor();
155	0	if (0 == exitValue) {
156	0	LOGGER.warn("Unexpected exit code from bundle-audit process. Disabling {}: {}", ANALYZER_NAME, exitValue);
157	0	setEnabled(false);
158	0	throw new AnalysisException("Unexpected exit code from bundle-audit process.");
159		} else {
160	0	BufferedReader reader = null;
161		try {
162	0	reader = new BufferedReader(new InputStreamReader(process.getErrorStream(), "UTF-8"));
163	0	if (!reader.ready()) {
164	0	LOGGER.warn("Bundle-audit error stream unexpectedly not ready. Disabling " + ANALYZER_NAME);
165	0	setEnabled(false);
166	0	throw new AnalysisException("Bundle-audit error stream unexpectedly not ready.");
167		} else {
168	0	final String line = reader.readLine();
169	0	if (line == null \|\| !line.contains("Errno::ENOENT")) {
170	0	LOGGER.warn("Unexpected bundle-audit output. Disabling {}: {}", ANALYZER_NAME, line);
171	0	setEnabled(false);
172	0	throw new AnalysisException("Unexpected bundle-audit output.");
173		}
174		}
175		} finally {
176	0	if (null != reader) {
177	0	reader.close();
178		}
179		}
180		}
181
182	0	if (isEnabled()) {
183	0	LOGGER.info(ANALYZER_NAME + " is enabled. It is necessary to manually run \"bundle-audit update\" "
184		+ "occasionally to keep its database up to date.");
185		}
186	0	}
187
188		/**
189		* Returns the name of the analyzer.
190		*
191		* @return the name of the analyzer.
192		*/
193		@Override
194		public String getName() {
195	32	return ANALYZER_NAME;
196		}
197
198		/**
199		* Returns the phase that the analyzer is intended to run in.
200		*
201		* @return the phase that the analyzer is intended to run in.
202		*/
203		@Override
204		public AnalysisPhase getAnalysisPhase() {
205	8	return ANALYSIS_PHASE;
206		}
207
208		/**
209		* Returns the key used in the properties file to reference the analyzer's
210		* enabled property.
211		*
212		* @return the analyzer's enabled property setting key
213		*/
214		@Override
215		protected String getAnalyzerEnabledSettingKey() {
216	24	return Settings.KEYS.ANALYZER_BUNDLE_AUDIT_ENABLED;
217		}
218
219		/**
220		* If {@link #analyzeFileType(Dependency, Engine)} is called, then we have
221		* successfully initialized, and it will be necessary to disable
222		* {@link RubyGemspecAnalyzer}.
223		*/
224	24	private boolean needToDisableGemspecAnalyzer = true;
225
226		/**
227		* Determines if the analyzer can analyze the given file type.
228		*
229		* @param dependency the dependency to determine if it can analyze
230		* @param engine the dependency-check engine
231		* @throws AnalysisException thrown if there is an analysis exception.
232		*/
233		@Override
234		protected void analyzeFileType(Dependency dependency, Engine engine)
235		throws AnalysisException {
236	0	if (needToDisableGemspecAnalyzer) {
237	0	boolean failed = true;
238	0	final String className = RubyGemspecAnalyzer.class.getName();
239	0	for (FileTypeAnalyzer analyzer : engine.getFileTypeAnalyzers()) {
240	0	if (analyzer instanceof RubyBundlerAnalyzer) {
241	0	((RubyBundlerAnalyzer) analyzer).setEnabled(false);
242	0	LOGGER.info("Disabled " + RubyBundlerAnalyzer.class.getName() + " to avoid noisy duplicate results.");
243	0	} else if (analyzer instanceof RubyGemspecAnalyzer) {
244	0	((RubyGemspecAnalyzer) analyzer).setEnabled(false);
245	0	LOGGER.info("Disabled " + className + " to avoid noisy duplicate results.");
246	0	failed = false;
247		}
248	0	}
249	0	if (failed) {
250	0	LOGGER.warn("Did not find " + className + '.');
251		}
252	0	needToDisableGemspecAnalyzer = false;
253		}
254	0	final File parentFile = dependency.getActualFile().getParentFile();
255	0	final Process process = launchBundleAudit(parentFile);
256		try {
257	0	process.waitFor();
258	0	} catch (InterruptedException ie) {
259	0	throw new AnalysisException("bundle-audit process interrupted", ie);
260	0	}
261	0	BufferedReader rdr = null;
262	0	BufferedReader errReader = null;
263		try {
264	0	errReader = new BufferedReader(new InputStreamReader(process.getErrorStream(), "UTF-8"));
265	0	while (errReader.ready()) {
266	0	final String error = errReader.readLine();
267	0	LOGGER.warn(error);
268	0	}
269	0	rdr = new BufferedReader(new InputStreamReader(process.getInputStream(), "UTF-8"));
270	0	processBundlerAuditOutput(dependency, engine, rdr);
271	0	} catch (IOException ioe) {
272	0	LOGGER.warn("bundle-audit failure", ioe);
273		} finally {
274	0	if (errReader != null) {
275		try {
276	0	errReader.close();
277	0	} catch (IOException ioe) {
278	0	LOGGER.warn("bundle-audit close failure", ioe);
279	0	}
280		}
281	0	if (null != rdr) {
282		try {
283	0	rdr.close();
284	0	} catch (IOException ioe) {
285	0	LOGGER.warn("bundle-audit close failure", ioe);
286	0	}
287		}
288		}
289
290	0	}
291
292		/**
293		* Processes the bundler audit output.
294		*
295		* @param original the dependency
296		* @param engine the dependency-check engine
297		* @param rdr the reader of the report
298		* @throws IOException thrown if the report cannot be read.
299		*/
300		private void processBundlerAuditOutput(Dependency original, Engine engine, BufferedReader rdr) throws IOException {
301	0	final String parentName = original.getActualFile().getParentFile().getName();
302	0	final String fileName = original.getFileName();
303	0	final String filePath = original.getFilePath();
304	0	Dependency dependency = null;
305	0	Vulnerability vulnerability = null;
306	0	String gem = null;
307	0	final Map<String, Dependency> map = new HashMap<String, Dependency>();
308	0	boolean appendToDescription = false;
309	0	while (rdr.ready()) {
310	0	final String nextLine = rdr.readLine();
311	0	if (null == nextLine) {
312	0	break;
313	0	} else if (nextLine.startsWith(NAME)) {
314	0	appendToDescription = false;
315	0	gem = nextLine.substring(NAME.length());
316	0	if (!map.containsKey(gem)) {
317	0	map.put(gem, createDependencyForGem(engine, parentName, fileName, filePath, gem));
318		}
319	0	dependency = map.get(gem);
320	0	LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
321	0	} else if (nextLine.startsWith(VERSION)) {
322	0	vulnerability = createVulnerability(parentName, dependency, gem, nextLine);
323	0	} else if (nextLine.startsWith(ADVISORY)) {
324	0	setVulnerabilityName(parentName, dependency, vulnerability, nextLine);
325	0	} else if (nextLine.startsWith(CRITICALITY)) {
326	0	addCriticalityToVulnerability(parentName, vulnerability, nextLine);
327	0	} else if (nextLine.startsWith("URL: ")) {
328	0	addReferenceToVulnerability(parentName, vulnerability, nextLine);
329	0	} else if (nextLine.startsWith("Description:")) {
330	0	appendToDescription = true;
331	0	if (null != vulnerability) {
332	0	vulnerability.setDescription("*** Vulnerability obtained from bundle-audit verbose report. "
333		+ "Title link may not work. CPE below is guessed. CVSS score is estimated (-1.0 "
334		+ " indicates unknown). See link below for full details. *** ");
335		}
336	0	} else if (appendToDescription) {
337	0	if (null != vulnerability) {
338	0	vulnerability.setDescription(vulnerability.getDescription() + nextLine + "\n");
339		}
340		}
341	0	}
342	0	}
343
344		/**
345		* Sets the vulnerability name.
346		*
347		* @param parentName the parent name
348		* @param dependency the dependency
349		* @param vulnerability the vulnerability
350		* @param nextLine the line to parse
351		*/
352		private void setVulnerabilityName(String parentName, Dependency dependency, Vulnerability vulnerability, String nextLine) {
353	0	final String advisory = nextLine.substring((ADVISORY.length()));
354	0	if (null != vulnerability) {
355	0	vulnerability.setName(advisory);
356		}
357	0	if (null != dependency) {
358	0	dependency.getVulnerabilities().add(vulnerability); // needed to wait for vulnerability name to avoid NPE
359		}
360	0	LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
361	0	}
362
363		/**
364		* Adds a reference to the vulnerability.
365		*
366		* @param parentName the parent name
367		* @param vulnerability the vulnerability
368		* @param nextLine the line to parse
369		*/
370		private void addReferenceToVulnerability(String parentName, Vulnerability vulnerability, String nextLine) {
371	0	final String url = nextLine.substring(("URL: ").length());
372	0	if (null != vulnerability) {
373	0	final Reference ref = new Reference();
374	0	ref.setName(vulnerability.getName());
375	0	ref.setSource("bundle-audit");
376	0	ref.setUrl(url);
377	0	vulnerability.getReferences().add(ref);
378		}
379	0	LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
380	0	}
381
382		/**
383		* Adds the criticality to the vulnerability
384		*
385		* @param parentName the parent name
386		* @param vulnerability the vulnerability
387		* @param nextLine the line to parse
388		*/
389		private void addCriticalityToVulnerability(String parentName, Vulnerability vulnerability, String nextLine) {
390	0	if (null != vulnerability) {
391	0	final String criticality = nextLine.substring(CRITICALITY.length()).trim();
392	0	float score = -1.0f;
393	0	Vulnerability v = null;
394		try {
395	0	v = cvedb.getVulnerability(vulnerability.getName());
396	0	} catch (DatabaseException ex) {
397	0	LOGGER.debug("Unable to look up vulnerability {}", vulnerability.getName());
398	0	}
399	0	if (v != null) {
400	0	score = v.getCvssScore();
401	0	} else if ("High".equalsIgnoreCase(criticality)) {
402	0	score = 8.5f;
403	0	} else if ("Medium".equalsIgnoreCase(criticality)) {
404	0	score = 5.5f;
405	0	} else if ("Low".equalsIgnoreCase(criticality)) {
406	0	score = 2.0f;
407		}
408	0	vulnerability.setCvssScore(score);
409		}
410	0	LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
411	0	}
412
413		/**
414		* Creates a vulnerability.
415		*
416		* @param parentName the parent name
417		* @param dependency the dependency
418		* @param gem the gem name
419		* @param nextLine the line to parse
420		* @return the vulnerability
421		*/
422		private Vulnerability createVulnerability(String parentName, Dependency dependency, String gem, String nextLine) {
423	0	Vulnerability vulnerability = null;
424	0	if (null != dependency) {
425	0	final String version = nextLine.substring(VERSION.length());
426	0	dependency.getVersionEvidence().addEvidence(
427		"bundler-audit",
428		"Version",
429		version,
430		Confidence.HIGHEST);
431	0	vulnerability = new Vulnerability(); // don't add to dependency until we have name set later
432	0	vulnerability.setMatchedCPE(
433	0	String.format("cpe:/a:%1$s_project:%1$s:%2$s::~~~ruby~~", gem, version),
434		null);
435	0	vulnerability.setCvssAccessVector("-");
436	0	vulnerability.setCvssAccessComplexity("-");
437	0	vulnerability.setCvssAuthentication("-");
438	0	vulnerability.setCvssAvailabilityImpact("-");
439	0	vulnerability.setCvssConfidentialityImpact("-");
440	0	vulnerability.setCvssIntegrityImpact("-");
441		}
442	0	LOGGER.debug(String.format("bundle-audit (%s): %s", parentName, nextLine));
443	0	return vulnerability;
444		}
445
446		/**
447		* Creates the dependency based off of the gem.
448		*
449		* @param engine the engine used for scanning
450		* @param parentName the gem parent
451		* @param fileName the file name
452		* @param filePath the file path
453		* @param gem the gem name
454		* @return the dependency to add
455		* @throws IOException thrown if a temporary gem file could not be written
456		*/
457		private Dependency createDependencyForGem(Engine engine, String parentName, String fileName, String filePath, String gem) throws IOException {
458	0	final File gemFile = new File(Settings.getTempDirectory(), gem + "_Gemfile.lock");
459	0	gemFile.createNewFile();
460	0	final String displayFileName = String.format("%s%c%s:%s", parentName, File.separatorChar, fileName, gem);
461
462	0	FileUtils.write(gemFile, displayFileName, Charset.defaultCharset()); // unique contents to avoid dependency bundling
463	0	final Dependency dependency = new Dependency(gemFile);
464	0	dependency.getProductEvidence().addEvidence("bundler-audit", "Name", gem, Confidence.HIGHEST);
465	0	dependency.setDisplayFileName(displayFileName);
466	0	dependency.setFileName(fileName);
467	0	dependency.setFilePath(filePath);
468	0	engine.getDependencies().add(dependency);
469	0	return dependency;
470		}
471		}