-
Notifications
You must be signed in to change notification settings - Fork 0
/
symExec.py
2922 lines (2692 loc) · 115 KB
/
symExec.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 tokenize
import zlib, base64
from tokenize import NUMBER, NAME, NEWLINE
import re
import math
import sys
import pickle
import json
import traceback
import signal
import time
import logging
import six
import time
from collections import namedtuple
from z3 import *
import re
from vargenerator import *
from ethereum_data import *
from basicblock import BasicBlock
from analysis import *
from test_evm.global_test_params import (TIME_OUT, UNKNOWN_INSTRUCTION,EXCEPTION, PICKLE_PATH)
from vulnerability import CallStack, TimeDependency, MoneyConcurrency, Reentrancy, AssertionFailure, ParityMultisigBug2, IntegerUnderflow, IntegerOverflow
import global_params
logging.basicConfig(level=logging.INFO, stream=sys.stdout)
log = logging.getLogger(__name__)
UNSIGNED_BOUND_NUMBER = 2**256 - 1
CONSTANT_ONES_159 = BitVecVal((1 << 160) - 1, 256)
Assertion = namedtuple('Assertion', ['pc', 'model'])
Underflow = namedtuple('Underflow', ['pc', 'model'])
Overflow = namedtuple('Overflow', ['pc', 'model'])
class Parameter:
def __init__(self, **kwargs):
attr_defaults = {
"stack": [],
"calls": [],
"memory": [],
"visited": [],
"overflow_pcs": [],
"mem": {},
"analysis": {},
"sha3_list": {},
"global_state": {},
"path_conditions_and_vars": {}
}
for (attr, default) in six.iteritems(attr_defaults):
setattr(self, attr, kwargs.get(attr, default))
def copy(self):
_kwargs = custom_deepcopy(self.__dict__)
return Parameter(**_kwargs)
def initGlobalCallVars():
# ** add by fcorleone
# define some call related global variables
global start_data_input
global size_data_input
global start_data_output
global size_data_output
global msg_data
global return_data_size
global return_data
global return_symbol_cons
# here we add a global variable to store all the global state
global backup_state # !!!important
size_data_input = 0
return_data_size = 0
return_data = []
return_symbol_cons = {}
backup_state = None
msg_data = None
def initGlobalVars():
global g_src_map
global solver
# Z3 solver
if global_params.PARALLEL:
t2 = Then('simplify', 'solve-eqs', 'smt')
_t = Then('tseitin-cnf-core', 'split-clause')
t1 = ParThen(_t, t2)
solver = OrElse(t1, t2).solver()
else:
solver = Solver()
solver.set("timeout", global_params.TIMEOUT)
global MSIZE
MSIZE = False
global revertible_overflow_pcs
revertible_overflow_pcs = set()
global g_disasm_file
with open(g_disasm_file, 'r') as f:
disasm = f.read()
if 'MSIZE' in disasm:
MSIZE = True
global g_bin_disasm_file
global g_timeout
g_timeout = False
global visited_pcs
visited_pcs = set()
global results
if g_src_map:
global start_block_to_func_sig
start_block_to_func_sig = {}
results = {
'evm_code_coverage': '',
'vulnerabilities': {
'integer_underflow': [],
'integer_overflow': [],
'callstack': [],
'money_concurrency': [],
'time_dependency': [],
'reentrancy': [],
'assertion_failure': [],
'parity_multisig_bug_2': [],
}
}
else:
results = {
'evm_code_coverage': '',
'vulnerabilities': {
'integer_underflow': [],
'integer_overflow': [],
'callstack': False,
'money_concurrency': False,
'time_dependency': False,
'reentrancy': False,
}
}
global calls_affect_state
calls_affect_state = {}
# capturing the last statement of each basic block
global end_ins_dict
end_ins_dict = {}
# capturing all the instructions, keys are corresponding addresses
global instructions
instructions = {}
# capturing the "jump type" of each basic block
global jump_type
jump_type = {}
global vertices
vertices = {}
global edges
edges = {}
global visited_edges
visited_edges = {}
global money_flow_all_paths
money_flow_all_paths = []
global reentrancy_all_paths
reentrancy_all_paths = []
# store the path condition corresponding to each path in money_flow_all_paths
global path_conditions
path_conditions = []
global global_problematic_pcs
global_problematic_pcs = {"money_concurrency_bug": [], "reentrancy_bug": [], "time_dependency_bug": [], "assertion_failure": [], "integer_underflow": [], "integer_overflow": []}
# store global variables, e.g. storage, balance of all paths
global all_gs
all_gs = []
global total_no_of_paths
total_no_of_paths = 0
global no_of_test_cases
no_of_test_cases = 0
# to generate names for symbolic variables
global gen
gen = Generator()
global data_source
if global_params.USE_GLOBAL_BLOCKCHAIN:
data_source = EthereumData()
global rfile
if global_params.REPORT_MODE:
rfile = open(g_disasm_file + '.report', 'w')
# def _backup_state(visited,stack,mem,memory,global_state,sha3_list,path_conditions_and_vars,analysis,calls,overflow_pcs,block, func_call, current_func_name):
def _backup_state():
global backup_state
global g_src_map
global solver
global MSIZE
global revertible_overflow_pcs
global g_disasm_file
global g_bin_disasm_file
global g_timeout
global visited_pcs
global results
global start_block_to_func_sig
global calls_affect_state
global end_ins_dict
global instructions
global jump_type
global vertices
global edges
global visited_edges
global money_flow_all_paths
global reentrancy_all_paths
global path_conditions
global global_problematic_pcs
global all_gs
global total_no_of_paths
global no_of_test_cases
global gen
global data_source
global rfile
backup_state = {
'g_src_map':g_src_map,
'solver':solver,
'MSIZE':MSIZE,
'revertible_overflow_pcs':revertible_overflow_pcs,
'g_disasm_file':g_disasm_file,
'g_bin_disasm_file':g_bin_disasm_file,
'g_timeout':g_timeout,
'visited_pcs':visited_pcs,
'results':results,
'start_block_to_func_sig':start_block_to_func_sig,
'calls_affect_state':calls_affect_state,
'end_ins_dict':end_ins_dict,
'instructions':instructions,
'jump_type':jump_type,
'vertices':vertices,
'edges':edges,
'visited_edges':visited_edges,
'money_flow_all_paths':money_flow_all_paths,
'reentrancy_all_paths':reentrancy_all_paths,
'path_conditions':path_conditions,
'global_problematic_pcs':global_problematic_pcs,
'all_gs':all_gs,
'total_no_of_paths':total_no_of_paths,
'no_of_test_cases':no_of_test_cases,
'gen':gen
# 'data_source':data_source,
# rfile is used after the analyze process, so we don't need to store it here
# 'rfile':rfile,
# # no need to store the paremeters when executing a block, they are not global so they will not change
# # params, block, pre_block, depth, func_call, current_func_name
# # visited = params.visited
# # stack = params.stack
# # mem = params.mem
# # memory = params.memory
# # global_state = params.global_state
# # sha3_list = params.sha3_list
# # path_conditions_and_vars = params.path_conditions_and_vars
# # analysis = params.analysis
# # calls = params.calls
# # overflow_pcs = params.overflow_pcs
# 'visited':visited,
# 'stack':stack,
# 'mem':mem,
# 'memory':memory,
# 'global_state':global_state,
# 'sha3_list':sha3_list,
# 'path_conditions_and_vars':path_conditions_and_vars,
# 'analysis':analysis,
# 'calls':calls,
# 'overflow_pcs':overflow_pcs,
# 'block':block,
# 'pre_block':pre_block,
# 'depth':depth,
# 'func_call':func_call,
# 'current_func_name':current_func_name
}
def _load_state():
global backup_state
global g_src_map
global solver
global MSIZE
global revertible_overflow_pcs
global g_disasm_file
global g_bin_disasm_file
global g_timeout
global visited_pcs
global results
global start_block_to_func_sig
global calls_affect_state
global end_ins_dict
global instructions
global jump_type
global vertices
global edges
global visited_edges
global money_flow_all_paths
global reentrancy_all_paths
global path_conditions
global global_problematic_pcs
global all_gs
global total_no_of_paths
global no_of_test_cases
global gen
global data_source
global rfile
g_src_map = backup_state['g_src_map']
solver = backup_state['solver']
MSIZE = backup_state['MSIZE']
revertible_overflow_pcs = backup_state['revertible_overflow_pcs']
g_disasm_file = backup_state['g_disasm_file']
g_bin_disasm_file = backup_state['g_bin_disasm_file']
g_timeout = backup_state['g_timeout']
visited_pcs = backup_state['visited_pcs']
results = backup_state['results']
start_block_to_func_sig = backup_state['start_block_to_func_sig']
calls_affect_state = backup_state['calls_affect_state']
end_ins_dict = backup_state['end_ins_dict']
instructions = backup_state['instructions']
jump_type = backup_state['jump_type']
vertices = backup_state['vertices']
edges = backup_state['edges']
visited_edges = backup_state['visited_edges']
money_flow_all_paths = backup_state['money_flow_all_paths']
reentrancy_all_paths = backup_state['reentrancy_all_paths']
path_conditions = backup_state['path_conditions']
global_problematic_pcs = backup_state['global_problematic_pcs']
all_gs = backup_state['all_gs']
total_no_of_paths = backup_state['total_no_of_paths']
no_of_test_cases = backup_state['no_of_test_cases']
gen = backup_state['gen']
backup_state = None
def is_testing_evm():
return global_params.UNIT_TEST != 0
def compare_storage_and_gas_unit_test(global_state, analysis):
unit_test = pickle.load(open(PICKLE_PATH, 'rb'))
test_status = unit_test.compare_with_symExec_result(global_state, analysis)
exit(test_status)
def change_format():
with open(g_disasm_file) as disasm_file:
file_contents = disasm_file.readlines()
i = 0
firstLine = file_contents[0].strip('\n')
for line in file_contents:
line = line.replace('SELFDESTRUCT', 'SUICIDE')
line = line.replace('Missing opcode 0xfd', 'REVERT')
line = line.replace('Missing opcode 0xfe', 'ASSERTFAIL')
line = line.replace('Missing opcode', 'INVALID')
line = line.replace(':', '')
lineParts = line.split(' ')
try: # removing initial zeroes
lineParts[0] = str(int(lineParts[0]))
except:
lineParts[0] = lineParts[0]
lineParts[-1] = lineParts[-1].strip('\n')
try: # adding arrow if last is a number
lastInt = lineParts[-1]
if(int(lastInt, 16) or int(lastInt, 16) == 0) and len(lineParts) > 2:
lineParts[-1] = "=>"
lineParts.append(lastInt)
except Exception:
pass
file_contents[i] = ' '.join(lineParts)
i = i + 1
file_contents[0] = firstLine
file_contents[-1] += '\n'
with open(g_disasm_file, 'w') as disasm_file:
disasm_file.write("\n".join(file_contents))
def build_cfg_and_analyze(is_printLog):
change_format()
with open(g_disasm_file, 'r') as disasm_file:
disasm_file.readline() # Remove first line
tokens = tokenize.generate_tokens(disasm_file.readline)
collect_vertices(tokens)
construct_bb()
construct_static_edges()
full_sym_exec(is_printLog) # jump targets are constructed on the fly
def print_cfg():
for block in vertices.values():
block.display()
log.debug(str(edges))
def mapping_push_instruction(current_line_content, current_ins_address, idx, positions, length):
global g_src_map
while (idx < length):
if not positions[idx]:
return idx + 1
name = positions[idx]['name']
if name.startswith("tag"):
idx += 1
else:
if name.startswith("PUSH"):
if name == "PUSH":
value = positions[idx]['value']
instr_value = current_line_content.split(" ")[1]
if int(value, 16) == int(instr_value, 16):
g_src_map.instr_positions[current_ins_address] = g_src_map.positions[idx]
idx += 1
break;
else:
raise Exception("Source map error")
else:
g_src_map.instr_positions[current_ins_address] = g_src_map.positions[idx]
idx += 1
break;
else:
raise Exception("Source map error")
return idx
def mapping_non_push_instruction(current_line_content, current_ins_address, idx, positions, length):
global g_src_map
while (idx < length):
if not positions[idx]:
return idx + 1
name = positions[idx]['name']
if name.startswith("tag"):
idx += 1
else:
instr_name = current_line_content.split(" ")[0]
if name == instr_name or name == "INVALID" and instr_name == "ASSERTFAIL" or name == "KECCAK256" and instr_name == "SHA3" or name == "SELFDESTRUCT" and instr_name == "SUICIDE":
g_src_map.instr_positions[current_ins_address] = g_src_map.positions[idx]
idx += 1
break;
else:
raise Exception("Source map error")
return idx
# 1. Parse the disassembled file
# 2. Then identify each basic block (i.e. one-in, one-out)
# 3. Store them in vertices
def collect_vertices(tokens):
global g_src_map
if g_src_map:
idx = 0
positions = g_src_map.positions
length = len(positions)
global end_ins_dict
global instructions
global jump_type
current_ins_address = 0
last_ins_address = 0
is_new_line = True
current_block = 0
current_line_content = ""
wait_for_push = False
is_new_block = False
for tok_type, tok_string, (srow, scol), _, line_number in tokens:
if wait_for_push is True:
push_val = ""
for ptok_type, ptok_string, _, _, _ in tokens:
if ptok_type == NEWLINE:
is_new_line = True
current_line_content += push_val + ' '
instructions[current_ins_address] = current_line_content
idx = mapping_push_instruction(current_line_content, current_ins_address, idx, positions, length) if g_src_map else None
log.debug(current_line_content)
current_line_content = ""
wait_for_push = False
break
try:
int(ptok_string, 16)
push_val += ptok_string
except ValueError:
pass
continue
elif is_new_line is True and tok_type == NUMBER: # looking for a line number
last_ins_address = current_ins_address
try:
current_ins_address = int(tok_string)
except ValueError:
log.critical("ERROR when parsing row %d col %d", srow, scol)
quit()
is_new_line = False
if is_new_block:
current_block = current_ins_address
is_new_block = False
continue
elif tok_type == NEWLINE:
is_new_line = True
log.debug(current_line_content)
instructions[current_ins_address] = current_line_content
idx = mapping_non_push_instruction(current_line_content, current_ins_address, idx, positions, length) if g_src_map else None
current_line_content = ""
continue
elif tok_type == NAME:
if tok_string == "JUMPDEST":
if last_ins_address not in end_ins_dict:
end_ins_dict[current_block] = last_ins_address
current_block = current_ins_address
is_new_block = False
elif tok_string == "STOP" or tok_string == "RETURN" or tok_string == "SUICIDE" or tok_string == "REVERT" or tok_string == "ASSERTFAIL":
jump_type[current_block] = "terminal"
end_ins_dict[current_block] = current_ins_address
elif tok_string == "JUMP":
jump_type[current_block] = "unconditional"
end_ins_dict[current_block] = current_ins_address
is_new_block = True
elif tok_string == "JUMPI":
jump_type[current_block] = "conditional"
end_ins_dict[current_block] = current_ins_address
is_new_block = True
elif tok_string.startswith('PUSH', 0):
wait_for_push = True
is_new_line = False
if tok_string != "=" and tok_string != ">":
current_line_content += tok_string + " "
if current_block not in end_ins_dict:
log.debug("current block: %d", current_block)
log.debug("last line: %d", current_ins_address)
end_ins_dict[current_block] = current_ins_address
if current_block not in jump_type:
jump_type[current_block] = "terminal"
for key in end_ins_dict:
if key not in jump_type:
jump_type[key] = "falls_to"
def construct_bb():
global vertices
global edges
sorted_addresses = sorted(instructions.keys())
size = len(sorted_addresses)
for key in end_ins_dict:
end_address = end_ins_dict[key]
block = BasicBlock(key, end_address)
if key not in instructions:
continue
block.add_instruction(instructions[key])
i = sorted_addresses.index(key) + 1
while i < size and sorted_addresses[i] <= end_address:
block.add_instruction(instructions[sorted_addresses[i]])
i += 1
block.set_block_type(jump_type[key])
vertices[key] = block
edges[key] = []
def construct_static_edges():
add_falls_to() # these edges are static
def add_falls_to():
global vertices
global edges
key_list = sorted(jump_type.keys())
length = len(key_list)
for i, key in enumerate(key_list):
if jump_type[key] != "terminal" and jump_type[key] != "unconditional" and i+1 < length:
target = key_list[i+1]
edges[key].append(target)
# print key,target
vertices[key].set_falls_to(target)
def get_init_global_state(path_conditions_and_vars):
global_state = {"balance" : {}, "pc": 0}
init_is = init_ia = deposited_value = sender_address = receiver_address = gas_price = origin = currentCoinbase = currentNumber = currentDifficulty = currentGasLimit = callData = None
if global_params.INPUT_STATE:
with open('state.json') as f:
state = json.loads(f.read())
if state["Is"]["balance"]:
init_is = int(state["Is"]["balance"], 16)
if state["Ia"]["balance"]:
init_ia = int(state["Ia"]["balance"], 16)
if state["exec"]["value"]:
deposited_value = 0
if state["Is"]["address"]:
sender_address = int(state["Is"]["address"], 16)
if state["Ia"]["address"]:
receiver_address = int(state["Ia"]["address"], 16)
if state["exec"]["gasPrice"]:
gas_price = int(state["exec"]["gasPrice"], 16)
if state["exec"]["origin"]:
origin = int(state["exec"]["origin"], 16)
if state["env"]["currentCoinbase"]:
currentCoinbase = int(state["env"]["currentCoinbase"], 16)
if state["env"]["currentNumber"]:
currentNumber = int(state["env"]["currentNumber"], 16)
if state["env"]["currentDifficulty"]:
currentDifficulty = int(state["env"]["currentDifficulty"], 16)
if state["env"]["currentGasLimit"]:
currentGasLimit = int(state["env"]["currentGasLimit"], 16)
# for some weird reason these 3 vars are stored in path_conditions insteaad of global_state
else:
sender_address = BitVec("Is", 256)
receiver_address = BitVec("Ia", 256)
deposited_value = BitVec("Iv", 256)
init_is = BitVec("init_Is", 256)
init_ia = BitVec("init_Ia", 256)
path_conditions_and_vars["Is"] = sender_address
path_conditions_and_vars["Ia"] = receiver_address
path_conditions_and_vars["Iv"] = deposited_value
constraint = (deposited_value >= BitVecVal(0, 256))
path_conditions_and_vars["path_condition"].append(constraint)
constraint = (init_is >= deposited_value)
path_conditions_and_vars["path_condition"].append(constraint)
constraint = (init_ia >= BitVecVal(0, 256))
path_conditions_and_vars["path_condition"].append(constraint)
# update the balances of the "caller" and "callee"
global_state["balance"]["Is"] = (init_is - deposited_value)
global_state["balance"]["Ia"] = (init_ia + deposited_value)
if not gas_price:
new_var_name = gen.gen_gas_price_var()
gas_price = BitVec(new_var_name, 256)
path_conditions_and_vars[new_var_name] = gas_price
if not origin:
new_var_name = gen.gen_origin_var()
origin = BitVec(new_var_name, 256)
path_conditions_and_vars[new_var_name] = origin
if not currentCoinbase:
new_var_name = "IH_c"
currentCoinbase = BitVec(new_var_name, 256)
path_conditions_and_vars[new_var_name] = currentCoinbase
if not currentNumber:
new_var_name = "IH_i"
currentNumber = BitVec(new_var_name, 256)
path_conditions_and_vars[new_var_name] = currentNumber
if not currentDifficulty:
new_var_name = "IH_d"
currentDifficulty = BitVec(new_var_name, 256)
path_conditions_and_vars[new_var_name] = currentDifficulty
if not currentGasLimit:
new_var_name = "IH_l"
currentGasLimit = BitVec(new_var_name, 256)
path_conditions_and_vars[new_var_name] = currentGasLimit
new_var_name = "IH_s"
currentTimestamp = BitVec(new_var_name, 256)
path_conditions_and_vars[new_var_name] = currentTimestamp
# the state of the current current contract
if "Ia" not in global_state:
global_state["Ia"] = {}
global_state["miu_i"] = 0
global_state["value"] = deposited_value
global_state["sender_address"] = sender_address
global_state["receiver_address"] = receiver_address
global_state["gas_price"] = gas_price
global_state["origin"] = origin
global_state["currentCoinbase"] = currentCoinbase
global_state["currentTimestamp"] = currentTimestamp
global_state["currentNumber"] = currentNumber
global_state["currentDifficulty"] = currentDifficulty
global_state["currentGasLimit"] = currentGasLimit
return global_state
def get_start_block_to_func_sig():
state = 0
func_sig = None
for pc, instr in six.iteritems(instructions):
if state == 0 and instr.startswith('PUSH4'):
state += 1
func_sig = instr.split(' ')[1][2:]
elif state == 1 and instr.startswith('EQ'):
state += 1
elif state == 2 and instr.startswith('PUSH'):
state = 0
pc = instr.split(' ')[1]
pc = int(pc, 16)
start_block_to_func_sig[pc] = func_sig
else:
state = 0
return start_block_to_func_sig
def full_sym_exec(is_printLog):
# executing, starting from beginning
path_conditions_and_vars = {"path_condition" : []}
global_state = get_init_global_state(path_conditions_and_vars)
# log.warning("*********************")
# log.warning(global_state["Ia"])
if not is_printLog:
# store the initial value of contract variables in storage
with open(g_bin_disasm_file, 'r') as bin_disasm_file:
lines = bin_disasm_file.readlines()
for line_no in range(len(lines)):
if 'SSTORE' in lines[line_no]:
# here we find the SSTORE and we need to store the value into storage
address_stm = lines[line_no-1]
value_stm = lines[line_no-2]
addr = ''
value = ''
# print value_stm
if 'PUSH' in value_stm:
value = value_stm.split(' ')[-1].strip()
else:
continue
if 'PUSH' in address_stm:
addr = address_stm.split(' ')[-1].strip()
elif 'DUP' in address_stm:
addr = value
else:
continue
# print type(value)
global_state["Ia"][int(addr,16)] = int(value,16)
# print(int(addr,16),int(value,16))
# log.warning(global_state['Ia'])
analysis = init_analysis()
params = Parameter(path_conditions_and_vars=path_conditions_and_vars, global_state=global_state, analysis=analysis)
if g_src_map:
start_block_to_func_sig = get_start_block_to_func_sig()
return sym_exec_block(params, 0, 0, 0, -1, 'fallback',is_printLog)
# ** add by fcorleone
# def a function to execute called contract when CALL opcode is encountered
# '''
# path_conditions_and_vars: the current path constrains and variables
#
# '''
def full_sym_exec_call(path_conditions_and_vars={"path_condition" : []}):
path_conditions_and_vars = path_conditions_and_vars
# Symbolically executing a block from the start address
def sym_exec_block(params, block, pre_block, depth, func_call, current_func_name,is_printLog=True):
global solver
global visited_edges
global money_flow_all_paths
global path_conditions
global global_problematic_pcs
global all_gs
global results
global g_src_map
visited = params.visited
stack = params.stack
mem = params.mem
memory = params.memory
global_state = params.global_state
sha3_list = params.sha3_list
path_conditions_and_vars = params.path_conditions_and_vars
analysis = params.analysis
calls = params.calls
overflow_pcs = params.overflow_pcs
Edge = namedtuple("Edge", ["v1", "v2"]) # Factory Function for tuples is used as dictionary key
if block < 0:
log.debug("UNKNOWN JUMP ADDRESS. TERMINATING THIS PATH")
return ["ERROR"]
log.debug("Reach block address %d \n", block)
if g_src_map:
if block in start_block_to_func_sig:
func_sig = start_block_to_func_sig[block]
current_func_name = g_src_map.sig_to_func[func_sig]
pattern = r'(\w[\w\d_]*)\((.*)\)$'
match = re.match(pattern, current_func_name)
if match:
current_func_name = list(match.groups())[0]
current_edge = Edge(pre_block, block)
if current_edge in visited_edges:
updated_count_number = visited_edges[current_edge] + 1
visited_edges.update({current_edge: updated_count_number})
else:
visited_edges.update({current_edge: 1})
if visited_edges[current_edge] > global_params.LOOP_LIMIT:
log.debug("Overcome a number of loop limit. Terminating this path ...")
return stack
current_gas_used = analysis["gas"]
if current_gas_used > global_params.GAS_LIMIT:
log.debug("Run out of gas. Terminating this path ... ")
return stack
# Execute every instruction, one at a time
try:
block_ins = vertices[block].get_instructions()
except KeyError:
log.debug("This path results in an exception, possibly an invalid jump address")
return ["ERROR"]
for instr in block_ins:
# if not is_printLog:
# log.warning("execute instruction:%s",instr)
# log.warning("current solver is %s",solver)
# log.warning("the current memory is %s",mem)
# log.warning("the current stack is %s",stack)
# print("ins is_printlog",is_printLog)
sym_exec_ins(params, block, instr, func_call, current_func_name,is_printLog)
# if 'RETURN' in instr:
# print jump_type[block]
# print stack
# Mark that this basic block in the visited blocks
visited.append(block)
depth += 1
reentrancy_all_paths.append(analysis["reentrancy_bug"])
# path_c = str(path_conditions_and_vars["path_condition"])
# if "IH_s" in path_c and "20" in path_c:
# print(path_conditions)
# print(money_flow_all_paths)
if analysis["money_flow"] not in money_flow_all_paths:
global_problematic_pcs["money_concurrency_bug"].append(analysis["money_concurrency_bug"])
money_flow_all_paths.append(analysis["money_flow"])
path_conditions.append(path_conditions_and_vars["path_condition"])
global_problematic_pcs["time_dependency_bug"].append(analysis["time_dependency_bug"])
all_gs.append(copy_global_values(global_state))
elif path_conditions_and_vars["path_condition"] not in path_conditions and analysis["money_flow"] != [("Is", "Ia", "Iv")]:
path_conditions.append(path_conditions_and_vars["path_condition"])
global_problematic_pcs["time_dependency_bug"].append(analysis["time_dependency_bug"])
all_gs.append(copy_global_values(global_state))
# print(jump_type[block],depth)
# Go to next Basic Block(s)
if jump_type[block] == "terminal" or depth > global_params.DEPTH_LIMIT:
global total_no_of_paths
global no_of_test_cases
total_no_of_paths += 1
if global_params.GENERATE_TEST_CASES:
try:
model = solver.model()
no_of_test_cases += 1
filename = "test%s.otest" % no_of_test_cases
with open(filename, 'w') as f:
for variable in model.decls():
f.write(str(variable) + " = " + str(model[variable]) + "\n")
if os.stat(filename).st_size == 0:
os.remove(filename)
no_of_test_cases -= 1
except Exception as e:
pass
log.debug("TERMINATING A PATH ...")
display_analysis(analysis)
if is_testing_evm():
compare_storage_and_gas_unit_test(global_state, analysis)
elif jump_type[block] == "unconditional": # executing "JUMP"
successor = vertices[block].get_jump_target()
new_params = params.copy()
new_params.global_state["pc"] = successor
if g_src_map:
source_code = g_src_map.get_source_code(global_state['pc'])
if source_code in g_src_map.func_call_names:
func_call = global_state['pc']
sym_exec_block(new_params, successor, block, depth, func_call, current_func_name,is_printLog)
elif jump_type[block] == "falls_to": # just follow to the next basic block
successor = vertices[block].get_falls_to()
new_params = params.copy()
new_params.global_state["pc"] = successor
sym_exec_block(new_params, successor, block, depth, func_call, current_func_name,is_printLog)
elif jump_type[block] == "conditional": # executing "JUMPI"
# A choice point, we proceed with depth first search
# print(block)
branch_expression = vertices[block].get_branch_expression()
# print(branch_expression)
log.debug("Branch expression: " + str(branch_expression))
solver.push() # SET A BOUNDARY FOR SOLVER
solver.add(branch_expression)
# print(solver)
try:
if solver.check() == unsat:
log.debug("INFEASIBLE PATH DETECTED")
else:
left_branch = vertices[block].get_jump_target()
new_params = params.copy()
new_params.global_state["pc"] = left_branch
new_params.path_conditions_and_vars["path_condition"].append(branch_expression)
last_idx = len(new_params.path_conditions_and_vars["path_condition"]) - 1
new_params.analysis["time_dependency_bug"][last_idx] = global_state["pc"]
sym_exec_block(new_params, left_branch, block, depth, func_call, current_func_name,is_printLog)
except TimeoutError:
raise
except Exception as e:
if global_params.DEBUG_MODE:
traceback.print_exc()
solver.pop() # POP SOLVER CONTEXT
solver.push() # SET A BOUNDARY FOR SOLVER
negated_branch_expression = Not(branch_expression)
solver.add(negated_branch_expression)
log.debug("Negated branch expression: " + str(negated_branch_expression))
try:
if solver.check() == unsat:
# Note that this check can be optimized. I.e. if the previous check succeeds,
# no need to check for the negated condition, but we can immediately go into
# the else branch
log.debug("INFEASIBLE PATH DETECTED")
else:
right_branch = vertices[block].get_falls_to()
new_params = params.copy()
new_params.global_state["pc"] = right_branch
new_params.path_conditions_and_vars["path_condition"].append(negated_branch_expression)
last_idx = len(new_params.path_conditions_and_vars["path_condition"]) - 1
new_params.analysis["time_dependency_bug"][last_idx] = global_state["pc"]
# print 'execute right !!!!!'
sym_exec_block(new_params, right_branch, block, depth, func_call, current_func_name,is_printLog)
except TimeoutError:
raise
except Exception as e:
if global_params.DEBUG_MODE:
traceback.print_exc()
solver.pop() # POP SOLVER CONTEXT
updated_count_number = visited_edges[current_edge] - 1
visited_edges.update({current_edge: updated_count_number})
else:
updated_count_number = visited_edges[current_edge] - 1
visited_edges.update({current_edge: updated_count_number})
raise Exception('Unknown Jump-Type')
# Symbolically executing an instruction
def sym_exec_ins(params, block, instr, func_call, current_func_name,is_printLog=True):
global MSIZE
global visited_pcs
global solver
global vertices
global edges
global g_src_map
global calls_affect_state
global data_source
global start_data_output
global start_data_input
global size_data_input
global size_data_ouput
global msg_data
global g_all_contracts
global return_data_size
global return_data
global return_symbol_cons
stack = params.stack
mem = params.mem
memory = params.memory
global_state = params.global_state
sha3_list = params.sha3_list
path_conditions_and_vars = params.path_conditions_and_vars
analysis = params.analysis
calls = params.calls
overflow_pcs = params.overflow_pcs
visited_pcs.add(global_state["pc"])
instr_parts = str.split(instr, ' ')
opcode = instr_parts[0]
if opcode == "INVALID":
return
elif opcode == "ASSERTFAIL":
if g_src_map:
source_code = g_src_map.get_source_code(global_state['pc'])
source_code = source_code.split("(")[0]
func_name = source_code.strip()
if check_sat(solver, False) != unsat:
model = solver.model()
if func_name == "assert":
global_problematic_pcs["assertion_failure"].append(Assertion(global_state["pc"], model))
elif func_call != -1:
global_problematic_pcs["assertion_failure"].append(Assertion(func_call, model))