gitlab-security_report_schemas 0.1.0.min15.0.0.max15.1.4 → 0.1.0.min15.1.0.max15.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (88) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -3
  3. data/README.md +10 -14
  4. data/Rakefile +1 -1
  5. data/gem_version +1 -1
  6. data/lib/gitlab/security_report_schemas/configuration.rb +2 -2
  7. data/lib/gitlab/security_report_schemas/version.rb +2 -0
  8. data/supported_versions +0 -11
  9. metadata +2 -81
  10. data/RUNBOOK.md +0 -28
  11. data/schemas/15.0.0/cluster-image-scanning-report-format.json +0 -946
  12. data/schemas/15.0.0/container-scanning-report-format.json +0 -880
  13. data/schemas/15.0.0/coverage-fuzzing-report-format.json +0 -836
  14. data/schemas/15.0.0/dast-report-format.json +0 -1241
  15. data/schemas/15.0.0/dependency-scanning-report-format.json +0 -944
  16. data/schemas/15.0.0/sast-report-format.json +0 -831
  17. data/schemas/15.0.0/secret-detection-report-format.json +0 -854
  18. data/schemas/15.0.1/cluster-image-scanning-report-format.json +0 -980
  19. data/schemas/15.0.1/container-scanning-report-format.json +0 -914
  20. data/schemas/15.0.1/coverage-fuzzing-report-format.json +0 -870
  21. data/schemas/15.0.1/dast-report-format.json +0 -1275
  22. data/schemas/15.0.1/dependency-scanning-report-format.json +0 -978
  23. data/schemas/15.0.1/sast-report-format.json +0 -865
  24. data/schemas/15.0.1/secret-detection-report-format.json +0 -888
  25. data/schemas/15.0.2/cluster-image-scanning-report-format.json +0 -980
  26. data/schemas/15.0.2/container-scanning-report-format.json +0 -912
  27. data/schemas/15.0.2/coverage-fuzzing-report-format.json +0 -870
  28. data/schemas/15.0.2/dast-report-format.json +0 -1275
  29. data/schemas/15.0.2/dependency-scanning-report-format.json +0 -978
  30. data/schemas/15.0.2/sast-report-format.json +0 -865
  31. data/schemas/15.0.2/secret-detection-report-format.json +0 -888
  32. data/schemas/15.0.4/cluster-image-scanning-report-format.json +0 -984
  33. data/schemas/15.0.4/container-scanning-report-format.json +0 -916
  34. data/schemas/15.0.4/coverage-fuzzing-report-format.json +0 -874
  35. data/schemas/15.0.4/dast-report-format.json +0 -1279
  36. data/schemas/15.0.4/dependency-scanning-report-format.json +0 -982
  37. data/schemas/15.0.4/sast-report-format.json +0 -869
  38. data/schemas/15.0.4/secret-detection-report-format.json +0 -893
  39. data/schemas/15.0.5/cluster-image-scanning-report-format.json +0 -1035
  40. data/schemas/15.0.5/container-scanning-report-format.json +0 -967
  41. data/schemas/15.0.5/coverage-fuzzing-report-format.json +0 -925
  42. data/schemas/15.0.5/dast-report-format.json +0 -1330
  43. data/schemas/15.0.5/dependency-scanning-report-format.json +0 -1033
  44. data/schemas/15.0.5/sast-report-format.json +0 -920
  45. data/schemas/15.0.5/secret-detection-report-format.json +0 -944
  46. data/schemas/15.0.6/cluster-image-scanning-report-format.json +0 -1035
  47. data/schemas/15.0.6/container-scanning-report-format.json +0 -967
  48. data/schemas/15.0.6/coverage-fuzzing-report-format.json +0 -925
  49. data/schemas/15.0.6/dast-report-format.json +0 -1330
  50. data/schemas/15.0.6/dependency-scanning-report-format.json +0 -1033
  51. data/schemas/15.0.6/sast-report-format.json +0 -920
  52. data/schemas/15.0.6/secret-detection-report-format.json +0 -944
  53. data/schemas/15.0.7/cluster-image-scanning-report-format.json +0 -1085
  54. data/schemas/15.0.7/container-scanning-report-format.json +0 -1017
  55. data/schemas/15.0.7/coverage-fuzzing-report-format.json +0 -975
  56. data/schemas/15.0.7/dast-report-format.json +0 -1380
  57. data/schemas/15.0.7/dependency-scanning-report-format.json +0 -1083
  58. data/schemas/15.0.7/sast-report-format.json +0 -970
  59. data/schemas/15.0.7/secret-detection-report-format.json +0 -994
  60. data/schemas/15.1.1/cluster-image-scanning-report-format.json +0 -1065
  61. data/schemas/15.1.1/container-scanning-for-registry-report-format.json +0 -0
  62. data/schemas/15.1.1/container-scanning-report-format.json +0 -998
  63. data/schemas/15.1.1/coverage-fuzzing-report-format.json +0 -975
  64. data/schemas/15.1.1/dast-report-format.json +0 -1380
  65. data/schemas/15.1.1/dependency-scanning-report-format.json +0 -986
  66. data/schemas/15.1.1/sast-report-format.json +0 -970
  67. data/schemas/15.1.1/secret-detection-report-format.json +0 -994
  68. data/schemas/15.1.2/cluster-image-scanning-report-format.json +0 -1190
  69. data/schemas/15.1.2/container-scanning-report-format.json +0 -1123
  70. data/schemas/15.1.2/coverage-fuzzing-report-format.json +0 -1100
  71. data/schemas/15.1.2/dast-report-format.json +0 -1505
  72. data/schemas/15.1.2/dependency-scanning-report-format.json +0 -1111
  73. data/schemas/15.1.2/sast-report-format.json +0 -1095
  74. data/schemas/15.1.2/secret-detection-report-format.json +0 -1119
  75. data/schemas/15.1.3/cluster-image-scanning-report-format.json +0 -1190
  76. data/schemas/15.1.3/container-scanning-report-format.json +0 -1123
  77. data/schemas/15.1.3/coverage-fuzzing-report-format.json +0 -1100
  78. data/schemas/15.1.3/dast-report-format.json +0 -1505
  79. data/schemas/15.1.3/dependency-scanning-report-format.json +0 -1111
  80. data/schemas/15.1.3/sast-report-format.json +0 -1095
  81. data/schemas/15.1.3/secret-detection-report-format.json +0 -1119
  82. data/schemas/15.1.4/cluster-image-scanning-report-format.json +0 -1190
  83. data/schemas/15.1.4/container-scanning-report-format.json +0 -1123
  84. data/schemas/15.1.4/coverage-fuzzing-report-format.json +0 -1100
  85. data/schemas/15.1.4/dast-report-format.json +0 -1505
  86. data/schemas/15.1.4/dependency-scanning-report-format.json +0 -1111
  87. data/schemas/15.1.4/sast-report-format.json +0 -1095
  88. data/schemas/15.1.4/secret-detection-report-format.json +0 -1119
data/schemas/15.0.4/dependency-scanning-report-format.json DELETED
@@ -1,982 +0,0 @@
1
- {
2
- "$schema": "http://json-schema.org/draft-07/schema#",
3
- "$id": "https://gitlab.com/gitlab-org/security-products/security-report-schemas/-/raw/master/dist/dependency-scanning-report-format.json",
4
- "title": "Report format for GitLab Dependency Scanning",
5
- "description": "This schema provides the the report format for Dependency Scanning analyzers (https://docs.gitlab.com/ee/user/application_security/dependency_scanning).",
6
- "definitions": {
7
- "detail_type": {
8
- "oneOf": [
9
- {
10
- "$ref": "#/definitions/named_list"
11
- },
12
- {
13
- "$ref": "#/definitions/list"
14
- },
15
- {
16
- "$ref": "#/definitions/table"
17
- },
18
- {
19
- "$ref": "#/definitions/text"
20
- },
21
- {
22
- "$ref": "#/definitions/url"
23
- },
24
- {
25
- "$ref": "#/definitions/code"
26
- },
27
- {
28
- "$ref": "#/definitions/value"
29
- },
30
- {
31
- "$ref": "#/definitions/diff"
32
- },
33
- {
34
- "$ref": "#/definitions/markdown"
35
- },
36
- {
37
- "$ref": "#/definitions/commit"
38
- },
39
- {
40
- "$ref": "#/definitions/file_location"
41
- },
42
- {
43
- "$ref": "#/definitions/module_location"
44
- }
45
- ]
46
- },
47
- "text_value": {
48
- "type": "string"
49
- },
50
- "named_field": {
51
- "type": "object",
52
- "required": [
53
- "name"
54
- ],
55
- "properties": {
56
- "name": {
57
- "$ref": "#/definitions/text_value",
58
- "type": "string",
59
- "minLength": 1
60
- },
61
- "description": {
62
- "$ref": "#/definitions/text_value"
63
- }
64
- }
65
- },
66
- "named_list": {
67
- "type": "object",
68
- "description": "An object with named and typed fields",
69
- "required": [
70
- "type",
71
- "items"
72
- ],
73
- "properties": {
74
- "type": {
75
- "const": "named-list"
76
- },
77
- "items": {
78
- "type": "object",
79
- "patternProperties": {
80
- "^.*$": {
81
- "allOf": [
82
- {
83
- "$ref": "#/definitions/named_field"
84
- },
85
- {
86
- "$ref": "#/definitions/detail_type"
87
- }
88
- ]
89
- }
90
- }
91
- }
92
- }
93
- },
94
- "list": {
95
- "type": "object",
96
- "description": "A list of typed fields",
97
- "required": [
98
- "type",
99
- "items"
100
- ],
101
- "properties": {
102
- "type": {
103
- "const": "list"
104
- },
105
- "items": {
106
- "type": "array",
107
- "items": {
108
- "$ref": "#/definitions/detail_type"
109
- }
110
- }
111
- }
112
- },
113
- "table": {
114
- "type": "object",
115
- "description": "A table of typed fields",
116
- "required": [
117
- "type",
118
- "rows"
119
- ],
120
- "properties": {
121
- "type": {
122
- "const": "table"
123
- },
124
- "header": {
125
- "type": "array",
126
- "items": {
127
- "$ref": "#/definitions/detail_type"
128
- }
129
- },
130
- "rows": {
131
- "type": "array",
132
- "items": {
133
- "type": "array",
134
- "items": {
135
- "$ref": "#/definitions/detail_type"
136
- }
137
- }
138
- }
139
- }
140
- },
141
- "text": {
142
- "type": "object",
143
- "description": "Raw text",
144
- "required": [
145
- "type",
146
- "value"
147
- ],
148
- "properties": {
149
- "type": {
150
- "const": "text"
151
- },
152
- "value": {
153
- "$ref": "#/definitions/text_value"
154
- }
155
- }
156
- },
157
- "url": {
158
- "type": "object",
159
- "description": "A single URL",
160
- "required": [
161
- "type",
162
- "href"
163
- ],
164
- "properties": {
165
- "type": {
166
- "const": "url"
167
- },
168
- "text": {
169
- "$ref": "#/definitions/text_value"
170
- },
171
- "href": {
172
- "type": "string",
173
- "minLength": 1,
174
- "examples": [
175
- "http://mysite.com"
176
- ]
177
- }
178
- }
179
- },
180
- "code": {
181
- "type": "object",
182
- "description": "A codeblock",
183
- "required": [
184
- "type",
185
- "value"
186
- ],
187
- "properties": {
188
- "type": {
189
- "const": "code"
190
- },
191
- "value": {
192
- "type": "string"
193
- },
194
- "lang": {
195
- "type": "string",
196
- "description": "A programming language"
197
- }
198
- }
199
- },
200
- "value": {
201
- "type": "object",
202
- "description": "A field that can store a range of types of value",
203
- "required": [
204
- "type",
205
- "value"
206
- ],
207
- "properties": {
208
- "type": {
209
- "const": "value"
210
- },
211
- "value": {
212
- "type": [
213
- "number",
214
- "string",
215
- "boolean"
216
- ]
217
- }
218
- }
219
- },
220
- "diff": {
221
- "type": "object",
222
- "description": "A diff",
223
- "required": [
224
- "type",
225
- "before",
226
- "after"
227
- ],
228
- "properties": {
229
- "type": {
230
- "const": "diff"
231
- },
232
- "before": {
233
- "type": "string"
234
- },
235
- "after": {
236
- "type": "string"
237
- }
238
- }
239
- },
240
- "markdown": {
241
- "type": "object",
242
- "description": "GitLab flavoured markdown, see https://docs.gitlab.com/ee/user/markdown.html",
243
- "required": [
244
- "type",
245
- "value"
246
- ],
247
- "properties": {
248
- "type": {
249
- "const": "markdown"
250
- },
251
- "value": {
252
- "$ref": "#/definitions/text_value",
253
- "examples": [
254
- "Here is markdown `inline code` #1 [test](gitlab.com)\n\n![GitLab Logo](https://about.gitlab.com/images/press/logo/preview/gitlab-logo-white-preview.png)"
255
- ]
256
- }
257
- }
258
- },
259
- "commit": {
260
- "type": "object",
261
- "description": "A commit/tag/branch within the GitLab project",
262
- "required": [
263
- "type",
264
- "value"
265
- ],
266
- "properties": {
267
- "type": {
268
- "const": "commit"
269
- },
270
- "value": {
271
- "type": "string",
272
- "description": "The commit SHA",
273
- "minLength": 1
274
- }
275
- }
276
- },
277
- "file_location": {
278
- "type": "object",
279
- "description": "A location within a file in the project",
280
- "required": [
281
- "type",
282
- "file_name",
283
- "line_start"
284
- ],
285
- "properties": {
286
- "type": {
287
- "const": "file-location"
288
- },
289
- "file_name": {
290
- "type": "string",
291
- "minLength": 1
292
- },
293
- "line_start": {
294
- "type": "integer"
295
- },
296
- "line_end": {
297
- "type": "integer"
298
- }
299
- }
300
- },
301
- "module_location": {
302
- "type": "object",
303
- "description": "A location within a binary module of the form module+relative_offset",
304
- "required": [
305
- "type",
306
- "module_name",
307
- "offset"
308
- ],
309
- "properties": {
310
- "type": {
311
- "const": "module-location"
312
- },
313
- "module_name": {
314
- "type": "string",
315
- "minLength": 1,
316
- "examples": [
317
- "compiled_binary"
318
- ]
319
- },
320
- "offset": {
321
- "type": "integer",
322
- "examples": [
323
- 100
324
- ]
325
- }
326
- }
327
- }
328
- },
329
- "self": {
330
- "version": "15.0.4"
331
- },
332
- "type": "object",
333
- "required": [
334
- "dependency_files",
335
- "scan",
336
- "version",
337
- "vulnerabilities"
338
- ],
339
- "additionalProperties": true,
340
- "properties": {
341
- "scan": {
342
- "type": "object",
343
- "required": [
344
- "analyzer",
345
- "end_time",
346
- "scanner",
347
- "start_time",
348
- "status",
349
- "type"
350
- ],
351
- "properties": {
352
- "end_time": {
353
- "type": "string",
354
- "description": "ISO8601 UTC value with format yyyy-mm-ddThh:mm:ss, representing when the scan finished.",
355
- "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$",
356
- "examples": [
357
- "2020-01-28T03:26:02"
358
- ]
359
- },
360
- "messages": {
361
- "type": "array",
362
- "items": {
363
- "type": "object",
364
- "description": "Communication intended for the initiator of a scan.",
365
- "required": [
366
- "level",
367
- "value"
368
- ],
369
- "properties": {
370
- "level": {
371
- "type": "string",
372
- "description": "Describes the severity of the communication. Use info to communicate normal scan behaviour; warn to communicate a potentially recoverable problem, or a partial error; fatal to communicate an issue that causes the scan to halt.",
373
- "enum": [
374
- "info",
375
- "warn",
376
- "fatal"
377
- ],
378
- "examples": [
379
- "info"
380
- ]
381
- },
382
- "value": {
383
- "type": "string",
384
- "description": "The message to communicate.",
385
- "minLength": 1,
386
- "examples": [
387
- "Permission denied, scanning aborted"
388
- ]
389
- }
390
- }
391
- }
392
- },
393
- "analyzer": {
394
- "type": "object",
395
- "description": "Object defining the analyzer used to perform the scan. Analyzers typically delegate to an underlying scanner to run the scan.",
396
- "required": [
397
- "id",
398
- "name",
399
- "version",
400
- "vendor"
401
- ],
402
- "properties": {
403
- "id": {
404
- "type": "string",
405
- "description": "Unique id that identifies the analyzer.",
406
- "minLength": 1,
407
- "examples": [
408
- "gitlab-dast"
409
- ]
410
- },
411
- "name": {
412
- "type": "string",
413
- "description": "A human readable value that identifies the analyzer, not required to be unique.",
414
- "minLength": 1,
415
- "examples": [
416
- "GitLab DAST"
417
- ]
418
- },
419
- "url": {
420
- "type": "string",
421
- "pattern": "^https?://.+",
422
- "description": "A link to more information about the analyzer.",
423
- "examples": [
424
- "https://docs.gitlab.com/ee/user/application_security/dast"
425
- ]
426
- },
427
- "vendor": {
428
- "description": "The vendor/maintainer of the analyzer.",
429
- "type": "object",
430
- "required": [
431
- "name"
432
- ],
433
- "properties": {
434
- "name": {
435
- "type": "string",
436
- "description": "The name of the vendor.",
437
- "minLength": 1,
438
- "examples": [
439
- "GitLab"
440
- ]
441
- }
442
- }
443
- },
444
- "version": {
445
- "type": "string",
446
- "description": "The version of the analyzer.",
447
- "minLength": 1,
448
- "examples": [
449
- "1.0.2"
450
- ]
451
- }
452
- }
453
- },
454
- "scanner": {
455
- "type": "object",
456
- "description": "Object defining the scanner used to perform the scan.",
457
- "required": [
458
- "id",
459
- "name",
460
- "version",
461
- "vendor"
462
- ],
463
- "properties": {
464
- "id": {
465
- "type": "string",
466
- "description": "Unique id that identifies the scanner.",
467
- "minLength": 1,
468
- "examples": [
469
- "my-sast-scanner"
470
- ]
471
- },
472
- "name": {
473
- "type": "string",
474
- "description": "A human readable value that identifies the scanner, not required to be unique.",
475
- "minLength": 1,
476
- "examples": [
477
- "My SAST Scanner"
478
- ]
479
- },
480
- "url": {
481
- "type": "string",
482
- "description": "A link to more information about the scanner.",
483
- "examples": [
484
- "https://scanner.url"
485
- ]
486
- },
487
- "version": {
488
- "type": "string",
489
- "description": "The version of the scanner.",
490
- "minLength": 1,
491
- "examples": [
492
- "1.0.2"
493
- ]
494
- },
495
- "vendor": {
496
- "description": "The vendor/maintainer of the scanner.",
497
- "type": "object",
498
- "required": [
499
- "name"
500
- ],
501
- "properties": {
502
- "name": {
503
- "type": "string",
504
- "description": "The name of the vendor.",
505
- "minLength": 1,
506
- "examples": [
507
- "GitLab"
508
- ]
509
- }
510
- }
511
- }
512
- }
513
- },
514
- "start_time": {
515
- "type": "string",
516
- "description": "ISO8601 UTC value with format yyyy-mm-ddThh:mm:ss, representing when the scan started.",
517
- "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$",
518
- "examples": [
519
- "2020-02-14T16:01:59"
520
- ]
521
- },
522
- "status": {
523
- "type": "string",
524
- "description": "Result of the scan.",
525
- "enum": [
526
- "success",
527
- "failure"
528
- ]
529
- },
530
- "type": {
531
- "type": "string",
532
- "description": "Type of the scan.",
533
- "enum": [
534
- "dependency_scanning"
535
- ]
536
- },
537
- "primary_identifiers": {
538
- "type": "array",
539
- "description": "An unordered array containing an exhaustive list of primary identifiers for which the analyzer may return results",
540
- "items": {
541
- "type": "object",
542
- "required": [
543
- "type",
544
- "name",
545
- "value"
546
- ],
547
- "properties": {
548
- "type": {
549
- "type": "string",
550
- "description": "for example, cve, cwe, osvdb, usn, or an analyzer-dependent type such as gemnasium).",
551
- "minLength": 1
552
- },
553
- "name": {
554
- "type": "string",
555
- "description": "Human-readable name of the identifier.",
556
- "minLength": 1
557
- },
558
- "url": {
559
- "type": "string",
560
- "description": "URL of the identifier's documentation.",
561
- "pattern": "^https?://.+"
562
- },
563
- "value": {
564
- "type": "string",
565
- "description": "Value of the identifier, for matching purpose.",
566
- "minLength": 1
567
- }
568
- }
569
- }
570
- }
571
- }
572
- },
573
- "schema": {
574
- "type": "string",
575
- "description": "URI pointing to the validating security report schema.",
576
- "pattern": "^https?://.+"
577
- },
578
- "version": {
579
- "type": "string",
580
- "description": "The version of the schema to which the JSON report conforms.",
581
- "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
582
- },
583
- "vulnerabilities": {
584
- "type": "array",
585
- "description": "Array of vulnerability objects.",
586
- "items": {
587
- "type": "object",
588
- "description": "Describes the vulnerability using GitLab Flavored Markdown",
589
- "required": [
590
- "id",
591
- "identifiers",
592
- "location"
593
- ],
594
- "properties": {
595
- "id": {
596
- "type": "string",
597
- "minLength": 1,
598
- "description": "Unique identifier of the vulnerability. This is recommended to be a UUID.",
599
- "examples": [
600
- "642735a5-1425-428d-8d4e-3c854885a3c9"
601
- ]
602
- },
603
- "name": {
604
- "type": "string",
605
- "maxLength": 255,
606
- "description": "The name of the vulnerability. This must not include the finding's specific information."
607
- },
608
- "description": {
609
- "type": "string",
610
- "maxLength": 1048576,
611
- "description": "A long text section describing the vulnerability more fully."
612
- },
613
- "severity": {
614
- "type": "string",
615
- "description": "How much the vulnerability impacts the software. Possible values are Info, Unknown, Low, Medium, High, or Critical. Note that some analyzers may not report all these possible values.",
616
- "enum": [
617
- "Info",
618
- "Unknown",
619
- "Low",
620
- "Medium",
621
- "High",
622
- "Critical"
623
- ]
624
- },
625
- "solution": {
626
- "type": "string",
627
- "maxLength": 7000,
628
- "description": "Explanation of how to fix the vulnerability."
629
- },
630
- "identifiers": {
631
- "type": "array",
632
- "minItems": 1,
633
- "description": "An ordered array of references that identify a vulnerability on internal or external databases. The first identifier is the Primary Identifier, which has special meaning.",
634
- "items": {
635
- "type": "object",
636
- "required": [
637
- "type",
638
- "name",
639
- "value"
640
- ],
641
- "properties": {
642
- "type": {
643
- "type": "string",
644
- "description": "for example, cve, cwe, osvdb, usn, or an analyzer-dependent type such as gemnasium).",
645
- "minLength": 1
646
- },
647
- "name": {
648
- "type": "string",
649
- "description": "Human-readable name of the identifier.",
650
- "minLength": 1
651
- },
652
- "url": {
653
- "type": "string",
654
- "description": "URL of the identifier's documentation.",
655
- "pattern": "^https?://.+"
656
- },
657
- "value": {
658
- "type": "string",
659
- "description": "Value of the identifier, for matching purpose.",
660
- "minLength": 1
661
- }
662
- }
663
- }
664
- },
665
- "links": {
666
- "type": "array",
667
- "description": "An array of references to external documentation or articles that describe the vulnerability.",
668
- "items": {
669
- "type": "object",
670
- "required": [
671
- "url"
672
- ],
673
- "properties": {
674
- "name": {
675
- "type": "string",
676
- "description": "Name of the vulnerability details link."
677
- },
678
- "url": {
679
- "type": "string",
680
- "description": "URL of the vulnerability details document.",
681
- "pattern": "^https?://.+"
682
- }
683
- }
684
- }
685
- },
686
- "details": {
687
- "$ref": "#/definitions/named_list/properties/items"
688
- },
689
- "tracking": {
690
- "type": "object",
691
- "description": "Describes how this vulnerability should be tracked as the project changes.",
692
- "oneOf": [
693
- {
694
- "description": "Declares that a series of items should be tracked using source-specific tracking methods.",
695
- "required": [
696
- "items"
697
- ],
698
- "properties": {
699
- "type": {
700
- "const": "source"
701
- },
702
- "items": {
703
- "type": "array",
704
- "items": {
705
- "description": "An item that should be tracked using source-specific tracking methods.",
706
- "type": "object",
707
- "required": [
708
- "signatures"
709
- ],
710
- "properties": {
711
- "file": {
712
- "type": "string",
713
- "description": "Path to the file where the vulnerability is located."
714
- },
715
- "start_line": {
716
- "type": "number",
717
- "description": "The first line of the file that includes the vulnerability."
718
- },
719
- "end_line": {
720
- "type": "number",
721
- "description": "The last line of the file that includes the vulnerability."
722
- },
723
- "signatures": {
724
- "type": "array",
725
- "description": "An array of calculated tracking signatures for this tracking item.",
726
- "minItems": 1,
727
- "items": {
728
- "description": "A calculated tracking signature value and metadata.",
729
- "type": "object",
730
- "required": [
731
- "algorithm",
732
- "value"
733
- ],
734
- "properties": {
735
- "algorithm": {
736
- "type": "string",
737
- "description": "The algorithm used to generate the signature."
738
- },
739
- "value": {
740
- "type": "string",
741
- "description": "The result of this signature algorithm."
742
- }
743
- }
744
- }
745
- }
746
- }
747
- }
748
- }
749
- }
750
- }
751
- ],
752
- "properties": {
753
- "type": {
754
- "type": "string",
755
- "description": "Each tracking type must declare its own type."
756
- }
757
- }
758
- },
759
- "flags": {
760
- "description": "Flags that can be attached to vulnerabilities.",
761
- "type": "array",
762
- "items": {
763
- "type": "object",
764
- "description": "Informational flags identified and assigned to a vulnerability.",
765
- "required": [
766
- "type",
767
- "origin",
768
- "description"
769
- ],
770
- "properties": {
771
- "type": {
772
- "type": "string",
773
- "minLength": 1,
774
- "description": "Result of the scan.",
775
- "enum": [
776
- "flagged-as-likely-false-positive"
777
- ]
778
- },
779
- "origin": {
780
- "minLength": 1,
781
- "description": "Tool that issued the flag.",
782
- "type": "string"
783
- },
784
- "description": {
785
- "minLength": 1,
786
- "description": "What the flag is about.",
787
- "type": "string"
788
- }
789
- }
790
- }
791
- },
792
- "location": {
793
- "type": "object",
794
- "description": "Identifies the vulnerability's location.",
795
- "required": [
796
- "file",
797
- "dependency"
798
- ],
799
- "properties": {
800
- "file": {
801
- "type": "string",
802
- "minLength": 1,
803
- "description": "Path to the manifest or lock file where the dependency is declared (such as yarn.lock)."
804
- },
805
- "dependency": {
806
- "type": "object",
807
- "description": "Describes the dependency of a project where the vulnerability is located.",
808
- "required": [
809
- "package",
810
- "version"
811
- ],
812
- "properties": {
813
- "package": {
814
- "type": "object",
815
- "description": "Provides information on the package where the vulnerability is located.",
816
- "required": [
817
- "name"
818
- ],
819
- "properties": {
820
- "name": {
821
- "type": "string",
822
- "description": "Name of the package where the vulnerability is located."
823
- }
824
- }
825
- },
826
- "version": {
827
- "type": "string",
828
- "description": "Version of the vulnerable package."
829
- },
830
- "iid": {
831
- "description": "ID that identifies the dependency in the scope of a dependency file.",
832
- "type": "number"
833
- },
834
- "direct": {
835
- "type": "boolean",
836
- "description": "Tells whether this is a direct, top-level dependency of the scanned project."
837
- },
838
- "dependency_path": {
839
- "type": "array",
840
- "description": "Ancestors of the dependency, starting from a direct project dependency, and ending with an immediate parent of the dependency. The dependency itself is excluded from the path. Direct dependencies have no path.",
841
- "items": {
842
- "type": "object",
843
- "required": [
844
- "iid"
845
- ],
846
- "properties": {
847
- "iid": {
848
- "type": "number",
849
- "description": "ID that is unique in the scope of a parent object, and specific to the resource type."
850
- }
851
- }
852
- }
853
- }
854
- }
855
- }
856
- }
857
- }
858
- }
859
- }
860
- },
861
- "remediations": {
862
- "type": "array",
863
- "description": "An array of objects containing information on available remediations, along with patch diffs to apply.",
864
- "items": {
865
- "type": "object",
866
- "required": [
867
- "fixes",
868
- "summary",
869
- "diff"
870
- ],
871
- "properties": {
872
- "fixes": {
873
- "type": "array",
874
- "description": "An array of strings that represent references to vulnerabilities fixed by this remediation.",
875
- "items": {
876
- "type": "object",
877
- "required": [
878
- "id"
879
- ],
880
- "properties": {
881
- "id": {
882
- "type": "string",
883
- "minLength": 1,
884
- "description": "Unique identifier of the vulnerability. This is recommended to be a UUID.",
885
- "examples": [
886
- "642735a5-1425-428d-8d4e-3c854885a3c9"
887
- ]
888
- }
889
- }
890
- }
891
- },
892
- "summary": {
893
- "type": "string",
894
- "minLength": 1,
895
- "description": "An overview of how the vulnerabilities were fixed."
896
- },
897
- "diff": {
898
- "type": "string",
899
- "minLength": 1,
900
- "description": "A base64-encoded remediation code diff, compatible with git apply."
901
- }
902
- }
903
- }
904
- },
905
- "dependency_files": {
906
- "type": "array",
907
- "description": "List of dependency files identified in the project.",
908
- "items": {
909
- "type": "object",
910
- "required": [
911
- "path",
912
- "package_manager",
913
- "dependencies"
914
- ],
915
- "properties": {
916
- "path": {
917
- "type": "string",
918
- "minLength": 1
919
- },
920
- "package_manager": {
921
- "type": "string",
922
- "minLength": 1
923
- },
924
- "dependencies": {
925
- "type": "array",
926
- "items": {
927
- "type": "object",
928
- "description": "Describes the dependency of a project where the vulnerability is located.",
929
- "required": [
930
- "package",
931
- "version"
932
- ],
933
- "properties": {
934
- "package": {
935
- "type": "object",
936
- "description": "Provides information on the package where the vulnerability is located.",
937
- "required": [
938
- "name"
939
- ],
940
- "properties": {
941
- "name": {
942
- "type": "string",
943
- "description": "Name of the package where the vulnerability is located."
944
- }
945
- }
946
- },
947
- "version": {
948
- "type": "string",
949
- "description": "Version of the vulnerable package."
950
- },
951
- "iid": {
952
- "description": "ID that identifies the dependency in the scope of a dependency file.",
953
- "type": "number"
954
- },
955
- "direct": {
956
- "type": "boolean",
957
- "description": "Tells whether this is a direct, top-level dependency of the scanned project."
958
- },
959
- "dependency_path": {
960
- "type": "array",
961
- "description": "Ancestors of the dependency, starting from a direct project dependency, and ending with an immediate parent of the dependency. The dependency itself is excluded from the path. Direct dependencies have no path.",
962
- "items": {
963
- "type": "object",
964
- "required": [
965
- "iid"
966
- ],
967
- "properties": {
968
- "iid": {
969
- "type": "number",
970
- "description": "ID that is unique in the scope of a parent object, and specific to the resource type."
971
- }
972
- }
973
- }
974
- }
975
- }
976
- }
977
- }
978
- }
979
- }
980
- }
981
- }
982
- }