chore(docs): Update lists of catalogers (#1780)

Signed-off-by: Jeff Squyres <jeff@squyres.com>
This commit is contained in:
Jeff Squyres 2023-05-04 15:36:22 -04:00 committed by GitHub
parent 645206735e
commit d63a1f5f80
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 132 additions and 105 deletions

117
README.md
View File

@ -152,39 +152,53 @@ This default behavior can be overridden with the `default-image-pull-source` con
##### Image Scanning: ##### Image Scanning:
- alpmdb - alpmdb
- rpmdb
- dpkgdb
- apkdb - apkdb
- portage - binary
- ruby-gemspec
- python-package
- php-composer-installed Cataloger
- javascript-package
- java
- go-module-binary
- dotnet-deps - dotnet-deps
- dpkgdb
- go-module-binary
- graalvm-native-image
- java
- javascript-package
- linux-kernel
- nix-store
- php-composer-installed
- portage
- python-package
- rpm-db
- ruby-gemspec
- sbom
##### Directory Scanning: ##### Directory Scanning:
- alpmdb - alpmdb
- apkdb - apkdb
- dpkgdb - binary
- portage
- rpmdb
- ruby-gemfile
- python-index
- python-package
- php-composer-lock
- javascript-lock
- java
- java-pom
- go-module-binary
- go-mod-file
- rust-cargo-lock
- dartlang-lock
- dotnet-deps
- cocoapods - cocoapods
- conan - conan
- hackage - dartlang-lock
- dotnet-deps
- dpkgdb
- elixir-mix-lock
- erlang-rebar-lock
- go-mod-file
- go-module-binary
- graalvm-native-image
- haskell
- java
- java-gradle-lockfile
- java-pom
- javascript-lock
- linux-kernel
- nix-store
- php-composer-lock
- portage
- python-index
- python-package
- rpm-db
- rpm-file
- ruby-gemfile
- rust-cargo-lock
- sbom
##### Non Default: ##### Non Default:
- cargo-auditable-binary - cargo-auditable-binary
@ -462,26 +476,39 @@ platform: ""
# set the list of package catalogers to use when generating the SBOM # set the list of package catalogers to use when generating the SBOM
# default = empty (cataloger set determined automatically by the source type [image or file/directory]) # default = empty (cataloger set determined automatically by the source type [image or file/directory])
# catalogers: # catalogers:
# - ruby-gemfile # - alpmdb-cataloger
# - ruby-gemspec # - apkdb-cataloger
# - python-index # - binary-cataloger
# - python-package # - cargo-auditable-binary-cataloger
# - javascript-lock # - cocoapods-cataloger
# - javascript-package # - conan-cataloger
# - php-composer-installed # - dartlang-lock-cataloger
# - php-composer-lock # - dotnet-deps-cataloger
# - alpmdb # - dpkgdb-cataloger
# - dpkgdb # - elixir-mix-lock-cataloger
# - rpmdb # - erlang-rebar-lock-cataloger
# - java # - go-mod-file-cataloger
# - apkdb # - go-module-binary-cataloger
# - go-module-binary # - graalvm-native-image-cataloger
# - go-mod-file # - haskell-cataloger
# - dartlang-lock # - java-cataloger
# - rust # - java-gradle-lockfile-cataloger
# - dotnet-deps # - java-pom-cataloger
# rust-audit-binary scans Rust binaries built with https://github.com/Shnatsel/rust-audit # - javascript-lock-cataloger
# - rust-audit-binary # - javascript-package-cataloger
# - linux-kernel-cataloger
# - nix-store-cataloger
# - php-composer-installed-cataloger
# - php-composer-lock-cataloger
# - portage-cataloger
# - python-index-cataloger
# - python-package-cataloger
# - rpm-db-cataloger
# - rpm-file-cataloger
# - ruby-gemfile-cataloger
# - ruby-gemspec-cataloger
# - rust-cargo-lock-cataloger
# - sbom-cataloger
catalogers: catalogers:
# cataloging packages is exposed through the packages and power-user subcommands # cataloging packages is exposed through the packages and power-user subcommands

View File

@ -41,22 +41,22 @@ const AllCatalogersPattern = "all"
func ImageCatalogers(cfg Config) []pkg.Cataloger { func ImageCatalogers(cfg Config) []pkg.Cataloger {
return filterCatalogers([]pkg.Cataloger{ return filterCatalogers([]pkg.Cataloger{
alpm.NewAlpmdbCataloger(), alpm.NewAlpmdbCataloger(),
ruby.NewGemSpecCataloger(), apkdb.NewApkdbCataloger(),
python.NewPythonPackageCataloger(), binary.NewCataloger(),
php.NewComposerInstalledCataloger(),
javascript.NewPackageCataloger(),
deb.NewDpkgdbCataloger(), deb.NewDpkgdbCataloger(),
rpm.NewRpmDBCataloger(), dotnet.NewDotnetDepsCataloger(),
golang.NewGoModuleBinaryCataloger(cfg.Go()),
java.NewJavaCataloger(cfg.Java()), java.NewJavaCataloger(cfg.Java()),
java.NewNativeImageCataloger(), java.NewNativeImageCataloger(),
apkdb.NewApkdbCataloger(), javascript.NewPackageCataloger(),
golang.NewGoModuleBinaryCataloger(cfg.Go()),
dotnet.NewDotnetDepsCataloger(),
portage.NewPortageCataloger(),
nix.NewStoreCataloger(),
sbom.NewSBOMCataloger(),
binary.NewCataloger(),
kernel.NewLinuxKernelCataloger(cfg.Kernel()), kernel.NewLinuxKernelCataloger(cfg.Kernel()),
nix.NewStoreCataloger(),
php.NewComposerInstalledCataloger(),
portage.NewPortageCataloger(),
python.NewPythonPackageCataloger(),
rpm.NewRpmDBCataloger(),
ruby.NewGemSpecCataloger(),
sbom.NewSBOMCataloger(),
}, cfg.Catalogers) }, cfg.Catalogers)
} }
@ -64,34 +64,34 @@ func ImageCatalogers(cfg Config) []pkg.Cataloger {
func DirectoryCatalogers(cfg Config) []pkg.Cataloger { func DirectoryCatalogers(cfg Config) []pkg.Cataloger {
return filterCatalogers([]pkg.Cataloger{ return filterCatalogers([]pkg.Cataloger{
alpm.NewAlpmdbCataloger(), alpm.NewAlpmdbCataloger(),
ruby.NewGemFileLockCataloger(),
python.NewPythonIndexCataloger(),
python.NewPythonPackageCataloger(),
php.NewComposerLockCataloger(),
javascript.NewLockCataloger(),
deb.NewDpkgdbCataloger(),
rpm.NewRpmDBCataloger(),
rpm.NewFileCataloger(),
java.NewJavaCataloger(cfg.Java()),
java.NewJavaPomCataloger(),
java.NewNativeImageCataloger(),
java.NewJavaGradleLockfileCataloger(),
apkdb.NewApkdbCataloger(), apkdb.NewApkdbCataloger(),
golang.NewGoModuleBinaryCataloger(cfg.Go()),
golang.NewGoModFileCataloger(cfg.Go()),
rust.NewCargoLockCataloger(),
dart.NewPubspecLockCataloger(),
dotnet.NewDotnetDepsCataloger(),
swift.NewCocoapodsCataloger(),
cpp.NewConanCataloger(),
portage.NewPortageCataloger(),
haskell.NewHackageCataloger(),
sbom.NewSBOMCataloger(),
binary.NewCataloger(), binary.NewCataloger(),
cpp.NewConanCataloger(),
dart.NewPubspecLockCataloger(),
deb.NewDpkgdbCataloger(),
dotnet.NewDotnetDepsCataloger(),
elixir.NewMixLockCataloger(), elixir.NewMixLockCataloger(),
erlang.NewRebarLockCataloger(), erlang.NewRebarLockCataloger(),
golang.NewGoModFileCataloger(cfg.Go()),
golang.NewGoModuleBinaryCataloger(cfg.Go()),
haskell.NewHackageCataloger(),
java.NewJavaCataloger(cfg.Java()),
java.NewJavaGradleLockfileCataloger(),
java.NewJavaPomCataloger(),
java.NewNativeImageCataloger(),
javascript.NewLockCataloger(),
kernel.NewLinuxKernelCataloger(cfg.Kernel()), kernel.NewLinuxKernelCataloger(cfg.Kernel()),
nix.NewStoreCataloger(), nix.NewStoreCataloger(),
php.NewComposerLockCataloger(),
portage.NewPortageCataloger(),
python.NewPythonIndexCataloger(),
python.NewPythonPackageCataloger(),
rpm.NewFileCataloger(),
rpm.NewRpmDBCataloger(),
ruby.NewGemFileLockCataloger(),
rust.NewCargoLockCataloger(),
sbom.NewSBOMCataloger(),
swift.NewCocoapodsCataloger(),
}, cfg.Catalogers) }, cfg.Catalogers)
} }
@ -99,38 +99,38 @@ func DirectoryCatalogers(cfg Config) []pkg.Cataloger {
func AllCatalogers(cfg Config) []pkg.Cataloger { func AllCatalogers(cfg Config) []pkg.Cataloger {
return filterCatalogers([]pkg.Cataloger{ return filterCatalogers([]pkg.Cataloger{
alpm.NewAlpmdbCataloger(), alpm.NewAlpmdbCataloger(),
ruby.NewGemFileLockCataloger(),
ruby.NewGemSpecCataloger(),
python.NewPythonIndexCataloger(),
python.NewPythonPackageCataloger(),
javascript.NewLockCataloger(),
javascript.NewPackageCataloger(),
deb.NewDpkgdbCataloger(),
rpm.NewRpmDBCataloger(),
rpm.NewFileCataloger(),
java.NewJavaCataloger(cfg.Java()),
java.NewJavaPomCataloger(),
java.NewNativeImageCataloger(),
java.NewJavaGradleLockfileCataloger(),
apkdb.NewApkdbCataloger(), apkdb.NewApkdbCataloger(),
golang.NewGoModuleBinaryCataloger(cfg.Go()),
golang.NewGoModFileCataloger(cfg.Go()),
rust.NewCargoLockCataloger(),
rust.NewAuditBinaryCataloger(),
dart.NewPubspecLockCataloger(),
dotnet.NewDotnetDepsCataloger(),
php.NewComposerInstalledCataloger(),
php.NewComposerLockCataloger(),
swift.NewCocoapodsCataloger(),
cpp.NewConanCataloger(),
portage.NewPortageCataloger(),
haskell.NewHackageCataloger(),
sbom.NewSBOMCataloger(),
binary.NewCataloger(), binary.NewCataloger(),
cpp.NewConanCataloger(),
dart.NewPubspecLockCataloger(),
deb.NewDpkgdbCataloger(),
dotnet.NewDotnetDepsCataloger(),
elixir.NewMixLockCataloger(), elixir.NewMixLockCataloger(),
erlang.NewRebarLockCataloger(), erlang.NewRebarLockCataloger(),
golang.NewGoModFileCataloger(cfg.Go()),
golang.NewGoModuleBinaryCataloger(cfg.Go()),
haskell.NewHackageCataloger(),
java.NewJavaCataloger(cfg.Java()),
java.NewJavaGradleLockfileCataloger(),
java.NewJavaPomCataloger(),
java.NewNativeImageCataloger(),
javascript.NewLockCataloger(),
javascript.NewPackageCataloger(),
kernel.NewLinuxKernelCataloger(cfg.Kernel()), kernel.NewLinuxKernelCataloger(cfg.Kernel()),
nix.NewStoreCataloger(), nix.NewStoreCataloger(),
php.NewComposerInstalledCataloger(),
php.NewComposerLockCataloger(),
portage.NewPortageCataloger(),
python.NewPythonIndexCataloger(),
python.NewPythonPackageCataloger(),
rpm.NewFileCataloger(),
rpm.NewRpmDBCataloger(),
ruby.NewGemFileLockCataloger(),
ruby.NewGemSpecCataloger(),
rust.NewAuditBinaryCataloger(),
rust.NewCargoLockCataloger(),
sbom.NewSBOMCataloger(),
swift.NewCocoapodsCataloger(),
}, cfg.Catalogers) }, cfg.Catalogers)
} }