Skip to content

Commit

Permalink
fix(nodejs): add name validation for package name from package.json (
Browse files Browse the repository at this point in the history
  • Loading branch information
DmitriyLewen authored Mar 11, 2024
1 parent d6c40ce commit 12c5bf0
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 2 deletions.
16 changes: 16 additions & 0 deletions pkg/dependency/parser/nodejs/packagejson/parse.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@ package packagejson
import (
"encoding/json"
"io"
"regexp"

"golang.org/x/xerrors"

"github.com/aquasecurity/trivy/pkg/dependency/parser/types"
"github.com/aquasecurity/trivy/pkg/dependency/parser/utils"
)

var nameRegexp = regexp.MustCompile(`^(@[A-Za-z0-9-._]+/)?[A-Za-z0-9-._]+$`)

type packageJSON struct {
Name string `json:"name"`
Version string `json:"version"`
Expand Down Expand Up @@ -40,6 +43,10 @@ func (p *Parser) Parse(r io.Reader) (Package, error) {
return Package{}, xerrors.Errorf("JSON decode error: %w", err)
}

if !IsValidName(pkgJSON.Name) {
return Package{}, xerrors.Errorf("Name can only contain URL-friendly characters")
}

var id string
// Name and version fields are optional
// https://docs.npmjs.com/cli/v9/configuring-npm/package-json#name
Expand Down Expand Up @@ -73,3 +80,12 @@ func parseLicense(val interface{}) string {
}
return ""
}

func IsValidName(name string) bool {
// Name is optional field
// https://docs.npmjs.com/cli/v9/configuring-npm/package-json#name
if name == "" {
return true
}
return nameRegexp.MatchString(name)
}
58 changes: 56 additions & 2 deletions pkg/dependency/parser/nodejs/packagejson/parse_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package packagejson_test

import (
"os"
"path"
"testing"

"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -77,6 +76,11 @@ func TestParse(t *testing.T) {
},
},
},
{
name: "invalid package name",
inputFile: "testdata/invalid_name.json",
wantErr: "Name can only contain URL-friendly characters",
},
{
name: "sad path",
inputFile: "testdata/invalid_package.json",
Expand All @@ -99,7 +103,7 @@ func TestParse(t *testing.T) {
}

for _, v := range vectors {
t.Run(path.Base(v.name), func(t *testing.T) {
t.Run(v.name, func(t *testing.T) {
f, err := os.Open(v.inputFile)
require.NoError(t, err)
defer f.Close()
Expand All @@ -115,3 +119,53 @@ func TestParse(t *testing.T) {
})
}
}

func TestIsValidName(t *testing.T) {
tests := []struct {
name string
want bool
}{
{
name: "",
want: true,
},
{
name: "test_package",
want: true,
},
{
name: "test.package",
want: true,
},
{
name: "test-package",
want: true,
},
{
name: "@test/package",
want: true,
},
{
name: "test@package",
want: false,
}, {
name: "test?package",
want: false,
},
{
name: "test/package",
want: false,
},
{
name: "package/",
want: false,
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
valid := packagejson.IsValidName(tt.name)
require.Equal(t, tt.want, valid)
})
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "@invalid/packageName/",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}

0 comments on commit 12c5bf0

Please sign in to comment.