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
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AXML Module — apkInspector documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Extract Module" href="extract.html" />
<link rel="prev" title="Headers Module" href="headers.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
apkInspector
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="headers.html">Headers Module</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">AXML Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.ManifestStruct"><code class="docutils literal notranslate"><span class="pre">ManifestStruct</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.ManifestStruct.check_reached_element"><code class="docutils literal notranslate"><span class="pre">ManifestStruct.check_reached_element()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.ManifestStruct.get_manifest"><code class="docutils literal notranslate"><span class="pre">ManifestStruct.get_manifest()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.ManifestStruct.parse"><code class="docutils literal notranslate"><span class="pre">ManifestStruct.parse()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.ManifestStruct.parse_lite"><code class="docutils literal notranslate"><span class="pre">ManifestStruct.parse_lite()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.ManifestStruct.parse_next_header"><code class="docutils literal notranslate"><span class="pre">ManifestStruct.parse_next_header()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.ManifestStruct.process_elements"><code class="docutils literal notranslate"><span class="pre">ManifestStruct.process_elements()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.ResChunkHeader"><code class="docutils literal notranslate"><span class="pre">ResChunkHeader</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.ResChunkHeader.parse"><code class="docutils literal notranslate"><span class="pre">ResChunkHeader.parse()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.ResStringPoolHeader"><code class="docutils literal notranslate"><span class="pre">ResStringPoolHeader</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.ResStringPoolHeader.parse"><code class="docutils literal notranslate"><span class="pre">ResStringPoolHeader.parse()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader"><code class="docutils literal notranslate"><span class="pre">ResXMLHeader</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader.parse"><code class="docutils literal notranslate"><span class="pre">ResXMLHeader.parse()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.StringPoolType"><code class="docutils literal notranslate"><span class="pre">StringPoolType</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.StringPoolType.decode_stringpool_mixed_string"><code class="docutils literal notranslate"><span class="pre">StringPoolType.decode_stringpool_mixed_string()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.StringPoolType.get_string_from_pool"><code class="docutils literal notranslate"><span class="pre">StringPoolType.get_string_from_pool()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.StringPoolType.parse"><code class="docutils literal notranslate"><span class="pre">StringPoolType.parse()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.StringPoolType.parse_lite"><code class="docutils literal notranslate"><span class="pre">StringPoolType.parse_lite()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.StringPoolType.read_string"><code class="docutils literal notranslate"><span class="pre">StringPoolType.read_string()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.StringPoolType.read_string_offset"><code class="docutils literal notranslate"><span class="pre">StringPoolType.read_string_offset()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.StringPoolType.read_string_offsets"><code class="docutils literal notranslate"><span class="pre">StringPoolType.read_string_offsets()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.StringPoolType.read_strings"><code class="docutils literal notranslate"><span class="pre">StringPoolType.read_strings()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.XmlAttributeElement"><code class="docutils literal notranslate"><span class="pre">XmlAttributeElement</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.XmlAttributeElement.parse"><code class="docutils literal notranslate"><span class="pre">XmlAttributeElement.parse()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.XmlEndElement"><code class="docutils literal notranslate"><span class="pre">XmlEndElement</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.XmlEndElement.parse"><code class="docutils literal notranslate"><span class="pre">XmlEndElement.parse()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.XmlEndNamespace"><code class="docutils literal notranslate"><span class="pre">XmlEndNamespace</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.XmlEndNamespace.parse"><code class="docutils literal notranslate"><span class="pre">XmlEndNamespace.parse()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.XmlResourceMapType"><code class="docutils literal notranslate"><span class="pre">XmlResourceMapType</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.XmlResourceMapType.parse"><code class="docutils literal notranslate"><span class="pre">XmlResourceMapType.parse()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.XmlResourceMapType.parse_lite"><code class="docutils literal notranslate"><span class="pre">XmlResourceMapType.parse_lite()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.XmlStartElement"><code class="docutils literal notranslate"><span class="pre">XmlStartElement</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.XmlStartElement.parse"><code class="docutils literal notranslate"><span class="pre">XmlStartElement.parse()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.XmlStartNamespace"><code class="docutils literal notranslate"><span class="pre">XmlStartNamespace</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.XmlStartNamespace.parse"><code class="docutils literal notranslate"><span class="pre">XmlStartNamespace.parse()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.XmlcDataElement"><code class="docutils literal notranslate"><span class="pre">XmlcDataElement</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.axml.XmlcDataElement.parse"><code class="docutils literal notranslate"><span class="pre">XmlcDataElement.parse()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.create_manifest"><code class="docutils literal notranslate"><span class="pre">create_manifest()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.get_attribute_value"><code class="docutils literal notranslate"><span class="pre">get_attribute_value()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.get_manifest"><code class="docutils literal notranslate"><span class="pre">get_manifest()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.get_manifest_lite"><code class="docutils literal notranslate"><span class="pre">get_manifest_lite()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.parse_apk_for_manifest"><code class="docutils literal notranslate"><span class="pre">parse_apk_for_manifest()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.process_attributes"><code class="docutils literal notranslate"><span class="pre">process_attributes()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.axml.read_remaining"><code class="docutils literal notranslate"><span class="pre">read_remaining()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="extract.html">Extract Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="indicators.html">Indicators Module</a></li>
<li class="toctree-l1"><a class="reference internal" href="helpers.html">Helpers Module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">apkInspector</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">AXML Module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/axml.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-apkInspector.axml">
<span id="axml-module"></span><h1>AXML Module<a class="headerlink" href="#module-apkInspector.axml" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.ManifestStruct">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">ManifestStruct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResChunkHeader" title="apkInspector.axml.ResChunkHeader"><span class="pre">ResChunkHeader</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_pool</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.StringPoolType" title="apkInspector.axml.StringPoolType"><span class="pre">StringPoolType</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">resource_map</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.XmlResourceMapType" title="apkInspector.axml.XmlResourceMapType"><span class="pre">XmlResourceMapType</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">elements</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ManifestStruct" title="Link to this definition"></a></dt>
<dd><p>A class to represent the AndroidManifest as a composition</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.ManifestStruct.check_reached_element">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_reached_element</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BytesIO</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ManifestStruct.check_reached_element" title="Link to this definition"></a></dt>
<dd><p>Static method to check if the next element right after the resource map chunk has been reached. There is only a
set of possible elements after the resource map chunk that could be met.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>io.BytesIO</em>) – The AndroidManifest file</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.ManifestStruct.get_manifest">
<span class="sig-name descname"><span class="pre">get_manifest</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ManifestStruct.get_manifest" title="Link to this definition"></a></dt>
<dd><p>Method to return the AndroidManifest created from this instance</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The AndroidManifest.xml as a string</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.ManifestStruct.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ManifestStruct.parse" title="Link to this definition"></a></dt>
<dd><p>A composition of the rest of the classes available in the apkInspector.axml module, to form the AndroidManifest structure.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>bytesIO</em>) – the axml that will be processed</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.ManifestStruct" title="apkInspector.axml.ManifestStruct">ManifestStruct</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.ManifestStruct.parse_lite">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_lite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manifest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_of_elements</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ManifestStruct.parse_lite" title="Link to this definition"></a></dt>
<dd><p>Parse the AndroidManifest with a limit on the elements to be parsed after the string pool. The goal of this method
is to make it possible to partially parse the AndroidManifest and allow faster parsing when needed. Only the
header is parsed from each chunk, and the rest are there as blobs of bytes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>manifest</strong> (<em>bytesIO</em>) – The manifest to be processed</p></li>
<li><p><strong>num_of_elements</strong> (<em>int</em>) – How many elements of the manifest to process. Usually 3 are enough to get basic info about it.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A tuple containing four elements: ResChunkHeader, [ResStringPoolHeader, string_pool_data], [ResChunkHeader, resource_map_data], elements</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple (ResChunkHeader_init, [<a class="reference internal" href="#apkInspector.axml.ResStringPoolHeader" title="apkInspector.axml.ResStringPoolHeader">ResStringPoolHeader</a>, bytes], [<a class="reference internal" href="#apkInspector.axml.ResChunkHeader" title="apkInspector.axml.ResChunkHeader">ResChunkHeader</a>, bytes], list of bytes)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.ManifestStruct.parse_next_header">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_next_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ManifestStruct.parse_next_header" title="Link to this definition"></a></dt>
<dd><p>Dispatcher method to parse the next available header. It takes into account to move on past the header if it
contains extra info besides the standard ones.
The dispatcher automatically picks the correct processing method for each chunk type.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>bytesIO</em>) – the axml that will be processed</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>NotImplementedError</strong> – The chunk type identified is not supported</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Dispatches to the appropriate processing method for each chunk type.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.ManifestStruct.process_elements">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">process_elements</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_of_elements</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ManifestStruct.process_elements" title="Link to this definition"></a></dt>
<dd><p>It starts processing the remaining chunks <strong>after</strong> the resource map chunk.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>BytesIO</em>) – the axml that will be processed</p></li>
<li><p><strong>num_of_elements</strong> (<em>int</em>) – how many elements should it process</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns all the elements found as their corresponding classes and whether dummy data were found in between.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>set(list, set(bool, bool))</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.ResChunkHeader">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">ResChunkHeader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ResChunkHeader" title="Link to this definition"></a></dt>
<dd><p>Chunk header used throughout the axml.
This header is essential as it contains information about the header size but also the total size of the chunk
the header belongs to.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.ResChunkHeader.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ResChunkHeader.parse" title="Link to this definition"></a></dt>
<dd><p>Read the header type (2 bytes), header size (2 bytes), and entry size (4 bytes).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>bytesIO</em>) – the xml file e.g. with open(‘/path/AndroidManifest.xml’, ‘rb’) as file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.ResChunkHeader" title="apkInspector.axml.ResChunkHeader">ResChunkHeader</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.ResStringPoolHeader">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">ResStringPoolHeader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResChunkHeader" title="apkInspector.axml.ResChunkHeader"><span class="pre">ResChunkHeader</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">style_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strings_start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">styles_start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ResStringPoolHeader" title="Link to this definition"></a></dt>
<dd><p>It reads the string pool header which contains information about the StringPool.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.ResStringPoolHeader.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ResStringPoolHeader.parse" title="Link to this definition"></a></dt>
<dd><p>Read and parse ResStringPoolHeader from the file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>bytesIO</em>) – the xml file right after the header has been read.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.ResStringPoolHeader" title="apkInspector.axml.ResStringPoolHeader">ResStringPoolHeader</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.ResXMLHeader">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">ResXMLHeader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResChunkHeader" title="apkInspector.axml.ResChunkHeader"><span class="pre">ResChunkHeader</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ResXMLHeader" title="Link to this definition"></a></dt>
<dd><p>Chunk header used as a header for the elements.
This header represents the header for the rest of the elements besides the initial header, the string pool and
the resource map.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.ResXMLHeader.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.ResXMLHeader.parse" title="Link to this definition"></a></dt>
<dd><p>Supporting header for the elements besides the initial header, the string pool and
the resource map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>bytesIO</em>) – the xml file e.g. with open(‘/path/AndroidManifest.xml’, ‘rb’) as file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader">ResXMLHeader</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.StringPoolType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">StringPoolType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string_pool_header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResStringPoolHeader" title="apkInspector.axml.ResStringPoolHeader"><span class="pre">ResStringPoolHeader</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_offsets</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_pool_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.StringPoolType" title="Link to this definition"></a></dt>
<dd><p>The stringPool class which is a composition of the ResStringPoolHeader
along with the string offsets and the string data.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.StringPoolType.decode_stringpool_mixed_string">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decode_stringpool_mixed_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_utf8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_stringpool_offset</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.StringPoolType.decode_stringpool_mixed_string" title="Link to this definition"></a></dt>
<dd><p>Handling the different encoding possibilities that can be met.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>bytesIO</em>) – the xml file at the offset where the string is to be read</p></li>
<li><p><strong>is_utf8</strong> (<em>bool</em>) – boolean to check if a utf8 string is expected</p></li>
<li><p><strong>end_stringpool_offset</strong> (<em>int</em>) – </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns the decoded string</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.StringPoolType.get_string_from_pool">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_string_from_pool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">position</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_pool_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_stringpool_offset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strings_start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_utf8</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.StringPoolType.get_string_from_pool" title="Link to this definition"></a></dt>
<dd><p>Retrieve a single string from the String Pool, given its position. It first gets the correct offset of the
string and then reads the string.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>position</strong> (<em>int</em>) – The position of the string to be retrieved</p></li>
<li><p><strong>string_pool_data</strong> (<em>io.BytesIO</em>) – the string pool data parsed as bytes</p></li>
<li><p><strong>end_stringpool_offset</strong> (<em>int</em>) – the offset at which the string pool ends</p></li>
<li><p><strong>strings_start</strong> (<em>int</em>) – the offset at which the string data starts</p></li>
<li><p><strong>is_utf8</strong> (<em>bool</em>) – boolean to check if a utf8 string is expected</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns the string or None</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str or None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.StringPoolType.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.StringPoolType.parse" title="Link to this definition"></a></dt>
<dd><p>Parse the string pool to acquire the strings used within the axml.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>bytesIO</em>) – the xml file right after the file header is read</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.StringPoolType" title="apkInspector.axml.StringPoolType">StringPoolType</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.StringPoolType.parse_lite">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_lite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.StringPoolType.parse_lite" title="Link to this definition"></a></dt>
<dd><p>A ‘lite’ parser that gets the header and then reads the rest of the chunk as a blob of bytes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>bytesIO</em>) – the AndroidManifest.xml file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns the header and the chunk data</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple(<a class="reference internal" href="#apkInspector.axml.ResStringPoolHeader" title="apkInspector.axml.ResStringPoolHeader">ResStringPoolHeader</a>, bytes)</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.StringPoolType.read_string">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_offset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strings_start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_utf8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_stringpool_offset</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.StringPoolType.read_string" title="Link to this definition"></a></dt>
<dd><p>Read a string from the string pool when the offset of it is known already.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>io.bytesIO</em>) – the string pool data parsed as bytes</p></li>
<li><p><strong>string_offset</strong> (<em>int</em>) – the offset at which the string is located in the string pool</p></li>
<li><p><strong>strings_start</strong> (<em>int</em>) – the offset at which the string data starts</p></li>
<li><p><strong>is_utf8</strong> (<em>bool</em>) – boolean to check if a utf8 string is expected</p></li>
<li><p><strong>end_stringpool_offset</strong> (<em>int</em>) – the offset at which the string pool ends</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns the string or None</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str or None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.StringPoolType.read_string_offset">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read_string_offset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">position</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.StringPoolType.read_string_offset" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.StringPoolType.read_string_offsets">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read_string_offsets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_of_strings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_absolute_offset</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.StringPoolType.read_string_offsets" title="Link to this definition"></a></dt>
<dd><p>Reads the offset available for each string. Requires to know the number of strings available beforehand.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>bytesIO</em>) – the xml file right after the string pool header has been read.</p></li>
<li><p><strong>num_of_strings</strong> (<em>int</em>) – the calculated number of strings available</p></li>
<li><p><strong>end_absolute_offset</strong> (<em>int</em>) – the absolute value of the offset where the offsets finish.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns a list of strings offsets.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.StringPoolType.read_strings">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">read_strings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_offsets</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strings_start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_utf8</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.StringPoolType.read_strings" title="Link to this definition"></a></dt>
<dd><p>Gets the actual strings based on the offsets retrieved from read_string_offsets().</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>bytesIO</em>) – the xml file right after the string pool offsets have been read</p></li>
<li><p><strong>string_offsets</strong> (<em>list</em>) – see -> read_string_offsets()</p></li>
<li><p><strong>strings_start</strong> (<em>int</em>) – the offset at which the string data starts</p></li>
<li><p><strong>is_utf8</strong> (<em>bool</em>) – boolean to check if a utf8 string is expected</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns a list of the string data</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.XmlAttributeElement">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">XmlAttributeElement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">full_namespace_index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_value_index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typed_value_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typed_value_res0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typed_value_datatype</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typed_value_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlAttributeElement" title="Link to this definition"></a></dt>
<dd><p>The attributes within each element within the axml, should be described by this class.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.XmlAttributeElement.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attr_count</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attr_size</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlAttributeElement.parse" title="Link to this definition"></a></dt>
<dd><p>The method is responsible to parse and retrieve the attributes of an element based on the attribute count.
There are many datatypes that are not read according to the specification (at least for now), but that does
not affect the main goal of the tool, therefore it is not a priority. For the presentation of the values
another check is occurring in the process_attributes method.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>BytesIO</em>) – the axml already pointing at the right offset</p></li>
<li><p><strong>attr_count</strong> (<em>int</em>) – The attribute count value part of XmlStartElement.attrext</p></li>
<li><p><strong>attr_size</strong> (<em>int</em>) – The attribute size value part of XmlStartElement</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>List of attributes</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.XmlEndElement">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">XmlEndElement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrext</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrext_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlEndElement" title="Link to this definition"></a></dt>
<dd><p>The end of an element, where the attrext contains the necessary information on which element it ends.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.XmlEndElement.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlEndElement.parse" title="Link to this definition"></a></dt>
<dd><p>Parse the end of an element.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>bytesIO</em>) – the axml already pointing at the right offset</p></li>
<li><p><strong>header_t</strong> (<a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><em>ResXMLHeader</em></a>) – the already read header of the chunk</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.XmlEndElement" title="apkInspector.axml.XmlEndElement">XmlEndElement</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.XmlEndNamespace">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">XmlEndNamespace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix_namespace_index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uri_index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_namespace_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlEndNamespace" title="Link to this definition"></a></dt>
<dd><p>Class to represent the end of a Namespace.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.XmlEndNamespace.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlEndNamespace.parse" title="Link to this definition"></a></dt>
<dd><p>Parse the ending element of a Namespace.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>bytesIO</em>) – the axml already pointing at the right offset</p></li>
<li><p><strong>header_t</strong> (<a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><em>ResXMLHeader</em></a>) – the already read header of the chunk</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.XmlEndNamespace" title="apkInspector.axml.XmlEndNamespace">XmlEndNamespace</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.XmlResourceMapType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">XmlResourceMapType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resids</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">resids_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlResourceMapType" title="Link to this definition"></a></dt>
<dd><p>Resource map class, with the header and the resource IDs.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.XmlResourceMapType.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlResourceMapType.parse" title="Link to this definition"></a></dt>
<dd><p>Parse the resource map and get the resource IDs.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>bytesIO</em>) – the xml file right after the string pool is read</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.XmlResourceMapType" title="apkInspector.axml.XmlResourceMapType">XmlResourceMapType</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.XmlResourceMapType.parse_lite">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_lite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlResourceMapType.parse_lite" title="Link to this definition"></a></dt>
<dd><p>A ‘lite’ parser that gets the header and then reads the rest of the chunk as a blob of bytes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>file</strong> (<em>bytesIO</em>) – the AndroidManifest.xml file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns the header and the chunk data</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple(<a class="reference internal" href="#apkInspector.axml.ResChunkHeader" title="apkInspector.axml.ResChunkHeader">ResChunkHeader</a>, bytes)</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.XmlStartElement">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">XmlStartElement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrext</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_element_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlStartElement" title="Link to this definition"></a></dt>
<dd><p>The starting point of an element, its attributes are described by XmlAttributeElement.
The attrext contains information about the element including the attribute count.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.XmlStartElement.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlStartElement.parse" title="Link to this definition"></a></dt>
<dd><p>Parse the current element</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>BytesIO</em>) – the axml already pointing at the right offset</p></li>
<li><p><strong>header_t</strong> (<a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><em>ResXMLHeader</em></a>) – the already read header of the chunk</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.XmlStartElement" title="apkInspector.axml.XmlStartElement">XmlStartElement</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.XmlStartNamespace">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">XmlStartNamespace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">ext</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ext_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlStartNamespace" title="Link to this definition"></a></dt>
<dd><p>The actual start of the xml, after this the elements of the xml will be found.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.XmlStartNamespace.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlStartNamespace.parse" title="Link to this definition"></a></dt>
<dd><p>Parse the starting element of a Namespace
:param file: the axml already pointing at the right offset
:type file: bytesIO
:param header_t: the already read header of the chunk
:type header_t: ResXMLHeader
:return: an instance of itself
:rtype: XmlStartNamespace</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.axml.XmlcDataElement">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">XmlcDataElement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_index</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typed_value_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typed_value_res0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typed_value_datatype</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">typed_value_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cdata_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlcDataElement" title="Link to this definition"></a></dt>
<dd><p>A class to cover any CDATA section
<a class="reference external" href="https://developer.android.com/reference/org/w3c/dom/CDATASection">https://developer.android.com/reference/org/w3c/dom/CDATASection</a></p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.axml.XmlcDataElement.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><span class="pre">ResXMLHeader</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.XmlcDataElement.parse" title="Link to this definition"></a></dt>
<dd><p>Parse the CDATA element.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>bytesIO</em>) – the axml already pointing at the right offset</p></li>
<li><p><strong>header_t</strong> (<a class="reference internal" href="#apkInspector.axml.ResXMLHeader" title="apkInspector.axml.ResXMLHeader"><em>ResXMLHeader</em></a>) – the already read header of the chunk</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>an instance of itself</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.axml.XmlcDataElement" title="apkInspector.axml.XmlcDataElement">XmlcDataElement</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.axml.create_manifest">
<span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">create_manifest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">elements</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_list</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.create_manifest" title="Link to this definition"></a></dt>
<dd><p>Method to create the readable XML AndroidManifest.xml file based on the elements discovered from the processed APK</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>elements</strong> (<em>list</em>) – The parsed elements as returned by process_elements()[0]</p></li>
<li><p><strong>string_list</strong> (<em>list</em>) – The string pool data</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The AndroidManifest.xml as a string</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.axml.get_attribute_value">
<span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">get_attribute_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attr_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attribute</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end_stringpool_offset</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strings_start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_utf8</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_pool_data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.get_attribute_value" title="Link to this definition"></a></dt>
<dd><p>Gets the value for a single attribute</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>attr_name</strong> (<em>str</em>) – The attribute name as it has been retrieved by the string pool</p></li>
<li><p><strong>attribute</strong> (<a class="reference internal" href="#apkInspector.axml.XmlAttributeElement" title="apkInspector.axml.XmlAttributeElement"><em>XmlAttributeElement</em></a>) – the parsed attribute itself</p></li>
<li><p><strong>end_stringpool_offset</strong> (<em>int</em>) – The end of string pool offset</p></li>
<li><p><strong>strings_start</strong> (<em>int</em>) – the strings start offset for the string pool</p></li>
<li><p><strong>is_utf8</strong> (<em>bool</em>) – boolean to check if a utf8 string is expected</p></li>
<li><p><strong>string_pool_data</strong> (<em>io.BytesIO</em>) – The string pool data as io.BytesIO</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns the attribute value</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.axml.get_manifest">
<span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">get_manifest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_manifest</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.get_manifest" title="Link to this definition"></a></dt>
<dd><p>Helper method to directly return the AndroidManifest file as created by create_manifest()</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>raw_manifest</strong> (<em>bytesIO</em>) – expects the encoded AndroidManifest.xml file as a file-like object</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns the decoded AndroidManifest file</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.axml.get_manifest_lite">
<span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">get_manifest_lite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manifest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BytesIO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_of_elements</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.get_manifest_lite" title="Link to this definition"></a></dt>
<dd><p>A method to provide ‘lite’ parsing of the AndroidManifest in order to retrieve a few details as fast as possible.
Based on the integer ‘num_of_elements’ being passed as a parameter, it will attempt to fetch this many chunks right
after the ‘resource map’ chunk and will get the attributes values of these elements if they are of instance XmlStartElement</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>manifest</strong> (<em>io.BytesIO</em>) – The manifest to be processed</p></li>
<li><p><strong>num_of_elements</strong> (<em>int</em>) – </p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns a dictionary of the attributes discovered</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.axml.parse_apk_for_manifest">
<span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">parse_apk_for_manifest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inc_apk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">num_of_elements</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">3</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.parse_apk_for_manifest" title="Link to this definition"></a></dt>
<dd><p>Helper method to retrieve the AndroidManifest directly from an APK, either by providing the APK itself or the path.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>inc_apk</strong> (<em>str</em>) – The path of the APK file or the APK itself</p></li>
<li><p><strong>raw</strong> (<em>bool</em>) – Boolean parameter to define whether the manifest is provided as string or bytes</p></li>
<li><p><strong>lite</strong> (<em>bool</em>) – Boolean parameter to define whether the lite parsing would occur or not</p></li>
<li><p><strong>num_of_elements</strong> (<em>int</em>) – Number of elements to parse from the APK</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns the AndroidManifest.xml as string</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.axml.process_attributes">
<span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">process_attributes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">string_list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ns_dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.process_attributes" title="Link to this definition"></a></dt>
<dd><p>Helps in processing the representation of attributes found in each element of the axml. It should be noted that not
all datatypes are taken into account, meaning that the values of certain attributes might not be represented properly.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>attributes</strong> (<em>list</em>) – the attributes of an XmlStartElement object as returned by XmlAttributeElement.parse()</p></li>
<li><p><strong>string_list</strong> (<em>list</em>) – the string data list from the String Pool</p></li>
<li><p><strong>ns_dict</strong> (<em>dict</em>) – a namespace dictionary based on the XmlStartNamespace elements found</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns a string of all the attributes with their values</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.axml.read_remaining">
<span class="sig-prename descclassname"><span class="pre">apkInspector.axml.</span></span><span class="sig-name descname"><span class="pre">read_remaining</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BytesIO</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.axml.ResChunkHeader" title="apkInspector.axml.ResChunkHeader"><span class="pre">ResChunkHeader</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.axml.read_remaining" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file</strong> (<em>io.BytesIO</em>) – the current file that is being processed</p></li>
<li><p><strong>header</strong> (<a class="reference internal" href="#apkInspector.axml.ResChunkHeader" title="apkInspector.axml.ResChunkHeader"><em>ResChunkHeader</em></a>) – the header of the current chunk of instance ResChunkHeader</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns the remaining bytes of the chunk except the header</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bytes</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="headers.html" class="btn btn-neutral float-left" title="Headers Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="extract.html" class="btn btn-neutral float-right" title="Extract Module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, erev0s.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
