spdx

package

Go to main page

Versions in this module

v0

v0.6.0

Jan 15, 2024

v0.5.1

Mar 31, 2023

v0.5.0

Mar 31, 2023

Changes in this version

+ const CatPackageManager

type DocBuilderImplementation

+ CreateDocument func(*DocGenerateOptions, *SPDX) (*Document, error)

+ CreateSPDXClient func(*DocGenerateOptions, *DocBuilderOptions) (*SPDX, error)

+ ScanArchives func(*DocGenerateOptions, *SPDX, *Document) error

+ ScanDirectories func(*DocGenerateOptions, *SPDX, *Document) error

+ ScanFiles func(*DocGenerateOptions, *SPDX, *Document) error

+ ScanImageArchives func(*DocGenerateOptions, *SPDX, *Document) error

+ ScanImages func(*DocGenerateOptions, *SPDX, *Document) error

+ ValidateOptions func(*DocGenerateOptions) error

type DocGenerateOptions

+ LicenseListVersion string

type DrawingOptions

+ Purls bool

+ Version bool

type Options

+ LicenseListVersion string

v0.4.1

Nov 3, 2022

v0.4.0

Oct 20, 2022

Changes in this version

+ var ExternalRefCategories = map[string][]string

+ var PackagePurposes = []string

+ type ImageReferenceInfo struct

+ Arch string

+ Archive string

+ Digest string

+ Images []ImageReferenceInfo

+ MediaType string

+ OS string

+ Reference string

type Package

+ PrimaryPurpose string

type RelationshipType

+ const REQUIREMENT_DESCRIPTION_FOR

+ const SPECIFICATION_FOR

v0.3.0

Jul 6, 2022

Changes in this version

+ const FormatJSON

+ const FormatTagValue

+ const MessageHashMismatch

+ var SupportedHashAlgorithms = []string

+ func DetectSBOMEncoding(f *os.File) (format string, err error)

type DocGenerateOptions

+ Format string

type Document

+ func (d *Document) GetPackagesByPurl(purlSpec *purl.PackageURL, opts ...PurlSearchOption) []*Package

+ func (d *Document) ValidateFiles(filePaths []string) ([]ValidationResults, error)

type Entity

+ LicenseComments string

+ type Format string

type GoPackage

+ func (pkg *GoPackage) PackageURL() string

+ type NewDocBuilderOption func(*newDocBuilderSettings)

+ func WithFormat(format Format) NewDocBuilderOption

type Package

+ HomePage string

+ func (p *Package) ComputeLicenseList() error

+ func (p *Package) ComputeVerificationCode() error

+ func (p *Package) GetPackagesByPurl(purlSpec *purl.PackageURL, opts ...PurlSearchOption) []*Package

+ func (p *Package) Purl() *purl.PackageURL

+ func (p *Package) PurlMatches(spec *purl.PackageURL, opts ...PurlSearchOption) bool

+ type PurlSearchOption string

+ const OptionVersionPattern

+ type ValidationResults struct

+ FailedAlgorithms []string

+ FileName string

+ Message string

+ Success bool

v0.3.0-rc1

Apr 2, 2022

v0.3.0-rc.2

Apr 2, 2022

v0.2.2

Feb 2, 2022

Changes in this version

type Document

+ func (d *Document) GetElementByID(id string) Object

type Entity

+ func (e *Entity) GetElementByID(string) Object

+ func (e *Entity) SetSPDXID(id string)

type File

+ func (f *File) GetElementByID(id string) Object

type Object

+ GetElementByID func(string) Object

+ SetSPDXID func(string)

type Package

+ func (p *Package) GetElementByID(id string) Object

v0.2.1

Jan 29, 2022

Changes in this version

type DocGenerateOptions

+ ScanImages bool

type Options

+ ScanImages bool

v0.2.0

Jan 26, 2022

Changes in this version

type DocGenerateOptions

+ Archives []string

type Document

+ func (d *Document) WriteProvenanceStatement(opts *ProvenanceOptions, path string) error

type File

+ FileType []string

+ func (f *File) ReadSourceFile(path string) error

type ObjectOptions

+ Prefix string

type Options

+ AddTarFiles bool

type Package

+ func (p *Package) ReadSourceFile(path string) error

type SPDX

+ func (spdx *SPDX) PackageFromArchive(archivePath string) (imagePackage *Package, err error)

type TarballOptions

+ AddFiles bool

v0.1.0

Nov 22, 2021

Changes in this version

+ const GoModFileName

+ const GoSumFileName

+ const NOASSERTION

+ const NONE

+ var DefaultProvenanceOptions = &ProvenanceOptions

+ func Banner() string

+ func PullImageToArchive(referenceString, path string) error

+ type ArchiveManifest struct

+ ConfigFilename string

+ LayerFiles []string

+ RepoTags []string

+ type ContainerLayerAnalyzer interface

+ CanHandle func(layerPath string) (bool, error)

+ ReadPackageData func(layerPath string, pkg *Package) error

+ type ContainerLayerAnalyzerOptions struct

+ LicenseCacheDir string

+ type DocBuilder struct

+ func NewDocBuilder() *DocBuilder

+ func (db *DocBuilder) Generate(genopts *DocGenerateOptions) (*Document, error)

+ type DocBuilderImplementation interface

+ GenerateDoc func(*DocBuilderOptions, *DocGenerateOptions) (*Document, error)

+ ReadYamlConfiguration func(string, *DocGenerateOptions) error

+ WriteDoc func(*Document, string) error

+ type DocBuilderOptions struct

+ WorkDir string

+ type DocGenerateOptions struct

+ AnalyseLayers bool

+ ConfigFile string

+ CreatorPerson string

+ Directories []string

+ ExternalDocumentRef []ExternalDocumentRef

+ Files []string

+ IgnorePatterns []string

+ Images []string

+ License string

+ Name string

+ Namespace string

+ NoGitignore bool

+ OnlyDirectDeps bool

+ OutputFile string

+ ProcessGoModules bool

+ ScanLicenses bool

+ Tarballs []string

+ func (o *DocGenerateOptions) Validate() error

+ type Document struct

+ Created time.Time

+ Creator struct{ ... }

+ DataLicense string

+ ExternalDocRefs []ExternalDocumentRef

+ Files map[string]*File

+ ID string

+ LicenseListVersion string

+ Name string

+ Namespace string

+ Packages map[string]*Package

+ Version string

+ func NewDocument() *Document

+ func OpenDoc(path string) (*Document, error)

+ func (d *Document) AddFile(file *File) error

+ func (d *Document) AddPackage(pkg *Package) error

+ func (d *Document) Outline(o *DrawingOptions) (outline string, err error)

+ func (d *Document) Render() (doc string, err error)

+ func (d *Document) ToProvenanceStatement(opts *ProvenanceOptions) *provenance.Statement

+ func (d *Document) Write(path string) error

+ type DrawingOptions struct

+ ASCIIOnly bool

+ DisableTerm bool

+ Height int

+ LastItem bool

+ OnlyIDs bool

+ Recursion int

+ SkipName bool

+ Width int

+ type Entity struct

+ Checksum map[string]string

+ CopyrightText string

+ DownloadLocation string

+ FileName string

+ ID string

+ LicenseConcluded string

+ Name string

+ Opts *ObjectOptions

+ Relationships []*Relationship

+ SourceFile string

+ func (e *Entity) AddRelationship(rel *Relationship)

+ func (e *Entity) BuildID(seeds ...string)

+ func (e *Entity) GetRelationships() *[]*Relationship

+ func (e *Entity) Options() *ObjectOptions

+ func (e *Entity) ReadChecksums(filePath string) error

+ func (e *Entity) ReadSourceFile(path string) error

+ func (e *Entity) Render() (string, error)

+ func (e *Entity) SPDXID() string

+ func (e *Entity) ToProvenanceSubject() *intoto.Subject

+ type ExternalDocumentRef struct

+ Checksums map[string]string

+ ID string

+ URI string

+ func (ed *ExternalDocumentRef) ReadSourceFile(path string) error

+ func (ed *ExternalDocumentRef) String() string

+ type ExternalRef struct

+ Category string

+ Locator string

+ Type string

+ type File struct

+ LicenseInfoInFile string

+ func NewFile() (f *File)

+ func (f *File) BuildID(seeds ...string)

+ func (f *File) Draw(builder *strings.Builder, o *DrawingOptions, depth int, ...)

+ func (f *File) Render() (docFragment string, err error)

+ func (f *File) SetEntity(e *Entity)

+ type GoModDefaultImpl struct

+ func (di *GoModDefaultImpl) BuildPackageList(gomod *modfile.File) ([]*GoPackage, error)

+ func (di *GoModDefaultImpl) DownloadPackage(pkg *GoPackage, opts *GoModuleOptions, force bool) error

+ func (di *GoModDefaultImpl) LicenseReader() (*license.Reader, error)

+ func (di *GoModDefaultImpl) OpenModule(opts *GoModuleOptions) (*modfile.File, error)

+ func (di *GoModDefaultImpl) RemoveDownloads(packageList []*GoPackage) error

+ func (di *GoModDefaultImpl) ScanPackageLicense(pkg *GoPackage, reader *license.Reader, opts *GoModuleOptions) error

+ type GoModImplementation interface

+ BuildPackageList func(*modfile.File) ([]*GoPackage, error)

+ DownloadPackage func(*GoPackage, *GoModuleOptions, bool) error

+ LicenseReader func() (*license.Reader, error)

+ OpenModule func(*GoModuleOptions) (*modfile.File, error)

+ RemoveDownloads func([]*GoPackage) error

+ ScanPackageLicense func(*GoPackage, *license.Reader, *GoModuleOptions) error

+ type GoModule struct

+ GoMod *modfile.File

+ Packages []*GoPackage

+ func NewGoModule() *GoModule

+ func NewGoModuleFromPath(path string) (*GoModule, error)

+ func (mod *GoModule) BuildFullPackageList(g *modfile.File) (packageList []*GoPackage, err error)

+ func (mod *GoModule) DownloadPackages() error

+ func (mod *GoModule) Open() error

+ func (mod *GoModule) Options() *GoModuleOptions

+ func (mod *GoModule) RemoveDownloads() error

+ func (mod *GoModule) ScanLicenses() error

+ type GoModuleOptions struct

+ OnlyDirectDeps bool

+ Path string

+ ScanLicenses bool

+ type GoPackage struct

+ CopyrightText string

+ ImportPath string

+ LicenseID string

+ LocalDir string

+ LocalInstall string

+ Revision string

+ TmpDir bool

+ func (pkg *GoPackage) ToSPDXPackage() (*Package, error)

+ type ImageAnalyzer struct

+ Analyzers map[string]ContainerLayerAnalyzer

+ func NewImageAnalyzer() *ImageAnalyzer

+ func (ia *ImageAnalyzer) AnalyzeLayer(layerPath string, pkg *Package) error

+ type Object interface

+ AddRelationship func(*Relationship)

+ BuildID func(seeds ...string)

+ GetRelationships func() *[]*Relationship

+ ReadSourceFile func(string) error

+ Render func() (string, error)

+ SPDXID func() string

+ SetEntity func(*Entity)

+ ToProvenanceSubject func() *intoto.Subject

+ type ObjectOptions struct

+ WorkDir string

+ type Options struct

+ AnalyzeLayers bool

+ IgnorePatterns []string

+ LicenseCacheDir string

+ LicenseData string

+ NoGitignore bool

+ OnlyDirectDeps bool

+ ProcessGoModules bool

+ ScanLicenses bool

+ type Package struct

+ Comment string

+ ExternalRefs []ExternalRef

+ FilesAnalyzed bool

+ LicenseComments string

+ LicenseDeclared string

+ LicenseInfoFromFiles []string

+ Originator struct{ ... }

+ Supplier struct{ ... }

+ VerificationCode string

+ Version string

+ func NewPackage() (p *Package)

+ func (p *Package) AddDependency(pkg *Package) error

+ func (p *Package) AddFile(file *File) error

+ func (p *Package) AddPackage(pkg *Package) error

+ func (p *Package) BuildID(seeds ...string)

+ func (p *Package) CheckRelationships() error

+ func (p *Package) Draw(builder *strings.Builder, o *DrawingOptions, depth int, ...)

+ func (p *Package) Files() []*File

+ func (p *Package) Render() (docFragment string, err error)

+ func (p *Package) SetEntity(e *Entity)

+ type ProvenanceOptions struct

+ Relationships map[string][]RelationshipType

+ type Relationship struct

+ Comment string

+ FullRender bool

+ Peer Object

+ PeerExtReference string

+ PeerReference string

+ Type RelationshipType

+ func (ro *Relationship) Render(hostObject Object) (string, error)

+ type RelationshipType string

+ const AMENDS

+ const ANCESTOR_OF

+ const BUILD_DEPENDENCY_OF

+ const BUILD_TOOL_OF

+ const CONTAINED_BY

+ const CONTAINS

+ const COPY_OF

+ const DATA_FILE_OF

+ const DEPENDENCY_MANIFEST_OF

+ const DEPENDENCY_OF

+ const DEPENDS_ON

+ const DESCENDANT_OF

+ const DESCRIBED_BY

+ const DESCRIBES

+ const DEV_DEPENDENCY_OF

+ const DEV_TOOL_OF

+ const DISTRIBUTION_ARTIFACT

+ const DOCUMENTATION_OF

+ const DYNAMIC_LINK

+ const EXAMPLE_OF

+ const EXPANDED_FROM_ARCHIVE

+ const FILE_ADDED

+ const FILE_DELETED

+ const FILE_MODIFIED

+ const GENERATED_FROM

+ const GENERATES

+ const HAS_PREREQUISITE

+ const METAFILE_OF

+ const OPTIONAL_COMPONENT_OF

+ const OPTIONAL_DEPENDENCY_OF

+ const OTHER

+ const PACKAGE_OF

+ const PATCH_APPLIED

+ const PATCH_FOR

+ const PREREQUISITE_FOR

+ const PROVIDED_DEPENDENCY_OF

+ const RUNTIME_DEPENDENCY_OF

+ const STATIC_LINK

+ const TEST_CASE_OF

+ const TEST_DEPENDENCY_OF

+ const TEST_OF

+ const TEST_TOOL_OF

+ const VARIANT_OF

+ type SPDX struct

+ func NewSPDX() *SPDX

+ func (spdx *SPDX) AnalyzeImageLayer(layerPath string, pkg *Package) error

+ func (spdx *SPDX) ExtractTarballTmp(tarPath string) (tmpDir string, err error)

+ func (spdx *SPDX) FileFromPath(filePath string) (*File, error)

+ func (spdx *SPDX) ImageRefToPackage(reference string) (pkg *Package, err error)

+ func (spdx *SPDX) Options() *Options

+ func (spdx *SPDX) PackageFromDirectory(dirPath string) (pkg *Package, err error)

+ func (spdx *SPDX) PackageFromImageTarball(tarPath string) (imagePackage *Package, err error)

+ func (spdx *SPDX) PullImagesToArchive(reference, path string) ([]struct{ ... }, error)

+ func (spdx *SPDX) SetImplementation(impl spdxImplementation)

+ type TarballOptions struct

+ ExtractDir string

+ type YamlBOMConfiguration struct

+ Artifacts []*YamlBuildArtifact

+ Creator struct{ ... }

+ ExternalDocRefs []ExternalDocumentRef

+ License string

+ Name string

+ Namespace string

+ type YamlBuildArtifact struct

+ GoModules *bool

+ License string

+ Source string

+ Type string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL