spdx

Documentation

Index

• Constants
• Variables
• func GetLicense(p ftypes.Package) string
• func WithClock(clock clock.Clock) marshalOption
• func WithHasher(hasher Hash) marshalOption
• func WithNewUUID(newUUID newUUID) marshalOption
• type Hash
• type Marshaler
  • func NewMarshaler(version string, opts ...marshalOption) *Marshaler
  • func (m *Marshaler) Marshal(r types.Report) (*spdx.Document, 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 (
	DocumentSPDXIdentifier = "DOCUMENT"
	DocumentNamespace      = "http://khulnasoft.github.io/vul"
	CreatorOrganization    = "khulnasoft"
	CreatorTool            = "vul"
)

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"
	// Package Purpose fields
	PackagePurposeOS          = "OPERATING-SYSTEM"
	PackagePurposeContainer   = "CONTAINER"
	PackagePurposeSource      = "SOURCE"
	PackagePurposeApplication = "APPLICATION"
	PackagePurposeLibrary     = "LIBRARY"

	PackageSupplierNoAssertion  = "NOASSERTION"
	PackageSupplierOrganization = "Organization"

	RelationShipContains  = common.TypeRelationshipContains
	RelationShipDescribe  = common.TypeRelationshipDescribe
	RelationShipDependsOn = common.TypeRelationshipDependsOn

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

Variables

var (
	SourcePackagePrefix = "built package from"
)

Functions

func GetLicense

func GetLicense(p ftypes.Package) string

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(version string, opts ...marshalOption) *Marshaler

func (*Marshaler) Marshal

func (m *Marshaler) Marshal(r types.Report) (*spdx.Document, 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