Class PythonPackageAnalyzer

java.lang.Object

org.owasp.dependencycheck.analyzer.AbstractAnalyzer

org.owasp.dependencycheck.analyzer.AbstractFileTypeAnalyzer

org.owasp.dependencycheck.analyzer.PythonPackageAnalyzer

All Implemented Interfaces:

FileFilter, Analyzer, FileTypeAnalyzer

@ThreadSafe
public class PythonPackageAnalyzer
extends AbstractFileTypeAnalyzer

Used to analyze a Python package, and collect information that can be used to determine the associated CPE.

Author:

Dale Visser

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEPENDENCY_ECOSYSTEM	A descriptor for the type of dependencies processed or added by this analyzer.

Constructor Summary

Constructors

Constructor	Description
PythonPackageAnalyzer()

Method Summary

Modifier and Type	Method	Description
protected void	analyzeDependency(Dependency dependency, Engine engine)	Analyzes python packages and adds evidence to the dependency.
AnalysisPhase	getAnalysisPhase()	Tell that we are used for information collection.
protected String	getAnalyzerEnabledSettingKey()	Returns the key name for the analyzers enabled setting.
protected FileFilter	getFileFilter()	Returns the FileFilter
String	getName()	Returns the name of the Python Package Analyzer.
protected void	prepareFileTypeAnalyzer(Engine engine)	No-op initializer implementation.

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

Constructor Details

PythonPackageAnalyzer

public PythonPackageAnalyzer()

Method Details

getName

public String getName()

Returns the name of the Python Package Analyzer.

Returns:

the name of the analyzer

getAnalysisPhase

public AnalysisPhase getAnalysisPhase()

Tell that we are used for information collection.

Returns:

INFORMATION_COLLECTION

getAnalyzerEnabledSettingKey

protected String getAnalyzerEnabledSettingKey()

Returns the key name for the analyzers enabled setting.

Specified by:

getAnalyzerEnabledSettingKey in class AbstractAnalyzer

Returns:

the key name for the analyzers enabled setting

getFileFilter

protected FileFilter getFileFilter()

Returns the FileFilter

Specified by:

getFileFilter in class AbstractFileTypeAnalyzer

Returns:

the FileFilter

prepareFileTypeAnalyzer

protected void prepareFileTypeAnalyzer(Engine engine)
                                throws InitializationException

No-op initializer implementation.

Specified by:

prepareFileTypeAnalyzer in class AbstractFileTypeAnalyzer

Parameters:

engine - a reference to the dependency-check engine

Throws:

InitializationException - never thrown

analyzeDependency

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

Analyzes python packages and adds evidence to the dependency.

Specified by:

analyzeDependency in class AbstractAnalyzer

Parameters:

dependency - the dependency being analyzed

engine - the engine being used to perform the scan

Throws:

AnalysisException - thrown if there is an unrecoverable error analyzing the dependency