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

• Usage
  • Workflow
  • Inputs
• Upload SARIF report

Usage

Workflow

name: Sample Orca Container Image 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-container_scan:
    name: Orca Container Windows Image Scan
    runs-on: windows-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 Container Image Scan
        uses: orcasecurity/shiftleft-container-image-action@v1
        with:
          api_token: ${{ secrets.ORCA_SECURITY_API_TOKEN }}
          project_key: ${{ env.PROJECT_KEY }}
          image: <image to scan>
          output:
            "results/"

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
image	redis:latest	Image name and tag to scan	String	Yes	N/A
format	json	Format for displaying the results	String	No	cli
output	results/	Output directory for scan results	String	No	N/A
no_color	false	Disable color output	Boolean	No	false
exit_code	10	Exit code for failed execution due to policy violations	Integer	No	3
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
disable_secret	true	Disables the secret detection scanning	Boolean	No	false
exceptions_filepath	n/a	Exceptions YAML filepath. (File should be mounted)	String	No	false
hide_vulnerabilities	n/a	Do not show detailed view of the vulnerabilities findings	Boolean	No	false
num_cpu	10	Number of logical CPUs to be used for secret scanning (default 10)	Integer	No	10
show_failed_issues_only	n/a	Show only failed issues	Boolean	No	false
custom_secret_controls	custom_rules.yaml	Path to custom secret controls file	String	No	N/A
tar_archive	n/a	Scan a tar archived image. Input should be the path of the image .tar file	Boolean	No	false
oci	n/a	Scan an OCI image	Boolean	No	false
skip_remote_lookup	false	Do not perform remote lookups for dependency information during the scan.	Boolean	No	false
display_name	custom-display-name	Scan log display name (on Orca platform)	String	No	N/A
hide_skipped_vulnerabilities	false	Filter out skipped vulnerabilities from result	Boolean	No	false
max_secret	10	Set the maximum secrets that can be found, when reaching this number secret scan will stop	Integer	No	10000
exclude_paths	./notToBeScanned/,example.tf	List of paths to be excluded from scan (comma-separated)	String	No	N/A
dependency_tree	false	Show dependency origin tree of vulnerable packages	Boolean	No	false

Output

By default, the scan output is displayed on the console, but you can choose to save the output to a specific directory as a file. You can specify the output directory using the output option as desribed in the Inputs section.

The output file name is following the format of image<.output_format_extension>.

For instance:

Output format	Output directory	Output file path
table	results/	results/image
json	results/	results/image.json
sarif	results/	results/image.sarif

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: Image Build, Scan and Upload Sarif

on: [pull_request]

jobs:
    build-cli:
      name: build-cli
      runs-on: ubuntu-latest
      permissions:
        security-events: write
      env: 
        IMAGE_NAME: <image name>
        PROJECT_KEY: <project key> # Set the desired project to run the cli scanning with
      
      steps:
      # checks-out your repository under $GitHub_WORKSPACE, so your workflow can access it.
      - name: Checkout
        uses: actions/checkout@v2
      
      # Build your docker image, that is going to be scanned in the next step
      - name: Docker Image Build
        run: docker build -t $IMAGE_NAME .
  

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

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

TODO: update this

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

TODO: update this