Argus-SAF: Framework de análise estática Argus

Este é o repositório oficial do Argus-SAF.

Para testar e brincar com o Argus-SAF, você pode criar um fork do nosso projeto Argus-SAF-playground, que possui a configuração básica para um projeto aprimorado com Argus-SAF com códigos de demonstração de como realizar diferentes tipos de análise.

Estrutura do repositório

Argus-SAF/
+--src/main/scala/org.argus.saf/Main.scala     Main class for argus-saf CLI.
+--jawa         Core static analysis data structures, "*.class"&"*.jawa" file managing, jawa compiler, class hierarchy, method body resolving, flow analysis, etc.
+--amandroid    Android resource parsers, information collector, decompiler, environment method builder, flow analysis, etc.
+--jnsaf        Java native interface analysis.
+--nativedroid  Annotation based analysis using angr symbolic execution engine.

Obtendo Argus-SAF como biblioteca

Dependa do Jawa editando build.sbt:

libraryDependencies += "com.github.arguslab" %% "jawa" % VERSION

Dependa do Amandroid editando build.sbt:

libraryDependencies += "com.github.arguslab" %% "amandroid" % VERSION

Nota: Depender do Amandroid adicionará automaticamente o Jawa como dependência. Se você usa Maven ou Gradle, deve converter para o formato correspondente.

Obtendo a Ferramenta CLI do Argus-SAF

Requisito: Java 10

1. Vá para a pasta binaries.
2. Baixe o argus-saf_***-version-assembly.jar
3. Obtenha o uso através de:

$ java -jar argus-saf_***-version-assembly.jar

Desenvolvendo o Argus-SAF

Para participar do desenvolvimento do Argus-SAF, você precisa:

1. Instalar o seguinte software:

   • IntelliJ IDEA 14 ou superior com versão compatível do plugin Scala

2. Fazer um fork deste repositório e cloná-lo para o seu computador

$ git clone https://github.com/arguslab/Argus-SAF.git

3. Abra o IntelliJ IDEA, selecione File -> New -> Project from existing sources (se a partir da janela inicial: Import Project), aponte para o diretório onde o repositório Argus-SAF está e importe-o como SBT project.

4. Quando a importação terminar, vá para o diretório do repositório Argus-SAF e execute

$ git checkout .idea

para obter artefatos e configurações de execução para o projeto IDEA.

5. [Opcional] Para construir o Argus-SAF de forma mais suave, você deve dar 2GB de tamanho de heap para o processo do compilador.

   • se você usa o Scala Compile Server (padrão): Settings > Languages & Frameworks > Scala Compile Server > JVM maximum heap size

   • se o Scala Compile Server estiver desabilitado: Settings > Build, Execution, Deployment > Compiler > Build process heap size

6. Construa o Argus-SAF a partir da linha de comando: vá para o diretório do repositório Argus-SAF e execute

$ tools/bin/sbt clean compile test

7. Gere o fat jar: vá para o diretório do repositório Argus-SAF e execute

$ tools/bin/sbt assembly

Instalar o JN-Saf com NativeDroid

Instale JN-Saf e NativeDroid:

$ tools/scripts/install.sh

Você pode instalar um ou outro através de:

$ tools/scripts/install.sh jnsaf
$ tools/scripts/install.sh nativedroid

Executar Teste de Benchmark

Após instalar JN-Saf e NativeDroid. Execute:

$ tools/scripts/benchmark_cli.sh droidbench
$ tools/scripts/benchmark_cli.sh iccbench
$ tools/scripts/benchmark_cli.sh nativeflowbench

Lançar o JN-SAF para análise nativa

1. Instale o nativedroid:

$ tools/scripts/install.sh nativedroid

2. Inicie o servidor nativedroid:

$ python nativedroid/nativedroid/server/native_droid_server.py /tmp/binaries nativedroid/nativedroid/data/sourceAndSinks/NativeSourcesAndSinks.txt nativedroid/data/sourceAndSinks/TaintSourcesAndSinks.txt

3. Use o NativeDroidClient.scala para se comunicar com o servidor nativedroid e realizar análise nativa.

Solução de problemas:

1. Se o código python no Intellij mostrar imports não resolvidos, você deve importar manualmente a pasta nativedroid como um módulo python e definir o Python SDK. Recomenda-se usar um virtualenv python para instalar o nativedroid com seus pacotes python necessários.

Construção com Bazel

Integração com Bazel em andamento. Ignore todos os arquivos BUILD por enquanto.

Como contribuir

Para contribuir com o Argus-SAF, por favor nos envie um pull request a partir do seu fork deste repositório!

Para mais informações sobre como construir e desenvolver o Argus-SAF, consulte também nossas diretrizes para contribuição. As pessoas que forneceram ideias excelentes estão listadas em contribuidor.

O que contribuir

Se você não sabe o que contribuir, pode conferir o rastreador de issues com a etiqueta help wanted, e reivindicar uma para se aquecer com o Argus-SAF.