Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,14 @@ require (
github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
github.com/xrash/smetrics v0.0.0-20250705151800-55b8f293f342 // indirect
go.yaml.in/yaml/v3 v3.0.4 // indirect
golang.org/x/crypto v0.49.0 // indirect
golang.org/x/crypto v0.50.0 // indirect
golang.org/x/mod v0.34.0 // indirect
golang.org/x/net v0.52.0 // indirect
golang.org/x/net v0.53.0 // indirect
golang.org/x/oauth2 v0.36.0 // indirect
golang.org/x/sync v0.20.0 // indirect
golang.org/x/sys v0.42.0 // indirect
golang.org/x/term v0.41.0 // indirect
golang.org/x/text v0.35.0 // indirect
golang.org/x/sys v0.43.0 // indirect
golang.org/x/term v0.42.0 // indirect
golang.org/x/text v0.36.0 // indirect
golang.org/x/time v0.15.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20260319201613-d00831a3d3e7 // indirect
google.golang.org/grpc v1.79.3 // indirect
Expand Down
10 changes: 10 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,8 @@ golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDf
golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
golang.org/x/crypto v0.49.0 h1:+Ng2ULVvLHnJ/ZFEq4KdcDd/cfjrrjjNSXNzxg0Y4U4=
golang.org/x/crypto v0.49.0/go.mod h1:ErX4dUh2UM+CFYiXZRTcMpEcN8b/1gxEuv3nODoYtCA=
golang.org/x/crypto v0.50.0 h1:zO47/JPrL6vsNkINmLoo/PH1gcxpls50DNogFvB5ZGI=
golang.org/x/crypto v0.50.0/go.mod h1:3muZ7vA7PBCE6xgPX7nkzzjiUq87kRItoJQM1Yo8S+Q=
golang.org/x/exp v0.0.0-20260312153236-7ab1446f8b90 h1:jiDhWWeC7jfWqR9c/uplMOqJ0sbNlNWv0UkzE0vX1MA=
golang.org/x/exp v0.0.0-20260312153236-7ab1446f8b90/go.mod h1:xE1HEv6b+1SCZ5/uscMRjUBKtIxworgEcEi+/n9NQDQ=
golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
Expand All @@ -353,6 +355,8 @@ golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
golang.org/x/net v0.52.0 h1:He/TN1l0e4mmR3QqHMT2Xab3Aj3L9qjbhRm78/6jrW0=
golang.org/x/net v0.52.0/go.mod h1:R1MAz7uMZxVMualyPXb+VaqGSa3LIaUqk0eEt3w36Sw=
golang.org/x/net v0.53.0 h1:d+qAbo5L0orcWAr0a9JweQpjXF19LMXJE8Ey7hwOdUA=
golang.org/x/net v0.53.0/go.mod h1:JvMuJH7rrdiCfbeHoo3fCQU24Lf5JJwT9W3sJFulfgs=
golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw=
golang.org/x/oauth2 v0.36.0 h1:peZ/1z27fi9hUOFCAZaHyrpWG5lwe0RJEEEeH0ThlIs=
golang.org/x/oauth2 v0.36.0/go.mod h1:YDBUJMTkDnJS+A4BP4eZBjCqtokkg1hODuPjwiGPO7Q=
Expand Down Expand Up @@ -396,6 +400,8 @@ golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
golang.org/x/sys v0.42.0 h1:omrd2nAlyT5ESRdCLYdm3+fMfNFE/+Rf4bDIQImRJeo=
golang.org/x/sys v0.42.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
golang.org/x/sys v0.43.0 h1:Rlag2XtaFTxp19wS8MXlJwTvoh8ArU6ezoyFsMyCTNI=
golang.org/x/sys v0.43.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
Expand All @@ -404,6 +410,8 @@ golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk=
golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58=
golang.org/x/term v0.41.0 h1:QCgPso/Q3RTJx2Th4bDLqML4W6iJiaXFq2/ftQF13YU=
golang.org/x/term v0.41.0/go.mod h1:3pfBgksrReYfZ5lvYM0kSO0LIkAl4Yl2bXOkKP7Ec2A=
golang.org/x/term v0.42.0 h1:UiKe+zDFmJobeJ5ggPwOshJIVt6/Ft0rcfrXZDLWAWY=
golang.org/x/term v0.42.0/go.mod h1:Dq/D+snpsbazcBG5+F9Q1n2rXV8Ma+71xEjTRufARgY=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
Expand All @@ -413,6 +421,8 @@ golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/text v0.35.0 h1:JOVx6vVDFokkpaq1AEptVzLTpDe9KGpj5tR4/X+ybL8=
golang.org/x/text v0.35.0/go.mod h1:khi/HExzZJ2pGnjenulevKNX1W67CUy0AsXcNubPGCA=
golang.org/x/text v0.36.0 h1:JfKh3XmcRPqZPKevfXVpI1wXPTqbkE5f7JA92a55Yxg=
golang.org/x/text v0.36.0/go.mod h1:NIdBknypM8iqVmPiuco0Dh6P5Jcdk8lJL0CUebqK164=
golang.org/x/time v0.15.0 h1:bbrp8t3bGUeFOx08pvsMYRTCVSMk89u4tKbNOZbp88U=
golang.org/x/time v0.15.0/go.mod h1:Y4YMaQmXwGQZoFaVFk4YpCt4FLQMYKZe9oeV/f4MSno=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
Expand Down
181 changes: 164 additions & 17 deletions packageupdaters/commonpackageupdater.go
Original file line number Diff line number Diff line change
@@ -1,21 +1,44 @@
package packageupdaters

import (
"errors"
"fmt"
"io/fs"
"os"
"os/exec"
"path/filepath"
"regexp"
"strings"
"time"

"github.com/jfrog/gofrog/datastructures"
"github.com/jfrog/jfrog-cli-security/utils/techutils"
"github.com/jfrog/jfrog-client-go/utils/log"
"github.com/tidwall/gjson"
"github.com/tidwall/sjson"
"golang.org/x/exp/slices"

"github.com/jfrog/frogbot/v2/utils"
)

// Node
const (
nodePackageJSONFileName = "package.json"
nodeModulesDirName = "node_modules"
nodeDependenciesSection = "dependencies"
nodeDevDependenciesSection = "devDependencies"
nodeOptionalDependenciesSection = "optionalDependencies"
nodeOverridesSection = "overrides"
nodePackageManagerInstallTimeout = 15 * time.Minute
)

var nodePackageManifestSections = []string{
nodeDependenciesSection,
nodeDevDependenciesSection,
nodeOptionalDependenciesSection,
nodeOverridesSection,
}

// PackageUpdater interface to hold operations on packages
type PackageUpdater interface {
UpdateDependency(details *utils.VulnerabilityDetails) error
Expand Down Expand Up @@ -54,6 +77,124 @@ func GetCompatiblePackageUpdater(vulnDetails *utils.VulnerabilityDetails, detail
// TODO can be deleted if not needed after refactoring all package updaters
type CommonPackageUpdater struct{}

// evidencePathLooksLikeNpmPackageCoordinate detects scanner evidence paths like "lodash@4.17.19/package.json" (not real paths). Pnpm filters these; npm does not.
func evidencePathLooksLikeNpmPackageCoordinate(evidenceFile string) bool {
dir := filepath.Dir(evidenceFile)
if dir == "." || dir == "" {
return false
}
for _, part := range strings.Split(filepath.ToSlash(dir), "/") {
if part == "" || part == "." {
continue
}
if strings.Contains(part, "@") && !strings.HasPrefix(part, "@") {
return true
}
}
return false
}

func (cph *CommonPackageUpdater) CollectVulnerabilityDescriptorPaths(vulnDetails *utils.VulnerabilityDetails, namesFilters []string, ignoreFilters []string) []string {
pathsSet := datastructures.MakeSet[string]()
for _, component := range vulnDetails.Components {
for _, evidence := range component.Evidences {
if evidence.File == "" || techutils.IsTechnologyDescriptor(evidence.File) == techutils.NoTech || slices.ContainsFunc(ignoreFilters, func(pattern string) bool { return strings.Contains(evidence.File, pattern) }) {
continue
}
if len(namesFilters) == 0 || slices.Contains(namesFilters, filepath.Base(evidence.File)) {
pathsSet.Add(evidence.File)
}
}
}
return pathsSet.ToSlice()
}

// BuildPackageDependencyLineRegex builds a regexp for matching a dependency line in a manifest.
func (cph *CommonPackageUpdater) BuildPackageDependencyLineRegex(impactedName, impactedVersion, dependencyLineFormat string) *regexp.Regexp {
regexpFitImpactedName := strings.ToLower(regexp.QuoteMeta(impactedName))
regexpFitImpactedVersion := strings.ToLower(regexp.QuoteMeta(impactedVersion))
regexpCompleteFormat := fmt.Sprintf(strings.ToLower(dependencyLineFormat), regexpFitImpactedName, regexpFitImpactedVersion)
return regexp.MustCompile(regexpCompleteFormat)
}

func escapeJsonPathKey(key string) string {
r := strings.NewReplacer(".", "\\.", "*", "\\*", "?", "\\?")
return r.Replace(key)
}

// GetFixedPackageJSONManifest returns manifest bytes with packageName set to newVersion in allowed sections.
func (cph *CommonPackageUpdater) GetFixedPackageJSONManifest(content []byte, packageName, newVersion, descriptorPath string) ([]byte, error) {
updated := false
escapedName := escapeJsonPathKey(packageName)

for _, section := range nodePackageManifestSections {
path := section + "." + escapedName
if gjson.GetBytes(content, path).Exists() {
var err error
content, err = sjson.SetBytes(content, path, newVersion)
if err != nil {
return nil, fmt.Errorf("failed to set version for '%s' in section '%s': %w", packageName, section, err)
}
updated = true
}
}

if !updated {
return nil, fmt.Errorf("package '%s' not found in allowed sections [%s] in '%s'", packageName, strings.Join(nodePackageManifestSections, ", "), descriptorPath)
}
return content, nil
}

// UpdatePackageJSONDescriptor writes the fixed version for packageName to descriptorPath and returns original file bytes for rollback.
func (cph *CommonPackageUpdater) UpdatePackageJSONDescriptor(descriptorPath, packageName, newVersion string) ([]byte, error) {
//#nosec G304 -- descriptorPath comes from vulnerability evidence in the scanned repository.
descriptorContent, err := os.ReadFile(descriptorPath)
if err != nil {
return nil, fmt.Errorf("failed to read file '%s': %w", descriptorPath, err)
}

backupContent := make([]byte, len(descriptorContent))
copy(backupContent, descriptorContent)

updatedContent, err := cph.GetFixedPackageJSONManifest(descriptorContent, packageName, newVersion, descriptorPath)
if err != nil {
return nil, fmt.Errorf("failed to update version in descriptor: %w", err)
}

//#nosec G306 G703 -- 0644 for checked-out source; path same trusted source as ReadFile above.
if err = os.WriteFile(descriptorPath, updatedContent, 0644); err != nil {
return nil, fmt.Errorf("failed to write updated descriptor '%s': %w", descriptorPath, err)
}
return backupContent, nil
}

func (cph *CommonPackageUpdater) withDescriptorWorkingDir(descriptorPath, originalWd string, fn func() error) (err error) {
descriptorDir := filepath.Dir(descriptorPath)
if err = os.Chdir(descriptorDir); err != nil {
return fmt.Errorf("failed to change directory to '%s': %w", descriptorDir, err)
}
defer func() {
if chErr := os.Chdir(originalWd); chErr != nil {
err = errors.Join(err, fmt.Errorf("failed to return to original directory: %w", chErr))
}
}()
return fn()
}

func (cph *CommonPackageUpdater) buildEnvWithOverrides(overrides map[string]string) []string {
env := make([]string, 0, len(os.Environ())+len(overrides))
for _, e := range os.Environ() {
key := strings.SplitN(e, "=", 2)[0]
if _, shouldOverride := overrides[key]; !shouldOverride {
env = append(env, e)
}
}
for key, value := range overrides {
env = append(env, fmt.Sprintf("%s=%s", key, value))
}
return env
}

// UpdateDependency updates the impacted package to the fixed version
func (cph *CommonPackageUpdater) UpdateDependency(vulnDetails *utils.VulnerabilityDetails, installationCommand string, extraArgs ...string) (err error) {
// Lower the package name to avoid duplicates
Expand All @@ -70,13 +211,31 @@ func runPackageMangerCommand(commandName string, techName string, commandArgs []
fullCommand := commandName + " " + strings.Join(commandArgs, " ")
log.Debug(fmt.Sprintf("Running '%s'", fullCommand))
//#nosec G204 -- False positive - the subprocess only runs after the user's approval.
output, err := exec.Command(commandName, commandArgs...).CombinedOutput()
cmd := exec.Command(commandName, commandArgs...)
if commandName == "pnpm" {
cmd.Env = envWithCorepackIntegrityWorkaround(os.Environ())
}
output, err := cmd.CombinedOutput()
if err != nil {
return fmt.Errorf("failed to update %s dependency: '%s' command failed: %s\n%s", techName, fullCommand, err.Error(), output)
}
return nil
}

// envWithCorepackIntegrityWorkaround sets COREPACK_INTEGRITY_KEYS=0 for older Node/Corepack (e.g. corepack#612).
// Also applied after buildEnvWithOverrides for pnpm lockfile regeneration so Corepack-invoked pnpm matches runPackageMangerCommand behavior.
func envWithCorepackIntegrityWorkaround(base []string) []string {
const key = "COREPACK_INTEGRITY_KEYS"
prefix := key + "="
out := make([]string, 0, len(base)+1)
for _, e := range base {
if !strings.HasPrefix(e, prefix) {
out = append(out, e)
}
}
return append(out, prefix+"0")
}

// Returns the updated package and version as it should be run in the update command:
// If the package manager expects a single string (example: <packName>@<version>) it returns []string{<packName>@<version>}
// If the command args suppose to be seperated by spaces (example: <packName> -v <version>) it returns []string{<packName>, "-v", <version>}
Expand Down Expand Up @@ -129,23 +288,11 @@ func (cph *CommonPackageUpdater) GetAllDescriptorFilesFullPaths(descriptorFilesS
}

func BuildPackageWithVersionRegex(impactedName, impactedVersion, dependencyLineFormat string) *regexp.Regexp {
regexpFitImpactedName := strings.ToLower(regexp.QuoteMeta(impactedName))
regexpFitImpactedVersion := strings.ToLower(regexp.QuoteMeta(impactedVersion))
regexpCompleteFormat := fmt.Sprintf(strings.ToLower(dependencyLineFormat), regexpFitImpactedName, regexpFitImpactedVersion)
return regexp.MustCompile(regexpCompleteFormat)
var c CommonPackageUpdater
return c.BuildPackageDependencyLineRegex(impactedName, impactedVersion, dependencyLineFormat)
}

func GetVulnerabilityLocations(vulnDetails *utils.VulnerabilityDetails, namesFilters []string, ignoreFilters []string) []string {
pathsSet := datastructures.MakeSet[string]()
for _, component := range vulnDetails.Components {
for _, evidence := range component.Evidences {
if evidence.File == "" || techutils.IsTechnologyDescriptor(evidence.File) == techutils.NoTech || slices.ContainsFunc(ignoreFilters, func(pattern string) bool { return strings.Contains(evidence.File, pattern) }) {
continue
}
if len(namesFilters) == 0 || slices.Contains(namesFilters, filepath.Base(evidence.File)) {
pathsSet.Add(evidence.File)
}
}
}
return pathsSet.ToSlice()
var c CommonPackageUpdater
return c.CollectVulnerabilityDescriptorPaths(vulnDetails, namesFilters, ignoreFilters)
}
66 changes: 21 additions & 45 deletions packageupdaters/commonpackageupdater_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -648,51 +648,6 @@ func TestGetAllDescriptorFilesFullPaths(t *testing.T) {
}
}

func TestPnpmFixVulnerabilityIfExists(t *testing.T) {
testRootDir, err := os.Getwd()
assert.NoError(t, err)

tmpDir, err := os.MkdirTemp("", "")
defer func() {
assert.NoError(t, fileutils.RemoveTempDir(tmpDir))
}()
assert.NoError(t, err)
assert.NoError(t, biutils.CopyDir(filepath.Join("..", "testdata", "projects", "npm"), tmpDir, true, nil))
assert.NoError(t, os.Chdir(tmpDir))
defer func() {
assert.NoError(t, os.Chdir(testRootDir))
}()

vulnerabilityDetails := &utils.VulnerabilityDetails{
SuggestedFixedVersion: "1.2.6",
IsDirectDependency: true,
VulnerabilityOrViolationRow: formats.VulnerabilityOrViolationRow{Technology: techutils.Pnpm, ImpactedDependencyDetails: formats.ImpactedDependencyDetails{ImpactedDependencyName: "minimist", ImpactedDependencyVersion: "1.2.5"}},
}
pnpm := &PnpmPackageUpdater{}

descriptorFiles, err := pnpm.GetAllDescriptorFilesFullPaths([]string{pnpmDescriptorFileSuffix})
assert.NoError(t, err)
descriptorFileToTest := descriptorFiles[0]

vulnRegexpCompiler := BuildPackageWithVersionRegex(vulnerabilityDetails.ImpactedDependencyName, vulnerabilityDetails.ImpactedDependencyVersion, pnpmDependencyRegexpPattern)
var isFileChanged bool
isFileChanged, err = pnpm.fixVulnerabilityIfExists(vulnerabilityDetails, descriptorFileToTest, tmpDir, vulnRegexpCompiler)
assert.NoError(t, err)
assert.True(t, isFileChanged)

var fixedFileContent []byte
fixedFileContent, err = os.ReadFile(descriptorFileToTest)
fixedFileContentString := string(fixedFileContent)

assert.NoError(t, err)
assert.NotContains(t, fixedFileContentString, "\"minimist\": \"1.2.5\"")
assert.Contains(t, fixedFileContentString, "\"minimist\": \"1.2.6\"")

nodeModulesExist, err := fileutils.IsDirExists(filepath.Join(tmpDir, "node_modules"), false)
assert.NoError(t, err)
assert.False(t, nodeModulesExist)
}

func TestGetVulnerabilityLocations(t *testing.T) {
testcases := []struct {
name string
Expand Down Expand Up @@ -969,6 +924,27 @@ func TestGetVulnerabilityLocations(t *testing.T) {
}
}

func TestEnvWithCorepackIntegrityWorkaround(t *testing.T) {
t.Parallel()
base := []string{"FOO=1", "COREPACK_INTEGRITY_KEYS=old-value", "BAR=2"}
out := envWithCorepackIntegrityWorkaround(base)
var foo, bar, corepack int
for _, e := range out {
switch {
case e == "FOO=1":
foo++
case e == "BAR=2":
bar++
case strings.HasPrefix(e, "COREPACK_INTEGRITY_KEYS="):
corepack++
assert.Equal(t, "COREPACK_INTEGRITY_KEYS=0", e)
}
}
assert.Equal(t, 1, foo, "FOO should appear once")
assert.Equal(t, 1, bar, "BAR should appear once")
assert.Equal(t, 1, corepack, "COREPACK_INTEGRITY_KEYS should appear exactly once with value 0")
}

func TestGetVulnerabilityRegexCompiler(t *testing.T) {
// Sample format patterns from different package managers
const (
Expand Down
1 change: 1 addition & 0 deletions packageupdaters/conanpackageupdater.go
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ func (conan *ConanPackageUpdater) updateDirectDependency(vulnDetails *utils.Vuln
}

func (conan *ConanPackageUpdater) updateConanFile(conanFilePath string, vulnDetails *utils.VulnerabilityDetails) (isFileChanged bool, err error) {
//#nosec G304 -- descriptor path from scan workflow.
data, err := os.ReadFile(conanFilePath)
if err != nil {
return false, fmt.Errorf("an error occurred while attempting to read the requirements file '%s': %s", conanFilePath, err.Error())
Expand Down
Loading