Package com.fortify.plugin.jenkins

Class FortifyPlugin

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

com.fortify.plugin.jenkins.FortifyPlugin

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep

public class FortifyPlugin
extends Recorder

Fortify Jenkins plugin to work with Fortify Software Security Center and Fortify Static Code Analyzer

Main plugin functionality:

• Provide pipeline and other means to launch Fortify Static Code Analysis (SCA) as part of the build
• Upload the resulting FPR analysis file to Fortify Software Security Center (SSC) server
• Calculate NVS from the results collected from SSC and plot graph on the project main page
• Make a build to be UNSTABLE if some critical vulnerabilities are found (or based on other info from SSC)
• Display detailed list of vulnerabilities collected from SSC and provide remediation links

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FortifyPlugin.AdvancedTranslationBlock	Deprecated.
static class	FortifyPlugin.AnalysisRunType
static interface	FortifyPlugin.BasicDotNetBuildTypeBlock	Deprecated.
static class	FortifyPlugin.BasicDotNetDevenvBuildTypeBlock	Deprecated.
static class	FortifyPlugin.BasicDotNetMSBuildBuildTypeBlock	Deprecated.
static class	FortifyPlugin.BasicDotNetProjectSolutionScanTypeBlock	Deprecated.
static interface	FortifyPlugin.BasicDotNetScanTypeBlock	Deprecated.
static class	FortifyPlugin.BasicDotNetSourceCodeScanTypeBlock	Deprecated.
static class	FortifyPlugin.BasicDotNetTranslationAppTypeBlock	Deprecated.
static class	FortifyPlugin.BasicGradleTranslationAppTypeBlock	Deprecated.
static class	FortifyPlugin.BasicJavaTranslationAppTypeBlock	Deprecated.
static class	FortifyPlugin.BasicMaven3TranslationAppTypeBlock	Deprecated.
static class	FortifyPlugin.BasicOtherTranslationAppTypeBlock	Deprecated.
static interface	FortifyPlugin.BasicTranslationAppTypeBlock	Deprecated.
static class	FortifyPlugin.BasicTranslationBlock	Deprecated.
static class	FortifyPlugin.DescriptorImpl
static class	FortifyPlugin.RemoteOptionalConfigBlock
static class	FortifyPlugin.RunScanBlock
static class	FortifyPlugin.RunTranslationBlock	Deprecated.
static interface	FortifyPlugin.TranslationTypeBlock	Deprecated.
static class	FortifyPlugin.UpdateContentBlock
static class	FortifyPlugin.UploadSSCBlock
static class	FortifyPlugin.UseProxyBlock	Deprecated.

Nested classes/interfaces inherited from class hudson.tasks.Publisher

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_APP_VERSION_LIST_LIMIT
static int	DEFAULT_PAGE_SIZE
static FortifyPlugin.DescriptorImpl	DESCRIPTOR

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
FortifyPlugin(FortifyPlugin.AnalysisRunType analysisRunType)
FortifyPlugin(String buildId, String scanFile, String maxHeap, String addJVMOptions, FortifyPlugin.UpdateContentBlock updateContent, boolean runSCAClean, FortifyPlugin.RunTranslationBlock runTranslation, FortifyPlugin.RunScanBlock runScan, FortifyPlugin.UploadSSCBlock uploadSSC)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	getAcceptKey()
String	getAddJVMOptions()
boolean	getAnalysisRunType()
String	getAppName()
String	getAppVersion()
String	getBuildFile()
String	getBuildId()
String	getBuildTool()
String	getCustomRulepacks()
String	getDotNetDevenvAddOptions()	Deprecated.
String	getDotNetDevenvProjects()	Deprecated.
String	getDotNetMSBuildAddOptions()	Deprecated.
String	getDotNetMSBuildProjects()	Deprecated.
String	getDotNetSourceCodeAddOptions()	Deprecated.
String	getDotNetSourceCodeFrameworkVersion()	Deprecated.
String	getDotNetSourceCodeLibdirs()	Deprecated.
String	getDotNetSourceCodeSrcFiles()	Deprecated.
String	getFilterFile()
String	getFilterSet()
String	getGradleOptions()	Deprecated.
String	getGradleTasks()	Deprecated.
boolean	getGradleUseWrapper()	Deprecated.
boolean	getIncludeTests()
boolean	getIsAdvancedTranslationType()	Deprecated.
boolean	getIsBasicDotNetDevenvBuildType()	Deprecated.
boolean	getIsBasicDotNetMSBuildBuildType()	Deprecated.
boolean	getIsBasicDotNetProjectSolutionScanType()	Deprecated.
boolean	getIsBasicDotNetSourceCodeScanType()	Deprecated.
boolean	getIsBasicDotNetTranslationType()	Deprecated.
boolean	getIsBasicGradleTranslationType()	Deprecated.
boolean	getIsBasicJavaTranslationType()	Deprecated.
boolean	getIsBasicMaven3TranslationType()	Deprecated.
boolean	getIsBasicOtherTranslationType()	Deprecated.
boolean	getIsBasicTranslationType()	Deprecated.
String	getLocale()
String	getMaven3Options()	Deprecated.
String	getMaxHeap()
String	getNotifyEmail()
String	getOtherIncludesList()	Deprecated.
String	getOtherOptions()	Deprecated.
static String	getPluginVersion()
String	getPollingInterval()
Collection<? extends Action>	getProjectActions(AbstractProject<?,?> project)
String	getProjectName()	Deprecated.
ProjectScanType	getProjectScanType()
String	getProjectVersion()	Deprecated.
RemoteAnalysisProjectType	getRemoteAnalysisProjectType()
boolean	getRemoteOptionalConfig()
BuildStepMonitor	getRequiredMonitorService()
boolean	getRunScan()
boolean	getRunTranslation()	Deprecated.
String	getScanAddOptions()
String	getScanArgs()
String	getScanCustomRulepacks()
boolean	getScanDebug()
String	getScanFile()
String	getScanLogFile()
String	getScanOptions()
boolean	getScanVerbose()
String	getSearchCondition()
String	getSensorPoolUUID()
boolean	getSkipBuild()
String	getTimeout()
String	getTransArgs()
boolean	getTranslationDebug()	Deprecated.
String	getTranslationExcludeList()
String	getTranslationJavaAddOptions()	Deprecated.
String	getTranslationJavaClasspath()	Deprecated.
String	getTranslationJavaSourceFiles()	Deprecated.
String	getTranslationJavaVersion()	Deprecated.
String	getTranslationLogFile()
String	getTranslationOptions()	Deprecated.
String	getTranslationType()	Deprecated.
boolean	getTranslationVerbose()	Deprecated.
boolean	getUpdateContent()
String	getUpdateProxyPassword()	Deprecated.
String	getUpdateProxyUrl()	Deprecated.
String	getUpdateProxyUsername()	Deprecated.
String	getUpdateServerUrl()
boolean	getUpdateUseProxy()	Deprecated.
boolean	getUploadSSC()
String	getUploadWaitTime()	Deprecated.
boolean	isLocal()
boolean	isMixed()
boolean	isRemote()
boolean	isTranslationDebug()
boolean	isTranslationVerbose()
boolean	isUploadOnly()
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
protected Object	readResolve()
static <T> T	runWithFortifyClient(String token, FortifyClient.Command<T> cmd)

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, perform, prebuild

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

DEFAULT_APP_VERSION_LIST_LIMIT

public static final int DEFAULT_APP_VERSION_LIST_LIMIT

See Also:

Constant Field Values

DESCRIPTOR

@Extension
public static final FortifyPlugin.DescriptorImpl DESCRIPTOR

Constructor Detail

FortifyPlugin

@DataBoundConstructor
public FortifyPlugin(FortifyPlugin.AnalysisRunType analysisRunType)

FortifyPlugin

@Deprecated
public FortifyPlugin(String buildId,
                     String scanFile,
                     String maxHeap,
                     String addJVMOptions,
                     FortifyPlugin.UpdateContentBlock updateContent,
                     boolean runSCAClean,
                     FortifyPlugin.RunTranslationBlock runTranslation,
                     FortifyPlugin.RunScanBlock runScan,
                     FortifyPlugin.UploadSSCBlock uploadSSC)

Deprecated.

Method Detail

getPluginVersion

public static String getPluginVersion()

readResolve

protected Object readResolve()

getAnalysisRunType

public boolean getAnalysisRunType()

getRemoteAnalysisProjectType

public RemoteAnalysisProjectType getRemoteAnalysisProjectType()

getProjectScanType

public ProjectScanType getProjectScanType()

isRemote

public boolean isRemote()

isMixed

public boolean isMixed()

isLocal

public boolean isLocal()

isUploadOnly

public boolean isUploadOnly()

isTranslationDebug

public boolean isTranslationDebug()

isTranslationVerbose

public boolean isTranslationVerbose()

getBuildId

public String getBuildId()

getScanFile

public String getScanFile()

getMaxHeap

public String getMaxHeap()

getAddJVMOptions

public String getAddJVMOptions()

getUpdateContent

public boolean getUpdateContent()

getRunTranslation

@Deprecated
public boolean getRunTranslation()

Deprecated.

getRunScan

public boolean getRunScan()

getUploadSSC

public boolean getUploadSSC()

getUpdateServerUrl

public String getUpdateServerUrl()

getLocale

public String getLocale()

getAcceptKey

public boolean getAcceptKey()

getUpdateUseProxy

@Deprecated
public boolean getUpdateUseProxy()

Deprecated.

getUpdateProxyUrl

@Deprecated
public String getUpdateProxyUrl()

Deprecated.

getUpdateProxyUsername

@Deprecated
public String getUpdateProxyUsername()

Deprecated.

getUpdateProxyPassword

@Deprecated
public String getUpdateProxyPassword()

Deprecated.

getTranslationType

@Deprecated
public String getTranslationType()

Deprecated.

getIsBasicTranslationType

@Deprecated
public boolean getIsBasicTranslationType()

Deprecated.

getIsAdvancedTranslationType

@Deprecated
public boolean getIsAdvancedTranslationType()

Deprecated.

getIsBasicJavaTranslationType

@Deprecated
public boolean getIsBasicJavaTranslationType()

Deprecated.

getIsBasicDotNetTranslationType

@Deprecated
public boolean getIsBasicDotNetTranslationType()

Deprecated.

getIsBasicMaven3TranslationType

@Deprecated
public boolean getIsBasicMaven3TranslationType()

Deprecated.

getIsBasicGradleTranslationType

@Deprecated
public boolean getIsBasicGradleTranslationType()

Deprecated.

getIsBasicOtherTranslationType

@Deprecated
public boolean getIsBasicOtherTranslationType()

Deprecated.

getTranslationJavaVersion

@Deprecated
public String getTranslationJavaVersion()

Deprecated.

getTranslationJavaClasspath

@Deprecated
public String getTranslationJavaClasspath()

Deprecated.

getTranslationJavaSourceFiles

@Deprecated
public String getTranslationJavaSourceFiles()

Deprecated.

getTranslationJavaAddOptions

@Deprecated
public String getTranslationJavaAddOptions()

Deprecated.

getTranslationExcludeList

public String getTranslationExcludeList()

getTranslationOptions

@Deprecated
public String getTranslationOptions()

Deprecated.

getTranslationDebug

@Deprecated
public boolean getTranslationDebug()

Deprecated.

getTranslationVerbose

@Deprecated
public boolean getTranslationVerbose()

Deprecated.

getTranslationLogFile

public String getTranslationLogFile()

getIsBasicDotNetProjectSolutionScanType

@Deprecated
public boolean getIsBasicDotNetProjectSolutionScanType()

Deprecated.

getIsBasicDotNetSourceCodeScanType

@Deprecated
public boolean getIsBasicDotNetSourceCodeScanType()

Deprecated.

getIsBasicDotNetDevenvBuildType

@Deprecated
public boolean getIsBasicDotNetDevenvBuildType()

Deprecated.

getIsBasicDotNetMSBuildBuildType

@Deprecated
public boolean getIsBasicDotNetMSBuildBuildType()

Deprecated.

getDotNetDevenvProjects

@Deprecated
public String getDotNetDevenvProjects()

Deprecated.

getDotNetDevenvAddOptions

@Deprecated
public String getDotNetDevenvAddOptions()

Deprecated.

getDotNetMSBuildProjects

@Deprecated
public String getDotNetMSBuildProjects()

Deprecated.

getDotNetMSBuildAddOptions

@Deprecated
public String getDotNetMSBuildAddOptions()

Deprecated.

getDotNetSourceCodeFrameworkVersion

@Deprecated
public String getDotNetSourceCodeFrameworkVersion()

Deprecated.

getDotNetSourceCodeLibdirs

@Deprecated
public String getDotNetSourceCodeLibdirs()

Deprecated.

getDotNetSourceCodeAddOptions

@Deprecated
public String getDotNetSourceCodeAddOptions()

Deprecated.

getDotNetSourceCodeSrcFiles

@Deprecated
public String getDotNetSourceCodeSrcFiles()

Deprecated.

getMaven3Options

@Deprecated
public String getMaven3Options()

Deprecated.

getGradleUseWrapper

@Deprecated
public boolean getGradleUseWrapper()

Deprecated.

getGradleTasks

@Deprecated
public String getGradleTasks()

Deprecated.

getGradleOptions

@Deprecated
public String getGradleOptions()

Deprecated.

getOtherOptions

@Deprecated
public String getOtherOptions()

Deprecated.

getOtherIncludesList

@Deprecated
public String getOtherIncludesList()

Deprecated.

getScanCustomRulepacks

public String getScanCustomRulepacks()

getScanAddOptions

public String getScanAddOptions()

getScanDebug

public boolean getScanDebug()

getScanVerbose

public boolean getScanVerbose()

getScanLogFile

public String getScanLogFile()

getFilterSet

public String getFilterSet()

getSearchCondition

public String getSearchCondition()

getProjectName

@Deprecated
public String getProjectName()

Deprecated.

getAppName

public String getAppName()

getProjectVersion

@Deprecated
public String getProjectVersion()

Deprecated.

getAppVersion

public String getAppVersion()

getUploadWaitTime

@Deprecated
public String getUploadWaitTime()

Deprecated.

getTimeout

public String getTimeout()

getPollingInterval

public String getPollingInterval()

getRemoteOptionalConfig

public boolean getRemoteOptionalConfig()

getSensorPoolUUID

public String getSensorPoolUUID()

getNotifyEmail

public String getNotifyEmail()

getScanOptions

public String getScanOptions()

getCustomRulepacks

public String getCustomRulepacks()

getFilterFile

public String getFilterFile()

getBuildTool

public String getBuildTool()

getBuildFile

public String getBuildFile()

getIncludeTests

public boolean getIncludeTests()

getSkipBuild

public boolean getSkipBuild()

getTransArgs

public String getTransArgs()

getScanArgs

public String getScanArgs()

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

getProjectActions

public Collection<? extends Action> getProjectActions(AbstractProject<?,?> project)

Specified by:

getProjectActions in interface BuildStep

Overrides:

getProjectActions in class BuildStepCompatibilityLayer

perform

public boolean perform(AbstractBuild<?,?> build,
                       Launcher launcher,
                       BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

runWithFortifyClient

public static <T> T runWithFortifyClient(String token,
                                         FortifyClient.Command<T> cmd)
                                  throws Exception

Throws:

Exception