feat: checkov workflow added (#49)

Co-authored-by: Deepak Verma <[email protected]>

Author: dverma-cd

.github/workflows/checkov.yml

@@ -0,0 +1,60 @@
+name: checkov
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on worflow call request events. 
+  workflow_call:
+    inputs:
+     directory:
+        required: true
+        type: string
+     continue_on_error:
+        required: true
+        type: string
+        default: 'true'
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "scan"
+  scan:
+    permissions:
+      contents: read # for actions/checkout to fetch code
+      security-events: write # for github/codeql-action/upload-sarif to upload SARIF results
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+      
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so follow-up steps can access it
+      - uses: actions/checkout@v3
+      
+      - name: Checkov GitHub Action
+        if: ${{ inputs.continue_on_error == 'true' }}
+        uses: bridgecrewio/checkov-action@v12
+        with:
+          # This will add both a CLI output to the console and create a results.sarif file
+          output_format: cli,sarif
+          output_file_path: console,results.sarif
+          soft_fail: true
+          directory: ${{ inputs.directory}}
+      
+      - name: Checkov GitHub Action
+        if: ${{ inputs.continue_on_error == 'false' }}
+        uses: bridgecrewio/checkov-action@v12
+        with:
+          # This will add both a CLI output to the console and create a results.sarif file
+          output_format: cli,sarif
+          output_file_path: console,results.sarif
+          directory: ${{ inputs.directory}}
+      
+        
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v2
+        # Results are generated only on a success or failure
+        # this is required since GitHub by default won't run the next step
+        # when the previous one has failed. Security checks that do not pass will 'fail'.
+        # An alternative is to add `continue-on-error: true` to the previous step
+        # Or 'soft_fail: true' to checkov.
+        if: success() || failure()
+        with:
+          sarif_file: results.sarif

README.md

@@ -60,6 +60,7 @@ Above example is just a simple example to call workflow from github shared workf
    * [Example for terraform checks with digitalocean cloud](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/terraform-checks.md#example-for-terraform-checks-with-digitalocean-cloud)
 6. [Terraform Lint Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/terraform-lint.md)
 7. [Terraform Checks Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/terraform-checks.md)
+7. [Checkov Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/checkov.md)
 
 ## Feedback 
 If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/github-shared-workflows/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).

docs/checkov.md

@@ -0,0 +1,35 @@
+## [Checkov Assignee Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/.github/workflows/checkov.yml)
+
+This workflow does a static code analysis tool for scanning infrastructure as code (IaC) files for misconfigurations that may lead to security or compliance problems.
+
+#### Usage
+Checkov is a static code analysis tool for scanning infrastructure as code (IaC) files for misconfigurations that may lead to security or compliance problems. Checkov includes more than 750 predefined policies to check for common misconfiguration issues. Checkov also supports the creation and contribution of custom policies.
+
+## Supported IaC types
+### Checkov scans these IaC file types:
+
+- Terraform (for AWS, GCP, Azure and OCI)
+- CloudFormation (including AWS SAM)
+- Azure Resource Manager (ARM)
+- Serverless framework
+- Helm charts
+- Kubernetes
+- Docker
+
+#### Example
+```yaml
+name:  checkov
+on: 
+  # this can be trigger based on both master and main branch.
+  push:
+    branches: [ "main", "master" ]
+  pull_request:
+    branches: [ "main", "master" ]
+  workflow_dispatch:
+jobs:
+  checkov:
+    uses: clouddrove/github-shared-workflows/.github/workflows/checkov.yml@master # shared workflow 
+    with:
+     directory: # specify your working folder from repo
+     continue_on_error: true #action will continue on error 
+```