Support direct loading from an APK file

To disable APK loading pass -DENABLE_APK_LOADING=NO to CMake.

Author: ytsutano

CMakeLists.txt

@@ -1,6 +1,7 @@
 cmake_minimum_required(VERSION 2.8.11)
 
 project(axmldec C CXX)
+option(ENABLE_APK_LOADING "enable loading from an APK file" ON)
 set(AXMLDEC_VERSION_MAJOR 1)
 set(AXMLDEC_VERSION_MINOR 1)
 set(AXMLDEC_VERSION_PATCH 0)
@@ -38,15 +39,6 @@ add_definitions(
 include_directories("${PROJECT_BINARY_DIR}")
 include_directories("include")
 
-set(BOOST_MIN_VERSION "1.53.0")
-find_package(Boost ${BOOST_MIN_VERSION}
-    COMPONENTS system iostreams program_options locale REQUIRED)
-include_directories(SYSTEM ${Boost_INCLUDE_DIRS})
-add_definitions(
-    -DBOOST_MAJOR_VERSION=${Boost_MAJOR_VERSION}
-    -DBOOST_MINOR_VERSION=${Boost_MINOR_VERSION}
-)
-
 #-------------------------------------------------------------------------------
 # axmldec
 #-------------------------------------------------------------------------------
@@ -57,8 +49,37 @@ add_executable(axmldec
     include/jitana/util/stream_reader.hpp
     lib/jitana/util/axml_parser.cpp
 )
+
+set(BOOST_MIN_VERSION "1.53.0")
+find_package(Boost ${BOOST_MIN_VERSION}
+    COMPONENTS system iostreams program_options locale REQUIRED)
+include_directories(SYSTEM ${Boost_INCLUDE_DIRS})
+add_definitions(
+    -DBOOST_MAJOR_VERSION=${Boost_MAJOR_VERSION}
+    -DBOOST_MINOR_VERSION=${Boost_MINOR_VERSION}
+)
 target_link_libraries(axmldec ${Boost_LIBRARIES})
 
+if(ENABLE_APK_LOADING)
+    find_package(ZLIB REQUIRED)
+    include_directories(${ZLIB_INCLUDE_DIR})
+
+    add_definitions(
+        -DENABLE_APK_LOADING=1
+    )
+    add_library(minizip STATIC
+        ${CMAKE_CURRENT_SOURCE_DIR}/external/minizip/unzip.c
+        ${CMAKE_CURRENT_SOURCE_DIR}/external/minizip/ioapi.c
+    )
+    set_target_properties(minizip PROPERTIES
+        COMPILE_DEFINITIONS "NOUNCRYPT;NOCRYPT")
+    target_link_libraries(minizip ${ZLIB_LIBRARIES})
+    set(MINIZIP_INCLUDE_DIR ${CMAKE_SOURCE_DIR}/external/minizip)
+    set(MINIZIP_LIBRARIES minizip)
+    include_directories(SYSTEM ${MINIZIP_INCLUDE_DIR})
+    target_link_libraries(axmldec ${MINIZIP_LIBRARIES})
+endif()
+
 #-------------------------------------------------------------------------------
 # Install
 #-------------------------------------------------------------------------------
@@ -70,7 +91,7 @@ install(TARGETS axmldec DESTINATION bin)
 #-------------------------------------------------------------------------------
 
 add_custom_target(format
-    find . \\\( -name "*.hpp" -or -name "*.cpp" \\\)
+    find main.cpp include lib \\\( -name "*.hpp" -or -name "*.cpp" \\\)
             -type f -exec clang-format -i {} \\+
     WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 )
@@ -80,7 +101,7 @@ add_custom_target(format
 #-------------------------------------------------------------------------------
 
 add_custom_target(count
-    find . \\\( -name "*.hpp" -or -name -name "*.cpp" \\\)
+    find main.cpp include lib \\\( -name "*.hpp" -or -name -name "*.cpp" \\\)
             -print0 | xargs -0 wc -l
     WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 )
@@ -112,4 +133,4 @@ if(DOXYGEN_FOUND)
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
         COMMENT "Generating API documentation with Doxygen" VERBATIM
     )
-endif(DOXYGEN_FOUND)
+endif()

README.md

@@ -3,9 +3,10 @@ axmldec: Android Binary XML Decoder
 
 ## 1 Overview
 
-[`AndroidManifest.xml`][Android App Manifest] in an [APK file][APK] can be
-binary encoded. This tool accepts either a binary or a text XML file and prints
-the decoded XML to the standard output or a file.
+[`AndroidManifest.xml`][Android App Manifest] in an [APK file][APK] is binary
+encoded. This tool accepts either a binary or a text XML file and prints the
+decoded XML to the standard output or a file. It also allows you to extract the
+decoded `AndroidManifest.xml` directly from an APK file.
 
 ![](doc/overview.png)
 
@@ -45,36 +46,49 @@ Build the tool from the source code (see below).
 
 ## 3 Usage
 
-### 3.1 Retrieving `AndroidManifest.xml` from an APK File
+### 3.1 Decoding `AndroidManifest.xml`
 
-1. Use `unzip` to extract the manifest file from an APK file:
-    ```sh
-    unzip -j com.example.app.apk AndroidManifest.xml
-    ```
+Pass the manifest file (either binary or text) to decodedecode:
+```sh
+axmldec -o output.xml AndroidManifest.xml
+```
 
-2. Pass the manifest file (either binary or text) to decode:
-    ```sh
-    axmldec -o output.xml AndroidManifest.xml
-    ```
+This will write the decoded XML to `output.xml`. You can specify the same
+filename for input and output to decode the file in-place.
+
+### 3.2 Decoding `AndroidManifest.xml` in an APK File
 
-    This will write the decoded XML to `output.xml`. You can specify the same
-    filename for input and output to decode the file in-place.
+If an APK file is specified, axmldec automatically extracts and decodes
+`AndroidManifest.xml`:
+```sh
+axmldec -o output.xml com.example.app.apk
+```
 
-### 3.2 Using the Standard Output
+### 3.3 Using the Standard Output
 
 axmldec writes to the standard output if the `-o` option is not specified. This
 is useful when additional processing is required. For example, you can extract
-the package name using `xmllint`:
+the package name from an APK file using xmllint:
 ```sh
-axmldec AndroidManifest.xml | xmllint --xpath 'string(/manifest/@package)' -
+axmldec com.example.app.apk | xmllint --xpath 'string(/manifest/@package)' -
 ```
 
 ## 4 Building
 
-Install Boost and CMake. Make sure you have a latest C++ compiler. Then compile:
-```sh
-cmake -DCMAKE_BUILD_TYPE=Release . && make
-```
+1. Install Boost, zlib, and CMake. Make sure you have a latest C++ compiler.
+
+2. Clone axmldec and its submodule from GitHub:
+    ```sh
+    git clone --recursive https://github.com/ytsutano/axmldec.git
+    ```
+
+3. Compile axmldec:
+    ```sh
+    cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_APK_LOADING=YES . && make
+    ```
+
+    You can specify `-DENABLE_APK_LOADING=NO` to disable APK loading. In this
+    case, zlib is not required.
 
 ## 5 Developer
 

doc/overview.dot

@@ -1,36 +1,46 @@
 digraph {
     rankdir=LR;
-    ranksep=0.6;
+    ranksep=0.1
+
+    edge [fontsize=10];
+
+    {
+        xml [label="AndroidManifest.xml\n(Binary/Text XML)", shape=none];
+        apk [label="com.example.app.apk", shape=none];
+        rank=same;
+    }
+    decoded_xml [label="output.xml\n(Text XML)", shape=none];
+
+    xml -> apk [style=invis];
 
     subgraph cluster_axmldec {
         {
-
             node [style=filled, color=gray87, shape=none, fontname=Courier, fontsize=12, fontcolor=midnightblue];
+            extract_manifest [label="extract_manifest()", URL="https://github.com/ytsutano/axmldec/blob/master/main.cpp"];
             {
-                read_xml [label="boost_pt::read_xml()", URL="http://www.boost.org/doc/libs/1_64_0/doc/html/boost/property_tree/xml_parser/read_xml_idp683796192.html"];
-                read_axml [label="jitana::read_axml()", URL="https://github.com/ytsutano/axmldec/blob/master/include/jitana/util/axml_parser.hpp"];
+                read_xml [label="boost_pt::\nread_xml()", URL="http://www.boost.org/doc/libs/1_64_0/doc/html/boost/property_tree/xml_parser/read_xml_idp683796192.html"];
+                read_axml [label="jitana::\nread_axml()", URL="https://github.com/ytsutano/axmldec/blob/master/include/jitana/util/axml_parser.hpp"];
                 rank=same;
             }
-            write_xml [label="boost_pt::write_xml()", URL="http://www.boost.org/doc/libs/1_64_0/doc/html/boost/property_tree/xml_parser/write_xml_idp683815200.html"];
+            write_xml [label="boost_pt::\nwrite_xml()", URL="http://www.boost.org/doc/libs/1_64_0/doc/html/boost/property_tree/xml_parser/write_xml_idp683815200.html"];
+            read_axml_xml [shape=point];
         }
-        ptree [label="Boost\nProperty Tree", shape="none", URL="http://www.boost.org/doc/libs/1_64_0/doc/html/property_tree.html"];
+        ptree [label="Boost\nProperty Tree", shape=none, URL="http://www.boost.org/doc/libs/1_64_0/doc/html/property_tree.html"];
 
         read_axml -> ptree;
         read_xml -> ptree;
+        extract_manifest -> read_axml [label="Binary", weight=1000];
         ptree -> write_xml;
 
         style=filled;
         color=gray95;
-        label="axmldec -o output.xml AndroidManifest.xml";
+        label="axmldec -o output.xml AndroidManifest.xml\naxmldec -o output.xml com.example.app.apk\n ";
         fontname=Courier;
         fontcolor=midnightblue
     }
 
-    axml [label="Android\nBinary XML", shape="none"];
-    txml [label="Standard\nText XML", shape="none"];
-    decoded_xml [label="Decoded\nStandard\nText XML", shape="none"];
-
-    axml -> read_axml;
-    txml -> read_xml;
+    xml -> read_axml [xlabel="Binary"];
+    xml -> read_xml [xlabel="Text"];
+    apk -> extract_manifest;
     write_xml -> decoded_xml;
 }

doc/overview.png

@@ -35,6 +35,8 @@ namespace jitana {
 
     void read_axml(const std::string& filename,
                    boost::property_tree::ptree& pt);
+
+    void read_axml(std::istream& stream, boost::property_tree::ptree& pt);
 }
 
 #endif

include/jitana/util/axml_parser.hpp

@@ -1868,3 +1868,15 @@ void jitana::read_axml(const std::string& filename,
     axml_parser p(reader, pt);
     p.parse();
 }
+
+void jitana::read_axml(std::istream& stream, boost::property_tree::ptree& pt)
+{
+    std::vector<uint8_t> buffer;
+    std::for_each(std::istreambuf_iterator<char>(stream),
+                  std::istreambuf_iterator<char>(),
+                  [&buffer](const char c) { buffer.push_back(c); });
+
+    stream_reader reader(buffer.data(), buffer.data() + buffer.size());
+    axml_parser p(reader, pt);
+    p.parse();
+}