The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.

For a list of other such plugins, see the Pipeline Steps Reference page.

Protecode SC

protecodesc: Black Duck Binary Analysis

  • credentialsId (optional)
    BDBA supports both username/password and an API token.
    • Type: String
  • protecodeScGroup (optional)
    Specify the BDBA Group ID where the artifacts should be uploaded to.

    Group ID can be found from the BDBA service by looking at the URL when browsing an individual group: or with Groups API

    Please notice that this value should be a number, not the name or the path to the group.
    • Type: String
  • convertToSummary (optional)
    The summary can be shown using Summary Display Jenkins Plugin.
    The report file name to publish is protecodesc.xml.

    If you wish to see only the latest results in the summary, you can run a "shell command" build step before the BDBA build step: "rm -rf reports". You can find the mentioned build step in the list of possible build steps on the build configuration page. Please notice that this action is irreversible.
    • Type: boolean
  • customHeader (optional)
    Please specify the custom header in JSON format for fetching a file by URL

    This is for the cases where the server from which BDBA must fetch the file requires authentication or similar header values.

    For example {"Customheader": "Foobar", "token": "oooooooo1!"}
    • Type: String
  • directoryToScan (optional)
    Please specify the directory in the workspace you wish to scan.

    Alternatively you can specify the URL of the file you wish to scan, BDBA will fetch the file from the given URL

    For files in the workarea, if you wish to use an absolute path put '/' at the beginning of the path, this will cause the plugin to not try to find the folder from the build workspace. Please notice that it is possible to upload massive amounts of files if this option is set to absolute path and the 'Include subdirectories' is enabled.

    If there are 10 or more files to scan, the plugin will zip them before sending them. You can specify the name for the BDBA scan job in the field "Scan job name (used only for zip)".
    • Type: String
  • dontZipFiles (optional)
    Do not zip files in any situation. Usually the BDBA plugin zips files if there are more than 50, to avoid transfer overhead. This configuration item is ignored if the BDBA instance is Synopsys hosted.
    • Type: boolean
  • endAfterSendingFiles (optional)
    Whether to end the build phase when the files are sent to BDBA. You can see the links to the results in the console.
    • Type: boolean
  • failIfVulns (optional)
    Trigger build failure if BDBA finds vulnerabilities from the scanned files. The build will always fail if the connection or api calls to BDBA returned any errors.
    • Type: boolean
  • includeSubdirectories (optional)
    Also include subdirectories of the directory from which the build attempts to find files to scan.

    Please notice that if this is selected, it is possible to accidentally upload massive amounts of files.
    • Type: boolean
  • pattern (optional)
    Here you can provide a regular expression to include only certain files. The option is the default java Pattern format:

    Leave blank to include all found files.
    • Type: String
  • protecodeScanName (optional)
    BDBA jenkins plugin will zip given files if there are 10 or more. This is done to avoid file transfer overhead produced by moving many files. The plugin will still show the results per file.
    • Type: String
  • scanOnlyArtifacts (optional)
    Scan only Jenkins Artifacts produced by earlier steps of the build.
    • Type: boolean
  • scanTimeout (optional)
    Timeout for the scan. If this timeout is exceeded the plugin will not try to get further results from BDBA. If a comprehensive timeout for the build is needed, it is suggested to use the Build Timeout Plugin.
    • Type: int

Was this page helpful?

Please submit your feedback about this page through this quick form.

Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?


See existing feedback here.