Skip to content

Package profiler#57

Merged
toderash merged 9 commits into
mainfrom
package-profiler
Apr 29, 2026
Merged

Package profiler#57
toderash merged 9 commits into
mainfrom
package-profiler

Conversation

@toderash
Copy link
Copy Markdown
Member

Package Profiler is a set of shell scripts with 2 controllers that will produce a combined json metadata document + 2 SBOMs. Includes file integrity checks, sbom validation, and cve checks against the sbom using Grype. Dependencies listed in docs. Documentation also includes design docs & developer docs, but may be somewhat repetitive with AI-verbosity.

`/package-profiler/*` should replace /sentinel-shell/ & /sbom-tools/ 
`/reputation-check/` is new, 2 scripts to evaluate email address deliverability and check domain reputation
docs included for `package-profiler` but not done yet for `reputation-check`. both need testing but can add as beta release.

Package Profiler scripts live together because of a few interdependencies. In general, they're meant to answer the question "What are we dealing with?"

Noted: Package Profiler is now 14,600 lines of code in 16 shell scripts and over 4,000 lines of documentation in 31 text/markup files, as tallied by `file-stats.sh`.

Signed-off-by: Brent Toderash <brent@toderash.net>
Signed-off-by: Brent Toderash <brent@toderash.net>
Signed-off-by: Brent Toderash <brent@toderash.net>
Signed-off-by: Brent Toderash <brent@toderash.net>
@toderash toderash requested review from chuckadams and namithj April 22, 2026 14:05
@toderash toderash added the enhancement New feature or request label Apr 22, 2026
@namithj namithj requested a review from Copilot April 22, 2026 16:42
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds the new “Package Profiler” toolset: Bash scripts for SBOM generation/discovery and vulnerability scanning, plus a Filescan controller, JSON schema examples, and extensive documentation.

Changes:

  • Introduces sbom-gen.sh, sbom-discover.sh, vuln-scan.sh, and vuln-scan-risk.jq for SBOM production + Grype-based vulnerability scanning with risk scoring.
  • Adds run-filescans.sh controller logic for running file stats/permission/deep content scans and merging outputs.
  • Adds/expands documentation: architecture/design, install guides, output schema reference, and testing guides.

Reviewed changes

Copilot reviewed 49 out of 59 changed files in this pull request and generated 20 comments.

Show a summary per file
File Description
tools/package-profiler/vuln-scan.sh New Grype scan wrapper with optional risk scoring + merged output document
tools/package-profiler/vuln-scan-risk.jq New jq program for CVSS-weighted risk scoring from Grype JSON
tools/package-profiler/sbom-gen.sh New Syft SBOM generator with provenance metadata embedding + post-processing
tools/package-profiler/sbom-discover.sh New embedded SBOM/manifest discovery + lightweight validation
tools/package-profiler/run-filescans.sh Filescan suite controller: orchestration + merged JSON output
tools/package-profiler/output-schema-example.json Example of the intended combined output schema
tools/package-profiler/docs/testing/toolkit-test.md SBOM toolkit test-suite documentation
tools/package-profiler/docs/testing/filescan-test.md Filescan suite test-suite documentation
tools/package-profiler/docs/sbom-toolkit/vuln-scan.md vuln-scan usage + risk scoring documentation
tools/package-profiler/docs/sbom-toolkit/slsa-attest.md slsa-attest usage documentation
tools/package-profiler/docs/sbom-toolkit/sbom-toolkit.md sbom-toolkit controller documentation
tools/package-profiler/docs/sbom-toolkit/sbom-gen.md sbom-gen usage documentation
tools/package-profiler/docs/sbom-toolkit/sbom-discover.md sbom-discover usage documentation
tools/package-profiler/docs/sbom-toolkit/sbom-compare.md sbom-compare usage documentation
tools/package-profiler/docs/sbom-toolkit/provenance-verify.md provenance-verify usage documentation
tools/package-profiler/docs/sbom-toolkit/license-check.md license-check usage documentation
tools/package-profiler/docs/sbom-toolkit/design.md SBOM toolkit design document
tools/package-profiler/docs/sbom-toolkit/dependency-audit.md dependency-audit usage documentation
tools/package-profiler/docs/sbom-toolkit/checksum-verify.md checksum-verify usage documentation
tools/package-profiler/docs/sbom-toolkit/README.md SBOM toolkit docs index
tools/package-profiler/docs/filescan/run-filescans.md run-filescans usage documentation
tools/package-profiler/docs/filescan/permission-check.md permission-check usage documentation
tools/package-profiler/docs/filescan/file-stats.md file-stats usage documentation
tools/package-profiler/docs/filescan/design.md Filescan suite design document
tools/package-profiler/docs/filescan/deep-filescan.md deep-filescan usage documentation
tools/package-profiler/docs/filescan/README.md Filescan suite docs index
tools/package-profiler/docs/developer/maintenance.md Maintenance/tuning guide (thresholds, patterns, ecosystems)
tools/package-profiler/docs/developer/json-schema.md Field-level JSON schema reference (narrative)
tools/package-profiler/docs/developer/getting-started.md Getting started + CI examples
tools/package-profiler/docs/developer/architecture.md Architecture overview (waves, data flow, outputs)
tools/package-profiler/docs/README.md Top-level documentation hub
tools/package-profiler/docs/INSTALL.md Installation/dependency documentation
tools/package-profiler/SECURITY.md Security contact/process doc
tools/package-profiler/GOVERNANCE.md Governance doc
tools/package-profiler/CONTRIBUTING.md Contributing doc
tools/package-profiler/CODE_OF_CONDUCT.md Code of conduct link doc
tools/package-profiler/CHANGELOG.md Initial changelog entry

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread tools/package-profiler/run-filescans.sh Outdated
Comment thread tools/package-profiler/run-filescans.sh Outdated
Comment thread tools/package-profiler/vuln-scan.sh Outdated
Comment thread tools/package-profiler/vuln-scan.sh
Comment thread tools/package-profiler/vuln-scan.sh
Comment thread tools/package-profiler/vuln-scan-risk.jq
Comment thread tools/package-profiler/docs/filescan/run-filescans.md Outdated
Comment thread tools/package-profiler/vuln-scan.sh
Comment thread tools/package-profiler/output-schema-example.json
Comment thread tools/package-profiler/SECURITY.md Outdated
chuckadams and others added 5 commits April 22, 2026 15:00
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Chuck Adams <chaz@chaz.works>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Chuck Adams <chaz@chaz.works>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Chuck Adams <chaz@chaz.works>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Brent Toderash <brent@toderash.net>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Brent Toderash <brent@toderash.net>
@toderash toderash merged commit 5a4b815 into main Apr 29, 2026
1 check passed
toderash added a commit that referenced this pull request Apr 30, 2026
Address PR #57 review feedback + add CLAUDE.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants