idasql v0.0.18 - SQL interface to IDA databases

Usage: idasql -s [-q ] [-f ] [-i] [--export ]

Options: -s IDA database (.idb/.i64) OR raw binary (.exe/.dll/firmware/etc.) — raw binaries trigger fresh idalib analysis and string-list rebuild — legacy 32-bit .idb files upgrade to .i64 and require an explicit reopen --token Auth token for HTTP/MCP server mode (if server requires it) -q Execute SQL query or semicolon-separated script -f Execute SQL from file -i Interactive REPL mode -w, --write Save database on exit (persist changes) --export Export tables to SQL file (local mode only) --export-tables=X Tables to export: * (all, default) or table1,table2,... --http [port] Start HTTP REST server (default: 8080, local mode only) --bind Bind address for HTTP/MCP server (default: 127.0.0.1) --mcp [port] Start MCP server (default: random port, use in -i mode) Or use .mcp start in interactive mode -h, --help Show this help --version Show version

Examples: idasql -s test.i64 -q "SELECT name, size FROM funcs LIMIT 10" idasql -s test.i64 -q "SELECT * FROM binary; SELECT COUNT(*) FROM funcs;" idasql -s test.i64 -f queries.sql idasql -s test.i64 -i idasql -s test.i64 --export dump.sql idasql -s test.i64 --http 8080 idasql -s sample.exe --http # raw PE: idalib auto-analyzes, then serves SQL (default port 8080) idasql -s firmware.bin -q "SELECT * FROM binary" idasql -s test.i64 --mcp 9000

Thank you for using IDA. Have a nice day!

レガシー32ビットの `.idb` 入力は、idalib によって同じディレクトリ内の `.i64` にアップグレードされます。このとき、
idasql は SQL を処理する前に終了し、終了コード `3` を返して、
`status:"upgraded"` と `reopen_with` を含む1つの JSON オブジェクトを stdout に出力します。同じ
操作を `-s <reopen_with>` を指定して繰り返してください。

</details>

### ソースからのビルド

#### 前提条件

- CMake 3.20+
- C++20 コンパイラ
- IDA SDK 9.0+（`IDASDK` 環境変数を設定）```bash
cmake -S . -B build -DIDASQL_WITH_MCP=ON -DIDASQL_BUILD_EXAMPLES=OFF
cmake --build build --config Release

Useful CMake switches:

Notes:

• Hex-Raysサポートは常にコンパイルされ、実行時に検出されます。Hex-Raysが利用できない場合、逆コンパイラを利用するテーブル/関数は単に登録されません。
• HTTP RESTサポートは常にコンパイルされます。CLIから--httpを使用するか、REPL/プラグインCLIから.http startを使用します。
• IDAPython SQL実行はコンパイルされていますが、実行時はデフォルトで無効です。セッションごとにPRAGMA idasql.enable_idapython = 1;で有効にしてください。
• IDASQL_WITH_MCP=ONはfastmcppを取得します。OFFにするとMCPサポートと--mcp / .mcpコマンドが削除されます。
• XSQL_WITH_THINCLIENTはONに強制され、HTTPLIB_USE_OPENSSL_IF_AVAILABLEはOFFに強制されます。IDASQLはローカルの平文HTTPを使用するためです。

利用可能なテーブル

関数、文字列、型、クロスリファレンス、逆アセンブル、逆コンパイルなどをカバーする30以上の仮想テーブル。

コア

文字列とバイト

デコンパイラ

型

注釈

検索

データベース情報

ストレージ

解析

SQL関数

統合エンティティ検索

名前付き関数、ラベル、 セグメント、型、メンバーを対象とした合成可能なSQL検索には、grepテーブルを使用します。```sql -- Search anything starting with "Create" SELECT name, kind, printf('0x%X', addr) as addr FROM grep WHERE pattern = 'Create%' LIMIT 20;

-- Search anywhere in name (plain text performs a contains search) SELECT name, kind, full_name FROM grep WHERE pattern = 'File' AND kind IN ('function', 'import') LIMIT 20;

-- Find struct members SELECT name, parent_name, full_name FROM grep WHERE pattern = 'dw%' AND kind = 'member';

-- Pagination SELECT name, kind, full_name FROM grep WHERE pattern = 'Create%' ORDER BY kind, name LIMIT 20 OFFSET 20;

## 統合

### HTTP REST API

シンプルな統合のためのステートレスHTTPサーバー。プロトコルオーバーヘッドなし。```bash
idasql -s database.i64 --http 8080

Please provide the Markdown content to translate.```bash curl http://localhost:8080/status curl -X POST http://localhost:8080/query -d "SELECT name FROM funcs LIMIT 5" curl -X POST http://localhost:8080/query -d "SELECT * FROM binary; SELECT COUNT(*) FROM funcs;"

すべての `/query` レスポンスは標準のスクリプトエンベロープを使用します — 単一ステートメント = 1エントリの配列:```
{
  "success": true,
  "statement_count": <N>,
  "results": [
    { "statement_index": 0, "success": true, "columns": [...], "rows": [...], "row_count": <N>, "elapsed_ms": <ms>, "error": null },
    ...
  ],
  "row_count_total": <N>,
  "elapsed_ms_total": <ms>,
  "first_error_index": null
}

Fail-fastはデフォルトです。continue_on_error=true（例: ?continue_on_error=1）を渡すと、以前の失敗に関係なくすべてのステートメントを実行します。各 results[i].error は、ステートメントごとの失敗を示す正規の情報です。first_error_index は最初の失敗を指すか、null になります。スプリッターの失敗（例: 終了していない引用符）の場合、レスポンスは success:false、statement_count:0、results:[] に加えて、トップレベルの parse_error を含みます。

複数のデータベースを使用する場合は、個別のインスタンスを実行してください:```bash idasql -s malware.i64 --http 8080 idasql -s kernel.i64 --http 8082

エンドポイント： `/status`, `/help`, `/query`, `/shutdown`

#### REPLからHTTPサーバー

REPLまたはIDAプラグインCLIから対話的にHTTPサーバーを起動します：```
idasql -s database.i64 -i
idasql> .http start
HTTP server started on port 8142
URL: http://127.0.0.1:8142
...
Press Ctrl+C to stop and return to REPL.

IDAプラグイン内（非ブロッキング）:``` idasql> .http start HTTP server started on port 8142 idasql> .http stop HTTP server stopped

サーバーは `--http` との競合を避けるため、ランダムなポート (8100-8199) を使用します。

### 自動起動 (ピン留め)

`.pin` は、サーバー設定を IDB (netnode `$ idasql config`) に永続化し、
そのデータベースが開かれるたびに **IDA プラグインが HTTP または MCP サーバーを自動起動** します —
各データベースが安定した既知のポートを維持する、マルチインスタンス環境に便利です。```
idasql> .pin set http 8080        # pin HTTP at 127.0.0.1:8080 (autostart on)
idasql> .pin set mcp 0.0.0.0 9500 # bind override + port (port optional; omit or 0 = fresh random port each launch)
idasql> .pin list                 # show pinned config
idasql> .pin off http             # disable autostart but keep host/port
idasql> .pin clear all            # remove all pins

ピン留め後、データベースを再度開くとサーバーが自動的に起動します — 読み込み時にIDAの出力ウィンドウに 次のように表示されます:``` IDASQL v0.0.18: Query engine initialized IDASQL CLI: Installed IDASQL: autostart -> IDASQL HTTP server: http://127.0.0.1:8099 Type '.http stop' to stop the server.

`.pin`（または `.pin list`）は、両サービスの現在の設定を表示します：```
idasql> .pin
Autostart pins:
  http 127.0.0.1:8099  (autostart: on)
  mcp  (not set)

• ロード時の自動起動はIDAプラグインでのみ発生します。 .pin コマンド自体は CLIとプラグインの両方で動作します（CLIは単にピンを読み書きするだけです）。
• .http start / .mcp start は明示的なポート指定なしで、固定されたホスト/ポートを再利用します。
• CLIからは、.pin の変更は -w/--write を指定して起動した場合のみ保持されます （他のIDB編集と同様）。

MCPサーバー

MCP互換クライアント（Model Context Protocol、AIツール統合の標準規格）向け：

--mcp と .mcp は、デフォルトである -DIDASQL_WITH_MCP=ON を指定してビルドした場合に利用可能です。MCPサポートを省略するには -DIDASQL_WITH_MCP=OFF を指定してビルドしてください。```bash

Standalone mode

idasql -s database.i64 --mcp idasql -s database.i64 --mcp 9500 # specific port

Or in interactive mode

idasql -s database.i64 -i .mcp start

MCPクライアントを設定してください:```json
{
  "mcpServers": {
    "idasql": { "url": "http://127.0.0.1:<port>/sse" }
  }
}

Tools: idasql_query (direct SQL query or semicolon-separated script)

The xsql family

IDASQLは、異なるバイナリ解析およびデバッグ情報プラットフォームを同じSQLインターフェースを通じて公開するツール群の一部であり、すべて共通の libxsql 仮想テーブルフレームワーク上に構築されています。あるツールで覚えたクエリは、他のツールにもほぼそのまま引き継がれます。例えば、同じ SELECT name, size FROM funcs ORDER BY size DESC LIMIT 10 はどこでも実行できます。

リバースエンジニアリングプラットフォーム

• bnsql — Binary NinjaデータベースをSQLとして。
• ghidrasql — GhidraデータベースをSQLとして。

デバッグ情報とコンパイラデータ

• pdbsql — Windows PDBシンボルファイルをSQLとして。
• dwarfsql — DWARFデバッグ情報をSQLとして。
• clangsql — Clang ASTをSQLとして。

コア

• libxsql — 上記のすべてのツールが基盤とするC++ SQLite仮想テーブルフレームワーク。

使用技術

• libxsql - C++データ構造をSQLite仮想テーブルとして公開するためのヘッダオンリーC++17ライブラリ。テーブル定義のための流暢なビルダーAPI、制約プッシュダウン、HTTPシンクライアントサポートを提供します。

• fastmcpp - -DIDASQL_WITH_MCP=ON でビルドするときに使用されるオプションのMCPサーバー実装。

ライセンスと利用条件

要約すると、未変更のidasqlは、通知を保持しライセンス条項に従う限り、商用を含めて、読むこと、ビルドすること、評価すること、ベンチマークすること、パッケージ化すること、使用することができます。また、ライセンスの貢献目的ルールの範囲内で、バグ修正、最適化、機能、テスト、ドキュメント改善などをフィードバックのために準備する目的でフォークやパッチ適用を行うことができます。

Elias Bachaalany からの事前の書面による許可なしに、分岐したプライベートフォーク、ポート、リブランド、クローン、API互換の代替品、競合実装を維持したり、派生実装を再作成または改善するためのAI入力としてidasqlを使用したりすることはできません。ライセンスで定義された意味において、idasqlからコピーされたものでも、実質的に派生したものでも、大幅に情報を得たものでもない独立した実装は、禁止されていません。

許可のリクエスト: allthingsida/idasql/issues でGitHub Issueを開いてください。

idasqlが配布プロジェクトに実質的に情報を提供する場合は、人間の起源を保持してください。該当する場合、README/ドキュメントおよびAbout/クレジットUIにidasqlとElias Bachaalanyへのクレジットを明示してください。ライセンスには、一般的に許可される使用法と許可が必要な使用法のためのexamples/FAQセクションが含まれています。サードパーティの依存関係(libxsql、IDA SDK、およびそれらの推移的依存関係)は、それぞれ独自のライセンスの下にあります。

完全な Human-Origin Source License v1.0 を参照してください。