-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathjson-schema.yaml
564 lines (564 loc) · 24 KB
/
json-schema.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
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
id: http://farsightsecurity.com/axa-json-output-schema#
$schema: http://json-schema.org/draft-04/schema#
title: axamd stream output schema
description: Schema describing the output of the AXAMD stream command in axa+json mode. This schema is very large and its use should probably be restricted to development and not be used to validate input at wire speeds.
type: object
properties:
tag:
description: "A tag is a 16-bit identifier used to uniquely \"tag\" specific events during the lifetime of an AXA session. To refer to these events, the client or server will use the tag. Some AXA messages do not require tags, in that case the tag field should be 0. Required tags must be unique during the lifetime of the corresponding client request. Some client requests such as a \"watch\" can last indefinitely and will elicit many server responses all with the same tag."
$ref: "#/definitions/tag"
op:
description: op code
$ref: "#/definitions/op"
pvers:
description: Protocol version.
$ref: "#/definitions/pvers"
required:
- tag
- op
oneOf:
- $ref: "#/definitions/empty"
- $ref: "#/definitions/hello"
- $ref: "#/definitions/join"
- $ref: "#/definitions/result"
- $ref: "#/definitions/missed"
- $ref: "#/definitions/missed_rad"
- $ref: "#/definitions/user"
- $ref: "#/definitions/whit"
- $ref: "#/definitions/watch"
- $ref: "#/definitions/wlist"
- $ref: "#/definitions/anomaly"
- $ref: "#/definitions/ahit"
- $ref: "#/definitions/alist"
- $ref: "#/definitions/channel"
- $ref: "#/definitions/clist"
- $ref: "#/definitions/opt"
definitions:
tag:
oneOf:
- type: integer
minimum: 1
maximum: 65535
- $ref: "#/definitions/TAG_NONE"
TAG_NONE:
type: string
pattern: '^\*$'
op:
type: string
enum:
- HELLO
- NOP
- OK
- ERROR
- WATCH HIT
- ANOMALY HIT
- MISSED
- WATCH LIST
- ANOMALY LIST
- CHANNEL LIST
- RAD MISSED
- USER
- JOIN
- PAUSE
- GO
- WATCH
- WATCH GET
- ANOMALY
- ANOMALY GET
- STOP
- ALL STOP
- CHANNEL ON/OFF
- CHANNEL GET
- OPTION
- ACCOUNTING
- RAD UNITS GET
- MGMT GET
- MGMT GET RSPNS
pvers:
type: integer
minimum: 1
maximum: 255
default: 1
uint32:
type: integer
minimum: 0
maximum: 4294967296
uint64:
type: integer
minimum: 0
maximum: 18446744073709551616
clnt_id:
$ref: "#/definitions/uint64"
count:
$ref: "#/definitions/uint64"
time:
$ref: "#/definitions/uint32"
channel_str:
type: string
pattern: '^ch[0-9]+$'
nmsg:
type: object
properties:
mname:
type: string
vname:
type: string
time:
type: string
source:
type: string
operator:
type: string
group:
type: string
message:
type: object
additionalProperties: true
required:
- mname
- vname
- time
- message
empty:
properties:
op:
enum:
- NOP
- PAUSE
- GO
- WATCH GET
- ANOMALY GET
- STOP
- ALL STOP
- CHANNEL GET
- ACCOUNTING
- RAD UNITS GET
- MGMT GET
hello:
description: RAD and SRA servers start the client-server conversation with a AXA_P_OP_HELLO announcing the protocol versions that the server understands, a version string, and an ID unique among connections to a single server. Clients can include those IDs in AXA_P_OP_JOIN messages to flag connections that are part of a bundle. Because AXA_P_OP_HELLO is sent before the client has said anything and so declared its protocol version, AXA_P_OP_HELLO must remain the same in all versions of the AXA protocol.
properties:
op:
enum: [ HELLO ]
id:
description: client ID for bundled TCP
$ref: "#/definitions/clnt_id"
pvers_min:
description: min protocol version accepted
$ref: "#/definitions/pvers"
pvers_max:
description: max protocol version accepted
$ref: "#/definitions/pvers"
str:
type: string
maxLength: 511
required:
- pvers_min
- pvers_max
- str
join:
description: TODO
properties:
tag:
$ref: "#definitions/TAG_NONE"
op:
enum: [ JOIN ]
id:
description: client ID originally from server
$ref: "#/definitions/clnt_id"
required:
- id
result:
description: result, OK or ERROR
properties:
op:
oneOf:
- enum: [ OK, ERROR ]
orig_op:
$ref: "#/definitions/op"
str:
type: string
maxLength: 511
required:
- orig_op
- str
missed:
description: SRA missed data
properties:
op:
enum: [ MISSED ]
missed:
description: "The number of packets (SIE messages or raw IP packets) lost in the network between the source and the SRA server or dropped by the SRA server because it was too busy."
$ref: "#/definitions/count"
dropped:
description: by SRA client-server congestion
$ref: "#/definitions/count"
rlimit:
description: dropped by rate limiting
$ref: "#/definitions/count"
filtered:
description: total considered
$ref: "#/definitions/count"
last_report:
description: UNIX epoch of previous report
$ref: "#/definitions/time"
required:
- missed
- dropped
- rlimit
- filtered
- last_report
missed_rad:
description: RAD missed data
properties:
op:
enum: [ RAD MISSED ]
sra_missed:
description: missed by all SRA servers
$ref: "#/definitions/count"
sra_dropped:
description: for SRA client-server congestion
$ref: "#/definitions/count"
sra_rlimit:
description: discarded to SRA rate limit
$ref: "#/definitions/count"
sra_filtered:
description: considered by SRA servers
$ref: "#/definitions/count"
dropped:
description: for RAD client-server congestion
$ref: "#/definitions/count"
rlimit:
description: discarded to RAD rate limit
$ref: "#/definitions/count"
filtered:
description: considered by RAD modules
$ref: "#/definitions/count"
last_report:
description: UNIX epoch of previous report
$ref: "#/definitions/time"
required:
- sra_missed
- sra_dropped
- sra_rlimit
- sra_filtered
- dropped
- rlimit
- filtered
- last_report
user:
description: user name
properties:
op:
description: ASCII user name
enum: [ USER ]
whit:
description: watch hit
properties:
op:
enum: [ WATCH HIT ]
oneOf:
- $ref: "#/definitions/whit_nmsg"
- $ref: "#/definitions/whit_ip"
whit_nmsg:
description: watch hit for nmsg data
properties:
channel:
$ref: "#/definitions/channel_str"
nmsg:
$ref: "#/definitions/nmsg"
field:
description: triggering field name
type: string
field_idx:
description: triggering field index
type: integer
val_idx:
description: triggering value index
type: integer
vname:
description: nmsg vendor name
type: string
vid:
description: nmsg vendor ID
type: integer
mname:
description: nmsg module name
type: string
msgtype:
description: nmsg module ID
type: integer
time:
description: timestamp when the NMSG message was reported
type: string
oneOf:
- required:
- field
- required:
- field_idx
required:
- nmsg
- channel
whit_ip:
description: watch hit for pcap data
properties:
af:
description: address family of src and dst
src:
description: source address
type: string
dst:
description: destination address
type: string
channel:
$ref: "#/definitions/channel_str"
ttl:
description: IP time to live
type: integer
minimum: 0
payload:
description: base64-encoded packet payload
type: string
proto:
description: network protocol
type: string
enum:
- ICMP
- ICMPv6
- TCP
- UDP
src_port:
description: network protocol src port
type: integer
dst_port:
description: network protocol dst port
type: integer
flags:
description: TCP flags
type: array
items:
type: string
oneOf:
- enum: [ FIN, SYN, ACK, RST ]
time:
description: timestamp when the packet was captured
type: string
required:
- af
- channel
oneOf:
- properties:
af:
type: string
enum: [ IPv4, IPv6 ]
- properties:
af:
type: integer
minimum: 0
watch:
description: TODO
properties:
op:
enum: [ WATCH ]
allOf:
- $ref: "#/definitions/watch_def"
watch_def:
properties:
watch_type:
description: watch type
type: string
watch:
description: watch string
type: string
oneOf:
- $ref: "#/definitions/watch_ip"
- $ref: "#/definitions/watch_dns"
- $ref: "#/definitions/watch_channel"
- $ref: "#/definitions/watch_errors"
required:
- watch
- watch_type
watch_ip:
description: IP address watch
properties:
watch_type:
enum: [ ipv4, ipv6 ]
watch:
pattern: "^IP="
watch_dns:
description: domain name watch
properties:
watch_type:
enum: [ dns ]
watch:
pattern: "^dns="
watch_channel:
description: channel watch
properties:
watch_type:
enum: [ channel ]
watch:
pattern: "^ch=[0-9]+$"
watch_errors:
description: errors watch
properties:
watch_type:
enum: [ errors ]
watch:
enum: [ ERRORS ]
wlist:
description: watch list result
properties:
op:
enum: [ WATCH LIST ]
cur_tag:
description: current tag of watch
$ref: "#/definitions/tag"
required:
- cur_tag
allOf:
- $ref: "#/definitions/watch_def"
anomaly:
description: anomaly module initialization
properties:
op:
enum: [ ANOMALY ]
allOf:
- $ref: "#/definitions/anomaly_def"
anomaly_def:
properties:
an:
description: anomaly module name
type: string
parms:
description: anomaly module parameters
type: string
required:
- an
ahit:
description: anomaly hit
oneOf:
- $ref: "#/definitions/whit_ip"
- $ref: "#/definitions/whit_nmsg"
properties:
op:
enum: [ ANOMALY HIT ]
an:
description: module that detected the anomaly
type: string
required:
- an
alist:
description: anomaly module list result
properties:
op:
enum: [ ANOMALY LIST ]
cur_tag:
description: current tag of anomaly module
$ref: "#/definitions/tag"
required:
- cur_tag
allOf:
- $ref: "#/definitions/anomaly_def"
channel:
properties:
op:
enum: [ CHANNEL ON/OFF ]
allOf:
- $ref: "#/definitions/channel_def"
channel_def:
properties:
channel:
description: channel number
oneOf:
- $ref: "#/definitions/channel_str"
- enum: [ all ]
"on":
type: boolean
required:
- channel
- "on"
clist:
properties:
op:
enum: [ CHANNEL LIST ]
spec:
description: Human readable string specifying the channel. It often looks like an IP address or network interface name or SIE channel alias.
type: string
maxLength: 1023
allOf:
- $ref: "#/definitions/channel_def"
opt:
properties:
op:
enum: [ OPTION ]
oneOf:
- $ref: "#/definitions/opt_trace"
- $ref: "#/definitions/opt_rlimit"
- $ref: "#/definitions/opt_sample"
- $ref: "#/definitions/opt_bufsize"
required:
- type
opt_trace:
description: server tracing level
properties:
type:
enum: [ TRACE ]
trace:
description: tracing level
oneOf:
- type: integer
- type: string
required:
- trace
opt_rlimit:
description: server rate limiting
properties:
type:
enum: [ RATE LIMIT ]
max_pkts_per_sec:
description: Request the server to send no more than this many WATCH HIT or ANOMALY HIT messages per second. Use "off" to request no limit. No change requested if null.
oneOf:
- type: integer
- type: string
enum: [ "off" ]
- type: "null"
cur_pkts_per_sec:
description: This is the current value of the server's rate limit counter. The counter is incremented each time a relevant AXA message is considered for sending to the client. If the new value is greater than the rate limit, the message dropped. The counter is reset every second.
type: integer
minimum: 0
report_secs:
description: The minimum number of seconds between reports of rate limiting. It is a rate limit on rate limit reports. No change requested if null.
oneOf:
- type: integer
- type: "null"
required:
- max_pkts_per_sec
- cur_pkts_per_sec
- report_secs
opt_sample:
description: sample an output stream
properties:
type:
enum: [ SAMPLE ]
sample:
description: sample ratio
oneOf:
- type: number
minimum: 0
exclusiveMinimum: true
maximum: 1
- type: string
enum: [ requested ]
required:
- sample
opt_bufsize:
description: set TCP buffer or window size
properties:
type:
enum: [ SNDBUF ]
bufsize:
description: number of bytes
type: integer
minimum: 0
required:
- bufsize