Orca Shift Left Security Action

GitHub Action for Orca Shift Left Security

More info can be found in the official Orca Shift Left Security documentation

Table of Contents

• Orca Shift Left Security Action - More info can be found in the official Orca Shift Left Security documentation
  • Table of Contents
  • Usage
    • Workflow
    • Inputs
  • Annotations
  • Upload SARIF report

Usage

Workflow

name: Sample Orca IaC Scan Workflow
on:
  # Scan for each push event on your protected branch. If you have a different branch configured, please adjust the configuration accordingly by replacing 'main'.
  push:
    branches: [ "main" ]
  # NOTE: To enable scanning for pull requests, uncomment the section below.
  #pull_request:
    #branches: [ "main" ]
  # NOTE: To schedule a daily scan at midnight, uncomment the section below.
  #schedule:
    #- cron: '0 0 * * *'
jobs:
  orca-iac_scan:
    name: Orca IaC Scan
    runs-on: ubuntu-latest
    env:
      PROJECT_KEY: <project key> # Set the desired project to run the cli scanning with
    steps:
      # Checkout your repository under $GITHUB_WORKSPACE, so your job can access it
      - name: Checkout Repository
        uses: actions/checkout@v3

      - name: Run Orca IaC Scan
        uses: orcasecurity/shiftleft-iac-action@v1
        with:
          api_token: ${{ secrets.ORCA_SECURITY_API_TOKEN }}
          project_key: ${{ env.PROJECT_KEY }}
          path:
            # scanning directories: ./terraform/ ./sub-dir/ and a file: ./Dockerfile
            "terraform,sub-dir,other-sub-dir/Dockerfile"

Inputs

Variable	Example Value	Description	Type	Required	Default
api_token		Orca API Token used for Authentication	String	Yes	N/A
project_key	my-project-key	Project Key name	String	Yes	N/A
path	terraform,sub-dir,other-sub-dir/Dockerfile	Paths or directories to scan (comma-separated)	String	Yes	N/A
exclude_paths	./notToBeScanned/,example.tf	List of paths to be excluded from scan (comma-separated)	String	No	N/A
format	json	Format for displaying the results	String	No	cli
output	results/	Output directory for scan results	String	No	N/A
platform	Terraform,CloudFormation	Limit scan to the specified list of platforms (comma-separated)	String	No	All supported platforms
exclude_platform	Terraform,CloudFormation	Exclude the specified list of platforms from scan (comma-separated)	String	No	N/A
cloud_provider	aws,gcp	Limit scan to the specified list of cloud providers	String	No	All supported cloud providers
no_color	false	Disable color output	Boolean	No	false
exit_code	10	Exit code for failed execution due to policy violations	Integer	No	3
control_timeout	30	Number of seconds the control has to execute before being canceled	Integer	No	60
silent	false	Disable logs and warnings output	Boolean	No	false
console_output	json	Prints results to console in the provided format (only when --output is provided)	String	No	cli
config	config.json	Path to configuration file (json, yaml or toml)	String	No	N/A
show_failed_issues_only	true	Show only failed issues	Boolean	No	false
show_annotations	true	Show github annotations on pull requests	Boolean	No	true
custom_controls	./custom_control1/,./custom_control2	Paths to custom controls (comma-separated)	String	No	N/A
generate_rego_input	./input.json	Generates an internal representation of scanned files, which can be utilized as input for Rego policies	String	No	N/A
include_compressed_files	false	Include compressed files in scan	Boolean	No	false
max_file_size	3	Maximum file size to be scanned in MB. Bigger files will be skipped	Integer	No	5
terraform_vars_path	/terraform-vars-path/terraform-vars.tfvars	Path where terraform variables are present	String	No	N/A
display_name	custom-display-name	Scan log display name (on Orca platform)	String	No	N/A
debug	true	Debug mode	Boolean	No	false
log_path	results/	The directory path to specify where the logs should be written to on debug mode.	String	No	working directory

Annotations

After scanning, the action will add the results as annotations in a pull request:

NOTE: Annotations can be disabled by setting the "show_annotation" input to "false"

Upload SARIF report

If you have GitHub code scanning available you can use Orca Shift Left Security as a scanning tool

NOTE: Code scanning is available for all public repositories. Code scanning is also available in private repositories owned by organizations that use GitHub Enterprise Cloud and have a license for GitHub Advanced Security.

Configuration:

name: Scan and upload SARIF

push:
  branches:
    - main

jobs:
  orca-iac_scan:
    name: Orca IaC Scan
    runs-on: ubuntu-latest
    permissions:
      security-events: write
    env:
      PROJECT_KEY: <project key> # Set the desired project to run the cli scanning with
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v3

      - name: Run Orca IaC Scan
        id: orcasecurity_iac_scan
        uses: orcasecurity/shiftleft-iac-action@v1
        with:
          api_token: ${{ secrets.ORCA_SECURITY_API_TOKEN }}
          project_key: ${{ env.PROJECT_KEY }}
          path: <path to scan>
          format: "sarif"
          output:
            "results/"
      - name: Upload SARIF file
        uses: github/codeql-action/upload-sarif@v2
        if: ${{ always() && steps.orcasecurity_iac_scan.outputs.exit_code != 1 }}
        with:
          sarif_file: results/iac.sarif

The results list can be found on the security tab of your GitHub project and should look like the following image

An entry should describe the error and in which line it occurred