Argus-SAF : Framework d'analyse statique Argus

Ceci est le dépôt officiel pour Argus-SAF.

Pour tester et jouer avec Argus-SAF, vous pouvez forker notre projet Argus-SAF-playground, qui contient la configuration de base pour un projet amélioré avec Argus-SAF et des codes de démonstration pour effectuer différents types d'analyses.

Structure du dépôt

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.

Obtenir Argus-SAF en tant que bibliothèque

Dépendre de Jawa en modifiant build.sbt :

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

Dépendre de Amandroid en modifiant build.sbt :

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

Notez que : Dépendre de Amandroid ajoutera automatiquement Jawa comme dépendance. Si vous utilisez Maven ou Gradle, vous devez le traduire dans le format correspondant.

Obtenir l'outil CLI Argus-SAF

Prérequis : Java 10

1. Allez dans le dossier binaries.
2. Téléchargez argus-saf_***-version-assembly.jar
3. Obtenez l'utilisation par :

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

Développer Argus-SAF

Pour participer au développement d'Argus-SAF, vous devez :

1. Installer les logiciels suivants :

   • IntelliJ IDEA 14 ou version ultérieure avec une version compatible du plugin Scala

2. Forker ce dépôt et le cloner sur votre ordinateur

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

3. Ouvrez IntelliJ IDEA, sélectionnez File -> New -> Project from existing sources (si depuis la fenêtre initiale : Import Project), pointez vers le répertoire où se trouve le dépôt Argus-SAF, puis importez-le en tant que SBT project.

4. Une fois l'importation terminée, allez dans le répertoire du dépôt Argus-SAF et exécutez

$ git checkout .idea

afin d'obtenir les artefacts et les configurations d'exécution pour le projet IDEA.

5. [Optionnel] Pour construire Argus-SAF plus facilement, vous devriez allouer 2 Go de taille de tas au processus du compilateur.

   • si vous utilisez le serveur de compilation Scala (par défaut) : Settings > Languages & Frameworks > Scala Compile Server > JVM maximum heap size

   • si le serveur de compilation Scala est désactivé : Settings > Build, Execution, Deployment > Compiler > Build process heap size

6. Construisez Argus-SAF en ligne de commande : allez dans le répertoire du dépôt Argus-SAF et exécutez

$ tools/bin/sbt clean compile test

7. Générez le fat jar : allez dans le répertoire du dépôt Argus-SAF et exécutez

$ tools/bin/sbt assembly

Installer JN-Saf avec NativeDroid

Installez JN-Saf et NativeDroid :

$ tools/scripts/install.sh

Vous pouvez installer l'un ou l'autre par :

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

Exécuter le test de benchmark

Après avoir installé JN-Saf et NativeDroid, exécutez :

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

Lancer JN-SAF pour l'analyse native

1. Installez nativedroid :

$ tools/scripts/install.sh nativedroid

2. Démarrez le serveur nativedroid :

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

3. Utilisez NativeDroidClient.scala pour communiquer avec le serveur nativedroid et effectuer une analyse native.

Dépannage :

1. Si du code Python dans IntelliJ montre des imports non résolus, vous devez importer manuellement le dossier nativedroid en tant que module Python et définir le SDK Python. Il est recommandé d'utiliser un environnement virtuel Python pour installer nativedroid avec ses paquets Python requis.

Construction avec Bazel

L'intégration de Bazel est en cours. Ignorez tous les fichiers BUILD pour l'instant.

Comment contribuer

Pour contribuer à Argus-SAF, veuillez nous envoyer une pull request depuis votre fork de ce dépôt !

Pour plus d'informations sur la construction et le développement d'Argus-SAF, veuillez également consulter nos directives pour contribuer. Les personnes ayant fourni d'excellentes idées sont listées dans contributeur.

Que contribuer

Si vous ne savez pas quoi contribuer, vous pouvez consulter le suivi des problèmes avec l'étiquette help wanted, et en réclamer un pour vous familiariser avec Argus-SAF.