-
Notifications
You must be signed in to change notification settings - Fork 3
/
api.yaml
358 lines (354 loc) · 9.25 KB
/
api.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
swagger: "2.0"
info:
description: "REST API description of the ElasTest Security Service (ESS) module."
version: "0.1.0"
title: "ElasTest Security Service REST API"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
contact:
email: [email protected]
basePath: "/ess/api/0.5.0-alpha2/"
tags:
- name: "securitytestmanagement"
description: "Security Test Management"
externalDocs:
description: "Find out more"
url: "http://swagger.io"
schemes:
- "https"
paths:
/:
get:
tags:
- "web-gui"
summary: "Returns the web gui of ESS."
description: "Returns the HTML page of the web GUI of ESS where testers can create new SecJobs, run existing SecJobs and view results."
operationId: "getEssGUI"
consumes:
- "application/json"
responses:
200:
description: "success and returns the html of ESS web gui"
examples:
text/html:
<html><body>ESS HTML</body></html>
404:
description: "Resource not found"
/secjobs:
get:
tags:
- "secjob"
summary: "Returns all secjobs."
description: "Returns all secJobs of the logged in user."
operationId: "getAllSecJobs"
consumes:
- "application/json"
responses:
200:
description: "Successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/SecJob"
404:
description: "Resource not found"
post:
tags:
- "secjob"
summary: "Create a new security testing job (secJob)."
description: "Creates a new secJob with the received information."
operationId: "createSecJob"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "secJob object that needs to create"
required: true
schema:
$ref: "#/definitions/SecJob"
responses:
200:
description: "secJob creation OK"
schema:
$ref: "#/definitions/SecJob"
405:
description: "Invalid input. Failed to create secJob"
put:
tags:
- "secjob"
summary: "Modifies an existing secJob."
description: "Modifies an existing secJob received as a parameter."
operationId: "modifySecJob"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "secJob object that needs to modify."
required: true
schema:
$ref: "#/definitions/SecJob"
responses:
200:
description: "secJob Mofification OK"
schema:
$ref: "#/definitions/SecJob"
405:
description: "Invalid input. Failed to modify secJob"
/secjobs/{secJobId}:
get:
tags:
- "secjob"
summary: "Returns a secJob."
description: "Returns the secJob for a given secJobId. Returns its detail information."
operationId: "getSecJobById"
produces:
- "application/json"
parameters:
- name: "secJobId"
in: "path"
description: "Id of secJob to retrieve."
required: true
type: "integer"
format: "int64"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/SecJob"
400:
description: "secJob not found."
delete:
tags:
- "secjob"
summary: "Deletes a secJob."
description: "Delete the secJob that matches with a given a secJobId."
operationId: "deleteSecJob"
parameters:
- name: "secJobId"
in: "path"
description: "Id of secJob to delete."
required: true
type: "integer"
format: "int64"
responses:
200:
description: "Deleteted successful"
schema:
$ref: "#/definitions/SecJob"
404:
description: "secJob not found"
/secjobs/{secJobId}/exec:
get:
tags:
- "secjob execution"
summary: "Returns all secJob executions of a secJob."
description: "Returns all secJob executions of a secJob."
operationId: "getSecJobsExecutionsBySecJob"
produces:
- "application/json"
parameters:
- name: "secJobId"
in: "path"
description: "secJob Id."
required: true
type: "integer"
format: "int64"
responses:
200:
description: "Successful operation"
schema:
type: "array"
items:
$ref: "#/definitions/SecJobExecution"
404:
description: "secJobs executions not found"
post:
tags:
- "secjob execution"
summary: "Executes a secJob."
description: "Runs the secJob for a give secJobId and returns a secJob execution id."
operationId: "execSecJob"
produces:
- "application/json"
parameters:
- name: "secJobId"
in: "path"
description: "secJob id."
required: true
type: "integer"
format: "int64"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/SecJobExecution"
400:
description: "Invalid ID supplied"
404:
description: "secJob not found"
/secjobs/{secJobId}/exec/{secJobExecId}:
get:
tags:
- "secjob execution"
summary: "Returns a secJob execution."
description: "Returns the secJob execution for a given id."
operationId: "getSecJobsExecution"
produces:
- "application/json"
parameters:
- name: "secJobId"
in: "path"
description: "secJob id."
required: true
type: "integer"
format: "int64"
- name: "secJobExecId"
in: "path"
description: "secJob execution id."
required: true
type: "integer"
format: "int64"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/SecJobExecution"
404:
description: "secJob execution not found"
delete:
tags:
- "secjob execution"
summary: "Deletes a SecJob Execution."
description: "Deletes the secJob execution for a given id. Returns the id."
operationId: "deleteSecJobExecution"
parameters:
- name: "secJobId"
in: "path"
description: "SecJob Id."
required: true
type: "integer"
format: "int64"
- name: "secJobExecId"
in: "path"
description: "secJob execution id."
required: true
type: "integer"
format: "int64"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/SecJobExecution"
404:
description: "secJob Execution not found"
/health/:
get:
tags:
- "ESS health check"
summary: "Returns the healthcheck status of ESS API."
description: "This API call is implemented to help ESM understand whether the ESS API is running properly."
operationId: "getEssHealth"
produces:
- "application/json"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/Health"
404:
description: "error retrieving health of ESS"
definitions:
SecJob:
type: "object"
required:
- "name"
properties:
id:
type: "integer"
format: "int64"
example: "87654321"
name:
type: "string"
example: "secTest1"
vulns:
type: "array"
items:
$ref: "#/definitions/Vulnerabilities"
tJobId:
type: "integer"
format: "int64"
example: "12345678"
maxRunTimeInMins:
type: "integer"
example: "10"
Vulnerabilities:
type: "object"
properties:
vulnType:
type: "string"
example: "Logical"
name:
type: "string"
example: "Replay Attack"
version:
type: "integer"
example: 1
format: "int32"
SecJobExecution:
type: "object"
required:
- "id"
- "result"
- "duration"
properties:
id:
type: "integer"
format: "int64"
duration:
type: "integer"
format: "int64"
result:
type: "string"
enum:
- "SUCCESS"
- "FAILURE"
- "IN PROGRESS"
error:
type: "string"
report:
description: "Report of the secJob execution"
type: "array"
items:
$ref: "#/definitions/Report"
Report:
type: "object"
properties:
secTestCaseId:
type: "integer"
format: "int32"
example: "1"
AttackFound:
type: "string"
format: "int32"
enum:
- "Yes"
- "No"
httpLog:
type: "string"
Health:
type: "object"
properties:
status:
type: "string"
context:
type: "object"
externalDocs:
description: "An elastic platform to ease end to end testing"
url: "http://elastest.io/"