Skip to content
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.

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

Generate filesystem based SBOM for MRI dependency #362

Merged
merged 2 commits into from
Apr 26, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
47 changes: 39 additions & 8 deletions build.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,42 @@ import (
"github.com/paketo-buildpacks/packit/v2/chronos"
"github.com/paketo-buildpacks/packit/v2/pexec"
"github.com/paketo-buildpacks/packit/v2/postal"
"github.com/paketo-buildpacks/packit/v2/sbom"
"github.com/paketo-buildpacks/packit/v2/scribe"
)

//go:generate faux --interface EntryResolver --output fakes/entry_resolver.go
//go:generate faux --interface DependencyManager --output fakes/dependency_manager.go
//go:generate faux --interface Executable --output fakes/executable.go
//go:generate faux --interface SBOMGenerator --output fakes/sbom_generator.go

type EntryResolver interface {
Resolve(string, []packit.BuildpackPlanEntry, []interface{}) (packit.BuildpackPlanEntry, []packit.BuildpackPlanEntry)
MergeLayerTypes(string, []packit.BuildpackPlanEntry) (launch, build bool)
}

//go:generate faux --interface DependencyManager --output fakes/dependency_manager.go
type DependencyManager interface {
Resolve(path, id, version, stack string) (postal.Dependency, error)
Deliver(dependency postal.Dependency, cnbPath, layerPath, platformPath string) error
GenerateBillOfMaterials(dependencies ...postal.Dependency) []packit.BOMEntry
}

//go:generate faux --interface Executable --output fakes/executable.go
type Executable interface {
Execute(pexec.Execution) error
}

func Build(entries EntryResolver, dependencies DependencyManager, logger scribe.Emitter, clock chronos.Clock, gem Executable) packit.BuildFunc {
type SBOMGenerator interface {
GenerateFromDependency(dependency postal.Dependency, dir string) (sbom.SBOM, error)
}

func Build(
entries EntryResolver,
dependencies DependencyManager,
gem Executable,
sbomGenerator SBOMGenerator,
logger scribe.Emitter,
clock chronos.Clock,
) packit.BuildFunc {
return func(context packit.BuildContext) (packit.BuildResult, error) {
logger.Title("%s %s", context.BuildpackInfo.Name, context.BuildpackInfo.Version)
logger.Process("Resolving MRI version")
Expand Down Expand Up @@ -77,19 +91,17 @@ func Build(entries EntryResolver, dependencies DependencyManager, logger scribe.
logger.Debug.Subprocess(mriLayer.Path)
logger.Debug.Break()

logger.Debug.Process("Generating the SBOM")
logger.Debug.Break()
bom := dependencies.GenerateBillOfMaterials(dependency)
legacySBOM := dependencies.GenerateBillOfMaterials(dependency)
launch, build := entries.MergeLayerTypes("mri", context.Plan.Entries)

var buildMetadata packit.BuildMetadata
if build {
buildMetadata.BOM = bom
buildMetadata.BOM = legacySBOM
}

var launchMetadata packit.LaunchMetadata
if launch {
launchMetadata.BOM = bom
launchMetadata.BOM = legacySBOM
}

cachedSHA, ok := mriLayer.Metadata[DepKey].(string)
Expand Down Expand Up @@ -128,6 +140,25 @@ func Build(entries EntryResolver, dependencies DependencyManager, logger scribe.
logger.Action("Completed in %s", duration.Round(time.Millisecond))
logger.Break()

logger.GeneratingSBOM(mriLayer.Path)
var sbomContent sbom.SBOM
duration, err = clock.Measure(func() error {
sbomContent, err = sbomGenerator.GenerateFromDependency(dependency, mriLayer.Path)
return err
})
if err != nil {
return packit.BuildResult{}, err
}

logger.Action("Completed in %s", duration.Round(time.Millisecond))
logger.Break()

logger.FormattingSBOM(context.BuildpackInfo.SBOMFormats...)
mriLayer.SBOM, err = sbomContent.InFormats(context.BuildpackInfo.SBOMFormats...)
if err != nil {
return packit.BuildResult{}, err
}

mriLayer.Metadata = map[string]interface{}{
DepKey: dependency.SHA256,
}
Expand Down
Loading