Quipu

Un atelier de bureau pour écrire, valider, compiler et tester des règles YARA.

Quipu (prononcé « KEE-poo ») réunit un explorateur de projet, un éditeur compatible YARA, le compilateur YARA-X et des résultats d'analyse ciblés dans une seule application locale. Il intègre à la fois YARA-X et son serveur de langage, ce qui vous évite d'installer YARA séparément.

[!IMPORTANT] Quipu est au stade MVP. La plateforme initialement prise en charge est Linux 64 bits ; la prise en charge de Windows et macOS suivra.

Fonctionnalités

• Ouvrez un dossier de fichiers .yar et .yara comme espace de travail, ou commencez avec une règle temporaire.
• Explorez les points d'entrée déduits ou configurés, les inclusions imbriquées, les inclusions externes et les problèmes du projet.
• Éditez avec la coloration syntaxique Monaco, la complétion, la documentation au survol et les diagnostics YARA-X en direct.
• Compilez un espace de travail complet, puis analysez un texte saisi ou un fichier sélectionné.
• Inspectez les règles correspondantes, les motifs, les décalages, les longueurs d'octets et les octets mis en évidence dans un visualiseur hexadécimal.
• Passez directement des diagnostics et des correspondances à leurs définitions sources.
• Restaurez les ensembles de règles compilés inchangés depuis un cache local borné.
• Travaillez à partir d'un ensemble de petits projets d'exemple autonomes inclus avec l'application.

Les règles et les cibles d'analyse sont traitées localement. Quipu n'envoie pas leur contenu à un service distant.

Installation sur Linux

Les paquets Linux x86-64 sont publiés sur la page GitHub Releases :

Paquet	Idéal pour	Installer ou exécuter
AppImage	Utilisation portable sur les distributions prises en charge	chmod +x Quipu_*.AppImage && ./Quipu_*.AppImage
.deb	Ubuntu 22.04+ et Debian 12+	sudo apt install ./Quipu_*.deb
.rpm	Versions récentes de Fedora	sudo dnf install ./Quipu-*.rpm

Les paquets .deb et .rpm utilisent le runtime WebKitGTK du système. Si votre distribution ne peut pas satisfaire cette dépendance, utilisez l'AppImage.

Les paquets Quipu ne sont actuellement pas signés. Chaque version inclut un fichier SHA256SUMS ; téléchargez-le à côté des paquets et vérifiez les fichiers que vous avez téléchargés avec :

sha256sum --ignore-missing --check SHA256SUMS

Les sommes de contrôle détectent les corruptions accidentelles mais ne constituent pas une signature authentifiée.

Démarrage rapide

1. Lancez Quipu et choisissez File → Open Example… → Basic text match.
2. Explorez text_indicators.yar dans l'éditeur.
3. Choisissez Rules → Compile Workspace ou appuyez sur Ctrl+Shift+B.
4. Analysez la cible préparée avec Rules → Scan Target ou appuyez sur Ctrl+Shift+Enter.
5. Développez une correspondance et sélectionnez-la pour inspecter les octets mis en évidence.

Le guide complet est fourni avec Quipu sous Help → Documentation. Sa source est également disponible dans documentation/content.

Espaces de travail et quipu.toml

Sans configuration, Quipu découvre récursivement les fichiers de règles et déduit un point d'entrée à partir de chaque fichier qui n'est pas inclus par un autre fichier. Ajoutez un quipu.toml à la racine de l'espace de travail lorsque vous avez besoin de points d'entrée explicites, de répertoires d'inclusion ou d'exclusions :

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

Consultez Workspaces and projects pour le modèle de projet complet et la référence du manifeste.

Compiler depuis les sources

Quipu cible actuellement Linux x86-64. Une compilation nécessite :

• Rust 1.93 ou plus récent
• Node.js 22.6 ou plus récent
• Zola 0.23
• Git
• les bibliothèques natives requises par Tauri et WebKitGTK

Sur Debian ou Ubuntu, installez les dépendances natives avec :

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

Compilez ensuite les trois formats de paquets Linux :

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

Les artefacts sont écrits sous app/src-tauri/target/release/bundle/. La première compilation peut prendre du temps car Cargo compile YARA-X et ses dépendances depuis les sources.

Développer et tester

Installez les dépendances et lancez l'application de développement :

cd app
npm ci
npm run tauri -- dev

Exécutez les tests unitaires du frontend, la compilation de production du frontend et les tests Rust avec :

cd app
npm test
npm run build

cd src-tauri
cargo test --locked

La suite d'acceptation du menu natif a des exigences supplémentaires concernant le serveur d'affichage Linux. Consultez test/README.md pour sa configuration et son utilisation.

Architecture

Quipu est une application Tauri avec un frontend TypeScript vanilla et un backend Rust :

• Vite regroupe le frontend et l'éditeur Monaco dans la webview de l'application.
• Tauri IPC connecte l'interface aux services d'espace de travail, de système de fichiers, de compilation, de cache et d'analyse en Rust.
• Le compilateur YARA-X et le serveur de langage s'exécutent dans le même processus.
• Zola génère un site de documentation hors ligne qui est intégré à l'application.

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 version de l'application est définie dans app/package.json ; Tauri lit cette valeur lorsqu'il nomme les paquets et rapporte la version en cours d'exécution.

Limitations actuelles

• Seuls les paquets Linux x86-64 sont pris en charge initialement.
• Quipu analyse un seul fichier sélectionné ou un seul tampon de texte à la fois, pas des répertoires ni des lots.
• Les nouvelles règles sont créées à la racine de l'espace de travail. Les opérations de déplacement et de suppression sont effectuées en dehors de Quipu.
• Une règle temporaire peut être compilée et analysée, mais pas enregistrée ni mise en cache.

Contribution et sécurité