indexer

package

v1.41.0 Latest Latest Go to latest Published: Oct 20, 2026 License: Apache-2.0 Imports: 25 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jfrog/jfrog-cli-security

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CreateTargetEmptySbom(target results.ScanTarget) *cyclonedx.BOM
func DownloadIndexerIfNeeded(xrayManager *xray.XrayServicesManager, xrayVersionStr string) (indexerPath string, err error)
func WithBypassArchiveLimits(bypass bool) bom.SbomGeneratorOption
func WithProjectKey(projectKey string) bom.SbomGeneratorOption
func WithServerDetails(serverDetails *config.ServerDetails) bom.SbomGeneratorOption
func WithXray(manager *xray.XrayServicesManager, xrayVersion string) bom.SbomGeneratorOption
type IndexerBomGenerator
- func NewIndexerBomGenerator() *IndexerBomGenerator

Constants ¶

View Source

const (
	XrayUrlEnvVariable  = "JFROG_XRAY_PLATFORM_URL"
	XrayUserEnvVariable = "JFROG_XRAY_USER"
	// #nosec G101 -- Not credentials.
	XrayPasswordEnvVariable = "JFROG_XRAY_PASSWORD"
	// #nosec G101 -- Not credentials.
	XrayTokenEnvVariable      = "JFROG_XRAY_TOKEN"
	XrayProjectKeyEnvVariable = "JFROG_XRAY_PROJECT_KEY"
)

Variables ¶

This section is empty.

Functions ¶

func CreateTargetEmptySbom ¶

func CreateTargetEmptySbom(target results.ScanTarget) *cyclonedx.BOM

func DownloadIndexerIfNeeded ¶

func DownloadIndexerIfNeeded(xrayManager *xray.XrayServicesManager, xrayVersionStr string) (indexerPath string, err error)

func WithBypassArchiveLimits ¶

func WithBypassArchiveLimits(bypass bool) bom.SbomGeneratorOption

func WithProjectKey ¶ added in v1.40.0

func WithProjectKey(projectKey string) bom.SbomGeneratorOption

func WithServerDetails ¶ added in v1.34.1

func WithServerDetails(serverDetails *config.ServerDetails) bom.SbomGeneratorOption

func WithXray ¶

func WithXray(manager *xray.XrayServicesManager, xrayVersion string) bom.SbomGeneratorOption

Types ¶

type IndexerBomGenerator ¶

type IndexerBomGenerator struct {
	// contains filtered or unexported fields
}

IndexerBomGenerator is a BomGenerator that uses the Xray Indexer to generate a CycloneDX SBOM. It indexes a file and converts the resulting component graph to a CycloneDX SBOM.

func NewIndexerBomGenerator ¶

func NewIndexerBomGenerator() *IndexerBomGenerator

func (*IndexerBomGenerator) CleanUp ¶

func (ibg *IndexerBomGenerator) CleanUp() error

func (*IndexerBomGenerator) GenerateSbom ¶

func (ibg *IndexerBomGenerator) GenerateSbom(target results.ScanTarget) (sbom *cyclonedx.BOM, err error)

func (*IndexerBomGenerator) IndexFile ¶

func (ibg *IndexerBomGenerator) IndexFile(filePath string) (*xrayClientUtils.BinaryGraphNode, error)

func (*IndexerBomGenerator) PrepareGenerator ¶

func (ibg *IndexerBomGenerator) PrepareGenerator() (err error)

func (*IndexerBomGenerator) WithOptions ¶

func (ibg *IndexerBomGenerator) WithOptions(options ...bom.SbomGeneratorOption) bom.SbomGenerator

Source Files ¶

View all Source files

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