forked from splunk-soar-connectors/imap
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathimap.json
630 lines (630 loc) · 22.7 KB
/
imap.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
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
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
{
"appid": "9f2e9f72-b0e5-45d6-92a7-09ef820476c1",
"name": "IMAP",
"description": "This app supports email ingestion and various investigative actions over IMAP",
"type": "email",
"publisher": "Splunk",
"main_module": "imap_connector.py",
"app_version": "3.3.2",
"utctime_updated": "2023-05-10T22:11:21.000000Z",
"package_name": "phantom_imap",
"product_vendor": "Generic",
"product_name": "IMAP",
"product_version_regex": ".*",
"min_phantom_version": "5.1.0",
"rest_handler": "request_handler.handle_request",
"fips_compliant": true,
"latest_tested_versions": [
"On-premise Outlook Web Access v14.3.301.0, Mailbox server Microsoft Exchange v14.3.123.0",
"OAuth, Gmail May 10, 2023"
],
"python_version": "3",
"logo": "logo_splunk.svg",
"logo_dark": "logo_splunk_dark.svg",
"license": "Copyright (c) 2016-2023 Splunk Inc.",
"configuration": {
"server": {
"data_type": "string",
"description": "Server IP/Hostname",
"order": 0,
"required": true
},
"auth_type": {
"data_type": "string",
"order": 1,
"description": "Authentication Mechanism to Use",
"value_list": [
"Basic",
"OAuth"
],
"default": "Basic"
},
"username": {
"data_type": "string",
"description": "Username",
"order": 2,
"required": true
},
"password": {
"data_type": "password",
"description": "Password",
"order": 3
},
"client_id": {
"data_type": "string",
"description": "OAuth Client ID",
"order": 4
},
"client_secret": {
"data_type": "password",
"description": "OAuth Client Secret",
"order": 5
},
"auth_url": {
"data_type": "string",
"description": "OAuth Authorization URL",
"order": 6,
"default": "https://accounts.google.com/o/oauth2/auth"
},
"token_url": {
"data_type": "string",
"description": "OAuth Token URL",
"order": 7,
"default": "https://oauth2.googleapis.com/token"
},
"scopes": {
"description": "OAuth API Scope (JSON formatted list)",
"data_type": "string",
"default": "[\"https://mail.google.com/\"]",
"order": 8
},
"ph": {
"data_type": "ph",
"order": 9
},
"folder": {
"data_type": "string",
"description": "Folder to ingest mails from (default is inbox)",
"order": 10,
"default": "inbox"
},
"ingest_manner": {
"data_type": "string",
"description": "How to ingest",
"required": true,
"order": 11,
"value_list": [
"oldest first",
"latest first"
],
"default": "oldest first",
"verbose": "During ingestion, should the app get the latest emails or the oldest."
},
"first_run_max_emails": {
"data_type": "numeric",
"order": 12,
"description": "Maximum emails to poll first time",
"value": "2000",
"required": true
},
"max_emails": {
"data_type": "numeric",
"order": 13,
"description": "Maximum emails to poll",
"value": "100",
"required": true
},
"use_ssl": {
"data_type": "boolean",
"description": "Use SSL",
"order": 14,
"default": false
},
"extract_attachments": {
"data_type": "boolean",
"description": "Extract Attachments",
"order": 15,
"default": true
},
"extract_urls": {
"data_type": "boolean",
"description": "Extract URLs",
"order": 16,
"default": true
},
"extract_ips": {
"data_type": "boolean",
"description": "Extract IPs",
"order": 17,
"default": true
},
"extract_domains": {
"data_type": "boolean",
"description": "Extract Domain Names",
"order": 18,
"default": true
},
"extract_hashes": {
"data_type": "boolean",
"description": "Extract Hashes",
"order": 19,
"default": true
},
"add_body_to_header_artifacts": {
"data_type": "boolean",
"description": "Add email body to the Email Artifact",
"order": 20,
"default": false
}
},
"actions": [
{
"action": "test connectivity",
"description": "Validate the asset configuration for connectivity. This action runs a quick query on the server to check the connection and credentials",
"type": "test",
"identifier": "test_asset_connectivity",
"read_only": true,
"parameters": {},
"output": [],
"versions": "EQ(*)"
},
{
"action": "get email",
"description": "Get an email from the server or container",
"verbose": "Every container that is created by the IMAP app has the following values:<ul><li>The container ID, that is generated by the Phantom platform.</li><li>The Source ID that the app equates to the email ID along with the hash of the folder name on the remote server</li><li>The raw_email data in the container's data field is set to the RFC822 format of the email.</li></ul>This action parses email data and if specified, creates containers and artifacts. The email data to parse is either extracted from the remote server if an email <b>id</b> is specified along with its folder name or from a Phantom container if the <b>contianer_id</b> is specified. The folder parameter is used only when the email id is specified in the input. If the folder is not mentioned, it takes the folder name from the asset configuration parameter. If the folder name is not specified as an input of the \"get email\" action or in asset configuration parameters, \"inbox\" is taken as its value.<br>If both parameters are specified, the action will use the <b>container_id</b>.<br>Do note that any containers and artifacts created will use the label configured in the asset.",
"type": "investigate",
"identifier": "get_email",
"read_only": true,
"parameters": {
"id": {
"description": "Message ID to get",
"data_type": "string",
"order": 0,
"contains": [
"imap email id"
],
"primary": true
},
"container_id": {
"description": "Container ID to get email data from",
"data_type": "numeric",
"order": 1,
"contains": [
"phantom container id"
],
"primary": true
},
"folder": {
"data_type": "string",
"description": "Folder name of email to get(used when id is given as input)",
"order": 2
},
"ingest_email": {
"description": "Create container and artifacts",
"data_type": "boolean",
"order": 3,
"default": false
}
},
"render": {
"type": "json"
},
"output": [
{
"data_path": "action_result.status",
"data_type": "string",
"example_values": [
"success",
"failed"
]
},
{
"data_path": "action_result.parameter.container_id",
"data_type": "numeric",
"contains": [
"phantom container id"
],
"example_values": [
1270
]
},
{
"data_path": "action_result.parameter.folder",
"data_type": "string",
"example_values": [
"test"
]
},
{
"data_path": "action_result.parameter.id",
"data_type": "string",
"contains": [
"imap email id"
],
"example_values": [
"1918"
]
},
{
"data_path": "action_result.parameter.ingest_email",
"data_type": "boolean",
"example_values": [
true,
false
]
},
{
"data_path": "action_result.data.*.ARC-Authentication-Results",
"data_type": "string"
},
{
"data_path": "action_result.data.*.ARC-Message-Signature",
"data_type": "string"
},
{
"data_path": "action_result.data.*.ARC-Seal",
"data_type": "string"
},
{
"data_path": "action_result.data.*.Accept-Language",
"data_type": "string",
"example_values": [
"en-US"
]
},
{
"data_path": "action_result.data.*.Authentication-Results",
"data_type": "string"
},
{
"data_path": "action_result.data.*.CC",
"data_type": "string",
"example_values": [
"User <[email protected]>"
]
},
{
"data_path": "action_result.data.*.Content-Language",
"data_type": "string",
"example_values": [
"en-US"
]
},
{
"data_path": "action_result.data.*.Content-Transfer-Encoding",
"data_type": "string",
"example_values": [
"quoted-printable"
]
},
{
"data_path": "action_result.data.*.Content-Type",
"data_type": "string",
"example_values": [
"multipart/alternative; boundary=\"00000000000082bcbd056d5b9c37\""
]
},
{
"data_path": "action_result.data.*.DKIM-Signature",
"data_type": "string"
},
{
"data_path": "action_result.data.*.Date",
"data_type": "string",
"example_values": [
"Tue, 29 May 2018 17:31:58 +0000"
]
},
{
"data_path": "action_result.data.*.Delivered-To",
"data_type": "string",
"example_values": [
]
},
{
"data_path": "action_result.data.*.FCC",
"data_type": "string",
"example_values": [
"test://[email protected]/Sent"
]
},
{
"data_path": "action_result.data.*.Feedback-ID",
"data_type": "string"
},
{
"data_path": "action_result.data.*.From",
"data_type": "string",
"example_values": [
"The Test Team <[email protected]>"
]
},
{
"data_path": "action_result.data.*.In-Reply-To",
"data_type": "string"
},
{
"data_path": "action_result.data.*.MIME-Version",
"data_type": "string",
"example_values": [
"1.0"
]
},
{
"data_path": "action_result.data.*.Message-ID",
"data_type": "string",
"example_values": [
"<88f9844d75d4b351.1527615118220.110312844.20155287.en.630c09e415f69497@test.com>"
]
},
{
"data_path": "action_result.data.*.Received",
"data_type": "string"
},
{
"data_path": "action_result.data.*.Received-SPF",
"data_type": "string"
},
{
"data_path": "action_result.data.*.References",
"data_type": "string"
},
{
"data_path": "action_result.data.*.Reply-To",
"data_type": "string",
"example_values": [
"The Test Team <[email protected]>"
]
},
{
"data_path": "action_result.data.*.Return-Path",
"data_type": "string",
"contains": [
"email"
]
},
{
"data_path": "action_result.data.*.Subject",
"data_type": "string",
"example_values": [
"Test Email Subject"
]
},
{
"data_path": "action_result.data.*.Thread-Index",
"data_type": "string",
"example_values": [
"AdZLNWgVDiTd5bCtTtyx3vkNcc0vtQ=="
]
},
{
"data_path": "action_result.data.*.Thread-Topic",
"data_type": "string",
"example_values": [
"beep for 4.9!"
]
},
{
"data_path": "action_result.data.*.To",
"data_type": "string",
"example_values": [
]
},
{
"data_path": "action_result.data.*.User-Agent",
"data_type": "string"
},
{
"data_path": "action_result.data.*.X-Account-Key",
"data_type": "string",
"example_values": [
"account7"
]
},
{
"data_path": "action_result.data.*.X-Gm-Message-State",
"data_type": "string"
},
{
"data_path": "action_result.data.*.X-Google-DKIM-Signature",
"data_type": "string"
},
{
"data_path": "action_result.data.*.X-Google-Id",
"data_type": "string",
"example_values": [
"194824"
]
},
{
"data_path": "action_result.data.*.X-Google-Smtp-Source",
"data_type": "string"
},
{
"data_path": "action_result.data.*.X-Identity-Key",
"data_type": "string",
"example_values": [
"id1"
]
},
{
"data_path": "action_result.data.*.X-MS-Exchange-Organization-AuthAs",
"data_type": "string",
"example_values": [
"Internal"
]
},
{
"data_path": "action_result.data.*.X-MS-Exchange-Organization-AuthMechanism",
"data_type": "string",
"example_values": [
"04"
]
},
{
"data_path": "action_result.data.*.X-MS-Exchange-Organization-AuthSource",
"data_type": "string",
"example_values": [
"test1.test.com"
]
},
{
"data_path": "action_result.data.*.X-MS-Exchange-Organization-SCL",
"data_type": "string",
"example_values": [
"-1"
]
},
{
"data_path": "action_result.data.*.X-MS-Has-Attach",
"data_type": "string"
},
{
"data_path": "action_result.data.*.X-MS-TNEF-Correlator",
"data_type": "string"
},
{
"data_path": "action_result.data.*.X-Mozilla-Draft-Info",
"data_type": "string"
},
{
"data_path": "action_result.data.*.X-Received",
"data_type": "string"
},
{
"data_path": "action_result.summary.container_id",
"data_type": "numeric",
"contains": [
"phantom container id"
],
"example_values": [
2433
]
},
{
"data_path": "action_result.message",
"data_type": "string",
"example_values": [
"Container id: 704"
]
},
{
"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(*)"
},
{
"action": "on poll",
"description": "Callback action for the on_poll ingest functionality",
"type": "ingest",
"identifier": "on_poll",
"read_only": true,
"parameters": {
"start_time": {
"data_type": "numeric",
"description": "Parameter ignored for this app"
},
"end_time": {
"data_type": "numeric",
"description": "Parameter ignored for this app"
},
"container_id": {
"data_type": "string",
"description": "Parameter ignored for this app"
},
"container_count": {
"data_type": "numeric",
"description": "Maximum number of container records to query for",
"required": true,
"value": 100
},
"artifact_count": {
"data_type": "numeric",
"description": "Parameter ignored for this app",
"required": true,
"value": 1000
}
},
"output": [],
"versions": "EQ(*)"
}
],
"pip_dependencies": {
"wheel": [
{
"module": "IMAPClient",
"input_file": "wheels/shared/IMAPClient-2.2.0-py2.py3-none-any.whl"
},
{
"module": "beautifulsoup4",
"input_file": "wheels/py3/beautifulsoup4-4.9.1-py3-none-any.whl"
},
{
"module": "parse",
"input_file": "wheels/py3/parse-1.17.0-py3-none-any.whl"
},
{
"module": "python_dateutil",
"input_file": "wheels/shared/python_dateutil-2.8.1-py2.py3-none-any.whl"
},
{
"module": "python_magic",
"input_file": "wheels/shared/python_magic-0.4.18-py2.py3-none-any.whl"
},
{
"module": "six",
"input_file": "wheels/shared/six-1.16.0-py2.py3-none-any.whl"
},
{
"module": "soupsieve",
"input_file": "wheels/py3/soupsieve-2.3.2.post1-py3-none-any.whl"
}
]
},
"pip39_dependencies": {
"wheel": [
{
"module": "IMAPClient",
"input_file": "wheels/shared/IMAPClient-2.2.0-py2.py3-none-any.whl"
},
{
"module": "beautifulsoup4",
"input_file": "wheels/py3/beautifulsoup4-4.9.1-py3-none-any.whl"
},
{
"module": "parse",
"input_file": "wheels/py3/parse-1.17.0-py3-none-any.whl"
},
{
"module": "python_dateutil",
"input_file": "wheels/shared/python_dateutil-2.8.1-py2.py3-none-any.whl"
},
{
"module": "python_magic",
"input_file": "wheels/shared/python_magic-0.4.18-py2.py3-none-any.whl"
},
{
"module": "six",
"input_file": "wheels/shared/six-1.16.0-py2.py3-none-any.whl"
},
{
"module": "soupsieve",
"input_file": "wheels/py3/soupsieve-2.4.1-py3-none-any.whl"
}
]
}
}