-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
ExtraHop_v2.py
2435 lines (1944 loc) · 89.9 KB
/
ExtraHop_v2.py
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
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import demistomock as demisto # noqa: F401
from CommonServerPython import * # noqa: F401
import json
import traceback
from collections import defaultdict
from ipaddress import ip_address
from typing import DefaultDict, Tuple
from requests import Response
import urllib3
# Disable insecure warnings
urllib3.disable_warnings()
""" CONSTANTS """
VALID_PEER_ROLES = ["any", "client", "server"]
VALID_PROTOCOLS = ["any", "AAA", "ActiveMQ", "AJP", "amf", "CIFS", "DB", "DHCP", "DICOM", "DNS", "FIX", "FTP", "HL7",
"HTTP", "IBMMQ", "ICA", "IKE/ISAKMP", "IMAP", "IPFIX", "IPsec NAT-T", "IRC", "iSCSI", "Kerberos",
"L2TP", "LDAP", "lync-compress", "memcache", "Modbus", "MongoDB", "MSMQ", "MSN", "MSRPC", "NetFlow",
"NFS", "NTP", "OpenVPN", "PCoIP", "Perforce", "POP3", "RDP", "Redis", "RFB", "RTCP", "RTP", "sFlow",
"SIP", "SMPP", "SMTP", "SNMP", "SSH", "SSL", "Syslog", "TCP", "telnet", "UDP", "WebSocket"]
VALID_DEVICE_ROLES = ["db_server", "dhcp_server", "dns_server", "file_server", "firewall", "gateway", "http_server",
"domain_controller", "web_proxy", "load_balancer", "pc", "medical_device", "mobile_device",
"printer", "scanner", "custom", "voip_phone", "other"]
VALID_DEVICE_SOFTWARES = ["android", "apple_ios", "arista_eos", "cisco_ios", "cisco_nx-os", "chrome_os", "linux",
"mac_os", "windows", "windows_server", "windows_server_2008", "windows_server_2008_r2",
"windows_server_2012", "windows_server_2012_r2", "windows_server_2016", "windows_vista",
"windows_7", "windows_8", "windows_8.1", "windows_10"]
VALID_DEVICE_VENDORS = ["alcatel-lucent", "apple", "arista", "asus", "brother", "canon", "cisco", "cisco-linksys",
"citrix", "dell", "dellemc", "d-link", "emc", "f5", "google", "hp", "htc", "huawei", "ibm",
"juniper", "kyocera", "microsoft", "netapp", "netgear", "nokia", "nortel", "oracle", "paloalto",
"samsung", "3com", "toshiba", "virtualbox", "vmware", "zte"]
VALID_DEVICE_ACTIVITIES = ["aaa_client", "aaa_server", "ajp_client", "ajp_server", "amf_client", "amf_server",
"cifs_client", "cifs_server", "db_client", "db_server", "dhcp_client", "dhcp_server",
"dicom_client", "dicom_server", "dns_client", "dns_server", "fix_client", "fix_server",
"ftp_client", "ftp_server", "hl7_client", "hl7_server", "http_client", "http_server",
"ibmmq_client", "ibmmq_server", "ica_client", "ica_server", "icmp", "iscsi_client",
"iscsi_server", "kerberos_client", "kerberos_server", "ldap_client", "ldap_server",
"llmnr_client", "llmnr_server", "memcache_client", "memcache_server", "modbus_client",
"modbus_server", "mongo_client", "mongo_server", "msmq", "nbns_client", "nbns_server",
"nfs_client", "nfs_server", "pcoip_client", "pcoip_server", "pop3_client", "pop3_server",
"rdp_client", "rdp_server", "redis_client", "redis_server", "rfb_client", "rfb_server",
"rpc_client", "rpc_server", "rtcp", "rtp", "scanner", "sip_client", "sip_server",
"smpp_client", "smpp_server", "smtp_client", "smtp_server", "ssh_client", "ssh_server",
"ssl_client", "ssl_server", "tcp", "telnet_client", "telnet_server", "udp",
"websocket_client",
"websocket_server", "wsman_client", "wsman_server"]
VALID_DEVICE_OPERATORS = [">", "<", "<=", ">=", "=", "!=", "startswith", "exists", "not_exists", "~", "!~"]
VALID_DEVICE_MATCH_TYPES = ["and", "or", "not"]
VALID_TIME_INTERVALS = ["30 minutes", "6 hours", "1 day", "1 week"]
VALID_FILE_FORMATS = ["pcap", "keylog_txt", "zip"]
VALID_INCIDENT_STATUS = ["0", "1", "2", "3"]
TICKET_STATUS_MAP = {
"0": "new", # pending
"1": "in_progress", # active
"2": "closed", # done
"3": "acknowledged" # archived
}
TICKET_SEVERITY = {
"0-39": 1, # low
"40-69": 2, # medium
"70-89": 3, # high
"90-100": 4 # critical
}
VALID_ALERT_RULE_REFIRE_INTERVALS = ["300", "600", "900", "1800", "3600", "7200", "14400"]
VALID_ALERT_RULE_TYPE = ["threshold", "detection"]
VALID_ALERT_RULE_SEVERITY = ["0", "1", "2", "3", "4", "5", "6", "7"]
VALID_ALERT_RULE_INTERVAL_LENGTH = ["30", "60", "120", "300", "600", "900", "1200", "1800"]
SORT_DIRECTION = ["asc", "desc"]
VALID_ALERT_RULE_OPERATOR = ["==", ">", "<", ">=", "<="]
VALID_ALERT_RULE_UNITS = ["none", "period", "1 sec", "1 min", "1 hr"]
VALID_ALERT_RULE_OBJECT_TYPES = ["application", "device"]
VALID_CYCLES = ["auto", "1sec", "30sec", "5min", "1hr", "24hr"]
VALID_OBJECT_TYPES = ["device", "network", "application", "vlan", "device_group", "system"]
VALID_METRICS_KEYS = ["cycle", "from", "metric_category", "metric_specs", "object_ids", "object_type", "until"]
VALID_DETECTION_KEYS = ["filter", "limit", "offset", "from", "until", "sort", "mod_time"]
VALID_FILTER_KEYS = ["assignee", "categories", "category", "resolution", "risk_score_min", "status", "ticket_id", "types"]
DATE_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
DEFAULT_FETCH_TYPE = 'ExtraHop Detections'
FIRST_FETCH = "3 days"
MAX_FETCH = 200
EXTRAHOP_MARKDOWN_REGEX = r"(\[[^\]]+\]\(\#\/[^\)]+\))+"
""" CLIENT CLASS """
class ExtraHopClient(BaseClient):
def __init__(self, base_url: str, api_key: str, client_id: str, client_secret: str, verify: bool, ok_codes: tuple,
on_cloud: bool) -> None:
"""
Prepare constructor for Client class.
Calls the constructor of BaseClient class and updates the header with the authentication token.
Args:
base_url: The url of ExtraHop instance.
api_key: The api key to use in header.
client_id: The Client ID to use for authentication.
client_secret: The Client Secret to use for authentication.
verify: True if verify SSL certificate is checked in integration configuration, False otherwise.
"""
super().__init__(base_url=base_url, verify=verify, ok_codes=ok_codes)
# Setting up access token in headers.
if on_cloud:
self._headers: Dict[str, Any] = {
"Authorization": f"Bearer {self.get_access_token(client_id=client_id, client_secret=client_secret)}",
"ExtraHop-Integration": "XSOAR-6.5.0-ExtraHop-2.0.0"
}
else:
self._headers = {
"Accept": "application/json",
"Authorization": f"ExtraHop apikey={api_key}",
"ExtraHop-Integration": "XSOAR-6.5.0-ExtraHop-2.0.0"
}
def get_access_token(self, client_id: str, client_secret: str) -> str:
"""Return the token stored in integration context.
If the token has expired or is not present in the integration context
(in the first case), it calls the Authentication function, which
generates a new token and stores it in the integration context.
Args:
client_id: The Client ID to use for authentication.
client_secret: The Client Secret to use for authentication.
Returns:
str: Authentication token stored in integration context.
"""
integration_context = get_integration_context()
token = integration_context.get("access_token")
valid_until = integration_context.get("valid_until")
time_now = int(time.time())
# If token exists and is valid, then return it.
if (token and valid_until) and (time_now < valid_until):
demisto.info("Extrahop token returned from integration context.")
return token
# Otherwise, generate a new token and store it.
token, expires_in = self.authenticate(client_id=client_id, client_secret=client_secret)
integration_context = {
"access_token": token,
"valid_until": time_now + expires_in, # Token expiration time - 30 mins
}
set_integration_context(integration_context)
return token
def authenticate(self, client_id: str, client_secret: str) -> Tuple[str, int]:
"""
Get the access token from the ExtraHop API.
Args:
client_id: The Client ID to use for authentication.
client_secret: The Client Secret to use for authentication.
Returns:
tuple[str,int]: The token and its expiration time in seconds received from the API.
"""
demisto.info("Generating new authentication token.")
req_headers = {
"cache-control": "no-cache",
"content-type": "application/x-www-form-urlencoded",
}
req_body = {
"grant_type": "client_credentials",
"client_id": client_id,
"client_secret": client_secret,
}
response = self._http_request(
method="POST",
url_suffix="/oauth2/token",
data=req_body,
headers=req_headers
)
token = response.get("access_token")
expires_in = response.get("expires_in")
return token, expires_in
def test_connection(self):
"""Test the authentication."""
return self._http_request(method="GET", url_suffix="/api/v1/extrahop",
error_handler=authentication_error_handler)
def get_extrahop_version(self):
"""Retrieve the ExtraHop version."""
return self._http_request(method="GET", url_suffix="/api/v1/extrahop/version")
def get_appliance_uuids(self):
"""Retrieve the appliance IDs.
Returns:
Response from the API.
"""
networks = self._http_request("GET", url_suffix="/api/v1/networks")
uuid_lookup = {}
for network in networks:
uuid_lookup[network["node_id"]] = network.get("appliance_uuid")
return uuid_lookup
def get_device_by_id(self, device_id: str, ok_codes: Tuple = None):
"""Retrieve the device from the Reveal(X).
Args:
device_id: Unique ID of the device to be retrieved.
ok_codes: The status code to not raise error for while fetching detections.
Returns:
Response from the API.
"""
return self._http_request("GET", url_suffix=f"/api/v1/devices/{device_id}", ok_codes=ok_codes)
def device_search(self, name: Optional[str], ip: Optional[str], mac: Optional[str], role: Optional[str],
software: Optional[str], vendor: Optional[str], tag: Optional[str], discover_time: Optional[str],
vlan: Optional[str], activity: Optional[str], operator: Optional[str], match_type: Optional[str],
active_from: Optional[str], active_until: Optional[str], limit: Optional[int],
l3_only: Optional[bool]):
"""Searches for a device from the Reveal(X).
Args:
name: Name of the device.
ip: IP address of the device.
mac: Mac address of the device.
role: Role of the device.
software: Software used in the device.
vendor: Vendor of the device.
tag: Tags of the device.
discover_time: The time device was discovered.
vlan: vlan of the device.
activity: activity information of the device.
operator: Operator of the device.
match_type: Match type of the device.
active_from: Date the device is active from.
active_until: Date the device was last active.
limit: Limit of the response
l3_only: Whether the device is a layer 3 device.
Returns:
Response from the API.
"""
fields = {
"name": name,
"ipaddr": ip,
"macaddr": mac,
"role": role,
"software": software,
"vendor": vendor,
"tag": tag,
"discover_time": discover_time,
"vlan": vlan,
"activity": activity
}
data: Dict[str, Any] = {}
if active_from:
data["active_from"] = int(active_from)
if active_until:
data["active_until"] = int(active_until)
if limit:
data["limit"] = int(limit)
if any([val is not None for val in fields.values()]):
data["filter"] = {
"operator": match_type,
"rules": []
}
rules_list = data["filter"]["rules"]
if l3_only:
rules_list.append(
{
"field": "ipaddr",
"operator": "exists"
}
)
if match_type != "and":
data["filter"]["operator"] = "and"
rules_list.append(
{
"operator": match_type,
"rules": []
}
)
rules_list = data["filter"]["rules"][1]["rules"]
for field in fields.items():
if field[1]:
search_filter = {
"field": field[0],
"operator": operator,
"operand": field[1]
}
rules_list.append(search_filter)
return self._http_request("POST", url_suffix="/api/v1/devices/search", json_data=data)
def get_watchlist(self):
"""Retrieve all the devices on the watchlist in Reveal(X).
Returns:
Response from the API.
"""
return self._http_request("GET", url_suffix="/api/v1/watchlist/devices")
def edit_watchlist(self, body: Dict):
"""Retrieve all devices that are in the watchlist.
Args:
body: Json payload to pass with the API.
"""
self._http_request("POST", url_suffix="/api/v1/watchlist/devices", json_data=body, resp_type="response")
def get_peers(self, body: Dict):
"""Retrieve the peers of a device from Reveal(X).
Returns:
Response from the API.
"""
return self._http_request("POST", url_suffix="/api/v1/activitymaps/query", json_data=body)
def get_alert_rules(self):
"""Retrieve the alert rules from Reveal(X).
Returns:
Response from the API.
"""
return self._http_request("GET", url_suffix="/api/v1/alerts")
def patch_detections(self, detection_id: str, body: Dict):
"""Patch a detection with provided fields.
Args:
detection_id: The unique identifier for the detection.
body: Json payload to pass with the API.
Returns:
Response from the API.
"""
return self._http_request("PATCH", url_suffix=f"/api/v1/detections/{detection_id}", json_data=body,
resp_type="response")
def packets_search(self, output: Optional[str], limit_bytes: Optional[str], limit_search_duration: Optional[str],
query_from: Optional[str], query_until: Optional[str], bpf: Optional[str], ip1: Optional[str],
port1: Optional[str], ip2: Optional[str], port2: Optional[str]):
"""Retrieve the specific packets from Reveal(X).
Args:
output: The output format
limit_bytes: The maximum number of bytes to return.
limit_search_duration: The maximum amount of time to run the packet search.
query_from: The beginning timestamp of the time range the search will include.
query_until: The ending timestamp of the time range the search will include.
bpf: The Berkeley Packet Filter (BPF) syntax for the packet search.
ip1: Returns packets sent to or received by the specified IP address.
port1: Returns packets sent from or received on the specified port.
ip2: Returns packets sent to or received by the specified IP address.
port2: Returns packets sent from or received on the specified port.
Returns:
Response from the API.
"""
body = {
"output": output,
"limit_bytes": limit_bytes,
"limit_search_duration": limit_search_duration,
"always_return_body": False,
"from": query_from,
"until": query_until,
"bpf": bpf,
"ip1": ip1,
"port1": port1,
"ip2": ip2,
"port2": port2
}
return self._http_request("GET", url_suffix="/api/v1/packets/search", json_data=body, resp_type="response")
def get_all_tags(self):
"""Retrieve all available tags from Reveal(X).
Returns:
Response from the API.
"""
return self._http_request("GET", url_suffix="/api/v1/tags")
def create_new_tag(self, data: Dict):
"""Create a new tag.
Returns:
Response from the API.
"""
return self._http_request("POST", url_suffix="/api/v1/tags", json_data=data, resp_type="response")
def tag_untag_devices(self, tag_id: str, data: Dict):
"""Tag and untag devices for the given tag id.
Returns:
Response from the API.
"""
return self._http_request("POST", url_suffix=f"/api/v1/tags/{tag_id}/devices", json_data=data,
resp_type="response")
def create_alert_rule(self, body: Dict):
"""Create a new alert rule with specified value.
Args:
body: Request body of alert rule.
Returns:
Response from the API.
"""
return self._http_request("POST", url_suffix="/api/v1/alerts", json_data=body, empty_valid_codes=[201],
return_empty_response=True)
def update_alert_rule(self, alert_id, body):
"""Update alert rule with specified value.
Args:
alert_id: The unique identifier of the alert.
body: Json payload to pass with the API.
Returns:
Response from the API.
"""
return self._http_request("PATCH", url_suffix=f"/api/v1/alerts/{alert_id}", json_data=body,
return_empty_response=True)
def metrics_list(self, body: Dict):
"""Retrieves metric information collected about every object from the Reveal(X).
Args:
body: Request body of metric list.
Returns:
Response from the API.
"""
return self._http_request("POST", url_suffix="/api/v1/metrics", json_data=body)
def detections_list(self, body):
"""Retrieve the detections from Reveal(X).
Returns:
Response from the API.
"""
return self._http_request("POST", url_suffix="/api/v1/detections/search", json_data=body)
def get_detections_by_id(self, detection_id):
"""Retrieve the detections from Reveal(X).
Returns:
Response from the API.
"""
return self._http_request("GET", url_suffix=f"/api/v1/detections/{detection_id}")
def get_query_records(self, body: Dict):
"""Get query records for specified filter.
Args:
body: JSON payload to pass with the API.
"""
return self._http_request("POST", url_suffix="/api/v1/records/search", json_data=body)
def get_next_page_records(self, cursor):
"""Get next page records from specified cursor value.
Args:
cursor: Cursor value to get records.
"""
body = {
"cursor": cursor
}
params = {
"context_ttl": 30000
}
return self._http_request("POST", url_suffix="/api/v1/records/cursor", json_data=body, params=params)
""" EXCEPTION CLASS """
class InvalidValueError(Exception):
"""Custom exception class for invalid values."""
def __init__(self, arg_name="", arg_value="", arg_list=[], message=""):
if not message:
message = f"{arg_value} is an invalid value for {arg_name}. Possible values are: {arg_list}"
super().__init__(message)
""" HELPER FUNCTIONS """
def modify_description(base_url, description):
"""Modify descriptions of the detections list.
Args:
base_url: Base URL of the instance.
description: Detection description.
Returns:
Updated description.
"""
new_link = f"{base_url}/extrahop/#"
markdown_data = re.findall(EXTRAHOP_MARKDOWN_REGEX, description)
for markdown in markdown_data:
# Replacing the '#' to the extrahop platform url
if "/extrahop/#" in markdown:
new_markdown = markdown.replace("#/extrahop", base_url)
else:
new_markdown = markdown.replace("#", new_link)
description = description.replace(markdown, new_markdown)
return description
def get_extrahop_server_version(client: ExtraHopClient):
"""Retrieve and parse the extrahop server version.
Args:
client: ExtraHop client to be used.
Returns:
The parsed version of the current extrahop server.
"""
version = client.get_extrahop_version().get("version")
temp = version.split(".")
version = ".".join(temp[:3])
return version
def remove_empty_elements_from_response(data: Union[Dict, List, None, str]) -> Union[Dict, List, str, None]:
"""Recursively remove empty lists, empty dicts, or None elements from a dictionary.
Args:
data: Data from which empty elements are to be removes
Returns:
Data with no empty fields.
"""
def empty(x):
return x is None or x == {} or x == [] or x == ""
if not isinstance(data, (dict, list)):
return data
elif isinstance(data, list):
return [v for v in (remove_empty_elements_from_response(v) for v in data) if not empty(v)]
else:
return {k: v for k, v in ((k, remove_empty_elements_from_response(v)) for k, v in data.items()) if not empty(v)}
def authentication_error_handler(res: Response) -> None:
"""Handle 400, 401, 403, 404, 5XX error.
Args:
res: The response object obtained from API.
Raises: ValueError if the status code is 401 or 400.
"""
if res.status_code == 400:
raise ValueError("Error code 400: Attempt to bad request.")
elif res.status_code == 401:
raise ValueError("Error code 401: Invalid credentials provided.")
elif res.status_code == 403:
raise ValueError("Error code 403: Attempt to access forbidden resource.")
elif res.status_code == 404:
raise ValueError("Error code 404: The requested resource cannot be found.")
else:
raise ValueError("Internal server error.")
def trim_spaces_from_args(args: Dict) -> Dict:
"""Trim spaces from values of the args dict.
Args:
args: Dict to trim spaces from.
Returns:
Arguments after trim spaces.
"""
for key, val in args.items():
if isinstance(val, str):
args[key] = val.strip()
return args
def remove_api_from_base_url(url: str) -> str:
"""Prepare URL from base URL required for human-readable.
Args:
url: Base URL of the cloud instance.
Returns:
ExtraHop cloud instance URL.
"""
url = url.split(".")
url.pop(1)
return ".".join(url)
def validate_peers_get_arguments(peer_role: Optional[Any], protocol: Optional[Any]) -> None:
"""Validate arguments for peers-get command.
Args:
peer_role: The role of the peer device in relation to the origin device.
protocol: The protocol over which the source device is communicating.
"""
if peer_role and peer_role not in VALID_PEER_ROLES:
raise InvalidValueError("peer_role", peer_role, VALID_PEER_ROLES)
if protocol and protocol not in VALID_PROTOCOLS:
raise InvalidValueError("protocol", protocol, VALID_PROTOCOLS)
def validate_device_search_arguments(role: Optional[str], software, vendor: Optional[str], activity: Optional[str],
operator: Optional[str], match_type: Optional[str],
l3_only: Optional[bool]) -> None:
"""Validate arguments for peers-get command.
Args:
role: The role of the device.
software: The OS of the device.
vendor: The vendor of the device, based on MAC address via OUI lookup.
activity: The activity of the device.
operator: The compare method applied when matching the fields against their values
match_type: The match operator to use when chaining the search fields together.
l3_only: Only returns layer 3 devices by filtering out any layer 2 parent devices.
"""
if role and role not in VALID_DEVICE_ROLES:
raise InvalidValueError("role", role, VALID_DEVICE_ROLES)
if software and software not in VALID_DEVICE_SOFTWARES:
raise InvalidValueError("software", software, VALID_DEVICE_SOFTWARES)
if vendor and vendor not in VALID_DEVICE_VENDORS:
raise InvalidValueError("vendor", vendor, VALID_DEVICE_VENDORS)
if activity and activity not in VALID_DEVICE_ACTIVITIES:
raise InvalidValueError("activity", activity, VALID_DEVICE_ACTIVITIES)
if operator and operator not in VALID_DEVICE_OPERATORS:
raise InvalidValueError("operator", operator, VALID_DEVICE_OPERATORS)
if match_type and match_type not in VALID_DEVICE_MATCH_TYPES:
raise InvalidValueError("match_type", match_type, VALID_DEVICE_MATCH_TYPES)
if l3_only:
argToBoolean(l3_only)
def validate_activity_map_get_arguments(ip_or_id: Optional[str], time_interval: str, from_time: Optional[str],
until_time: Optional[str], peer_role: str, protocol: str) -> None:
"""Validate arguments for peers-get command.
Args:
ip_or_id: IP address or unique ID of the device.
time_interval: Time interval of the live activity map.
from_time: The beginning timestamp of a fixed time range.
until_time: The ending timestamp of a fixed time range.
peer_role: The role of the peer devices in relation to the source device.
protocol: The protocol over which the source device is communicating.
"""
if not ip_or_id.isdigit(): # type: ignore
ip_address(ip_or_id) # type: ignore
if time_interval and time_interval not in VALID_TIME_INTERVALS:
raise InvalidValueError("time_interval", time_interval, VALID_TIME_INTERVALS)
if from_time:
arg_to_number(from_time, "from_time")
if until_time:
arg_to_number(until_time, "until_time")
if peer_role and peer_role not in VALID_PEER_ROLES:
raise InvalidValueError("peer_role", peer_role, VALID_PEER_ROLES)
if protocol and protocol not in VALID_PROTOCOLS:
raise InvalidValueError("protocol", protocol, VALID_PROTOCOLS)
def validate_ticket_track_arguments(incident_status: str):
"""Validate arguments for ticket-track command.
Args:
incident_status: The status of the incident.
"""
if incident_status and incident_status not in VALID_INCIDENT_STATUS:
raise InvalidValueError("incident_status", incident_status, VALID_INCIDENT_STATUS)
def validate_packets_search_arguments(output: str) -> None:
"""Validate arguments for peers-get command.
Args:
output: The output format.
"""
if output and output not in VALID_FILE_FORMATS:
raise InvalidValueError("output", output, VALID_FILE_FORMATS)
def validate_add_and_remove_arguments(add: str, remove: str) -> None:
"""Validate add and remove arguments for command.
Args:
add: The list of IP or device ID to add tag.
remove: The list of IP or device ID to remove tag.
"""
if not add and not remove:
raise DemistoException("No device id provided to add or remove arguments.")
def validate_create_or_update_alert_rule_arguments(refire_interval: Optional[str], severity: Optional[str],
alert_type: Optional[str]) -> None:
"""Validate arguments for extrahop-alert-rule-create and extrahop-alert-rule-update commands.
Args:
refire_interval: The time interval in which alert conditions are monitored, expressed in seconds.
severity: The severity level of the alert, which is displayed in the Alert History,
email notifications, and SNMP traps.
alert_type: The type of alert.
"""
if refire_interval and refire_interval not in VALID_ALERT_RULE_REFIRE_INTERVALS:
raise InvalidValueError("refire_interval", refire_interval, VALID_ALERT_RULE_REFIRE_INTERVALS)
if severity and severity not in VALID_ALERT_RULE_SEVERITY:
raise InvalidValueError("severity", severity, VALID_ALERT_RULE_SEVERITY)
if alert_type and alert_type not in VALID_ALERT_RULE_TYPE:
raise InvalidValueError("type", alert_type, VALID_ALERT_RULE_TYPE)
def validate_threshold_alert_rule_arguments(interval_length: Optional[str], operator: Optional[str],
units: Optional[str]) -> None:
"""Validate arguments for extrahop-alert-rule-create and extrahop-alert-rule-update commands for alert_type:
threshold.
Args:
interval_length: The length of the alert interval, expressed in seconds.
operator: The logical operator applied when comparing the value of the operand field to alert conditions
units: The interval in which to evaluate the alert condition.
"""
if interval_length and interval_length not in VALID_ALERT_RULE_INTERVAL_LENGTH:
raise InvalidValueError("interval_length", interval_length, VALID_ALERT_RULE_INTERVAL_LENGTH)
if operator and operator not in VALID_ALERT_RULE_OPERATOR:
raise InvalidValueError("operator", operator, VALID_ALERT_RULE_OPERATOR)
if units and units not in VALID_ALERT_RULE_UNITS:
raise InvalidValueError("units", units, VALID_ALERT_RULE_UNITS)
def validate_metrics_list_arguments(body: Dict) -> None:
"""Validate arguments for metrics-list command.
Args:
body: Payload of the API request.
"""
keys = body.keys()
for key in keys:
if key not in VALID_METRICS_KEYS:
raise InvalidValueError("keys", key, VALID_METRICS_KEYS)
if body.get("cycle") not in VALID_CYCLES:
raise InvalidValueError("cycle", body["cycle"], VALID_CYCLES)
if body.get("object_type") not in VALID_OBJECT_TYPES:
raise InvalidValueError("object_type", body["object_type"], VALID_OBJECT_TYPES)
def validate_detections_list_arguments(body: Dict) -> None:
"""Validate arguments for list-detections command.
Args:
body: The payload of the API request.
Raises:
DemistoException if invalid input given for an argument.
"""
body = trim_spaces_from_args(body)
for key in body.keys():
if key not in VALID_DETECTION_KEYS:
raise InvalidValueError("key", key, VALID_DETECTION_KEYS)
if body.get("filter"):
for key in body["filter"].keys():
if key not in VALID_FILTER_KEYS:
raise InvalidValueError("key", key, VALID_FILTER_KEYS)
if body.get("from") and body.get("until") and body["from"] > body["until"]:
raise DemistoException("Input for \"from\" should always be less than that of \"until\".")
if isinstance(body.get("limit"), int):
if body["limit"] <= 0:
raise DemistoException("Invalid input for field limit. It should have numeric value greater than zero.")
body["limit"] = min(body["limit"], 200)
else:
body["limit"] = 200
if isinstance(body.get("offset"), int):
if body["offset"] < 0:
raise DemistoException(
"Invalid input for field offset. It should have numeric value greater than or equal to zero.")
else:
body["offset"] = 0
def add_default_category_for_filter_of_detection_list(_filter: Dict) -> None:
"""Set a default category for filter argument.
Args:
_filter: Filter argument for detection list command.
"""
if "category" not in _filter:
if "categories" not in _filter:
_filter["categories"] = ["sec.attack"]
elif isinstance(_filter.get("categories"), list):
valid_categories = []
for category in _filter.get("categories", []):
if isinstance(category, str):
category = category.strip()
if category:
valid_categories.append(category)
_filter["categories"] = valid_categories if valid_categories else ["sec.attack"]
def format_protocol_stack(protocol_list: List) -> str:
"""Formats the protocol stack.
Args:
protocol_list: List of protocols.
Returns:
String of formatted protocols.
"""
if len(protocol_list) > 1:
protos = protocol_list[1:]
else:
protos = protocol_list
return ":".join(protos)
def sort_protocols(protos_by_weight: Dict) -> List:
"""Sort protocols by weight.
Args:
protos_by_weight: Weighted dictionary of protocols.
Returns:
Sorted List fo protocols.
"""
sorted_protos = sorted(protos_by_weight.items(), key=lambda x: x[1], reverse=True)
return [proto_tuple[0] for proto_tuple in sorted_protos]
def get_device_by_ip(client: ExtraHopClient, ip, active_from: str = None, active_until: str = None, limit: int = None):
"""Retrieve the device by IP address.
Args:
client: ExtraHop client to be used.
ip: IP address of the device.
active_from: Time the device was active from.
active_until: Time the device was last active.
limit: Number of devices to retrieve.
Returns:
Devices.
"""
devices = client.device_search(name=None, ip=ip, mac=None, role=None, software=None, vendor=None, tag=None,
discover_time=None, vlan=None, activity=None, operator="=", match_type="and",
active_from=active_from, active_until=active_until, limit=limit, l3_only=True)
if devices:
return devices[0]
else:
raise DemistoException(f"Error the IP Address {ip} was not found in ExtraHop.")
def get_devices_by_ip_or_id(client: ExtraHopClient, devices_str, active_from: str = None, active_until: str = None,
limit: int = None, id_only: bool = False) -> List:
"""Retrieve the devices by IP address or ID.
Args:
client: Extrahop client to be used.
devices_str: String os devices.
active_from: Time the device was active from.
active_until: Time the device was last active.
limit: Number of devices to retrieve.
id_only: Whether to retrieve devices by id only.
Returns:
List of devices.
"""
devices = []
for item in str(devices_str).split(","):
if item.isdigit():
if id_only:
devices.append(int(item))
else:
device = client.get_device_by_id(item)
devices.append(device)
else:
try:
ip_address(item)
except ValueError:
raise DemistoException(f"Error parsing IP Address {item}")
device = get_device_by_ip(client, item, active_from, active_until, limit)
if id_only:
devices.append(int(device["id"]))
else:
devices.append(device)
return devices
def get_protocols(client: ExtraHopClient, ip_or_id, query_from, query_until) -> Dict:
"""Retrieve all the protocols for a device from the Reveal(X) in the given time range.
Args:
client: ExtraHop client to be used.
ip_or_id: IP or ID of the object to get protocols for.
query_from: Time since epoch to fetch the protocols.
query_until: Time until epoch to fetch the protocols.
Returns:
Dictionory of client and server protocols.
"""
device = get_devices_by_ip_or_id(client, ip_or_id)[0]
api_id = int(device["id"])
if device.get("analysis") == "discovery":
demisto.results({
"Type": entryTypes["note"],
"ContentsFormat": formats["markdown"],
"Contents": (f"This Device is in Discovery Mode. Configure your [Analysis Priorities]"
f"(https://docs.extrahop.com/current/analysis_priorities/) or add this device to the "
f"[Watchlist](https://docs.extrahop.com/current/analysis-priorities-faq/"
f"#what-is-the-watchlist) manually with: `!extrahop-edit-watchlist add={api_id}`")
})
body = {
"edge_annotations": ["protocols"],
"from": query_from,
"walks": [{
"origins": [{
"object_id": api_id,
"object_type": "device"
}],
"steps": [{}]
}]
}
if query_until:
body["until"] = query_until
activitymap = client.get_peers(body)
client_protocols = defaultdict(int) # type: DefaultDict[str, int]
server_protocols = defaultdict(int) # type: DefaultDict[str, int]
for edge in activitymap["edges"]: