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