Skip to content

docs: sync README.md with cmd/generate.go defaults and fix pipeline flow #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
imshubham22apr-gif wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: sync README.md with cmd/generate.go defaults and fix pipeline flow #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Flags:
-v, --version string Version for the SBOM document (default "0.0.1")
```

By default, `sbomit` parses `material`, `command-run`, and `product` attestations. To restrict parsing on demand:
By default, `sbomit` parses `material`, `command-run`, `product`, and `network-trace` attestations. To restrict parsing on demand:

```bash
sbomit generate attestation.json --types command-run
Expand All @@ -55,9 +55,10 @@ sbomit generate attestation.json --catalog syft --project-dir /path/to/project
### Attestation Extractors

Modular extractors for different attestation types:
- `MaterialExtractor` - Build Input materials
- `MaterialExtractor` - Build input materials
- `CommandRunExtractor` - Opened files from processes
- `ProductExtractor` - Built artifacts
- `NetworkTrace` - External download connections

Implement `Extractor` interface to add new types.

Expand All @@ -74,8 +75,9 @@ Each resolver implements `Resolver` and optionally `PackageFileFilterer` to filt
### Processing Pipeline

```
Attestation → Extract Files → Filter Cache Files →
Run Resolvers → Filter Package Files → Generate SBOM
Attestation → Extract Files & Network Conns → Run Resolvers →
Filter Package Files → Resolve Network PURLs → Merge with Catalog (Syft) →
Generate SBOM Document
```

## Testing
Expand Down