1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
// Copyright 2021 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//go:build go1.18
// +build go1.18
package vulncheck
import (
"context"
"io"
"os"
"os/exec"
"path/filepath"
"runtime"
"sort"
"testing"
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"golang.org/x/tools/go/packages/packagestest"
"golang.org/x/vuln/internal/semver"
"golang.org/x/vuln/vulncheck/internal/binscan"
)
// TODO: we build binary programatically, so what if the underlying tool chain changes?
func TestBinary(t *testing.T) {
// TODO(#52160): investigate why Binary does not process plan9 binaries
if !hasGoBuild() || runtime.GOOS == "plan9" {
t.Skip("fails on android and plan9")
}
e := packagestest.Export(t, packagestest.Modules, []packagestest.Module{
{
Name: "golang.org/entry",
Files: map[string]interface{}{
"main.go": `
package main
import (
"archive/zip"
"golang.org/cmod/c"
"golang.org/bmod/bvuln"
)
func main() {
c.C()
bvuln.NoVuln() // no vuln use
_, err := zip.OpenReader("file.zip")
print(err)
}
`,
}},
{
Name: "golang.org/cmod@v1.1.3",
Files: map[string]interface{}{"c/c.go": `
package c
import (
"golang.org/amod/avuln"
)
//go:noinline
func C() {
v := avuln.VulnData{}
v.Vuln1() // vuln use
}
`},
},
{
Name: "golang.org/amod@v1.1.3",
Files: map[string]interface{}{"avuln/avuln.go": `
package avuln
type VulnData struct {}
//go:noinline
func (v VulnData) Vuln1() {}
//go:noinline
func (v VulnData) Vuln2() {}
`},
},
{
Name: "golang.org/bmod@v0.5.0",
Files: map[string]interface{}{"bvuln/bvuln.go": `
package bvuln
//go:noinline
func Vuln() {}
//go:noinline
func NoVuln() {}
`},
},
})
defer e.Cleanup()
cmd := exec.Command("go", "build", "-o", "entry")
cmd.Dir = e.Config.Dir
cmd.Env = e.Config.Env
out, err := cmd.CombinedOutput()
if err != nil || len(out) > 0 {
t.Fatalf("failed to build the binary %v %v", err, string(out))
}
bin, err := os.Open(filepath.Join(e.Config.Dir, "entry"))
if err != nil {
t.Fatalf("failed to access the binary %v", err)
}
defer bin.Close()
// Test imports only mode
cfg := &Config{
Client: testClient,
ImportsOnly: true,
}
res, err := Binary(context.Background(), bin, cfg)
if err != nil {
t.Fatal(err)
}
hasGo := hasGoVersion(bin)
// In importsOnly mode, vulnerable symbols
// {avuln.VulnData.Vuln1, avuln.VulnData.Vuln2, bvuln.Vuln}
// should be detected.
wantVulns := []*Vuln{
{Symbol: "Vuln", PkgPath: "golang.org/bmod/bvuln", ModPath: "golang.org/bmod"},
{Symbol: "VulnData.Vuln1", PkgPath: "golang.org/amod/avuln", ModPath: "golang.org/amod"},
{Symbol: "VulnData.Vuln2", PkgPath: "golang.org/amod/avuln", ModPath: "golang.org/amod"},
}
if hasGo {
// If binary has recognizable Go version available,
// then archive/zip.OpenReader should be detected too.
wantVulns = append(wantVulns, &Vuln{Symbol: "OpenReader", PkgPath: "archive/zip", ModPath: "stdlib"})
}
diff := cmp.Diff(wantVulns, res.Vulns,
cmpopts.IgnoreFields(Vuln{}, "OSV"),
cmpopts.SortSlices(func(v1, v2 *Vuln) bool { return v1.Symbol < v2.Symbol }))
if diff != "" {
t.Errorf("vulns mismatch (-want, +got)\n%s", diff)
}
// Test the symbols (non-import mode)
cfg = &Config{Client: testClient}
res, err = Binary(context.Background(), bin, cfg)
if err != nil {
t.Fatal(err)
}
wantVulns = []*Vuln{
{Symbol: "VulnData.Vuln1", PkgPath: "golang.org/amod/avuln", ModPath: "golang.org/amod"},
}
if hasGo {
// If binary has recognizable Go version available,
// then archive/zip.OpenReader should be detected too.
wantVulns = append(wantVulns, &Vuln{Symbol: "OpenReader", PkgPath: "archive/zip", ModPath: "stdlib"})
}
diff = cmp.Diff(wantVulns, res.Vulns,
cmpopts.IgnoreFields(Vuln{}, "OSV"),
cmpopts.SortSlices(func(v1, v2 *Vuln) bool { return v1.Symbol < v2.Symbol }))
if diff != "" {
t.Errorf("vulns mismatch (-want, +got)\n%s", diff)
}
// Check that the binary's modules are returned.
// The list does not include the module binary itself.
wantMods := []*Module{
{Path: "golang.org/amod", Version: "v1.1.3"},
{Path: "golang.org/bmod", Version: "v0.5.0"},
{Path: "golang.org/cmod", Version: "v1.1.3"},
stdlibModule,
}
gotMods := res.Modules
sort.Slice(gotMods, func(i, j int) bool { return gotMods[i].Path < gotMods[j].Path })
if diff := cmp.Diff(wantMods, gotMods, cmpopts.IgnoreFields(Module{}, "Dir")); diff != "" {
t.Errorf("modules mismatch (-want, +got):\n%s", diff)
}
}
// hasGoBuild reports whether the current system can build programs with “go build”
// and then run them with os.StartProcess or exec.Command.
//
// Duplicated from std/internal/testenv
func hasGoBuild() bool {
if os.Getenv("GO_GCFLAGS") != "" {
return false
}
switch runtime.GOOS {
case "android", "js", "ios":
return false
}
return true
}
func hasGoVersion(exe io.ReaderAt) bool {
_, _, bi, _ := binscan.ExtractPackagesAndSymbols(exe)
return semver.GoTagToSemver(bi.GoVersion) != ""
}
|
