roblox-actionscache/Checkov GitHub Action

Run Checkov against infrastructure as code, open source packages, container images, and CI/CD configurations as a pre-packaged GitHub Action.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
fileFile with infrastructure code or packages to scanno
directoryDirectory with infrastructure code and/or package manager files to scanno.
checkRun scan only on a specific check identifier (comma separated)no
skip_checkRun scan on all checks but a specific check identifier (comma separated)no
compactDo not display code blocks in outputno
quietdisplay only failed checksno
api-keyEnvironment variable name of the Bridgecrew API key from Bridgecrew appno
output_bc_idsOutput Bridgecrew IDs (BC...) instead of Checkov IDs (CKV...)no
use_enforcement_rulesUse the Enforcement rules configured in the platform for hard / soft fail logic. See checkov help text for more details on the nuances of this option.no
skip_results_uploadDo not upload scan results to the platform to view in the console. Results are only available locally. If you use the --support flag, logs will still get uploaded.no
soft_faildo not return an error code if there are failed checksno
frameworkrun only on a specific infrastructureno
skip_frameworkskip a specific infrastructureno
external_checks_dirscomma separated list of external (custom) checks directoriesno
external_checks_reposcomma separated list of external (custom) checks repositoriesno
output_formatThe format of the output. cli, json, junitxml, github_failed_only, or sarif (comma separated)nosarif
output_file_pathPath and name for output file, needs to end with a comma for a single output formatno
download_external_modulesdownload external terraform modules from public git repositories and terraform registry:true, falseno
enable_secrets_scan_all_filesScan all files for secretsno
log_levellog levelnoWARNING
config_filecheckov configuration fileno
baselinePath to a .checkov.baseline file to compare. Report will include only failed checks that are not in the baselineno
soft_fail_onDo not return an error code only for specific check identifiers (comma separated)no
hard_fail_onReturn an error code only for specific check identifiers (comma separated)no
container_userSet the username or UID used and optionally the groupname or GID for the action to run underno0
docker_imageName of the docker image with the tags. Only works with an API and Dockerfile pathno
dockerfile_pathPath to the Dockerfile of the scanned docker imageno
var_fileVariable files to load in addition to the default files. Currently only supported for source Terraform (.tf file), and Helm chart scans. Requires using --directory, not --file. (comma separated)no
github_patEnvironment variable name for a Github personal access token for scanning external modules sourced from private repositoriesno
tfc_token(deprecated, use tf_registry_token) Environment variable name for a Terraform Cloud token for scanning external modules sourced from private registriesno
tf_registry_tokenEnvironment variable name for a Terraform registry token for scanning external modules sourced from private registriesno
ckv_validate_secretsEnvironment variable to enable local validation of secrets. Off by default.no
vcs_base_urlEnvironment variable name for the base url of a self hosted VCS with external modules. To be used with vcs_username and vcs_tokenno
vcs_usernameEnvironment variable name for the username for basic auth against a self hosted VCS with external modules. To be used with vcs_base_url and vcs_tokenno
vcs_tokenEnvironment variable name for the password (personal access token) for basic auth against a self hosted VCS with external modules. To be used with vcs_base_url and vcs_usernameno
bitbucket_tokenEnvironment variable name for a Bitbucket access token to scan external modules sourced from a private Bitbucket repositoryno
bitbucket_app_passwordEnvironment variable name for a Bitbucket app password to perform basic auth in order to scan external modules sourced from a private Bitbucket repository. To be used with bitbucket_usernamno
bitbucket_usernameEnvironment variable name for a Bitbucket username to perform basic auth in order to scan external modules sourced from a private Bitbucket repository. To be used with bitbucket_app_passwordno
repo_root_for_plan_enrichmentDirectory containing the hcl code used to generate a given plan file. Use with `file`no
deep_analysisCombine the TF Plan and TF graphs to make additional connections. Must be used with `repo_root_for_plan_enrichment`no
policy_metadata_filterComma separated key:value string to filter policies based on Prisma Cloud policy metadata. See https://prisma.pan.dev/api/cloud/cspm/policy#operation/get-policy-filters-and-options for information on allowed filters. Format: policy.label=test,cloud.type=awsno
policy_metadata_filter_exceptionComma separated key:value string to exclude filtered policies based on Prisma Cloud policy metadata. When used with policy_metadata_filter, the exceptions override any policies selected asa result of the policy_metadata_filter flag.See https://prisma.pan.dev/api/cloud/cspm/policy#operation/get-policy-filters-and-options for information on allowed filters. Format: policy.label=test,cloud.type=awsno
skip_pathPath (file or directory) to skip, using regular expression logic, relative to the current working directory. Word boundaries are not implicit; i.e., specifying "dir1" will skip any directory or subdirectory named "dir1". Ignored with -f. (comma separated)no
skip_cve_packageFilter scan to run on all packages except for a specific CVE package identifier, e.g. CVE-2018-19788 (comma separated)no
skip_downloadDo not download any data from Bridgecrew. This will omit doc links, severities, etc., as well as custom policies and suppressions if using an API token. Note: it will prevent BC platform IDs from being available in Checkov.no
prisma-api-urlPrisma API URL for prisma platform featuresno
namedescription
resultsThe results from the infrastructure scan