Documentation
¶
Index ¶
- func CleanKey(key string) string
- func SupportedPrimaryPurpose(f string) []string
- func SupportedSBOMFileFormats(f string) []string
- func SupportedSBOMSpecVersions(f string) []string
- func SupportedSBOMSpecs() []string
- type Author
- type CdxDoc
- func (c CdxDoc) Authors() []GetAuthor
- func (c CdxDoc) Components() []GetComponent
- func (c CdxDoc) GetComposition(componentID string) string
- func (c CdxDoc) GetRelationships(componentID string) []string
- func (c CdxDoc) Lifecycles() []string
- func (c CdxDoc) Logs() []string
- func (c CdxDoc) Manufacturer() GetManufacturer
- func (c CdxDoc) PrimaryComp() GetPrimaryComp
- func (c CdxDoc) Relations() []GetRelation
- func (c CdxDoc) Signature() GetSignature
- func (c CdxDoc) Spec() Spec
- func (c CdxDoc) Supplier() GetSupplier
- func (c CdxDoc) Tools() []GetTool
- func (c CdxDoc) Vulnerabilities() []GetVulnerabilities
- type Checksum
- type Component
- func (c Component) Authors() []GetAuthor
- func (c Component) ConcludedLicenses() []licenses.License
- func (c Component) CountOfDependencies() int
- func (c Component) DeclaredLicenses() []licenses.License
- func (c Component) ExternalReferences() []GetExternalReference
- func (c Component) GetChecksums() []GetChecksum
- func (c Component) GetComposition(componentID string) string
- func (c Component) GetCopyRight() string
- func (c Component) GetCpes() []cpe.CPE
- func (c Component) GetDownloadLocationURL() string
- func (c Component) GetFileAnalyzed() bool
- func (c Component) GetID() string
- func (c Component) GetName() string
- func (c Component) GetPackageLicenseConcluded() string
- func (c Component) GetPackageLicenseDeclared() string
- func (c Component) GetPrimaryCompInfo() GetPrimaryComp
- func (c Component) GetPurls() []purl.PURL
- func (c Component) GetSpdxID() string
- func (c Component) GetVersion() string
- func (c Component) HasRelationShips() bool
- func (c Component) IsPrimaryComponent() bool
- func (c Component) Licenses() []licenses.License
- func (c Component) Manufacturer() GetManufacturer
- func (c Component) OmniborIDs() []omniborid.OMNIBORID
- func (c Component) PrimaryPurpose() string
- func (c Component) RelationShipState() string
- func (c Component) RequiredFields() bool
- func (c Component) SourceCodeHash() string
- func (c Component) SourceCodeURL() string
- func (c Component) Suppliers() GetSupplier
- func (c Component) Swhids() []swhid.SWHID
- func (c Component) Swids() []swid.SWID
- type Contact
- type Document
- type ExternalReference
- type FileFormat
- type FormatVersion
- type GetAuthor
- type GetChecksum
- type GetComponent
- type GetContact
- type GetExternalReference
- type GetManufacturer
- type GetPrimaryComp
- type GetRelation
- type GetSignature
- type GetSupplier
- type GetTool
- type GetVulnerabilities
- type Manufacturer
- type PrimaryComp
- func (pc PrimaryComp) GetDependencies() []string
- func (pc PrimaryComp) GetID() string
- func (pc PrimaryComp) GetName() string
- func (pc PrimaryComp) GetTotalNoOfDependencies() int
- func (pc PrimaryComp) GetVersion() string
- func (pc PrimaryComp) HasDependencies() bool
- func (pc PrimaryComp) IsPresent() bool
- type Relation
- type Signature
- type SpdxDoc
- func (s SpdxDoc) Authors() []GetAuthor
- func (s SpdxDoc) Components() []GetComponent
- func (s SpdxDoc) GetComposition(componentID string) string
- func (s SpdxDoc) GetRelationships(componentID string) []string
- func (s SpdxDoc) Lifecycles() []string
- func (s SpdxDoc) Logs() []string
- func (s SpdxDoc) Manufacturer() GetManufacturer
- func (s SpdxDoc) PrimaryComp() GetPrimaryComp
- func (s SpdxDoc) Relations() []GetRelation
- func (s SpdxDoc) Signature() GetSignature
- func (s SpdxDoc) Spec() Spec
- func (s SpdxDoc) Supplier() GetSupplier
- func (s SpdxDoc) Tools() []GetTool
- func (s SpdxDoc) Vulnerabilities() []GetVulnerabilities
- type Spec
- type SpecFormat
- type Specs
- func (s Specs) FileFormat() string
- func (s Specs) GetComment() string
- func (s Specs) GetCreationTimestamp() string
- func (s Specs) GetExtDocRef() []string
- func (s Specs) GetLicenses() []licenses.License
- func (s Specs) GetName() string
- func (s Specs) GetNamespace() string
- func (s Specs) GetOrganization() string
- func (s Specs) GetSpdxID() string
- func (s Specs) GetSpecType() string
- func (s Specs) GetURI() string
- func (s Specs) GetVersion() string
- func (s Specs) Parsable() bool
- func (s Specs) RequiredFields() bool
- type Supplier
- type Tool
- type Vulnerability
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SupportedPrimaryPurpose ¶
func SupportedSBOMSpecs ¶
func SupportedSBOMSpecs() []string
Types ¶
type CdxDoc ¶ added in v0.2.0
type CdxDoc struct {
CdxSpec *Specs
Comps []GetComponent
CdxAuthors []GetAuthor
CdxTools []GetTool
Lifecycle []string
CdxSupplier GetSupplier
CdxManufacturer GetManufacturer
PrimaryComponent PrimaryComp
Dependencies map[string][]string
Vuln []GetVulnerabilities
SignatureDetail GetSignature
// contains filtered or unexported fields
}
func (CdxDoc) Components ¶ added in v0.2.0
func (c CdxDoc) Components() []GetComponent
func (CdxDoc) GetComposition ¶ added in v0.2.0
func (CdxDoc) GetRelationships ¶ added in v0.2.0
func (CdxDoc) Lifecycles ¶ added in v0.2.0
func (CdxDoc) Manufacturer ¶ added in v0.2.0
func (c CdxDoc) Manufacturer() GetManufacturer
func (CdxDoc) PrimaryComp ¶ added in v0.2.0
func (c CdxDoc) PrimaryComp() GetPrimaryComp
func (CdxDoc) Relations ¶ added in v0.2.0
func (c CdxDoc) Relations() []GetRelation
func (CdxDoc) Signature ¶ added in v1.0.0
func (c CdxDoc) Signature() GetSignature
func (CdxDoc) Supplier ¶ added in v0.2.0
func (c CdxDoc) Supplier() GetSupplier
func (CdxDoc) Vulnerabilities ¶ added in v1.0.0
func (c CdxDoc) Vulnerabilities() []GetVulnerabilities
type Checksum ¶
func (Checksum) GetContent ¶ added in v0.1.5
type Component ¶
type Component struct {
Name string
Version string
Cpes []cpe.CPE
Purls []purl.PURL
Swhid []swhid.SWHID
OmniID []omniborid.OMNIBORID
Swid []swid.SWID
Checksums []GetChecksum
ID string
Athrs []GetAuthor
Supplier Supplier
DownloadLocation string
PrimaryCompt PrimaryComp
RelationshipState string
Spdxid string
FileAnalyzed bool
CopyRight string
PackageLicenseConcluded string
PackageLicenseDeclared string
ExternalRefs []GetExternalReference
// contains filtered or unexported fields
}
func NewComponent ¶ added in v0.1.5
func NewComponent() *Component
func (Component) ConcludedLicenses ¶ added in v1.0.0
func (Component) CountOfDependencies ¶ added in v0.1.0
func (Component) DeclaredLicenses ¶ added in v1.0.0
func (Component) ExternalReferences ¶ added in v0.1.5
func (c Component) ExternalReferences() []GetExternalReference
func (Component) GetChecksums ¶ added in v0.1.5
func (c Component) GetChecksums() []GetChecksum
func (Component) GetComposition ¶ added in v0.2.0
func (Component) GetCopyRight ¶ added in v0.1.5
func (Component) GetDownloadLocationURL ¶ added in v0.1.8
func (Component) GetFileAnalyzed ¶ added in v0.1.5
func (Component) GetPackageLicenseConcluded ¶ added in v0.1.5
func (Component) GetPackageLicenseDeclared ¶ added in v0.1.5
func (Component) GetPrimaryCompInfo ¶ added in v0.2.2
func (c Component) GetPrimaryCompInfo() GetPrimaryComp
func (Component) GetVersion ¶ added in v0.1.5
func (Component) HasRelationShips ¶ added in v0.1.0
func (Component) IsPrimaryComponent ¶ added in v0.1.0
func (Component) Manufacturer ¶ added in v0.1.0
func (c Component) Manufacturer() GetManufacturer
func (Component) OmniborIDs ¶ added in v0.2.2
func (Component) PrimaryPurpose ¶
func (Component) RelationShipState ¶ added in v0.1.0
func (Component) RequiredFields ¶
func (Component) SourceCodeHash ¶ added in v0.1.0
func (Component) SourceCodeURL ¶ added in v0.1.8
func (Component) Suppliers ¶ added in v0.1.5
func (c Component) Suppliers() GetSupplier
type Document ¶
type Document interface {
Spec() Spec
Components() []GetComponent
Relations() []GetRelation
Authors() []GetAuthor
Tools() []GetTool
Logs() []string
Lifecycles() []string
Manufacturer() GetManufacturer
Supplier() GetSupplier
PrimaryComp() GetPrimaryComp
GetRelationships(string) []string
Vulnerabilities() []GetVulnerabilities
Signature() GetSignature
}
func NewSBOMDocument ¶
type ExternalReference ¶ added in v0.1.5
func (ExternalReference) GetRefLocator ¶ added in v0.2.2
func (e ExternalReference) GetRefLocator() string
func (ExternalReference) GetRefType ¶ added in v0.1.5
func (e ExternalReference) GetRefType() string
type FileFormat ¶
type FileFormat string
const ( FileFormatJSON FileFormat = "json" FileFormatRDF FileFormat = "rdf" FileFormatYAML FileFormat = "yaml" FileFormatTagValue FileFormat = "tag-value" FileFormatXML FileFormat = "xml" FileFormatUnknown FileFormat = "unknown" )
type FormatVersion ¶ added in v0.2.3
type FormatVersion string
type GetChecksum ¶ added in v0.1.5
type GetComponent ¶ added in v0.1.5
type GetComponent interface {
GetID() string
GetName() string
GetVersion() string
GetCpes() []cpe.CPE
GetPurls() []purl.PURL
Swhids() []swhid.SWHID
OmniborIDs() []omniborid.OMNIBORID
Swids() []swid.SWID
Licenses() []licenses.License
DeclaredLicenses() []licenses.License
ConcludedLicenses() []licenses.License
GetChecksums() []GetChecksum
PrimaryPurpose() string
RequiredFields() bool
Suppliers() GetSupplier
Authors() []GetAuthor
Manufacturer() GetManufacturer
CountOfDependencies() int
SourceCodeURL() string
GetDownloadLocationURL() string
SourceCodeHash() string
IsPrimaryComponent() bool
HasRelationShips() bool
RelationShipState() string
GetSpdxID() string
GetFileAnalyzed() bool
GetCopyRight() string
GetPackageLicenseDeclared() string
GetPackageLicenseConcluded() string
ExternalReferences() []GetExternalReference
GetComposition(string) string
GetPrimaryCompInfo() GetPrimaryComp
}
type GetContact ¶ added in v0.2.2
type GetExternalReference ¶ added in v0.1.5
type GetManufacturer ¶ added in v1.0.0
type GetPrimaryComp ¶ added in v0.2.0
type GetRelation ¶ added in v0.2.0
type GetSignature ¶ added in v1.0.0
type GetSupplier ¶ added in v0.1.5
type GetVulnerabilities ¶ added in v1.0.0
type GetVulnerabilities interface {
GetID() string
}
type Manufacturer ¶ added in v0.1.0
func (Manufacturer) GetContacts ¶ added in v0.1.8
func (m Manufacturer) GetContacts() []Contact
func (Manufacturer) GetEmail ¶ added in v0.1.8
func (m Manufacturer) GetEmail() string
func (Manufacturer) GetName ¶ added in v0.1.8
func (m Manufacturer) GetName() string
func (Manufacturer) GetURL ¶ added in v0.1.8
func (m Manufacturer) GetURL() string
type PrimaryComp ¶ added in v0.2.0
type PrimaryComp struct {
Present bool
ID string
Dependecies int
HasDependency bool
Name string
Version string
AllDependencies []string
}
func (PrimaryComp) GetDependencies ¶ added in v0.2.2
func (pc PrimaryComp) GetDependencies() []string
func (PrimaryComp) GetID ¶ added in v0.2.0
func (pc PrimaryComp) GetID() string
func (PrimaryComp) GetName ¶ added in v0.2.2
func (pc PrimaryComp) GetName() string
func (PrimaryComp) GetTotalNoOfDependencies ¶ added in v0.2.0
func (pc PrimaryComp) GetTotalNoOfDependencies() int
func (PrimaryComp) GetVersion ¶ added in v1.0.7
func (pc PrimaryComp) GetVersion() string
func (PrimaryComp) HasDependencies ¶ added in v0.2.0
func (pc PrimaryComp) HasDependencies() bool
func (PrimaryComp) IsPresent ¶ added in v0.2.0
func (pc PrimaryComp) IsPresent() bool
type Signature ¶ added in v1.0.0
func (*Signature) GetPublicKey ¶ added in v1.0.0
func (*Signature) GetSigValue ¶ added in v1.0.0
type SpdxDoc ¶ added in v0.1.5
type SpdxDoc struct {
SpdxSpec *Specs
Comps []GetComponent
Auths []GetAuthor
SpdxTools []GetTool
Rels []GetRelation
PrimaryComponent PrimaryComp
Lifecycle string
Dependencies map[string][]string
Vuln []GetVulnerabilities
SignatureDetail GetSignature
// contains filtered or unexported fields
}
func (SpdxDoc) Components ¶ added in v0.1.5
func (s SpdxDoc) Components() []GetComponent
func (SpdxDoc) GetComposition ¶ added in v0.2.0
func (SpdxDoc) GetRelationships ¶ added in v0.2.0
func (SpdxDoc) Lifecycles ¶ added in v0.1.5
func (SpdxDoc) Manufacturer ¶ added in v0.1.5
func (s SpdxDoc) Manufacturer() GetManufacturer
func (SpdxDoc) PrimaryComp ¶ added in v0.2.0
func (s SpdxDoc) PrimaryComp() GetPrimaryComp
func (SpdxDoc) Relations ¶ added in v0.1.5
func (s SpdxDoc) Relations() []GetRelation
func (SpdxDoc) Signature ¶ added in v1.0.0
func (s SpdxDoc) Signature() GetSignature
func (SpdxDoc) Supplier ¶ added in v0.1.5
func (s SpdxDoc) Supplier() GetSupplier
func (SpdxDoc) Vulnerabilities ¶ added in v1.0.0
func (s SpdxDoc) Vulnerabilities() []GetVulnerabilities
type Spec ¶
type Spec interface {
GetVersion() string
FileFormat() string
Parsable() bool
GetName() string
GetSpecType() string
RequiredFields() bool
GetCreationTimestamp() string
GetLicenses() []licenses.License
GetNamespace() string
GetURI() string
GetOrganization() string
GetComment() string
GetSpdxID() string
GetExtDocRef() []string
}
type SpecFormat ¶ added in v0.1.8
type SpecFormat string
const ( SBOMSpecSPDX SpecFormat = "spdx" SBOMSpecCDX SpecFormat = "cyclonedx" SBOMSpecUnknown SpecFormat = "unknown" )
type Specs ¶ added in v0.1.5
type Specs struct {
Version string
Format string
SpecType string
Name string
Licenses []licenses.License
CreationTimestamp string
Namespace string
URI string
Organization string
Comment string
Spdxid string
ExternalDocReference []string
// contains filtered or unexported fields
}
func (Specs) FileFormat ¶ added in v0.1.5
func (Specs) GetComment ¶ added in v0.1.5
func (Specs) GetCreationTimestamp ¶ added in v0.1.5
func (Specs) GetExtDocRef ¶ added in v1.0.0
func (Specs) GetLicenses ¶ added in v0.1.5
func (Specs) GetNamespace ¶ added in v0.1.5
func (Specs) GetOrganization ¶ added in v0.1.5
func (Specs) GetSpecType ¶ added in v0.1.5
func (Specs) GetVersion ¶ added in v0.1.5
func (Specs) RequiredFields ¶ added in v0.1.5
type Supplier ¶ added in v0.1.0
func (Supplier) GetContacts ¶ added in v0.1.5
type Tool ¶
func (Tool) GetVersion ¶ added in v0.1.5
type Vulnerability ¶ added in v1.0.0
type Vulnerability struct {
ID string
}
func (Vulnerability) GetID ¶ added in v1.0.0
func (v Vulnerability) GetID() string
Source Files
¶
Click to show internal directories.
Click to hide internal directories.