[!WARNING] DEPRECATED: This repository is deprecated and will no longer receive updates. Please migrate to the new CrowdStrike FCS Action for future container image scanning needs.

CrowdStrike Container Image Scan

This script will scan a container and return response codes indicating pass/fail status.

Specifically, this script:

1. Tags your image using docker tag or podman tag
2. Authenticates to CrowdStrike using your OAuth2 API keys
3. Pushes your image to CrowdStrike for evaluation using docker push, after which CrowdStrike performs an Image Scan
4. Parses returned scan report, generating return error codes as needed

All output is sent to stdout/stderr.

Prerequisites

• Docker or Podman installed and running
• Python3 and pip installed
• CrowdStrike OAuth2 API keys with appropriate permissions (see below)

OAuth2 API Key Prerequisites

A CrowdStrike OAuth2 API keys with the following permissions is required:

| Permission | Needed scopes | | ---------------------- | ------------------ | | Falcon Container Image | read and write |

Installation

Choose ONE of the following installation methods based on your container runtime:

Option 1: Docker Installation

If you're using Docker:

shell pip3 install docker crowdstrike-falconpy retry

Option 2: Podman Installation

If you're using Podman:

shell pip3 install podman crowdstrike-falconpy retry

Important Podman Configuration Notes

1. For rootless Podman, ensure the podman socket is running:

shell systemctl --user start podman.socket

1. For rootful Podman, ensure the following:

shell # The socket is running systemctl start podman.socket # Set the container host environment variable export CONTAINER_HOST="unix:///var/run/podman/podman.sock"

Option 3: Complete Installation

To install support for both Docker and Podman:

[!NOTE] If using Podman, follow the Podman Configuration Notes above after installing the requirements.

shell pip3 install -r requirements.txt

Usage

```shell $ python3 csscanimage.py --help usage: csscanimage.py [-h] -u CLIENT_ID -r REPO [-t TAG] [-c {us-1,us-2,eu-1,us-gov-1}] [-s SCORE] [--json-report REPORT] [--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-R RETRY_COUNT] [--plugin] [--user-agent USERAGENT]

optional arguments: -h, --help show this help message and exit --json-report REPORT Export JSON report to specified file --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL} Set the logging level --plugin Prints the report as json to stdout --user-agent USERAGENT HTTP User agent to use for API calls

required arguments: -u CLIENTID, --clientid CLIENTID Falcon OAuth2 API ClientID -r REPO, --repo REPO Container image repository -t TAG, --tag TAG Container image tag -c {us-1,us-2,eu-1,us-gov-1}, --cloud-region {us-1,us-2,eu-1,us-gov-1} CrowdStrike cloud region -s SCORE, --scorethreshold SCORE Vulnerability score threshold -R RETRYCOUNT, --retrycount RETRYCOUNT Scan report retry count ```

[!NOTE] CrowdStrike Falcon API credentials may be supplied also by the means of environment variables:

FALCON_CLIENT_ID, FALCON_CLIENT_SECRET, and FALCON_CLOUD_REGION.

Establishing and retrieving API credentials can be performed at https://falcon.crowdstrike.com/support/api-clients-and-keys.

Example Scans

Example 1

```shell python csscanimage.py --clientid FALCONCLIENTID --repo --tag --cloud-region <cloudregion>

please enter password to login Password: ```

The command above will return output similar to:

shell INFO Downloading Image Scan Report INFO Searching for vulnerabilities in scan report... INFO Searching for leaked secrets in scan report... INFO Searching for malware in scan report... INFO Searching for misconfigurations in scan report... WARNING Alert: Misconfiguration found INFO Vulnerability score threshold not met: '0' out of '500'

Example 2

The script provided was built to score vulnerabilities on a scale show below.

critical_score = 2000 high_score = 500 medium_score = 100 low_score = 20

The default value to return a non-zero error code for vulnerabilties is one high vulnerabilty. This can be overridden by providing the -s parameters to the script.

The example below will accomodate vulnerabilities with a sum of 1500.

```shell python csscanimage.py --clientid FALCONCLIENTID --repo --tag \ --cloud-region <cloudregion> -s 1500

```

The echo $? command can be utilized to review the return code, e.g:

shell echo $? 1

The echo $? above displays the returned code with the following mappings:

shell VulnerabilityScoreExceeded = 1 Malware = 2 Secrets = 3 Success = 0 Misconfig = 0 ScriptFailure = 10

Running the Scan using CICD

• You can use the container-image-scan GitHub Action in your GitHub workflows. Checkout the action at https://github.com/marketplace/actions/crowdstrike-container-image-scan

• Pipeline examples, including the GitHub Action, can be found at the CrowdStrike image-scan-example repository.

Using the container-image-scan Container

```shell export FALCONCLIENTID= export FALCONCLIENTSECRET=

docker run -it --rm -e FALCONCLIENTID -e FALCONCLIENTSECRET \ -v /var/run/docker.sock:/var/run/docker.sock \ quay.io/crowdstrike/container-image-scan:latest --repo --tag ```

You can use any argument that is supported by the script. For example, to set the cloud region:

shell docker run -it --rm -e FALCON_CLIENT_ID -e FALCON_CLIENT_SECRET \ -v /var/run/docker.sock:/var/run/docker.sock \ quay.io/crowdstrike/container-image-scan:latest --repo <repo> --tag <tag> -c us-2