jas

Documentation

Index

• Constants
• Variables
• func CheckForSecretValidation(xrayManager *xray.XrayServicesManager, xrayVersion string, ...) bool
• func CreateJFrogAppsConfig(workingDirs []string) (*jfrogappsconfig.JFrogAppsConfig, error)
• func CreateScannerTempDirectory(scanner *JasScanner, scanType string) (string, error)
• func CreateScannersConfigFile(fileName string, fileContent interface{}, scanType jasutils.JasScanType) error
• func DownloadAnalyzerManagerIfNeeded(threadId int) error
• func GetAnalyzerManagerDirAbsolutePath() (string, error)
• func GetAnalyzerManagerDownloadPath() (string, error)
• func GetAnalyzerManagerEnvVariables(serverDetails *config.ServerDetails) (envVars map[string]string, err error)
• func GetAnalyzerManagerExecutable() (analyzerManagerPath string, err error)
• func GetAnalyzerManagerExecutableName() string
• func GetAnalyzerManagerVersion() string
• func GetAnalyzerManagerXscEnvVars(msi string, validateSecrets bool, technologies ...techutils.Technology) map[string]string
• func GetExcludePatterns(module jfrogappsconfig.Module, scanner *jfrogappsconfig.Scanner, ...) []string
• func GetSourceRoots(module jfrogappsconfig.Module, scanner *jfrogappsconfig.Scanner) ([]string, error)
• func GetTestDataPath() string
• func IsEntitledForJas(xrayManager *xray.XrayServicesManager, xrayVersion string) (entitled bool, err error)
• func ParseAnalyzerManagerError(scanner jasutils.JasScanType, err error) (formatErr error)
• func ReadJasScanRunsFromFile(fileName, wd, informationUrlSuffix string, minSeverity severityutils.Severity) (sarifRuns []*sarif.Run, err error)
• func ShouldSkipScanner(module jfrogappsconfig.Module, scanType jasutils.JasScanType) bool
• type AnalyzerManager
  • func (am *AnalyzerManager) Exec(configFile, scanCommand, workingDir string, ...) (err error)
  • func (am *AnalyzerManager) ExecWithOutputFile(configFile, scanCommand, workingDir, outputFile string, ...) (err error)
• type JasScanner
  • func CreateJasScanner(jfrogAppsConfig *jfrogappsconfig.JFrogAppsConfig, ...) (scanner *JasScanner, err error)
  • func InitJasTest(t *testing.T, workingDirs ...string) (*JasScanner, func())
  • func (a *JasScanner) Run(scannerCmd ScannerCmd, module jfrogappsconfig.Module) (err error)
• type ScannerCmd

Constants

const (
	ApplicabilityFeatureId = "contextual_analysis"
	AnalyzerManagerZipName = "analyzerManager.zip"

	ErrFailedScannerRun = "failed to run %s scan. Exit code received: %s"

	JfPackageManagerEnvVariable = "AM_PACKAGE_MANAGER"
	JfLanguageEnvVariable       = "AM_LANGUAGE"
	// #nosec G101 -- Not credentials.
	JfSecretValidationEnvVariable = "JF_VALIDATE_SECRETS"
)

const (
	NoServerUrlError     = "" /* 191-byte string literal not displayed */
	NoServerDetailsError = "jfrog Server details are missing"
)

Variables

var FakeBasicXrayResults = []services.ScanResponse{
	{
		ScanId: "scanId_1",
		Vulnerabilities: []services.Vulnerability{
			{IssueId: "issueId_1", Technology: techutils.Pipenv.String(),
				Cves:       []services.Cve{{Id: "testCve1"}, {Id: "testCve2"}, {Id: "testCve3"}},
				Components: map[string]services.Component{"issueId_1_direct_dependency": {}, "issueId_3_direct_dependency": {}}},
		},
		Violations: []services.Violation{
			{IssueId: "issueId_2", Technology: techutils.Pipenv.String(),
				Cves:       []services.Cve{{Id: "testCve4"}, {Id: "testCve5"}},
				Components: map[string]services.Component{"issueId_2_direct_dependency": {}, "issueId_4_direct_dependency": {}}},
		},
	},
}

var FakeServerDetails = config.ServerDetails{
	Url:      "platformUrl",
	Password: "password",
	User:     "user",
}

Functions

func CheckForSecretValidation

func CheckForSecretValidation(xrayManager *xray.XrayServicesManager, xrayVersion string, validateSecrets bool) bool

func CreateJFrogAppsConfig

func CreateJFrogAppsConfig(workingDirs []string) (*jfrogappsconfig.JFrogAppsConfig, error)

func CreateScannerTempDirectory

func CreateScannerTempDirectory(scanner *JasScanner, scanType string) (string, error)

func CreateScannersConfigFile

func CreateScannersConfigFile(fileName string, fileContent interface{}, scanType jasutils.JasScanType) error

func DownloadAnalyzerManagerIfNeeded

func DownloadAnalyzerManagerIfNeeded(threadId int) error

Download the latest AnalyzerManager executable if not cached locally. By default, the zip is downloaded directly from jfrog releases.

func GetAnalyzerManagerDirAbsolutePath

func GetAnalyzerManagerDirAbsolutePath() (string, error)

func GetAnalyzerManagerDownloadPath

func GetAnalyzerManagerDownloadPath() (string, error)

func GetAnalyzerManagerEnvVariables

func GetAnalyzerManagerEnvVariables(serverDetails *config.ServerDetails) (envVars map[string]string, err error)

func GetAnalyzerManagerExecutable

func GetAnalyzerManagerExecutable() (analyzerManagerPath string, err error)

func GetAnalyzerManagerExecutableName

func GetAnalyzerManagerExecutableName() string

func GetAnalyzerManagerVersion

func GetAnalyzerManagerVersion() string

func GetAnalyzerManagerXscEnvVars

func GetAnalyzerManagerXscEnvVars(msi string, validateSecrets bool, technologies ...techutils.Technology) map[string]string

func GetExcludePatterns

func GetExcludePatterns(module jfrogappsconfig.Module, scanner *jfrogappsconfig.Scanner, exclusions ...string) []string

func GetSourceRoots

func GetSourceRoots(module jfrogappsconfig.Module, scanner *jfrogappsconfig.Scanner) ([]string, error)

func GetTestDataPath

func GetTestDataPath() string

func IsEntitledForJas

func IsEntitledForJas(xrayManager *xray.XrayServicesManager, xrayVersion string) (entitled bool, err error)

func ParseAnalyzerManagerError

func ParseAnalyzerManagerError(scanner jasutils.JasScanType, err error) (formatErr error)

func ReadJasScanRunsFromFile

func ReadJasScanRunsFromFile(fileName, wd, informationUrlSuffix string, minSeverity severityutils.Severity) (sarifRuns []*sarif.Run, err error)

func ShouldSkipScanner

func ShouldSkipScanner(module jfrogappsconfig.Module, scanType jasutils.JasScanType) bool

Types

type AnalyzerManager

type AnalyzerManager struct {
	AnalyzerManagerFullPath string
	MultiScanId             string
}

func (*AnalyzerManager) Exec

func (am *AnalyzerManager) Exec(configFile, scanCommand, workingDir string, serverDetails *config.ServerDetails, envVars map[string]string) (err error)

func (*AnalyzerManager) ExecWithOutputFile

func (am *AnalyzerManager) ExecWithOutputFile(configFile, scanCommand, workingDir, outputFile string, serverDetails *config.ServerDetails, envVars map[string]string) (err error)

type JasScanner

type JasScanner struct {
	TempDir               string
	AnalyzerManager       AnalyzerManager
	ServerDetails         *config.ServerDetails
	JFrogAppsConfig       *jfrogappsconfig.JFrogAppsConfig
	ScannerDirCleanupFunc func() error
	EnvVars               map[string]string
	Exclusions            []string
	MinSeverity           severityutils.Severity
}

func CreateJasScanner

func CreateJasScanner(jfrogAppsConfig *jfrogappsconfig.JFrogAppsConfig, serverDetails *config.ServerDetails, minSeverity severityutils.Severity, envVars map[string]string, exclusions ...string) (scanner *JasScanner, err error)

func InitJasTest

func InitJasTest(t *testing.T, workingDirs ...string) (*JasScanner, func())

func (*JasScanner) Run

func (a *JasScanner) Run(scannerCmd ScannerCmd, module jfrogappsconfig.Module) (err error)

type ScannerCmd

type ScannerCmd interface {
	Run(module jfrogappsconfig.Module) (err error)
}