kics Github Action

kics GitHub Action.

Please find more info in the official website: kics.io

Inputs

Variable	Example Value	Description	Type	Required	Default
path	terraform	path to file or directory to scan	String	Yes	N/A
output_path	results.json	file path to store result in json format	String	No	N/A
payload_path		file path to store source internal representation in JSON format	String	No	N/A
queries		path to directory with queries (default "./assets/queries")	String	No	./assets/queries downloaded with the binaries
verbose	true	verbose scan	Boolean	No	false

Outputs

The default output format for this GitHub Action is a SARIF output report stored in the working directory as ./cx.sarif

For full documentation on all the supported output formats and defect management integration, please see the following.

Example usage

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
    - uses: actions/checkout@v2
    # Scan Iac with kics
     - name: run kics Scan
        uses: checkmarx/kics-action@v1.0
        with:
          path: 'terraform'
          output_path: 'results.json'
	# Display the results in json format	  
     - name: display kics results
        run: |
          cat results.json

How To Contribute

We welcome issues to and pull requests against this repository!

License

kics Github Action

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.