Malicious code scanner

Malicious code scanner

Author: barv-jfrog

cli/docs/flags.go

@@ -25,6 +25,7 @@ const (
 	GitCountContributors = "count-contributors"
 	Enrich               = "sbom-enrich"
 	UploadCdx            = "upload-cdx"
+	MaliciousScan        = "malicious-scan"
 
 	// TODO: Deprecated commands (remove at next CLI major version)
 	AuditMvn    = "audit-maven"
@@ -175,6 +176,9 @@ var commandFlags = map[string][]string{
 	Enrich: {
 		Url, user, password, accessToken, ServerId, Threads, InsecureTls,
 	},
+	MaliciousScan: {
+		Url, user, password, accessToken, ServerId, Threads, InsecureTls, OutputFormat, MinSeverity, AnalyzerManagerCustomPath, WorkingDirs,
+	},
 	BuildScan: {
 		Url, user, password, accessToken, ServerId, scanProjectKey, BuildVuln, OutputFormat, Fail, ExtendedTable, Rescan, InsecureTls, TriggerScanRetries,
 	},

cli/docs/maliciousscan/help.go

@@ -0,0 +1,13 @@
+package maliciousscan
+
+import (
+	"github.com/jfrog/jfrog-cli-core/v2/plugins/components"
+)
+
+func GetDescription() string {
+	return "Scan malicious models (pickle files, etc.) located in the working directory with AnalyzerManager."
+}
+
+func GetArguments() []components.Argument {
+	return []components.Argument{}
+}

cli/scancommands.go

@@ -21,6 +21,7 @@ import (
 	flags "github.com/jfrog/jfrog-cli-security/cli/docs"
 	auditSpecificDocs "github.com/jfrog/jfrog-cli-security/cli/docs/auditspecific"
 	enrichDocs "github.com/jfrog/jfrog-cli-security/cli/docs/enrich"
+	maliciousScanDocs "github.com/jfrog/jfrog-cli-security/cli/docs/maliciousscan"
 	mcpDocs "github.com/jfrog/jfrog-cli-security/cli/docs/mcp"
 	auditDocs "github.com/jfrog/jfrog-cli-security/cli/docs/scan/audit"
 	buildScanDocs "github.com/jfrog/jfrog-cli-security/cli/docs/scan/buildscan"
@@ -40,6 +41,7 @@ import (
 
 	"github.com/jfrog/jfrog-cli-security/commands/audit"
 	"github.com/jfrog/jfrog-cli-security/commands/curation"
+	"github.com/jfrog/jfrog-cli-security/commands/maliciousscan"
 	"github.com/jfrog/jfrog-cli-security/commands/scan"
 	"github.com/jfrog/jfrog-cli-security/commands/upload"
 
@@ -72,6 +74,15 @@ func getAuditAndScansCommands() []components.Command {
 			Category:    securityCategory,
 			Action:      EnrichCmd,
 		},
+		{
+			Name:        "malicious-scan",
+			Aliases:     []string{"ms"},
+			Flags:       flags.GetCommandFlags(flags.MaliciousScan),
+			Description: maliciousScanDocs.GetDescription(),
+			Arguments:   maliciousScanDocs.GetArguments(),
+			Category:    securityCategory,
+			Action:      MaliciousScanCmd,
+		},
 		{
 			Name:        "build-scan",
 			Aliases:     []string{"bs"},
@@ -230,6 +241,42 @@ func EnrichCmd(c *components.Context) error {
 	return commandsCommon.Exec(EnrichCmd)
 }
 
+func MaliciousScanCmd(c *components.Context) error {
+	serverDetails, err := CreateServerDetailsFromFlags(c)
+	if err != nil {
+		return err
+	}
+	if err = validateConnectionInputs(serverDetails); err != nil {
+		return err
+	}
+	format, err := outputFormat.GetOutputFormat(c.GetStringFlagValue(flags.OutputFormat))
+	if err != nil {
+		return err
+	}
+	threads, err := pluginsCommon.GetThreadsCount(c)
+	if err != nil {
+		return err
+	}
+	minSeverity, err := getMinimumSeverity(c)
+	if err != nil {
+		return err
+	}
+	workingDirs := []string{}
+	if c.GetStringFlagValue(flags.WorkingDirs) != "" {
+		workingDirs = splitByCommaAndTrim(c.GetStringFlagValue(flags.WorkingDirs))
+	}
+	maliciousScanCmd := maliciousscan.NewMaliciousScanCommand().
+		SetServerDetails(serverDetails).
+		SetWorkingDirs(workingDirs).
+		SetThreads(threads).
+		SetOutputFormat(format).
+		SetMinSeverityFilter(minSeverity)
+	if c.IsFlagSet(flags.AnalyzerManagerCustomPath) {
+		maliciousScanCmd.SetCustomAnalyzerManagerPath(c.GetStringFlagValue(flags.AnalyzerManagerCustomPath))
+	}
+	return commandsCommon.Exec(maliciousScanCmd)
+}
+
 func ScanCmd(c *components.Context) error {
 	if len(c.Arguments) == 0 && !c.IsFlagSet(flags.SpecFlag) {
 		return pluginsCommon.PrintHelpAndReturnError("providing either a <source pattern> argument or the 'spec' option is mandatory", c)

commands/maliciousscan/maliciousscan.go

@@ -0,0 +1,282 @@
+package maliciousscan
+
+import (
+	"errors"
+	"fmt"
+	"os/exec"
+	"path/filepath"
+	"strings"
+
+	"github.com/jfrog/jfrog-cli-core/v2/common/format"
+	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
+	"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
+	"github.com/jfrog/jfrog-cli-security/jas"
+	"github.com/jfrog/jfrog-cli-security/jas/runner"
+	"github.com/jfrog/jfrog-cli-security/utils"
+	"github.com/jfrog/jfrog-cli-security/utils/results"
+	"github.com/jfrog/jfrog-cli-security/utils/results/output"
+	"github.com/jfrog/jfrog-cli-security/utils/severityutils"
+	"github.com/jfrog/jfrog-cli-security/utils/xray"
+	ioUtils "github.com/jfrog/jfrog-client-go/utils/io"
+	"github.com/jfrog/jfrog-client-go/utils/io/fileutils"
+	"github.com/jfrog/jfrog-client-go/utils/log"
+)
+
+type MaliciousScanCommand struct {
+	serverDetails             *config.ServerDetails
+	workingDirs               []string
+	threads                   int
+	outputFormat              format.OutputFormat
+	minSeverityFilter         severityutils.Severity
+	progress                  ioUtils.ProgressMgr
+	customAnalyzerManagerPath string
+}
+
+func (cmd *MaliciousScanCommand) SetProgress(progress ioUtils.ProgressMgr) {
+	cmd.progress = progress
+}
+
+func (cmd *MaliciousScanCommand) SetThreads(threads int) *MaliciousScanCommand {
+	cmd.threads = threads
+	return cmd
+}
+
+func (cmd *MaliciousScanCommand) SetServerDetails(server *config.ServerDetails) *MaliciousScanCommand {
+	cmd.serverDetails = server
+	return cmd
+}
+
+func (cmd *MaliciousScanCommand) SetWorkingDirs(workingDirs []string) *MaliciousScanCommand {
+	cmd.workingDirs = workingDirs
+	return cmd
+}
+
+func (cmd *MaliciousScanCommand) SetOutputFormat(format format.OutputFormat) *MaliciousScanCommand {
+	cmd.outputFormat = format
+	return cmd
+}
+
+func (cmd *MaliciousScanCommand) SetMinSeverityFilter(minSeverity severityutils.Severity) *MaliciousScanCommand {
+	cmd.minSeverityFilter = minSeverity
+	return cmd
+}
+
+func (cmd *MaliciousScanCommand) SetCustomAnalyzerManagerPath(path string) *MaliciousScanCommand {
+	cmd.customAnalyzerManagerPath = path
+	return cmd
+}
+
+func (cmd *MaliciousScanCommand) ServerDetails() (*config.ServerDetails, error) {
+	return cmd.serverDetails, nil
+}
+
+func (cmd *MaliciousScanCommand) CommandName() string {
+	return "malicious_scan"
+}
+
+func NewMaliciousScanCommand() *MaliciousScanCommand {
+	return &MaliciousScanCommand{}
+}
+
+func (cmd *MaliciousScanCommand) Run() (err error) {
+	defer func() {
+		if err != nil {
+			var e *exec.ExitError
+			if errors.As(err, &e) {
+				if e.ExitCode() != coreutils.ExitCodeVulnerableBuild.Code {
+					err = errors.New("Malicious scan command failed. " + err.Error())
+				}
+			}
+		}
+	}()
+
+	xrayManager, xrayVersion, err := xray.CreateXrayServiceManagerAndGetVersion(cmd.serverDetails)
+	if err != nil {
+		return err
+	}
+
+	entitledForJas, err := jas.IsEntitledForJas(xrayManager, xrayVersion)
+	if err != nil {
+		return err
+	}
+	if !entitledForJas {
+		return errors.New("JAS (Advanced Security) feature is not entitled")
+	}
+
+	log.Info("JFrog Xray version is:", xrayVersion)
+
+	if err = jas.DownloadAnalyzerManagerIfNeeded(0); err != nil {
+		return fmt.Errorf("failed to download Analyzer Manager: %w", err)
+	}
+
+	workingDirs, err := coreutils.GetFullPathsWorkingDirs(cmd.workingDirs)
+	if err != nil {
+		return err
+	}
+	logScanPaths(workingDirs)
+
+	cmdResults := results.NewCommandResults(utils.SourceCode)
+	cmdResults.SetXrayVersion(xrayVersion)
+	cmdResults.SetEntitledForJas(entitledForJas)
+	cmdResults.SetResultsContext(results.ResultContext{
+		IncludeVulnerabilities: true,
+	})
+
+	populateScanTargets(cmdResults, workingDirs)
+
+	scannerOptions := []jas.JasScannerOption{
+		jas.WithEnvVars(
+			false, // validateSecrets not relevant for malicious scan
+			jas.NotDiffScanEnvValue,
+			jas.GetAnalyzerManagerXscEnvVars(
+				"",  // msi
+				"",  // gitRepoUrl
+				"",  // projectKey
+				nil, // watches
+			),
+		),
+		jas.WithMinSeverity(cmd.minSeverityFilter),
+	}
+
+	scanner, err := jas.NewJasScanner(cmd.serverDetails, scannerOptions...)
+	if err != nil {
+		return fmt.Errorf("failed to create JAS scanner: %w", err)
+	}
+	if scanner == nil {
+		return errors.New("JAS scanner was not created")
+	}
+
+	if cmd.customAnalyzerManagerPath != "" {
+		scanner.AnalyzerManager.AnalyzerManagerFullPath = cmd.customAnalyzerManagerPath
+	} else {
+		if scanner.AnalyzerManager.AnalyzerManagerFullPath, err = jas.GetAnalyzerManagerExecutable(); err != nil {
+			return fmt.Errorf("failed to set analyzer manager executable path: %w", err)
+		}
+	}
+
+	log.Debug(fmt.Sprintf("Using analyzer manager executable at: %s", scanner.AnalyzerManager.AnalyzerManagerFullPath))
+
+	jasScanProducerConsumer := utils.NewSecurityParallelRunner(cmd.threads)
+
+	serverDetails, err := cmd.ServerDetails()
+	if err != nil {
+		return err
+	}
+
+	jasScanProducerConsumer.JasWg.Add(1)
+	createMaliciousScansTask := func(threadId int) (generalError error) {
+		defer func() {
+			jasScanProducerConsumer.JasWg.Done()
+		}()
+		for _, targetResult := range cmdResults.Targets {
+			if targetResult.AppsConfigModule == nil {
+				_ = targetResult.AddTargetError(fmt.Errorf("can't find module for path %s", targetResult.Target), false)
+				continue
+			}
+			appsConfigModule := *targetResult.AppsConfigModule
+			jasParams := runner.JasRunnerParams{
+				Runner:         &jasScanProducerConsumer,
+				ServerDetails:  serverDetails,
+				Scanner:        scanner,
+				Module:         appsConfigModule,
+				ScansToPerform: []utils.SubScanType{utils.MaliciousCodeScan},
+				ScanResults:    targetResult,
+				TargetCount:    len(cmdResults.Targets),
+			}
+
+			if generalError = runner.AddJasScannersTasks(jasParams); generalError != nil {
+				_ = targetResult.AddTargetError(fmt.Errorf("failed to add malicious scan task: %w", generalError), false)
+				generalError = nil
+			}
+		}
+		return
+	}
+
+	if _, addTaskErr := jasScanProducerConsumer.Runner.AddTaskWithError(createMaliciousScansTask, func(taskErr error) {
+		cmdResults.AddGeneralError(fmt.Errorf("failed while adding JAS scan tasks: %s", taskErr.Error()), false)
+	}); addTaskErr != nil {
+		return fmt.Errorf("failed to create JAS task: %w", addTaskErr)
+	}
+
+	jasScanProducerConsumer.Start()
+
+	if cmd.progress != nil {
+		if err = cmd.progress.Quit(); err != nil {
+			return err
+		}
+	}
+
+	if err = output.NewResultsWriter(cmdResults).
+		SetOutputFormat(cmd.outputFormat).
+		SetPlatformUrl(cmd.serverDetails.Url).
+		SetPrintExtendedTable(false).
+		SetIsMultipleRootProject(cmdResults.HasMultipleTargets()).
+		SetSubScansPerformed([]utils.SubScanType{utils.MaliciousCodeScan}).
+		PrintScanResults(); err != nil {
+		return errors.Join(err, cmdResults.GetErrors())
+	}
+
+	if err = cmdResults.GetErrors(); err != nil {
+		return err
+	}
+
+	log.Info("Malicious scan completed successfully.")
+	return nil
+}
+
+func logScanPaths(workingDirs []string) {
+	if len(workingDirs) == 0 {
+		return
+	}
+	if len(workingDirs) == 1 {
+		log.Info("Scanning path:", workingDirs[0])
+		return
+	}
+	log.Info("Scanning paths:", strings.Join(workingDirs, ", "))
+}
+
+func populateScanTargets(cmdResults *results.SecurityCommandResults, workingDirs []string) {
+	for _, requestedDirectory := range workingDirs {
+		if !fileutils.IsPathExists(requestedDirectory, false) {
+			log.Warn("The working directory", requestedDirectory, "doesn't exist. Skipping scan...")
+			continue
+		}
+		cmdResults.NewScanResults(results.ScanTarget{Target: requestedDirectory, Name: filepath.Base(requestedDirectory)})
+	}
+
+	if len(workingDirs) == 0 {
+		currentDir, err := coreutils.GetWorkingDirectory()
+		if err != nil {
+			cmdResults.AddGeneralError(fmt.Errorf("failed to get current working directory: %w", err), false)
+			return
+		}
+		cmdResults.NewScanResults(results.ScanTarget{Target: currentDir, Name: filepath.Base(currentDir)})
+	}
+
+	if len(cmdResults.Targets) == 0 {
+		log.Warn("No scan targets were detected. Proceeding with empty scan...")
+		return
+	}
+
+	jfrogAppsConfig, err := jas.CreateJFrogAppsConfig(cmdResults.GetTargetsPaths())
+	if err != nil {
+		cmdResults.AddGeneralError(fmt.Errorf("failed to create JFrogAppsConfig: %w", err), false)
+		return
+	}
+
+	for _, targetResult := range cmdResults.Targets {
+		targetResult.AppsConfigModule = jas.GetModule(targetResult.Target, jfrogAppsConfig)
+	}
+
+	logScanTargetsInfo(cmdResults)
+}
+
+func logScanTargetsInfo(cmdResults *results.SecurityCommandResults) {
+	if len(cmdResults.Targets) == 0 {
+		return
+	}
+	log.Info("Scanning", len(cmdResults.Targets), "target(s)...")
+	for _, targetResult := range cmdResults.Targets {
+		log.Info("Scanning target:", targetResult.Target)
+	}
+}