Skip to content

Commit e107608

Browse files
authored
refactor: rename security-checks to scanners (aquasecurity#3467)
1 parent aaf845d commit e107608

File tree

53 files changed

+1106
-725
lines changed

Some content is hidden

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

53 files changed

+1106
-725
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Trivy is integrated with many popular platforms and applications. The complete l
5454
### General usage
5555

5656
```bash
57-
trivy <target> [--security-checks <scanner1,scanner2>] <subject>
57+
trivy <target> [--scanners <scanner1,scanner2>] <subject>
5858
```
5959

6060
Examples:
@@ -71,7 +71,7 @@ https://user-images.githubusercontent.com/1161307/171013513-95f18734-233d-45d3-a
7171
</details>
7272

7373
```bash
74-
trivy fs --security-checks vuln,secret,config myproject/
74+
trivy fs --scanners vuln,secret,config myproject/
7575
```
7676

7777
<details>

docs/docs/attestation/rekor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You need to pass `--sbom-sources rekor` so that Trivy will look for SBOM attesta
2121
$ trivy image --sbom-sources rekor otms61/alpine:3.7.3 [~/src/github.com/aquasecurity/trivy]
2222
2022-09-16T17:37:13.258+0900 INFO Vulnerability scanning is enabled
2323
2022-09-16T17:37:13.258+0900 INFO Secret scanning is enabled
24-
2022-09-16T17:37:13.258+0900 INFO If your scanning is slow, please try '--security-checks vuln' to disable secret scanning
24+
2022-09-16T17:37:13.258+0900 INFO If your scanning is slow, please try '--scanners vuln' to disable secret scanning
2525
2022-09-16T17:37:13.258+0900 INFO Please see also https://aquasecurity.github.io/trivy/dev/docs/secret/scanning/#recommendation for faster secret detection
2626
2022-09-16T17:37:14.827+0900 INFO Detected SBOM format: cyclonedx-json
2727
2022-09-16T17:37:14.901+0900 INFO Found SBOM (cyclonedx) attestation in Rekor
@@ -105,7 +105,7 @@ Total: 1 (UNKNOWN: 0, LOW: 0, MEDIUM: 0, HIGH: 1, CRITICAL: 0)
105105
Also, it is applied to non-packaged binaries even in container images.
106106

107107
```bash
108-
$ trivy image --sbom-sources rekor --security-checks vuln alpine-with-bat
108+
$ trivy image --sbom-sources rekor --scanners vuln alpine-with-bat
109109
2022-10-25T13:40:14.920+0300 INFO Vulnerability scanning is enabled
110110
2022-10-25T13:40:18.047+0300 INFO Found SBOM attestation in Rekor: bat
111111
2022-10-25T13:40:18.186+0300 INFO Detected OS: alpine

docs/docs/kubernetes/cli/scanning.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ Filter by severity:
2727
$ trivy k8s --severity=CRITICAL --report=all cluster
2828
```
2929

30-
Filter by security check (Vulnerabilities, Secrets or Misconfigurations):
30+
Filter by scanners (Vulnerabilities, Secrets or Misconfigurations):
3131

3232
```
33-
$ trivy k8s --security-checks=secret --report=summary cluster
33+
$ trivy k8s --scanners=secret --report=summary cluster
3434
# or
35-
$ trivy k8s --security-checks=config --report=summary cluster
35+
$ trivy k8s --scanners=config --report=summary cluster
3636
```
3737

3838
Scan a specific namespace:
@@ -263,16 +263,16 @@ Severities: C=CRITICAL H=HIGH M=MEDIUM L=LOW U=UNKNOWN
263263
The infra checks are based on CIS Benchmarks recommendations for kubernetes.
264264

265265

266-
If you want filter only for the infra checks, you can use the flag `--components` along with the `--security-checks=config`
266+
If you want filter only for the infra checks, you can use the flag `--components` along with the `--scanners=config`
267267

268268
```
269-
$ trivy k8s cluster --report summary --components=infra --security-checks=config # scan only infra
269+
$ trivy k8s cluster --report summary --components=infra --scanners=config # scan only infra
270270
```
271271

272272
Or, to filter for all other checks besides the infra checks, you can:
273273

274274
```
275-
$ trivy k8s cluster --report summary --components=workload --security-checks=config # scan all components besides infra
275+
$ trivy k8s cluster --report summary --components=workload --scanners=config # scan all components besides infra
276276
```
277277

278278

docs/docs/licenses/scanning.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ License checking classifies the identified licenses and map the classification t
4747
This section shows how to scan license in container image and filesystem.
4848

4949
### Standard scanning
50-
Specify an image name with `--security-checks license`.
50+
Specify an image name with `--scanners license`.
5151

5252
``` shell
53-
$ trivy image --security-checks license --severity UNKNOWN,HIGH,CRITICAL alpine:3.15
53+
$ trivy image --scanners license --severity UNKNOWN,HIGH,CRITICAL alpine:3.15
5454
2022-07-13T17:28:39.526+0300 INFO License scanning is enabled
5555

5656
OS Packages (license)
@@ -78,7 +78,7 @@ Total: 6 (UNKNOWN: 0, HIGH: 6, CRITICAL: 0)
7878
Specify `--license-full`
7979

8080
``` shell
81-
$ trivy image --security-checks license --severity UNKNOWN,HIGH,CRITICAL --license-full grafana/grafana
81+
$ trivy image --scanners license --severity UNKNOWN,HIGH,CRITICAL --license-full grafana/grafana
8282
2022-07-13T17:48:40.905+0300 INFO Full license scanning is enabled
8383

8484
OS Packages (license)
@@ -141,7 +141,7 @@ Trivy has number of configuration flags for use with license scanning;
141141
Trivy license scanning can ignore licenses that are identified to explicitly remove them from the results using the `--ignored-licenses` flag;
142142

143143
```shell
144-
$ trivy image --security-checks license --ignored-licenses MPL-2.0,MIT --severity LOW grafana/grafana:latest
144+
$ trivy image --scanners license --ignored-licenses MPL-2.0,MIT --severity LOW grafana/grafana:latest
145145
2022-07-13T18:15:28.605Z INFO License scanning is enabled
146146

147147
OS Packages (license)

docs/docs/misconfiguration/scanning.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,28 +37,28 @@ $ trivy config [YOUR_IaC_DIRECTORY]
3737
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
3838
```
3939

40-
You can also enable misconfiguration detection in container image, filesystem and git repository scanning via `--security-checks config`.
40+
You can also enable misconfiguration detection in container image, filesystem and git repository scanning via `--scanners config`.
4141

4242
```bash
43-
$ trivy image --security-checks config IMAGE_NAME
43+
$ trivy image --scanners config IMAGE_NAME
4444
```
4545

4646
```bash
47-
$ trivy fs --security-checks config /path/to/dir
47+
$ trivy fs --scanners config /path/to/dir
4848
```
4949

5050
!!! note
5151
Misconfiguration detection is not enabled by default in `image`, `fs` and `repo` subcommands.
5252

5353
Unlike the `config` subcommand, `image`, `fs` and `repo` subcommands can also scan for vulnerabilities and secrets at the same time.
54-
You can specify `--security-checks vuln,config,secret` to enable vulnerability and secret detection as well as misconfiguration detection.
54+
You can specify `--scanners vuln,config,secret` to enable vulnerability and secret detection as well as misconfiguration detection.
5555

5656

5757
!!! example
5858
``` bash
5959
$ ls myapp/
6060
Dockerfile Pipfile.lock
61-
$ trivy fs --security-checks vuln,config,secret --severity HIGH,CRITICAL myapp/
61+
$ trivy fs --scanners vuln,config,secret --severity HIGH,CRITICAL myapp/
6262
2022-05-16T13:42:21.440+0100 INFO Number of language-specific files: 1
6363
2022-05-16T13:42:21.440+0100 INFO Detecting pipenv vulnerabilities...
6464
2022-05-16T13:42:21.440+0100 INFO Detected config files: 1

docs/docs/references/cli/client.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Aliases:
99

1010
Scan Flags
1111
--offline-scan do not issue API requests to identify dependencies
12-
--security-checks string comma-separated list of what security issues to detect (vuln,config,secret) (default "vuln,secret")
12+
--scanners string comma-separated list of what security issues to detect (vuln,config,secret) (default "vuln,secret")
1313
--skip-dirs strings specify the directories where the traversal is skipped
1414
--skip-files strings specify the file paths to skip traversal
1515

@@ -47,8 +47,8 @@ Vulnerability Flags
4747
Misconfiguration Flags
4848
--config-data strings specify paths from which data for the Rego policies will be recursively loaded
4949
--config-policy strings specify paths to the Rego policy files directory, applying config files
50-
--file-patterns strings specify config file patterns, available with '--security-checks config'
51-
--include-non-failures include successes and exceptions, available with '--security-checks config'
50+
--file-patterns strings specify config file patterns, available with '--scanners config'
51+
--include-non-failures include successes and exceptions, available with '--scanners config'
5252
--policy-namespaces strings Rego namespaces
5353
--trace enable more verbose trace output for custom queries
5454

docs/docs/references/cli/config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Cache Flags
3232
Misconfiguration Flags
3333
--config-data strings specify paths from which data for the Rego policies will be recursively loaded
3434
--config-policy strings specify paths to the Rego policy files directory, applying config files
35-
--file-patterns strings specify config file patterns, available with '--security-checks config'
36-
--include-non-failures include successes and exceptions, available with '--security-checks config'
35+
--file-patterns strings specify config file patterns, available with '--scanners config'
36+
--include-non-failures include successes and exceptions, available with '--scanners config'
3737
--policy-namespaces strings Rego namespaces
3838
--trace enable more verbose trace output for custom queries
3939

docs/docs/references/cli/fs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Examples:
1818

1919
Scan Flags
2020
--offline-scan do not issue API requests to identify dependencies
21-
--security-checks string comma-separated list of what security issues to detect (vuln,config,secret) (default "vuln,secret")
21+
--scanners string comma-separated list of what security issues to detect (vuln,config,secret) (default "vuln,secret")
2222
--skip-dirs strings specify the directories where the traversal is skipped
2323
--skip-files strings specify the file paths to skip traversal
2424

@@ -55,8 +55,8 @@ Vulnerability Flags
5555
Misconfiguration Flags
5656
--config-data strings specify paths from which data for the Rego policies will be recursively loaded
5757
--config-policy strings specify paths to the Rego policy files directory, applying config files
58-
--file-patterns strings specify config file patterns, available with '--security-checks config'
59-
--include-non-failures include successes and exceptions, available with '--security-checks config'
58+
--file-patterns strings specify config file patterns, available with '--scanners config'
59+
--include-non-failures include successes and exceptions, available with '--scanners config'
6060
--policy-namespaces strings Rego namespaces
6161
--trace enable more verbose trace output for custom queries
6262

docs/docs/references/cli/image.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Examples:
3333

3434
Scan Flags
3535
--offline-scan do not issue API requests to identify dependencies
36-
--security-checks string comma-separated list of what security issues to detect (vuln,config,secret) (default "vuln,secret")
36+
--scanners string comma-separated list of what security issues to detect (vuln,config,secret) (default "vuln,secret")
3737
--skip-dirs strings specify the directories where the traversal is skipped
3838
--skip-files strings specify the file paths to skip traversal
3939

@@ -73,8 +73,8 @@ Vulnerability Flags
7373
Misconfiguration Flags
7474
--config-data strings specify paths from which data for the Rego policies will be recursively loaded
7575
--config-policy strings specify paths to the Rego policy files directory, applying config files
76-
--file-patterns strings specify config file patterns, available with '--security-checks config'
77-
--include-non-failures include successes and exceptions, available with '--security-checks config'
76+
--file-patterns strings specify config file patterns, available with '--scanners config'
77+
--include-non-failures include successes and exceptions, available with '--scanners config'
7878
--policy-namespaces strings Rego namespaces
7979
--trace enable more verbose trace output for custom queries
8080

docs/docs/references/cli/repo.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Examples:
1515

1616
Scan Flags
1717
--offline-scan do not issue API requests to identify dependencies
18-
--security-checks string comma-separated list of what security issues to detect (vuln,config,secret) (default "vuln,secret")
18+
--scanners string comma-separated list of what security issues to detect (vuln,config,secret) (default "vuln,secret")
1919
--skip-dirs strings specify the directories where the traversal is skipped
2020
--skip-files strings specify the file paths to skip traversal
2121

@@ -52,8 +52,8 @@ Vulnerability Flags
5252
Misconfiguration Flags
5353
--config-data strings specify paths from which data for the Rego policies will be recursively loaded
5454
--config-policy strings specify paths to the Rego policy files directory, applying config files
55-
--file-patterns strings specify config file patterns, available with '--security-checks config'
56-
--include-non-failures include successes and exceptions, available with '--security-checks config'
55+
--file-patterns strings specify config file patterns, available with '--scanners config'
56+
--include-non-failures include successes and exceptions, available with '--scanners config'
5757
--policy-namespaces strings Rego namespaces
5858
--trace enable more verbose trace output for custom queries
5959

0 commit comments

Comments
 (0)