spdx

Documentation

Index

• Constants
• Variables
• func WithClock(clock clock.Clock) marshalOption
• func WithHasher(hasher Hash) marshalOption
• func WithNewUUID(newUUID newUUID) marshalOption
• type Hash
• type Marshaler
  • func NewMarshaler(opts ...marshalOption) *Marshaler
  • func (m *Marshaler) Marshal(r types.Report) (*spdx.Document2_2, error)
• type SPDX
  • func (s *SPDX) UnmarshalJSON(b []byte) error
• type TVDecoder
  • func NewTVDecoder(r io.Reader) *TVDecoder
  • func (tv *TVDecoder) Decode(v interface{}) error

Constants

const (
	SPDXVersion         = "SPDX-2.2"
	DataLicense         = "CC0-1.0"
	SPDXIdentifier      = "DOCUMENT"
	DocumentNamespace   = "http://aquasecurity.github.io/trivy"
	CreatorOrganization = "aquasecurity"
	CreatorTool         = "trivy"
)

const (
	CategoryPackageManager = "PACKAGE-MANAGER"
	RefTypePurl            = "purl"

	PropertySchemaVersion = "SchemaVersion"

	// Image properties
	PropertySize       = "Size"
	PropertyImageID    = "ImageID"
	PropertyRepoDigest = "RepoDigest"
	PropertyDiffID     = "DiffID"
	PropertyRepoTag    = "RepoTag"

	// Package properties
	PropertyPkgID       = "PkgID"
	PropertyLayerDiffID = "LayerDiffID"
	PropertyLayerDigest = "LayerDigest"

	RelationShipContains  = "CONTAINS"
	RelationShipDescribe  = "DESCRIBES"
	RelationShipDependsOn = "DEPENDS_ON"

	ElementOperatingSystem = "OperatingSystem"
	ElementApplication     = "Application"
	ElementPackage         = "Package"
	ElementFile            = "File"
)

Variables

var (
	SourcePackagePrefix = "built package from"
)

Functions

func WithClock

func WithClock(clock clock.Clock) marshalOption

func WithHasher

func WithHasher(hasher Hash) marshalOption

func WithNewUUID

func WithNewUUID(newUUID newUUID) marshalOption

Types

type Hash

type Hash func(v interface{}, format hashstructure.Format, opts *hashstructure.HashOptions) (uint64, error)

type Marshaler

type Marshaler struct {
	// contains filtered or unexported fields
}

func NewMarshaler

func NewMarshaler(opts ...marshalOption) *Marshaler

func (*Marshaler) Marshal

func (m *Marshaler) Marshal(r types.Report) (*spdx.Document2_2, error)

type SPDX

type SPDX struct {
	*types.SBOM
}

func (*SPDX) UnmarshalJSON

func (s *SPDX) UnmarshalJSON(b []byte) error

type TVDecoder

type TVDecoder struct {
	// contains filtered or unexported fields
}

func NewTVDecoder

func NewTVDecoder(r io.Reader) *TVDecoder

func (*TVDecoder) Decode

func (tv *TVDecoder) Decode(v interface{}) error