Quipu

YARAルールの作成、検証、コンパイル、テストを行うためのデスクトップワークベンチ。

Quipu（「KEE-poo」と発音）は、プロジェクトエクスプローラー、YARA対応エディター、 YARA-Xコンパイラー、そして焦点を絞ったスキャン結果を1つのローカルアプリケーションに統合します。 YARA-Xと言語サーバーの両方を組み込んでいるため、別途YARAをインストールする必要はありません。

[!IMPORTANT] QuipuはMVP段階です。初期対応プラットフォームは64ビットLinuxであり、 WindowsとmacOSの対応は今後追加されます。

コンパイル済みのYARAプロジェクトと2件の一致するスキャン結果を表示するQuipu

機能

.yarおよび.yaraファイルのフォルダーをワークスペースとして開くか、スクラッチルールから開始できます。
推論または設定されたエントリーポイント、ネストされたインクルード、外部インクルード、プロジェクトの問題を探索できます。
Monacoによるシンタックスハイライト、補完、ホバードキュメント、ライブ YARA-X診断を使用して編集できます。
ワークスペース全体をコンパイルし、入力したテキストまたは選択したファイルをスキャンできます。
一致したルール、パターン、オフセット、バイト長、ハイライトされたバイトをヘックスビューアーで検査できます。
診断と一致箇所からソース定義へ直接ジャンプできます。
変更されていないコンパイル済みルールセットを、サイズ制限付きのローカルキャッシュから復元できます。
アプリケーションに同梱された、小さく自己完結したサンプルプロジェクトのセットから作業できます。

ルールとスキャン対象はローカルで処理されます。Quipuはそれらの内容をリモートサービスへ送信しません。

Linuxへのインストール

Linux x86-64パッケージは GitHub Releasesページで公開されています：

パッケージ	最適な用途	インストールまたは実行
AppImage	対応ディストリビューションでのポータブル利用	`chmod +x Quipu_.AppImage && ./Quipu_.AppImage`
`.deb`	Ubuntu 22.04以降およびDebian 12以降	`sudo apt install ./Quipu_*.deb`
`.rpm`	最近のFedoraリリース	`sudo dnf install ./Quipu-*.rpm`

.debおよび.rpmパッケージはシステムのWebKitGTKランタイムを使用します。お使いのディストリビューションがその依存関係を満たせない場合は、AppImageを使用してください。

Quipuパッケージは現在署名されていません。各リリースにはSHA256SUMSファイルが含まれています。パッケージの隣にダウンロードし、ダウンロードしたファイルを次のコマンドで検証してください：

sha256sum --ignore-missing --check SHA256SUMS

チェックサムは偶発的な破損を検出しますが、認証された署名ではありません。

クイックスタート

Quipuを起動し、File → Open Example… → Basic text matchを選択します。
エディターでtext_indicators.yarを確認します。
Rules → Compile Workspaceを選択するか、 Ctrl+Shift+Bを押します。
Rules → Scan Targetで準備済みのターゲットをスキャンするか、 Ctrl+Shift+Enterを押します。
一致箇所を展開して選択し、ハイライトされたバイトを検査します。

完全なガイドはHelp → Documentationの下にQuipuと同梱されています。そのソースはdocumentation/contentにもあります。

ワークスペースと`quipu.toml`

設定がない場合、Quipuはルールファイルを再帰的に検出し、他のファイルからインクルードされていない各ファイルからエントリーポイントを推論します。明示的なエントリーポイント、インクルードディレクトリ、除外が必要な場合は、ワークスペースルートにquipu.tomlを追加します：

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

完全なプロジェクトモデルとマニフェストリファレンスについては、ワークスペースとプロジェクトを参照してください。

ソースからのビルド

Quipuは現在Linux x86-64を対象としています。ビルドには以下が必要です：

Rust 1.93以降
Node.js 22.6以降
Zola 0.23
Git
TauriとWebKitGTKが必要とするネイティブライブラリ

DebianまたはUbuntuでは、ネイティブ依存関係を次のコマンドでインストールします：

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

次に、3つのLinuxパッケージ形式をすべてビルドします：

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

成果物はapp/src-tauri/target/release/bundle/の下に出力されます。Cargoが YARA-Xとその依存関係をソースからコンパイルするため、初回ビルドには時間がかかることがあります。

開発とテスト

依存関係をインストールし、開発アプリケーションを起動します：

cd app
npm ci
npm run tauri -- dev

フロントエンドのユニットテスト、本番フロントエンドビルド、Rustテストを次のコマンドで実行します：

cd app
npm test
npm run build

cd src-tauri
cargo test --locked

ネイティブメニューの受け入れテストスイートには、追加のLinuxディスプレイサーバー要件があります。そのセットアップと使用方法については test/README.mdを参照してください。

アーキテクチャ

Quipuは、バニラTypeScriptフロントエンドとRustバックエンドを備えた Tauriアプリケーションです：

ViteがフロントエンドとMonacoエディターをアプリケーションのWebViewにバンドルします。
Tauri IPCがUIをRustのワークスペース、ファイルシステム、コンパイル、キャッシュ、スキャンサービスに接続します。
YARA-Xコンパイラーと言語サーバーはインプロセスで実行されます。
Zolaがアプリに埋め込まれるオフラインドキュメンテーションサイトをビルドします。

app/src/           TypeScriptフロントエンド
app/src-tauri/     Rustバックエンドとデスクトップパッケージング
documentation/    同梱のオフラインガイドのソース
examples/          アプリケーションに同梱されるプロジェクト
test/ui/           ネイティブメニュー受け入れテストハーネス

アプリケーションのバージョンはapp/package.jsonで定義されています。Tauriはパッケージの命名時と実行中バージョンの報告時にその値を読み取ります。

現在の制限事項

当初はLinux x86-64パッケージのみがサポートされています。
Quipuは一度に1つの選択ファイルまたは1つのテキストバッファーをスキャンし、ディレクトリやバッチは対象外です。
新しいルールはワークスペースルートに作成されます。移動と削除の操作は Quipuの外部で実行されます。
スクラッチルールはコンパイルとスキャンはできますが、保存やキャッシュはできません。

コントリビューションとセキュリティ

コントリビューションを歓迎します。プルリクエストを開く前に CONTRIBUTING.mdをお読みください。

セキュリティ脆弱性を公開Issueで報告しないでください。 SECURITY.mdの非公開報告プロセスに従ってください。

謝辞

QuipuはCorelightによって構築され、 YARA-X、 Monaco Editor、 Tauriによって支えられています。

ライセンス

Quipuは3条項BSDライセンスの下で配布されています。LICENSEを参照してください。サードパーティから組み込まれたソフトウェアの通知は THIRD_PARTY_LICENSESにあります。

quipu

人気