binaryninja api

API Ninja binaire

Ce référentiel contient la documentation et le code source des API C++, Python et Rust pour la plateforme d'ingénierie inverse Binary Ninja.

Documentation

Une documentation en ligne est disponible pour les API suivantes :

• API C++, branche stable
• API Python, branche stable
• API Python, branche de développement
• API Rust, branche stable
• API Rust, branche de développement

Instructions d'utilisation et de construction

Afin de créer l'API Binary Ninja, vous devrez utiliser la révision spécifique qui correspond au hachage du fichier api_REVISION.txt . Ce fichier doit se trouver dans le dossier d'installation racine pour Linux et Windows ou dans le sous-dossier Contents/Resources de l'application sur macOS. Le moyen le plus simple de procéder est de cloner ce référentiel (ou de l'ajouter en tant que sous-module) et de faire quelque chose comme git checkout $(cat api_REVISION.txt | awk -F/ '{print $NF}') . La documentation expliquant comment configurer cela avec quelque chose comme cmake peut être trouvée ici.

Pour écrire des plugins Binary Ninja en utilisant C++, vous devrez créer l'API C++. La construction de la bibliothèque API se fait de la même manière que la plupart des projets basés sur CMake ; les étapes de base sont décrites comme suit :

 # Get the source
git clone https://github.com/Vector35/binaryninja-api.git
cd binaryninja-api
git submodule update --init --recursive

# Configure an out-of-source build setup
cmake -S . -B build # (additional arguments go here if needed)

# Compile
cmake --build build -j8

En plus de la configuration de build par défaut, vous souhaiterez peut-être :

• Construisez des exemples. Pour créer les exemples d'API, transmettez -DBN_API_BUILD_EXAMPLES=ON à CMake lors de la configuration de la build. Une fois la construction réussie, vous pouvez installer les plugins générés en exécutant la cible install . Lorsque vous utilisez le générateur de build "Unix Makefiles", cela ressemble à : make install .
• Créez des plugins d’interface utilisateur. Vous aurez besoin de Qt 6.7.2 (au moment de la rédaction) installé pour créer des plugins d'interface utilisateur.
• Construisez sans tête. Si vous utilisez une distribution Binary Ninja sans tête ou si vous ne souhaitez pas créer de plugins d'interface utilisateur, transmettez -DHEADLESS=ON à CMake lors de la configuration de la version.

Dépannage

• Si Binary Ninja est installé à un emplacement différent de celui par défaut de la plate-forme (défini dans CMakeLists.txt), vous obtiendrez probablement une erreur indiquant « Binary Ninja Core Not Found ». Spécifiez le chemin d'accès à votre installation Binary Ninja en passant -DBN_INSTALL_DIR=/path/to/binaryninja à CMake lors de la configuration de la configuration de build.
• Étant donné que Binary Ninja est un produit 64 bits uniquement, assurez-vous que vous utilisez un environnement de compilation et de liaison 64 bits. Des erreurs sous Windows comme LNK1107 peuvent indiquer que vos bits ne correspondent pas.

Exemples

Il existe de nombreux exemples disponibles. Le dossier d'exemples Python présente de nombreuses applications différentes de l'API Python, tandis que les exemples C++ incluent :

• background_task est un plugin qui démontre la gestion d'une tâche en arrière-plan.*
• bin-info est un exécutable autonome qui imprime des informations sur un binaire donné sur le terminal.*
• breakpoint est un plugin qui vous permet de sélectionner une région dans un binaire x86 et d'utiliser le menu contextuel pour la remplir d'octets de point d'arrêt.
• disassm en ligne de commande montre comment vider le démontage sur la ligne de commande.*
• llil-parser analyse l'IL de bas niveau, démontrant comment faire correspondre les types et utiliser une classe de visiteur.*
• mlil-parser analyse l'IL de niveau moyen, démontrant comment faire correspondre les types et utiliser une classe de visiteur.*
• print_syscalls est un exécutable autonome qui imprime les appels système utilisés dans un binaire donné.*
• triage est un plugin complet fourni et activé par défaut, démontrant comment effectuer une grande variété de tâches, notamment l'extension de l'interface utilisateur via QT.
• workflows est une collection de plugins qui démontrent l'utilisation de Workflows pour étendre le pipeline d'analyse.
• L'extension x86 crée une extension d'architecture qui montre comment modifier le comportement des architectures intégrées sans créer de remplacement complet.

* Nécessite une licence prenant en charge l'accès API sans tête.

Problèmes

Le système de suivi des problèmes de ce référentiel suit non seulement les problèmes liés au code source contenu ici, mais également au produit Binary Ninja plus large.

Succursales

Ce référentiel comporte deux branches principales dev et master .

La branche dev dispose des dernières mises à jour et suit la dernière version de développement de Binary Ninja ; des demandes d'extraction doivent être effectuées sur cette branche. La branche master suit la version stable de Binary Ninja. Si vous venez d'installer Binary Ninja pour la première fois, vous êtes probablement sur la version stable.

Contribuer

Les contributions publiques sont les bienvenues dans ce référentiel. La plupart de l'API et de la documentation de ce référentiel sont sous licence MIT, cependant, l'API s'interface avec une application commerciale fermée, Binary Ninja. De plus, l'API Rust est sous licence Apache 2.0.

Si vous souhaitez contribuer lorsque vous soumettez votre premier PR, vous recevrez un avis de CLA Assistant qui vous permettra de signer notre accord de licence de contribution en ligne.

Plateformes

Ce référentiel contient tous nos plugins Platform disponibles ici :

• Fenêtres
• Linux
• macOS
• GratuitBSD
• Décret
• EFI

Architectures

Ce référentiel contient tous les plugins d'architecture disponibles dans les éditions personnelles et commerciales de Binary Ninja. Vous pouvez trouver chaque architecture ici :

• x86/x86_64
• ARM64
• ARMv7
• PPC
• MIPS
• RISC-V
• MSP430

Types de vue binaire

Ce référentiel contient tous nos plugins Binary View Type disponibles ici :

• Mach-O
• ELFE
• PE/CAF/TE
• MD1Rom

Informations de débogage

• Importation NAIN
• Importation PDB
• Importation de la BID

Dépôts associés

En plus du fait que ce référentiel d'API principal est open source, Vector35 propose également le débogueur et les plugins Objective-C open source :

• Débogueur
• workflow_objc

Licence

Certains composants peuvent être publiés sous des licences open source compatibles mais légèrement différentes et auront leur propre fichier LICENSE, le cas échéant.

Les composants restants sont publiés sous licence MIT.

Notez que les fichiers .lib sont inclus dans les versions binaires natives de Binary Ninja pour Windows. Ces fichiers lib sont également publiés sous la même licence que ce référentiel et peuvent être distribués en conséquence.