Rizin Notebook

Un cuaderno para análisis binario con rizin. Mantén notas, comandos y scripts organizados por binario.

Requiere rizin 0.7.0 o posterior.

Qué hace

Cada página del cuaderno está vinculada a un binario. Almacena el binario en sí, su hash SHA-256, y una lista de celdas:

• celdas de comando - un comando de rizin y su salida
• celdas de script - un fragmento de JavaScript ejecutado en el servidor contra un pipe de rizin
• celdas de markdown - notas libres

Las páginas se almacenan como archivos .rznb individuales (bases de datos SQLite) en ~/.rizin-notebook/. Se pueden exportar e importar como archivos individuales autocontenidos.

Componentes

• Servidor Go (rizin-notebook) - la aplicación principal. Sirve una interfaz web, expone una API REST de protobuf + JSON, almacena todo en archivos .rznb SQLite por página.
• rizin-notebook-plugin - un plugin de núcleo de rizin (C). Agrega comandos NB a rizin para que puedas interactuar con el cuaderno desde el shell de rizin.
• cutter-notebook-plugin - un plugin de Cutter (C++/Qt6). Agrega un dock y menú Plugins -> Notebook a Cutter.

Los plugins son opcionales. El servidor Go funciona de forma independiente solo con un navegador.

Nota de compatibilidad

El servidor Go es independiente de la plataforma. Los plugins dependen de la versión de Rizin con la que se compilan.

Si rizin independiente y Cutter distribuyen diferentes versiones de Rizin en tu máquina, compila rz_notebook una vez para cada una. Ambas compilaciones pueden comunicarse con el mismo servidor y compartir los mismos datos .rznb.

Regla simple:

• un servidor
• una compilación de rz_notebook por versión de Rizin en uso
• un plugin de Cutter si deseas el dock de Cutter

Capturas de pantalla

Las capturas de pantalla del proyecto están organizadas en docs/images/.

Interfaz web

Figura 1. Vista de la página de inicio (con búsqueda basada en celda y alcance, compatible con múltiples modos). Figura 2. Página de configuración para la configuración del entorno, atajos de teclado y comportamiento del lado del servidor. Figura 3. Autocompletado de comandos en la consola web, ayudando a descubrir y completar comandos de Rizin rápidamente. Figura 4. Ventana modal integrada de ayuda y búsqueda de comandos para explorar descripciones y argumentos.

Integración de plugins

Figura 5. Integración del plugin de núcleo de Rizin, permitiendo la interacción con el cuaderno directamente desde el shell de Rizin. Figura 6. Vista de integración del plugin de Cutter mostrando la experiencia del cuaderno dentro de la interfaz de Cutter. Figura 7. Vista adicional del flujo de trabajo del plugin de Cutter demostrando posibles usos del cuaderno.

Compilación del servidor

go build -o rizin-notebook .

Integra la cadena de versión durante las compilaciones de lanzamiento:

go build -ldflags "-X main.NBVERSION=$(git rev-parse --short HEAD)" -o rizin-notebook .

Ejecución

./rizin-notebook

Se abre en http://127.0.0.1:8000/ por defecto.

Banderas:

-bind 127.0.0.1:8000    dirección y puerto de escucha
-root /                  prefijo de ruta URL
-notebook /path/to/data  directorio de datos (predeterminado: ~/.rizin-notebook)
-debug-assets /path      cargar plantillas desde el disco en lugar de incrustadas
-debug                   habilitar registros de solicitudes HTTP

Establece RIZIN_PATH para sobrescribir la ruta del binario de rizin utilizada para la ejecución del pipe.

Compilación del plugin de rizin

Consulta rizin-notebook-plugin/README.md.

Compilación del plugin de Cutter

Consulta cutter-notebook-plugin/README.md.

Si Cutter incluye su propio Rizin incrustado, el plugin rz_notebook cargado por Cutter debe compilarse contra esa misma versión de Rizin empaquetada.

Almacenamiento de datos

Cada página es un archivo .rznb en el directorio de datos. Es una base de datos SQLite que contiene:

• metadatos de la página (título, nombre de archivo original, clave de almacenamiento del binario, hash SHA-256)
• celdas (tipo, contenido, salida, marcas de tiempo)
• el blob del binario en sí
• configuración por página (clave/valor)

El servidor mantiene un índice catalog.db para listar rápidamente todas las páginas.

En la primera ejecución, el servidor migra automáticamente cualquier página de un formato monolítico anterior notebook.db al diseño por página .rznb.

API

Todos los comandos del plugin NB utilizan la API protobuf (Content-Type: application/x-protobuf). El esquema está en proto/notebook.proto.

Una API JSON paralela en /api/v1/json/... es utilizada por el plugin de Cutter y la interfaz del navegador.