-
Notifications
You must be signed in to change notification settings - Fork 0
/
netwitness.json
453 lines (453 loc) · 17.7 KB
/
netwitness.json
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
{
"appid": "cedf3b46-0aeb-4d08-8097-3019ad4c42c7",
"name": "NetWitness Logs and Packets",
"description": "This app supports investigative actions to collect log and packet captures from RSA NetWitness Logs and Packets",
"publisher": "Splunk Community",
"package_name": "phantom_netwitness",
"type": "investigative",
"license": "Copyright (c) 2017-2024 Splunk Inc.",
"main_module": "netwitness_connector.py",
"app_version": "3.0.0",
"utctime_updated": "2024-09-30T06:21:40.000000Z",
"product_vendor": "RSA",
"product_name": "NetWitness Logs and Packets",
"product_version_regex": ".*",
"python_version": "3",
"min_phantom_version": "6.2.2",
"fips_compliant": true,
"latest_tested_versions": [
"RSA NetWitness v11.7"
],
"logo": "logo_rsa.svg",
"logo_dark": "logo_rsa_dark.svg",
"configuration": {
"url": {
"required": true,
"description": "URL",
"data_type": "string",
"order": 0
},
"verify_server_cert": {
"default": false,
"description": "Verify server certificate",
"data_type": "boolean",
"order": 1
},
"username": {
"required": true,
"description": "Username",
"data_type": "string",
"order": 2
},
"password": {
"required": true,
"description": "Password",
"data_type": "password",
"order": 3
}
},
"actions": [
{
"action": "test connectivity",
"description": "Validate the credentials provided for connectivity",
"type": "test",
"identifier": "test_asset_connectivity",
"read_only": true,
"parameters": {},
"output": [],
"versions": "EQ(*)"
},
{
"action": "get pcap",
"description": "Download a packet capture file from Netwitness Logs and Packets and add it to the vault",
"verbose": "There are several ways to search NetWitness Logs and Packets to get capture files:<ul><li>By session ID, which can be done in three ways:<ul><li>Searching by a single session ID. The downloaded capture file would have the name <b>netwitness-<id></b>.</li><li>Searching by a list of session IDs. In this case the <b>session_ids</b> parameter should be a comma separated list. The downloaded capture file would have the name <b>netwitness-<id1_id2_id3...></b>. The session ID list will be cut off at 50 characters.</li><li>Searching by a range of session IDs. In this case the <b>session_ids</b> parameter would have the format <b>start_id-end_id</b>. The downloaded capture file would have the name <b>netwitness-<start_id>-<end_id></b>. NOTE: Including spaces when specifying a range of sessions IDs will cause the action to fail.</li></ul></li><li>By query. The <b>query</b> parameter should be treated as the <b>where</b> clause of a database query using the meta keys configured on the NetWitness server. The downloaded capture file would have the name <b>netwitness-<random_uuid></b>. Some example queries:<ul><li>ip.src=10.10.10.10</li><li>ip.dst=10.10.0.1 || ip.dst=10.10.0.2</li><li>ip.src=10.10.0.7 && ip.dst=10.10.0.8</li><li>ip.src exists</li></ul></li><li>By time frame, which requires both the <b>start_time</b> and <b>end_time</b> parameters be given. The downloaded capture file would have the name <b>netwitness-<start_time>_<end_time></b>.</li></ul>NOTE: If <b>start_time</b> and <b>end_time</b> are included along with a <b>query</b>, then the time-frame will be appended to the end of the query. For example: if the query is ip.src=10.10.10.10, the start time is 2018-01-01 00:00:00, and the end time is 2018-01-01 23:59:59, then the final query would be ip.src=10.10.0.7 && time="2018-01-01 00:00:00"-"2018-01-01 23:59:59"<br><br><b>file_name</b> is an optional parameter that, if specified, will result in the capture file being given that name. It will override the filenames mentioned above. The appropriate extension, <b>.pcap</b> (or <b>.json</b> for <b>get log</b>), will be appended to the file name if it is not already present.<br><br>If a query returns no data, the action will pass, but no file will be added to the vault. Queries to decoders that return large amounts of data, which take more than five minutes, can time out, in which case the action will fail.",
"type": "investigate",
"identifier": "get_pcap",
"read_only": true,
"versions": "EQ(*)",
"parameters": {
"session_ids": {
"description": "Session IDs in a list (72,637,1298...), as a range (0-9999), or singly (485)",
"data_type": "string",
"contains": [
"netwitness session ids"
],
"order": 0,
"primary": true
},
"query": {
"description": "A where query using configured meta keys",
"data_type": "string",
"order": 1
},
"start_time": {
"description": "Start time in UTC (YYYY-MM-DD HH:MM:SS)",
"data_type": "string",
"order": 2
},
"end_time": {
"description": "End time in UTC (YYYY-MM-DD HH:MM:SS)",
"data_type": "string",
"order": 3
},
"file_name": {
"description": "File name to give the downloaded capture",
"data_type": "string",
"order": 4
}
},
"render": {
"width": 12,
"height": 5,
"type": "table",
"title": "Get Pcap"
},
"output": [
{
"data_path": "action_result.status",
"data_type": "string",
"example_values": [
"success",
"failed"
]
},
{
"data_path": "action_result.parameter.end_time",
"data_type": "string"
},
{
"data_path": "action_result.parameter.file_name",
"data_type": "string"
},
{
"data_path": "action_result.parameter.query",
"data_type": "string"
},
{
"data_path": "action_result.parameter.session_ids",
"data_type": "string",
"contains": [
"netwitness session ids"
]
},
{
"data_path": "action_result.parameter.start_time",
"data_type": "string"
},
{
"data_path": "action_result.data.*.file_name",
"data_type": "string",
"contains": [
"file name"
],
"column_name": "File Name",
"column_order": 0
},
{
"data_path": "action_result.data.*.size",
"data_type": "numeric",
"column_name": "File Size",
"column_order": 2
},
{
"data_path": "action_result.data.*.type",
"data_type": "string"
},
{
"data_path": "action_result.data.*.vault_id",
"data_type": "string",
"contains": [
"vault id"
],
"column_name": "Vault ID",
"column_order": 1
},
{
"data_path": "action_result.summary.file_availability",
"data_type": "boolean",
"example_values": [
false,
true
]
},
{
"data_path": "action_result.message",
"data_type": "string"
},
{
"data_path": "summary.total_objects",
"data_type": "numeric",
"example_values": [
1
]
},
{
"data_path": "summary.total_objects_successful",
"data_type": "numeric",
"example_values": [
1
]
}
]
},
{
"action": "get log",
"description": "Download a log capture file from Netwitness Logs and Packets and add it to the vault",
"verbose": "See <b>get pcap</b> for further information on this action.",
"type": "investigate",
"identifier": "get_log_capture",
"read_only": true,
"versions": "EQ(*)",
"parameters": {
"session_ids": {
"description": "Session IDs in a list (72,637,1298...), as a range (0-9999), or singly (485)",
"data_type": "string",
"contains": [
"netwitness session ids"
],
"order": 0,
"primary": true
},
"query": {
"description": "A where query using configured meta keys",
"data_type": "string",
"order": 1
},
"start_time": {
"description": "Start time in UTC (YYYY-MM-DD HH:MM:SS)",
"data_type": "string",
"order": 2
},
"end_time": {
"description": "End time in UTC (YYYY-MM-DD HH:MM:SS)",
"data_type": "string",
"order": 3
},
"file_name": {
"description": "File name to give the downloaded capture",
"data_type": "string",
"order": 4
}
},
"render": {
"width": 12,
"height": 5,
"type": "table",
"title": "Get Log"
},
"output": [
{
"data_path": "action_result.status",
"data_type": "string",
"example_values": [
"success",
"failed"
]
},
{
"data_path": "action_result.parameter.end_time",
"data_type": "string"
},
{
"data_path": "action_result.parameter.file_name",
"data_type": "string"
},
{
"data_path": "action_result.parameter.query",
"data_type": "string"
},
{
"data_path": "action_result.parameter.session_ids",
"data_type": "string",
"contains": [
"netwitness session ids"
]
},
{
"data_path": "action_result.parameter.start_time",
"data_type": "string"
},
{
"data_path": "action_result.data.*.file_name",
"data_type": "string",
"contains": [
"file name"
],
"column_name": "File Name",
"column_order": 0
},
{
"data_path": "action_result.data.*.size",
"data_type": "numeric",
"column_name": "File Size",
"column_order": 2
},
{
"data_path": "action_result.data.*.type",
"data_type": "string"
},
{
"data_path": "action_result.data.*.vault_id",
"data_type": "string",
"contains": [
"vault id"
],
"column_name": "Vault ID",
"column_order": 1
},
{
"data_path": "action_result.summary.file_availability",
"data_type": "boolean",
"example_values": [
false,
true
]
},
{
"data_path": "action_result.message",
"data_type": "string"
},
{
"data_path": "summary.total_objects",
"data_type": "numeric",
"example_values": [
1
]
},
{
"data_path": "summary.total_objects_successful",
"data_type": "numeric",
"example_values": [
1
]
}
]
},
{
"action": "upload file",
"description": "Upload a feed or parser file to a NetWitness Decoder",
"type": "generic",
"identifier": "upload_file",
"read_only": false,
"versions": "EQ(*)",
"parameters": {
"vault_id": {
"description": "Vault ID of parser/feed to upload",
"data_type": "string",
"contains": [
"vault id"
],
"primary": true,
"required": true,
"order": 0
}
},
"render": {
"width": 12,
"height": 5,
"type": "table",
"title": "Upload File"
},
"output": [
{
"data_path": "action_result.status",
"data_type": "string",
"example_values": [
"success",
"failed"
],
"column_name": "Status",
"column_order": 1
},
{
"data_path": "action_result.parameter.vault_id",
"data_type": "string",
"contains": [
"vault id"
],
"column_name": "Vault ID",
"column_order": 0
},
{
"data_path": "action_result.data",
"data_type": "string"
},
{
"data_path": "action_result.summary",
"data_type": "string"
},
{
"data_path": "action_result.message",
"data_type": "string"
},
{
"data_path": "summary.total_objects",
"data_type": "numeric",
"example_values": [
1
]
},
{
"data_path": "summary.total_objects_successful",
"data_type": "numeric",
"example_values": [
1
]
}
]
},
{
"action": "restart device",
"description": "Restart the configured device",
"type": "generic",
"identifier": "restart_device",
"read_only": false,
"parameters": {},
"render": {
"width": 12,
"height": 5,
"type": "table",
"title": "Restart Device"
},
"output": [
{
"data_path": "action_result.status",
"data_type": "string",
"example_values": [
"success",
"failed"
],
"column_name": "Status",
"column_order": 0
},
{
"data_path": "action_result.data",
"data_type": "string"
},
{
"data_path": "action_result.summary",
"data_type": "string"
},
{
"data_path": "action_result.message",
"data_type": "string"
},
{
"data_path": "summary.total_objects",
"data_type": "numeric",
"example_values": [
1
]
},
{
"data_path": "summary.total_objects_successful",
"data_type": "numeric",
"example_values": [
1
]
}
],
"versions": "EQ(*)"
}
]
}