-
Notifications
You must be signed in to change notification settings - Fork 521
/
store.go
380 lines (315 loc) · 10.8 KB
/
store.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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
package store
import (
"fmt"
"sort"
_ "github.com/glebarez/sqlite" // provide the sqlite dialect to gorm via import
"github.com/go-test/deep"
"gorm.io/gorm"
"github.com/anchore/grype/grype/db/internal/gormadapter"
v5 "github.com/anchore/grype/grype/db/v5"
"github.com/anchore/grype/grype/db/v5/store/model"
"github.com/anchore/grype/internal/stringutil"
)
// store holds an instance of the database connection
type store struct {
db *gorm.DB
}
// New creates a new instance of the store.
func New(dbFilePath string, overwrite bool) (v5.Store, error) {
db, err := gormadapter.Open(dbFilePath, overwrite)
if err != nil {
return nil, err
}
if overwrite {
// TODO: automigrate could write to the database,
// we should be validating the database is the correct database based on the version in the ID table before
// automigrating
if err := db.AutoMigrate(&model.IDModel{}); err != nil {
return nil, fmt.Errorf("unable to migrate ID model: %w", err)
}
if err := db.AutoMigrate(&model.VulnerabilityModel{}); err != nil {
return nil, fmt.Errorf("unable to migrate Vulnerability model: %w", err)
}
if err := db.AutoMigrate(&model.VulnerabilityMetadataModel{}); err != nil {
return nil, fmt.Errorf("unable to migrate Vulnerability Metadata model: %w", err)
}
if err := db.AutoMigrate(&model.VulnerabilityMatchExclusionModel{}); err != nil {
return nil, fmt.Errorf("unable to migrate Vulnerability Match Exclusion model: %w", err)
}
}
return &store{
db: db,
}, nil
}
// GetID fetches the metadata about the databases schema version and build time.
func (s *store) GetID() (*v5.ID, error) {
var models []model.IDModel
result := s.db.Find(&models)
if result.Error != nil {
return nil, result.Error
}
switch {
case len(models) > 1:
return nil, fmt.Errorf("found multiple DB IDs")
case len(models) == 1:
id, err := models[0].Inflate()
if err != nil {
return nil, err
}
return &id, nil
}
return nil, nil
}
// SetID stores the databases schema version and build time.
func (s *store) SetID(id v5.ID) error {
var ids []model.IDModel
// replace the existing ID with the given one
s.db.Find(&ids).Delete(&ids)
m := model.NewIDModel(id)
result := s.db.Create(&m)
if result.RowsAffected != 1 {
return fmt.Errorf("unable to add id (%d rows affected)", result.RowsAffected)
}
return result.Error
}
// GetVulnerabilityNamespaces retrieves all possible namespaces from the database.
func (s *store) GetVulnerabilityNamespaces() ([]string, error) {
var names []string
result := s.db.Model(&model.VulnerabilityMetadataModel{}).Distinct().Pluck("namespace", &names)
return names, result.Error
}
// GetVulnerability retrieves vulnerabilities by namespace and id
func (s *store) GetVulnerability(namespace, id string) ([]v5.Vulnerability, error) {
var models []model.VulnerabilityModel
result := s.db.Where("namespace = ? AND id = ?", namespace, id).Find(&models)
var vulnerabilities = make([]v5.Vulnerability, len(models))
for idx, m := range models {
vulnerability, err := m.Inflate()
if err != nil {
return nil, err
}
vulnerabilities[idx] = vulnerability
}
return vulnerabilities, result.Error
}
// SearchForVulnerabilities retrieves vulnerabilities by namespace and package
func (s *store) SearchForVulnerabilities(namespace, packageName string) ([]v5.Vulnerability, error) {
var models []model.VulnerabilityModel
result := s.db.Where("namespace = ? AND package_name = ?", namespace, packageName).Find(&models)
var vulnerabilities = make([]v5.Vulnerability, len(models))
for idx, m := range models {
vulnerability, err := m.Inflate()
if err != nil {
return nil, err
}
vulnerabilities[idx] = vulnerability
}
return vulnerabilities, result.Error
}
// AddVulnerability saves one or more vulnerabilities into the sqlite3 store.
func (s *store) AddVulnerability(vulnerabilities ...v5.Vulnerability) error {
for _, vulnerability := range vulnerabilities {
m := model.NewVulnerabilityModel(vulnerability)
result := s.db.Create(&m)
if result.Error != nil {
return result.Error
}
if result.RowsAffected != 1 {
return fmt.Errorf("unable to add vulnerability (%d rows affected)", result.RowsAffected)
}
}
return nil
}
// GetVulnerabilityMetadata retrieves metadata for the given vulnerability ID relative to a specific record source.
func (s *store) GetVulnerabilityMetadata(id, namespace string) (*v5.VulnerabilityMetadata, error) {
var models []model.VulnerabilityMetadataModel
result := s.db.Where(&model.VulnerabilityMetadataModel{ID: id, Namespace: namespace}).Find(&models)
if result.Error != nil {
return nil, result.Error
}
switch {
case len(models) > 1:
return nil, fmt.Errorf("found multiple metadatas for single ID=%q Namespace=%q", id, namespace)
case len(models) == 1:
metadata, err := models[0].Inflate()
if err != nil {
return nil, err
}
return &metadata, nil
}
return nil, nil
}
// AddVulnerabilityMetadata stores one or more vulnerability metadata models into the sqlite DB.
//
//nolint:gocognit
func (s *store) AddVulnerabilityMetadata(metadata ...v5.VulnerabilityMetadata) error {
for _, m := range metadata {
existing, err := s.GetVulnerabilityMetadata(m.ID, m.Namespace)
if err != nil {
return fmt.Errorf("failed to verify existing entry: %w", err)
}
if existing != nil {
// merge with the existing entry
switch {
case existing.Severity != m.Severity:
return fmt.Errorf("existing metadata has mismatched severity (%q!=%q)", existing.Severity, m.Severity)
case existing.Description != m.Description:
return fmt.Errorf("existing metadata has mismatched description (%q!=%q)", existing.Description, m.Description)
}
incoming:
// go through all incoming CVSS and see if they are already stored.
// If they exist already in the database then skip adding them,
// preventing a duplicate
for _, incomingCvss := range m.Cvss {
for _, existingCvss := range existing.Cvss {
if len(deep.Equal(incomingCvss, existingCvss)) == 0 {
// duplicate found, so incoming CVSS shouldn't get added
continue incoming
}
}
// a duplicate CVSS entry wasn't found, so append the incoming CVSS
existing.Cvss = append(existing.Cvss, incomingCvss)
}
links := stringutil.NewStringSetFromSlice(existing.URLs)
for _, l := range m.URLs {
links.Add(l)
}
existing.URLs = links.ToSlice()
sort.Strings(existing.URLs)
newModel := model.NewVulnerabilityMetadataModel(*existing)
result := s.db.Save(&newModel)
if result.RowsAffected != 1 {
return fmt.Errorf("unable to merge vulnerability metadata (%d rows affected)", result.RowsAffected)
}
if result.Error != nil {
return result.Error
}
} else {
// this is a new entry
newModel := model.NewVulnerabilityMetadataModel(m)
result := s.db.Create(&newModel)
if result.Error != nil {
return result.Error
}
if result.RowsAffected != 1 {
return fmt.Errorf("unable to add vulnerability metadata (%d rows affected)", result.RowsAffected)
}
}
}
return nil
}
// GetVulnerabilityMatchExclusion retrieves one or more vulnerability match exclusion records given a vulnerability identifier.
func (s *store) GetVulnerabilityMatchExclusion(id string) ([]v5.VulnerabilityMatchExclusion, error) {
var models []model.VulnerabilityMatchExclusionModel
result := s.db.Where("id = ?", id).Find(&models)
var exclusions []v5.VulnerabilityMatchExclusion
for _, m := range models {
exclusion, err := m.Inflate()
if err != nil {
return nil, err
}
if exclusion != nil {
exclusions = append(exclusions, *exclusion)
}
}
return exclusions, result.Error
}
// AddVulnerabilityMatchExclusion saves one or more vulnerability match exclusion records into the sqlite3 store.
func (s *store) AddVulnerabilityMatchExclusion(exclusions ...v5.VulnerabilityMatchExclusion) error {
for _, exclusion := range exclusions {
m := model.NewVulnerabilityMatchExclusionModel(exclusion)
result := s.db.Create(&m)
if result.Error != nil {
return result.Error
}
if result.RowsAffected != 1 {
return fmt.Errorf("unable to add vulnerability match exclusion (%d rows affected)", result.RowsAffected)
}
}
return nil
}
func (s *store) Close() {
s.db.Exec("VACUUM;")
sqlDB, err := s.db.DB()
if err != nil {
_ = sqlDB.Close()
}
}
// GetAllVulnerabilities gets all vulnerabilities in the database
func (s *store) GetAllVulnerabilities() (*[]v5.Vulnerability, error) {
var models []model.VulnerabilityModel
if result := s.db.Find(&models); result.Error != nil {
return nil, result.Error
}
vulns := make([]v5.Vulnerability, len(models))
for idx, m := range models {
vuln, err := m.Inflate()
if err != nil {
return nil, err
}
vulns[idx] = vuln
}
return &vulns, nil
}
// GetAllVulnerabilityMetadata gets all vulnerability metadata in the database
func (s *store) GetAllVulnerabilityMetadata() (*[]v5.VulnerabilityMetadata, error) {
var models []model.VulnerabilityMetadataModel
if result := s.db.Find(&models); result.Error != nil {
return nil, result.Error
}
metadata := make([]v5.VulnerabilityMetadata, len(models))
for idx, m := range models {
data, err := m.Inflate()
if err != nil {
return nil, err
}
metadata[idx] = data
}
return &metadata, nil
}
// DiffStore creates a diff between the current sql database and the given store
func (s *store) DiffStore(targetStore v5.StoreReader) (*[]v5.Diff, error) {
// 7 stages, one for each step of the diff process (stages)
rowsProgress, diffItems, stager := trackDiff(7)
stager.Current = "reading target vulnerabilities"
targetVulns, err := targetStore.GetAllVulnerabilities()
rowsProgress.Increment()
if err != nil {
return nil, err
}
stager.Current = "reading base vulnerabilities"
baseVulns, err := s.GetAllVulnerabilities()
rowsProgress.Increment()
if err != nil {
return nil, err
}
stager.Current = "preparing"
baseVulnPkgMap := buildVulnerabilityPkgsMap(baseVulns)
targetVulnPkgMap := buildVulnerabilityPkgsMap(targetVulns)
stager.Current = "comparing vulnerabilities"
allDiffsMap := diffVulnerabilities(baseVulns, targetVulns, baseVulnPkgMap, targetVulnPkgMap, diffItems)
stager.Current = "reading base metadata"
baseMetadata, err := s.GetAllVulnerabilityMetadata()
if err != nil {
return nil, err
}
rowsProgress.Increment()
stager.Current = "reading target metadata"
targetMetadata, err := targetStore.GetAllVulnerabilityMetadata()
if err != nil {
return nil, err
}
rowsProgress.Increment()
stager.Current = "comparing metadata"
metaDiffsMap := diffVulnerabilityMetadata(baseMetadata, targetMetadata, baseVulnPkgMap, targetVulnPkgMap, diffItems)
for k, diff := range *metaDiffsMap {
(*allDiffsMap)[k] = diff
}
allDiffs := []v5.Diff{}
for _, diff := range *allDiffsMap {
allDiffs = append(allDiffs, *diff)
}
rowsProgress.SetCompleted()
diffItems.SetCompleted()
return &allDiffs, nil
}