Packages security report
Artifact Hub scans containers' images used by packages for security vulnerabilities. The scanner uses Trivy to generate security reports for each of the package’s versions. These reports are accessible from the package’s detail view.
Security reports are generated periodically. The scanner runs twice an hour and scans packages' versions that haven’t been scanned yet. Packages' versions already scanned are revisited and scanned again, just in case new vulnerabilities have been discovered since the previous scan. The latest package version available is scanned daily, whereas previous versions are scanned weekly. This happens even if nothing has changed in the package version.
The security report may contain multiple images sections, one for each of the images your package is listing. Within each image section, multiple targets can be listed as well. A common one is the OS used by the image, including the packages installed. But more targets can be scanned and displayed if files describing your application dependencies are found in the image.
To generate a security report of your package, it needs to include the containers images it uses. The location of this information varies from one package kind to another.
Artifact Hub will try to extract the containers images used by Helm charts from the manifests generated from a dry-run install using the default values. Alternatively, images used by a Helm chart can be listed including a special annotation called
artifacthub.io/images in the
Chart.yaml file. You can find an example of how this is done in the Artifact Hub Helm chart here. For more information please see the Artifact Hub Helm annotations documentation.
The images used by an OLM operator are extracted from the
containerImage annotation in the CSV file metadata section, as well as from the
related images section in the CSV spec. Most of the OLM operators currently listed in Artifact Hub provide that information already, so security reports for them are already available in Artifact Hub with no extra effort required.
Images used by these kinds of packages can be listed using the
containersImages field in the package’s
artifacthub-pkg.yml metadata file.
Trivy also scans applications dependencies for vulnerabilities. To do that, it inspects the files that contain the applications dependencies and the versions used.
The following dependencies files are supported at the moment:
- JAR/WAR/EAR files (.jar, .war, and *.ear)
- Binaries built by Go (UPX-compressed binaries don’t work)
If you want your application dependencies scanned, please make sure the relevant files are included in your final images. The security report will include a target for each of them. You can find an example of how this is done in one of the Artifact Hub images here.
- I can’t see the security report for my package
Please make sure your images are publicly available. If your repository has just been added to Artifact Hub, it may take up to 30 mins for it to be indexed. Once it has been indexed, it may take up to 15 extra minutes for the initial security report of your packages to be generated. If you don’t see it after an hour and the images your package lists meet the requirements, please file an issue.