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
|
<!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>Extract 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="Indicators Module" href="indicators.html" />
<link rel="prev" title="AXML Module" href="axml.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"><a class="reference internal" href="axml.html">AXML Module</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Extract Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.extract.extract_all_files_from_central_directory"><code class="docutils literal notranslate"><span class="pre">extract_all_files_from_central_directory()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.extract.extract_file_based_on_header_info"><code class="docutils literal notranslate"><span class="pre">extract_file_based_on_header_info()</span></code></a></li>
</ul>
</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">Extract Module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/extract.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.extract">
<span id="extract-module"></span><h1>Extract Module<a class="headerlink" href="#module-apkInspector.extract" title="Link to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.extract.extract_all_files_from_central_directory">
<span class="sig-prename descclassname"><span class="pre">apkInspector.extract.</span></span><span class="sig-name descname"><span class="pre">extract_all_files_from_central_directory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">apk_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">central_directory_entries</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_header_entries</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_dir</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.extract.extract_all_files_from_central_directory" title="Link to this definition"></a></dt>
<dd><p>Extracts all files from an APK based on the entries detected in the central_directory_entries.</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>apk_file</strong> (<em>bytesIO</em>) – The APK file e.g. with open(‘test.apk’, ‘rb’) as apk_file</p></li>
<li><p><strong>central_directory_entries</strong> (<em>dict</em>) – The dictionary with all the entries for the central directory</p></li>
<li><p><strong>local_header_entries</strong> (<em>dict</em>) – The dictionary with all the local header entries</p></li>
<li><p><strong>output_dir</strong> (<em>str</em>) – The output directory where to save the files.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns 0 if no errors, 1 if an exception and 2 if the output directory already exists</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.extract.extract_file_based_on_header_info">
<span class="sig-prename descclassname"><span class="pre">apkInspector.extract.</span></span><span class="sig-name descname"><span class="pre">extract_file_based_on_header_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">apk_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_header_info</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">central_directory_info</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.extract.extract_file_based_on_header_info" title="Link to this definition"></a></dt>
<dd><p>Extracts a single file from the apk_file based on the information provided from the offset and the header_info.
It takes into account that the compression method provided might not be STORED or DEFLATED! The returned
‘indicator’, shows what compression method was used. Besides the standard STORED/DEFLATE it may return
‘DEFLATED_TAMPERED’, which means that the compression method found was not DEFLATED(8) but it should have been,
and ‘STORED_TAMPERED’ which means that the compression method found was not STORED(0) but should have been.</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>apk_file</strong> (<em>bytesIO</em>) – The APK file e.g. with open(‘test.apk’, ‘rb’) as apk_file</p></li>
<li><p><strong>local_header_info</strong> (<em>dict</em>) – The local header dictionary info for that specific filename</p></li>
<li><p><strong>central_directory_info</strong> (<em>dict</em>) – The central directory entry for that specific filename</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns the actual extracted data for that file along with an indication of whether a static analysis evasion technique was used or not.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>set(bytes, str)</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="axml.html" class="btn btn-neutral float-left" title="AXML Module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="indicators.html" class="btn btn-neutral float-right" title="Indicators 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>
|
