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
@@ -1,869 +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/sast-report-format.json",
4
- "title": "Report format for GitLab SAST",
5
- "description": "This schema provides the report format for Static Application Security Testing analyzers (https://docs.gitlab.com/ee/user/application_security/sast).",
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
- "scan",
335
- "version",
336
- "vulnerabilities"
337
- ],
338
- "additionalProperties": true,
339
- "properties": {
340
- "scan": {
341
- "type": "object",
342
- "required": [
343
- "analyzer",
344
- "end_time",
345
- "scanner",
346
- "start_time",
347
- "status",
348
- "type"
349
- ],
350
- "properties": {
351
- "end_time": {
352
- "type": "string",
353
- "description": "ISO8601 UTC value with format yyyy-mm-ddThh:mm:ss, representing when the scan finished.",
354
- "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$",
355
- "examples": [
356
- "2020-01-28T03:26:02"
357
- ]
358
- },
359
- "messages": {
360
- "type": "array",
361
- "items": {
362
- "type": "object",
363
- "description": "Communication intended for the initiator of a scan.",
364
- "required": [
365
- "level",
366
- "value"
367
- ],
368
- "properties": {
369
- "level": {
370
- "type": "string",
371
- "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.",
372
- "enum": [
373
- "info",
374
- "warn",
375
- "fatal"
376
- ],
377
- "examples": [
378
- "info"
379
- ]
380
- },
381
- "value": {
382
- "type": "string",
383
- "description": "The message to communicate.",
384
- "minLength": 1,
385
- "examples": [
386
- "Permission denied, scanning aborted"
387
- ]
388
- }
389
- }
390
- }
391
- },
392
- "analyzer": {
393
- "type": "object",
394
- "description": "Object defining the analyzer used to perform the scan. Analyzers typically delegate to an underlying scanner to run the scan.",
395
- "required": [
396
- "id",
397
- "name",
398
- "version",
399
- "vendor"
400
- ],
401
- "properties": {
402
- "id": {
403
- "type": "string",
404
- "description": "Unique id that identifies the analyzer.",
405
- "minLength": 1,
406
- "examples": [
407
- "gitlab-dast"
408
- ]
409
- },
410
- "name": {
411
- "type": "string",
412
- "description": "A human readable value that identifies the analyzer, not required to be unique.",
413
- "minLength": 1,
414
- "examples": [
415
- "GitLab DAST"
416
- ]
417
- },
418
- "url": {
419
- "type": "string",
420
- "pattern": "^https?://.+",
421
- "description": "A link to more information about the analyzer.",
422
- "examples": [
423
- "https://docs.gitlab.com/ee/user/application_security/dast"
424
- ]
425
- },
426
- "vendor": {
427
- "description": "The vendor/maintainer of the analyzer.",
428
- "type": "object",
429
- "required": [
430
- "name"
431
- ],
432
- "properties": {
433
- "name": {
434
- "type": "string",
435
- "description": "The name of the vendor.",
436
- "minLength": 1,
437
- "examples": [
438
- "GitLab"
439
- ]
440
- }
441
- }
442
- },
443
- "version": {
444
- "type": "string",
445
- "description": "The version of the analyzer.",
446
- "minLength": 1,
447
- "examples": [
448
- "1.0.2"
449
- ]
450
- }
451
- }
452
- },
453
- "scanner": {
454
- "type": "object",
455
- "description": "Object defining the scanner used to perform the scan.",
456
- "required": [
457
- "id",
458
- "name",
459
- "version",
460
- "vendor"
461
- ],
462
- "properties": {
463
- "id": {
464
- "type": "string",
465
- "description": "Unique id that identifies the scanner.",
466
- "minLength": 1,
467
- "examples": [
468
- "my-sast-scanner"
469
- ]
470
- },
471
- "name": {
472
- "type": "string",
473
- "description": "A human readable value that identifies the scanner, not required to be unique.",
474
- "minLength": 1,
475
- "examples": [
476
- "My SAST Scanner"
477
- ]
478
- },
479
- "url": {
480
- "type": "string",
481
- "description": "A link to more information about the scanner.",
482
- "examples": [
483
- "https://scanner.url"
484
- ]
485
- },
486
- "version": {
487
- "type": "string",
488
- "description": "The version of the scanner.",
489
- "minLength": 1,
490
- "examples": [
491
- "1.0.2"
492
- ]
493
- },
494
- "vendor": {
495
- "description": "The vendor/maintainer of the scanner.",
496
- "type": "object",
497
- "required": [
498
- "name"
499
- ],
500
- "properties": {
501
- "name": {
502
- "type": "string",
503
- "description": "The name of the vendor.",
504
- "minLength": 1,
505
- "examples": [
506
- "GitLab"
507
- ]
508
- }
509
- }
510
- }
511
- }
512
- },
513
- "start_time": {
514
- "type": "string",
515
- "description": "ISO8601 UTC value with format yyyy-mm-ddThh:mm:ss, representing when the scan started.",
516
- "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$",
517
- "examples": [
518
- "2020-02-14T16:01:59"
519
- ]
520
- },
521
- "status": {
522
- "type": "string",
523
- "description": "Result of the scan.",
524
- "enum": [
525
- "success",
526
- "failure"
527
- ]
528
- },
529
- "type": {
530
- "type": "string",
531
- "description": "Type of the scan.",
532
- "enum": [
533
- "sast"
534
- ]
535
- },
536
- "primary_identifiers": {
537
- "type": "array",
538
- "description": "An unordered array containing an exhaustive list of primary identifiers for which the analyzer may return results",
539
- "items": {
540
- "type": "object",
541
- "required": [
542
- "type",
543
- "name",
544
- "value"
545
- ],
546
- "properties": {
547
- "type": {
548
- "type": "string",
549
- "description": "for example, cve, cwe, osvdb, usn, or an analyzer-dependent type such as gemnasium).",
550
- "minLength": 1
551
- },
552
- "name": {
553
- "type": "string",
554
- "description": "Human-readable name of the identifier.",
555
- "minLength": 1
556
- },
557
- "url": {
558
- "type": "string",
559
- "description": "URL of the identifier's documentation.",
560
- "pattern": "^https?://.+"
561
- },
562
- "value": {
563
- "type": "string",
564
- "description": "Value of the identifier, for matching purpose.",
565
- "minLength": 1
566
- }
567
- }
568
- }
569
- }
570
- }
571
- },
572
- "schema": {
573
- "type": "string",
574
- "description": "URI pointing to the validating security report schema.",
575
- "pattern": "^https?://.+"
576
- },
577
- "version": {
578
- "type": "string",
579
- "description": "The version of the schema to which the JSON report conforms.",
580
- "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
581
- },
582
- "vulnerabilities": {
583
- "type": "array",
584
- "description": "Array of vulnerability objects.",
585
- "items": {
586
- "type": "object",
587
- "description": "Describes the vulnerability using GitLab Flavored Markdown",
588
- "required": [
589
- "id",
590
- "identifiers",
591
- "location"
592
- ],
593
- "properties": {
594
- "id": {
595
- "type": "string",
596
- "minLength": 1,
597
- "description": "Unique identifier of the vulnerability. This is recommended to be a UUID.",
598
- "examples": [
599
- "642735a5-1425-428d-8d4e-3c854885a3c9"
600
- ]
601
- },
602
- "name": {
603
- "type": "string",
604
- "maxLength": 255,
605
- "description": "The name of the vulnerability. This must not include the finding's specific information."
606
- },
607
- "description": {
608
- "type": "string",
609
- "maxLength": 1048576,
610
- "description": "A long text section describing the vulnerability more fully."
611
- },
612
- "severity": {
613
- "type": "string",
614
- "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.",
615
- "enum": [
616
- "Info",
617
- "Unknown",
618
- "Low",
619
- "Medium",
620
- "High",
621
- "Critical"
622
- ]
623
- },
624
- "solution": {
625
- "type": "string",
626
- "maxLength": 7000,
627
- "description": "Explanation of how to fix the vulnerability."
628
- },
629
- "identifiers": {
630
- "type": "array",
631
- "minItems": 1,
632
- "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.",
633
- "items": {
634
- "type": "object",
635
- "required": [
636
- "type",
637
- "name",
638
- "value"
639
- ],
640
- "properties": {
641
- "type": {
642
- "type": "string",
643
- "description": "for example, cve, cwe, osvdb, usn, or an analyzer-dependent type such as gemnasium).",
644
- "minLength": 1
645
- },
646
- "name": {
647
- "type": "string",
648
- "description": "Human-readable name of the identifier.",
649
- "minLength": 1
650
- },
651
- "url": {
652
- "type": "string",
653
- "description": "URL of the identifier's documentation.",
654
- "pattern": "^https?://.+"
655
- },
656
- "value": {
657
- "type": "string",
658
- "description": "Value of the identifier, for matching purpose.",
659
- "minLength": 1
660
- }
661
- }
662
- }
663
- },
664
- "links": {
665
- "type": "array",
666
- "description": "An array of references to external documentation or articles that describe the vulnerability.",
667
- "items": {
668
- "type": "object",
669
- "required": [
670
- "url"
671
- ],
672
- "properties": {
673
- "name": {
674
- "type": "string",
675
- "description": "Name of the vulnerability details link."
676
- },
677
- "url": {
678
- "type": "string",
679
- "description": "URL of the vulnerability details document.",
680
- "pattern": "^https?://.+"
681
- }
682
- }
683
- }
684
- },
685
- "details": {
686
- "$ref": "#/definitions/named_list/properties/items"
687
- },
688
- "tracking": {
689
- "type": "object",
690
- "description": "Describes how this vulnerability should be tracked as the project changes.",
691
- "oneOf": [
692
- {
693
- "description": "Declares that a series of items should be tracked using source-specific tracking methods.",
694
- "required": [
695
- "items"
696
- ],
697
- "properties": {
698
- "type": {
699
- "const": "source"
700
- },
701
- "items": {
702
- "type": "array",
703
- "items": {
704
- "description": "An item that should be tracked using source-specific tracking methods.",
705
- "type": "object",
706
- "required": [
707
- "signatures"
708
- ],
709
- "properties": {
710
- "file": {
711
- "type": "string",
712
- "description": "Path to the file where the vulnerability is located."
713
- },
714
- "start_line": {
715
- "type": "number",
716
- "description": "The first line of the file that includes the vulnerability."
717
- },
718
- "end_line": {
719
- "type": "number",
720
- "description": "The last line of the file that includes the vulnerability."
721
- },
722
- "signatures": {
723
- "type": "array",
724
- "description": "An array of calculated tracking signatures for this tracking item.",
725
- "minItems": 1,
726
- "items": {
727
- "description": "A calculated tracking signature value and metadata.",
728
- "type": "object",
729
- "required": [
730
- "algorithm",
731
- "value"
732
- ],
733
- "properties": {
734
- "algorithm": {
735
- "type": "string",
736
- "description": "The algorithm used to generate the signature."
737
- },
738
- "value": {
739
- "type": "string",
740
- "description": "The result of this signature algorithm."
741
- }
742
- }
743
- }
744
- }
745
- }
746
- }
747
- }
748
- }
749
- }
750
- ],
751
- "properties": {
752
- "type": {
753
- "type": "string",
754
- "description": "Each tracking type must declare its own type."
755
- }
756
- }
757
- },
758
- "flags": {
759
- "description": "Flags that can be attached to vulnerabilities.",
760
- "type": "array",
761
- "items": {
762
- "type": "object",
763
- "description": "Informational flags identified and assigned to a vulnerability.",
764
- "required": [
765
- "type",
766
- "origin",
767
- "description"
768
- ],
769
- "properties": {
770
- "type": {
771
- "type": "string",
772
- "minLength": 1,
773
- "description": "Result of the scan.",
774
- "enum": [
775
- "flagged-as-likely-false-positive"
776
- ]
777
- },
778
- "origin": {
779
- "minLength": 1,
780
- "description": "Tool that issued the flag.",
781
- "type": "string"
782
- },
783
- "description": {
784
- "minLength": 1,
785
- "description": "What the flag is about.",
786
- "type": "string"
787
- }
788
- }
789
- }
790
- },
791
- "location": {
792
- "type": "object",
793
- "description": "Identifies the vulnerability's location.",
794
- "properties": {
795
- "file": {
796
- "type": "string",
797
- "description": "Path to the file where the vulnerability is located."
798
- },
799
- "start_line": {
800
- "type": "number",
801
- "description": "The first line of the code affected by the vulnerability."
802
- },
803
- "end_line": {
804
- "type": "number",
805
- "description": "The last line of the code affected by the vulnerability."
806
- },
807
- "class": {
808
- "type": "string",
809
- "description": "Provides the name of the class where the vulnerability is located."
810
- },
811
- "method": {
812
- "type": "string",
813
- "description": "Provides the name of the method where the vulnerability is located."
814
- }
815
- }
816
- },
817
- "raw_source_code_extract": {
818
- "type": "string",
819
- "description": "Provides an unsanitized excerpt of the affected source code."
820
- }
821
- }
822
- }
823
- },
824
- "remediations": {
825
- "type": "array",
826
- "description": "An array of objects containing information on available remediations, along with patch diffs to apply.",
827
- "items": {
828
- "type": "object",
829
- "required": [
830
- "fixes",
831
- "summary",
832
- "diff"
833
- ],
834
- "properties": {
835
- "fixes": {
836
- "type": "array",
837
- "description": "An array of strings that represent references to vulnerabilities fixed by this remediation.",
838
- "items": {
839
- "type": "object",
840
- "required": [
841
- "id"
842
- ],
843
- "properties": {
844
- "id": {
845
- "type": "string",
846
- "minLength": 1,
847
- "description": "Unique identifier of the vulnerability. This is recommended to be a UUID.",
848
- "examples": [
849
- "642735a5-1425-428d-8d4e-3c854885a3c9"
850
- ]
851
- }
852
- }
853
- }
854
- },
855
- "summary": {
856
- "type": "string",
857
- "minLength": 1,
858
- "description": "An overview of how the vulnerabilities were fixed."
859
- },
860
- "diff": {
861
- "type": "string",
862
- "minLength": 1,
863
- "description": "A base64-encoded remediation code diff, compatible with git apply."
864
- }
865
- }
866
- }
867
- }
868
- }
869
- }