Argus-SAF: Marco de análisis estático Argus

Este es el repositorio oficial de Argus-SAF.

Para probar y jugar con Argus-SAF, puedes bifurcar nuestro proyecto Argus-SAF-playground, que tiene la configuración básica para un proyecto mejorado con Argus-SAF con códigos de demostración de cómo realizar diferentes tipos de análisis.

Estructura del repositorio

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.

Obtener Argus-SAF como biblioteca

Depende de Jawa editando build.sbt:

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

Depende de Amandroid editando build.sbt:

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

Nota: Depender de Amandroid agregará automáticamente Jawa como dependencia. Si usas Maven o Gradle, debes traducirlo al formato correspondiente.

Obtener la herramienta CLI de Argus-SAF

Requisito: Java 10

1. Ve a la carpeta binaries.
2. Descarga argus-saf_***-version-assembly.jar
3. Obtén el uso mediante:

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

Desarrollo de Argus-SAF

Para participar en el desarrollo de Argus-SAF, necesitas:

1. Instalar el siguiente software:

   • IntelliJ IDEA 14 o superior con una versión compatible del plugin de Scala

2. Bifurcar este repositorio y clonarlo en tu computadora

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

3. Abrir IntelliJ IDEA, seleccionar File -> New -> Project from existing sources (si desde la ventana inicial: Import Project), apuntar al directorio donde está el repositorio de Argus-SAF y luego importarlo como SBT project.

4. Cuando la importación finalice, ve al directorio del repositorio de Argus-SAF y ejecuta

$ git checkout .idea

para obtener los artefactos y configuraciones de ejecución para el proyecto IDEA.

5. [Opcional] Para compilar Argus-SAF de manera más fluida, debes asignar 2GB de tamaño de heap al proceso del compilador.

   • si usas Scala Compile Server (por defecto): Settings > Languages & Frameworks > Scala Compile Server > JVM maximum heap size

   • si Scala Compile Server está deshabilitado: Settings > Build, Execution, Deployment > Compiler > Build process heap size

6. Compilar Argus-SAF desde la línea de comandos: ve al directorio del repositorio de Argus-SAF y ejecuta

$ tools/bin/sbt clean compile test

7. Generar fat jar: ve al directorio del repositorio de Argus-SAF y ejecuta

$ tools/bin/sbt assembly

Instalar JN-Saf con NativeDroid

Instalar JN-Saf y NativeDroid:

$ tools/scripts/install.sh

Puedes instalar uno u otro mediante:

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

Ejecutar prueba de BenchMark

Después de instalar JN-Saf y NativeDroid. Ejecuta:

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

Lanzar JN-SAF para análisis nativo

1. Instalar nativedroid:

$ tools/scripts/install.sh nativedroid

2. Iniciar el servidor nativedroid:

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

3. Usar NativeDroidClient.scala para comunicarse con el servidor nativedroid y realizar análisis nativo.

Solución de problemas:

1. Si el código de Python en IntelliJ muestra importaciones sin resolver, debes importar manualmente la carpeta nativedroid como un módulo de Python y configurar el SDK de Python. Se recomienda usar un virtualenv de Python para instalar nativedroid con sus paquetes de Python requeridos.

Compilación con Bazel

Integración con Bazel en progreso. Ignora todos los archivos BUILD por ahora.

Cómo contribuir

Para contribuir a Argus-SAF, por favor envíanos un pull request desde tu bifurcación de este repositorio!

Para más información sobre cómo compilar y desarrollar Argus-SAF, consulta también nuestras directrices para contribuir. Las personas que proporcionaron ideas excelentes están listadas en contributor.

Qué contribuir

Si no sabes qué contribuir, puedes revisar el issue tracker con la etiqueta help wanted, y reclamar uno para ayudarte a calentar con Argus-SAF.