feat: Allow extra SSC export options to be specified (closes #44)

fortify · Jun 4, 2024 · bf28950 · bf28950
1 parent 3ccfaed
commit bf28950
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -243,6 +243,15 @@ Version of the ScanCentral SAST sensor on which the scan should be performed. Se
 Extra ScanCentral SAST scan options; see [`fcli sc-sast scan start` documentation](https://fortify.github.io/fcli/v2.3.0//manpage/fcli-sc-sast-scan-start.html)
 
 
+<!-- START-INCLUDE:env-ssc-export.md -->
+
+**`EXTRA_EXPORT_OPTS`** - OPTIONAL   
+This environment variable allows for passing extra options to the `fcli ssc action run github-sast-report` command. Please see the `fcli ssc action help github-sast-report` command for supported options. With the current fcli version, the most interesting option is `--fs` to specify an alternative SSC filter set, for example: `EXTRA_EXPORT_OPTS: --fs "Quick View"`.
+
+<!-- END-INCLUDE:env-ssc-export.md -->
+
+
+
 <!-- START-INCLUDE:env-wait-export.md -->
 
 **`DO_WAIT`** - OPTIONAL    
@@ -933,6 +942,15 @@ Version of the ScanCentral SAST sensor on which the scan should be performed. Se
 Extra ScanCentral SAST scan options; see [`fcli sc-sast scan start` documentation](https://fortify.github.io/fcli/v2.3.0//manpage/fcli-sc-sast-scan-start.html)
 
 
+<!-- START-INCLUDE:env-ssc-export.md -->
+
+**`EXTRA_EXPORT_OPTS`** - OPTIONAL   
+This environment variable allows for passing extra options to the `fcli ssc action run github-sast-report` command. Please see the `fcli ssc action help github-sast-report` command for supported options. With the current fcli version, the most interesting option is `--fs` to specify an alternative SSC filter set, for example: `EXTRA_EXPORT_OPTS: --fs "Quick View"`.
+
+<!-- END-INCLUDE:env-ssc-export.md -->
+
+
+
 <!-- START-INCLUDE:env-wait-export.md -->
 
 **`DO_WAIT`** - OPTIONAL    
@@ -1159,6 +1177,15 @@ Fortify SSC application version to use with this action. This can be specified e
 
 
 
+<!-- START-INCLUDE:env-ssc-export.md -->
+
+**`EXTRA_EXPORT_OPTS`** - OPTIONAL   
+This environment variable allows for passing extra options to the `fcli ssc action run github-sast-report` command. Please see the `fcli ssc action help github-sast-report` command for supported options. With the current fcli version, the most interesting option is `--fs` to specify an alternative SSC filter set, for example: `EXTRA_EXPORT_OPTS: --fs "Quick View"`.
+
+<!-- END-INCLUDE:env-ssc-export.md -->
+
+
+
 <!-- START-INCLUDE:env-setup.md -->
 
 **`TOOL_DEFINITIONS`** - OPTIONAL   

diff --git a/doc-resources/action-ssc-export.md b/doc-resources/action-ssc-export.md
@@ -8,6 +8,8 @@ This action exports the latest vulnerability data from an SSC application versio
 
 {{include:env-ssc-appversion.md}}
 
+{{include:env-ssc-export.md}}
+
 {{include:env-setup.md}}
 
 ### Sample usage

diff --git a/doc-resources/env-sc-sast-scan.md b/doc-resources/env-sc-sast-scan.md
@@ -20,4 +20,6 @@ Version of the ScanCentral SAST sensor on which the scan should be performed. Se
 **`EXTRA_SC_SAST_SCAN_OPTS`** - OPTIONAL    
 Extra ScanCentral SAST scan options; see [`fcli sc-sast scan start` documentation]({{var:fcli-doc-base-url}}/manpage/fcli-sc-sast-scan-start.html)
 
+{{include:env-ssc-export.md}}
+
 {{include:env-wait-export.md}}
diff --git a/doc-resources/env-ssc-export.md b/doc-resources/env-ssc-export.md
@@ -0,0 +1,2 @@
+**`EXTRA_EXPORT_OPTS`** - OPTIONAL   
+This environment variable allows for passing extra options to the `fcli ssc action run github-sast-report` command. Please see the `fcli ssc action help github-sast-report` command for supported options. With the current fcli version, the most interesting option is `--fs` to specify an alternative SSC filter set, for example: `EXTRA_EXPORT_OPTS: --fs "Quick View"`.
diff --git a/sc-sast-scan/README.md b/sc-sast-scan/README.md
@@ -114,6 +114,15 @@ Version of the ScanCentral SAST sensor on which the scan should be performed. Se
 Extra ScanCentral SAST scan options; see [`fcli sc-sast scan start` documentation](https://fortify.github.io/fcli/v2.3.0//manpage/fcli-sc-sast-scan-start.html)
 
 
+<!-- START-INCLUDE:env-ssc-export.md -->
+
+**`EXTRA_EXPORT_OPTS`** - OPTIONAL   
+This environment variable allows for passing extra options to the `fcli ssc action run github-sast-report` command. Please see the `fcli ssc action help github-sast-report` command for supported options. With the current fcli version, the most interesting option is `--fs` to specify an alternative SSC filter set, for example: `EXTRA_EXPORT_OPTS: --fs "Quick View"`.
+
+<!-- END-INCLUDE:env-ssc-export.md -->
+
+
+
 <!-- START-INCLUDE:env-wait-export.md -->
 
 **`DO_WAIT`** - OPTIONAL    

diff --git a/ssc-export/README.md b/ssc-export/README.md
@@ -55,6 +55,15 @@ Fortify SSC application version to use with this action. This can be specified e
 
 
 
+<!-- START-INCLUDE:env-ssc-export.md -->
+
+**`EXTRA_EXPORT_OPTS`** - OPTIONAL   
+This environment variable allows for passing extra options to the `fcli ssc action run github-sast-report` command. Please see the `fcli ssc action help github-sast-report` command for supported options. With the current fcli version, the most interesting option is `--fs` to specify an alternative SSC filter set, for example: `EXTRA_EXPORT_OPTS: --fs "Quick View"`.
+
+<!-- END-INCLUDE:env-ssc-export.md -->
+
+
+
 <!-- START-INCLUDE:env-setup.md -->
 
 **`TOOL_DEFINITIONS`** - OPTIONAL   

diff --git a/ssc-export/action.yml b/ssc-export/action.yml
@@ -10,8 +10,9 @@ runs:
         export-path: false
         fcli: action-default
     - uses: fortify/github-action/internal/[email protected]
-    - run: ${FCLI_CMD} ssc action run github-sast-report --av "${SSC_APPVERSION}" -f ./gh-fortify-sast.sarif
-      shell: bash
+    - uses: fortify/github-action/internal/[email protected]
+      with: 
+        cmd: ${FCLI_CMD} ssc action run github-sast-report --av "${SSC_APPVERSION}" -f ./gh-fortify-sast.sarif ${EXTRA_EXPORT_OPTS}
     - uses: github/codeql-action/upload-sarif@v3
       with:
         sarif_file: ./gh-fortify-sast.sarif
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		`EXTRA_EXPORT_OPTS` - OPTIONAL
		This environment variable allows for passing extra options to the `fcli ssc action run github-sast-report` command. Please see the `fcli ssc action help github-sast-report` command for supported options. With the current fcli version, the most interesting option is `--fs` to specify an alternative SSC filter set, for example: `EXTRA_EXPORT_OPTS: --fs "Quick View"`.