forked from kevoreilly/CAPEv2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
dist.py
1551 lines (1332 loc) · 61.5 KB
/
dist.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
# encoding: utf-8
#!/usr/bin/env python
# Copyright (C) 2010-2015 Cuckoo Foundation.
# This file is part of Cuckoo Sandbox - http://www.cuckoosandbox.org
# See the file 'docs/LICENSE' for copying permission.
# ToDo
# https://github.com/cuckoosandbox/cuckoo/pull/1694/files
from __future__ import absolute_import, print_function
import argparse
import distutils.util
import hashlib
import json
import logging
import os
import queue
import shutil
import sys
import threading
import time
import zipfile
from datetime import datetime, timedelta
from io import BytesIO
from itertools import combinations
from logging import handlers
from zipfile import ZipFile
from sqlalchemy import and_, or_
from sqlalchemy.exc import OperationalError, SQLAlchemyError
try:
import pyzipper
except ImportError:
sys.exti("Missed pyzipper dependency: pip3 install pyzipper -U")
CUCKOO_ROOT = os.path.join(os.path.abspath(os.path.dirname(__file__)), "..")
sys.path.append(CUCKOO_ROOT)
from lib.cuckoo.common.config import Config
from lib.cuckoo.common.dist_db import ExitNodes, Machine, Node, Task, create_session
from lib.cuckoo.common.utils import get_options
from lib.cuckoo.core.database import (
TASK_DISTRIBUTED,
TASK_DISTRIBUTED_COMPLETED,
TASK_FAILED_REPORTING,
TASK_PENDING,
TASK_REPORTED,
TASK_RUNNING,
Database,
)
from lib.cuckoo.core.database import Task as MD_Task
# we need original db to reserve ID in db,
# to store later report, from master or worker
reporting_conf = Config("reporting")
zip_pwd = Config("web").zipped_download.zip_pwd
if not isinstance(zip_pwd, bytes):
zip_pwd = zip_pwd.encode()
# init
logging.getLogger("elasticsearch").setLevel(logging.WARNING)
logging.getLogger("requests").setLevel(logging.WARNING)
logging.getLogger("urllib3").setLevel(logging.WARNING)
# Move to config
dist_ignore_patterns = shutil.ignore_patterns("binary", "dump_sorted.pcap", "memory.dmp", "logs")
STATUSES = {}
ID2NAME = {}
SERVER_TAGS = {}
main_db = Database()
dead_count = 5
if reporting_conf.distributed.dead_count:
dead_count = reporting_conf.distributed.dead_count
NFS_BASED_FETCH = reporting_conf.distributed.get("nfs")
INTERVAL = 10
# controller of dead nodes
failed_count = {}
# status controler count to reset number
status_count = {}
lock_retriever = threading.Lock()
dist_lock = threading.BoundedSemaphore(int(reporting_conf.distributed.dist_threads))
fetch_lock = threading.BoundedSemaphore(1)
delete_enabled = False
failed_clean_enabled = False
def required(package):
sys.exit("The %s package is required: pip3 install %s" % (package, package))
try:
from flask import Flask, jsonify, make_response, request
except ImportError:
required("flask")
try:
import requests
from requests.auth import HTTPBasicAuth
except ImportError:
required("requests")
try:
requests.packages.urllib3.disable_warnings()
except AttributeError:
pass
try:
from flask_restful import Api as RestApi
from flask_restful import Resource as RestResource
from flask_restful import abort, reqparse
except ImportError:
required("flask-restful")
session = create_session(reporting_conf.distributed.db, echo=False)
def node_status(url, name, apikey):
try:
r = requests.get(
os.path.join(url, "cuckoo", "status/"), headers={"Authorization": f"Token {apikey}"}, verify=False, timeout=300
)
return r.json().get("data", {})
except Exception as e:
log.critical("Possible invalid Cuckoo node (%s): %s", name, e)
return {}
def node_fetch_tasks(status, url, apikey, action="fetch", since=0):
try:
url = os.path.join(url, "tasks", "list/")
params = dict(status=status, ids=True)
if action == "fetch":
params["completed_after"] = since
r = requests.get(url, params=params, headers={"Authorization": f"Token {apikey}"}, verify=False)
if not r.ok:
log.error(f"Error fetching task list. Status code: {r.status_code} - {r.url}")
log.info("Saving error to /tmp/dist_error.html")
with open("/tmp/dist_error.html", "wb") as f:
f.write(r.content)
return []
return r.json().get("data", [])
except Exception as e:
log.critical("Error listing completed tasks (node %s): %s", url, e)
return []
def node_list_machines(url, apikey):
try:
r = requests.get(os.path.join(url, "machines", "list/"), headers={"Authorization": f"Token {apikey}"}, verify=False)
for machine in r.json()["data"]:
yield Machine(name=machine["name"], platform=machine["platform"], tags=machine["tags"])
except Exception as e:
abort(404, message="Invalid CAPE node (%s): %s" % (url, e))
def node_list_exitnodes(url, apikey):
try:
r = requests.get(os.path.join(url, "exitnodes/"), headers={"Authorization": f"Token {apikey}"}, verify=False)
for exitnode in r.json()["data"]:
yield exitnode
except Exception as e:
abort(404, message="Invalid CAPE node (%s): %s" % (url, e))
def node_get_report(task_id, fmt, url, apikey, stream=False):
try:
url = os.path.join(url, "tasks", "get", "report", "%d/" % task_id, fmt)
return requests.get(url, stream=stream, headers={"Authorization": f"Token {apikey}"}, verify=False, timeout=800)
except Exception as e:
log.critical("Error fetching report (task #%d, node %s): %s", task_id, url, e)
# For older systems as ubuntu 18.04 and lower than py3.8
# ToDo remvoe in future
def copytree(src, dst, symlinks=False, ignore=None):
for item in os.listdir(src):
if item in ("binary", "dump_sorted.pcap", "memory.dmp", "logs"):
continue
s = os.path.join(src, item)
d = os.path.join(dst, item)
if os.path.isdir(s):
shutil.copytree(s, d, symlinks, ignore)
else:
shutil.copy2(s, d, follow_symlinks=False)
def node_get_report_nfs(task_id, worker_name, main_task_id):
worker_path = os.path.join("/mnt", f"cape_worker_{worker_name}", "storage", "analyses", str(task_id))
if not os.path.exists(worker_path):
log.error(f"File on destiny doesn't exist: {worker_path}")
return False
analyses_path = os.path.join(CUCKOO_ROOT, "storage", "analyses", str(main_task_id))
if not os.path.exists(analyses_path):
os.makedirs(analyses_path, mode=0o755)
try:
# py 3.8
if sys.version_info[:2] >= (3, 8):
shutil.copytree(
worker_path, analyses_path, ignore=dist_ignore_patterns, ignore_dangling_symlinks=True, dirs_exist_ok=True
)
else:
copytree(worker_path, analyses_path, True, dist_ignore_patterns)
except Exception as e:
log.exception(e)
return False
return True
def _delete_many(node, ids, nodes, db):
if nodes[node].name == "master":
return
try:
url = os.path.join(nodes[node].url, "tasks", "delete_many/")
apikey = nodes[node].apikey
log.debug("Removing task id(s): {0} - from node: {1}".format(ids, nodes[node].name))
res = requests.post(
url,
headers={"Authorization": f"Token {apikey}"},
data={"ids": ids, "delete_mongo": False},
verify=False,
)
if res and res.status_code != 200:
log.info("{} - {}".format(res.status_code, res.content))
db.rollback()
except Exception as e:
log.critical("Error deleting task (tasks #%s, node %s): %s", ids, nodes[node].name, e)
db.rollback()
def node_submit_task(task_id, node_id):
db = session()
node = db.query(Node).with_entities(Node.id, Node.name, Node.url, Node.apikey).filter_by(id=node_id).first()
task = db.query(Task).filter_by(id=task_id).first()
check = False
try:
if node.name == "master":
return
# Remove the earlier appended comma
if task.tags:
if task.tags[-1] == ",":
task.tags = task.tags[:-1]
apikey = node.apikey
data = dict(
package=task.package,
timeout=task.timeout,
priority=task.priority,
options=task.options,
machine=task.machine,
platform=task.platform,
tags=task.tags,
custom=task.custom,
clock=task.clock,
memory=task.memory,
enforce_timeout=task.enforce_timeout,
route=task.route,
)
if task.category in ("file", "pcap"):
if task.category == "pcap":
data = {"pcap": 1}
url = os.path.join(node.url, "tasks", "create", "file/")
# If the file does not exist anymore, ignore it and move on
# to the next file.
if not os.path.exists(task.path):
task.finished = True
task.retrieved = True
main_db.set_status(task.main_task_id, TASK_FAILED_REPORTING)
try:
db.commit()
except Exception as e:
log.exception(e)
db.rollback()
return
try:
files = dict(file=open(task.path, "rb"))
r = requests.post(url, data=data, files=files, headers={"Authorization": f"Token {apikey}"}, verify=False)
except OSError:
task.finished = True
task.retrieved = True
main_db.set_status(task.main_task_id, TASK_FAILED_REPORTING)
try:
db.commit()
except Exception as e:
log.exception(e)
db.rollback()
return
elif task.category == "url":
url = os.path.join(node.url, "tasks", "create", "url/")
r = requests.post(
url, data={"url": task.path, "options": task.options}, headers={"Authorization": f"Token {apikey}"}, verify=False
)
elif task.category == "static":
url = os.path.join(node.url, "tasks", "create", "static/")
files = dict(file=open(task.path, "rb"))
r = requests.post(url, data=data, files=files, headers={"Authorization": f"Token {apikey}"}, verify=False)
else:
log.debug("Target category is: {}".format(task.category))
db.close()
return
# encoding problem
if r.status_code == 500 and task.category == "file":
r = requests.post(url, data=data, files={"file": ("file", open(task.path, "rb").read())}, verify=False)
# Zip files preprocessed, so only one id
if r and r.status_code == 200:
if (
"task_ids" in r.json().get("data", {})
and len(r.json().get("data", {})["task_ids"]) > 0
and r.json().get("data", {})["task_ids"] is not None
):
task.task_id = r.json().get("data", {})["task_ids"][0]
check = True
elif r.json().get("task_id", 0) > 0:
task.task_id = r.json()["task_id"]
check = True
else:
log.debug("Failed to submit task {} to node: {}, code: {}".format(task_id, node.name, r.status_code))
log.debug("Submitted task to worker: {} - {} - {}".format(node.name, task.task_id, task.main_task_id))
elif r.status_code == 500:
log.debug((r.status_code, r.text))
elif r.status_code == 429:
log.info((r.status_code, "see api auth for more details"))
else:
log.info("Node: {} - Task submit to worker failed: {} - {}".format(node.id, r.status_code, r.content))
if check:
task.node_id = node.id
# We have to refresh() the task object because otherwise we get
# the unmodified object back in further sql queries..
# TODO Commit once, refresh() all at once. This could potentially
# become a bottleneck.
try:
db.commit()
db.refresh(task)
except Exception as e:
print(e)
db.rollback()
except Exception as e:
log.exception(e)
log.critical("Error submitting task (task #%d, node %s): %s", task.id, node.name, e)
db.commit()
db.close()
return check
# class Retriever():
class Retriever(threading.Thread):
def run(self):
self.cleaner_queue = queue.Queue()
self.fetcher_queue = queue.Queue()
self.cfg = Config()
self.t_is_none = {}
self.status_count = {}
self.current_queue = {}
self.current_two_queue = {}
self.stop_dist = threading.Event()
self.threads = []
for x in range(int(reporting_conf.distributed.dist_threads)):
if dist_lock.acquire(blocking=False):
if NFS_BASED_FETCH:
thread = threading.Thread(target=self.fetch_latest_reports_nfs, name="fetch_latest_reports_nfs", args=())
else:
thread = threading.Thread(target=self.fetch_latest_reports, name="fetch_latest_reports", args=())
thread.daemon = True
thread.start()
self.threads.append(thread)
if fetch_lock.acquire(blocking=False):
thread = threading.Thread(target=self.fetcher, name="fetcher", args=())
thread.daemon = True
thread.start()
self.threads.append(thread)
# Delete the task and all its associated files.
# (It will still remain in the nodes" database, though.)
if reporting_conf.distributed.remove_task_on_worker or delete_enabled:
thread = threading.Thread(target=self.remove_from_worker, name="remove_from_worker", args=())
thread.daemon = True
thread.start()
self.threads.append(thread)
if reporting_conf.distributed.failed_cleaner or failed_clean_enabled:
thread = threading.Thread(target=self.failed_cleaner, name="failed_to_clean", args=())
thread.daemon = True
thread.start()
self.threads.append(thread)
thread = threading.Thread(target=self.free_space_mon, name="free_space_mon", args=())
thread.daemon = True
thread.start()
self.threads.append(thread)
if reporting_conf.callback.enabled:
thread = threading.Thread(target=self.notification_loop, name="notification_loop", args=())
thread.daemon = True
thread.start()
self.threads.append(thread)
# thread monitoring
for thr in self.threads:
try:
thr.join(timeout=0.0)
log.info(f"Thread: {thr.getName()} - Alive: {thr.is_alive()}")
except Exception as e:
log.exception(e)
time.sleep(60)
def free_space_mon(self):
# If not enough free disk space is available, then we print an
# error message and wait another round (this check is ignored
# when the freespace configuration variable is set to zero).
while True:
if self.cfg.cuckoo.freespace:
# Resolve the full base path to the analysis folder, just in
# case somebody decides to make a symbolic link out of it.
dir_path = os.path.join(CUCKOO_ROOT, "storage", "analyses")
if hasattr(os, "statvfs") and os.path.exists(dir_path):
dir_stats = os.statvfs(dir_path)
# Calculate the free disk space in megabytes.
space_available = dir_stats.f_bavail * dir_stats.f_frsize
space_available /= 1024 * 1024
if space_available < self.cfg.cuckoo.freespace:
log.error("Not enough free disk space! (Only %d MB!)", space_available)
self.stop_dist.set()
continue
else:
self.stop_dist.clear()
time.sleep(60)
def zip_files(self, files):
in_memory = BytesIO()
zf = ZipFile(in_memory, mode="w")
for file in files:
zf.writestr(os.path.basename(file), open(file, "rb").read())
zf.close()
in_memory.seek(0)
# read the data
data = in_memory.read()
in_memory.close()
return data
def notification_loop(self):
urls = reporting_conf.callback.url.split(",")
# headers = {"x-api-key": reporting_conf.callback.key}
db = session()
while True:
tasks = db.query(Task).filter_by(finished=True, retrieved=True, notificated=False).order_by(Task.id.desc()).all()
if tasks is not None:
for task in tasks:
main_db.set_status(task.main_task_id, TASK_REPORTED)
log.debug("reporting main_task_id: {}".format(task.main_task_id))
for url in urls:
try:
# headers=headers,
res = requests.post(url, data=json.dumps({"task_id": int(task.main_task_id)}))
if res and res.ok:
# log.info(res.content)
task.notificated = True
# db.commit()
# db.refresh(task)
else:
log.info("failed to report: {} - {}".format(task.main_task_id, res.status_code))
except requests.exceptions.ConnectionError:
log.info("Can't report to callback")
except Exception as e:
log.info("failed to report: {} - {}".format(task.main_task_id, e))
db.commit()
time.sleep(20)
db.close()
def failed_cleaner(self):
db = session()
while True:
for node in db.query(Node).with_entities(Node.id, Node.name, Node.url, Node.apikey).filter_by(enabled=True).all():
log.info("Checking for failed tasks on: {}".format(node.name))
for status in ("failed_analysis", "failed_processing"):
for task in node_fetch_tasks(status, node.url, node.apikey, action="delete"):
t = db.query(Task).filter_by(task_id=task["id"], node_id=node.id).order_by(Task.id.desc()).first()
if t is not None:
log.info(
"Cleaning failed_analysis for id:{}, node:{}: main_task_id: {}".format(
t.id, t.node_id, t.main_task_id
)
)
main_db.set_status(t.main_task_id, TASK_FAILED_REPORTING)
t.finished = True
t.retrieved = True
t.notificated = True
lock_retriever.acquire()
if (t.node_id, t.task_id) not in self.cleaner_queue.queue:
self.cleaner_queue.put((t.node_id, t.task_id))
lock_retriever.release()
else:
log.debug("failed_cleaner t is None for: {} - node_id: {}".format(task["id"], node.id))
lock_retriever.acquire()
if (node.id, task["id"]) not in self.cleaner_queue.queue:
self.cleaner_queue.put((node.id, task["id"]))
lock_retriever.release()
db.commit()
time.sleep(600)
db.close()
def fetcher(self):
"""Method that runs forever"""
last_checks = {}
# to not exit till cleaner works
db = session()
while not self.stop_dist.isSet():
# .with_entities(Node.id, Node.name, Node.url, Node.apikey, Node.last_check)
for node in db.query(Node).filter_by(enabled=True).all():
self.status_count.setdefault(node.name, 0)
last_checks.setdefault(node.name, 0)
last_checks[node.name] += 1
# reset it every 10 calls
if hasattr(node, "last_check") and node.last_check:
last_check = int(node.last_check.strftime("%s"))
else:
last_check = 0
if last_checks[node.name] == 3:
last_check = 0
last_checks[node.name] = 0
limit = 0
for task in node_fetch_tasks("reported", node.url, node.apikey, "fetch", last_check):
tasker = (
db.query(Task)
.filter_by(finished=False, retrieved=False, task_id=task["id"], node_id=node.id, deleted=False)
.order_by(Task.id.desc())
.first()
)
if tasker is None:
# log.debug(f"Node ID: {node.id} - Task ID: {task['id']} - adding to cleaner")
self.cleaner_queue.put((node.id, task["id"]))
continue
try:
if (
task["id"] not in self.current_queue.get(node.id, [])
and (task["id"], node.id) not in self.fetcher_queue.queue
):
limit += 1
self.fetcher_queue.put((task, node.id))
# log.debug("{} - {}".format(task, node.id))
completed_on = datetime.strptime(task["completed_on"], "%Y-%m-%d %H:%M:%S")
if node.last_check is None or completed_on > node.last_check:
node.last_check = completed_on
db.commit()
db.refresh(node)
if limit == 50:
break
except Exception as e:
self.status_count[node.name] += 1
log.info(e)
if self.status_count[node.name] == dead_count:
log.info("[-] {} dead".format(node.name))
# node_data = db.query(Node).filter_by(name=node.name).first()
# node_data.enabled = False
# db.commit()
db.commit()
time.sleep(5)
db.close()
# This should be executed as external thread as it generates bottle neck
def fetch_latest_reports_nfs(self):
db = session()
# to not exit till cleaner works
while not self.stop_dist.isSet():
task, node_id = self.fetcher_queue.get()
self.current_queue.setdefault(node_id, []).append(task["id"])
try:
# In the case that a Cuckoo node has been reset over time it"s
# possible that there are multiple combinations of
# node-id/task-id, in this case we take the last one available.
# (This makes it possible to re-setup a Cuckoo node).
t = (
db.query(Task)
.filter_by(node_id=node_id, task_id=task["id"], retrieved=False, finished=False)
.order_by(Task.id.desc())
.first()
)
if t is None:
self.t_is_none.setdefault(node_id, []).append(task["id"])
# sometime it not deletes tasks in workers of some fails or something
# this will do the trick
# log.debug("tf else,")
if (node_id, task.get("id")) not in self.cleaner_queue.queue:
self.cleaner_queue.put((node_id, task.get("id")))
continue
log.debug(
"Fetching dist report for: id: {}, task_id: {}, main_task_id:{} from node: {}".format(
t.id, t.task_id, t.main_task_id, ID2NAME[t.node_id] if t.node_id in ID2NAME else t.node_id
)
)
# set completed_on time
main_db.set_status(t.main_task_id, TASK_DISTRIBUTED_COMPLETED)
# set reported time
main_db.set_status(t.main_task_id, TASK_REPORTED)
# Fetch each requested report.
report_path = os.path.join(CUCKOO_ROOT, "storage", "analyses", "{}".format(t.main_task_id))
# ToDo option
node = db.query(Node).with_entities(Node.id, Node.name, Node.url, Node.apikey).filter_by(id=node_id).first()
start_copy = datetime.now()
copied = node_get_report_nfs(t.task_id, node.name, t.main_task_id)
log.info(
f"It took {datetime.now()-start_copy} to copy report {t.task_id} from node: {node.name} for task: {t.main_task_id}"
)
if not copied:
log.error(f"Can't copy report {t.task_id} from node: {node.name} for task: {t.main_task_id}")
continue
if os.path.exists(t.path):
sample = open(t.path, "rb").read()
sample_sha256 = hashlib.sha256(sample).hexdigest()
destination = os.path.join(CUCKOO_ROOT, "storage", "binaries")
if not os.path.exists(destination):
os.makedirs(destination, mode=0o755)
destination = os.path.join(destination, sample_sha256)
if not os.path.exists(destination) and os.path.exists(t.path):
try:
shutil.move(t.path, destination)
except FileNotFoundError as e:
pass
# creating link to analysis folder
if os.path.exists(t.path):
try:
os.symlink(destination, os.path.join(report_path, "binary"))
except Exception as e:
pass
t.retrieved = True
t.finished = True
db.commit()
"""
report_path = os.path.join(CUCKOO_ROOT, "storage", "analyses", "{}".format(t.main_task_id))
if not os.path.exists(report_path):
os.makedirs(report_path, mode=0o755)
except Exception as e:
log.exception("Exception: %s" % e)
if os.path.exists(os.path.join(report_path, "reports", "report.json")):
os.remove(os.path.join(report_path, "reports", "report.json"))
"""
except Exception as e:
log.exception(e)
self.current_queue[node_id].remove(task["id"])
db.commit()
db.close()
# This should be executed as external thread as it generates bottle neck
def fetch_latest_reports(self):
db = session()
# to not exit till cleaner works
while not self.stop_dist.isSet():
task, node_id = self.fetcher_queue.get()
self.current_queue.setdefault(node_id, []).append(task["id"])
try:
# In the case that a Cuckoo node has been reset over time it"s
# possible that there are multiple combinations of
# node-id/task-id, in this case we take the last one available.
# (This makes it possible to re-setup a Cuckoo node).
t = (
db.query(Task)
.filter_by(node_id=node_id, task_id=task["id"], retrieved=False, finished=False)
.order_by(Task.id.desc())
.first()
)
if t is None:
self.t_is_none.setdefault(node_id, []).append(task["id"])
# sometime it not deletes tasks in workers of some fails or something
# this will do the trick
# log.debug("tf else,")
if (node_id, task.get("id")) not in self.cleaner_queue.queue:
self.cleaner_queue.put((node_id, task.get("id")))
continue
log.debug(
"Fetching dist report for: id: {}, task_id: {}, main_task_id:{} from node: {}".format(
t.id, t.task_id, t.main_task_id, ID2NAME[t.node_id] if t.node_id in ID2NAME else t.node_id
)
)
# set completed_on time
main_db.set_status(t.main_task_id, TASK_DISTRIBUTED_COMPLETED)
# set reported time
main_db.set_status(t.main_task_id, TASK_REPORTED)
# Fetch each requested report.
node = db.query(Node).with_entities(Node.id, Node.name, Node.url, Node.apikey).filter_by(id=node_id).first()
report = node_get_report(t.task_id, "dist/", node.url, node.apikey, stream=True)
if report is None:
log.info("dist report retrieve failed NONE: task_id: {} from node: {}".format(t.task_id, node_id))
continue
if report.status_code != 200:
log.info(
"dist report retrieve failed - status_code {}: task_id: {} from node: {}".format(
report.status_code, t.task_id, node_id
)
)
if report.status_code == 400 and (node_id, task.get("id")) not in self.cleaner_queue.queue:
self.cleaner_queue.put((node_id, task.get("id")))
log.info(f"Status code: {report.status_code} - MSG: {report.text}")
continue
log.info(f"Report size for task {t.task_id} is: {int(report.headers.get('Content-length', 1))/int(1<<20):,.0f} MB")
report_path = os.path.join(CUCKOO_ROOT, "storage", "analyses", "{}".format(t.main_task_id))
if not os.path.exists(report_path):
os.makedirs(report_path, mode=0o777)
try:
if report.content:
# with pyzipper.AESZipFile(BytesIO(report.content)) as zf:
# zf.setpassword(zip_pwd)
with zipfile.ZipFile(BytesIO(report.content)) as zf:
try:
zf.extractall(report_path)
if (node_id, task.get("id")) not in self.cleaner_queue.queue:
self.cleaner_queue.put((node_id, task.get("id")))
except OSError:
log.error("Permission denied: {}".format(report_path))
if os.path.exists(t.path):
sample = open(t.path, "rb").read()
sample_sha256 = hashlib.sha256(sample).hexdigest()
destination = os.path.join(CUCKOO_ROOT, "storage", "binaries")
if not os.path.exists(destination):
os.makedirs(destination, mode=0o755)
destination = os.path.join(destination, sample_sha256)
if not os.path.exists(destination) and os.path.exists(t.path):
shutil.move(t.path, destination)
# creating link to analysis folder
if os.path.exists(t.path):
try:
os.symlink(destination, os.path.join(report_path, "binary"))
except Exception as e:
pass
else:
log.debug(f"{t.path} doesn't exist")
t.retrieved = True
t.finished = True
db.commit()
else:
log.error("Zip file is empty")
except pyzipper.zipfile.BadZipFile:
log.error("File is not a zip file")
except Exception as e:
log.exception("Exception: %s" % e)
if os.path.exists(os.path.join(report_path, "reports", "report.json")):
os.remove(os.path.join(report_path, "reports", "report.json"))
except Exception as e:
log.exception(e)
self.current_queue[node_id].remove(task["id"])
db.commit()
db.close()
def remove_from_worker(self):
db = session()
nodes = {}
for node in db.query(Node).with_entities(Node.id, Node.name, Node.url, Node.apikey).all():
nodes.setdefault(node.id, node)
while True:
details = {}
for _ in range(self.cleaner_queue.qsize()):
node_id, task_id = self.cleaner_queue.get()
details.setdefault(node_id, []).append(str(task_id))
if task_id in self.t_is_none.get(node_id, []):
self.t_is_none[node_id].remove(task_id)
for node_id in details:
node = nodes[node_id]
if node and details[node_id]:
ids = ",".join(list(set(details[node_id])))
_delete_many(node_id, ids, nodes, db)
db.commit()
time.sleep(20)
class StatusThread(threading.Thread):
def submit_tasks(self, node_id, pend_tasks_num, options_like=False, force_push_push=False, db=None):
# HACK do not create a new session if the current one (passed as parameter) is still valid.
try:
node = db.query(Node).with_entities(Node.id, Node.name, Node.url, Node.apikey).filter_by(name=node_id).first()
except (OperationalError, SQLAlchemyError) as e:
log.warning(f"Got an operational Exception when trying to submit tasks: {str(e)}")
return False
if node.name not in SERVER_TAGS:
self.load_vm_tags(db, node.id, node.name)
limit = 0
# check if we have tasks with no node_id and task_id, but with main_task_id
bad_tasks = db.query(Task).filter(Task.node_id.is_(None), Task.task_id.is_(None), Task.main_task_id.is_not(None)).all()
if bad_tasks:
for task in bad_tasks:
db.delete(task)
db.commit()
main_db.set_status(task.main_task_id, TASK_PENDING)
if node.name != "master":
# don"t do nothing if nothing in pending
# Get tasks from main_db submitted through web interface
main_db_tasks = main_db.list_tasks(
status=TASK_PENDING, options_like=options_like, limit=pend_tasks_num, order_by=MD_Task.priority.desc()
)
if not main_db_tasks:
return True
if main_db_tasks:
for t in main_db_tasks:
force_push = False
try:
options = get_options(t.options)
# check if node exist and its correct
if options.get("node"):
requested_node = options.get("node")
if requested_node not in STATUSES:
# if the requested node is not available
force_push = True
elif requested_node != node.name:
# otherwise keep looping
continue
if "timeout=" in t.options:
t.timeout = options.get("timeout", 0)
except Exception as e:
log.error(e, exc_info=True)
# wtf are you doing in pendings?
tasks = db.query(Task).filter_by(main_task_id=t.id).all()
if tasks:
for task in tasks:
# log.info("Deleting incorrectly uploaded file from dist db, main_task_id: {}".format(t.id))
if node.name == "master":
main_db.set_status(t.id, TASK_RUNNING)
else:
main_db.set_status(t.id, TASK_DISTRIBUTED)
# db.delete(task)
db.commit()
continue
# Check if file exist, if no wipe from db and continue, rare cases
if t.category in ("file", "pcap", "static") and not os.path.exists(t.target):
log.info(f"Task id: {t.id} - File doesn't exist: {t.target}")
main_db.delete_task(t.id)
continue
# Convert array of tags into comma separated list
tags = ",".join([tag.name for tag in t.tags])
# Append a comma, to make LIKE searches more precise
if tags:
tags += ","
# sanity check
if "x86" in tags and "x64" in tags:
tags = tags.replace("x86,", "")
if "msoffice-crypt-tmp" in t.target and "password=" in t.options:
# t.options = t.options.replace(f"password={options['password']}", "")
options["password"]
# if options.get("node"):
# t.options = t.options.replace(f"node={options['node']}", "")
if options.get("node"):
del options["node"]
t.options = ",".join([f"{k}={v}" for k, v in options.items()])
if t.options:
t.options += ","
t.options += "main_task_id={}".format(t.id)
args = dict(
package=t.package,
category=t.category,
timeout=t.timeout,
priority=t.priority,
options=t.options,
machine=t.machine,
platform=t.platform,
tags=tags,
custom=t.custom,
memory=t.memory,
clock=t.clock,
enforce_timeout=t.enforce_timeout,
main_task_id=t.id,
route=t.route,
)
task = Task(path=t.target, **args)
db.add(task)
try:
db.commit()
except Exception as e:
log.exception(e)
log.info("TASK_FAILED_REPORTING")
db.rollback()
log.info(e)
continue
if force_push or force_push_push:
# Submit appropriate tasks to node
submitted = node_submit_task(task.id, node.id)
if submitted:
if node.name == "master":
main_db.set_status(t.id, TASK_RUNNING)
else:
main_db.set_status(t.id, TASK_DISTRIBUTED)
limit += 1
if limit == pend_tasks_num or limit == len(main_db_tasks):
db.commit()
log.info("Pushed all tasks")
return True
# Only get tasks that have not been pushed yet.
q = db.query(Task).filter(or_(Task.node_id.is_(None), Task.task_id.is_(None)), Task.finished.is_(False))
if q is None:
db.commit()
return True
# Order by task priority and task id.
q = q.order_by(-Task.priority, Task.main_task_id)
# if we have node set in options push
if reporting_conf.distributed.enable_tags:
# Create filter query from tasks in ta
tags = [getattr(Task, "tags") == ""]
for tg in SERVER_TAGS[node.name]:
if len(tg.split(",")) == 1:
tags.append(getattr(Task, "tags") == (tg + ","))
else:
tg = tg.split(",")
# ie. LIKE "%,%,%,"
t_combined = [getattr(Task, "tags").like("%s" % ("%," * len(tg)))]
for tag in tg:
t_combined.append(getattr(Task, "tags").like("%%%s%%" % (tag + ",")))
tags.append(and_(*t_combined))
# Filter by available tags
q = q.filter(or_(*tags))
to_upload = q.limit(pend_tasks_num).all()
if not to_upload:
db.commit()
log.info("nothing to upload? How? o_O")
return True
# Submit appropriate tasks to node
log.debug("going to upload {} tasks to node {}".format(pend_tasks_num, node.name))
for task in to_upload:
submitted = node_submit_task(task.id, node.id)
if submitted:
if node.name == "master":
main_db.set_status(task.main_task_id, TASK_RUNNING)
else:
main_db.set_status(task.main_task_id, TASK_DISTRIBUTED)
else:
log.info("something is wrong with submission of task: {}".format(task.id))
db.delete(task)
db.commit()
limit += 1