binaryninja api

API Ninja Binaria

Este repositorio contiene documentación y código fuente de las API de C++, Python y Rust para la plataforma de ingeniería inversa Binary Ninja.

Documentación

La documentación en línea está disponible para las siguientes API:

• API C++, rama estable
• API de Python, rama estable
• API de Python, rama de desarrollo
• API Rust, rama estable
• API de Rust, rama de desarrollo

Instrucciones de uso y construcción

Para crear la API de Binary Ninja, deberá utilizar la revisión específica que coincida con el hash del archivo api_REVISION.txt . Este archivo debe estar ubicado en la carpeta de instalación raíz para Linux y Windows o en la subcarpeta Contents/Resources de la aplicación en macOS. La forma más sencilla de hacerlo es clonando este repositorio (o agregándolo como un submódulo) y haciendo algo como git checkout $(cat api_REVISION.txt | awk -F/ '{print $NF}') . La documentación sobre cómo configurar esto con algo como cmake se puede encontrar aquí.

Para escribir complementos de Binary Ninja usando C++, necesitarás crear la API de C++. La creación de la biblioteca API se realiza de manera similar a la mayoría de los proyectos basados ​​en CMake; Los pasos básicos se describen a continuación:

 # 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

Además de la configuración de compilación predeterminada, es posible que desees:

• Construir ejemplos. Para compilar los ejemplos de API, pase -DBN_API_BUILD_EXAMPLES=ON a CMake al configurar la compilación. Una vez que la compilación se haya realizado correctamente, puede instalar los complementos integrados ejecutando el destino install . Cuando se utiliza el generador de compilación "Unix Makefiles", esto se ve así: make install .
• Cree complementos de interfaz de usuario. Necesitará Qt 6.7.2 (al momento de escribir este artículo) instalado para crear complementos de interfaz de usuario.
• Construye sin cabeza. Si está utilizando una distribución Binary Ninja sin cabeza o no desea crear complementos de interfaz de usuario, pase -DHEADLESS=ON a CMake al configurar la compilación.

Solución de problemas

• Si Binary Ninja está instalado en una ubicación diferente a la predeterminada de la plataforma (definida en CMakeLists.txt), es probable que reciba un error que indique "Binary Ninja Core Not Found". Especifique la ruta a su instalación de Binary Ninja pasando -DBN_INSTALL_DIR=/path/to/binaryninja a CMake al configurar la configuración de compilación.
• Dado que Binary Ninja es un producto únicamente de 64 bits, asegúrese de utilizar un entorno de compilación y vinculación de 64 bits. Errores en Windows como LNK1107 pueden indicar que sus bits no coinciden.

Ejemplos

Hay muchos ejemplos disponibles. La carpeta de ejemplos de Python muestra muchas aplicaciones diferentes de la API de Python, mientras que los ejemplos de C++ incluyen:

• background_task es un complemento que demuestra cómo administrar una tarea en segundo plano.*
• bin-info es un ejecutable independiente que imprime información sobre un binario determinado en la terminal.*
• breakpoint es un complemento que le permite seleccionar una región dentro de un binario x86 y usar el menú contextual para llenarla con bytes de punto de interrupción.
• disassm de línea de comando demuestra cómo volcar el desensamblado a la línea de comando.*
• llil-parser analiza IL de bajo nivel y demuestra cómo hacer coincidir tipos y utilizar una clase de visitante.*
• mlil-parser analiza IL de nivel medio y demuestra cómo hacer coincidir tipos y utilizar una clase de visitante.*
• print_syscalls es un ejecutable independiente que imprime las llamadas al sistema utilizadas en un binario determinado.*
• triage es un complemento con todas las funciones que se envía y habilita de forma predeterminada y que demuestra cómo realizar una amplia variedad de tareas, incluida la extensión de la interfaz de usuario a través de QT.
• flujos de trabajo es una colección de complementos que demuestran el uso de flujos de trabajo para ampliar el proceso de análisis.
• La extensión x86 crea una extensión de arquitectura que muestra cómo modificar el comportamiento de las arquitecturas integradas sin crear un reemplazo completo.

* Requiere una licencia que admita el acceso API sin cabeza.

Asuntos

El rastreador de problemas para este repositorio rastrea no solo los problemas con el código fuente contenido aquí sino también el producto Binary Ninja más amplio.

Sucursales

Este repositorio tiene dos ramas principales, dev y master .

La rama dev tiene las últimas actualizaciones y rastrea la última versión de desarrollo de Binary Ninja; Las solicitudes de extracción deben realizarse contra esta rama. La rama master rastrea la construcción estable de Binary Ninja. Si acaba de instalar Binary Ninja por primera vez, probablemente se encuentre en el canal de versión estable.

Contribuyendo

Las contribuciones públicas son bienvenidas a este repositorio. La mayor parte de la API y la documentación de este repositorio tienen una licencia MIT; sin embargo, la API interactúa con una aplicación comercial de código cerrado, Binary Ninja. Además, la API de Rust tiene una licencia Apache 2.0.

Si está interesado en contribuir cuando envíe su primer PR, recibirá un aviso de CLA Assistant que le permitirá firmar nuestro Acuerdo de licencia de contribución en línea.

Plataformas

Este repositorio contiene todos nuestros complementos de plataforma disponibles aquí:

• ventanas
• linux
• macos
• FreeBSD
• Decreto
• EFI

Arquitecturas

Este repositorio contiene todos los complementos de Arquitectura disponibles en las ediciones Personal y Comercial de Binary Ninja. Puede encontrar cada arquitectura aquí:

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

Tipos de vista binaria

Este repositorio contiene todos nuestros complementos de tipo de vista binaria disponibles aquí:

• Macho
• DUENDE
• PE/COFF/TE
• MD1Rom

Información de depuración

• Importación ENANO
• Importación de PDB
• Importación del BID

Repositorios relacionados

Además de que este repositorio principal de API es de código abierto, Vector35 también tiene de código abierto los complementos Debugger y Objective-C:

• Depurador
• objeto_flujo de trabajo

Licencias

Algunos componentes pueden publicarse bajo licencias de código abierto compatibles pero ligeramente diferentes y tendrán su propio archivo de LICENCIA, según corresponda.

Los componentes restantes se publican bajo una licencia MIT.

Tenga en cuenta que los archivos .lib se incluyen en las compilaciones binarias nativas de Binary Ninja para Windows. Esos archivos lib también se publican bajo la misma licencia que este repositorio y pueden distribuirse en consecuencia.