Coverage Report

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

Classes in this File

Line Coverage

Branch Coverage

Complexity

RubyBundleAuditAnalyzer

14%

32/221

2/78

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