forked from quay/claircore
-
Notifications
You must be signed in to change notification settings - Fork 0
/
updater.go
348 lines (318 loc) · 8.09 KB
/
updater.go
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
// Package pyupio provides an updater for importing pyup vulnerability
// information.
package pyupio
import (
"archive/tar"
"compress/gzip"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"path/filepath"
"strings"
"github.com/quay/zlog"
"go.opentelemetry.io/otel/baggage"
"go.opentelemetry.io/otel/label"
"github.com/quay/claircore"
"github.com/quay/claircore/libvuln/driver"
"github.com/quay/claircore/pkg/pep440"
"github.com/quay/claircore/pkg/tmp"
)
const defaultURL = `https://github.com/pyupio/safety-db/archive/master.tar.gz`
var (
_ driver.Updater = (*Updater)(nil)
defaultRepo = claircore.Repository{
Name: "pypi",
URI: "https://pypi.org/simple",
}
)
// Updater reads a pyup formatted json database for vulnerabilities.
//
// The zero value is not safe to use.
type Updater struct {
url *url.URL
client *http.Client
repo *claircore.Repository
}
// NewUpdater returns a configured Updater or reports an error.
func NewUpdater(opt ...Option) (*Updater, error) {
u := Updater{}
for _, f := range opt {
if err := f(&u); err != nil {
return nil, err
}
}
if u.url == nil {
var err error
u.url, err = url.Parse(defaultURL)
if err != nil {
return nil, err
}
}
if u.client == nil {
u.client = http.DefaultClient
}
if u.repo == nil {
u.repo = &defaultRepo
}
return &u, nil
}
// Option controls the configuration of an Updater.
type Option func(*Updater) error
// WithClient sets the http.Client that the updater should use for requests.
//
// If not passed to NewUpdater, http.DefaultClient will be used.
func WithClient(c *http.Client) Option {
return func(u *Updater) error {
u.client = c
return nil
}
}
// WithRepo sets the repository information that will be associated with all the
// vulnerabilites found.
//
// If not passed to NewUpdater, a default Repository will be used.
func WithRepo(r *claircore.Repository) Option {
return func(u *Updater) error {
u.repo = r
return nil
}
}
// WithURL sets the URL the updater should fetch.
//
// The URL should point to a gzip compressed tarball containing a properly
// formatted json object in a file named `insecure_full.json`.
//
// If not passed to NewUpdater, the master branch of github.com/pyupio/safety-db
// will be fetched.
func WithURL(uri string) Option {
u, err := url.Parse(uri)
return func(up *Updater) error {
if err != nil {
return err
}
up.url = u
return nil
}
}
// Name implements driver.Updater.
func (*Updater) Name() string { return "pyupio" }
// Fetch implements driver.Updater.
func (u *Updater) Fetch(ctx context.Context, hint driver.Fingerprint) (io.ReadCloser, driver.Fingerprint, error) {
ctx = baggage.ContextWithValues(ctx,
label.String("component", "pyupio/Updater.Fetch"))
zlog.Info(ctx).Str("database", u.url.String()).Msg("starting fetch")
req := http.Request{
Method: http.MethodGet,
Header: http.Header{"User-Agent": {"claircore/pyupio/Updater"}},
URL: u.url,
Proto: "HTTP/1.1",
ProtoMajor: 1,
ProtoMinor: 1,
Host: u.url.Host,
}
if hint != "" {
zlog.Debug(ctx).
Str("hint", string(hint)).
Msg("using hint")
req.Header.Set("if-none-match", string(hint))
}
res, err := u.client.Do(req.WithContext(ctx))
if res != nil {
defer res.Body.Close()
}
if err != nil {
return nil, hint, err
}
switch res.StatusCode {
case http.StatusNotModified:
return nil, hint, driver.Unchanged
case http.StatusOK:
// break
default:
return nil, hint, fmt.Errorf("pyupio: fetcher got unexpected HTTP response: %d (%s)", res.StatusCode, res.Status)
}
zlog.Debug(ctx).Msg("request ok")
r, err := gzip.NewReader(res.Body)
if err != nil {
return nil, hint, err
}
tf, err := tmp.NewFile("", "pyupio.")
if err != nil {
return nil, hint, err
}
zlog.Debug(ctx).
Str("path", tf.Name()).
Msg("using tempfile")
success := false
defer func() {
if !success {
zlog.Debug(ctx).Msg("unsuccessful, cleaning up tempfile")
if err := tf.Close(); err != nil {
zlog.Warn(ctx).Err(err).Msg("failed to close tempfile")
}
}
}()
if _, err := io.Copy(tf, r); err != nil {
return nil, hint, err
}
if o, err := tf.Seek(0, io.SeekStart); err != nil || o != 0 {
return nil, hint, err
}
zlog.Debug(ctx).Msg("decompressed and buffered database")
if t := res.Header.Get("etag"); t != "" {
zlog.Debug(ctx).
Str("hint", t).
Msg("using new hint")
hint = driver.Fingerprint(t)
}
success = true
return tf, hint, nil
}
// Parse implements driver.Updater.
func (u *Updater) Parse(ctx context.Context, r io.ReadCloser) ([]*claircore.Vulnerability, error) {
ctx = baggage.ContextWithValues(ctx,
label.String("component", "pyupio/Updater.Parse"))
zlog.Info(ctx).Msg("parse start")
defer r.Close()
defer zlog.Info(ctx).Msg("parse done")
var db db
tr := tar.NewReader(r)
h, err := tr.Next()
done := false
for ; err == nil && !done; h, err = tr.Next() {
if h.Typeflag != tar.TypeReg || filepath.Base(h.Name) != "insecure_full.json" {
continue
}
if err := json.NewDecoder(tr).Decode(&db); err != nil {
return nil, err
}
}
if err != io.EOF {
return nil, err
}
zlog.Debug(ctx).
Int("count", len(db)).
Msg("found raw entries")
ret, err := db.Vulnerabilites(ctx, u.repo, u.Name())
if err != nil {
return nil, err
}
zlog.Debug(ctx).
Int("count", len(ret)).
Msg("found vulnerabilities")
return ret, nil
}
type db map[string]json.RawMessage
type entry struct {
Advisory string `json:"advisory"`
CVE *string `json:"cve"`
ID string `json:"id"`
Specs []string `json:"specs"`
V string `json:"v"`
}
var vZero pep440.Version
func init() {
var err error
vZero, err = pep440.Parse("0")
if err != nil {
panic(err)
}
}
func (db db) Vulnerabilites(ctx context.Context, repo *claircore.Repository, updater string) ([]*claircore.Vulnerability, error) {
const opSet = `<>=!`
ctx = baggage.ContextWithValues(ctx,
label.String("component", "pyupio/db.Vulnerabilities"))
var mungeCt int
var ret []*claircore.Vulnerability
for k, m := range db {
if k == "$meta" {
continue
}
var es []entry
if err := json.Unmarshal(m, &es); err != nil {
return nil, err
}
for _, e := range es {
Vuln:
for _, spec := range e.Specs {
v := &claircore.Vulnerability{
Name: e.ID,
Updater: updater,
Description: e.Advisory,
Package: &claircore.Package{Name: strings.ToLower(k), Kind: claircore.BINARY},
Repo: repo,
Range: &claircore.Range{},
}
if e.CVE != nil {
v.Name += fmt.Sprintf(" (%s)", *e.CVE)
}
specs := strings.Split(spec, ",")
ls := len(specs)
if ls == 1 {
v.Range.Lower = vZero.Version()
}
if ls > 2 && ls%2 == 1 {
zlog.Warn(ctx).
Str("spec", spec).
Msg("malformed database entry")
continue
}
for _, r := range specs {
i := strings.LastIndexAny(r, opSet) + 1
ver, err := pep440.Parse(r[i:])
if err != nil {
zlog.Info(ctx).
Err(err).
Str("version", r[i:]).
Msg("unable to parse version as pep440")
continue Vuln
}
switch strings.TrimSpace(r[:i]) {
case ">":
// Treat the same as greater-than-equal becase we can't
// turn one into the other without having a list of
// versions.
mungeCt++
fallthrough
case ">=":
v.Range.Lower = ver.Version()
case "<=":
mungeCt++
ver.Post++
fallthrough
case "<":
v.FixedInVersion = ver.String()
v.Range.Upper = ver.Version()
case "==":
// Since range is half-open, this is equivalent to
// specifying exactly one version.
v.Range.Lower = ver.Version()
v.Range.Upper = ver.Version()
default:
zlog.Warn(ctx).
Str("comparison", r[:i]).
Msg("unexpected comparison, please file an issue")
}
}
if v.Range.Lower.Compare(&v.Range.Upper) == 1 {
zlog.Debug(ctx).
Str("id", e.ID).
Str("name", k).
Str("spec", spec).
Msg("malformed range")
continue
}
ret = append(ret, v)
}
}
}
if mungeCt > 0 {
zlog.Debug(ctx).
Int("count", mungeCt).
Msg("munged bounds on some vulnerabilities 😬")
}
return ret, nil
}