Skip to content

Commit 37da98d

Browse files
authored
feat(misconf): Use updated terminology for misconfiguration checks (aquasecurity#6476)
Signed-off-by: Simar <[email protected]>
1 parent cdee703 commit 37da98d

File tree

52 files changed

+1074
-398
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1074
-398
lines changed

docs/docs/configuration/cache.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ $ trivy server --cache-backend redis://localhost:6379 \
7070

7171
[trivy-db]: ./db.md#vulnerability-database
7272
[trivy-java-db]: ./db.md#java-index-database
73-
[misconf-policies]: ../scanner/misconfiguration/policy/builtin.md
73+
[misconf-policies]: ../scanner/misconfiguration/check/builtin.md
7474

7575
[^1]: Downloaded when scanning for vulnerabilities
7676
[^2]: Downloaded when scanning `jar/war/par/ear` files

docs/docs/coverage/iac/helm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The following scanners are supported.
1111
Trivy recursively searches directories and scans all found Helm files.
1212

1313
It evaluates variables, functions, and other elements within Helm templates and resolve the chart to Kubernetes manifests then run the Kubernetes checks.
14-
See [here](../../scanner/misconfiguration/policy/builtin.md) for more details on the built-in policies.
14+
See [here](../../scanner/misconfiguration/check/builtin.md) for more details on the built-in policies.
1515

1616
### Value overrides
1717
There are a number of options for overriding values in Helm charts.

docs/docs/references/configuration/cli/trivy_aws.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,11 @@ trivy aws [flags]
6969
--account string The AWS account to scan. It's useful to specify this when reviewing cached results for multiple accounts.
7070
--arn string The AWS ARN to show results for. Useful to filter results once a scan is cached.
7171
--cf-params strings specify paths to override the CloudFormation parameters files
72+
--check-namespaces strings Rego namespaces
73+
--checks-bundle-repository string OCI registry URL to retrieve checks bundle from (default "ghcr.io/aquasecurity/trivy-checks:0")
7274
--compliance string compliance report to generate (aws-cis-1.2,aws-cis-1.4)
73-
--config-data strings specify paths from which data for the Rego policies will be recursively loaded
74-
--config-policy strings specify the paths to the Rego policy files or to the directories containing them, applying config files
75+
--config-check strings specify the paths to the Rego check files or to the directories containing them, applying config files
76+
--config-data strings specify paths from which data for the Rego checks will be recursively loaded
7577
--dependency-tree [EXPERIMENTAL] show dependency origin tree of vulnerable packages
7678
--endpoint string AWS Endpoint override
7779
--exit-code int specify exit code when any security issues are found
@@ -91,14 +93,12 @@ trivy aws [flags]
9193
--misconfig-scanners strings comma-separated list of misconfig scanners to use for misconfiguration scanning (default [azure-arm,cloudformation,dockerfile,helm,kubernetes,terraform,terraformplan-json,terraformplan-snapshot])
9294
-o, --output string output file name
9395
--output-plugin-arg string [EXPERIMENTAL] output plugin arguments
94-
--policy-bundle-repository string OCI registry URL to retrieve policy bundle from (default "ghcr.io/aquasecurity/trivy-policies:0")
95-
--policy-namespaces strings Rego namespaces
9696
--region string AWS Region to scan
9797
--report string specify a report format for the output (all,summary) (default "all")
98-
--reset-policy-bundle remove policy bundle
98+
--reset-checks-bundle remove checks bundle
9999
--service strings Only scan AWS Service(s) specified with this flag. Can specify multiple services using --service A --service B etc.
100100
-s, --severity strings severities of security issues to be displayed (UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL) (default [UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL])
101-
--skip-policy-update skip fetching rego policy updates
101+
--skip-check-update skip fetching rego check updates
102102
--skip-service strings Skip selected AWS Service(s) specified with this flag. Can specify multiple services using --skip-service A --skip-service B etc.
103103
-t, --template string output template
104104
--tf-exclude-downloaded-modules exclude misconfigurations for downloaded terraform modules

docs/docs/references/configuration/cli/trivy_config.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ trivy config [flags] DIR
1212
--cache-backend string cache backend (e.g. redis://localhost:6379) (default "fs")
1313
--cache-ttl duration cache TTL when using redis as cache backend
1414
--cf-params strings specify paths to override the CloudFormation parameters files
15+
--check-namespaces strings Rego namespaces
16+
--checks-bundle-repository string OCI registry URL to retrieve checks bundle from (default "ghcr.io/aquasecurity/trivy-checks:0")
1517
--clear-cache clear image caches without scanning
1618
--compliance string compliance report to generate
17-
--config-data strings specify paths from which data for the Rego policies will be recursively loaded
18-
--config-policy strings specify the paths to the Rego policy files or to the directories containing them, applying config files
19+
--config-check strings specify the paths to the Rego check files or to the directories containing them, applying config files
20+
--config-data strings specify paths from which data for the Rego checks will be recursively loaded
1921
--enable-modules strings [EXPERIMENTAL] module names to enable
2022
--exit-code int specify exit code when any security issues are found
2123
--file-patterns strings specify config file patterns
@@ -36,19 +38,17 @@ trivy config [flags] DIR
3638
-o, --output string output file name
3739
--output-plugin-arg string [EXPERIMENTAL] output plugin arguments
3840
--password strings password. Comma-separated passwords allowed. TRIVY_PASSWORD should be used for security reasons.
39-
--policy-bundle-repository string OCI registry URL to retrieve policy bundle from (default "ghcr.io/aquasecurity/trivy-policies:0")
40-
--policy-namespaces strings Rego namespaces
4141
--redis-ca string redis ca file location, if using redis as cache backend
4242
--redis-cert string redis certificate file location, if using redis as cache backend
4343
--redis-key string redis key file location, if using redis as cache backend
4444
--redis-tls enable redis TLS with public certificates, if using redis as cache backend
4545
--registry-token string registry token
4646
--report string specify a compliance report format for the output (all,summary) (default "all")
47-
--reset-policy-bundle remove policy bundle
47+
--reset-checks-bundle remove checks bundle
4848
-s, --severity strings severities of security issues to be displayed (UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL) (default [UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL])
49+
--skip-check-update skip fetching rego check updates
4950
--skip-dirs strings specify the directories or glob patterns to skip
5051
--skip-files strings specify the files or glob patterns to skip
51-
--skip-policy-update skip fetching rego policy updates
5252
-t, --template string output template
5353
--tf-exclude-downloaded-modules exclude misconfigurations for downloaded terraform modules
5454
--tf-vars strings specify paths to override the Terraform tfvars files

docs/docs/references/configuration/cli/trivy_filesystem.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@ trivy filesystem [flags] PATH
2222
--cache-backend string cache backend (e.g. redis://localhost:6379) (default "fs")
2323
--cache-ttl duration cache TTL when using redis as cache backend
2424
--cf-params strings specify paths to override the CloudFormation parameters files
25+
--check-namespaces strings Rego namespaces
26+
--checks-bundle-repository string OCI registry URL to retrieve checks bundle from (default "ghcr.io/aquasecurity/trivy-checks:0")
2527
--clear-cache clear image caches without scanning
2628
--compliance string compliance report to generate
27-
--config-data strings specify paths from which data for the Rego policies will be recursively loaded
28-
--config-policy strings specify the paths to the Rego policy files or to the directories containing them, applying config files
29+
--config-check strings specify the paths to the Rego check files or to the directories containing them, applying config files
30+
--config-data strings specify paths from which data for the Rego checks will be recursively loaded
2931
--custom-headers strings custom headers in client mode
3032
--db-repository string OCI repository to retrieve trivy-db from (default "ghcr.io/aquasecurity/trivy-db:2")
3133
--dependency-tree [EXPERIMENTAL] show dependency origin tree of vulnerable packages
@@ -61,8 +63,6 @@ trivy filesystem [flags] PATH
6163
--output-plugin-arg string [EXPERIMENTAL] output plugin arguments
6264
--parallel int number of goroutines enabled for parallel scanning, set 0 to auto-detect parallelism (default 5)
6365
--password strings password. Comma-separated passwords allowed. TRIVY_PASSWORD should be used for security reasons.
64-
--policy-bundle-repository string OCI registry URL to retrieve policy bundle from (default "ghcr.io/aquasecurity/trivy-policies:0")
65-
--policy-namespaces strings Rego namespaces
6666
--redis-ca string redis ca file location, if using redis as cache backend
6767
--redis-cert string redis certificate file location, if using redis as cache backend
6868
--redis-key string redis key file location, if using redis as cache backend
@@ -71,18 +71,18 @@ trivy filesystem [flags] PATH
7171
--rekor-url string [EXPERIMENTAL] address of rekor STL server (default "https://rekor.sigstore.dev")
7272
--report string specify a compliance report format for the output (all,summary) (default "all")
7373
--reset remove all caches and database
74-
--reset-policy-bundle remove policy bundle
74+
--reset-checks-bundle remove checks bundle
7575
--sbom-sources strings [EXPERIMENTAL] try to retrieve SBOM from the specified sources (oci,rekor)
7676
--scanners strings comma-separated list of what security issues to detect (vuln,misconfig,secret,license) (default [vuln,secret])
7777
--secret-config string specify a path to config file for secret scanning (default "trivy-secret.yaml")
7878
--server string server address in client mode
7979
-s, --severity strings severities of security issues to be displayed (UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL) (default [UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL])
8080
--show-suppressed [EXPERIMENTAL] show suppressed vulnerabilities
81+
--skip-check-update skip fetching rego check updates
8182
--skip-db-update skip updating vulnerability database
8283
--skip-dirs strings specify the directories or glob patterns to skip
8384
--skip-files strings specify the files or glob patterns to skip
8485
--skip-java-db-update skip updating Java index database
85-
--skip-policy-update skip fetching rego policy updates
8686
-t, --template string output template
8787
--tf-exclude-downloaded-modules exclude misconfigurations for downloaded terraform modules
8888
--tf-vars strings specify paths to override the Terraform tfvars files

docs/docs/references/configuration/cli/trivy_image.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,12 @@ trivy image [flags] IMAGE_NAME
3636
```
3737
--cache-backend string cache backend (e.g. redis://localhost:6379) (default "fs")
3838
--cache-ttl duration cache TTL when using redis as cache backend
39+
--check-namespaces strings Rego namespaces
40+
--checks-bundle-repository string OCI registry URL to retrieve checks bundle from (default "ghcr.io/aquasecurity/trivy-checks:0")
3941
--clear-cache clear image caches without scanning
4042
--compliance string compliance report to generate (docker-cis)
41-
--config-data strings specify paths from which data for the Rego policies will be recursively loaded
42-
--config-policy strings specify the paths to the Rego policy files or to the directories containing them, applying config files
43+
--config-check strings specify the paths to the Rego check files or to the directories containing them, applying config files
44+
--config-data strings specify paths from which data for the Rego checks will be recursively loaded
4345
--custom-headers strings custom headers in client mode
4446
--db-repository string OCI repository to retrieve trivy-db from (default "ghcr.io/aquasecurity/trivy-db:2")
4547
--dependency-tree [EXPERIMENTAL] show dependency origin tree of vulnerable packages
@@ -81,8 +83,6 @@ trivy image [flags] IMAGE_NAME
8183
--password strings password. Comma-separated passwords allowed. TRIVY_PASSWORD should be used for security reasons.
8284
--platform string set platform in the form os/arch if image is multi-platform capable
8385
--podman-host string unix podman socket path to use for podman scanning
84-
--policy-bundle-repository string OCI registry URL to retrieve policy bundle from (default "ghcr.io/aquasecurity/trivy-policies:0")
85-
--policy-namespaces strings Rego namespaces
8686
--redis-ca string redis ca file location, if using redis as cache backend
8787
--redis-cert string redis certificate file location, if using redis as cache backend
8888
--redis-key string redis key file location, if using redis as cache backend
@@ -92,18 +92,18 @@ trivy image [flags] IMAGE_NAME
9292
--removed-pkgs detect vulnerabilities of removed packages (only for Alpine)
9393
--report string specify a format for the compliance report. (all,summary) (default "summary")
9494
--reset remove all caches and database
95-
--reset-policy-bundle remove policy bundle
95+
--reset-checks-bundle remove checks bundle
9696
--sbom-sources strings [EXPERIMENTAL] try to retrieve SBOM from the specified sources (oci,rekor)
9797
--scanners strings comma-separated list of what security issues to detect (vuln,misconfig,secret,license) (default [vuln,secret])
9898
--secret-config string specify a path to config file for secret scanning (default "trivy-secret.yaml")
9999
--server string server address in client mode
100100
-s, --severity strings severities of security issues to be displayed (UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL) (default [UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL])
101101
--show-suppressed [EXPERIMENTAL] show suppressed vulnerabilities
102+
--skip-check-update skip fetching rego check updates
102103
--skip-db-update skip updating vulnerability database
103104
--skip-dirs strings specify the directories or glob patterns to skip
104105
--skip-files strings specify the files or glob patterns to skip
105106
--skip-java-db-update skip updating Java index database
106-
--skip-policy-update skip fetching rego policy updates
107107
-t, --template string output template
108108
--tf-exclude-downloaded-modules exclude misconfigurations for downloaded terraform modules
109109
--token string for authentication in client/server mode

0 commit comments

Comments
 (0)