spdx

Documentation

Index

• Constants
• Variables
• func NormalizeLicense(licenses []string) string
• func WithHasher(hasher Hash) marshalOption
• type Hash
• type Marshaler
  • func NewMarshaler(version string, opts ...marshalOption) *Marshaler
  • func (m *Marshaler) Marshal(ctx context.Context, bom *core.BOM) (*spdx.Document, error)
  • func (m *Marshaler) MarshalReport(ctx context.Context, report 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 any) error

Constants

const (
	DocumentSPDXIdentifier = "DOCUMENT"
	DocumentNamespace      = "http://khulnasoft.github.io/tunnel"
	CreatorOrganization    = "khulnasoft"
	CreatorTool            = "tunnel"
)

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

	// Package Purpose fields
	PackagePurposeOS          = "OPERATING-SYSTEM"
	PackagePurposeContainer   = "CONTAINER"
	PackagePurposeSource      = "SOURCE"
	PackagePurposeApplication = "APPLICATION"
	PackagePurposeLibrary     = "LIBRARY"

	PackageSupplierNoAssertion  = "NOASSERTION"
	PackageSupplierOrganization = "Organization"

	PackageAnnotatorToolField = "Tool"

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

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

Variables

var (
	SourcePackagePrefix = "built package from"
	SourceFilePrefix    = "package found in"
)

Functions

func NormalizeLicense

func NormalizeLicense(licenses []string) string

func WithHasher

func WithHasher(hasher Hash) marshalOption

Types

type Hash

type Hash func(v any, 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(ctx context.Context, bom *core.BOM) (*spdx.Document, error)

func (*Marshaler) MarshalReport

func (m *Marshaler) MarshalReport(ctx context.Context, report types.Report) (*spdx.Document, error)

type SPDX

type SPDX struct {
	*core.BOM
	// contains filtered or unexported fields
}

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 any) error