

malwareExecuteScan

Performs a malware scan

Parameters

Overview

Name	Mandatory	Additional information
file	yes
host	yes
malwareScanCredentialsId	yes	id of credentials (using credentials)
password	yes	pass via ENV or Jenkins credentials
script	yes	reference to Jenkins main pipeline script
username	yes	pass via ENV or Jenkins credentials
timeout	no
verbose	no	activates debug output

Details

file

The file which is scanned for malware

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	yes
Default	$PIPER_file (if set)
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

host

malware scanning host.

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	yes
Default	$PIPER_host (if set)
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

malwareScanCredentialsId

Jenkins-specific: Used for proper environment setup.

The technical user/password credential used to communicate with the malwarescanning service

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	yes
Default
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

password

Password

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	yes
Default	$PIPER_password (if set)
Secret	yes
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

script

Jenkins-specific: Used for proper environment setup.

The common script environment of the Jenkinsfile running. Typically the reference to the script calling the pipeline step is provided with the this parameter, as in script: this. This allows the function to access the commonPipelineEnvironment for retrieving, e.g. configuration parameters.

back to overview

Scope	Details
Aliases	-
Type	Jenkins Script
Mandatory	yes
Default
Secret	no
Configuration scope	☐ parameter ☐ general ☐ steps ☐ stages
Resource references	none

timeout

timeout for http layer in seconds

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	no
Default	600
Secret	no
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

username

User

back to overview

Scope	Details
Aliases	-
Type	string
Mandatory	yes
Default	$PIPER_username (if set)
Secret	yes
Configuration scope	☒ parameter ☐ general ☒ steps ☒ stages
Resource references	none

verbose

verbose output

back to overview

Scope	Details
Aliases	-
Type	bool
Mandatory	no
Default	false
Possible values	- true - false
Secret	no
Configuration scope	☒ parameter ☒ general ☒ steps ☒ stages
Resource references	none

Exceptions

None

Examples

malwareExecuteScan script: this

configuration

steps:
    malwareExecuteScan:
        file: myFile.zip
        host: https://malwarescanner.example.sap.com
        malwareScanCredentialsId: MALWARESCAN