Reverse engineering and pentesting for Android applications
Go to file
Sebastian Bachmann 2464410198 format
2017-06-14 10:44:41 +02:00
.github Creating a template for issues 2017-06-11 19:42:28 +02:00
androguard really resolve #157 - removed unused code 2017-06-12 11:22:17 +02:00
demos Merge branch 'master' into patch-1 2017-06-07 11:26:09 +02:00
docs change path 2017-06-12 11:30:19 +02:00
examples Delete useless stuff 2015-06-24 12:35:51 +02:00
tests Start analysis refactoring #219 2017-03-17 07:14:25 +01:00
tools format 2017-06-14 10:44:41 +02:00
.gitignore ignore more folders 2017-02-14 09:37:46 +01:00
.landscape.yml add landscape 2015-09-14 16:55:01 +02:00
.readthedocs.yml configure readthedocs seperately 2017-06-12 11:59:18 +02:00
.travis.yml remove py 3.2 as too many libs does not like it, specify mock version 2017-06-10 19:06:38 +02:00
androarsc.py futurize tools 2017-02-08 08:35:35 +00:00
androauto.py futurize tools 2017-02-08 08:35:35 +00:00
androaxml.py futurize tools 2017-02-08 08:35:35 +00:00
androdd.py try to find unicode related errors in androdd 2017-05-23 12:03:16 +02:00
androdis.py futurize tools 2017-02-08 08:35:35 +00:00
androgui.py setup standard install paths for GUI files 2017-03-16 22:18:42 +01:00
androlyze.py futurize tools 2017-02-08 08:35:35 +00:00
LICENCE-2.0 Fix a bug with invoke-super/range 2014-07-06 22:26:02 +02:00
README.md link to documentation 2017-06-12 11:08:48 +02:00
requirements.txt configure readthedocs seperately 2017-06-12 11:59:18 +02:00
setup.py change to RTD theme 2017-06-12 11:26:38 +02:00

Androguard

Build Status Documentation Status

Features

Androguard is a full python tool to play with Android files.

  • DEX, ODEX
  • APK
  • Android's binary xml
  • Android resources
  • Disassemble DEX/ODEX bytecodes
  • Decompiler for DEX/ODEX files

1. Authors: Androguard Team

Androguard + tools: Anthony Desnos (desnos at t0t0.fr).

DAD (DAD is A Decompiler): Geoffroy Gueguen (geoffroy dot gueguen at gmail dot com)

2. Stable release

See the stable release here: https://github.com/androguard/androguard/releases

You can also install androguard from the Debian repositories: androguard.

Note that androguard only works with python >= 2.7 or >= 3.3!

3. Documentation

Find the documentation for master on ReadTheDocs.

There are some (probably broken/outdated) examples and demos in the folders demos and examples.

4. Building and Requirements

Using Debian based Distributions

Assuming you are using Debian, most of the packages are available from standard repos.

For androguard:

apt install python python-pyqt5 python-pyperclip python-networkx ipython python-future python-pyasn1 python-cryptography python-magic python-pydot

You should be able to use python3 as well:

apt install python3 python3-pyqt5 python3-pyperclip python3-networkx ipython3 python3-future python3-pyasn1 python3-cryptography python3-magic python3-pydot

If you are installing the libraries using pip, make sure you download the correct packages. For example, there are a lot of implemenations of the magic library. Get the one, that is shipped with the file command (See Fine Free File Command) or use filemagic, which should work as well.

and for building the documentation (optional):

apt install python-sphinx python-sphinxcontrib.programoutput

or

apt install python3-sphinx python3-sphinxcontrib.programoutput

when using python3.

To install androguard, just use:

python setup.py install

The documentation can be build using:

python setup.py build_sphinx

For running the unit tests, the mock library is required:

apt install python-mock or apt install python3-mock

Using Windows

Using Anaconda with python3, most of the used packages are pre-installed.

Additional packages, that might be required are:

pyperclip sphinxcontrib-programoutput future pydot

You can simply run

python setup.py install

to install androguard.

and

python setup.py build_sphinx

to create the documentation.

5. Licenses

  • Androguard

Copyright (C) 2012 - 2016, Anthony Desnos (desnos at t0t0.fr) All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

  • DAD

Copyright (C) 2012 - 2016, Geoffroy Gueguen (geoffroy dot gueguen at gmail dot com) All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.