aboutsummaryrefslogtreecommitdiff
path: root/dbstore/dbstore.go
blob: 65aa35998e83a287f68db9aa8e5b2d37e84e9324 (plain)
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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
// database storage
package dbstore

import (
  "context"
  db_sql "database/sql"
  "encoding/json"
  "fmt"
  _ "github.com/mattn/go-sqlite3"
  "github.com/pablotron/cvez/cisa"
  "github.com/pablotron/cvez/cpedict"
  "github.com/pablotron/cvez/cpematch"
  nvd_feed "github.com/pablotron/cvez/feed"
  "sort"
)

// sqlite3 backing store
type DbStore struct {
  db *db_sql.DB
}

// Open database.
//
// This function is called by Open().  It is a separate package-private
// function to make Open() easier to test.
func openFull(dbType, path string) (DbStore, error) {
  var r DbStore

  // init db
  if db, err := db_sql.Open(dbType, path); err != nil {
    return r, err
  } else {
    // save handle
    r.db = db
    return r, nil
  }
}

// Open database
func Open(path string) (DbStore, error) {
  return openFull("sqlite3", path)
}

// initialized database version
const initDbVersion = 314159

func (me DbStore) isInitialized(ctx context.Context) (bool, error) {
  sql := "PRAGMA user_version;"
  // get version
  var version int32
  if err := me.db.QueryRowContext(ctx, sql).Scan(&version); err != nil {
    return false, err
  }

  // return result
  return (version == initDbVersion), nil
}

// enable foreign keys
func (me DbStore) enableForeignKeys(ctx context.Context) error {
  _, err := me.db.ExecContext(ctx, "PRAGMA foreign_keys = true;")
  return err
}

// initialize database
func (me DbStore) Init(ctx context.Context) error {
  if inited, err := me.isInitialized(ctx); err != nil {
    return err
  } else if inited {
    // already initialized, enable foreign keys
    return me.enableForeignKeys(ctx)
  }

  // read init query
  if sql, err := getQuery("init"); err != nil {
    return err
  } else {
    // exec init query, return result
    _, err = me.db.ExecContext(ctx, sql)
    return err
  }
}

// Begin new transaction and create prepared statements.
func (me DbStore) Begin(ctx context.Context, queryIds []string) (Tx, error) {
  return newTx(ctx, me.db, queryIds)
}

// Create a transaction, pass it to callback, then commit the transaction
// if the callback returns success and rollback the transaction if the
// callback returns an error.
func (me DbStore) Tx(ctx context.Context, queryIds []string, fn func(Tx) error) error {
  // create transaction
  tx, err := me.Begin(ctx, queryIds)
  if err != nil {
    return err
  }

  if err := fn(tx); err != nil {
    // rollback
    if rb_err := tx.Rollback(); rb_err != nil {
      return rb_err
    }

    // return error
    return err
  } else {
    // commit transaction
    return tx.Commit()
  }
}

// Execute query and invoke callback with each row of result.
func (me DbStore) Query(
  ctx context.Context,
  queryId string,
  args []interface{},
  fn func(*db_sql.Rows) error,
) error {
  // get query
  sql, err := getQuery(queryId)
  if err != nil {
    return err
  }

  // exec query
  rows, err := me.db.QueryContext(ctx, sql, args...)
  if err != nil {
    return err
  }

  // walk results
  for rows.Next() {
    if err = fn(rows); err != nil {
      return err
    }
  }

  // close rows
  // FIXME: is this correct? i am following the example from the
  // database/sql documentation, but it is messy and it seems
  // counterintuitive to close the row set and then do an additional
  // test for iteration errors...
  if err = rows.Close(); err != nil {
    return err
  }

  // check for iteration errors
  if err = rows.Err(); err != nil {
    return err
  }

  // return success
  return nil
}

// Execute query and invoke callback with first row of result.
func (me DbStore) QueryRow(
  ctx context.Context,
  queryId string,
  args []interface{},
  fn func (*db_sql.Row) error,
) error {
  // get query
  sql, err := getQuery(queryId)
  if err != nil {
    return err
  }

  // exec query, invoke callback, return result
  return fn(me.db.QueryRowContext(ctx, sql, args...))
}

// queries used by AddCpeDictionary()
var addCpeDictionaryQueryIds = []string {
  "cpe/insert",
  "cpe/insert-title",
  "cpe/insert-ref",
  "cpe/insert-fts-refresh",
}

// Refresh CVE FTS index.
func (me DbStore) refreshCpeFts(ctx context.Context, tx Tx) error {
  _, err := tx.Exec(ctx, "cpe/insert-fts-refresh")
  return err
}

// import CPE dictionary
func (me DbStore) AddCpeDictionary(ctx context.Context, dict cpedict.Dictionary) error {
  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return err
  }

  return me.Tx(ctx, addCpeDictionaryQueryIds, func(tx Tx) error {
    // add items
    for _, item := range(dict.Items) {
      // add cpe
      rs, err := tx.Exec(ctx, "cpe/insert", item.CpeUri, item.Cpe23Item.Name)
      if err != nil {
        return err
      }

      // get last row ID
      id, err := rs.LastInsertId()
      if err != nil {
        return err
      }

      // add titles
      for _, title := range(item.Titles) {
        _, err := tx.Exec(ctx, "cpe/insert-title", id, title.Lang, title.Text)
        if err != nil {
          return err
        }
      }

      // add refs
      for _, ref := range(item.References) {
        _, err := tx.Exec(ctx, "cpe/insert-ref", id, ref.Href, ref.Text)
        if err != nil {
          return err
        }
      }
    }

    // refresh the cpe fts's
    return me.refreshCpeFts(ctx, tx)
  })
}

// search CPEs
func (me DbStore) CpeSearch(
  ctx context.Context,
  searchType CpeSearchType,
  s string,
) ([]CpeSearchRow, error) {
  var r []CpeSearchRow

  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return r, err
  }

  // get/exec search query
  err := me.Query(ctx, searchType.String(), []interface{} {
    db_sql.Named("q", s),
  }, func(rows *db_sql.Rows) error {
    if sr, err := unmarshalCpeSearchRow(rows); err != nil {
      // return error
      return err
    } else {
      // append to results
      r = append(r, sr)
      return nil
    }
  })

  // return results
  return r, err
}

// query IDs used by AddCpeMatches()
var addCpeMatchesQueryIds = []string {
  "cpe-match/insert",
  "cpe-match/insert-vulnerable",
  "cpe-match/insert-version-min",
  "cpe-match/insert-version-max",
  "cpe-match/insert-name",
}

// import CPE matches
func (me DbStore) AddCpeMatches(ctx context.Context, matches cpematch.Matches) error {
  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return err
  }

  // begin transaction
  return me.Tx(ctx, addCpeMatchesQueryIds, func(tx Tx) error {
    // add matches
    for _, m := range(matches.Matches) {
      // add cpe
      rs, err := tx.Exec(ctx, "cpe-match/insert", m.Cpe23Uri, m.Cpe22Uri)
      if err != nil {
        return err
      }

      // get last row ID
      id, err := rs.LastInsertId()
      if err != nil {
        return err
      }

      // add vulnerable
      if m.Vulnerable != nil {
        _, err := tx.Exec(ctx, "cpe-match/insert-vulnerable", id, *m.Vulnerable)
        if  err != nil {
          return err
        }
      }

      // add version minimum
      if m.VersionStartIncluding != "" && m.VersionStartExcluding != "" {
        return fmt.Errorf("cannot specify both VersionStartIncluding = \"%s\", VersionEndIncluding \"%s\"", m.VersionStartIncluding, m.VersionStartExcluding)
      } else if m.VersionStartIncluding != "" {
        _, err := tx.Exec(ctx, "cpe-match/insert-version-min", id, true, m.VersionStartIncluding)
        if  err != nil {
          return err
        }
      } else if m.VersionStartExcluding != "" {
        _, err := tx.Exec(ctx, "cpe-match/insert-version-min", id, false, m.VersionStartExcluding)
        if  err != nil {
          return err
        }
      }

      // add version maximum
      if m.VersionEndIncluding != "" && m.VersionEndExcluding != "" {
        return fmt.Errorf("cannot specify both VersionEndIncluding = \"%s\", VersionEndIncluding \"%s\"", m.VersionEndIncluding, m.VersionEndExcluding)
      } else if m.VersionEndIncluding != "" {
        _, err := tx.Exec(ctx, "cpe-match/insert-version-max", id, true, m.VersionEndIncluding)
        if  err != nil {
          return err
        }
      } else if m.VersionEndExcluding != "" {
        _, err := tx.Exec(ctx, "cpe-match/insert-version-max", id, false, m.VersionEndExcluding)
        if  err != nil {
          return err
        }
      }

      // add names
      for _, name := range(m.Names) {
        _, err := tx.Exec(ctx, "cpe-match/insert-name", id, name.Cpe22Uri, name.Cpe23Uri)
        if err != nil {
          return err
        }
      }
    }

    // return success
    return nil
  })
}

// search CPE matches
func (me DbStore) CpeMatchSearch(
  ctx context.Context,
  match string,
) ([]string, error) {
  var r []string

  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return r, err
  }

  // exec search query
  err := me.Query(ctx, "cpe-match/search", []interface{} {
    match,
  }, func(rows *db_sql.Rows) error {
    var s string
    if err := rows.Scan(&s); err != nil {
      // return error
      return err
    } else {
      // append to results
      r = append(r, s)
      return nil
    }
  })

  // return result
  return r, err
}

// Add description.
func (me DbStore) addDescriptions(ctx context.Context, tx Tx, ds []nvd_feed.Description) ([]int64, error) {
  r := make([]int64, len(ds))

  for i, d := range(ds) {
    // add description
    rs, err := tx.Exec(ctx, "feed/insert-desc", d.Lang, d.Value)
    if err != nil {
      return r, err
    }

    // return id and error
    id, err := rs.LastInsertId()
    if err != nil {
      return r, err
    }

    // add to results
    r[i] = id
  }

  // return description IDs
  return r, nil
}

// Add assigner if they are not already present in the database
func (me DbStore) addAssigner(ctx context.Context, tx Tx, itemId int64, assigner string) error {
  _, err := tx.Exec(ctx, "feed/insert-assigner", db_sql.Named("assigner", assigner))
  return err
}

// Add CVE.
func (me DbStore) addCve(ctx context.Context, tx Tx, itemId int64, cve nvd_feed.Cve) error {
  // cve ID
  var cveId int64

  // check data type, data format, and data version
  if err := checkNvdData(cve.DataType, cve.DataFormat, cve.DataVersion); err != nil {
    return err
  }

  // add cve assigner
  if err := me.addAssigner(ctx, tx, itemId, cve.Metadata.Assigner); err != nil {
    return err
  }

  // add cve
  nvdId := cve.Metadata.Id
  rs, err := tx.Exec(ctx, "feed/insert-cve", itemId, nvdId.Year(), nvdId.Number(), cve.Metadata.Assigner)
  if  err != nil {
    return err
  }

  // get cve ID
  cveId, err = rs.LastInsertId()
  if err != nil {
    return err
  }

  // add problem types
  for _, pt := range(cve.ProblemTypes.ProblemTypes) {
    // problem type ID
    var ptId int64

    // add problem type
    rs, err := tx.Exec(ctx, "feed/insert-cve-problem", cveId)
    if err != nil {
      return err
    }

    // get problem type ID
    ptId, err = rs.LastInsertId()
    if err != nil {
      return err
    }

    // add problem type descriptions
    descIds, err := me.addDescriptions(ctx, tx, pt.Descriptions)
    if err != nil {
      return err
    }

    // add problem type descriptions
    for _, descId := range(descIds) {
      _, err = tx.Exec(ctx, "feed/insert-cve-problem-desc", ptId, descId)
      if err != nil {
        return err
      }
    }
  }

  // add references
  for _, ref := range(cve.References.References) {
    // add reference
    rs, err := tx.Exec(ctx, "feed/insert-cve-ref", cveId, ref.Url, ref.Name, ref.RefSource)
    if err != nil {
      return err
    }

    // get ref ID
    refId, err := rs.LastInsertId()
    if err != nil {
      return err
    }

    // add cve ref tags
    for _, tag := range(ref.Tags) {
      _, err = tx.Exec(ctx, "feed/insert-cve-ref-tag", refId, tag)
      if err != nil {
        return err
      }
    }
  }

  // add cve descriptions
  descIds, err := me.addDescriptions(ctx, tx, cve.Description.Descriptions)
  if err != nil {
    return err
  }

  // add cve descriptions
  for _, descId := range(descIds) {
    _, err = tx.Exec(ctx, "feed/insert-cve-desc", cveId, descId)
    if err != nil {
      return err
    }
  }

  // return success
  return nil
}

// add feed item CVSSv2 impact.
func (me DbStore) addItemCvssV2(ctx context.Context, tx Tx, itemId int64, metric *nvd_feed.BaseMetricV2) error {
  if metric == nil {
    // no v2 vector to add
    return nil
  }

  // check version
  if metric.CvssV2.Version != nvd_feed.V20 {
    return fmt.Errorf("unknown CVSSv2 version: %s", metric.CvssV2.Version)
  }

  // add metric
  _, err := tx.Exec(ctx, "feed/insert-item-cvss-v2",
    itemId,
    metric.CvssV2.Vector.String(),
    int64(metric.CvssV2.BaseScore),
    metric.Severity.String(),
    int64(metric.ExploitabilityScore),
    int64(metric.ImpactScore),
    metric.InsufficientInfo,
    metric.ObtainAllPrivilege,
    metric.ObtainUserPrivilege,
    metric.ObtainOtherPrivilege,
    metric.UserInteractionRequired,
  )

  // return result
  return err
}

// add feed item CVSSv3 impact.
func (me DbStore) addItemCvssV3(ctx context.Context, tx Tx, itemId int64, metric *nvd_feed.BaseMetricV3) error {
  if metric == nil {
    // no cvssv3 vector to add
    return nil
  }

  // check version
  if metric.CvssV3.Version != nvd_feed.V30 && metric.CvssV3.Version != nvd_feed.V31 {
    return fmt.Errorf("unknown CVSSv3 version: %s", metric.CvssV3.Version)
  }

  // add metric
  _, err := tx.Exec(ctx, "feed/insert-item-cvss-v3",
    itemId,
    metric.CvssV3.Vector.String(),
    int64(uint8(metric.CvssV3.BaseScore)),
    metric.CvssV3.BaseSeverity.String(),
    int64(uint8(metric.ExploitabilityScore)),
    int64(uint8(metric.ImpactScore)),
  )

  // return result
  return err
}

// add feed item impact.
func (me DbStore) addImpact(ctx context.Context, tx Tx, itemId int64, impact nvd_feed.Impact) error {
  // add cvss v2 impact
  if err := me.addItemCvssV2(ctx, tx, itemId, impact.BaseMetricV2); err != nil {
    return err
  }

  // add cvss v3 impact
  if err := me.addItemCvssV3(ctx, tx, itemId, impact.BaseMetricV3); err != nil {
    return err
  }

  // return success
  return nil
}

// Add feed item and return item ID.
func (me DbStore) addItem(ctx context.Context, tx Tx, feedId int64, item nvd_feed.Item) error {
  // item ID
  var itemId int64

  // serialize published timestamp
  publishedAt, err := item.PublishedDate.MarshalText()
  if err != nil {
    return err
  }

  // serialize lastmodified timestamp
  modifiedAt, err := item.LastModifiedDate.MarshalText()
  if err != nil {
    return err
  }

  // add feed item
  rs, err := tx.Exec(ctx, "feed/insert-item", feedId, publishedAt, modifiedAt)
  if  err != nil {
    return err
  }

  // get item ID
  itemId, err = rs.LastInsertId()
  if err != nil {
    return err
  }

  // TODO: add item configuration
  // if err := me.addConfigs(ctx, tx, itemId, item.Configurations); err != nil {
  //   return err
  // }


  // add item cve
  if err := me.addCve(ctx, tx, itemId, item.Cve); err != nil {
    return err
  }

  // add item impact
  if err := me.addImpact(ctx, tx, itemId, item.Impact); err != nil {
    return err
  }

  // return success
  return nil
}

// Add base CVE feed and return feed ID.
func (me DbStore) addFeed(ctx context.Context, tx Tx, feed nvd_feed.Feed) (int64, error) {
  // return feed ID
  var feedId int64

  // check feed data type, data format, and data version
  if err := checkNvdData(feed.DataType, feed.DataFormat, feed.DataVersion); err != nil {
    return feedId, err
  }

  // FIXME: check cve count?
  // if feed.NumCVEs != len(feed.Items) {
  // }

  // serialize feed timestamp
  ts, err := feed.Timestamp.MarshalText()
  if err != nil {
    return feedId, err
  }

  // add feed
  rs, err := tx.Exec(ctx, "feed/insert", string(ts))
  if err != nil {
    return feedId, err
  }

  // get feed ID
  feedId, err = rs.LastInsertId()
  if err != nil {
    return feedId, err
  }

  // add feed items
  for _, item := range(feed.Items) {
    if err := me.addItem(ctx, tx, feedId, item); err != nil {
      return feedId, err
    }
  }

  // return success
  return feedId, nil
}

// query IDs used by AddCpeMatches()
var addCveFeedsQueryIds = []string {
  "feed/insert",
  "feed/insert-assigner",
  "feed/insert-cve",
  "feed/insert-cve-desc",
  "feed/insert-cve-fts-refresh",
  "feed/insert-cve-problem",
  "feed/insert-cve-problem-desc",
  "feed/insert-cve-ref",
  "feed/insert-cve-ref-tag",
  "feed/insert-desc",
  "feed/insert-item",
  "feed/insert-item-cvss-v2",
  "feed/insert-item-cvss-v3",
}

// Refresh CVE FTS index.
func (me DbStore) refreshCveFts(ctx context.Context, tx Tx) error {
  _, err := tx.Exec(ctx, "feed/insert-cve-fts-refresh")
  return err
}

// Import CVE feeds.
func (me DbStore) AddCveFeeds(ctx context.Context, feeds []nvd_feed.Feed) ([]int64, error) {
  feedIds := make([]int64, len(feeds))

  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return feedIds, err
  }

  // begin transaction
  err := me.Tx(ctx, addCveFeedsQueryIds, func(tx Tx) error {
    for i, feed := range(feeds) {
      // add feed, get feed ID
      if id, err := me.addFeed(ctx, tx, feed); err != nil {
        return err
      } else {
        feedIds[i] = id
      }
    }

    // refresh the cve fts index
    return me.refreshCveFts(ctx, tx)
  })

  // return results
  return feedIds, err
}

// Import single CVE feed.
func (me DbStore) AddCveFeed(ctx context.Context, feed nvd_feed.Feed) (int64, error) {
  if r, err := me.AddCveFeeds(ctx, []nvd_feed.Feed { feed }); err != nil {
    return 0, err
  } else {
    return r[0], nil
  }
}

// search CVEs
func (me DbStore) CveSearch(
  ctx context.Context,
  s string,
) ([]CveSearchRow, error) {
  var r []CveSearchRow

  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return r, err
  }

  // get/exec search query
  err := me.QueryRow(ctx, "feed/search", []interface{} {
    db_sql.Named("q", s),
  }, func(row *db_sql.Row) error {
    var s string
    if err := row.Scan(&s); err != nil {
      return err
    }

    return json.Unmarshal([]byte(s), &r)
  })

  // return results
  return r, err
}

// Add CISA vendor.
//
// Note: This query has an ON CONFLICT(name) DO NOTHING clause, so if
// the name already exists it does nothing.
func (me DbStore) addCisaVendor(ctx context.Context, tx Tx, name string) error {
  _, err := tx.Exec(ctx, "cisa/insert-vendor", string(name))
  return err
}

// Add CISA product.
//
// Note: This query has an ON CONFLICT(name) DO NOTHING clause, so if
// the name already exists it does nothing.
func (me DbStore) addCisaProduct(ctx context.Context, tx Tx, name string) error {
  _, err := tx.Exec(ctx, "cisa/insert-product", string(name))
  return err
}

// Add CISA vulnerability and return vulnerability ID
func (me DbStore) addCisaVuln(ctx context.Context, tx Tx, catId int64, vuln cisa.Vulnerability) error {
  // add vendor (if it does not already exist)
  if err := me.addCisaVendor(ctx, tx, vuln.VendorProject); err != nil {
    return err
  }

  // add product (if it does not already exist)
  if err := me.addCisaProduct(ctx, tx, vuln.Product); err != nil {
    return err
  }

  // exec query
  _, err := tx.Exec(ctx, "cisa/insert-vuln",
    catId,
    vuln.CveId.Year(),
    vuln.CveId.Number(),
    vuln.VendorProject,
    vuln.Product,
    vuln.Name,
    vuln.DateAdded.String(),
    vuln.ShortDescription,
    vuln.RequiredAction,
    vuln.DueDate.String(),
  )

  // return result
  return err
}

// Add CISA catalog and return catalog ID
func (me DbStore) addCisaCatalog(ctx context.Context, tx Tx, cat cisa.Catalog) (int64, error) {
  // return catalog ID
  var catId int64

  // serialize date released
  ts, err := cat.DateReleased.MarshalText()
  if err != nil {
    return catId, err
  }

  // add catalog
  rs, err := tx.Exec(ctx, "cisa/insert", cat.Title, cat.Version, string(ts))
  if err != nil {
    return catId, err
  }

  // get catalog ID
  catId, err = rs.LastInsertId()
  if err != nil {
    return catId, err
  }

  // add catalog vulnerabilities
  for _, vuln := range(cat.Vulnerabilities) {
    if err := me.addCisaVuln(ctx, tx, catId, vuln); err != nil {
      return catId, err
    }
  }

  // return success
  return catId, nil
}

// query IDs used by AddCisaCatalogs()
var addCisaCatalogsQueryIds = []string {
  "cisa/insert",
  "cisa/insert-vendor",
  "cisa/insert-product",
  "cisa/insert-vuln",
  "cisa/insert-fts-refresh",
}

// Refresh CVE FTS index.
func (me DbStore) refreshCisaFts(ctx context.Context, tx Tx) error {
  _, err := tx.Exec(ctx, "cisa/insert-fts-refresh")
  return err
}

// Import CISA Known Exploited Vulnerabilities catalogs.
func (me DbStore) AddCisaCatalogs(ctx context.Context, cats []cisa.Catalog) ([]int64, error) {
  ids := make([]int64, len(cats))

  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return ids, err
  }

  // begin transaction
  err := me.Tx(ctx, addCisaCatalogsQueryIds, func(tx Tx) error {
    for i, cat := range(cats) {
      // add feed, get feed ID
      if id, err := me.addCisaCatalog(ctx, tx, cat); err != nil {
        return err
      } else {
        ids[i] = id
      }
    }

    // refresh the cve fts index
    return me.refreshCisaFts(ctx, tx)
  })

  // return results
  return ids, err
}

// search CISA vulnerabilities.
func (me DbStore) CisaSearch(
  ctx context.Context,
  s string,
) ([]CisaSearchRow, error) {
  var r []CisaSearchRow

  // lazy-init db
  if err := me.Init(ctx); err != nil {
    return r, err
  }

  // get/exec search query
  err := me.QueryRow(ctx, "cisa/search", []interface{} {
    db_sql.Named("q", s),
  }, func(row *db_sql.Row) error {
    var s string
    if err := row.Scan(&s); err != nil {
      return err
    }

    return json.Unmarshal([]byte(s), &r)
  })

  // sort results by rank
  sort.Sort(byRank(r))

  // return results
  return r, err
}