fcs-action

KO | EN

gitlite — search

#hacktoberfest #ai #llm #go #machine-learning #java #windows #awesome #cli #kubernetes #awesome-list #vue #pytorch #security

(★ 20)

CrowdStrike FCS CLI GitHub action

fcs-action Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FCS CLI GitHub Action

This GitHub Action allows you to run the CrowdStrike Falcon Cloud Security (FCS) CLI tool directly in your CI/CD pipeline. The action supports both Infrastructure as Code (IaC) scanning for misconfigurations and security vulnerabilities, as well as container image scanning for vulnerabilities and security issues.

## Features

- **IaC Scanning**: Run FCS IaC scans on local files, directories, or Git repositories
- **Image Scanning**: Scan container images for vulnerabilities, malware, and security issues
- **SBOM Generation**: Generate Software Bill of Materials (SBOM) in CycloneDX format
- Customize scan parameters such as categories, platforms, severities, and filtering options
- Generate scan reports in various formats (JSON, SARIF, SBOM)
- Upload scan results to the CrowdStrike Falcon Console
- Flexible configuration options for tailoring scans to your needs
- Support for vulnerability-only and SBOM-only scanning modes

## Prerequisites

### Create a CrowdStrike API Client

> [!NOTE]
> API clients are granted one or more API scopes. Scopes allow access to specific CrowdStrike APIs and describe the actions that an API client can perform. To create an API client, see [API Clients and Keys](https://falcon.crowdstrike.com/login/?unilogin=true&next=/api-clients-and-keys).

The following API scopes are available:

| Scope | Permission | Required |
|---------|-------------|---------------|
| Cloud Security Tools Download | *READ* | **Always** |
| Infrastructure as Code | *READ* & *WRITE* | For IaC scanning only |
| Falcon Container CLI | *READ* & *WRITE* | For Image scanning only |
| Falcon Container Image | *READ* & *WRITE* | For Image scanning only |

### Create a GitHub Secret

This action relies on the environment variable `FALCON_CLIENT_SECRET` to authenticate with the CrowdStrike API.

Create a GitHub secret in your repository to store the CrowdStrike API Client secret created from the step above. For more information, see [Creating secrets for a repository](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository).

### FCS Action Support for FCS CLI Versions

| **FCS CLI Version** | **FCS Action Version** |
| ------------------- | ---------------------- |
| **`>= 2.0.0`** | **`>= 2.0.0`** |
| **`>= 1.0.0`** and **`< 2.0.0`** | **`>= 1.1.0`** and **`< 2.0.0`** |
| **`< 1.0.0`** | **`< 1.1.0`** |

## What's New in FCS CLI 4.0.x

> [!IMPORTANT]
> FCS CLI 4.0.x changes how cloud-based IaC rules are applied and deprecates the `policy_rule` input.

### Cloud Rules Now Applied by Default (IaC)

**What Changed:** Cloud-based custom rules are now applied automatically on every IaC scan. The `policy_rule` input is **deprecated and ignored**.

**Migration Required:**
- **Before:** `policy_rule: 'default-iac-alert-rule'` to enable cloud rules
- **After:** Cloud rules are on by default — remove `policy_rule` from your workflow
- **To disable cloud rules:** Use the new `disable_custom_rules: true` input instead of `policy_rule: 'local'`

### New Inputs (FCS CLI 4.0.x)

| Input | Scan Type | Description |
|---|---|---|
| `disable_custom_rules` | IaC | Disable cloud-based rules; scan with local rules only. Replaces `policy_rule: local` |
| `exclude_gitignore` | IaC | Disable automatic exclusion of paths listed in `.gitignore` |
| `max_file_size` | IaC | Maximum file size in MB to scan (default 100) |
| `module_cache` | IaC | Cache downloaded Terraform modules to disk across scans |
| `scan_only` | Image | Run scan without generating report output |
| `falcon_token` | Both | Bearer token for Falcon API, skips OAuth2 authentication |
| `verbose` | Both | Enable verbose output |
| `profile` | Both | Named profile from FCS CLI configuration |

---

## What's New in FCS CLI 2.3.x

> [!NOTE]
> FCS CLI version 2.3.x introduces multi-architecture image scanning support. The FCS Action automatically handles these changes - no workflow modifications required.

### Multi-Architecture Image Scanning

**What's New:** When scanning multi-architecture (multi-arch) images, the FCS CLI now scans **all architecture variants by default** instead of only the host architecture.

**What This Means for Your Workflows:**

- **Multiple Report Files**: If you scan a multi-arch image (e.g., `nginx:latest`), you'll receive separate reports for each architecture (linux/amd64, linux/arm64, etc.)
- **Exit Codes**: The action returns a non-zero exit code if ANY architecture variant fails your assessment criteria
- **No Changes Needed**: The action automatically discovers and processes all generated reports

### Controlling Which Architectures to Scan

**Scan all architectures (default):**

```yaml
- name: Scan All Architectures
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 scan_type: image
 image: nginx:latest
 # Omit platform parameter to scan all architectures
```

**Scan specific architectures only:**

```yaml
- name: Scan Specific Architectures
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 scan_type: image
 image: nginx:latest
 platform: linux/amd64,linux/arm64 # New: Comma-separated list
```

**Scan single architecture (previous behavior):**

```yaml
- name: Scan Single Architecture
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 scan_type: image
 image: nginx:latest
 platform: linux/amd64 # Only scan amd64
```

## Important Changes in FCS CLI 2.2.0

> [!IMPORTANT]
> FCS CLI version 2.2.0 introduces a breaking change for IaC scanning when using multiple report formats.

### IaC: Multiple Report Formats Require Directory Path

**What Changed:** When requesting multiple report formats (e.g., `json,sarif`), the `output_path` parameter must now be a **directory path**, not a file path.

**Migration Required:**
- **Before (CLI < 2.2.0):** `output_path: './my-report.out'` with `report_formats: 'json,sarif'` ✅
- **After (CLI >= 2.2.0):** `output_path: './reports'` with `report_formats: 'json,sarif'` ✅
- **After (CLI >= 2.2.0):** `output_path: './my-report.out'` with `report_formats: 'json,sarif'` ❌ **Will fail**

**Valid Configurations:**
```yaml
# Single format - file path is OK
report_formats: 'json'
output_path: './my-report.json'

# Multiple formats - must use directory path
report_formats: 'json,sarif'
output_path: './reports'

# Multiple formats - omit output_path to use defaults
report_formats: 'json,sarif'
# Uses default: ~/.crowdstrike/reports/
```

**Why This Changed:** This ensures consistent file naming when generating multiple report formats and prevents file naming conflicts.

## Usage

To use this action in your workflow, add the following step:

```yaml
- name: Run FCS IaC Scan
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-1'
 path: './my-iac-directory'
 project_name: '${{ github.repository }}/${{ github.ref_name }}'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

> [!TIP]
> The `project_name` above uses [GitHub context](https://docs.github.com/en/actions/reference/workflows-and-actions/contexts#github-context) variables to distinguish scan results across repositories and branches.

## Environment Variables

| Variable | Description | Required | Default | Example |
| -------- | ----------- | -------- | ------- | ------- |
| `FALCON_CLIENT_SECRET` | CrowdStrike API Client Secret | **Yes** | - | `${{ secrets.FALCON_CLIENT_SECRET }}` |

## Inputs

### Core Configuration

| Input | Description | Required | Default | Example/Values |
| ----- | ----------- | -------- | ------- | -------------- |
| `falcon_client_id` | CrowdStrike API Client ID | **Yes** | - | `${{ vars.FALCON_CLIENT_ID }}` |
| `falcon_region` | CrowdStrike API region | **Yes** | **us-1**| **Allowed values**:us-1us-2eu-1us-gov-1us-gov-2 |
| `version` | FCS CLI tool version to use | No | uses the latest | `2.0.2` |
| `bin_path` | FCS binary installation path | No | `$RUNNER_TEMP` | `/custom/bin` |
| `scan_type` | Type of scan to perform | No | `iac` | **Allowed values**:iacimage |

### Common Parameters

| Input | Description | Required | Default | Example/Values |
| ----- | ----------- | -------- | ------- | -------------- |
| `timeout` | Timeout for scan in seconds | No | `300` | `600` |
| `upload_results` | Upload to Falcon Console | No | `false` | **Allowed values**:truefalse |
| `verbose` | Enable verbose output | No | `false` | **Allowed values**:truefalse |
| `profile` | Named profile from FCS CLI configuration | No | `default` | `production` |
| `falcon_token` | Bearer token for Falcon API calls, skips OAuth2 | No | - | `<token>` |

<details>
<summary>🛠️ IaC Scanning Parameters (Click to expand)</summary>

| Input | Description | Required | Default | Example/Values |
| ----- | ----------- | -------- | ------- | -------------- |
| `path` | Path to scan (file/dir/git repo) | No | - | `./dir``git::repo``file.tf` |
| `output_path` | Path to save scan results**NOTE: Must be a directory when using multiple report formats** (FCS CLI 2.2.0+) | No | (uses CLI default) | `./scan-results/` |
| `report_formats` | List of output formats for reports | No | `json` | **Allowed values**:json, csv, junit, sarif |
| `config` | Path to configuration file | No | - | `./fcs-config.json` |
| `policy_rule` | **(Deprecated, ignored as of FCS CLI 4.0.x)** Cloud rules are now applied by default. Use `disable_custom_rules` to opt out. | No | - | - |
| `disable_custom_rules` | Disable cloud-based rules; scan with local rules only (FCS CLI 4.0.x+) | No | `false` | **Allowed values**:truefalse |
| `exclude_gitignore` | Disable automatic exclusion of paths in `.gitignore` (FCS CLI 4.0.x+) | No | `false` | **Allowed values**:truefalse |
| `max_file_size` | Maximum file size in MB for scanning (FCS CLI 4.0.x+) | No | `100` | `50` |
| `module_cache` | Cache downloaded Terraform modules across scans (FCS CLI 4.0.x+) | No | `false` | **Allowed values**:truefalse |
| `disable_secrets_scan` | Disable secrets scanning | No | `false` | **Allowed values**:truefalse |
| `project_owners` | Project owners to notify (max 5) | No | - | `john@example.com,jane@example.com` |
| `project_name` | Name of the project for identification in Falcon console | No | - | `my-awesome-project` |

#### Filtering & Categorization

| Input | Description | Required | Default | Example/Values |
| ----- | ----------- | -------- | ------- | -------------- |
| `categories` | Include specified categories | No | - | See [Categories](#reference-categories) |
| `exclude_categories` | Exclude specified categories | No | - | See [Categories](#reference-categories) |
| `platforms` | Include specified platforms | No | - | See [Platforms](#reference-platforms) |
| `exclude_platforms` | Exclude specified platforms | No | - | See [Platforms](#reference-platforms) |
| `severities` | Include specified severities | No | - | **Allowed values**:criticalhighmediuminformational |
| `exclude_severities` | Exclude specified severities | No | - | **Allowed values**:criticalhighmediuminformational |
| `exclude_paths` | Exclude paths from scan | No | - | `./test/*,file.tf` |
| `fail_on` | Exit codes for severity levels | No | critical=1,high=1,medium=1,informational=1 | `critical=5,high=10` |

</details>

<details>
<summary>🐳 Image Scanning Parameters (Click to expand)</summary>

#### Basic Image Settings

| Input | Description | Required | Default | Example/Values |
| ----- | ----------- | -------- | ------- | -------------- |
| `image` | Container image to scan | **Yes*** | - | `nginx:latest``quay.io/org/app:v1.0` |
| `output_path` | File path to save scan results.**NOTE: must be a file path ending with .json, .sarif, or .cdx.json**Omit to use CLI default: `~/.crowdstrike/image_assessment/reports/` | No | (uses CLI default) | `./scan-results.json` |
| `report_formats` | A **single** output format for generated report | No | `json` | **Allowed values**:**Image**: json, sarif, cyclonedx-json |
| `socket` | Custom container engine socket | No | - | `unix:///var/run/docker.sock` |
| `platform` | Target platform(s). Single value or comma-separated list (FCS CLI >= 2.3.0) | No | - | `linux/amd64``linux/amd64,linux/arm64``windows/amd64` |
| `temp_dir` | Custom temp directory | No | - | `/local/tmp` |

#### Scan Mode Options

| Input | Description | Required | Default | Example/Values |
| ----- | ----------- | -------- | ------- | -------------- |
| `vulnerability_only` | Scan vulnerabilities only | No | `false` | **Allowed values**:truefalse |
| `sbom_only` | Generate SBOM only | No | `false` | **Allowed values**:truefalse |
| `scan_only` | Run scan without generating report output (FCS CLI 4.0.x+) | No | `false` | **Allowed values**:truefalse |
| `strict_digest` | Enable strict digest validation(requires FCS CLI 2.2.0+) | No | `false` | **Allowed values**:truefalse |

> **Note on strict_digest:** When enabled, image scans enforce digest validation to ensure consistency between build and registry. The scan will fail if the image has uncompressed layers that cannot be pulled from a registry with correct digests. This feature helps with image traceability in compliance scenarios. When disabled (default), scans proceed with a warning if uncompressed layers are detected.

#### Vulnerability Filtering

| Input | Description | Required | Default | Example/Values |
| ----- | ----------- | -------- | ------- | -------------- |
| `minimum_score` | Min CVSS score threshold | No | - | `0.0-10.0` |
| `minimum_severity` | Min vulnerability severity | No | - | **Allowed values**:lowmediumhighcritical |
| `minimum_exprt` | Min ExPRT rating | No | - | **Allowed values**:lowmediumhighcritical |
| `exclude_vulnerabilities` | Exclude vulnerability IDs | No | - | `CVE-2023-1234,CVE-2023-5678` |
| `vuln_fixable_only` | Exclude unfixable vulnerabilities | No | `false` | **Allowed values**:truefalse |

#### Detection & Display Options

| Input | Description | Required | Default | Example/Values |
| ----- | ----------- | -------- | ------- | -------------- |
| `minimum_detection_severity` | Min detection severity | No | - | **Allowed values**:lowmediumhighcritical |
| `report_sort_by` | Sort report by criteria | No | - | `severity/asc``score/desc``vulnerability/asc` |
| `show_full_description` | Show full vuln descriptions | No | `false` | **Allowed values**:truefalse |
| `show_full_detection_details` | Show full detection details | No | `false` | **Allowed values**:truefalse |
| `no_color` | Disable colored output | No | `false` | **Allowed values**:truefalse |

> **Note**: *Required only when `scan_type` is `image`

</details>

## Reference Values

<details>
<summary id="reference-categories">📋 Available Categories (Click to expand)</summary>

For use with `categories` and `exclude_categories` parameters:

- **Access Control** - Authentication, authorization, and access management
- **Availability** - High availability and disaster recovery configurations
- **Backup** - Data backup and recovery configurations
- **Best Practices** - General security and operational best practices
- **Build Process** - CI/CD and build pipeline security
- **Encryption** - Data encryption at rest and in transit
- **Insecure Configurations** - Misconfigurations that create security risks
- **Insecure Defaults** - Default settings that should be changed
- **Networking and Firewall** - Network security and firewall rules
- **Observability** - Logging, monitoring, and auditing
- **Resource Management** - Resource allocation and management
- **Secret Management** - Secrets, keys, and credential management
- **Supply-Chain** - Supply chain security concerns
- **Structure and Semantics** - Code structure and syntax issues

</details>

<details>
<summary id="reference-platforms">✅ Supported Platforms (Click to expand)</summary>

For use with `platforms` and `exclude_platforms` parameters:

- **Ansible** - Ansible playbooks and configurations
- **AzureResourceManager** - Azure ARM templates
- **CloudFormation** - AWS CloudFormation templates
- **Crossplane** - Crossplane configurations
- **DockerCompose** - Docker Compose files
- **Dockerfile** - Docker container definitions
- **GoogleDeploymentManager** - Google Cloud Deployment Manager
- **Kubernetes** - Kubernetes manifests and configurations
- **OpenAPI** - OpenAPI/Swagger specifications
- **Pulumi** - Pulumi infrastructure code
- **ServerlessFW** - Serverless Framework configurations
- **Terraform** - Terraform infrastructure code

</details>

## Outputs

| Output | Description |
| ------ | ----------- |
| `exit-code` | Exit code of the FCS CLI tool. Returns `0` on success, non-zero on scan findings or errors. See [Controlling Pipeline Flow](#controlling-pipeline-flow-with-fcs-cli-exit-codes) for details on how exit codes differ between IaC and image scans |

## Controlling Pipeline Flow with FCS CLI Exit Codes

The FCS action provides an `exit-code` output that allows you to control whether your pipeline continues or stops based on scan results. This is useful when you want to conditionally run subsequent steps based on scan outcomes.

### How Exit Codes Work

The exit code of the action itself should remain `0` which denotes a successful run of the action, while the output `exit-code` reflects the result of the FCS CLI scan. Exit code behavior differs between IaC and image scans:

#### IaC Scans

For IaC scans, the exit code is controlled locally by the `fail_on` parameter:

- **`0`**: Scan completed with no issues matching your `fail_on` criteria
- **Non-zero**: Scan found issues that match your `fail_on` criteria, or an error occurred

```yaml
# This configuration will cause a non-zero exit code
# if ANY issues are found at these severity levels
fail_on: 'critical=1,high=1,medium=1,informational=1'
```

#### Image Scans

For image scans, the exit code is determined by the **image assessment policy** configured in your Falcon console — not by the `fail_on` parameter (which only applies to IaC scans).

- **`0`**: The image meets the assessment policy defined in the Falcon console
- **Non-zero (e.g., `2`)**: The image does not meet the policy requirements

To change what triggers a non-zero exit code for image scans, update the image assessment policy in your [Falcon console](https://falcon.crowdstrike.com) under **Falcon Cloud Security** > **Image Assessment Policies**.

## Examples

### Basic scan of a local file

```yaml
- name: Run FCS IaC Scan
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-1'
 path: './sample-file.tf'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### Specifying severity levels

```yaml
- name: Run FCS IaC Scan
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-2'
 path: './kubernetes'
 severities: 'critical,high,medium'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### Disable cloud rules (air-gapped or firewall-restricted environments)

```yaml
- name: Run FCS IaC Scan
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-2'
 path: './kubernetes'
 disable_custom_rules: true
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### IaC scan with project identification

```yaml
- name: Run FCS IaC Scan with Project Name
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-1'
 path: './infrastructure'
 project_name: 'payment-service-infrastructure'
 severities: 'critical,high'
 report_formats: 'sarif'
 output_path: './security-scan-results/'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### Upload SARIF report to GitHub Code scanning on non-zero exit code

```yaml
- name: Run FCS IaC Scan
 uses: crowdstrike/fcs-action@v4.0.2
 id: fcs
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'eu-1'
 path: './cloudformation'
 report_formats: 'sarif'
 output_path: './scan-results.sarif'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}

- name: Upload SARIF report to GitHub Code scanning
 uses: github/codeql-action/upload-sarif@v3
 if: steps.fcs.outputs.exit-code != 0
 with:
 sarif_file: ./scan-results.sarif
```

### Scan with exclusions and severity filtering

```yaml
- name: Run FCS IaC Scan
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-2'
 path: './kubernetes'
 exclude_paths: './test/*,./deprecated/*'
 severities: 'high,medium'
 fail_on: 'high=10,medium=70'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

## Image Scanning Examples

### Basic container image scan

```yaml
- name: Scan Container Image
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-1'
 scan_type: image
 image: nginx:latest
 output_path: './image-scan-results.json'
 report_formats: json
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### Image scan with strict digest validation (FCS CLI 2.2.0+)

```yaml
- name: Scan Container Image with Strict Digest Validation
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-1'
 scan_type: image
 image: nginx:latest
 strict_digest: true
 output_path: './image-scan-results.json'
 report_formats: json
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### Continue pipeline on zero exit code (image passes assessment policy)

```yaml
- name: Scan Container Image
 uses: crowdstrike/fcs-action@v4.0.2
 id: fcs
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-1'
 scan_type: image
 image: nginx:latest
 output_path: './image-scan-results.json'
 report_formats: json
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}

- name: Continue pipeline to push image, etc
 if: steps.fcs.outputs.exit-code == 0
 ...
```

### Vulnerability-only image scan with filtering

```yaml
- name: Scan Image for Vulnerabilities Only
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-2'
 scan_type: image
 image: alpine:latest
 vulnerability_only: true
 minimum_severity: high
 minimum_score: 7.0
 vuln_fixable_only: true
 report_formats: json
 output_path: './vuln-results.json'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### Generate SBOM for container image

```yaml
- name: Generate SBOM
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'eu-1'
 scan_type: image
 image: python:3.9-slim
 sbom_only: true
 report_formats: cyclonedx-json
 output_path: './sbom-results.json'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### Advanced image scan with comprehensive filtering

```yaml
- name: Advanced Image Scan
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-1'
 scan_type: image
 image: node:16-alpine
 minimum_severity: medium
 minimum_exprt: medium
 exclude_vulnerabilities: 'CVE-2023-1234,CVE-2023-5678'
 show_full_description: true
 show_full_detection_details: true
 report_sort_by: severity/desc
 no_color: true
 platform: linux/amd64
 output_path: './detailed-scan-results.json'
 report_formats: json
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### Upload image scan results to Falcon Console

```yaml
- name: Scan and Upload to Falcon
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-1'
 scan_type: image
 image: myapp:latest
 upload_results: true
 minimum_severity: low
 output_path: './upload-results.json'
 report_formats: json
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

### Multi-platform image scan

```yaml
- name: Scan Multi-Platform Image
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-2'
 scan_type: image
 image: nginx:latest
 platform: linux/arm64
 minimum_detection_severity: medium
 temp_dir: './custom-temp'
 output_path: './multi-platform-results.json'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

---

You can also use configuration files to customize the scan parameters. For more information, see the [FCS CLI documentation](https://falcon.crowdstrike.com/login/?unilogin=true&next=/documentation/page/e08ea90a/infrastructure-as-code-security#u253ccc1)

### Run scan with configuration file

```yaml
- name: Run FCS IaC Scan
 uses: crowdstrike/fcs-action@v4.0.2
 with:
 falcon_client_id: ${{ vars.FALCON_CLIENT_ID }}
 falcon_region: 'us-1'
 config: './fcs-config.json'
 env:
 FALCON_CLIENT_SECRET: ${{ secrets.FALCON_CLIENT_SECRET }}
```

> Example configuration file: `./fcs-config.json`

```json
{
    "path": "./scan-dir",
    "fail-on": [
        "critical=1",
        "high=1",
        "medium=1",
        "informational=1"
    ],
    "output-path": "./results",
    "report-formats": [
        "json",
        "sarif"
    ],
    "timeout": 300
}
```

## SARIF Output Transformation

When SARIF format reports are generated, the action automatically applies transformations to ensure compatibility with GitHub's SARIF 2.1.0 parsing requirements:

### Transformations Applied

1. **Tool Information**: Sets empty `informationUri` fields to `https://crowdstrike.com`
2. **Result Levels**: Normalizes severity levels to standard SARIF values (`error`, `warning`, `note`, `none`)
3. **Result Types**: Removes unsupported `type` properties from results
4. **Location Structure**: Ensures every result has a standardized locations array with URI set to `"unknown"`

### Why These Transformations Are Needed

These transformations resolve common GitHub SARIF parsing issues by:

- Ensuring all required fields meet GitHub's validation requirements
- Standardizing location structures to prevent parsing errors
- Normalizing severity levels for consistent GitHub Code Scanning integration

The transformations are applied automatically when SARIF format is requested and do not affect the scan results' accuracy or completeness.

## Support

This project is a community-driven, open source project designed to provide a simple way to run CrowdStrike Falcon Cloud Security (FCS) CLI in a GitHub Action.

While not a formal CrowdStrike product, this project is maintained by CrowdStrike and supported in partnership with the open source developer community.

For additional support, please see the [SUPPORT](SUPPORT.md) file.

## License

See [LICENSE](LICENSE)

fcs-action

fcs-action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

fcs-action

fcs-action Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README