-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
CTIXv3.py
2150 lines (1873 loc) · 74.3 KB
/
CTIXv3.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
from CommonServerPython import *
from CommonServerUserPython import *
from http import HTTPStatus
import urllib3
import requests
from typing import Any, Callable, Dict, cast
import urllib.parse
import time
import json
import hmac
import hashlib
import base64
import uuid
from datetime import datetime
def is_valid_uuid(uuid_string):
try:
uuid.UUID(uuid_string)
return True
except ValueError:
return False
# register_module_line("CTIX v3", "start", __line__())
# Uncomment while development=
"""IMPORTS"""
# Disable insecure warnings
urllib3.disable_warnings()
"""GLOBALS"""
domain_regex = (
"([a-z¡-\uffff0-9](?:[a-z¡-\uffff0-9-]{0,61}"
"[a-z¡-\uffff0-9])?(?:\\.(?!-)[a-z¡-\uffff0-9-]{1,63}(?<!-))*"
"\\.(?!-)(?!(jpg|jpeg|exif|tiff|tif|png|gif|otf|ttf|fnt|dtd|xhtml|css"
"|html)$)(?:[a-z¡-\uffff-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?$"
"|localhost)"
)
tag_colors = {
"blue": "#0068FA",
"purple": "#5236E2",
"orange": "#EB9C00",
"red": "#FF5330",
"green": "#27865F",
"yellow": "#C4C81D",
"turquoise": "#00A2C2",
"pink": "#C341E7",
"light-red": "#AD6B76",
"grey": "#95A1B1",
}
CTIX_DBOT_MAP = {
"ipv4-addr": "ip",
"ipv6-addr": "ip",
"MD5": "file",
"SHA-1": "file",
"SHA-224": "file",
"SHA-256": "file",
"SHA-384": "file",
"SHA-512": "file",
"SSDEEP": "file",
"domain-name": "domain",
"domain": "domain",
"email-addr": "email",
"email-message": "email",
"artifact": "custom",
"network-traffic": "custom",
"user-agent": "custom",
"windows-registry-key": "custom",
"directory": "custom",
"process": "custom",
"software": "custom",
"user-account": "custom",
"mac-addr": "custom",
"mutex": "custom",
"autonomous-system": "custom",
"cidr": "custom",
"certificate": "x509-certificate",
"url": "url",
}
REGEX_MAP = {
"url": re.compile(urlRegex, regexFlags),
"domain": re.compile(domain_regex, regexFlags),
"hash": re.compile(hashRegex, regexFlags),
}
""" CLIENT CLASS """
class Client(BaseClient):
"""
Client to use in the CTIX integration. Overrides BaseClient
"""
def __init__(
self,
base_url: str,
access_id: str,
secret_key: str,
verify: bool,
proxies: dict,
) -> None:
self.base_url = base_url
self.access_id = access_id
self.secret_key = secret_key
self.verify = verify
self.proxies = proxies
def signature(self, expires: int):
"""
Signature Generation
:param int expires: Epoch time in which time when signature will expire
:return str signature : signature queryset
"""
to_sign = "%s\n%i" % (self.access_id, expires)
return base64.b64encode(
hmac.new(
self.secret_key.encode("utf-8"), to_sign.encode("utf-8"), hashlib.sha1
).digest()
).decode("utf-8")
def add_common_params(self, params: dict):
"""
Add Common Params
:param dict params: Paramters to be added in request
:return dict: Params dictionary with AccessID, Expires and Signature
"""
expires = int(time.time() + 15)
params["AccessID"] = self.access_id
params["Expires"] = expires
params["Signature"] = self.signature(expires)
return params
def get_http_request(self, full_url: str, payload: dict = None, **kwargs):
"""
GET HTTP Request
:param str full_url: URL to be called
:param dict payload: Request body, defaults to None
:raises DemistoException: If Any error is found will be raised on XSOAR
:return dict: Response object
"""
kwargs = self.add_common_params(kwargs)
full_url = full_url + "?" + urllib.parse.urlencode(kwargs)
headers = {"content-type": "application/json"}
resp = requests.get(
full_url,
verify=self.verify,
proxies=self.proxies,
timeout=5,
headers=headers,
json=payload,
)
status_code = resp.status_code
try:
resp.raise_for_status() # Raising an exception for non-200 status code
response = {"data": resp.json(), "status": status_code}
return response
except requests.exceptions.HTTPError:
if status_code == HTTPStatus.NOT_FOUND:
return_error("Your CTIX version does not support this command.")
else:
return_error(f"Error: status-> {status_code!r}; Reason-> {resp.reason!r}]")
def post_http_request(self, full_url: str, payload: dict, params: dict):
"""
POST HTTP Request
:param str full_url: URL to be called
:param dict payload: Request body, defaults to None
:raises DemistoException: If Any error is found will be raised on XSOAR
:return dict: Response object
"""
headers = {"content-type": "application/json"}
params = self.add_common_params(params)
full_url = full_url + "?" + urllib.parse.urlencode(params)
resp = requests.post(
full_url,
verify=self.verify,
proxies=self.proxies,
json=payload,
headers=headers,
timeout=15,
)
status_code = resp.status_code
try:
resp.raise_for_status() # Raising an exception for non-200 status code
response = {"data": resp.json(), "status": status_code}
return response
except requests.exceptions.HTTPError:
if status_code == HTTPStatus.NOT_FOUND:
return_error("Your CTIX version does not support this command.")
else:
return_error(f"Error: status-> {status_code!r}; Reason-> {resp.reason!r}]")
def put_http_request(self, full_url: str, payload: dict, params: dict):
"""
PUT HTTP Request
:param str full_url: URL to be called
:param dict payload: Request body, defaults to None
:raises DemistoException: If Any error is found will be raised on XSOAR
:return dict: Response object
"""
headers = {"content-type": "application/json"}
params = self.add_common_params(params)
full_url = full_url + "?" + urllib.parse.urlencode(params)
resp = requests.put(
full_url,
verify=self.verify,
proxies=self.proxies,
json=payload,
headers=headers,
timeout=15,
)
status_code = resp.status_code
try:
resp.raise_for_status() # Raising an exception for non-200 status codeg
response = {"data": resp.json(), "status": status_code}
return response
except requests.exceptions.HTTPError:
if status_code == HTTPStatus.NOT_FOUND:
return_error("Your CTIX version does not support this command.")
else:
return_error(f"Error: status-> {status_code!r}; Reason-> {resp.reason!r}]")
def delete_http_request(self, full_url: str, payload: dict = None, **kwargs):
"""
DELETE HTTP Request
:param str full_url: URL to be called
:param dict payload: Request body, defaults to None
:raises DemistoException: If Any error is found will be raised on XSOAR
:return dict: Response object
"""
kwargs = self.add_common_params(kwargs)
full_url = full_url + "?" + urllib.parse.urlencode(kwargs)
headers = {"content-type": "application/json"}
resp = requests.delete(
full_url,
verify=self.verify,
proxies=self.proxies,
timeout=5,
headers=headers,
json=payload,
)
status_code = resp.status_code
try:
resp.raise_for_status() # Raising an exception for non-200 status code
response = {"data": resp.json(), "status": status_code}
return response
except requests.exceptions.HTTPError:
if status_code == HTTPStatus.BAD_REQUEST:
response = {"data": {}, "status": status_code}
return response
return_error(f"Error: status-> {status_code!r}; Reason-> {resp.reason!r}]")
def test_auth(self):
"""
Test authentication
:return dict: Returns result for ping
"""
client_url = self.base_url + "ping/"
return self.get_http_request(client_url)
def create_tag(self, name: str, color_code: str):
"""Creates a tag in ctix platform
:type name: ``str``
:param name: Name of the tag
:type color_code: ``str``
:param color_code: Hex color code of the tag e.g #111111
:return: dict containing the details of newly created tag
:rtype: ``Dict[str, Any]``
"""
url_suffix = "ingestion/tags/"
client_url = self.base_url + url_suffix
payload = {"name": name, "color_code": color_code}
return self.post_http_request(full_url=client_url, payload=payload, params={})
def get_tags(self, page: int, page_size: int, q: str):
"""Paginated list of tags from ctix platform using page_number and page_size
:type page: int
:param page: page number for the pagination for list api
:type page_size: int
:param page_size: page size for the pagination for list api
:type q: str
:param q: search query string for the list api
"""
url_suffix = "ingestion/tags/"
client_url = self.base_url + url_suffix
params = {"page": page, "page_size": page_size}
if q:
params["q"] = q # type: ignore
return self.get_http_request(client_url, params)
def delete_tag(self, tag_id: str):
"""Deletes a tag from the ctix instance
:type tag_id: ``str``
:param name: id of the tag to be deleted
"""
url_suffix = "ingestion/tags/bulk-actions/"
client_url = self.base_url + url_suffix
return self.post_http_request(
client_url, {"ids": tag_id, "action": "delete"}, {}
)
def whitelist_iocs(self, ioc_type, values, reason):
url_suffix = "conversion/whitelist/"
client_url = self.base_url + url_suffix
payload = {"type": ioc_type, "values": values, "reason": reason}
return self.post_http_request(client_url, payload, {})
def get_whitelist_iocs(self, page: int, page_size: int, q: str):
"""Paginated list of tags from ctix platform using page_number and page_size
:type page: int
:param page: page number for the pagination for list api
:type page_size: int
:param page_size: page size for the pagination for list api
:type q: str
:param q: search query string for the list api
"""
url_suffix = "conversion/whitelist/"
client_url = self.base_url + url_suffix
params = {"page": page, "page_size": page_size}
if q:
params["q"] = q # type: ignore
return self.get_http_request(client_url, {}, **params)
def remove_whitelisted_ioc(self, whitelist_id: str):
"""Removes whitelisted ioc with given `whitelist_id`
:type whitelist_id: str
:param whitelist_id: id of the whitelisted ioc to be removed
"""
url_suffix = "conversion/whitelist/bulk-actions/"
client_url = self.base_url + url_suffix
return self.post_http_request(
client_url, {"ids": whitelist_id, "action": "delete"}, {}
)
def get_threat_data(self, page: int, page_size: int, query: str):
"""
Get Threat Data
:param int page: Paginated number from where data will be polled
:param int page_size: Size of the result
:param str query: CQL query for polling specific result
:return dict: Returns response for query
"""
url_suffix = "ingestion/threat-data/list/"
client_url = self.base_url + url_suffix
params = {"page": page, "page_size": page_size}
payload = {"query": query}
return self.post_http_request(client_url, payload=payload, params=params)
def get_saved_searches(self, page: int, page_size: int):
"""
Get Saved Searches
:param int page: Paginated number from where data will be polled
:param int page_size: Size of the result
:return dict: Returns response for query
"""
url_suffix = "ingestion/saved-searches/"
client_url = self.base_url + url_suffix
params = {"page": page, "page_size": page_size}
return self.get_http_request(client_url, {}, **params)
def get_server_collections(self, page: int, page_size: int):
"""
Get Server Collections
:param int page: Paginated number from where data will be polled
:param int page_size: Size of the result
:return dict: Returns response for query
"""
url_suffix = "publishing/collection/"
client_url = self.base_url + url_suffix
params = {"page": page, "page_size": page_size}
return self.get_http_request(client_url, {}, **params)
def get_actions(self, page: int, page_size: int, params: Dict[str, Any]):
"""
Get Actions
:param int page: Paginated number from where data will be polled
:param int page_size: Size of the result
:param Dict[str, Any] params: Params to be send with request
:return dict: Returns response for query
"""
url_suffix = "ingestion/actions/"
client_url = self.base_url + url_suffix
params["page"] = page
params["page_size"] = page_size
return self.get_http_request(client_url, **params)
def add_indicator_as_false_positive(self, object_ids: List[str], object_type: str):
"""
Add Indicator as False Positive
:param list[str] object_ids: Object IDs of the IOCs
:param str object_type: Object type of the IOCs
:return dict: Returns response for query
"""
url_suffix = "ingestion/threat-data/bulk-action/false_positive/"
client_url = self.base_url + url_suffix
payload = {"object_ids": object_ids, "object_type": object_type, "data": {}}
return self.post_http_request(client_url, payload, {})
def add_ioc_to_manual_review(self, object_ids: List[str], object_type: str):
"""
Add IOC to Manual Review
:param list[str] object_ids: Object IDs of the IOCs
:param str object_type: Object type of the IOCs
:return dict: Returns response for query
"""
url_suffix = "ingestion/threat-data/bulk-action/manual_review/"
client_url = self.base_url + url_suffix
payload = {"object_ids": object_ids, "object_type": object_type, "data": {}}
return self.post_http_request(client_url, payload, {})
def deprecate_ioc(self, object_ids: str, object_type: str):
"""
Deprecate IOC
:param str object_ids: Object ID of the IOC
:param str object_type: Object type of the IOC
:return dict: Returns response for query
"""
url_suffix = "ingestion/threat-data/bulk-action/deprecate/"
client_url = self.base_url + url_suffix
payload = {"object_ids": object_ids, "object_type": object_type, "data": {}}
return self.post_http_request(client_url, payload, {})
def add_analyst_tlp(self, object_id: str, object_type: str, data):
"""
Add Analyst TLP
:param str object_id: Object ID of the IOCs
:param str object_type: _Object type of the IOCs
:param dict data: data to be send over POST request
:return dict: Returns response for query
"""
url_suffix = "ingestion/threat-data/action/analyst_tlp/"
client_url = self.base_url + url_suffix
payload = {"object_id": object_id, "object_type": object_type, "data": data}
return self.post_http_request(client_url, payload, {})
def add_analyst_score(self, object_id: str, object_type, data):
"""
Add Analyst Score
:param str object_id: Object ID of the IOCs
:param str object_type: Object type of the IOCs
:param dict data: Request body to be send over POST request
:return dict: Returns response for query
"""
url_suffix = "ingestion/threat-data/action/analyst_score/"
client_url = self.base_url + url_suffix
payload = {"object_id": object_id, "object_type": object_type, "data": data}
return self.post_http_request(client_url, payload, {})
def saved_result_set(self, page: int, page_size: int, label_name: str, query: str):
"""
Saved Result Set
:param int page: Paginated number from where data will be polled
:param int page_size: Size of the result
:param str label_name: Label name used to get the data from the rule
:param str query: CQL query to get specific data
:return dict: Returns response for query
"""
url_suffix = "ingestion/threat-data/list/"
client_url = self.base_url + url_suffix
params = {}
params.update({"page": page})
params.update({"page_size": page_size})
if query is None:
query = "type=indicator"
payload = {"label_name": label_name, "query": query}
return self.post_http_request(client_url, payload, params)
def tag_indicator_updation(
self,
q: str,
page: int,
page_size: int,
object_id: str,
object_type: str,
tag_id: str,
operation: str,
):
"""
Tag Indicator Updation
:param str q: query to be send
:param int page: Paginated number from where data will be polled
:param int page_size: Size of the result
:param str object_id: Object ID of the IOCs
:param str object_type: Object type of the IOCs
:param str tag_id: Tag ID that will be removed or added
:param str operation: Addition or Removal of tag operation
:return dict: Returns response for query
"""
tags_data = self.get_indicator_tags(
object_type, object_id, {"page": page, "page_size": page_size}
)["data"]
tags = [_["id"] for _ in tags_data["tags"]]
if operation == "add_tag_indicator":
tags.extend([_.strip() for _ in tag_id.split(",")])
elif operation == "remove_tag_from_indicator":
removable_tags = [_.strip() for _ in tag_id.split(",")]
for r_tag in removable_tags:
if r_tag in tags:
tags.remove(r_tag)
final_tags = list(set(tags))
url_suffix = "ingestion/threat-data/action/add_tag/"
client_url = self.base_url + url_suffix
params = {"page": page, "page_size": page_size, "q": q}
payload = {
"object_id": object_id,
"object_type": object_type,
"data": {"tag_id": final_tags},
}
return self.post_http_request(client_url, payload, params)
def search_for_tag(self, params: dict):
"""
Search for tag
:param dict params: Paramters to be added in request
:return dict: Returns response for query
"""
url_suffix = "ingestion/tags/"
client_url = self.base_url + url_suffix
return self.get_http_request(client_url, **params)
def get_indicator_details(self, object_type: str, object_id: str, params: dict):
"""
Get Indicator Details
:param str object_type: Object type of the IOCs
:param str object_id: Object ID of the IOCs
:param dict params: Paramters to be added in request
:return dict: Returns response for query
"""
url_suffix = f"ingestion/threat-data/{object_type}/{object_id}/basic/"
client_url = self.base_url + url_suffix
return self.get_http_request(client_url, **params)
def get_indicator_tags(self, object_type: str, object_id: str, params: dict):
"""
Get Indicator Tags
:param str object_type: Object type of the IOCs
:param str object_id: Object ID of the IOCs
:param dict params: Paramters to be added in request
:return dict: Returns response for query
"""
url_suffix = f"ingestion/threat-data/{object_type}/{object_id}/quick-actions/"
client_url = self.base_url + url_suffix
return self.get_http_request(client_url, **params)
def get_indicator_relations(self, object_type: str, object_id: str, params: dict):
"""
Get Indicator Relations
:param str object_type: Object type of the IOCs
:param str object_id: Object ID of the IOCs
:param dict params: Paramters to be added in request
:return dict: Returns response for query
"""
url_suffix = f"ingestion/threat-data/{object_type}/{object_id}/relations/"
client_url = self.base_url + url_suffix
return self.get_http_request(client_url, **params)
def get_indicator_observations(self, params: dict):
"""
Get Indicator Observations
:param dict params: Paramters to be added in request
:return dict: Returns response for query
"""
url_suffix = "ingestion/threat-data/source-references/"
client_url = self.base_url + url_suffix
return self.get_http_request(client_url, **params)
def get_conversion_feed_source(self, params: dict):
"""
Get Conversion Feed Source
:param dict params: Paramters to be added in request
:return dict: Returns response for query
"""
url_suffix = "conversion/feed-sources/"
client_url = self.base_url + url_suffix
return self.get_http_request(client_url, **params)
def get_lookup_threat_data(
self, object_type: str, ioc_type: list, object_names: list, params: dict
):
"""
Get Lookup Threat Data
:param str object_type: (SDO) Object type of the IOCs
:param list ioc_type: the IOC type of the Indicator (eg. URL, MD5, IPv4)
:param list object_names: Indicator/IOCs names
:param dict params: Paramters to be added in request
:return dict: Returns response for query
"""
url_suffix = "ingestion/threat-data/list/"
query = f"type={object_type}"
if len(ioc_type) == 1:
query += f" AND ioc_type IN ('{ioc_type[0]}')"
elif len(ioc_type) > 1:
query += f" AND ioc_type IN {tuple(ioc_type)}"
if len(object_names) == 1:
query += f" AND value IN ('{object_names[0]}')"
else:
query += f" AND value IN {tuple(object_names)}"
payload = {"query": query}
client_url = self.base_url + url_suffix
return self.post_http_request(client_url, payload, params)
def bulk_lookup_and_create_data(self, object_names, source, collection, page_size):
url_suffix = "ingestion/threat-data/bulk-lookup-and-create/"
client_url = self.base_url + url_suffix
params = {"create": "true", "page_size": page_size}
payload = {
"ioc_values": object_names,
"metadata": {
"tlp": "AMBER",
"confidence": 100,
"tags": []
},
"source": {
"source_name": source
},
"collection": {
"collection_name": collection
}
}
return self.post_http_request(client_url, payload, params)
def get_vulnerability_product_details(self, obj_id: str, page: int, page_size: int):
"""
Get Vulnerability Product Details
:param str obj_id: The ID of the vulnerability to get the product details for
:param int page: Paginated number from where data will be polled
:param int page_size: Size of the result
:return dict: Returns response for query
"""
url_suffix = f"ingestion/threat-data/vulnerability/{obj_id}/product-details/"
client_url = self.base_url + url_suffix
params = {"page": page, "page_size": page_size}
return self.get_http_request(client_url, {}, **params)
def get_vulnerability_cvss_score(self, obj_id: str, page: int, page_size: int):
"""
Get Vulnerability CVSS Score
:param str obj_id: The ID of the vulnerability to get the product details for
:param int page: Paginated number from where data will be polled
:param int page_size: Size of the result
:return dict: Returns response for query
"""
url_suffix = f"ingestion/threat-data/vulnerability/{obj_id}/cvss-score/"
client_url = self.base_url + url_suffix
params = {"page": page, "page_size": page_size}
return self.get_http_request(client_url, {}, **params)
def get_vulnerability_source_description(self, obj_id: str, source_id: str, page: int, page_size: int):
"""
Get Vulnerability Source Description
:param str obj_id: The ID of the vulnerability to get the source description for
:param str source_id: The ID of the source to get the description for
:param int page: Paginated number from where data will be polled
:param int page_size: Size of the result
:return dict: Returns response for query
"""
url_suffix = f"ingestion/threat-data/vulnerability/{obj_id}/source-description/"
client_url = self.base_url + url_suffix
params = {"source_id": source_id, "page": page, "page_size": page_size}
return self.get_http_request(client_url, {}, **params)
""" HELPER FUNCTIONS """
def to_dbot_score(ctix_score: int) -> int:
"""
Maps CTIX Score to DBotScore
"""
if ctix_score == 0:
dbot_score = Common.DBotScore.NONE # unknown
elif ctix_score <= 30:
dbot_score = Common.DBotScore.GOOD # good
elif ctix_score <= 70:
dbot_score = Common.DBotScore.SUSPICIOUS # suspicious
else:
dbot_score = Common.DBotScore.BAD
return dbot_score
def no_result_found(data: Any):
if data in ("", " ", None, [], {}):
result = CommandResults(
readable_output="No results were found",
outputs=None,
raw_response=None,
)
else:
result = data
return result
def check_for_empty_variable(value: str, default: Any):
return value if value not in ("", " ", None) else default
def iter_dbot_score(
data: list,
score_key: str,
type_key: str,
table_name: str,
output_prefix: str,
outputs_key_field: str,
reliability: str = None,
):
final_data = []
for value in data:
if value[type_key] is not None:
indicator_type = CTIX_DBOT_MAP[value[type_key]]
score = to_dbot_score(value.get(score_key, 0))
if indicator_type == "ip":
dbot_score = Common.DBotScore(
indicator=value.get("name"),
indicator_type=DBotScoreType.IP,
integration_name="CTIX",
score=score,
reliability=reliability,
)
ip_standard_context = Common.IP(
ip=value.get("name"), asn=value.get("asn"), dbot_score=dbot_score
)
final_data.append(
CommandResults(
readable_output=tableToMarkdown(
table_name, value, removeNull=True
),
outputs_prefix=output_prefix,
outputs_key_field=outputs_key_field,
outputs=value,
indicator=ip_standard_context,
raw_response=value,
)
)
elif indicator_type == "file":
dbot_score = Common.DBotScore(
indicator=value.get("name"),
indicator_type=DBotScoreType.FILE,
integration_name="CTIX",
score=score,
reliability=reliability,
)
file_standard_context = Common.File(
name=value.get("name"), dbot_score=dbot_score
)
file_key = value.get("name")
hash_type = value.get("attribute_field", "Unknown").lower()
if hash_type == "md5":
file_standard_context.md5 = file_key
elif hash_type == "sha-1":
file_standard_context.sha1 = file_key
elif hash_type == "sha-256":
file_standard_context.sha256 = file_key
elif hash_type == "sha-512":
file_standard_context.sha512 == file_key
final_data.append(
CommandResults(
readable_output=tableToMarkdown(
table_name, value, removeNull=True
),
outputs_prefix=output_prefix,
outputs_key_field=outputs_key_field,
outputs=value,
indicator=file_standard_context,
raw_response=value,
)
)
elif indicator_type == "domain":
dbot_score = Common.DBotScore(
indicator=value.get("name"),
indicator_type=DBotScoreType.DOMAIN,
integration_name="CTIX",
score=score,
reliability=reliability,
)
domain_standard_context = Common.Domain(
domain=value.get("name"), dbot_score=dbot_score
)
final_data.append(
CommandResults(
readable_output=tableToMarkdown(
table_name, value, removeNull=True
),
outputs_prefix=output_prefix,
outputs_key_field=outputs_key_field,
outputs=value,
indicator=domain_standard_context,
raw_response=value,
)
)
elif indicator_type == "email":
dbot_score = Common.DBotScore(
indicator=value.get("name"),
indicator_type=DBotScoreType.EMAIL,
integration_name="CTIX",
score=score,
reliability=reliability,
)
email_standard_context = Common.Domain(
domain=value.get("name"), dbot_score=dbot_score
)
final_data.append(
CommandResults(
readable_output=tableToMarkdown(
table_name, value, removeNull=True
),
outputs_prefix=output_prefix,
outputs_key_field=outputs_key_field,
outputs=value,
indicator=email_standard_context,
raw_response=value,
)
)
elif indicator_type == "url":
dbot_score = Common.DBotScore(
indicator=value.get("name"),
indicator_type=DBotScoreType.URL,
integration_name="CTIX",
score=score,
reliability=reliability,
)
url_standard_context = Common.URL(
url=value.get("name"), dbot_score=dbot_score
)
final_data.append(
CommandResults(
readable_output=tableToMarkdown(
table_name, value, removeNull=True
),
outputs_prefix=output_prefix,
outputs_key_field=outputs_key_field,
outputs=value,
indicator=url_standard_context,
raw_response=value,
)
)
else: # indicator_type == 'custom'
final_data.append(
CommandResults(
readable_output=tableToMarkdown(
table_name, value, removeNull=True
),
outputs_prefix=output_prefix,
outputs_key_field=outputs_key_field,
outputs=value,
raw_response=value,
)
)
else:
final_data.append(
CommandResults(
readable_output=tableToMarkdown(table_name, value, removeNull=True),
outputs_prefix=output_prefix,
outputs_key_field=outputs_key_field,
outputs=value,
raw_response=value,
)
)
return final_data
""" COMMAND FUNCTIONS """
def test_module(client: Client):
"""
Performs basic get request to get sample ip details.
"""
client.test_auth()
# test was successful
demisto.results("ok")
def create_tag_command(client: Client, args: Dict[str, str]) -> CommandResults:
"""
create_tag command: Creates a new tag in the CTIX platform
"""
name = args["tag_name"]
color_name = args["color"]
color_code = tag_colors[color_name]
response = client.create_tag(name, color_code)
data = response.get("data")
data = no_result_found(data)
if isinstance(data, CommandResults):
return data
else:
results = CommandResults(
readable_output=tableToMarkdown("Tag Data", data, removeNull=True),
outputs_prefix="CTIX.Tag",
outputs_key_field="name",
outputs=data,
raw_response=data,
)
return results
def get_tags_command(client: Client, args=Dict[str, Any]) -> List[CommandResults]:
"""
get_tags commands: Returns paginated list of tags
"""
page = args["page"]
page = check_for_empty_variable(page, 1)
page_size = args["page_size"]
page_size = check_for_empty_variable(page_size, 10)
query = args.get("q", "")
response = client.get_tags(page, page_size, query)
tags_list = response.get("data", {}).get("results", [])
tags_list = no_result_found(tags_list)
if isinstance(tags_list, CommandResults):
return [tags_list]
else:
results = []
for tag in tags_list:
results.append(
CommandResults(
readable_output=tableToMarkdown("Tag Data", tag, removeNull=True),
outputs_prefix="CTIX.Tag",
outputs_key_field="name",
outputs=tag,
)
)
return results
def delete_tag_command(client: Client, args: dict) -> CommandResults:
"""
delete_tag command: Deletes a tag with given tag_name
"""
tag_name = argToList(args.get("tag_name"))
final_result = []
for tag in tag_name:
search_result = client.get_tags(1, 10, tag)
tags = search_result.get("data", {}).get("results", [])
response = client.delete_tag(tags[0]["id"])
final_result.append(response.get("data"))
final_result = no_result_found(final_result)
if isinstance(final_result, CommandResults):
return final_result
else:
results = CommandResults(
readable_output=tableToMarkdown(
"Tag Response", final_result, removeNull=True
),
outputs_prefix="CTIX.DeleteTag",