Documentation
¶
Index ¶
- Constants
- type Checksum
- type CreationInfo
- type Document
- type ExternalDocumentRef
- type ExternalRef
- type File
- type LicensingInfo
- type Package
- type PackageVerificationCode
- type Relationship
- type SPDX
- func (sx *SPDX) Ext() string
- func (sx *SPDX) Generate(opts *options.Options, path string) error
- func (sx *SPDX) GenerateIndex(opts *options.Options, path string) error
- func (sx *SPDX) Key() string
- func (sx *SPDX) ParseInternalSBOM(opts *options.Options, path string) (*Document, error)
- func (sx *SPDX) ProcessInternalApkSBOM(opts *options.Options, doc *Document, p *Package, ipkg *apk.InstalledPackage) error
Constants ¶
View Source
const ( NOASSERTION = "NOASSERTION" ExtRefPackageManager = "PACKAGE-MANAGER" ExtRefTypePurl = "purl" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreationInfo ¶
type Document ¶
type Document struct {
ID string `json:"SPDXID"`
Name string `json:"name"`
Version string `json:"spdxVersion"`
CreationInfo CreationInfo `json:"creationInfo"`
DataLicense string `json:"dataLicense"`
Namespace string `json:"documentNamespace"`
DocumentDescribes []string `json:"documentDescribes"`
Packages []Package `json:"packages"`
Relationships []Relationship `json:"relationships"`
ExternalDocumentRefs []ExternalDocumentRef `json:"externalDocumentRefs,omitempty"`
LicensingInfos []LicensingInfo `json:"hasExtractedLicensingInfos,omitempty"`
}
type ExternalDocumentRef ¶ added in v0.5.0
type ExternalRef ¶
type File ¶ added in v0.6.0
type File struct {
ID string `json:"SPDXID"`
Name string `json:"fileName"`
CopyrightText string `json:"copyrightText,omitempty"`
NoticeText string `json:"noticeText,omitempty"`
LicenseConcluded string `json:"licenseConcluded,omitempty"`
Description string `json:"description,omitempty"`
FileTypes []string `json:"fileTypes,omitempty"`
LicenseInfoInFile []string `json:"licenseInfoInFiles,omitempty"` // List of licenses
Checksums []Checksum `json:"checksums,omitempty"`
}
type LicensingInfo ¶ added in v0.14.2
type LicensingInfo struct {
LicenseID string `json:"licenseId"`
ExtractedText string `json:"extractedText"`
}
Can also contain name, comment, seeAlso
type Package ¶
type Package struct {
ID string `json:"SPDXID"`
Name string `json:"name"`
Version string `json:"versionInfo,omitempty"`
FilesAnalyzed bool `json:"filesAnalyzed"`
LicenseConcluded string `json:"licenseConcluded,omitempty"`
LicenseDeclared string `json:"licenseDeclared,omitempty"`
Description string `json:"description,omitempty"`
DownloadLocation string `json:"downloadLocation,omitempty"`
Originator string `json:"originator,omitempty"`
Supplier string `json:"supplier,omitempty"`
SourceInfo string `json:"sourceInfo,omitempty"`
CopyrightText string `json:"copyrightText,omitempty"`
PrimaryPurpose string `json:"primaryPackagePurpose,omitempty"`
Checksums []Checksum `json:"checksums,omitempty"`
ExternalRefs []ExternalRef `json:"externalRefs,omitempty"`
VerificationCode *PackageVerificationCode `json:"packageVerificationCode,omitempty"`
}
type PackageVerificationCode ¶ added in v0.6.0
type PackageVerificationCode struct {
Value string `json:"packageVerificationCodeValue,omitempty"`
}
type Relationship ¶
type SPDX ¶
type SPDX struct {
// contains filtered or unexported fields
}
func (*SPDX) GenerateIndex ¶ added in v0.5.0
func (*SPDX) ParseInternalSBOM ¶ added in v0.7.0
ParseInternalSBOM opens an SBOM inside apks and
func (*SPDX) ProcessInternalApkSBOM ¶ added in v0.7.0
Click to show internal directories.
Click to hide internal directories.