Class RubyBundleAuditAnalyzer

java.lang.Object

org.owasp.dependencycheck.analyzer.AbstractAnalyzer

org.owasp.dependencycheck.analyzer.AbstractFileTypeAnalyzer

org.owasp.dependencycheck.analyzer.RubyBundleAuditAnalyzer

All Implemented Interfaces:

FileFilter, Analyzer, FileTypeAnalyzer

@ThreadSafe
public class RubyBundleAuditAnalyzer
extends AbstractFileTypeAnalyzer

Used to analyze Ruby Bundler Gemspec.lock files utilizing the 3rd party bundle-audit tool.

Author:

Dale Visser

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADVISORY	Advisory.
static final String	CRITICALITY	Criticality.
static final String	CVE	CVE.
static final String	DEPENDENCY_ECOSYSTEM	A descriptor for the type of dependencies processed or added by this analyzer.
static final String	NAME	Name.
static final String	VERSION	Version.

Constructor Summary

Constructors

Constructor	Description
RubyBundleAuditAnalyzer()

Method Summary

Modifier and Type	Method	Description
protected void	analyzeDependency(Dependency dependency, Engine engine)	Determines if the analyzer can analyze the given file type.
AnalysisPhase	getAnalysisPhase()	Returns the phase that the analyzer is intended to run in.
protected String	getAnalyzerEnabledSettingKey()	Returns the key used in the properties file to reference the analyzer's enabled property.
protected FileFilter	getFileFilter()	Returns the FileFilter used to determine which files are to be analyzed.
String	getName()	Returns the name of the analyzer.
void	prepareFileTypeAnalyzer(Engine engine)	Initialize the analyzer.

Methods inherited from class AbstractFileTypeAnalyzer

accept, getFilesMatched, newHashSet, prepareAnalyzer, setFilesMatched

Methods inherited from class AbstractAnalyzer

analyze, close, closeAnalyzer, getSettings, initialize, isEnabled, prepare, setEnabled, supportsParallelProcessing

Methods inherited from class Object

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

Methods inherited from interface Analyzer

analyze, close, initialize, isEnabled, prepare, supportsParallelProcessing

Field Details

DEPENDENCY_ECOSYSTEM

public static final String DEPENDENCY_ECOSYSTEM

A descriptor for the type of dependencies processed or added by this analyzer.

See Also:

• Constant Field Values

NAME

public static final String NAME

Name.

See Also:

• Constant Field Values

VERSION

public static final String VERSION

Version.

See Also:

• Constant Field Values

ADVISORY

public static final String ADVISORY

Advisory.

See Also:

• Constant Field Values

CVE

public static final String CVE

CVE.

See Also:

• Constant Field Values

CRITICALITY

public static final String CRITICALITY

Criticality.

See Also:

• Constant Field Values

Constructor Details

RubyBundleAuditAnalyzer

public RubyBundleAuditAnalyzer()

Method Details

getFileFilter

protected FileFilter getFileFilter()

Description copied from class: AbstractFileTypeAnalyzer

Returns the FileFilter used to determine which files are to be analyzed. An example would be an analyzer that inspected Java jar files. Implementors may use FileFilterBuilder.

If the analyzer returns null it will not cause additional files to be analyzed, but will be executed against every file loaded.

Specified by:

getFileFilter in class AbstractFileTypeAnalyzer

Returns:

a filter that accepts files named Gemfile.lock

getName

public String getName()

Returns the name of the analyzer.

Returns:

the name of the analyzer.

getAnalysisPhase

public AnalysisPhase getAnalysisPhase()

Returns the phase that the analyzer is intended to run in.

Returns:

the phase that the analyzer is intended to run in.

getAnalyzerEnabledSettingKey

protected String getAnalyzerEnabledSettingKey()

Returns the key used in the properties file to reference the analyzer's enabled property.

Specified by:

getAnalyzerEnabledSettingKey in class AbstractAnalyzer

Returns:

the analyzer's enabled property setting key

prepareFileTypeAnalyzer

public void prepareFileTypeAnalyzer(Engine engine)
                             throws InitializationException

Initialize the analyzer.

Specified by:

prepareFileTypeAnalyzer in class AbstractFileTypeAnalyzer

Parameters:

engine - a reference to the dependency-checkException engine

Throws:

InitializationException - if anything goes wrong

analyzeDependency

protected void analyzeDependency(Dependency dependency,
 Engine engine)
                          throws AnalysisException

Determines if the analyzer can analyze the given file type.

Specified by:

analyzeDependency in class AbstractAnalyzer

Parameters:

dependency - the dependency to determine if it can analyze

engine - the dependency-checkException engine

Throws:

AnalysisException - thrown if there is an analysis exception.