-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
AMPv2.py
3825 lines (3166 loc) · 123 KB
/
AMPv2.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
"""
CiscoAMP (Advanced Malware Protection) API Integration for Cortex XSOAR (aka Demisto).
"""
import copy
import math
from typing import Callable, Dict, Any, MutableMapping, MutableSequence, Tuple, Optional
from http import HTTPStatus
from collections import namedtuple
from CommonServerUserPython import * # pylint: disable=wildcard-import
""" GLOBAL/PARAMS """ # pylint: disable=pointless-string-statement
INTEGRATION_NAME = "Cisco AMP v2"
DEFAULT_INTERVAL = 30
DEFAULT_TIMEOUT = 600
FETCH_LIMIT = 200
MAX_PAGE_SIZE = 100
FILENAME_REGEX = r"[\w\-\.]+[\w\-\. ]*"
ISO_8601_FORMAT = "%Y-%m-%dT%H:%M:%S.000Z"
XSOAR_SEVERITY_BY_AMP_SEVERITY = {
"Low": IncidentSeverity.LOW,
"Medium": IncidentSeverity.MEDIUM,
"High": IncidentSeverity.HIGH,
"Critical": IncidentSeverity.CRITICAL,
}
PAGINATION_FIELDS = (
"page",
"page_size",
"limit",
"offset",
"number_of_requests",
"offset_multiplier",
"is_automatic",
"is_manual",
)
Pagination = namedtuple(
"Pagination",
(
"page",
"page_size",
"limit",
"offset",
"number_of_requests",
"offset_multiplier",
"is_automatic",
"is_manual",
),
defaults=(None, None, None, None, None, None, None, None),
)
TRAJECTORY_TITLE = "Event Information"
TRAJECTORY_HEADERS_BY_KEYS = {
"ID": ["id"],
"Date": ["date"],
"Event Type": ["event_type"],
"Detection": ["detection"],
"Severity": ["severity"],
"Group GUIDs": ["group_guids"],
}
ACTIVITY_TITLE = "Activity Information"
ACTIVITY_HEADERS_BY_KEYS = {
"Connector GUID": ["connector_guid"],
"Host Name": ["hostname"],
"Windows Processor ID": ["windows_processor_id"],
"Active": ["active"],
}
VULNERABILITY_TITLE = "Vulnerabilities Information"
VULNERABILITY_HEADERS_BY_KEYS = {
"Application": ["application"],
"Version": ["version"],
"Latest Date": ["latest_date"],
"File Name": ["file", "filename"],
"SHA-256": ["file", "identity", "sha256"],
}
EVENT_TYPE_TITLE = "Event Type Information"
EVENT_TYPE_HEADERS_BY_KEYS = {
"ID": ["id"],
"Name": ["name"],
"Description": ["description"],
}
EVENT_TITLE = "Event Information"
EVENT_HEADERS_BY_KEYS = {
"ID": ["id"],
"Date": ["date"],
"Event Type": ["event_type"],
"Detection": ["detection"],
"Connector GUID": ["connector_guid"],
"Severity": ["severity"],
}
GROUPS_TITLE = "Groups Information"
GROUPS_HEADERS_BY_KEYS = {
"Name": ["name"],
"Description": ["description"],
"GUID": ["guid"],
"Source": ["source"],
}
GROUP_TITLE = "Group Information"
GROUP_HEADERS_BY_KEYS = {
"Name": ["name"],
"Description": ["description"],
"Creator": ["creator"],
"Created At": ["created_at"],
"Computers Count": ["computers_count"],
"Descendant Computers Count": ["descendant_computers_count"],
}
VULNERABLE_COMPUTER_TITLE = "Vulnerable Computers Information"
VULNERABLE_COMPUTER_HEADERS_BY_KEYS = {
"Connector GUID": ["connector_guid"],
"Hostname": ["hostname"],
"Windows Processor ID": ["windows_processor_id"],
"Active": ["active"],
"Group GUID": ["group_guid"],
}
POLICY_TITLE = "Policy Information"
POLICY_HEADERS_BY_KEYS = {
"GUID": ["guid"],
"Name": ["name"],
"Description": ["description"],
"Product": ["product"],
"Serial Number": ["serial_number"],
}
FILE_LIST_TITLE = "File List Information"
FILE_LIST_HEADERS_BY_KEYS = {
"GUID": ["guid"],
"Name": ["name"],
"Type": ["type"],
}
FILE_LIST_ITEM_TITLE = "File List Item Information"
FILE_LIST_ITEM_HEADERS_BY_KEYS = {
"SHA-256": ["sha256"],
"Source": ["source"],
"Description": ["description"],
}
ISOLATION_TITLE = "Isolation Information"
ISOLATION_HEADERS_BY_KEYS = {
"Available": ["available"],
"Status": ["status"],
"Unlock Code": ["unlock_code"],
"Comment": ["comment"],
"Isolated By": ["isolated_by"],
}
APP_TRAJECTORY_TITLE = "App Trajectory Information"
APP_TRAJECTORY_HEADERS_BY_KEYS = {
"Connector GUID": ["connector_guid"],
"Date": ["date"],
"Query Type": ["query_type"],
"Dirty URL": ["network_info", "dirty_url"],
}
INDICATOR_TITLE = "Indicator Information"
INDICATOR_HEADERS_BY_KEYS = {
"GUID": ["guid"],
"Name": ["name"],
"Description": ["description"],
"Severity": ["severity"],
"Observed Compromises": ["observed_compromises"],
}
MITRE_TACTIC_TITLE = "Mitre Tactic Information"
MITRE_TECHNIQUE_TITLE = "Mitre Technique Information"
MITRE_HEADERS_BY_KEYS = {
"External ID": ["external_id"],
"Name": ["name"],
"Mitre URL": ["mitre_url"],
}
""" CLIENT CLASS """
class Client(BaseClient):
"""
API Client to communicate with CiscoAMP API.
"""
API_VERSION = "v1"
def __init__(
self,
server_url: str,
api_key: str,
client_id: str,
reliability: str,
verify: bool = False,
proxy: bool = False,
should_create_relationships: bool = True,
):
"""
Build URL with authorization arguments to provide the required Basic Authentication.
Args:
server_url (str): CiscoAMP API URL.
api_key (str): API key to connect to the server.
client_id (str): 3rd Party API Client ID.
reliability (str): Reliability of the source providing the intelligence data.
verify (bool, optional): SSL verification handled by BaseClient. Defaults to False.
proxy (bool, optional): System proxy is handled by BaseClient. Defaults to False.
"""
super().__init__(
base_url=urljoin(server_url, self.API_VERSION),
verify=verify,
proxy=proxy,
auth=(client_id, api_key),
)
self.reliability = reliability
self.should_create_relationships = should_create_relationships
def computer_list_request(
self,
limit: int = None,
offset: int = None,
hostnames: List[str] = None,
internal_ip: str = None,
external_ip: str = None,
group_guids: List[str] = None,
last_seen_within: int = None,
last_seen_over: int = None,
) -> Dict[str, Any]:
"""
Return a single computer with a connector_guid or a list filtered by the other arguments.
Args:
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
hostnames (List[str], optional): Hostname to filter by.
Defaults to None.
internal_ip (str, optional): Internal IP to filter by.
Defaults to None.
external_ip (str, optional): External IP to filter by.
Defaults to None.
group_guid (List[str], optional): Group GUID to filter by.
Defaults to None.
last_seen_within (str, optional): Number of days the last time the computer has been seen within.
Defaults to None.
last_seen_over (str, optional): Number of days the last time the computer has been seen.
Defaults to None.
Returns:
Dict[str, Any]: Information about a list of computers or a single computer.
"""
params = remove_empty_elements(
{
"limit": limit,
"offset": offset,
"hostname[]": hostnames,
"internal_ip": internal_ip,
"external_ip": external_ip,
"group_guid[]": group_guids,
"last_seen_within": last_seen_within,
"last_seen_over": last_seen_over,
}
)
return self._http_request(
method="GET",
url_suffix="/computers",
params=params,
)
def computer_get_request(
self,
connector_guid: str,
) -> Dict[str, Any]:
"""
Return a single computer with a connector_guid.
Args:
connector_guid (str): Specific computer to return.
Returns:
Dict[str, Any]: Information about a computer.
"""
return self._http_request(
method="GET",
url_suffix=f"/computers/{connector_guid}",
)
def computer_trajectory_list_request(
self, connector_guid: str, limit: int = None, query_string: str = None
) -> Dict[str, Any]:
"""
Get information about a computer and its trajectory which be set in a list of events.
Args:
connector_guid (str): Specific computer to return.
limit (int, optional): Maximum number of items to return.
Defaults to None.
query_string (str, optional): Freeform query string which accepts: IP address, SHA-256 or URL.
Defaults to None.
Returns:
Dict[str, Any]: Information about a computer and its trajectory.
"""
params = remove_empty_elements(
{
"limit": limit,
"q": query_string,
}
)
return self._http_request(
method="GET",
url_suffix=f"/computers/{connector_guid}/trajectory",
params=params,
)
def computer_user_activity_get_request(
self,
username: str,
limit: int = None,
offset: int = None,
) -> Dict[str, Any]:
"""
Get computers that have observed activity by given username.
Args:
username (str): Username to filter by.
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
Returns:
Dict[str, Any]: List of computers.
"""
params = remove_empty_elements(
{"q": username, "limit": limit, "offset": offset}
)
return self._http_request(
method="GET",
url_suffix="/computers/user_activity",
params=params,
)
def computer_user_trajectory_list_request(
self, connector_guid: str, limit: int = None, username: str = None
) -> Dict[str, Any]:
"""
Get information about a computer and its trajectory which be set in a list of events.
Args:
connector_guid (str): Specific computer to return.
limit (int, optional): Maximum number of items to return.
Defaults to None.
username (str, optional): Username to filter by.
Defaults to None.
Returns:
Dict[str, Any]: Information about a computer and its trajectory.
"""
params = remove_empty_elements(
{
"limit": limit,
"q": username,
}
)
return self._http_request(
method="GET",
url_suffix=f"/computers/{connector_guid}/user_trajectory",
params=params,
)
def computer_vulnerabilities_list_request(
self,
connector_guid: str,
start_time: str = None,
end_time: str = None,
limit: int = None,
offset: int = None,
) -> Dict[str, Any]:
"""
Return vulnerabilities observed on a specific computer.
Args:
connector_guid (str): Specific computer to return.
start_time (str, optional): Inclusive, include vulnerable programs detected at start_time.
Defaults to None.
end_time (str, optional): Exclusive if end_time is a time, inclusive if end_time is a date,
include vulnerable programs detected before end_time.
Defaults to None.
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
Returns:
Dict[str, Any]: Information about a computer and its vulnerabilities.
"""
params = remove_empty_elements(
{
"start_time": start_time,
"end_time": end_time,
"limit": limit,
"offset": offset,
}
)
return self._http_request(
method="GET",
url_suffix=f"/computers/{connector_guid}/vulnerabilities",
params=params,
)
def computer_move_request(
self, connector_guid: str, group_guid: str
) -> Dict[str, Any]:
"""
Moves the computer with the input connector_guid to a group with the input group_guid.
Args:
connector_guid (str): Connector GUID of the selected computer.
group_guid (str): Group GUID of the group to move the computer to.s
Returns:
Dict[str, Any]: Information about the computer.
"""
return self._http_request(
method="PATCH",
url_suffix=f"/computers/{connector_guid}",
json_data={
"group_guid": group_guid,
},
)
def computer_delete_request(self, connector_guid: str) -> Dict[str, Any]:
"""
Deletes the computer with the connector_guid.
Args:
connector_guid (str): Connector GUID of the selected computer.
Returns:
Dict[str, Any]: Information about the delete operation, if it has succeeded.
"""
return self._http_request(
method="DELETE",
url_suffix=f"/computers/{connector_guid}",
)
def computer_activity_list_request(
self, query_string: str, limit: int = None, offset: str = None
) -> Dict[str, Any]:
"""
Get computers that have observed activity by given username.
Args:
query_string (str): Query string which accepts: IPv4 address, SHA-256, File Name and a URL Fragment.
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
Returns:
Dict[str, Any]: List of computers.
"""
params = remove_empty_elements(
{
"q": query_string,
"limit": limit,
"offset": offset,
}
)
return self._http_request(
method="GET",
url_suffix="/computers/activity",
params=params,
)
def computer_isolation_feature_availability_get_request(
self, connector_guid: str
) -> requests.Response:
"""
Get information about available options for a computer's isolation.
Args:
connector_guid (str): Computer to get information about.
Returns:
requests.Response: Information about a computer's isolation.
"""
return self._http_request(
method="OPTIONS",
url_suffix=f"/computers/{connector_guid}/isolation",
resp_type="response",
)
def computer_isolation_get_request(self, connector_guid: str) -> Dict[str, Any]:
"""
Get information about a computer's isolation.
Args:
connector_guid (str): Computer to get information about.
Returns:
Dict[str, Any]: Information about a computer's isolation.
"""
return self._http_request(
method="GET",
url_suffix=f"/computers/{connector_guid}/isolation",
)
def computer_isolation_create_request(
self, connector_guid: str, comment: str, unlock_code: str
) -> Dict[str, Any]:
"""
Put a computer in isolation.
Args:
connector_guid (str): Computer to put in isolation.
comment (str): Computer to put in isolation.
unlock_code (str): Unlock code.
Returns:
Dict[str, Any]: Information about the computer's isolation.
"""
body = remove_empty_elements(
{
"comment": comment,
"unlock_code": unlock_code,
}
)
return self._http_request(
method="PUT",
url_suffix=f"/computers/{connector_guid}/isolation",
json_data=body,
)
def computer_isolation_delete_request(
self,
connector_guid: str,
comment: str = None,
) -> Dict[str, Any]:
"""
Stop a computer in isolation.
Args:
connector_guid (str): Computer to put in isolation.
comment (str): Computer to put in isolation.
Defaults to None.
Returns:
Dict[str, Any]: Information about the computer's isolation.
"""
body = remove_empty_elements(
{
"comment": comment,
}
)
return self._http_request(
method="DELETE",
url_suffix=f"/computers/{connector_guid}/isolation",
json_data=body,
)
def event_list_request(
self,
detection_sha256: str = None,
application_sha256: str = None,
connector_guids: List[str] = None,
group_guids: List[str] = None,
start_date: str = None,
event_types: List[int] = None,
limit: int = None,
offset: int = None,
) -> Dict[str, Any]:
"""
Get a list of events that can be filtered by the input parameters.
Args:
detection_sha256 (str, optional): Detection SHA-256 to filter by..
Defaults to None.
application_sha256 (str, optional): Application SHA-256 to filter by.
Defaults to None.
connector_guids (List[str], optional): connector_guid for specific computer.
Defaults to None.
group_guids (List[str], optional): Group GUID to filter by.
Defaults to None.
start_date (str, optional): Fetch events that are newer than given time.
Defaults to None.
event_types (List[int], optional): Event type to filter by.
Defaults to None.
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
Returns:
Dict[str, Any]: A list of events.
"""
params = remove_empty_elements(
{
"detection_sha256": detection_sha256,
"application_sha256": application_sha256,
"connector_guid[]": connector_guids,
"group_guid[]": group_guids,
"start_date": start_date,
"event_type[]": event_types,
"limit": limit,
"offset": offset,
}
)
return self._http_request(
method="GET",
url_suffix="/events",
params=params,
)
def event_type_list_request(self) -> Dict[str, Any]:
"""
Get a list of event types.
Returns:
Dict[str, Any]: List of event types.
"""
return self._http_request(
method="GET",
url_suffix="/event_types",
)
def file_list_application_blocking_list_request(
self, names: List[str] = None, limit: int = None, offset: int = None
) -> Dict[str, Any]:
"""
Get a file list of application blocking type.
Args:
names (List[str], optional): Name to filter by.
Defaults to None.
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
Returns:
Dict[str, Any]: File list of application blocking type.
"""
params = remove_empty_elements(
{
"name[]": names,
"limit": limit,
"offset": offset,
}
)
return self._http_request(
method="GET",
url_suffix="/file_lists/application_blocking",
params=params,
)
def file_list_get_request(self, file_list_guid: str) -> Dict[str, Any]:
"""
Get a file list.
Args:
file_list_guid (str): GUID of the file list to get.
Returns:
Dict[str, Any]: Information about a policy.
"""
return self._http_request(
method="GET",
url_suffix=f"/file_lists/{file_list_guid}",
)
def file_list_simple_custom_detections_list_request(
self, names: List[str] = None, limit: int = None, offset: int = None
) -> Dict[str, Any]:
"""
Get a file list of simple custom detections type.
Args:
names (List[str], optional): Name to filter by.
Defaults to None.
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
Returns:
Dict[str, Any]: File list of simple custom detections type.
"""
params = remove_empty_elements(
{
"name[]": names,
"limit": limit,
"offset": offset,
}
)
return self._http_request(
method="GET",
url_suffix="/file_lists/simple_custom_detections",
params=params,
)
def file_list_item_list_request(
self, file_list_guid: str, limit: int = None, offset: int = None
) -> Dict[str, Any]:
"""
Get information about a file list items.
Args:
file_list_guid (str): GUID of the file list to get its items.
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
Returns:
Dict[str, Any]: Information about a file list items.
"""
params = remove_empty_elements(
{
"limit": limit,
"offset": offset,
}
)
return self._http_request(
method="GET",
url_suffix=f"/file_lists/{file_list_guid}/files",
params=params,
)
def file_list_item_get_request(
self, file_list_guid: str, sha256: str
) -> Dict[str, Any]:
"""
Get information about a file list item.
Args:
file_list_guid (str): GUID of the file list to get its items.
sha256 (str): sha256 of item to get.
Returns:
Dict[str, Any]: Information about a file list item.
"""
return self._http_request(
method="GET",
url_suffix=f"/file_lists/{file_list_guid}/files/{sha256}",
)
def file_list_item_create_request(
self, file_list_guid: str, sha256: str, description: str = None
) -> Dict[str, Any]:
"""
Create a new file list item.
Args:
file_list_guid (str): GUID of the file list to add the new item.
sha256 (str): sha256 of the item to create.
Returns:
Dict[str, Any]: Information about the new file list item.
"""
body = remove_empty_elements(
{
"description": description,
}
)
return self._http_request(
method="POST",
url_suffix=f"/file_lists/{file_list_guid}/files/{sha256}",
json_data=body,
)
def file_list_item_delete_request(
self, file_list_guid: str, sha256: str
) -> Dict[str, Any]:
"""
Delete an item from a file list item.
Args:
file_list_guid (str): GUID of the file list to delete item.
sha256 (str): sha256 of the item to delete.
Returns:
Dict[str, Any]: Information about the deletion result.
"""
return self._http_request(
method="DELETE",
url_suffix=f"/file_lists/{file_list_guid}/files/{sha256}",
)
def group_list_request(
self, name: str = None, limit: int = None, offset: int = None
) -> Dict[str, Any]:
"""
Get a list of groups information that can be filtered by a name.
Args:
name (str, optional): Name to filter by.
Defaults to None.
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
Returns:
Dict[str, Any]: List of group information.
"""
params = remove_empty_elements(
{
"name": name,
"limit": limit,
"offset": offset,
}
)
return self._http_request(
method="GET",
url_suffix="/groups",
params=params,
)
def group_get_request(self, group_guid: str) -> Dict[str, Any]:
"""
Get information about a group.
Args:
group_guid (str): GUID of the group to get information about.
Returns:
Dict[str, Any]: Information about a group.
"""
return self._http_request(
method="GET",
url_suffix=f"/groups/{group_guid}",
)
def group_policy_update_request(
self,
group_guid: str,
windows_policy_guid: str = None,
mac_policy_guid: str = None,
android_policy_guid: str = None,
linux_policy_guid: str = None,
) -> Dict[str, Any]:
"""
Update a group's Policy to given Policy GUID.
Args:
group_guid (str): The group to update.
windows_policy_guid (str, optional): Policy GUID for Windows.
Defaults to None.
mac_policy_guid (str, optional): Policy GUID for MAC.
Defaults to None.
android_policy_guid (str, optional): Policy GUID for Android.
Defaults to None.
linux_policy_guid (str, optional): Policy GUID for Linux.
Defaults to None.
Returns:
Dict[str, Any]: Information about the updated group.
"""
body = remove_empty_elements(
{
"windows_policy_guid": windows_policy_guid,
"mac_policy_guid": mac_policy_guid,
"android_policy_guid": android_policy_guid,
"linux_policy_guid": linux_policy_guid,
}
)
return self._http_request(
method="PATCH",
url_suffix=f"groups/{group_guid}",
json_data=body,
)
def group_parent_update_request(
self,
child_guid: str,
parent_group_guid: str = None,
) -> Dict[str, Any]:
"""
Converts an existing group to a child of another group or an existing
child group to a root group (that is, one with no parent groups).
Args:
child_guid (str): Groups GUID to set as child or make as root.
parent_group_guid (str, optional): Group parent to set to child group.
Defaults to None.
Returns:
Dict[str, Any]: Information about the updated group.
"""
return self._http_request(
method="PATCH",
url_suffix=f"groups/{child_guid}/parent",
json_data=remove_empty_elements({"parent_group_guid": parent_group_guid}),
)
def group_create_request(self, name: str, description: str) -> Dict[str, Any]:
"""
Create a new group and get its information.
Args:
name (str): Name of the new group.
description (str): Description of the new group.
Returns:
Dict[str, Any]: Information about the new group.
"""
body = {
"name": name,
"description": description,
}
return self._http_request(
method="POST",
url_suffix="/groups",
json_data=body,
)
def group_delete_request(self, group_guid: str) -> Dict[str, Any]:
"""
Deletes the group with the group_guid.
Args:
group_guid (str): Group GUID of the selected group to delete.
Returns:
Dict[str, Any]: Information about the delete operation, if it has succeeded.
"""
return self._http_request(
method="DELETE",
url_suffix=f"groups/{group_guid}",
)
def indicator_get_request(self, indicator_guid: str) -> Dict[str, Any]:
"""
Get information about a indicator.
Args:
indicator_guid (str): GUID of the indicator to get.
Returns:
Dict[str, Any]: Information about a indicator.
"""
return self._http_request(
method="GET",
url_suffix=f"/indicators/{indicator_guid}",
)
def indicator_list_request(
self, limit: int = None, offset: int = None
) -> Dict[str, Any]:
"""
Get a list of indicators information.
Args:
limit (int, optional): Maximum number of items to return.
Defaults to None.
offset (int, optional): Item number to start looking from.
Defaults to None.
Returns:
Dict[str, Any]: List of indicators information.
"""
params = remove_empty_elements(
{
"limit": limit,
"offset": offset,
}
)
return self._http_request(
method="GET",
url_suffix="/indicators",
params=params,
)
def policy_list_request(
self,
products: List[str] = None,
names: List[str] = None,
limit: int = None,
offset: int = None,
) -> Dict[str, Any]:
"""
Get a list of policies information.
Args: