-
Notifications
You must be signed in to change notification settings - Fork 8
/
Copy pathdex.py
1431 lines (1265 loc) · 52.7 KB
/
dex.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
#!/usr/bin/env python3
import dataclasses
import unittest
from binascii import unhexlify
from enum import IntEnum, IntFlag
from struct import pack, unpack
from typing import Any, Dict, List, NewType, Optional, Tuple, Union, cast
from .smali import (
PseudoInstructions,
SmaliFillArrayDataPayload,
SmaliPackedSwitchPayload,
SmaliSparseSwitchPayload,
disassemble_pseudoinstructions,
)
try:
from compat import Endianness, log_debug, log_error, log_warn # type: ignore
except ModuleNotFoundError:
from .compat import Endianness, log_debug, log_error, log_warn
#
# LEB128
#
def parse_sleb128(data: bytes) -> Tuple[int, int]:
"""Parse sleb128 and return (value, length in bytes)."""
i = 0
val = data[i] & 0x7F
while data[i] & 0x80:
i += 1
val |= (data[i] & 0x7F) << (7 * i)
if val & (0x40 << (i * 7)):
for j in range(6 + i * 7, -1, -1):
if not (val | (1 << j)):
break
val ^= 1 << j
val = -1 - val
return val, i + 1
def parse_uleb128(data: bytes) -> Tuple[int, int]:
"""Parse uleb128 and return (value, length in bytes)."""
i = 0
val = data[i] & 0x7F
while data[i] & 0x80:
i += 1
val |= (data[i] & 0x7F) << (7 * i)
return val, i + 1
def parse_uleb128p1(data: bytes) -> Tuple[int, int]:
"""Parse uleb128p1 and return (value, length in bytes)."""
i = 0
val = data[i] & 0x7F
while data[i] & 0x80:
i += 1
val |= (data[i] & 0x7F) << (7 * i)
return val - 1, i + 1
class TestLeb128(unittest.TestCase):
def test_example1(self) -> None:
"""First example from https://source.android.com/devices/tech/dalvik/dex-format.html#leb128"""
data = b"\x00XXXXX"
self.assertEqual(parse_sleb128(data), (0, 1))
self.assertEqual(parse_uleb128(data), (0, 1))
self.assertEqual(parse_uleb128p1(data), (-1, 1))
def test_example2(self) -> None:
"""Second example from https://source.android.com/devices/tech/dalvik/dex-format.html#leb128"""
data = b"\x01XXXXX"
self.assertEqual(parse_sleb128(data), (1, 1))
self.assertEqual(parse_uleb128(data), (1, 1))
self.assertEqual(parse_uleb128p1(data), (0, 1))
def test_example3(self) -> None:
"""Third example from https://source.android.com/devices/tech/dalvik/dex-format.html#leb128"""
data = b"\x7fXXXXX"
self.assertEqual(parse_sleb128(data), (-1, 1))
self.assertEqual(parse_uleb128(data), (127, 1))
self.assertEqual(parse_uleb128p1(data), (126, 1))
def test_example4(self) -> None:
"""Fourth example from https://source.android.com/devices/tech/dalvik/dex-format.html#leb128"""
data = b"\x80\x7fXXXXX"
self.assertEqual(parse_sleb128(data), (-128, 2))
self.assertEqual(parse_uleb128(data), (16256, 2))
self.assertEqual(parse_uleb128p1(data), (16255, 2))
def test_5byte(self) -> None:
data = b"\xff\xff\xff\xff\x0fXXXXX"
self.assertEqual(parse_sleb128(data), (0xFFFFFFFF, 5))
self.assertEqual(parse_uleb128(data), (0xFFFFFFFF, 5))
self.assertEqual(parse_uleb128p1(data), (0xFFFFFFFE, 5))
def test_wikipedia_signed(self) -> None:
"""Signed example from https://en.wikipedia.org/wiki/LEB128"""
data = b"\x9b\xf1\x59XXXXX"
self.assertEqual(parse_sleb128(data), (-624485, 3))
def test_wikipedia_unsigned(self) -> None:
"""Unsigned example from https://en.wikipedia.org/wiki/LEB128"""
data = b"\xe5\x8e\x26XXXXX"
self.assertEqual(parse_uleb128(data), (624485, 3))
def test_gas_signed(self) -> None:
"""Signed examples from binutils gas
https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;a=blob;f=gas/testsuite/gas/all/sleb128.s;h=e8997ca175d4fcf05374cd45a62ccbc4630c3d1a;hb=refs/heads/master
https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;a=blob;f=gas/testsuite/gas/all/sleb128.d;h=993921ef5be6d8d605c61a3799225a8e3770adcd;hb=refs/heads/master
The Dex format specifies that all *LEB128 values are 32-bit and <=5
bytes, but might as well over-test.
"""
tests = {
"90e4d0b207": (0x76543210, 5),
"8080808008": (0x80000000, 5),
"a18695bb08": (0x87654321, 5),
"ffffffff0f": (0xFFFFFFFF, 5),
"f09bafcd78": (-0x76543210, 5),
"8080808078": (-0x80000000, 5),
"dff9eac477": (-0x87654321, 5),
"8180808070": (-0xFFFFFFFF, 5),
"ef9bafcdf8acd19101": (0x123456789ABCDEF, 9),
"91e4d0b287d3aeee7e": (-0x123456789ABCDEF, 9),
"81808080808060": (-0x7FFFFFFFFFFF, 7),
"80808080808060": (-0x800000000000, 7),
"8180808080808080807f": (-0x7FFFFFFFFFFFFFFF, 10),
"8080808080808080807f": (-0x8000000000000000, 10),
"8080808070": (-0x100000000, 5),
"80808080808040": (-0x1000000000000, 7),
}
for data in tests:
self.assertEqual(parse_sleb128(unhexlify(data)), tests[data])
#
# MUTF-8
#
def parse_mutf8(data: bytes) -> Tuple[str, int]:
"""Parse MUTF-8 and return (string, length in bytes)."""
chars = list() # list of strings
part_of_surrogate_pair = False
surrogate_first = 0
i = 0
while data[i] != 0:
if data[i] & 0x80:
if data[i] & 0x20:
# 3 bytes
code_point = ord(data[i : i + 3].decode("utf-8", "surrogatepass"))
if part_of_surrogate_pair:
# Second part of pair
# Use little-endian encoding for python
bb = pack("<H", surrogate_first) + pack("<H", code_point)
chars.append(bb.decode("utf-16", "surrogatepass"))
part_of_surrogate_pair = False
else:
if code_point < 0xD7FF or 0xE000 < code_point < 0xFFFF:
# Not part of pair
chars.append(chr(code_point))
else:
# First part of pair
part_of_surrogate_pair = True
surrogate_first = code_point
i += 3
else:
# 2 bytes
if data[i : i + 2] == b"\xc0\x80":
chars.append("\x00")
else:
chars.append(data[i : i + 2].decode("utf-8"))
i += 2
else:
# single byte
chars.append(chr(data[i]))
i += 1
if part_of_surrogate_pair:
chars.append(pack("<H", surrogate_first).decode("utf-16", "surrogatepass"))
return "".join(chars), i + 1
class TestMutf8(unittest.TestCase):
def test_empty_string(self) -> None:
self.assertEqual(parse_mutf8(b"\x00AAAAA"), ("", 1))
def test_null_byte(self) -> None:
self.assertEqual(parse_mutf8(b"\xc0\x80\x00"), ("\x00", 3))
def test_one_byte_chars(self) -> None:
self.assertEqual(parse_mutf8(b"A\x00"), ("A", 2))
self.assertEqual(parse_mutf8(b"\x01\x00"), ("\x01", 2))
self.assertEqual(parse_mutf8(b" \x00"), (" ", 2))
self.assertEqual(parse_mutf8(b"\x7e\x00"), ("~", 2))
self.assertEqual(parse_mutf8(b"hello\x00"), ("hello", 6))
def test_two_byte_chars(self) -> None:
self.assertEqual(parse_mutf8(b"\xc2\xa2\x00"), ("¢", 3))
self.assertEqual(parse_mutf8(b"\xc3\x98\x00"), ("Ø", 3))
self.assertEqual(parse_mutf8(b"\xc3\xa6\x00"), ("æ", 3))
self.assertEqual(parse_mutf8(b"\xcf\x84\x00"), ("τ", 3))
self.assertEqual(parse_mutf8(b"\xc2\xa0\x00"), ("\xa0", 3))
self.assertEqual(parse_mutf8(b"\xdf\xbf\x00"), ("\u07ff", 3))
def test_three_byte_chars(self) -> None:
self.assertEqual(parse_mutf8(b"\xe0\xa4\xb9\x00"), ("\u0939", 4))
self.assertEqual(parse_mutf8(b"\xe2\x82\xac\x00"), ("€", 4))
self.assertEqual(parse_mutf8(b"\xe3\x81\x82\x00"), ("あ", 4))
def test_surrogate_singleton(self) -> None:
self.assertEqual(parse_mutf8(b"\xed\xa0\x80\x00"), ("\ud800", 4))
def test_six_byte_chars(self) -> None:
self.assertEqual(
parse_mutf8(b"\xed\xae\x80\xed\xb0\x80\x00"), ("\U000f0000", 7)
)
#
# DexFile
#
DexType = NewType("DexType", str)
# Offset from beginning of file
FileOffset = NewType("FileOffset", int)
# Offset from beginning of data section
# DataOffset = NewType("DataOffset", int)
# Offset from beginning of section
# SectionOffset = NewType("SectionOffset", int)
# Word offset from beginning of code block
BytecodeAddress = NewType("BytecodeAddress", int)
NO_INDEX = 0xFFFFFFFF
@dataclasses.dataclass
class MapListItem:
size: int
offset: FileOffset
class MapType(IntEnum):
"""Dex map_item type codes
https://source.android.com/devices/tech/dalvik/dex-format.html#type-codes
"""
TYPE_HEADER_ITEM = 0x0000
TYPE_STRING_ID_ITEM = 0x0001
TYPE_TYPE_ID_ITEM = 0x0002
TYPE_PROTO_ID_ITEM = 0x0003
TYPE_FIELD_ID_ITEM = 0x0004
TYPE_METHOD_ID_ITEM = 0x0005
TYPE_CLASS_DEF_ITEM = 0x0006
TYPE_CALL_SITE_ID_ITEM = 0x0007
TYPE_METHOD_HANDLE_ITEM = 0x0008
TYPE_MAP_LIST = 0x1000
TYPE_TYPE_LIST = 0x1001
TYPE_ANNOTATION_SET_REF_LIST = 0x1002
TYPE_ANNOTATION_SET_ITEM = 0x1003
TYPE_CLASS_DATA_ITEM = 0x2000
TYPE_CODE_ITEM = 0x2001
TYPE_STRING_DATA_ITEM = 0x2002
TYPE_DEBUG_INFO_ITEM = 0x2003
TYPE_ANNOTATION_ITEM = 0x2004
TYPE_ENCODED_ARRAY_ITEM = 0x2005
TYPE_ANNOTATIONS_DIRECTORY_ITEM = 0x2006
class MethodHandleType(IntEnum):
"""Dex method_handle_item type codes
https://source.android.com/devices/tech/dalvik/dex-format.html#method-handle-type-codes
"""
METHOD_HANDLE_TYPE_STATIC_PUT = 0x00
METHOD_HANDLE_TYPE_STATIC_GET = 0x01
METHOD_HANDLE_TYPE_INSTANCE_PUT = 0x02
METHOD_HANDLE_TYPE_INSTANCE_GET = 0x03
METHOD_HANDLE_TYPE_INVOKE_STATIC = 0x04
METHOD_HANDLE_TYPE_INVOKE_INSTANCE = 0x05
METHOD_HANDLE_TYPE_INVOKE_CONSTRUCTOR = 0x06
METHOD_HANDLE_TYPE_INVOKE_DIRECT = 0x07
METHOD_HANDLE_TYPE_INVOKE_INTERFACE = 0x08
class AccessFlagEnum(IntFlag):
"""access_flags bitfield values for classes, fields, and methods
e.g. public, final, volatile
https://source.android.com/devices/tech/dalvik/dex-format.html#access-flags
"""
ACC_PUBLIC = 0x1
ACC_PRIVATE = 0x2
ACC_PROTECTED = 0x4
ACC_STATIC = 0x8
ACC_FINAL = 0x10
ACC_SYNCHRONIZED = 0x20
ACC_VOLATILE = 0x40
ACC_BRIDGE = 0x40
ACC_TRANSIENT = 0x80
ACC_VARARGS = 0x80
ACC_NATIVE = 0x100
ACC_INTERFACE = 0x200
ACC_ABSTRACT = 0x400
ACC_STRICT = 0x800
ACC_SYNTHETIC = 0x1000
ACC_ANNOTATION = 0x2000
ACC_ENUM = 0x4000
unused = 0x8000
ACC_CONSTRUCTOR = 0x10000
ACC_DECLARED_SYNCHRONIZED = 0x20000
class AccessFlag:
def __init__(self, val: int, context: str):
if context not in ("method", "field", "class"):
raise ValueError(f"Context {context} not valid for AccessFlag")
self.value = val
self.context = context
def __str__(self) -> str:
"""Make human-readable string.
In Java-land, the order is:
public protected private abstract static final transient volatile
synchronized native strictfp interface.
Sources:
https://developer.android.com/reference/java/lang/reflect/Modifier.html#toString(int)
http://cr.openjdk.java.net/~alundblad/styleguide/index-v6.html#toc-modifiers
https://docs.oracle.com/javase/specs/jls/se11/html/jls-8.html#jls-8.1.1
In Dex-land, dexgen orders them as:
public private protected static final super synchronized bridge
volatile varargs transient native interface abstract strictfp synthetic
annotation enum constructor declared_synchronized.
Sources:
https://android.googlesource.com/platform/dalvik2/+/refs/heads/master/dexgen/src/com/android/dexgen/rop/code/AccessFlags.java#297
https://github.com/JesusFreke/smali/blob/239b64ba003accffd1b0cf7c1c58d35435f5e94a/dexlib2/src/main/java/org/jf/dexlib2/AccessFlags.java
"""
if self.value == 0:
return ""
val = self.value
res = list()
if val & AccessFlagEnum.ACC_PUBLIC:
res.append("public")
val ^= AccessFlagEnum.ACC_PUBLIC
if val & AccessFlagEnum.ACC_PRIVATE:
res.append("private")
val ^= AccessFlagEnum.ACC_PRIVATE
if val & AccessFlagEnum.ACC_PROTECTED:
res.append("protected")
val ^= AccessFlagEnum.ACC_PROTECTED
if val & AccessFlagEnum.ACC_STATIC:
res.append("static")
val ^= AccessFlagEnum.ACC_STATIC
if val & AccessFlagEnum.ACC_FINAL:
res.append("final")
val ^= AccessFlagEnum.ACC_FINAL
if val & AccessFlagEnum.ACC_SYNCHRONIZED:
if self.context == "class":
res.append("super")
else:
res.append("synchronized")
val ^= AccessFlagEnum.ACC_SYNCHRONIZED
if val & AccessFlagEnum.ACC_VOLATILE:
if self.context == "method":
res.append("bridge")
else:
res.append("volatile")
val ^= AccessFlagEnum.ACC_VOLATILE
if val & AccessFlagEnum.ACC_TRANSIENT:
if self.context == "method":
res.append("varargs")
else:
res.append("transient")
val ^= AccessFlagEnum.ACC_TRANSIENT
if val & AccessFlagEnum.ACC_NATIVE:
res.append("native")
val ^= AccessFlagEnum.ACC_NATIVE
if val & AccessFlagEnum.ACC_INTERFACE:
res.append("interface")
val ^= AccessFlagEnum.ACC_INTERFACE
if val & AccessFlagEnum.ACC_ABSTRACT:
res.append("abstract")
val ^= AccessFlagEnum.ACC_ABSTRACT
if val & AccessFlagEnum.ACC_STRICT:
res.append("strictfp")
val ^= AccessFlagEnum.ACC_STRICT
if val & AccessFlagEnum.ACC_SYNTHETIC:
res.append("synthetic")
val ^= AccessFlagEnum.ACC_SYNTHETIC
if val & AccessFlagEnum.ACC_ANNOTATION:
res.append("annotation")
val ^= AccessFlagEnum.ACC_ANNOTATION
if val & AccessFlagEnum.ACC_ENUM:
res.append("enum")
val ^= AccessFlagEnum.ACC_ENUM
if val & AccessFlagEnum.ACC_CONSTRUCTOR:
res.append("constructor")
val ^= AccessFlagEnum.ACC_CONSTRUCTOR
if val & AccessFlagEnum.ACC_DECLARED_SYNCHRONIZED:
res.append("declared_synchronized")
val ^= AccessFlagEnum.ACC_DECLARED_SYNCHRONIZED
if val:
raise ValueError(
f"Failed to make string with all access flags. Value: {hex(self.value)}. Remaining: {hex(val)}"
)
return " ".join(res) + " "
class TestAccessFlag(unittest.TestCase):
def test_none(self) -> None:
"""No modifiers."""
self.assertEqual(str(AccessFlag(0, "class")), "")
self.assertEqual(str(AccessFlag(0, "method")), "")
self.assertEqual(str(AccessFlag(0, "field")), "")
def test_single(self) -> None:
"""Single modifier."""
self.assertEqual(str(AccessFlag(AccessFlagEnum.ACC_PUBLIC, "class")), "public ")
def test_sorted(self) -> None:
"""Cases with specified orders."""
self.assertEqual(
str(
AccessFlag(
AccessFlagEnum.ACC_PUBLIC | AccessFlagEnum.ACC_STATIC, "method"
)
),
"public static ",
)
self.assertEqual(
str(
AccessFlag(
AccessFlagEnum.ACC_PUBLIC
| AccessFlagEnum.ACC_PRIVATE
| AccessFlagEnum.ACC_PROTECTED
| AccessFlagEnum.ACC_STATIC
| AccessFlagEnum.ACC_FINAL
| AccessFlagEnum.ACC_SYNCHRONIZED
| AccessFlagEnum.ACC_VOLATILE
| AccessFlagEnum.ACC_TRANSIENT
| AccessFlagEnum.ACC_NATIVE
| AccessFlagEnum.ACC_INTERFACE
| AccessFlagEnum.ACC_ABSTRACT
| AccessFlagEnum.ACC_STRICT
| AccessFlagEnum.ACC_SYNTHETIC
| AccessFlagEnum.ACC_ANNOTATION
| AccessFlagEnum.ACC_ENUM
| AccessFlagEnum.ACC_CONSTRUCTOR
| AccessFlagEnum.ACC_DECLARED_SYNCHRONIZED,
"method",
)
),
"public private protected static final synchronized bridge varargs native interface abstract strictfp synthetic annotation enum constructor declared_synchronized ",
)
self.assertEqual(
str(
AccessFlag(
AccessFlagEnum.ACC_PUBLIC
| AccessFlagEnum.ACC_PRIVATE
| AccessFlagEnum.ACC_PROTECTED
| AccessFlagEnum.ACC_STATIC
| AccessFlagEnum.ACC_FINAL
| AccessFlagEnum.ACC_SYNCHRONIZED
| AccessFlagEnum.ACC_VOLATILE
| AccessFlagEnum.ACC_TRANSIENT
| AccessFlagEnum.ACC_NATIVE
| AccessFlagEnum.ACC_INTERFACE
| AccessFlagEnum.ACC_ABSTRACT
| AccessFlagEnum.ACC_STRICT
| AccessFlagEnum.ACC_SYNTHETIC
| AccessFlagEnum.ACC_ANNOTATION
| AccessFlagEnum.ACC_ENUM
| AccessFlagEnum.ACC_CONSTRUCTOR
| AccessFlagEnum.ACC_DECLARED_SYNCHRONIZED,
"field",
)
),
"public private protected static final synchronized volatile transient native interface abstract strictfp synthetic annotation enum constructor declared_synchronized ",
)
self.assertEqual(
str(
AccessFlag(
AccessFlagEnum.ACC_PUBLIC
| AccessFlagEnum.ACC_PRIVATE
| AccessFlagEnum.ACC_PROTECTED
| AccessFlagEnum.ACC_STATIC
| AccessFlagEnum.ACC_FINAL
| AccessFlagEnum.ACC_SYNCHRONIZED
| AccessFlagEnum.ACC_VOLATILE
| AccessFlagEnum.ACC_TRANSIENT
| AccessFlagEnum.ACC_NATIVE
| AccessFlagEnum.ACC_INTERFACE
| AccessFlagEnum.ACC_ABSTRACT
| AccessFlagEnum.ACC_STRICT
| AccessFlagEnum.ACC_SYNTHETIC
| AccessFlagEnum.ACC_ANNOTATION
| AccessFlagEnum.ACC_ENUM
| AccessFlagEnum.ACC_CONSTRUCTOR
| AccessFlagEnum.ACC_DECLARED_SYNCHRONIZED,
"class",
)
),
"public private protected static final super volatile transient native interface abstract strictfp synthetic annotation enum constructor declared_synchronized ",
)
class ValueType(IntEnum):
"""Dex encoded_value type codes
https://source.android.com/devices/tech/dalvik/dex-format.html#value-formats
"""
VALUE_BYTE = 0x00
VALUE_SHORT = 0x02
VALUE_CHAR = 0x03
VALUE_INT = 0x04
VALUE_LONG = 0x06
VALUE_FLOAT = 0x10
VALUE_DOUBLE = 0x11
VALUE_METHOD_TYPE = 0x15
VALUE_METHOD_HANDLE = 0x16
VALUE_STRING = 0x17
VALUE_TYPE = 0x18
VALUE_FIELD = 0x19
VALUE_METHOD = 0x1A
VALUE_ENUM = 0x1B
VALUE_ARRAY = 0x1C
VALUE_ANNOTATION = 0x1D
VALUE_NULL = 0x1E
VALUE_BOOLEAN = 0x1F
@dataclasses.dataclass
class DexValue:
"""Dex encoded_value object
https://source.android.com/devices/tech/dalvik/dex-format.html#encoding
"""
type_: ValueType
value: Any
@property
def value_str(self) -> str:
if self.type_ == ValueType.VALUE_BYTE:
return hex(self.value) + "t"
elif self.type_ == ValueType.VALUE_SHORT:
return hex(self.value) + "s"
elif self.type_ == ValueType.VALUE_CHAR:
return f"'{self.value.encode('unicode-escape').decode()}'"
elif self.type_ == ValueType.VALUE_INT:
return hex(self.value)
elif self.type_ == ValueType.VALUE_LONG:
return hex(self.value) + "L"
elif self.type_ == ValueType.VALUE_FLOAT:
return f"{self.value}f"
elif self.type_ == ValueType.VALUE_DOUBLE:
return str(self.value)
elif self.type_ == ValueType.VALUE_METHOD_TYPE:
# Needs testing
return f"({self.value.return_type})"
elif self.type_ == ValueType.VALUE_METHOD_HANDLE:
# Needs testing
return f"{self.value.type_}@{self.value.field_or_method_id}"
elif self.type_ == ValueType.VALUE_STRING:
return f'"{self.value.encode("unicode-escape").decode()}"'
elif self.type_ == ValueType.VALUE_TYPE:
# Needs testing
return self.value
elif self.type_ == ValueType.VALUE_FIELD:
# TODO If this is called from the same class, the class-> shouldn't be included
# Needs testing
return f"{self.value.class_}->{self.value.name}:{self.type_}"
elif self.type_ == ValueType.VALUE_METHOD:
# Same as ^
return f"{self.value.class_}->{self.value.name}({self.proto})"
elif self.type_ == ValueType.VALUE_ENUM:
# Same as ^
return f".enum {self.value.class_}->{self.value.name}:{self.type_}"
elif self.type_ == ValueType.VALUE_ARRAY:
# Needs testing
return "{" + ",".join([f"\n {x.value_str}" for x in self.value]) + "}"
elif self.type_ == ValueType.VALUE_ANNOTATION:
# TODO annotations
return (
".subannotation <type>\n"
# + ",".join([f"\n something = something" for x in self.something])
+ ".end subannotation"
)
elif self.type_ == ValueType.VALUE_NULL:
return "null"
elif self.type_ == ValueType.VALUE_BOOLEAN:
return str(self.value).lower()
DexEncodedArray = List[DexValue]
@dataclasses.dataclass
class DexProtoId:
"""Dex proto_id_item object
https://source.android.com/devices/tech/dalvik/dex-format.html#encoding
"""
shorty: str
return_type: DexType
parameters: List[DexType]
@dataclasses.dataclass
class DexEncodedCatchHandler:
"""Dex encoded_catch_handler object
https://source.android.com/devices/tech/dalvik/dex-format.html#encoded-catch-handler
"""
size: int
handlers: List[Tuple[DexType, int]]
catch_all_addr: BytecodeAddress = cast(BytecodeAddress, -1)
@dataclasses.dataclass
class DexTryItem:
"""Dex try_item object
https://source.android.com/devices/tech/dalvik/dex-format.html#type-item
"""
start_addr: BytecodeAddress
insn_count: int
handler: DexEncodedCatchHandler
@dataclasses.dataclass
class DexCodeItem:
"""Dex code_item object
https://source.android.com/devices/tech/dalvik/dex-format.html#code-item
"""
registers_size: int
ins_size: int
outs_size: int
tries_size: int
debug_info: FileOffset # TODO debug
insns_size: int
insns: bytes
_insns_off: FileOffset
tries: List[DexTryItem]
@dataclasses.dataclass
class DexFieldId:
"""Dex field_id_item object
https://source.android.com/devices/tech/dalvik/dex-format.html#field-id-item
"""
class_: DexType
type_: DexType
name: str
@dataclasses.dataclass
class DexEncodedField:
"""Dex encoded_field object
https://source.android.com/devices/tech/dalvik/dex-format.html#encoded-field-format
"""
field: DexFieldId
access_flags: AccessFlag
@dataclasses.dataclass
class DexMethodId:
"""Dex method_id_item object
https://source.android.com/devices/tech/dalvik/dex-format.html#method-id-item
"""
class_: DexType
proto: DexProtoId
name: str
_insns_off: Optional[FileOffset] = None
@dataclasses.dataclass
class DexEncodedMethod:
"""Dex encoded_method
https://source.android.com/devices/tech/dalvik/dex-format.html#encoded-method
"""
method: DexMethodId
access_flags: AccessFlag
code: Optional[DexCodeItem]
@dataclasses.dataclass
class DexMethodHandle:
"""Dex method_handle_item object
https://source.android.com/devices/tech/dalvik/dex-format.html#method-handle-item
"""
type_: MethodHandleType
field_or_method_id: Union[DexFieldId, DexMethodId]
@dataclasses.dataclass
class DexClassData:
static_fields: List[DexEncodedField]
instance_fields: List[DexEncodedField]
direct_methods: List[DexEncodedMethod]
virtual_methods: List[DexEncodedMethod]
@dataclasses.dataclass
class DexClassDef:
class_type: DexType
access_flags: AccessFlag
superclass: Optional[DexType]
interfaces: Optional[List[DexType]]
source_file: Optional[str]
annotations: Optional[FileOffset] # TODO
class_data: Optional[DexClassData]
static_values: List[DexValue]
def parse_ushort(endianness: Endianness, data: bytes) -> int:
if endianness == Endianness.LittleEndian:
return cast(int, unpack("<H", data)[0])
else:
return cast(int, unpack(">H", data)[0])
def parse_uint(endianness: Endianness, data: bytes) -> int:
if endianness == Endianness.LittleEndian:
return cast(int, unpack("<I", data)[0])
else:
return cast(int, unpack(">I", data)[0])
class DexFile(object):
"""Object to contain the entire parsed Dex."""
def _parse_ushort(self, data: bytes) -> int:
return parse_ushort(self.endianness, data)
def _parse_uint(self, data: bytes) -> int:
return parse_uint(self.endianness, data)
def __init__(self, data: bytes) -> None:
endian_bytes = data[40:44]
if endian_bytes == b"\x12\x34\x56\x78":
self.endianness = Endianness.BigEndian
elif endian_bytes == b"\x78\x56\x34\x12":
self.endianness = Endianness.LittleEndian
else:
raise ValueError(f"Invalid endianness found: {endian_bytes!r}")
if self.endianness == Endianness.BigEndian:
# It is likely that these do not exist at all, but who knows
log_warn(
"This is a big-endian file. The author was unable to find one of these to test with, so there will probably be errors. Please open an issue with a copy of this file!"
)
map_off = self._parse_uint(data[52:56])
map_size = self._parse_uint(data[map_off : map_off + 4])
# Parse map list items. First we collect them all, and then we parse
# them in an order that satisfies dependency relationships. For
# example, string_ids/strings need to be parsed first, and type_ids
# need to be parsed before type_lists, which need to be parsed before
# protos. Strings are the first items in the map list, but protos come
# before type_lists, so we can't just go in order.
map_list = dict()
for i in range(map_off + 4, 4 + map_off + map_size * 12, 12):
item_type = self._parse_ushort(data[i : i + 2])
item_size = self._parse_uint(data[i + 4 : i + 8])
item_offset = cast(FileOffset, self._parse_uint(data[i + 8 : i + 12]))
# log_debug(f'found type: "{item_type}", "{MapType(item_type).name}"')
map_list[item_type] = MapListItem(size=item_size, offset=item_offset)
# Ignore sections we don't need to reparse
map_list.pop(MapType.TYPE_HEADER_ITEM)
# The map list is what this part is parsing. No recursion
map_list.pop(MapType.TYPE_MAP_LIST)
# string_ids and strings
mi = map_list.pop(MapType.TYPE_STRING_ID_ITEM)
self.parse_string_ids(
data[mi.offset : mi.offset + 4 * mi.size], mi.size, mi.offset
)
self.make_strings(data)
del self.string_ids
map_list.pop(MapType.TYPE_STRING_DATA_ITEM) # Already handled
# Then, type_ids and type_lists
mi = map_list.pop(MapType.TYPE_TYPE_ID_ITEM)
self.parse_type_ids(
data[mi.offset : mi.offset + 4 * mi.size], mi.size, mi.offset
)
try:
mi = map_list.pop(MapType.TYPE_TYPE_LIST)
self.parse_type_lists(data[mi.offset :], mi.size, mi.offset)
except KeyError:
log_warn("No type list section")
# Need proto ids before method ids and both method ids and field
# ids before class data before class definitions
mi = map_list.pop(MapType.TYPE_PROTO_ID_ITEM)
self.parse_proto_ids(
data[mi.offset : mi.offset + 12 * mi.size], mi.size, mi.offset
)
mi = map_list.pop(MapType.TYPE_METHOD_ID_ITEM)
self.parse_method_ids(data[mi.offset :], mi.size, mi.offset)
try:
mi = map_list.pop(MapType.TYPE_FIELD_ID_ITEM)
self.parse_field_ids(
data[mi.offset : mi.offset + 8 * mi.size], mi.size, mi.offset
)
except KeyError:
log_warn("No field id section.")
mi = map_list.pop(MapType.TYPE_CODE_ITEM)
self.parse_code_items(data[mi.offset :], mi.size, mi.offset)
mi = map_list.pop(MapType.TYPE_CLASS_DATA_ITEM)
self.parse_class_data(data[mi.offset :], mi.size, mi.offset)
del self.code_items
# Need encoded_array_items before class_defs
try:
mi = map_list.pop(MapType.TYPE_ENCODED_ARRAY_ITEM)
self.parse_encoded_array_items(data[mi.offset :], mi.size, mi.offset)
except KeyError:
log_warn("No encoded array section.")
del self.proto_ids
# Rest are in order of MapType constant
mi = map_list.pop(MapType.TYPE_CLASS_DEF_ITEM)
self.parse_class_defs(
data[mi.offset : mi.offset + 32 * mi.size], mi.size, mi.offset
)
try:
del self.type_lists
del self.class_data_items
except AttributeError:
pass
try:
mi = map_list.pop(MapType.TYPE_CALL_SITE_ID_ITEM)
self.parse_call_site_ids(
data[mi.offset : mi.offset + 4 * mi.size], mi.size, mi.offset
)
except KeyError:
log_warn("No calls")
try:
mi = map_list.pop(MapType.TYPE_METHOD_HANDLE_ITEM)
self.parse_method_handles(
data[mi.offset : mi.offset + 8 * mi.size], mi.size, mi.offset
)
except KeyError:
log_warn("No methods")
# TODO annotations
try:
mi = map_list.pop(MapType.TYPE_ANNOTATION_ITEM)
mi = map_list.pop(MapType.TYPE_ANNOTATIONS_DIRECTORY_ITEM)
# self.parse_annotation_set_refs(data[mi.offset:mi.offset+4+mi.size*4], mi.size)
mi = map_list.pop(MapType.TYPE_ANNOTATION_SET_ITEM)
except KeyError:
log_warn("No annotations")
try:
mi = map_list.pop(MapType.TYPE_ANNOTATION_SET_REF_LIST)
# self.parse_annotation_sets(data[mi.offset:mi.offset+4+mi.size*4], mi.size)
except KeyError:
log_warn("No annotations set refs")
# TODO debug info
try:
mi = map_list.pop(MapType.TYPE_DEBUG_INFO_ITEM)
except KeyError:
log_warn("No debug info items")
for item_type in map_list:
log_error(f"unknown type {hex(item_type)}")
def parse_string_ids(
self, data: bytes, size: int, offset_to_section: FileOffset
) -> None:
i_offset = (4 - (offset_to_section)) % 4
self.string_ids = [
self._parse_uint(data[i : i + 4])
for i in range(i_offset, size * 4 + i_offset, 4)
]
def make_strings(self, data: bytes) -> None:
self.strings: List[str] = list()
for string_data_off in self.string_ids:
utf16_size, off = parse_uleb128(data[string_data_off : string_data_off + 5])
try:
string, string_size_off = parse_mutf8(data[string_data_off + off :])
except UnicodeDecodeError:
# This should never be reached
t = data[
string_data_off
+ off : string_data_off
+ off
+ data[string_data_off + off :].index(b"\x00")
]
log_error(f"Failed to decode MUTF8: {t!r}")
raise
self.strings.append(string)
plen = len(string.encode("utf-16", "surrogatepass")) // 2 - 1
if plen != utf16_size:
# This should never be reached
log_error(
f'String {repr(string)} at string offset "{string_data_off}" Python length {plen} does not match expected length {utf16_size}'
)
def parse_type_ids(
self, data: bytes, size: int, offset_to_section: FileOffset
) -> None:
i_offset = (4 - (offset_to_section)) % 4
self.type_ids: List[DexType] = [
DexType(self.strings[self._parse_uint(data[i : i + 4])])
for i in range(i_offset, size * 4 + i_offset, 4)
]
def parse_proto_ids(
self, data: bytes, size: int, offset_to_section: FileOffset
) -> None:
i_offset = (4 - (offset_to_section)) % 4
self.proto_ids: List[DexProtoId] = [
DexProtoId(
shorty=self.strings[self._parse_uint(data[i : i + 4])],
return_type=self.type_ids[self._parse_uint(data[i + 4 : i + 8])],
parameters=(
self.type_lists[
cast(FileOffset, self._parse_uint(data[i + 8 : i + 12]))
]
if self._parse_uint(data[i + 8 : i + 12])
else list()
),
)
for i in range(i_offset, size * 12 + i_offset, 12)
]
for proto in self.proto_ids:
if len(proto.shorty) - 1 != len(proto.parameters):
log_error("Shorty does not match parameters")
def parse_field_ids(
self, data: bytes, size: int, offset_to_section: FileOffset
) -> None:
i_offset = (4 - (offset_to_section)) % 4
self.field_ids = [
DexFieldId(
class_=self.type_ids[self._parse_ushort(data[i : i + 2])],
type_=self.type_ids[self._parse_ushort(data[i + 2 : i + 4])],
name=self.strings[self._parse_uint(data[i + 4 : i + 8])],
)
for i in range(i_offset, i_offset + size * 8, 8)
]
def parse_method_ids(
self, data: bytes, size: int, offset_to_section: FileOffset
) -> None:
i_offset = (4 - (offset_to_section)) % 4
self.method_ids = [
DexMethodId(
class_=self.type_ids[self._parse_ushort(data[i : i + 2])],
proto=self.proto_ids[self._parse_ushort(data[i + 2 : i + 4])],
name=self.strings[self._parse_uint(data[i + 4 : i + 8])],
)
for i in range(i_offset, size * 8 + i_offset, 8)
]
def parse_class_defs(
self, data: bytes, size: int, offset_to_section: FileOffset
) -> None:
i_offset = (4 - (offset_to_section)) % 4
self.class_defs = list()
for i in range(i_offset, size * 32 + i_offset, 32):
cdef = DexClassDef(
class_type=self.type_ids[self._parse_uint(data[i : i + 4])],
access_flags=AccessFlag(self._parse_uint(data[i + 4 : i + 8]), "class"),
superclass=(
self.type_ids[self._parse_uint(data[i + 8 : i + 12])]
if self._parse_uint(data[i + 8 : i + 12]) != NO_INDEX