Obfuscapk

## ❱ Demonstração

![Demonstração](https://assets.kitploit.com/production/public/readmes/3132/632e285a29e53c28a5549c70012673a2761ca3ca4fd7eac3ad89be3d6a9a2a21.gif)



## ❱ Arquitetura

![Arquitetura](https://assets.kitploit.com/production/public/readmes/3132/da41bec35f1c09df38ad201aa1e74f0b1426dba0201162a70b4d5376b3da654e.png)

O Obfuscapk foi projetado para ser modular e fácil de estender, por isso é construído usando um
[sistema de plugins](https://github.com/tibonihoo/yapsy). Consequentemente, cada ofuscador é
um plugin que herda de uma
[classe base](https://github.com/ClaudiuGeorgiu/Obfuscapk/blob/master/src/obfuscapk/obfuscator_category.py)
abstrata e precisa implementar o método `obfuscate`. Quando a ferramenta começa a processar um novo
arquivo de aplicação Android, ela cria um
[objeto de ofuscação](https://github.com/ClaudiuGeorgiu/Obfuscapk/blob/master/src/obfuscapk/obfuscation.py)
para armazenar todas as informações necessárias (por exemplo, a localização do código `smali` descompilado)
e o estado interno das operações (por exemplo, a lista de ofuscadores já utilizados).
Em seguida, o objeto de ofuscação é passado, como parâmetro para o método `obfuscate`, para todos
os plugins/ofuscadores ativos (em sequência) para ser processado e modificado. A lista e
a ordem dos plugins ativos é especificada através de [opções de linha de comando](#-usage).

A ferramenta é facilmente extensível com novos ofuscadores: basta adicionar o código
fonte implementando a técnica de ofuscação e os metadados do plugin (um
arquivo `<obfuscator-name>.obfuscator`) no
diretório
[`src/obfuscapk/obfuscators`](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators)
(pegue um ofuscador simples existente como
[`Nop`](https://github.com/ClaudiuGeorgiu/Obfuscapk/blob/master/src/obfuscapk/obfuscators/nop/nop.py)
como exemplo inicial). A ferramenta detectará automaticamente o novo plugin, portanto,
nenhuma configuração adicional é necessária (o novo plugin será tratado como todos os outros
plugins fornecidos com a ferramenta).



## ❱ Instalação

Existem duas maneiras de obter uma cópia funcional do Obfuscapk no seu computador: ou
[usando Docker](#docker-image) ou [usando diretamente o código fonte](#from-source)
em um ambiente `Python 3`. Em ambos os casos, a primeira coisa a fazer é obter uma cópia
local deste repositório, então abra um terminal no diretório onde deseja salvar
o projeto e clone o repositório:```Shell
$ git clone https://github.com/ClaudiuGeorgiu/Obfuscapk.git

#### Imagem oficial do Docker Hub

A [imagem oficial do Docker Obfuscapk](https://hub.docker.com/r/claudiugeorgiu/obfuscapk) está disponível no Docker Hub (construída automaticamente a partir deste repositório):```Shell
$ # Download the Docker image.
$ docker pull claudiugeorgiu/obfuscapk
$ # Give it a shorter name.
$ docker tag claudiugeorgiu/obfuscapk obfuscapk

Quando a imagem Docker estiver pronta, faça um teste rápido para verificar se tudo foi instalado corretamente:```Shell
$ docker run --rm -it obfuscapk --help
usage: python3 -m obfuscapk.cli [-h] -o OBFUSCATOR [-w DIR] [-d OUT_APK_OR_AAB]
...

```Shell
$ apksigner
Usage:  apksigner <command> [options]
        apksigner --version
        apksigner --help
...

$ zipalign
Zip alignment utility
Copyright (C) 2009 The Android Open Source Project
...

pip install -r requirements.txt
``````Shell
$ # Make sure to run the commands in Obfuscapk/ directory.

$ # The usage of a virtual environment is highly recommended.
$ python3 -m venv venv
$ source venv/bin/activate

$ # Install Obfuscapk's requirements.
$ python3 -m pip install -r src/requirements.txt

O Obfuscapk já está pronto para ser utilizado, consulte as [instruções de uso](#-usage) para mais informações.



## ❱ Uso

De agora em diante, o Obfuscapk será considerado como um executável disponível como `obfuscapk`,
então você precisa adaptar os comandos de acordo com como instalou a ferramenta:

* **Imagem Docker**: um diretório local contendo o aplicativo a ser ofuscado deve ser
montado em `/workdir` no contêiner (por exemplo, o diretório atual `"${PWD}"`), então o
comando:
    ```Shell
    $ obfuscapk [params...]
    ```
    torna-se:
    ```Shell
    $ docker run --rm -it -u $(id -u):$(id -g) -v "${PWD}":"/workdir" obfuscapk [params...]
    ```

* **A partir do código fonte**: todas as instruções devem ser executadas a partir do diretório `Obfuscapk/src/`
(ou adicionando o diretório `Obfuscapk/src/` à variável de ambiente `PYTHONPATH`)
e o comando:
    ```Shell
    $ obfuscapk [params...]
    ```
    torna-se:
    ```Shell
    $ python3 -m obfuscapk.cli [params...]
    ```

Vamos começar observando a mensagem de ajuda:```Shell
$ obfuscapk --help
obfuscapk [-h] -o OBFUSCATOR [-w DIR] [-d OUT_APK_OR_AAB] [-i] [-p] [-k VT_API_KEY]
          [--keystore-file KEYSTORE_FILE] [--keystore-password KEYSTORE_PASSWORD]
          [--key-alias KEY_ALIAS] [--key-password KEY_PASSWORD] [--use-aapt2]
          <APK_OR_BUNDLE_FILE>

Ao executar o comando acima, é isso que acontece nos bastidores:

* já que nenhum diretório de trabalho foi especificado, um novo diretório de trabalho
(`obfuscation_working_dir`) é criado no mesmo local que `original.apk` (isso pode
ser útil para inspecionar os arquivos `smali`/manifesto/recursos em caso de erros)

* algumas verificações são realizadas para garantir que todos os arquivos/executáveis necessários estejam
disponíveis e prontos para uso

* o processo real de ofuscação começa: os ofuscadores especificados são executados
(em ordem) um a um até que não haja mais ofuscadores ou até que um erro seja encontrado

    - ao executar o primeiro ofuscador, `original.apk` é descompilado com `apktool`
    e os resultados são armazenados no diretório de trabalho

    - como o primeiro ofuscador é `RandomManifest`, as entradas no manifesto Android
    descompilado são reordenadas aleatoriamente (sem quebrar as estruturas `xml`)

    - o ofuscador `Rebuild` simplesmente reconstrói a aplicação (agora com o manifesto
    modificado) usando `apktool`, e como nenhum arquivo de saída foi especificado, o arquivo
    apk resultante é salvo no diretório de trabalho criado anteriormente

    - o ofuscador `NewAlignment` usa a ferramenta `zipalign` para alinhar o arquivo apk resultante
      
    - o ofuscador `NewSignature` assina o novo arquivo apk com um certificado personalizado contido em um
      [keystore incluído no Obfuscapk](https://github.com/ClaudiuGeorgiu/Obfuscapk/blob/master/src/obfuscapk/resources/obfuscation_keystore.jks)
      (embora um keystore diferente possa ser especificado com o parâmetro `--keystore-file`)

* quando todos os ofuscadores foram executados sem erros, o arquivo apk ofuscado
resultante pode ser encontrado em `obfuscation_working_dir/original_obfuscated.apk`, assinado,
alinhado e pronto para ser instalado em um dispositivo/emulador

Como visto no exemplo anterior, os ofuscadores `Rebuild`, `NewAlignment` e `NewSignature` 
são sempre necessários para completar uma operação de ofuscação, para construir o apk ofuscado
final. Eles não são técnicas reais de ofuscação, mas são necessários no processo de
construção, por isso são incluídos na lista de ofuscadores para manter a arquitetura geral
modular.

Não está funcionando como esperado? Veja
[FAQ](https://github.com/ClaudiuGeorgiu/Obfuscapk/blob/master/docs/FAQ.md) e
[solução de problemas](https://github.com/ClaudiuGeorgiu/Obfuscapk/blob/master/docs/TROUBLESHOOTING.md).



## ❱ Ofuscadores

Os ofuscadores incluídos no Obfuscapk podem ser divididos em diferentes categorias,
dependendo das operações que realizam:

* **Trivial**: como o nome sugere, esta categoria inclui operações simples (que
não modificam muito a aplicação original), como assinar o arquivo apk com uma nova
assinatura.

* **Renomear**: operações que alteram os nomes dos identificadores usados (classes, campos,
métodos).

* **Criptografia**: empacotar código/recursos criptografados e descriptografá-los durante a execução
do aplicativo. Quando o Obfuscapk inicia, ele gera automaticamente uma chave secreta aleatória (32
caracteres, usando letras e dígitos ASCII) que será usada para criptografia.

* **Código**: todas as operações que envolvem a modificação do código-fonte descompilado.

* **Recursos**: operações nos arquivos de recursos (como modificar o manifesto).

* **Outro**

Os ofuscadores atualmente incluídos no Obfuscapk são apresentados brevemente abaixo (em
ordem alfabética). Consulte o código-fonte do projeto para mais detalhes.

> [!TIP]
> Nem todos os ofuscadores abaixo correspondem a técnicas reais de ofuscação (ex.,
> `Rebuild`, `NewAlignment`, `NewSignature` e `VirusTotal`), mas são implementados
> como ofuscadores para manter a arquitetura modular e fácil de estender com novas
> funcionalidades.


<details><summary><b>AdvancedReflection</b> [Code]</summary>

> Usa reflexão para invocar APIs perigosas do Android Framework. Para descobrir se um
> método pertence ao Android Framework, o Obfuscapk refere-se ao mapeamento descoberto por
> [Backes et al](https://www.usenix.org/system/files/conference/usenixsecurity16/sec16_paper_backes-android.pdf).  
> [:page_facing_up: Código-fonte do AdvancedReflection](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/advanced_reflection)
</details>


<details><summary><b>ArithmeticBranch</b> [Code]</summary>

> Insere código lixo. Neste caso, o código lixo é composto por computações aritméticas
> e uma instrução de desvio dependendo do resultado dessas computações, criada de
> forma que o desvio nunca seja tomado.  
> [:page_facing_up: Código-fonte do ArithmeticBranch](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/arithmetic_branch)
</details>


<details><summary><b>AssetEncryption</b> [Encryption]</summary>

> Criptografar arquivos de assets.  
> [:page_facing_up: Código-fonte do AssetEncryption](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/asset_encryption)
</details>


<details><summary><b>CallIndirection</b> [Code]</summary>

> Esta técnica modifica o grafo de fluxo de controle sem impactar a semântica do código:
> ela adiciona novos métodos que invocam os originais. Por exemplo, uma invocação ao
> método *m1* será substituída por um novo método wrapper *m2*, que, quando invocado,
> chama o método original *m1*.  
> [:page_facing_up: Código-fonte do CallIndirection](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/call_indirection)
</details>


<details><summary><b>ClassRename</b> [Rename]</summary>

> Alterar o nome do pacote e renomear classes (mesmo no arquivo de manifesto).  
> [:page_facing_up: Código-fonte do ClassRename](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/class_rename)
</details>


<details><summary><b>ConstStringEncryption</b> [Encryption]</summary>

> Criptografar strings constantes no código.  
> [:page_facing_up: Código-fonte do ConstStringEncryption](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/const_string_encryption)
</details>


<details><summary><b>DebugRemoval</b> [Code]</summary>

> Remover informações de depuração.  
> [:page_facing_up: Código-fonte do DebugRemoval](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/debug_removal)
</details>


<details><summary><b>FieldRename</b> [Rename]</summary>

> Renomear campos.  
> [:page_facing_up: Código-fonte do FieldRename](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/field_rename)
</details>


<details><summary><b>Goto</b> [Code]</summary>

> Dado um método, insere uma instrução `goto` apontando para o final do método e
> outra `goto` apontando para a instrução após o primeiro `goto`; modifica o
> grafo de fluxo de controle adicionando dois novos nós.  
> [:page_facing_up: Código-fonte do Goto](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/goto)
</details>


<details><summary><b>LibEncryption</b> [Encryption]</summary>

> Criptografar bibliotecas nativas.  
> [:page_facing_up: Código-fonte do LibEncryption](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/lib_encryption)
</details>


<details><summary><b>MethodOverload</b> [Code]</summary>

> Explora o recurso de sobrecarga da linguagem de programação Java para atribuir o
> mesmo nome a métodos diferentes, mas usando argumentos diferentes. Dado um método
> já existente, esta técnica cria um novo método void com o mesmo nome e argumentos,
> mas também adiciona novos argumentos aleatórios. Então, o corpo do novo método
> é preenchido com instruções aritméticas aleatórias.  
> [:page_facing_up: Código-fonte do MethodOverload](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/method_overload)
</details>


<details><summary><b>MethodRename</b> [Rename]</summary>

> Renomear métodos.  
> [:page_facing_up: Código-fonte do MethodRename](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/method_rename)
</details>


<details><summary><b>NewAlignment</b> [Trivial]</summary>

> Realinhar a aplicação.  
> [:page_facing_up: Código-fonte do NewAlignment](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/new_alignment)
</details>


<details><summary><b>NewSignature</b> [Trivial]</summary>

> Reassinar a aplicação com uma nova assinatura personalizada.  
> [:page_facing_up: Código-fonte do NewSignature](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/new_signature)
</details>


<details><summary><b>Nop</b> [Code]</summary>

> Insere código lixo. Nop, abreviação de *no-operation*, é uma instrução dedicada que não
> faz nada. Esta técnica apenas insere instruções `nop` aleatórias dentro de cada implementação
> de método.  
> [:page_facing_up: Código-fonte do Nop](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/nop)
</details>


<details><summary><b>RandomManifest</b> [Resource]</summary>

> Reordenar aleatoriamente as entradas no arquivo de manifesto.  
> [:page_facing_up: Código-fonte do RandomManifest](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/random_manifest)
</details>


<details><summary><b>Rebuild</b> [Trivial]</summary>

> Reconstruir a aplicação.  
> [:page_facing_up: Código-fonte do Rebuild](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/rebuild)
</details>


<details><summary><b>Reflection</b> [Code]</summary>

> Esta técnica analisa o código existente em busca de invocações de métodos do aplicativo,
> ignorando as chamadas ao framework Android (veja `AdvancedReflection`). Se encontrar
> uma instrução com uma invocação de método adequada (ou seja, sem métodos construtores,
> visibilidade pública, registradores livres suficientes, etc.), tal invocação é redirecionada para
> um método personalizado que invocará o método original usando as APIs de Reflexão.  
> [:page_facing_up: Código-fonte do Reflection](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/reflection)
</details>


<details><summary><b>Reorder</b> [Code]</summary>

> Esta técnica consiste em alterar a ordem dos blocos básicos no código. Quando uma
> instrução de desvio é encontrada, a condição é invertida (ex., *branch if lower than*,
> torna-se *branch if greater or equal than*) e os blocos básicos de destino são reordenados
> de acordo. Além disso, também reorganiza aleatoriamente o código abusando de instruções
> `goto`.  
> [:page_facing_up: Código-fonte do Reorder](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/reorder)
</details>


<details><summary><b>ResStringEncryption</b> [Encryption]</summary>

> Criptografar strings em recursos (apenas aquelas chamadas dentro do código).  
> [:page_facing_up: Código-fonte do ResStringEncryption](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/res_string_encryption)
</details>


<details><summary><b>VirusTotal</b> [Other]</summary>

> Enviar a aplicação original e a ofuscada para o Virus Total. Você deve fornecer
> a chave da API do VT (veja a opção `-k`).  
> [:page_facing_up: Código-fonte do VirusTotal](https://github.com/ClaudiuGeorgiu/Obfuscapk/tree/master/src/obfuscapk/obfuscators/virus_total)
</details>



## ❱ Licença

Você é livre para usar este código sob a
[Licença MIT](https://github.com/ClaudiuGeorgiu/Obfuscapk/blob/master/LICENSE).



## ❱ Créditos

[![Unige](https://assets.kitploit.com/production/public/readmes/placeholders/f0fc86cfe65f76d40e15aaec61704ec8220a56dc89d4be03c46f67cb31b9fa8c.svg)](https://unige.it/en/)
[![Dibris](https://assets.kitploit.com/production/public/readmes/placeholders/f0fc86cfe65f76d40e15aaec61704ec8220a56dc89d4be03c46f67cb31b9fa8c.svg)](https://www.dibris.unige.it/en/)

Este software foi desenvolvido para fins de pesquisa no Laboratório de Segurança de Computadores
([CSecLab](https://csec.it/)), hospedado no DIBRIS, Universidade de Gênova.



## ❱ Equipe

* [Simone Aonzo](https://simoneaonzo.it/) - Assistente de Pesquisa
* [Gabriel Claudiu Georgiu](https://github.com/ClaudiuGeorgiu) - Desenvolvedor Principal
* [Luca Verderame](https://csec.it/people/luca_verderame/) - Pesquisador Pós-Doutorado
* [Alessio Merlo](https://csec.it/people/alessio_merlo/) - Membro do Corpo Docente