Skip to content

Commit

Permalink
docs: add info about support for package license detection in fs/`r…
Browse files Browse the repository at this point in the history
…epo` modes (aquasecurity#6381)
  • Loading branch information
DmitriyLewen authored Mar 27, 2024
1 parent f85c9fa commit ade033a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/docs/scanner/license.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,15 @@ Check out [the coverage document][coverage] for details.
To enable extended license scanning, you can use `--license-full`.
In addition to package licenses, Trivy scans source code files, Markdown documents, text files and `LICENSE` documents to identify license usage within the image or filesystem.

By default, Trivy only classifies licenses that are matched with a confidence level of 0.9 or more by the classifer.
By default, Trivy only classifies licenses that are matched with a confidence level of 0.9 or more by the classifier.
To configure the confidence level, you can use `--license-confidence-level`. This enables us to classify licenses that might be matched with a lower confidence level by the classifer.

!!! note
The full license scanning is expensive. It takes a while.

Currently, the standard license scanning doesn't support filesystem and repository scanning.

| License scanning | Image | Rootfs | Filesystem | Repository | SBOM |
|:---------------------:|:-----:|:------:|:----------:|:----------:|:----:|
| Standard ||| - | - ||
| Standard ||| [^1][^2] |[^1][^2] ||
| Full (--license-full) ||||| - |

License checking classifies the identified licenses and map the classification to severity.
Expand Down Expand Up @@ -344,6 +342,8 @@ license:
permissive: []
```

[^1]: See the list of supported language files [here](../coverage/language/index.md).
[^2]: Some lock files require additional files (e.g. files from the cache directory) to detect licenses. Check [coverage][coverage] for more information.

[coverage]: ../coverage/index.md
[google-license-classification]: https://opensource.google/documentation/reference/thirdparty/licenses

0 comments on commit ade033a

Please sign in to comment.