Quipu

Un banco de trabajo de escritorio para escribir, validar, compilar y probar reglas YARA.

Quipu (pronunciado «KEE-poo») reúne un explorador de proyectos, un editor con conocimiento de YARA, el compilador YARA-X y resultados de escaneo enfocados en una única aplicación local. Incorpora tanto YARA-X como su servidor de lenguaje, por lo que no necesitas una instalación independiente de YARA.

[!IMPORTANT] Quipu está en fase de MVP. La plataforma inicialmente compatible es Linux de 64 bits; el soporte para Windows y macOS llegará más adelante.

Características

• Abre una carpeta de archivos .yar y .yara como espacio de trabajo, o comienza con una regla temporal.
• Explora puntos de entrada inferidos o configurados, inclusiones anidadas, inclusiones externas y problemas del proyecto.
• Edita con resaltado de sintaxis de Monaco, autocompletado, documentación al pasar el cursor y diagnósticos en vivo de YARA-X.
• Compila un espacio de trabajo completo y luego escanea texto escrito o un archivo seleccionado.
• Inspecciona reglas coincidentes, patrones, desplazamientos, longitudes en bytes y bytes resaltados en un visor hexadecimal.
• Salta desde diagnósticos y coincidencias directamente a sus definiciones de origen.
• Restaura conjuntos de reglas compilados sin cambios desde una caché local acotada.
• Trabaja con un conjunto de pequeños proyectos de ejemplo autocontenidos incluidos con la aplicación.

Las reglas y los objetivos de escaneo se procesan localmente. Quipu no envía su contenido a un servicio remoto.

Instalación en Linux

Los paquetes para Linux x86-64 se publican en la página de GitHub Releases:

Paquete	Ideal para	Instalar o ejecutar
AppImage	Uso portátil en distribuciones compatibles	chmod +x Quipu_*.AppImage && ./Quipu_*.AppImage
.deb	Ubuntu 22.04+ y Debian 12+	sudo apt install ./Quipu_*.deb
.rpm	Versiones recientes de Fedora	sudo dnf install ./Quipu-*.rpm

Los paquetes .deb y .rpm usan el entorno de ejecución WebKitGTK del sistema. Si tu distribución no puede satisfacer esa dependencia, usa el AppImage.

Los paquetes de Quipu no están firmados actualmente. Cada versión incluye un archivo SHA256SUMS; descárgalo junto a los paquetes y verifica los archivos que descargaste con:

sha256sum --ignore-missing --check SHA256SUMS

Las sumas de verificación detectan corrupción accidental, pero no son una firma autenticada.

Inicio rápido

1. Inicia Quipu y elige File → Open Example… → Basic text match.
2. Explora text_indicators.yar en el editor.
3. Elige Rules → Compile Workspace o pulsa Ctrl+Shift+B.
4. Escanea el objetivo preparado con Rules → Scan Target o pulsa Ctrl+Shift+Enter.
5. Expande una coincidencia y selecciónala para inspeccionar los bytes resaltados.

La guía completa está incluida con Quipu en Help → Documentation. Su código fuente también está disponible en documentation/content.

Espacios de trabajo y quipu.toml

Sin configuración, Quipu descubre recursivamente archivos de reglas e infiere un punto de entrada a partir de cada archivo que no esté incluido por otro archivo. Añade un quipu.toml en la raíz del espacio de trabajo cuando necesites puntos de entrada explícitos, directorios de inclusión o exclusiones:

schema = 1
entrypoints = ["main.yar"]
include_dirs = ["rules", "../shared-rules"]
exclude = ["fixtures/**", "vendor/legacy/**"]

Consulta Workspaces and projects para conocer el modelo completo de proyecto y la referencia del manifiesto.

Compilar desde el código fuente

Quipu actualmente está orientado a Linux x86-64. Una compilación necesita:

• Rust 1.93 o posterior
• Node.js 22.6 o posterior
• Zola 0.23
• Git
• las bibliotecas nativas requeridas por Tauri y WebKitGTK

En Debian o Ubuntu, instala las dependencias nativas con:

sudo apt update
sudo apt install -y \
  build-essential \
  curl \
  file \
  libayatana-appindicator3-dev \
  libgtk-3-dev \
  librsvg2-dev \
  libssl-dev \
  libwebkit2gtk-4.1-dev \
  patchelf \
  rpm \
  wget

Luego compila los tres formatos de paquete para Linux:

git clone https://github.com/corelight/quipu.git
cd quipu/app
npm ci
npm run tauri -- build --bundles appimage,deb,rpm

Los artefactos se escriben en app/src-tauri/target/release/bundle/. La primera compilación puede tardar un rato porque Cargo compila YARA-X y sus dependencias desde el código fuente.

Desarrollar y probar

Instala las dependencias e inicia la aplicación de desarrollo:

cd app
npm ci
npm run tauri -- dev

Ejecuta las pruebas unitarias del frontend, la compilación de producción del frontend y las pruebas de Rust con:

cd app
npm test
npm run build

cd src-tauri
cargo test --locked

La suite de aceptación del menú nativo tiene requisitos adicionales de servidor de pantalla de Linux. Consulta test/README.md para su configuración y uso.

Arquitectura

Quipu es una aplicación Tauri con un frontend de TypeScript vanilla y un backend de Rust:

• Vite empaqueta el frontend y el editor Monaco en el webview de la aplicación.
• La IPC de Tauri conecta la interfaz de usuario con los servicios de espacio de trabajo, sistema de archivos, compilación, caché y escaneo en Rust.
• El compilador YARA-X y el servidor de lenguaje se ejecutan en proceso.
• Zola compila un sitio de documentación sin conexión que se incorpora en la aplicación.

app/src/           TypeScript frontend
app/src-tauri/     Rust backend and desktop packaging
documentation/    Source for the bundled offline guide
examples/          Projects bundled with the application
test/ui/           Native-menu acceptance test harness

La versión de la aplicación se define en app/package.json; Tauri lee ese valor cuando nombra los paquetes e informa la versión en ejecución.

Limitaciones actuales

• Inicialmente solo se admiten paquetes para Linux x86-64.
• Quipu escanea un archivo seleccionado o un búfer de texto a la vez, no directorios ni lotes.
• Las reglas nuevas se crean en la raíz del espacio de trabajo. Las operaciones de mover y eliminar se realizan fuera de Quipu.
• Una regla temporal se puede compilar y escanear, pero no guardar ni almacenar en caché.

Contribuciones y seguridad

Las contribuciones son bienvenidas. Lee CONTRIBUTING.md antes de abrir una solicitud de extracción.