gitlab-security_report_schemas 0.1.0.min0.0.0.max0.0.0 → 0.1.0.min15.0.0.max15.1.4

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