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/dast-report-format.json DELETED
@@ -1,1279 +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/dast-report-format.json",
4
- "title": "Report format for GitLab DAST",
5
- "description": "This schema provides the the report format for Dynamic Application Security Testing (https://docs.gitlab.com/ee/user/application_security/dast).",
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
- "scanned_resources",
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
- "dast",
535
- "api_fuzzing"
536
- ]
537
- },
538
- "primary_identifiers": {
539
- "type": "array",
540
- "description": "An unordered array containing an exhaustive list of primary identifiers for which the analyzer may return results",
541
- "items": {
542
- "type": "object",
543
- "required": [
544
- "type",
545
- "name",
546
- "value"
547
- ],
548
- "properties": {
549
- "type": {
550
- "type": "string",
551
- "description": "for example, cve, cwe, osvdb, usn, or an analyzer-dependent type such as gemnasium).",
552
- "minLength": 1
553
- },
554
- "name": {
555
- "type": "string",
556
- "description": "Human-readable name of the identifier.",
557
- "minLength": 1
558
- },
559
- "url": {
560
- "type": "string",
561
- "description": "URL of the identifier's documentation.",
562
- "pattern": "^https?://.+"
563
- },
564
- "value": {
565
- "type": "string",
566
- "description": "Value of the identifier, for matching purpose.",
567
- "minLength": 1
568
- }
569
- }
570
- }
571
- },
572
- "scanned_resources": {
573
- "type": "array",
574
- "description": "The attack surface scanned by DAST.",
575
- "items": {
576
- "type": "object",
577
- "required": [
578
- "method",
579
- "url",
580
- "type"
581
- ],
582
- "properties": {
583
- "method": {
584
- "type": "string",
585
- "minLength": 1,
586
- "description": "HTTP method of the scanned resource.",
587
- "examples": [
588
- "GET",
589
- "POST",
590
- "HEAD"
591
- ]
592
- },
593
- "url": {
594
- "type": "string",
595
- "minLength": 1,
596
- "description": "URL of the scanned resource.",
597
- "examples": [
598
- "http://my.site.com/a-page"
599
- ]
600
- },
601
- "type": {
602
- "type": "string",
603
- "minLength": 1,
604
- "description": "Type of the scanned resource, for DAST, this must be 'url'.",
605
- "examples": [
606
- "url"
607
- ]
608
- }
609
- }
610
- }
611
- }
612
- }
613
- },
614
- "schema": {
615
- "type": "string",
616
- "description": "URI pointing to the validating security report schema.",
617
- "pattern": "^https?://.+"
618
- },
619
- "version": {
620
- "type": "string",
621
- "description": "The version of the schema to which the JSON report conforms.",
622
- "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+$"
623
- },
624
- "vulnerabilities": {
625
- "type": "array",
626
- "description": "Array of vulnerability objects.",
627
- "items": {
628
- "type": "object",
629
- "description": "Describes the vulnerability using GitLab Flavored Markdown",
630
- "required": [
631
- "id",
632
- "identifiers",
633
- "location"
634
- ],
635
- "properties": {
636
- "id": {
637
- "type": "string",
638
- "minLength": 1,
639
- "description": "Unique identifier of the vulnerability. This is recommended to be a UUID.",
640
- "examples": [
641
- "642735a5-1425-428d-8d4e-3c854885a3c9"
642
- ]
643
- },
644
- "name": {
645
- "type": "string",
646
- "maxLength": 255,
647
- "description": "The name of the vulnerability. This must not include the finding's specific information."
648
- },
649
- "description": {
650
- "type": "string",
651
- "maxLength": 1048576,
652
- "description": "A long text section describing the vulnerability more fully."
653
- },
654
- "severity": {
655
- "type": "string",
656
- "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.",
657
- "enum": [
658
- "Info",
659
- "Unknown",
660
- "Low",
661
- "Medium",
662
- "High",
663
- "Critical"
664
- ]
665
- },
666
- "solution": {
667
- "type": "string",
668
- "maxLength": 7000,
669
- "description": "Explanation of how to fix the vulnerability."
670
- },
671
- "identifiers": {
672
- "type": "array",
673
- "minItems": 1,
674
- "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.",
675
- "items": {
676
- "type": "object",
677
- "required": [
678
- "type",
679
- "name",
680
- "value"
681
- ],
682
- "properties": {
683
- "type": {
684
- "type": "string",
685
- "description": "for example, cve, cwe, osvdb, usn, or an analyzer-dependent type such as gemnasium).",
686
- "minLength": 1
687
- },
688
- "name": {
689
- "type": "string",
690
- "description": "Human-readable name of the identifier.",
691
- "minLength": 1
692
- },
693
- "url": {
694
- "type": "string",
695
- "description": "URL of the identifier's documentation.",
696
- "pattern": "^https?://.+"
697
- },
698
- "value": {
699
- "type": "string",
700
- "description": "Value of the identifier, for matching purpose.",
701
- "minLength": 1
702
- }
703
- }
704
- }
705
- },
706
- "links": {
707
- "type": "array",
708
- "description": "An array of references to external documentation or articles that describe the vulnerability.",
709
- "items": {
710
- "type": "object",
711
- "required": [
712
- "url"
713
- ],
714
- "properties": {
715
- "name": {
716
- "type": "string",
717
- "description": "Name of the vulnerability details link."
718
- },
719
- "url": {
720
- "type": "string",
721
- "description": "URL of the vulnerability details document.",
722
- "pattern": "^https?://.+"
723
- }
724
- }
725
- }
726
- },
727
- "details": {
728
- "$ref": "#/definitions/named_list/properties/items"
729
- },
730
- "tracking": {
731
- "type": "object",
732
- "description": "Describes how this vulnerability should be tracked as the project changes.",
733
- "oneOf": [
734
- {
735
- "description": "Declares that a series of items should be tracked using source-specific tracking methods.",
736
- "required": [
737
- "items"
738
- ],
739
- "properties": {
740
- "type": {
741
- "const": "source"
742
- },
743
- "items": {
744
- "type": "array",
745
- "items": {
746
- "description": "An item that should be tracked using source-specific tracking methods.",
747
- "type": "object",
748
- "required": [
749
- "signatures"
750
- ],
751
- "properties": {
752
- "file": {
753
- "type": "string",
754
- "description": "Path to the file where the vulnerability is located."
755
- },
756
- "start_line": {
757
- "type": "number",
758
- "description": "The first line of the file that includes the vulnerability."
759
- },
760
- "end_line": {
761
- "type": "number",
762
- "description": "The last line of the file that includes the vulnerability."
763
- },
764
- "signatures": {
765
- "type": "array",
766
- "description": "An array of calculated tracking signatures for this tracking item.",
767
- "minItems": 1,
768
- "items": {
769
- "description": "A calculated tracking signature value and metadata.",
770
- "type": "object",
771
- "required": [
772
- "algorithm",
773
- "value"
774
- ],
775
- "properties": {
776
- "algorithm": {
777
- "type": "string",
778
- "description": "The algorithm used to generate the signature."
779
- },
780
- "value": {
781
- "type": "string",
782
- "description": "The result of this signature algorithm."
783
- }
784
- }
785
- }
786
- }
787
- }
788
- }
789
- }
790
- }
791
- }
792
- ],
793
- "properties": {
794
- "type": {
795
- "type": "string",
796
- "description": "Each tracking type must declare its own type."
797
- }
798
- }
799
- },
800
- "flags": {
801
- "description": "Flags that can be attached to vulnerabilities.",
802
- "type": "array",
803
- "items": {
804
- "type": "object",
805
- "description": "Informational flags identified and assigned to a vulnerability.",
806
- "required": [
807
- "type",
808
- "origin",
809
- "description"
810
- ],
811
- "properties": {
812
- "type": {
813
- "type": "string",
814
- "minLength": 1,
815
- "description": "Result of the scan.",
816
- "enum": [
817
- "flagged-as-likely-false-positive"
818
- ]
819
- },
820
- "origin": {
821
- "minLength": 1,
822
- "description": "Tool that issued the flag.",
823
- "type": "string"
824
- },
825
- "description": {
826
- "minLength": 1,
827
- "description": "What the flag is about.",
828
- "type": "string"
829
- }
830
- }
831
- }
832
- },
833
- "evidence": {
834
- "type": "object",
835
- "properties": {
836
- "source": {
837
- "type": "object",
838
- "description": "Source of evidence",
839
- "required": [
840
- "id",
841
- "name"
842
- ],
843
- "properties": {
844
- "id": {
845
- "type": "string",
846
- "minLength": 1,
847
- "description": "Unique source identifier",
848
- "examples": [
849
- "assert:LogAnalysis",
850
- "assert:StatusCode"
851
- ]
852
- },
853
- "name": {
854
- "type": "string",
855
- "minLength": 1,
856
- "description": "Source display name",
857
- "examples": [
858
- "Log Analysis",
859
- "Status Code"
860
- ]
861
- },
862
- "url": {
863
- "type": "string",
864
- "description": "Link to additional information",
865
- "examples": [
866
- "https://docs.gitlab.com/ee/development/integrations/secure.html"
867
- ]
868
- }
869
- }
870
- },
871
- "summary": {
872
- "type": "string",
873
- "description": "Human readable string containing evidence of the vulnerability.",
874
- "examples": [
875
- "Credit card 4111111111111111 found",
876
- "Server leaked information nginx/1.17.6"
877
- ]
878
- },
879
- "request": {
880
- "type": "object",
881
- "description": "An HTTP request.",
882
- "required": [
883
- "headers",
884
- "method",
885
- "url"
886
- ],
887
- "properties": {
888
- "headers": {
889
- "type": "array",
890
- "description": "HTTP headers present on the request.",
891
- "items": {
892
- "type": "object",
893
- "required": [
894
- "name",
895
- "value"
896
- ],
897
- "properties": {
898
- "name": {
899
- "type": "string",
900
- "minLength": 1,
901
- "description": "Name of the HTTP header.",
902
- "examples": [
903
- "Accept",
904
- "Content-Length",
905
- "Content-Type"
906
- ]
907
- },
908
- "value": {
909
- "type": "string",
910
- "description": "Value of the HTTP header.",
911
- "examples": [
912
- "*/*",
913
- "560",
914
- "application/json; charset=utf-8"
915
- ]
916
- }
917
- }
918
- }
919
- },
920
- "method": {
921
- "type": "string",
922
- "minLength": 1,
923
- "description": "HTTP method used in the request.",
924
- "examples": [
925
- "GET",
926
- "POST"
927
- ]
928
- },
929
- "url": {
930
- "type": "string",
931
- "minLength": 1,
932
- "description": "URL of the request.",
933
- "examples": [
934
- "http://my.site.com/vulnerable-endpoint?show-credit-card"
935
- ]
936
- },
937
- "body": {
938
- "type": "string",
939
- "description": "Body of the request for display purposes. Body must be suitable for display (not binary), and truncated to a reasonable size.",
940
- "examples": [
941
- "user=jsmith&first=%27&last=smith"
942
- ]
943
- }
944
- }
945
- },
946
- "response": {
947
- "type": "object",
948
- "description": "An HTTP response.",
949
- "required": [
950
- "headers",
951
- "reason_phrase",
952
- "status_code"
953
- ],
954
- "properties": {
955
- "headers": {
956
- "type": "array",
957
- "description": "HTTP headers present on the request.",
958
- "items": {
959
- "type": "object",
960
- "required": [
961
- "name",
962
- "value"
963
- ],
964
- "properties": {
965
- "name": {
966
- "type": "string",
967
- "minLength": 1,
968
- "description": "Name of the HTTP header.",
969
- "examples": [
970
- "Accept",
971
- "Content-Length",
972
- "Content-Type"
973
- ]
974
- },
975
- "value": {
976
- "type": "string",
977
- "description": "Value of the HTTP header.",
978
- "examples": [
979
- "*/*",
980
- "560",
981
- "application/json; charset=utf-8"
982
- ]
983
- }
984
- }
985
- }
986
- },
987
- "reason_phrase": {
988
- "type": "string",
989
- "description": "HTTP reason phrase of the response.",
990
- "examples": [
991
- "OK",
992
- "Internal Server Error"
993
- ]
994
- },
995
- "status_code": {
996
- "type": "integer",
997
- "description": "HTTP status code of the response.",
998
- "examples": [
999
- 200,
1000
- 500
1001
- ]
1002
- },
1003
- "body": {
1004
- "type": "string",
1005
- "description": "Body of the response for display purposes. Body must be suitable for display (not binary), and truncated to a reasonable size.",
1006
- "examples": [
1007
- "{\"user_id\": 2}"
1008
- ]
1009
- }
1010
- }
1011
- },
1012
- "supporting_messages": {
1013
- "type": "array",
1014
- "description": "Array of supporting http messages.",
1015
- "items": {
1016
- "type": "object",
1017
- "description": "A supporting http message.",
1018
- "required": [
1019
- "name"
1020
- ],
1021
- "properties": {
1022
- "name": {
1023
- "type": "string",
1024
- "minLength": 1,
1025
- "description": "Message display name.",
1026
- "examples": [
1027
- "Unmodified",
1028
- "Recorded"
1029
- ]
1030
- },
1031
- "request": {
1032
- "type": "object",
1033
- "description": "An HTTP request.",
1034
- "required": [
1035
- "headers",
1036
- "method",
1037
- "url"
1038
- ],
1039
- "properties": {
1040
- "headers": {
1041
- "type": "array",
1042
- "description": "HTTP headers present on the request.",
1043
- "items": {
1044
- "type": "object",
1045
- "required": [
1046
- "name",
1047
- "value"
1048
- ],
1049
- "properties": {
1050
- "name": {
1051
- "type": "string",
1052
- "minLength": 1,
1053
- "description": "Name of the HTTP header.",
1054
- "examples": [
1055
- "Accept",
1056
- "Content-Length",
1057
- "Content-Type"
1058
- ]
1059
- },
1060
- "value": {
1061
- "type": "string",
1062
- "description": "Value of the HTTP header.",
1063
- "examples": [
1064
- "*/*",
1065
- "560",
1066
- "application/json; charset=utf-8"
1067
- ]
1068
- }
1069
- }
1070
- }
1071
- },
1072
- "method": {
1073
- "type": "string",
1074
- "minLength": 1,
1075
- "description": "HTTP method used in the request.",
1076
- "examples": [
1077
- "GET",
1078
- "POST"
1079
- ]
1080
- },
1081
- "url": {
1082
- "type": "string",
1083
- "minLength": 1,
1084
- "description": "URL of the request.",
1085
- "examples": [
1086
- "http://my.site.com/vulnerable-endpoint?show-credit-card"
1087
- ]
1088
- },
1089
- "body": {
1090
- "type": "string",
1091
- "description": "Body of the request for display purposes. Body must be suitable for display (not binary), and truncated to a reasonable size.",
1092
- "examples": [
1093
- "user=jsmith&first=%27&last=smith"
1094
- ]
1095
- }
1096
- }
1097
- },
1098
- "response": {
1099
- "type": "object",
1100
- "description": "An HTTP response.",
1101
- "required": [
1102
- "headers",
1103
- "reason_phrase",
1104
- "status_code"
1105
- ],
1106
- "properties": {
1107
- "headers": {
1108
- "type": "array",
1109
- "description": "HTTP headers present on the request.",
1110
- "items": {
1111
- "type": "object",
1112
- "required": [
1113
- "name",
1114
- "value"
1115
- ],
1116
- "properties": {
1117
- "name": {
1118
- "type": "string",
1119
- "minLength": 1,
1120
- "description": "Name of the HTTP header.",
1121
- "examples": [
1122
- "Accept",
1123
- "Content-Length",
1124
- "Content-Type"
1125
- ]
1126
- },
1127
- "value": {
1128
- "type": "string",
1129
- "description": "Value of the HTTP header.",
1130
- "examples": [
1131
- "*/*",
1132
- "560",
1133
- "application/json; charset=utf-8"
1134
- ]
1135
- }
1136
- }
1137
- }
1138
- },
1139
- "reason_phrase": {
1140
- "type": "string",
1141
- "description": "HTTP reason phrase of the response.",
1142
- "examples": [
1143
- "OK",
1144
- "Internal Server Error"
1145
- ]
1146
- },
1147
- "status_code": {
1148
- "type": "integer",
1149
- "description": "HTTP status code of the response.",
1150
- "examples": [
1151
- 200,
1152
- 500
1153
- ]
1154
- },
1155
- "body": {
1156
- "type": "string",
1157
- "description": "Body of the response for display purposes. Body must be suitable for display (not binary), and truncated to a reasonable size.",
1158
- "examples": [
1159
- "{\"user_id\": 2}"
1160
- ]
1161
- }
1162
- }
1163
- }
1164
- }
1165
- }
1166
- }
1167
- }
1168
- },
1169
- "location": {
1170
- "type": "object",
1171
- "description": "Identifies the vulnerability's location.",
1172
- "properties": {
1173
- "hostname": {
1174
- "type": "string",
1175
- "description": "The protocol, domain, and port of the application where the vulnerability was found."
1176
- },
1177
- "method": {
1178
- "type": "string",
1179
- "description": "The HTTP method that was used to request the URL where the vulnerability was found."
1180
- },
1181
- "param": {
1182
- "type": "string",
1183
- "description": "A value provided by a vulnerability rule related to the found vulnerability. Examples include a header value, or a parameter used in a HTTP POST."
1184
- },
1185
- "path": {
1186
- "type": "string",
1187
- "description": "The path of the URL where the vulnerability was found. Typically, this would start with a forward slash."
1188
- }
1189
- }
1190
- },
1191
- "assets": {
1192
- "type": "array",
1193
- "description": "Array of build assets associated with vulnerability.",
1194
- "items": {
1195
- "type": "object",
1196
- "description": "Describes an asset associated with vulnerability.",
1197
- "required": [
1198
- "type",
1199
- "name",
1200
- "url"
1201
- ],
1202
- "properties": {
1203
- "type": {
1204
- "type": "string",
1205
- "description": "The type of asset",
1206
- "enum": [
1207
- "http_session",
1208
- "postman"
1209
- ]
1210
- },
1211
- "name": {
1212
- "type": "string",
1213
- "minLength": 1,
1214
- "description": "Display name for asset",
1215
- "examples": [
1216
- "HTTP Messages",
1217
- "Postman Collection"
1218
- ]
1219
- },
1220
- "url": {
1221
- "type": "string",
1222
- "minLength": 1,
1223
- "description": "Link to asset in build artifacts",
1224
- "examples": [
1225
- "https://gitlab.com/gitlab-org/security-products/dast/-/jobs/626397001/artifacts/file//output/zap_session.data"
1226
- ]
1227
- }
1228
- }
1229
- }
1230
- }
1231
- }
1232
- }
1233
- },
1234
- "remediations": {
1235
- "type": "array",
1236
- "description": "An array of objects containing information on available remediations, along with patch diffs to apply.",
1237
- "items": {
1238
- "type": "object",
1239
- "required": [
1240
- "fixes",
1241
- "summary",
1242
- "diff"
1243
- ],
1244
- "properties": {
1245
- "fixes": {
1246
- "type": "array",
1247
- "description": "An array of strings that represent references to vulnerabilities fixed by this remediation.",
1248
- "items": {
1249
- "type": "object",
1250
- "required": [
1251
- "id"
1252
- ],
1253
- "properties": {
1254
- "id": {
1255
- "type": "string",
1256
- "minLength": 1,
1257
- "description": "Unique identifier of the vulnerability. This is recommended to be a UUID.",
1258
- "examples": [
1259
- "642735a5-1425-428d-8d4e-3c854885a3c9"
1260
- ]
1261
- }
1262
- }
1263
- }
1264
- },
1265
- "summary": {
1266
- "type": "string",
1267
- "minLength": 1,
1268
- "description": "An overview of how the vulnerabilities were fixed."
1269
- },
1270
- "diff": {
1271
- "type": "string",
1272
- "minLength": 1,
1273
- "description": "A base64-encoded remediation code diff, compatible with git apply."
1274
- }
1275
- }
1276
- }
1277
- }
1278
- }
1279
- }