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
|
<!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>Headers 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="AXML Module" href="axml.html" />
<link rel="prev" title="Welcome to apkInspector’s documentation!" href="index.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 current"><a class="current reference internal" href="#">Headers Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.headers.CentralDirectory"><code class="docutils literal notranslate"><span class="pre">CentralDirectory</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.CentralDirectory.from_dict"><code class="docutils literal notranslate"><span class="pre">CentralDirectory.from_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.CentralDirectory.parse"><code class="docutils literal notranslate"><span class="pre">CentralDirectory.parse()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.CentralDirectory.to_dict"><code class="docutils literal notranslate"><span class="pre">CentralDirectory.to_dict()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.headers.CentralDirectoryEntry"><code class="docutils literal notranslate"><span class="pre">CentralDirectoryEntry</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.CentralDirectoryEntry.from_dict"><code class="docutils literal notranslate"><span class="pre">CentralDirectoryEntry.from_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.CentralDirectoryEntry.to_dict"><code class="docutils literal notranslate"><span class="pre">CentralDirectoryEntry.to_dict()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord"><code class="docutils literal notranslate"><span class="pre">EndOfCentralDirectoryRecord</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord.from_dict"><code class="docutils literal notranslate"><span class="pre">EndOfCentralDirectoryRecord.from_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord.parse"><code class="docutils literal notranslate"><span class="pre">EndOfCentralDirectoryRecord.parse()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord.to_dict"><code class="docutils literal notranslate"><span class="pre">EndOfCentralDirectoryRecord.to_dict()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.headers.LocalHeaderRecord"><code class="docutils literal notranslate"><span class="pre">LocalHeaderRecord</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.LocalHeaderRecord.from_dict"><code class="docutils literal notranslate"><span class="pre">LocalHeaderRecord.from_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.LocalHeaderRecord.parse"><code class="docutils literal notranslate"><span class="pre">LocalHeaderRecord.parse()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.LocalHeaderRecord.to_dict"><code class="docutils literal notranslate"><span class="pre">LocalHeaderRecord.to_dict()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.headers.ZipEntry"><code class="docutils literal notranslate"><span class="pre">ZipEntry</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.ZipEntry.extract_all"><code class="docutils literal notranslate"><span class="pre">ZipEntry.extract_all()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.ZipEntry.get_central_directory_entry_dict"><code class="docutils literal notranslate"><span class="pre">ZipEntry.get_central_directory_entry_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.ZipEntry.get_local_header_dict"><code class="docutils literal notranslate"><span class="pre">ZipEntry.get_local_header_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.ZipEntry.infolist"><code class="docutils literal notranslate"><span class="pre">ZipEntry.infolist()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.ZipEntry.namelist"><code class="docutils literal notranslate"><span class="pre">ZipEntry.namelist()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.ZipEntry.parse"><code class="docutils literal notranslate"><span class="pre">ZipEntry.parse()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.ZipEntry.parse_single"><code class="docutils literal notranslate"><span class="pre">ZipEntry.parse_single()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.ZipEntry.read"><code class="docutils literal notranslate"><span class="pre">ZipEntry.read()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apkInspector.headers.ZipEntry.to_dict"><code class="docutils literal notranslate"><span class="pre">ZipEntry.to_dict()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.headers.print_headers_of_filename"><code class="docutils literal notranslate"><span class="pre">print_headers_of_filename()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#apkInspector.headers.show_and_save_info_of_headers"><code class="docutils literal notranslate"><span class="pre">show_and_save_info_of_headers()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="axml.html">AXML Module</a></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">Headers Module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/headers.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.headers">
<span id="headers-module"></span><h1>Headers Module<a class="headerlink" href="#module-apkInspector.headers" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.headers.CentralDirectory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.headers.</span></span><span class="sig-name descname"><span class="pre">CentralDirectory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entries</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.CentralDirectory" title="Link to this definition"></a></dt>
<dd><p>The CentralDirectory containing all the CentralDirectoryEntry entries discovered.
The entries are listed as a dictionary where the filename is the key.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.CentralDirectory.from_dict">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entry_dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.CentralDirectory.from_dict" title="Link to this definition"></a></dt>
<dd><p>Convert a dictionary back to an instance of the class.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>entry_dict</strong> (<em>dict</em>) – the dictionary</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the instance of the class</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.headers.CentralDirectory" title="apkInspector.headers.CentralDirectory">CentralDirectory</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.CentralDirectory.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">apk_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eocd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord" title="apkInspector.headers.EndOfCentralDirectoryRecord"><span class="pre">EndOfCentralDirectoryRecord</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.CentralDirectory.parse" title="Link to this definition"></a></dt>
<dd><p>Method that is used to parse the central directory header according to the specification
<a class="reference external" href="https://pkware.cachefly.net/webdocs/APPNOTE/APPNOTE-6.3.9.TXT">https://pkware.cachefly.net/webdocs/APPNOTE/APPNOTE-6.3.9.TXT</a>
based on the offset provided by the end of central directory record: eocd.offset_of_start_of_central_directory.</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 already read/loaded data of the APK file e.g. with open(‘test.apk’, ‘rb’) as apk_file</p></li>
<li><p><strong>eocd</strong> (<a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord" title="apkInspector.headers.EndOfCentralDirectoryRecord"><em>EndOfCentralDirectoryRecord</em></a>) – End of central directory record</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns a dictionary with all the entries discovered. The filename of each entry is used as the key. Besides the fields defined by the specification, each entry has an additional field named ‘Offset in the central directory header’, which includes the offset of the entry in the central directory 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.headers.CentralDirectory" title="apkInspector.headers.CentralDirectory">CentralDirectory</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.CentralDirectory.to_dict">
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.CentralDirectory.to_dict" title="Link to this definition"></a></dt>
<dd><p>Represent the class as a dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>returns the dictionary</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.headers.CentralDirectoryEntry">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.headers.</span></span><span class="sig-name descname"><span class="pre">CentralDirectoryEntry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version_made_by</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version_needed_to_extract</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">general_purpose_bit_flag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression_method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_last_modification_time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_last_modification_date</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">crc32_of_uncompressed_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compressed_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uncompressed_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_field_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_comment_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_number_where_file_starts</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">internal_file_attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">external_file_attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">relative_offset_of_local_file_header</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_comment</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset_in_central_directory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.CentralDirectoryEntry" title="Link to this definition"></a></dt>
<dd><p>A class representing each entry in the central directory.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.CentralDirectoryEntry.from_dict">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entry_dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.CentralDirectoryEntry.from_dict" title="Link to this definition"></a></dt>
<dd><p>Convert a dictionary back to an instance of the class.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>entry_dict</strong> (<em>dict</em>) – the dictionary</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the instance of the class</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.headers.CentralDirectoryEntry" title="apkInspector.headers.CentralDirectoryEntry">CentralDirectoryEntry</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.CentralDirectoryEntry.to_dict">
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.CentralDirectoryEntry.to_dict" title="Link to this definition"></a></dt>
<dd><p>Represent the class as a dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>returns the dictionary</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.headers.EndOfCentralDirectoryRecord">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.headers.</span></span><span class="sig-name descname"><span class="pre">EndOfCentralDirectoryRecord</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signature</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">number_of_this_disk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disk_where_central_directory_starts</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">number_of_central_directory_records_on_this_disk</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">total_number_of_central_directory_records</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size_of_central_directory</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset_of_start_of_central_directory</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.EndOfCentralDirectoryRecord" title="Link to this definition"></a></dt>
<dd><p>A class to provide details about the end of central directory record.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.EndOfCentralDirectoryRecord.from_dict">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entry_dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.EndOfCentralDirectoryRecord.from_dict" title="Link to this definition"></a></dt>
<dd><p>Convert a dictionary back to an instance of the class.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>entry_dict</strong> (<em>dict</em>) – the dictionary</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the instance of the class</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord" title="apkInspector.headers.EndOfCentralDirectoryRecord">EndOfCentralDirectoryRecord</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.EndOfCentralDirectoryRecord.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">apk_file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.EndOfCentralDirectoryRecord.parse" title="Link to this definition"></a></dt>
<dd><p>Method to locate the “end of central directory record signature” as the first step of the correct process of
reading a ZIP archive. Should be noted that certain APKs do not follow the zip specification and declare multiple
“end of central directory records”. For this reason the search for the corresponding signature of the eocd starts
from the end of the apk.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>apk_file</strong> (<em>bytesIO</em>) – The already read/loaded data of the APK file e.g. with open(‘test.apk’, ‘rb’) as apk_file</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns the end of central directory record with all the information available if the corresponding signature is found. If not, then it returns None.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord" title="apkInspector.headers.EndOfCentralDirectoryRecord">EndOfCentralDirectoryRecord</a> or None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.EndOfCentralDirectoryRecord.to_dict">
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.EndOfCentralDirectoryRecord.to_dict" title="Link to this definition"></a></dt>
<dd><p>Represent the class as a dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>returns the dictionary</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.headers.LocalHeaderRecord">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.headers.</span></span><span class="sig-name descname"><span class="pre">LocalHeaderRecord</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version_needed_to_extract</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">general_purpose_bit_flag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression_method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_last_modification_time</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_last_modification_date</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">crc32_of_uncompressed_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compressed_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uncompressed_size</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_field_length</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_field</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.LocalHeaderRecord" title="Link to this definition"></a></dt>
<dd><p>The local header for each entry discovered.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.LocalHeaderRecord.from_dict">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entry_dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.LocalHeaderRecord.from_dict" title="Link to this definition"></a></dt>
<dd><p>Convert a dictionary back to an instance of the class.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>entry_dict</strong> (<em>dict</em>) – the dictionary</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the instance of the class</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.headers.LocalHeaderRecord" title="apkInspector.headers.LocalHeaderRecord">LocalHeaderRecord</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.LocalHeaderRecord.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">apk_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entry_of_interest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.headers.CentralDirectoryEntry" title="apkInspector.headers.CentralDirectoryEntry"><span class="pre">CentralDirectoryEntry</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.LocalHeaderRecord.parse" title="Link to this definition"></a></dt>
<dd><p>Method that attempts to read the local file header according to the specification <a class="reference external" href="https://pkware.cachefly.net/webdocs/APPNOTE/APPNOTE-6.3.9.TXT">https://pkware.cachefly.net/webdocs/APPNOTE/APPNOTE-6.3.9.TXT</a>.</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 already read/loaded data of the APK file e.g. with open(‘test.apk’, ‘rb’) as apk_file</p></li>
<li><p><strong>entry_of_interest</strong> (<a class="reference internal" href="#apkInspector.headers.CentralDirectoryEntry" title="apkInspector.headers.CentralDirectoryEntry"><em>CentralDirectoryEntry</em></a>) – The central directory header of the specific entry of interest</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns a dictionary with the local header information or None if it failed to find the header.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.headers.LocalHeaderRecord" title="apkInspector.headers.LocalHeaderRecord">LocalHeaderRecord</a> or None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.LocalHeaderRecord.to_dict">
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.LocalHeaderRecord.to_dict" title="Link to this definition"></a></dt>
<dd><p>Represent the class as a dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>returns the dictionary</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apkInspector.headers.</span></span><span class="sig-name descname"><span class="pre">ZipEntry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">zip_bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eocd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord" title="apkInspector.headers.EndOfCentralDirectoryRecord"><span class="pre">EndOfCentralDirectoryRecord</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">central_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.headers.CentralDirectory" title="apkInspector.headers.CentralDirectory"><span class="pre">CentralDirectory</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_headers</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#apkInspector.headers.LocalHeaderRecord" title="apkInspector.headers.LocalHeaderRecord"><span class="pre">LocalHeaderRecord</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.ZipEntry" title="Link to this definition"></a></dt>
<dd><p>Is the actual APK represented as a composition of the previous classes, which are: the EndOfCentralDirectoryRecord, the CentralDirectory and a dictionary of values of LocalHeaderRecord.</p>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry.extract_all">
<span class="sig-name descname"><span class="pre">extract_all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">extract_path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">apk_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.ZipEntry.extract_all" title="Link to this definition"></a></dt>
<dd><p>Extracts all the contents of the 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>extract_path</strong> (<em>str</em>) – where to extract it</p></li>
<li><p><strong>apk_name</strong> (<em>str</em>) – the name of the apk</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry.get_central_directory_entry_dict">
<span class="sig-name descname"><span class="pre">get_central_directory_entry_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.ZipEntry.get_central_directory_entry_dict" title="Link to this definition"></a></dt>
<dd><p>Method to retrieve the central directory entry for a specific filename.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filename</strong> (<em>str</em>) – the filename of the file to search for in the central directory</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns a dictionary of the central directory entry or None if the filename is not found</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 method">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry.get_local_header_dict">
<span class="sig-name descname"><span class="pre">get_local_header_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.ZipEntry.get_local_header_dict" title="Link to this definition"></a></dt>
<dd><p>Method to retrieve the local header of a specific filename.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>filename</strong> (<em>str</em>) – the filename of the entry to search for among the local headers</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns a ditionary of the local header entry or None if the filename is not found</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 method">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry.infolist">
<span class="sig-name descname"><span class="pre">infolist</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#apkInspector.headers.CentralDirectoryEntry" title="apkInspector.headers.CentralDirectoryEntry"><span class="pre">CentralDirectoryEntry</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#apkInspector.headers.ZipEntry.infolist" title="Link to this definition"></a></dt>
<dd><p>List of information about the entries in the central directory.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>returns a dictionary where the keys are the filenames and the values are each an instance of the CentralDirectoryEntry</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry.namelist">
<span class="sig-name descname"><span class="pre">namelist</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.ZipEntry.namelist" title="Link to this definition"></a></dt>
<dd><p>List of the filenames included in the central directory.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>returns the list of the filenames</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry.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">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">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.ZipEntry.parse" title="Link to this definition"></a></dt>
<dd><p>Method to start processing an APK. The raw (bytes) APK may be passed or the path to it.</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><em> or </em><em>bytesIO</em>) – the incoming apk, either path or bytes</p></li>
<li><p><strong>raw</strong> (<em>bool</em>) – boolean flag to specify whether it is the raw apk in bytes or not</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns the instance of the class</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.headers.ZipEntry" title="apkInspector.headers.ZipEntry">ZipEntry</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry.parse_single">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_single</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">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eocd</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord" title="apkInspector.headers.EndOfCentralDirectoryRecord"><span class="pre">EndOfCentralDirectoryRecord</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">central_directory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apkInspector.headers.CentralDirectory" title="apkInspector.headers.CentralDirectory"><span class="pre">CentralDirectory</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.ZipEntry.parse_single" title="Link to this definition"></a></dt>
<dd><p>Similar to parse, but instead of parsing the entire APK, it only targets the specified file.</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 expected raw</p></li>
<li><p><strong>filename</strong> (<em>str</em>) – the filename of the file to be parsed</p></li>
<li><p><strong>eocd</strong> (<a class="reference internal" href="#apkInspector.headers.EndOfCentralDirectoryRecord" title="apkInspector.headers.EndOfCentralDirectoryRecord"><em>EndOfCentralDirectoryRecord</em></a><em>(</em><em>, </em><em>optional</em><em>)</em>) – Optionally, the instance of the end of central directory from the APK</p></li>
<li><p><strong>central_directory</strong> (<a class="reference internal" href="#apkInspector.headers.CentralDirectory" title="apkInspector.headers.CentralDirectory"><em>CentralDirectory</em></a><em>(</em><em>, </em><em>optional</em><em>)</em>) – Optionally, the instance of the central directory record</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns the instance of the class</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#apkInspector.headers.ZipEntry" title="apkInspector.headers.ZipEntry">ZipEntry</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry.read">
<span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">save</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><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.ZipEntry.read" title="Link to this definition"></a></dt>
<dd><p>Method to utilize the extract module and extract a single entry from the APK based on the filename.</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>name</strong> (<em>str</em>) – the name of the file to be read/extracted</p></li>
<li><p><strong>save</strong> (<em>bool</em><em>(</em><em>, </em><em>optional</em><em>)</em>) – boolean to define whether the extracted file should be saved as well or not</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>returns the raw bytes of the filename that was extracted</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bytes</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apkInspector.headers.ZipEntry.to_dict">
<span class="sig-name descname"><span class="pre">to_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.ZipEntry.to_dict" title="Link to this definition"></a></dt>
<dd><p>Represent the class as a dictionary.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>returns the dictionary</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.headers.print_headers_of_filename">
<span class="sig-prename descclassname"><span class="pre">apkInspector.headers.</span></span><span class="sig-name descname"><span class="pre">print_headers_of_filename</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cd_h_of_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_header_of_file</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.print_headers_of_filename" title="Link to this definition"></a></dt>
<dd><p>Prints out the details for both the central directory header and the local file header. Useful for the CLI.</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>cd_h_of_file</strong> (<em>dict</em>) – central directory header of a filename as it may be retrieved from headers_of_filename</p></li>
<li><p><strong>local_header_of_file</strong> (<em>dict</em>) – local header dictionary of a filename as it may be retrieved from headers_of_filename</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apkInspector.headers.show_and_save_info_of_headers">
<span class="sig-prename descclassname"><span class="pre">apkInspector.headers.</span></span><span class="sig-name descname"><span class="pre">show_and_save_info_of_headers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entries</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">apk_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apkInspector.headers.show_and_save_info_of_headers" title="Link to this definition"></a></dt>
<dd><p>Print information for each entry for the central directory header and allow to possibly export to JSON.</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>entries</strong> (<em>dict</em>) – The dictionary with all the entries for the central directory</p></li>
<li><p><strong>apk_name</strong> (<em>str</em>) – String with the name of the APK, so it can be used for the export.</p></li>
<li><p><strong>header_type</strong> (<em>str</em>) – What type of header that is, either central_directory or local, to be used for the export</p></li>
<li><p><strong>export</strong> (<em>bool</em>) – Boolean for exporting or not to JSON</p></li>
<li><p><strong>show</strong> (<em>bool</em>) – Boolean for printing or not the entries</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Welcome to apkInspector’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="axml.html" class="btn btn-neutral float-right" title="AXML 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>
|