-
Notifications
You must be signed in to change notification settings - Fork 22
/
openapi.yaml
520 lines (487 loc) · 14 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
---
openapi: 3.0.1
info:
title: Scanner Plugin API
version: 1.0.0
paths:
/healthz:
get:
summary: Check the scanner plugin's health.
responses:
200:
description: The scanner is healthy and can start receiving requests.
503:
description: The scanner is not healthy and cannot start receiving requests.
/metadata:
get:
summary: Get metadata from the scanner plugin.
responses:
200:
description: Scanner metadata.
content:
application/json:
schema:
$ref: '#/components/schemas/Metadata'
/config:
post:
summary: Post config to the scanner plugin and start scanner.
responses:
201:
description: A new scan has been created.
400:
description: The request body is invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
409:
description: The scanner is not in ready state.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
/status:
get:
summary: Get the status of the scanner.
responses:
200:
description: The status of the scanner.
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/stop:
post:
summary: Stop the scanner.
responses:
201:
description: The server will be stopped.
400:
description: The request body is invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Stop'
components:
schemas:
Annotations:
type: object
description: Generic map of string keys and string values to attach arbitrary non-identifying metadata to objects.
additionalProperties:
type: string
Metadata:
type: object
description: Describes the scanner plugin.
properties:
annotations:
$ref: '#/components/schemas/Annotations'
name:
type: string
version:
type: string
apiVersion:
description: This value will be automatically set by the SDK.
type: string
State:
description: |
Describes the status of scanner.
| Status | Description |
| -------------- | ------------------------------------------------------------- |
| NotReady | Initial state when the scanner container starts |
| Ready | Scanner setup is complete and it is ready to receive requests |
| Running | Scanner config was received and the scanner is running |
| Failed | Scanner failed |
| Done | Scanner completed successfully |
type: string
enum:
- NotReady
- Ready
- Running
- Failed
- Done
x-enum-varnames:
- StateNotReady
- StateReady
- StateRunning
- StateFailed
- StateDone
Status:
type: object
description: Describes the scanner status.
required:
- state
- lastTransitionTime
properties:
state:
$ref: '#/components/schemas/State'
message:
description: Human readable message.
type: string
lastTransitionTime:
description: Last date time when the status has changed.
type: string
format: date-time
Config:
type: object
description: Describes config for scanner to start the scanning process.
required:
- inputDir
- outputFile
- timeoutSeconds
properties:
scannerConfig:
type: string
description: |
Optional JSON string of internal scanner configuration used to override default scanner behaviour.
The config schema needs to be documented and payload manually parsed by the developer of scanner plugin.
inputDir:
type: string
x-oapi-codegen-extra-tags:
validate: required
description: |
The directory which should be scanned by the scanner plugin.
outputFile:
type: string
x-oapi-codegen-extra-tags:
validate: required
description: |
Path to JSON file where the scanner plugin should store its results.
timeoutSeconds:
type: integer
minimum: 0
x-oapi-codegen-extra-tags:
validate: required,gt=0
description: |
The maximum time in seconds that a scan started from this scan
should run for before being automatically aborted.
Stop:
type: object
description: Describes data for scanner to stop the scanning process.
required:
- timeoutSeconds
properties:
timeoutSeconds:
type: integer
minimum: 0
x-oapi-codegen-extra-tags:
validate: required,gt=0
description: After this timeout the server will be stopped.
ErrorResponse:
type: object
properties:
message:
type: string
description: An object that is returned for a failed API request.
## --------------------------------
## Models for scan result data
## --------------------------------
Result:
type: object
description: Describes data saved to a JSON file when a scan finishes successfully.
required:
- vmclarity
- rawJSON
properties:
annotations:
# Can be used to attach some scan data consumable by third-party service.
# Optional.
$ref: '#/components/schemas/Annotations'
vmclarity:
# Specifies concrete scan result data that can be consumed by VMClarity API.
# Required.
$ref: '#/components/schemas/VMClarityData'
rawJSON:
# Specifies raw scan result data.
# Required.
type: null
description: Defines scan result data that is not consumed by VMClarity API.
rawSarif:
# Specifies raw scan result data in SARIF format.
# Optional.
type: null
description: Defines scan result data in that is not consumed by the VMClarity API.
VMClarityData:
type: object
description: Defines scan result data that can be consumed by VMClarity API.
properties:
packages:
type: array
items:
$ref: '#/components/schemas/Package'
vulnerabilities:
type: array
items:
$ref: '#/components/schemas/Vulnerability'
malware:
type: array
items:
$ref: '#/components/schemas/Malware'
secrets:
type: array
items:
$ref: '#/components/schemas/Secret'
misconfigurations:
type: array
items:
$ref: '#/components/schemas/Misconfiguration'
rootkits:
type: array
items:
$ref: '#/components/schemas/Rootkit'
exploits:
type: array
items:
$ref: '#/components/schemas/Exploit'
infoFinder:
type: array
items:
$ref: '#/components/schemas/InfoFinder'
Vulnerability:
type: object
properties:
vulnerabilityName:
type: string
description:
type: string
severity:
$ref: '#/components/schemas/VulnerabilitySeverity'
links:
type: array
items:
type: string
nullable: true
distro:
$ref: '#/components/schemas/VulnerabilityDistro'
cvss:
type: array
items:
$ref: '#/components/schemas/VulnerabilityCvss'
nullable: true
package:
$ref: '#/components/schemas/Package'
fix:
$ref: '#/components/schemas/VulnerabilityFix'
layerId:
type: string
path:
type: string
VulnerabilityFix:
type: object
properties:
versions:
type: array
items:
type: string
nullable: true
state:
type: string
VulnerabilityCvss:
type: object
properties:
version:
type: string
vector:
type: string
baseScore:
type: number
exploitabilityScore:
type: number
impactScore:
type: number
VulnerabilityDistro:
type: object
description: Distro provides information about a detected Linux distribution.
properties:
name:
description: Name of the Linux distribution
type: string
version:
description: Version of the Linux distribution (major or major.minor version)
type: string
IDLike:
description: the ID_LIKE field found within the /etc/os-release file
type: array
items:
type: string
nullable: true
VulnerabilitySeverity:
type: string
enum:
- CRITICAL
- HIGH
- MEDIUM
- LOW
- NEGLIGIBLE
x-enum-varnames:
- VulnerabilitySeverityCritical
- VulnerabilitySeverityHigh
- VulnerabilitySeverityMedium
- VulnerabilitySeverityLow
- VulnerabilitySeverityNegligible
Package:
type: object
properties:
name:
type: string
version:
type: string
type:
type: string
language:
type: string
licenses:
type: array
items:
type: string
nullable: true
cpes:
type: array
items:
type: string
nullable: true
purl:
type: string
Malware:
type: object
properties:
malwareName:
type: string
malwareType:
type: string
ruleName:
type: string
path:
type: string
description: Path of the file that contains malware
Rootkit:
type: object
properties:
rootkitName:
type: string
rootkitType:
$ref: '#/components/schemas/RootkitType'
message:
type: string
RootkitType:
type: string
enum:
- UNKNOWN
- MEMORY
- KERNEL
- APPLICATION
- FIRMWARE
x-enum-varnames:
- RootkitTypeUnknown
- RootkitTypeMemory
- RootkitTypeKernel
- RootkitTypeApplication
- RootkitTypeFirmware
Misconfiguration:
type: object
properties:
id:
type: string
description: Check or test ID, if applicable (e.g. Lynis TestID, CIS Docker Benchmark checkpoint code, etc)
location:
type: string
description: Location within the asset where the misconfiguration was recorded (e.g. filesystem path)
category:
type: string
description: Specifies misconfiguration impact category
message:
type: string
description: Short info about the misconfiguration
description:
type: string
description: Additional context such as the potential impact
remediation:
type: string
description: Possible fix for the misconfiguration
severity:
$ref: '#/components/schemas/MisconfigurationSeverity'
MisconfigurationSeverity:
type: string
enum:
- HIGH
- MEDIUM
- LOW
- INFO
x-enum-varnames:
- MisconfigurationSeverityHigh
- MisconfigurationSeverityMedium
- MisconfigurationSeverityLow
- MisconfigurationSeverityInfo
Secret:
type: object
properties:
description:
type: string
filePath:
description: "Name of the file containing the secret"
type: string
startLine:
type: integer
endLine:
type: integer
startColumn:
type: integer
endColumn:
type: integer
fingerprint:
description: "Note: this is not unique"
type: string
Exploit:
type: object
properties:
name:
type: string
title:
type: string
description:
type: string
cveID:
type: string
sourceDB:
type: string
urls:
type: array
items:
type: string
nullable: true
InfoFinder:
type: object
properties:
type:
$ref: '#/components/schemas/InfoFinderType'
path:
type: string
description: "File path containing the info"
data:
type: string
description: "The data found by the scanner in the specific path for a specific type. See example for SSHKnownHostFingerprint info type"
example: "2048 SHA256:YQuPOM8ld6FOA9HbKCgkCJWHuGt4aTRD7hstjJpRhxc xxxx (RSA)"
InfoFinderType:
type: string
enum:
- UNKNOWN
- SSHKnownHostFingerprint
- SSHAuthorizedKeyFingerprint
- SSHPrivateKeyFingerprint
- SSHDaemonKeyFingerprint
x-enum-varnames:
- InfoFinderTypeUnknown
- InfoFinderTypeSSHKnownHostFingerprint
- InfoFinderTypeSSHAuthorizedKeyFingerprint
- InfoFinderTypeSSHPrivateKeyFingerprint
- InfoFinderTypeSSHDaemonKeyFingerprint