sbom

Documentation

Index

• func CachedGenerate(ctx context.Context, inputFilePath string, f io.ReadSeeker, distroID string) (*sbom.SBOM, error)
• func FromSyftJSON(r io.ReadSeeker) (*sbom.SBOM, error)
• func Generate(ctx context.Context, inputFilePath string, f io.Reader, distroID string) (*sbom.SBOM, error)
• func ToSyftJSON(s *sbom.SBOM) (io.ReadSeeker, error)

Functions

func CachedGenerate

func CachedGenerate(ctx context.Context, inputFilePath string, f io.ReadSeeker, distroID string) (*sbom.SBOM, error)

CachedGenerate behaves similarly to Generate, but it caches the result of the SBOM generation using the user's local XDG cache home directory. Furthermore, if a generated SBOM is already available in the cache for the given APK, CachedGenerate will return the cached SBOM immediately instead of generating a new SBOM.

func FromSyftJSON

func FromSyftJSON(r io.ReadSeeker) (*sbom.SBOM, error)

FromSyftJSON returns an SBOM from a reader of the Syft JSON format.

func Generate

func Generate(ctx context.Context, inputFilePath string, f io.Reader, distroID string) (*sbom.SBOM, error)

Generate creates an SBOM for the given APK file.

func ToSyftJSON

func ToSyftJSON(s *sbom.SBOM) (io.ReadSeeker, error)

ToSyftJSON returns the SBOM as a reader of the Syft JSON format.