{{var:repo-title}} - Usage

April 4, 2025 ยท View on GitHub

{{var:repo-title}} - Usage

Introduction

{{include:p.marketing-intro.md}}

{{include:repo-intro.md}}

Plugin Installation

These sections describe how to install, upgrade and uninstall the parser plugin in SSC.

Install & Upgrade

  • Obtain the plugin binary jar file; either:
    • Download from the repository release page: {{var:repo-url}}/releases
    • Build the plugin from source: {{var:repo-url}}/blob/main/CONTRIBUTING.md
  • If you already have another version of the plugin installed, first uninstall the previously installed version of the plugin by following the steps under Uninstall below
  • In Fortify Software Security Center:
    • Navigate to Administration->Plugins->Parsers
    • Click the NEW button
    • Accept the warning
    • Upload the plugin jar file
    • Enable the plugin by clicking the ENABLE button

Uninstall

  • In Fortify Software Security Center:
    • Navigate to Administration->Plugins->Parsers
    • Select the parser plugin that you want to uninstall
    • Click the DISABLE button
    • Click the REMOVE button

Obtain results

{{include:parser-obtain-results.md}}

Upload results

Results can be uploaded through the SSC web interface, REST API, or SSC client utilities like FortifyClient or fcli. The SSC web interface, FortifyClient and most other Fortify clients require the raw results to be packaged into a zip-file; REST API and fcli allow for uploading raw results directly.

To upload results through the SSC web interface or most clients:

  • Create a scan.info file containing a single line as follows:
    engineType={{var:engine-type}}
  • Create a zip file containing the following:
    • The scan.info file generated in the previous step
    • The raw results file as obtained from the target system (see Obtain results section above)
  • Upload the zip file generated in the previous step to SSC
    • Using any SSC client, for example FortifyClient or Maven plugin
    • Or using the SSC web interface
    • Similar to how you would upload an FPR file

Both SSC REST API and fcli provide options for specifying the engine type directly, and as such it is not necessary to package the raw results into a zip-file with accompanying scan.info file. For example, fcli allows for uploading raw scan results using a command like the following:

fcli ssc artifact upload -f <raw-results-file> --appversion MyApp:MyVersion --engine-type {{var:engine-type}}