- 
+ 
انضم إلى مجتمع الهندسة العكسية
Discord · أسئلة وأجوبة · مشاركة النتائج
@@ -67,7 +67,7 @@ npx rea-agents setup
اختر الوكلاء، وراجع التغييرات المقترحة، ثم وافق عليها. يضيف الإعداد خادم MCP الخاص بـ REA وتعليمات سير العمل المطابقة، مع الاحتفاظ بنسخ احتياطية من الإعدادات الموجودة. أعد تشغيل وكيلك بعد ذلك.
-يدعم الإعداد Claude Code وCodex وCursor وGemini CLI وGrok Build و[وكلاء آخرين](docs/installation.md#supported-agents). راجع [التثبيت والإعداد](docs/installation.md) لتهيئة موفّري التحليل وتسجيل MCP يدويًا.
+يدعم الإعداد Claude Code وCodex وCursor وGemini CLI وGrok Build و[وكلاء آخرين](../installation.md#supported-agents). راجع [التثبيت والإعداد](../installation.md) لتهيئة موفّري التحليل وتسجيل MCP يدويًا.
### اطلب من وكيلك
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-لتحليل الشيفرة الأصلية، هيّئ موفّرًا أولًا. راجع [دليل CLI وEvidence](docs/cli.md) لأوامر تحليل الشيفرة الأصلية، واختيار الموفّر، واللقطات، والاستخدام في السكربتات.
+لتحليل الشيفرة الأصلية، هيّئ موفّرًا أولًا. راجع [دليل CLI وEvidence](../cli.md) لأوامر تحليل الشيفرة الأصلية، واختيار الموفّر، واللقطات، والاستخدام في السكربتات.
### تحديث REA
@@ -120,9 +120,9 @@ npx rea-agents@latest setup
يستدعي وكيلك REA عبر MCP لفحص الهدف وتتبع الشيفرة ذات الصلة. يعيد REA النتائج مع أدلتها. يستخدمها الوكيل لطرح أسئلة متابعة، أو شرح السلوك، أو كتابة تنفيذ واختباره. تستخدم أوامر CLI سير العمل نفسه.
-
+
-[افتح الشكل بحجمه الكامل](website/public/assets/figures/rea-investigation-flow.svg).
+[افتح الشكل بحجمه الكامل](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ npx rea-agents@latest setup
يتطلب REA إصدار Node.js 22.x (>=22.19) أو 24.x (>=24.11) أو 26+، إضافة إلى npm. تعتمد الأدوات الإضافية والأنظمة المضيفة المدعومة على الهدف:
-| الهدف | ما يعيده REA | المتطلبات والدليل |
-| ------------------------------- | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
-| الملفات الثنائية للشيفرة الأصلية | شيفرة شبه برمجية، وتعليمات تجميع، وسلاسل نصية، ورموز، واستدعاءات، ومراجع | Hopper أو Ghidra أو IDA؛ [تحليل الشيفرة الأصلية](https://rea.tools/ar/guides/native/) |
-| بنية ELF دون تشغيل | الأقسام والمقاطع والرموز ومعلومات إعادة التموضع الأصلية، وآليات الحماية المحتملة المستدلّ عليها بالفحص الثابت | pwntools يوفّره المستدعي على Linux x64؛ [تشخيص الملفات الثنائية](docs/binary-diagnostics.md) |
-| شيفرة EVM البايتية | محددات التوجيه، وإزاحات البايتات، والمعاملات المستنتجة، وقابلية تغيير الحالة | مدخل محلي يحمل بايتات خامًا أو تمثيلًا سداسيًا عشريًا على Linux x64؛ [دليل EVM دون تشغيل](docs/evm-bytecode.md) |
-| أعطال Linux المسجّلة | سجلات note الخام، ومسجّلات المعالج/الإشارات لكل خيط مسجّل، وترشيحات اختيارية لخرائط الذاكرة | pwntools يوفّره المستدعي على Linux x64؛ GDB/pwndbg اختياريان؛ [الأعطال المسجّلة](docs/recorded-crashes.md) |
-| JavaScript / Electron | الوحدات، وعمليات الاستيراد، وخرائط المصدر، والمسارات، وIPC، وعلاقات إضافات الشيفرة الأصلية | Node.js وnpm؛ [تحليل التطبيقات](https://rea.tools/ar/guides/javascript/) |
-| المواقع | بنية الصفحة، والسكربتات، وملاحظات الشبكة، ولقطات الشاشة المطلوبة | متصفح من عائلة Chrome؛ [تحليل المتصفح](https://rea.tools/ar/guides/browser/) |
-| تسجيلات الشبكة المحفوظة | الطلبات، والاستجابات، ومحتويات الحمولة المتاحة، ومواضعها في المصدر | HAR؛ وmitmdump على Linux لتسجيلات mitmproxy بصيغتها الأصلية؛ [دليل تسجيلات الشبكة](docs/web-network-captures.md) |
-| التقاط الحزم | نقاط النهاية وDNS وTLS SNI وتوزيع البروتوكولات وطلبات HTTP | tshark وcapinfos يوفّرهما المُستدعي؛ [دليل pcap](docs/pcap-analysis.md) |
-| تجميعات .NET | البيانات الوصفية، وتعليمات CIL، واعتماديات الشيفرة الأصلية المعلنة، ومقارنات البناء | فحص ثابت؛ [دليل الشيفرة المُدارة](docs/managed-code-analysis.md) |
-| حزم Android APK | تصريحات ملف manifest، والأصناف، والدوال الناتجة عن فك الترجمة، والمراجع | JADX دون واجهة رسومية وJDK كامل على Linux/macOS/Windows x64؛ [دليل Android](docs/android-analysis.md) |
-| أجهزة Android | الأجهزة والحزم والعمليات والسجلات والدامبات ولقطات الشاشة ونقل APK/الملفات | adb يوفّره المُستدعي (محاكي أو جهاز)؛ [دليل ADB](docs/adb-device-analysis.md) |
-| مشاريع JEB | وحدات المشروع من المحرك وبصمات المصنّفات والكود الزائف للأنواع/الدوال | عميل JEB يبدأه المُستدعي ويقدّم MCP، ويُختار عبر REA_JEB_MCP_URL؛ [دليل JEB](docs/jeb-analysis.md) |
-| موارد Android | البيان المفكوك الترميز وجداول السلاسل واللغات وحقائق الإصدار | مُشغّل Apktool يوفّره المُستدعي؛ [دليل الموارد](docs/apktool-resource-analysis.md) |
-| تطبيقات Flutter | بصمة لقطة Dart وهشوش المكتبات لكل ABI وأصل بناء المحرك | لا شيء (تحليل APK ساكن)؛ [دليل Flutter](docs/flutter-analysis.md) |
-| البرامج الثابتة | المناطق، ونتائج الاستخراج، وما يُمرّر إلى تحليل الشيفرة الأصلية | Binwalk / Unblob على Linux؛ [دليل البرامج الثابتة](docs/firmware-analysis.md) |
-| الحزم المسجلة | حقول مختارة وقيم متكررة ومرشحات وقواعد فك الترميز | Linux: TShark 4.x + prlimit; [دليل التقاط الحزم](docs/packet-captures.md) |
-| الإشارات المنطقية المسجلة | تعليقات مفكك الترميز ونطاقات العينات ومعلومات التشخيص | Linux: sigrok-cli 0.7.2 + prlimit; [دليل الإشارات](docs/signal-recordings.md) |
-| الحزم والموارد | قوائم الملفات، والبصمات، وملفات plist، وبنية حزم Apple، والموارد المستخرجة | [دليل تحليل الملفات وJavaScript](docs/javascript-artifact-reconstruction.md)، [تطبيقات Apple](docs/apple-application-analysis.md) |
-| سلوك العمليات | مخرجات الطرفية، والتفاعلات، وملاحظات الخروج ونظام الملفات، ومقارنات التشغيل | Linux/macOS مع PTY أصلي؛ [تسجيل سلوك العمليات](docs/process-capture.md) |
+| الهدف | ما يعيده REA | المتطلبات والدليل |
+| ------------------------------- | ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| الملفات الثنائية للشيفرة الأصلية | شيفرة شبه برمجية، وتعليمات تجميع، وسلاسل نصية، ورموز، واستدعاءات، ومراجع | Hopper أو Ghidra أو IDA؛ [تحليل الشيفرة الأصلية](https://rea.tools/ar/guides/native/) |
+| بنية ELF دون تشغيل | الأقسام والمقاطع والرموز ومعلومات إعادة التموضع الأصلية، وآليات الحماية المحتملة المستدلّ عليها بالفحص الثابت | pwntools يوفّره المستدعي على Linux x64؛ [تشخيص الملفات الثنائية](../binary-diagnostics.md) |
+| شيفرة EVM البايتية | محددات التوجيه، وإزاحات البايتات، والمعاملات المستنتجة، وقابلية تغيير الحالة | مدخل محلي يحمل بايتات خامًا أو تمثيلًا سداسيًا عشريًا على Linux x64؛ [دليل EVM دون تشغيل](../evm-bytecode.md) |
+| أعطال Linux المسجّلة | سجلات note الخام، ومسجّلات المعالج/الإشارات لكل خيط مسجّل، وترشيحات اختيارية لخرائط الذاكرة | pwntools يوفّره المستدعي على Linux x64؛ GDB/pwndbg اختياريان؛ [الأعطال المسجّلة](../recorded-crashes.md) |
+| JavaScript / Electron | الوحدات، وعمليات الاستيراد، وخرائط المصدر، والمسارات، وIPC، وعلاقات إضافات الشيفرة الأصلية | Node.js وnpm؛ [تحليل التطبيقات](https://rea.tools/ar/guides/javascript/) |
+| المواقع | بنية الصفحة، والسكربتات، وملاحظات الشبكة، ولقطات الشاشة المطلوبة | متصفح من عائلة Chrome؛ [تحليل المتصفح](https://rea.tools/ar/guides/browser/) |
+| تسجيلات الشبكة المحفوظة | الطلبات، والاستجابات، ومحتويات الحمولة المتاحة، ومواضعها في المصدر | HAR؛ وmitmdump على Linux لتسجيلات mitmproxy بصيغتها الأصلية؛ [دليل تسجيلات الشبكة](../web-network-captures.md) |
+| التقاط الحزم | نقاط النهاية وDNS وTLS SNI وتوزيع البروتوكولات وطلبات HTTP | tshark وcapinfos يوفّرهما المُستدعي؛ [دليل pcap](../pcap-analysis.md) |
+| تجميعات .NET | البيانات الوصفية، وتعليمات CIL، واعتماديات الشيفرة الأصلية المعلنة، ومقارنات البناء | فحص ثابت؛ [دليل الشيفرة المُدارة](../managed-code-analysis.md) |
+| حزم Android APK | تصريحات ملف manifest، والأصناف، والدوال الناتجة عن فك الترجمة، والمراجع | JADX دون واجهة رسومية وJDK كامل على Linux/macOS/Windows x64؛ [دليل Android](../android-analysis.md) |
+| أجهزة Android | الأجهزة والحزم والعمليات والسجلات والدامبات ولقطات الشاشة ونقل APK/الملفات | adb يوفّره المُستدعي (محاكي أو جهاز)؛ [دليل ADB](../adb-device-analysis.md) |
+| مشاريع JEB | وحدات المشروع من المحرك وبصمات المصنّفات والكود الزائف للأنواع/الدوال | عميل JEB يبدأه المُستدعي ويقدّم MCP، ويُختار عبر REA_JEB_MCP_URL؛ [دليل JEB](../jeb-analysis.md) |
+| موارد Android | البيان المفكوك الترميز وجداول السلاسل واللغات وحقائق الإصدار | مُشغّل Apktool يوفّره المُستدعي؛ [دليل الموارد](../apktool-resource-analysis.md) |
+| تطبيقات Flutter | بصمة لقطة Dart وهشوش المكتبات لكل ABI وأصل بناء المحرك | لا شيء (تحليل APK ساكن)؛ [دليل Flutter](../flutter-analysis.md) |
+| البرامج الثابتة | المناطق، ونتائج الاستخراج، وما يُمرّر إلى تحليل الشيفرة الأصلية | Binwalk / Unblob على Linux؛ [دليل البرامج الثابتة](../firmware-analysis.md) |
+| الحزم المسجلة | حقول مختارة وقيم متكررة ومرشحات وقواعد فك الترميز | Linux: TShark 4.x + prlimit; [دليل التقاط الحزم](../packet-captures.md) |
+| الإشارات المنطقية المسجلة | تعليقات مفكك الترميز ونطاقات العينات ومعلومات التشخيص | Linux: sigrok-cli 0.7.2 + prlimit; [دليل الإشارات](../signal-recordings.md) |
+| الحزم والموارد | قوائم الملفات، والبصمات، وملفات plist، وبنية حزم Apple، والموارد المستخرجة | [دليل تحليل الملفات وJavaScript](../javascript-artifact-reconstruction.md)، [تطبيقات Apple](../apple-application-analysis.md) |
+| سلوك العمليات | مخرجات الطرفية، والتفاعلات، وملاحظات الخروج ونظام الملفات، ومقارنات التشغيل | Linux/macOS مع PTY أصلي؛ [تسجيل سلوك العمليات](../process-capture.md) |
يقرأ الفحص الثابت لـ JavaScript و.NET الملفات المقدّمة دون تشغيل التطبيق. يشغّل التسجيل أثناء التنفيذ الهدف المحدد أو يتفاعل معه بصلاحيات مستخدمك؛ ويشرح كل دليل للتسجيل أثناء التنفيذ آثاره.
-تختلف صيغ ملفات الشيفرة الأصلية والأنظمة المضيفة المدعومة باختلاف الموفّر. راجع [إعداد Hopper وGhidra](docs/installation.md#hopper)، و[دليل IDA](docs/ida-provider.md)، و[دعم Ghidra التجريبي على Windows](docs/windows-ghidra-p0.md). يدعم Ghidra أيضًا [تحليل DOS ذي 16 بت](docs/ghidra-dos.md). لاختيار الموفّر، راجع [دليل CLI](docs/cli.md#choose-a-provider). تحقّق من [توفر الميزات في الإصدارات](docs/installation.md#released-package-and-main) للميزات المضافة بعد أحدث إصدار على npm.
+تختلف صيغ ملفات الشيفرة الأصلية والأنظمة المضيفة المدعومة باختلاف الموفّر. راجع [إعداد Hopper وGhidra](../installation.md#hopper)، و[دليل IDA](../ida-provider.md)، و[دعم Ghidra التجريبي على Windows](../windows-ghidra-p0.md). يدعم Ghidra أيضًا [تحليل DOS ذي 16 بت](../ghidra-dos.md). لاختيار الموفّر، راجع [دليل CLI](../cli.md#choose-a-provider). تحقّق من [توفر الميزات في الإصدارات](../installation.md#released-package-and-main) للميزات المضافة بعد أحدث إصدار على npm.
## دراسات الحالة
-[](https://rea.tools/ar/showcase/)
+[](https://rea.tools/ar/showcase/)
### DX-Ball: إعادة بناء حساب توزيع الصوت بين القناتين
@@ -189,28 +189,28 @@ npx rea-agents@latest setup
أي وكلاء يمكنهم استخدام REA؟
-أي وكيل يدعم خوادم MCP المحلية. يهيّئ الإعداد [الوكلاء المدعومين](docs/installation.md#supported-agents)؛ ويمكن للعملاء الآخرين استخدام [تسجيل MCP يدويًا](docs/installation.md#mcp-registry).
+أي وكيل يدعم خوادم MCP المحلية. يهيّئ الإعداد [الوكلاء المدعومين](../installation.md#supported-agents)؛ ويمكن للعملاء الآخرين استخدام [تسجيل MCP يدويًا](../installation.md#mcp-registry).
هل أحتاج إلى Hopper أو Ghidra أو IDA؟
-يستخدم تحليل الشيفرة الأصلية المتعمق أحدها. يعمل الفحص الثابت لـ JavaScript و.NET دون محرك لتحليل الشيفرة الأصلية. يستطيع الإعداد تثبيت Hopper بعد الموافقة؛ أما Ghidra وIDA فيستخدمان تثبيتاتك الموجودة. راجع [إعداد الموفّرين](docs/installation.md#hopper).
+يستخدم تحليل الشيفرة الأصلية المتعمق أحدها. يعمل الفحص الثابت لـ JavaScript و.NET دون محرك لتحليل الشيفرة الأصلية. يستطيع الإعداد تثبيت Hopper بعد الموافقة؛ أما Ghidra وIDA فيستخدمان تثبيتاتك الموجودة. راجع [إعداد الموفّرين](../installation.md#hopper).
هل أحتاج إلى تشغيل Hopper أولًا؟
-يشغّل REA برنامج Hopper عندما تحتاج العملية إليه. على macOS، قد تظهر عند التشغيل الأول نافذة تطلب اختيار وضع العرض التجريبي أو تفعيل الترخيص. راجع [تشغيل Hopper واستكشاف الأخطاء](docs/installation.md#launcher-paths-and-troubleshooting).
+يشغّل REA برنامج Hopper عندما تحتاج العملية إليه. على macOS، قد تظهر عند التشغيل الأول نافذة تطلب اختيار وضع العرض التجريبي أو تفعيل الترخيص. راجع [تشغيل Hopper واستكشاف الأخطاء](../installation.md#launcher-paths-and-troubleshooting).
ماذا يفعل تثبيت المهارة من skills.sh؟
-توفّر المهارة تعليمات الاستقصاء لوكيلك. استخدم `npx rea-agents setup` لتسجيل خادم MCP الخاص بـ REA وتثبيت التعليمات المطابقة، ثم أعد تشغيل وكيلك. راجع [تثبيت المهارة وحدها](docs/installation.md#skill-only-installation).
+توفّر المهارة تعليمات الاستقصاء لوكيلك. استخدم `npx rea-agents setup` لتسجيل خادم MCP الخاص بـ REA وتثبيت التعليمات المطابقة، ثم أعد تشغيل وكيلك. راجع [تثبيت المهارة وحدها](../installation.md#skill-only-installation).
@@ -253,14 +253,14 @@ npx rea-agents@latest setup
ابدأ بـ [الأدلة العملية](https://rea.tools/ar/guides/) على الموقع. للخيارات الدقيقة والمتطلبات وعقود النتائج:
-- [التثبيت والإعداد](docs/installation.md): تسجيل الوكلاء، وتهيئة الموفّرين، والتحديثات، وإلغاء التثبيت.
-- [الجاهزية واستكشاف الأخطاء](docs/installation.md#check-readiness-for-your-task): تشخيص وكيل أو محرك تحليل محدد.
-- [CLI وEvidence](docs/cli.md): الأوامر، واختيار الموفّر، واللقطات، والاستيراد/التصدير، وحالات الخروج.
-- [عقود MCP](docs/mcp-contracts.md) و[تعليمات الوكلاء](docs/mcp-prompts.md): نتائج الأدوات، والجلسات، والاستقصاءات الموجّهة.
-- [كتالوج الأدوات](docs/mcp-contracts.md#generated-catalog): قائمة الأدوات والموفّرين وأوامر CLI المولّدة أثناء البناء.
-- [خطة العمل](docs/roadmap.md): الأعمال المخطط لها ومتابعة القدرات.
+- [التثبيت والإعداد](../installation.md): تسجيل الوكلاء، وتهيئة الموفّرين، والتحديثات، وإلغاء التثبيت.
+- [الجاهزية واستكشاف الأخطاء](../installation.md#check-readiness-for-your-task): تشخيص وكيل أو محرك تحليل محدد.
+- [CLI وEvidence](../cli.md): الأوامر، واختيار الموفّر، واللقطات، والاستيراد/التصدير، وحالات الخروج.
+- [عقود MCP](../mcp-contracts.md) و[تعليمات الوكلاء](../mcp-prompts.md): نتائج الأدوات، والجلسات، والاستقصاءات الموجّهة.
+- [كتالوج الأدوات](../mcp-contracts.md#generated-catalog): قائمة الأدوات والموفّرين وأوامر CLI المولّدة أثناء البناء.
+- [خطة العمل](../roadmap.md): الأعمال المخطط لها ومتابعة القدرات.
-أبلغ عن الثغرات وفق [SECURITY.md](SECURITY.md).
+أبلغ عن الثغرات وفق [SECURITY.md](../../SECURITY.md).
## سجل النجوم
@@ -278,7 +278,7 @@ npx rea-agents@latest setup
## إخلاء المسؤولية
-راجع [DISCLAIMER.md](DISCLAIMER.md) للحصول على إرشادات الاستخدام المسؤول.
+راجع [DISCLAIMER.md](../../DISCLAIMER.md) للحصول على إرشادات الاستخدام المسؤول.
REA مخصص للبحث والتعليم والتشغيل البيني وحفظ البرمجيات بشكل قانوني، ولتحليل البرمجيات التي تملكها أو لديك تفويض لفحصها.
@@ -290,14 +290,14 @@ applicable licenses.
نرحّب بمساعدتك في تطوير REA! [افتح issue](https://github.com/morluto/rea/issues) للإبلاغ عن خطأ أو اقتراح ميزة، أو [أرسل pull request](https://github.com/morluto/rea/pulls) لتحسين الشيفرة أو التوثيق.
-راجع [CONTRIBUTING.md](CONTRIBUTING.md) لإعداد بيئة التطوير والفحوص، و[دليل الاختبار](docs/testing.md) لمسارات التحقق، و[خريطة البنية](docs/architecture.mermaid) لهيكل المشروع.
+راجع [CONTRIBUTING.md](../../CONTRIBUTING.md) لإعداد بيئة التطوير والفحوص، و[دليل الاختبار](../testing.md) لمسارات التحقق، و[خريطة البنية](../architecture.mermaid) لهيكل المشروع.
## الترخيص
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_de.md b/docs/readme/README_de.md
similarity index 76%
rename from README_de.md
rename to docs/readme/README_de.md
index 2c6d20290..2dbb1d41a 100644
--- a/README_de.md
+++ b/docs/readme/README_de.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · **Deutsch** · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · **Deutsch** · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: Alles reverse-engineeren
@@ -9,10 +9,10 @@
**Eine Funktion gefällt dir? Verstehe, wie sie funktioniert – bis hinunter auf die Binärebene.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Der Reverse-Engineering-Community beitreten
Discord · Fragen und Antworten · Ergebnisse teilen
@@ -67,7 +67,7 @@ npx rea-agents setup
Wähle deine Agenten aus, prüfe die geplanten Änderungen und bestätige sie. Die Einrichtung fügt den MCP-Server von REA und passende Workflow-Anweisungen hinzu und sichert vorhandene Konfigurationen. Starte deinen Agenten anschließend neu.
-Die Einrichtung unterstützt Claude Code, Codex, Cursor, Gemini CLI, Grok Build und [weitere Agenten](docs/installation.md#supported-agents). Informationen zur Provider-Konfiguration und manuellen MCP-Registrierung findest du unter [Installation und Einrichtung](docs/installation.md).
+Die Einrichtung unterstützt Claude Code, Codex, Cursor, Gemini CLI, Grok Build und [weitere Agenten](../installation.md#supported-agents). Informationen zur Provider-Konfiguration und manuellen MCP-Registrierung findest du unter [Installation und Einrichtung](../installation.md).
### Deinen Agenten fragen
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-Konfiguriere für native Analysen zuerst einen Provider. Native Befehle, Provider-Auswahl, Snapshots und Skriptnutzung beschreibt der [CLI- und Evidence-Leitfaden](docs/cli.md).
+Konfiguriere für native Analysen zuerst einen Provider. Native Befehle, Provider-Auswahl, Snapshots und Skriptnutzung beschreibt der [CLI- und Evidence-Leitfaden](../cli.md).
### REA aktualisieren
@@ -120,9 +120,9 @@ Prüfe die Änderungen und starte deinen Agenten neu. Für einzelne CLI-Aufrufe
Dein Agent ruft REA über MCP auf, um das Ziel zu untersuchen und relevanten Code zu verfolgen. REA liefert Ergebnisse mit ihren Belegen zurück. Der Agent nutzt sie für weitere Fragen, Erklärungen oder zum Schreiben und Testen einer Implementierung. CLI-Befehle verwenden dieselben Workflows.
-
+
-[Abbildung in voller Größe öffnen](website/public/assets/figures/rea-investigation-flow.svg).
+[Abbildung in voller Größe öffnen](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ Dein Agent ruft REA über MCP auf, um das Ziel zu untersuchen und relevanten Cod
REA benötigt Node.js 22.x (>=22.19), 24.x (>=24.11) oder 26+ sowie npm. Zusätzliche Werkzeuge und unterstützte Hostsysteme hängen vom Ziel ab:
-| Ziel | Was REA zurückgibt | Voraussetzungen und Anleitung |
-| ----------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| Native Binärdateien | Pseudocode, Assemblercode, Zeichenketten, Symbole, Aufrufe und Verweise | Hopper, Ghidra oder IDA; [native Analyse](https://rea.tools/de/guides/native/) |
-| Offline-ELF-Struktur | Sektionen, Segmente, ursprüngliche Symbole/Relokationen und mögliche Schutzmaßnahmen aus statischer Analyse | Vom Aufrufer bereitgestelltes pwntools unter Linux x64; [Binärdiagnostik](docs/binary-diagnostics.md) |
-| EVM-Bytecode | Dispatch-Selektoren, Byte-Offsets, abgeleitete Argumente und Veränderbarkeit des Zustands | Lokale Eingabe mit Rohbytes oder Hexdarstellung unter Linux x64; [Offline-EVM-Leitfaden](docs/evm-bytecode.md) |
-| Aufgezeichnete Linux-Abstürze | Unverarbeitete Note-Einträge, Register/Signale aller aufgezeichneten Threads und optionale Zuordnungskandidaten | Vom Aufrufer bereitgestelltes pwntools unter Linux x64; optional GDB/pwndbg; [aufgezeichnete Abstürze](docs/recorded-crashes.md) |
-| JavaScript / Electron | Module, Imports, Source Maps, Routen, IPC und Beziehungen zu nativen Add-ons | Node.js und npm; [Anwendungsanalyse](https://rea.tools/de/guides/javascript/) |
-| Websites | Seitenstruktur, Skripte, Netzwerkbeobachtungen und angeforderte Screenshots | Ein Browser aus der Chrome-Familie; [Browseranalyse](https://rea.tools/de/guides/browser/) |
-| Gespeicherte Netzwerkaufzeichnungen | Anfragen, Antworten, zugängliche Nutzdaten und Quellpositionen | HAR; mitmdump unter Linux für Aufzeichnungen im nativen mitmproxy-Format; [Leitfaden zu Netzwerkaufzeichnungen](docs/web-network-captures.md) |
-| Paketerfassungen | Endpunkte, DNS, TLS SNI, Protokollverteilung und HTTP-Anfragen | Vom Aufrufer bereitgestellte tshark- und capinfos-Binaries; [pcap-Leitfaden](docs/pcap-analysis.md) |
-| .NET-Assemblies | Metadaten, CIL-Anweisungen, deklarierte native Abhängigkeiten und Build-Vergleiche | Statische Untersuchung; [Leitfaden für verwalteten Code](docs/managed-code-analysis.md) |
-| Android-APKs | Manifest-Deklarationen, Klassen, dekompilierte Methoden und Verweise | JADX ohne grafische Oberfläche und ein vollständiges JDK unter Linux/macOS/Windows x64; [Android-Leitfaden](docs/android-analysis.md) |
-| Android-Geräte | Geräte, Pakete, Prozesse, Logs, Dumps, Bildschirmaufnahmen sowie APK- und Dateiübertragungen | Vom Aufrufer bereitgestelltes adb (Emulator oder Gerät); [ADB-Leitfaden](docs/adb-device-analysis.md) |
-| JEB-Projekte | Engine-gestützte Projekteinheiten, Artefakt-Prüfsummen und Pseudokode von Typen/Methoden | Ein vom Aufrufer gestarteter JEB-Client mit MCP, ausgewählt über REA_JEB_MCP_URL; [JEB-Leitfaden](docs/jeb-analysis.md) |
-| Android-Ressourcen | Dekodiertes Manifest, String-Tabellen, Sprachen und Versionsfakten | Vom Aufrufer bereitgestellter Apktool-Starter; [Ressourcen-Leitfaden](docs/apktool-resource-analysis.md) |
-| Flutter-Apps | Dart-Snapshot-Hash, Per-ABI-Bibliotheksprüfsummen und Engine-Build-Provenienz | Keine (statische APK-Analyse); [Flutter-Leitfaden](docs/flutter-analysis.md) |
-| Firmware | Bereiche, Extraktionsergebnisse und Übergaben an die native Analyse | Binwalk / Unblob unter Linux; [Firmware-Leitfaden](docs/firmware-analysis.md) |
-| Aufgezeichnete Pakete | Ausgewählte Felder, wiederholte Werte, Filter und Decode-as-Regeln | Linux: TShark 4.x + prlimit; [Mitschnitt-Anleitung](docs/packet-captures.md) |
-| Aufgezeichnete Logiksignale | Decoder-Anmerkungen, Sample-Bereiche und Diagnosen | Linux: sigrok-cli 0.7.2 + prlimit; [Signalaufzeichnungen](docs/signal-recordings.md) |
-| Pakete und Ressourcen | Dateiinventare, Hashwerte, plists, Aufbau von Apple-Bundles und extrahierte Ressourcen | [Artefakt- und JavaScript-Leitfaden](docs/javascript-artifact-reconstruction.md), [Apple-Anwendungen](docs/apple-application-analysis.md) |
-| Prozessverhalten | Terminalausgabe, Interaktionen, Beobachtungen zu Prozessende und Dateisystem sowie Laufvergleiche | Linux/macOS mit nativer PTY; [Prozessaufzeichnung](docs/process-capture.md) |
+| Ziel | Was REA zurückgibt | Voraussetzungen und Anleitung |
+| ----------------------------------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| Native Binärdateien | Pseudocode, Assemblercode, Zeichenketten, Symbole, Aufrufe und Verweise | Hopper, Ghidra oder IDA; [native Analyse](https://rea.tools/de/guides/native/) |
+| Offline-ELF-Struktur | Sektionen, Segmente, ursprüngliche Symbole/Relokationen und mögliche Schutzmaßnahmen aus statischer Analyse | Vom Aufrufer bereitgestelltes pwntools unter Linux x64; [Binärdiagnostik](../binary-diagnostics.md) |
+| EVM-Bytecode | Dispatch-Selektoren, Byte-Offsets, abgeleitete Argumente und Veränderbarkeit des Zustands | Lokale Eingabe mit Rohbytes oder Hexdarstellung unter Linux x64; [Offline-EVM-Leitfaden](../evm-bytecode.md) |
+| Aufgezeichnete Linux-Abstürze | Unverarbeitete Note-Einträge, Register/Signale aller aufgezeichneten Threads und optionale Zuordnungskandidaten | Vom Aufrufer bereitgestelltes pwntools unter Linux x64; optional GDB/pwndbg; [aufgezeichnete Abstürze](../recorded-crashes.md) |
+| JavaScript / Electron | Module, Imports, Source Maps, Routen, IPC und Beziehungen zu nativen Add-ons | Node.js und npm; [Anwendungsanalyse](https://rea.tools/de/guides/javascript/) |
+| Websites | Seitenstruktur, Skripte, Netzwerkbeobachtungen und angeforderte Screenshots | Ein Browser aus der Chrome-Familie; [Browseranalyse](https://rea.tools/de/guides/browser/) |
+| Gespeicherte Netzwerkaufzeichnungen | Anfragen, Antworten, zugängliche Nutzdaten und Quellpositionen | HAR; mitmdump unter Linux für Aufzeichnungen im nativen mitmproxy-Format; [Leitfaden zu Netzwerkaufzeichnungen](../web-network-captures.md) |
+| Paketerfassungen | Endpunkte, DNS, TLS SNI, Protokollverteilung und HTTP-Anfragen | Vom Aufrufer bereitgestellte tshark- und capinfos-Binaries; [pcap-Leitfaden](../pcap-analysis.md) |
+| .NET-Assemblies | Metadaten, CIL-Anweisungen, deklarierte native Abhängigkeiten und Build-Vergleiche | Statische Untersuchung; [Leitfaden für verwalteten Code](../managed-code-analysis.md) |
+| Android-APKs | Manifest-Deklarationen, Klassen, dekompilierte Methoden und Verweise | JADX ohne grafische Oberfläche und ein vollständiges JDK unter Linux/macOS/Windows x64; [Android-Leitfaden](../android-analysis.md) |
+| Android-Geräte | Geräte, Pakete, Prozesse, Logs, Dumps, Bildschirmaufnahmen sowie APK- und Dateiübertragungen | Vom Aufrufer bereitgestelltes adb (Emulator oder Gerät); [ADB-Leitfaden](../adb-device-analysis.md) |
+| JEB-Projekte | Engine-gestützte Projekteinheiten, Artefakt-Prüfsummen und Pseudokode von Typen/Methoden | Ein vom Aufrufer gestarteter JEB-Client mit MCP, ausgewählt über REA_JEB_MCP_URL; [JEB-Leitfaden](../jeb-analysis.md) |
+| Android-Ressourcen | Dekodiertes Manifest, String-Tabellen, Sprachen und Versionsfakten | Vom Aufrufer bereitgestellter Apktool-Starter; [Ressourcen-Leitfaden](../apktool-resource-analysis.md) |
+| Flutter-Apps | Dart-Snapshot-Hash, Per-ABI-Bibliotheksprüfsummen und Engine-Build-Provenienz | Keine (statische APK-Analyse); [Flutter-Leitfaden](../flutter-analysis.md) |
+| Firmware | Bereiche, Extraktionsergebnisse und Übergaben an die native Analyse | Binwalk / Unblob unter Linux; [Firmware-Leitfaden](../firmware-analysis.md) |
+| Aufgezeichnete Pakete | Ausgewählte Felder, wiederholte Werte, Filter und Decode-as-Regeln | Linux: TShark 4.x + prlimit; [Mitschnitt-Anleitung](../packet-captures.md) |
+| Aufgezeichnete Logiksignale | Decoder-Anmerkungen, Sample-Bereiche und Diagnosen | Linux: sigrok-cli 0.7.2 + prlimit; [Signalaufzeichnungen](../signal-recordings.md) |
+| Pakete und Ressourcen | Dateiinventare, Hashwerte, plists, Aufbau von Apple-Bundles und extrahierte Ressourcen | [Artefakt- und JavaScript-Leitfaden](../javascript-artifact-reconstruction.md), [Apple-Anwendungen](../apple-application-analysis.md) |
+| Prozessverhalten | Terminalausgabe, Interaktionen, Beobachtungen zu Prozessende und Dateisystem sowie Laufvergleiche | Linux/macOS mit nativer PTY; [Prozessaufzeichnung](../process-capture.md) |
Statische JavaScript- und .NET-Untersuchungen lesen die bereitgestellten Dateien, ohne die Anwendung auszuführen. Laufzeitaufzeichnungen führen das gewählte Ziel mit deinen Benutzerrechten aus oder interagieren damit; die jeweiligen Anleitungen beschreiben die Auswirkungen.
-Native Formate und unterstützte Hostsysteme unterscheiden sich je nach Provider. Siehe [Hopper- und Ghidra-Einrichtung](docs/installation.md#hopper), den [IDA-Leitfaden](docs/ida-provider.md) und die [experimentelle Ghidra-Unterstützung unter Windows](docs/windows-ghidra-p0.md). Ghidra unterstützt auch [16-Bit-DOS-Analyse](docs/ghidra-dos.md). Die Provider-Auswahl beschreibt der [CLI-Leitfaden](docs/cli.md#choose-a-provider). Prüfe die [Verfügbarkeit in Releases](docs/installation.md#released-package-and-main) für Funktionen, die seit der neuesten npm-Version hinzugekommen sind.
+Native Formate und unterstützte Hostsysteme unterscheiden sich je nach Provider. Siehe [Hopper- und Ghidra-Einrichtung](../installation.md#hopper), den [IDA-Leitfaden](../ida-provider.md) und die [experimentelle Ghidra-Unterstützung unter Windows](../windows-ghidra-p0.md). Ghidra unterstützt auch [16-Bit-DOS-Analyse](../ghidra-dos.md). Die Provider-Auswahl beschreibt der [CLI-Leitfaden](../cli.md#choose-a-provider). Prüfe die [Verfügbarkeit in Releases](../installation.md#released-package-and-main) für Funktionen, die seit der neuesten npm-Version hinzugekommen sind.
## Fallstudien
-[](https://rea.tools/de/showcase/)
+[](https://rea.tools/de/showcase/)
### DX-Ball: Eine Stereo-Panning-Berechnung rekonstruieren
@@ -187,28 +187,28 @@ Wenn du mit REA etwas Interessantes untersucht hast, würden wir es gern sehen.
Welche Agenten können REA verwenden?
-Jeder Agent, der lokale MCP-Server unterstützt. Die Einrichtung konfiguriert die [unterstützten Agenten](docs/installation.md#supported-agents); andere Clients können die [manuelle MCP-Registrierung](docs/installation.md#mcp-registry) nutzen.
+Jeder Agent, der lokale MCP-Server unterstützt. Die Einrichtung konfiguriert die [unterstützten Agenten](../installation.md#supported-agents); andere Clients können die [manuelle MCP-Registrierung](../installation.md#mcp-registry) nutzen.
Brauche ich Hopper, Ghidra oder IDA?
-Für tiefgehende native Analysen wird eines dieser Programme verwendet. Statische JavaScript- und .NET-Untersuchungen funktionieren ohne native Analyse-Engine. Die Einrichtung kann Hopper nach Zustimmung installieren; Ghidra und IDA nutzen deine vorhandenen Installationen. Siehe [Provider-Einrichtung](docs/installation.md#hopper).
+Für tiefgehende native Analysen wird eines dieser Programme verwendet. Statische JavaScript- und .NET-Untersuchungen funktionieren ohne native Analyse-Engine. Die Einrichtung kann Hopper nach Zustimmung installieren; Ghidra und IDA nutzen deine vorhandenen Installationen. Siehe [Provider-Einrichtung](../installation.md#hopper).
Muss ich Hopper vorher starten?
-REA startet Hopper, wenn eine Operation es benötigt. Unter macOS kann beim ersten Start ein Dialog erscheinen, in dem du den Demomodus auswählst oder deine Lizenz aktivierst. Siehe [Hopper-Start und Fehlerbehebung](docs/installation.md#launcher-paths-and-troubleshooting).
+REA startet Hopper, wenn eine Operation es benötigt. Unter macOS kann beim ersten Start ein Dialog erscheinen, in dem du den Demomodus auswählst oder deine Lizenz aktivierst. Siehe [Hopper-Start und Fehlerbehebung](../installation.md#launcher-paths-and-troubleshooting).
Was bewirkt die Installation des Skills über skills.sh?
-Der Skill stellt Untersuchungsanweisungen für deinen Agenten bereit. Verwende `npx rea-agents setup`, um den MCP-Server von REA zu registrieren und passende Anweisungen zu installieren. Starte deinen Agenten anschließend neu. Siehe [Installation nur des Skills](docs/installation.md#skill-only-installation).
+Der Skill stellt Untersuchungsanweisungen für deinen Agenten bereit. Verwende `npx rea-agents setup`, um den MCP-Server von REA zu registrieren und passende Anweisungen zu installieren. Starte deinen Agenten anschließend neu. Siehe [Installation nur des Skills](../installation.md#skill-only-installation).
@@ -251,14 +251,14 @@ Wenn du einen Agenten verwendest, schließe die [Aktualisierung der Einrichtung]
Beginne mit den [praxisnahen Anleitungen](https://rea.tools/de/guides/) auf der Website. Genaue Optionen, Voraussetzungen und Ergebniskontrakte findest du hier:
-- [Installation und Einrichtung](docs/installation.md): Agentenregistrierung, Provider-Konfiguration, Updates und Deinstallation.
-- [Bereitschaft und Fehlerbehebung](docs/installation.md#check-readiness-for-your-task): Diagnose eines bestimmten Agenten oder einer Analyse-Engine.
-- [CLI und Evidence](docs/cli.md): Befehle, Provider-Auswahl, Snapshots, Import/Export und Exit-Status.
-- [MCP-Kontrakte](docs/mcp-contracts.md) und [Agenten-Prompts](docs/mcp-prompts.md): Werkzeugergebnisse, Sitzungen und geführte Untersuchungen.
-- [Werkzeugkatalog](docs/mcp-contracts.md#generated-catalog): Beim Build erzeugtes Inventar von Werkzeugen, Providern und CLI-Befehlen.
-- [Roadmap](docs/roadmap.md): Geplante Arbeiten und Fortschrittsübersichten zu Fähigkeiten.
+- [Installation und Einrichtung](../installation.md): Agentenregistrierung, Provider-Konfiguration, Updates und Deinstallation.
+- [Bereitschaft und Fehlerbehebung](../installation.md#check-readiness-for-your-task): Diagnose eines bestimmten Agenten oder einer Analyse-Engine.
+- [CLI und Evidence](../cli.md): Befehle, Provider-Auswahl, Snapshots, Import/Export und Exit-Status.
+- [MCP-Kontrakte](../mcp-contracts.md) und [Agenten-Prompts](../mcp-prompts.md): Werkzeugergebnisse, Sitzungen und geführte Untersuchungen.
+- [Werkzeugkatalog](../mcp-contracts.md#generated-catalog): Beim Build erzeugtes Inventar von Werkzeugen, Providern und CLI-Befehlen.
+- [Roadmap](../roadmap.md): Geplante Arbeiten und Fortschrittsübersichten zu Fähigkeiten.
-Melde Sicherheitslücken gemäß [SECURITY.md](SECURITY.md).
+Melde Sicherheitslücken gemäß [SECURITY.md](../../SECURITY.md).
## Sternverlauf
@@ -276,7 +276,7 @@ Danke an alle, die REA nutzen, Fehler melden, Funktionswünsche äußern, Builds
## Haftungsausschluss
-Hinweise zur verantwortungsvollen Nutzung findest du in [DISCLAIMER.md](DISCLAIMER.md).
+Hinweise zur verantwortungsvollen Nutzung findest du in [DISCLAIMER.md](../../DISCLAIMER.md).
REA dient der rechtmäßigen Forschung, Bildung, Interoperabilität, Softwareerhaltung und Analyse von Software, die dir gehört oder die du mit entsprechender Genehmigung untersuchen darfst.
@@ -288,14 +288,14 @@ applicable licenses.
Wir freuen uns über deine Hilfe bei REA! [Öffne ein Issue](https://github.com/morluto/rea/issues), um einen Fehler zu melden oder eine Funktion vorzuschlagen, oder [sende einen Pull Request](https://github.com/morluto/rea/pulls), um Code oder Dokumentation zu verbessern.
-Die Entwicklungsumgebung und Prüfungen beschreibt [CONTRIBUTING.md](CONTRIBUTING.md), die Verifikationspfade der [Testleitfaden](docs/testing.md) und die Projektstruktur die [Architekturübersicht](docs/architecture.mermaid).
+Die Entwicklungsumgebung und Prüfungen beschreibt [CONTRIBUTING.md](../../CONTRIBUTING.md), die Verifikationspfade der [Testleitfaden](../testing.md) und die Projektstruktur die [Architekturübersicht](../architecture.mermaid).
## Lizenz
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_es.md b/docs/readme/README_es.md
similarity index 75%
rename from README_es.md
rename to docs/readme/README_es.md
index f955b5891..d09be25e2 100644
--- a/README_es.md
+++ b/docs/readme/README_es.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · **Español** · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · **Español** · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: Ingeniería inversa de cualquier cosa
@@ -9,10 +9,10 @@
**¿Ves una función que te gusta? Entiende cómo funciona, hasta el nivel binario.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Únete a la comunidad de ingeniería inversa
Discord · Preguntas y respuestas · Comparte tus resultados
@@ -67,7 +67,7 @@ npx rea-agents setup
Elige tus agentes, revisa los cambios propuestos y apruébalos. La configuración añade el servidor MCP de REA y las instrucciones de trabajo correspondientes, con copias de seguridad de la configuración existente. Reinicia tu agente al terminar.
-La configuración admite Claude Code, Codex, Cursor, Gemini CLI, Grok Build y [otros agentes](docs/installation.md#supported-agents). Consulta [instalación y configuración](docs/installation.md) para configurar proveedores y registrar MCP manualmente.
+La configuración admite Claude Code, Codex, Cursor, Gemini CLI, Grok Build y [otros agentes](../installation.md#supported-agents). Consulta [instalación y configuración](../installation.md) para configurar proveedores y registrar MCP manualmente.
### Pregunta a tu agente
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-Para el análisis nativo, configura primero un proveedor. Consulta la [guía de CLI y Evidence](docs/cli.md) para los comandos nativos, la selección de proveedores, las instantáneas y el uso en scripts.
+Para el análisis nativo, configura primero un proveedor. Consulta la [guía de CLI y Evidence](../cli.md) para los comandos nativos, la selección de proveedores, las instantáneas y el uso en scripts.
### Actualiza REA
@@ -120,9 +120,9 @@ Revisa los cambios de configuración y reinicia tu agente. Para ejecutar comando
Tu agente llama a REA mediante MCP para inspeccionar el objetivo y seguir el código relevante. REA devuelve los hallazgos junto con sus pruebas. El agente los utiliza para hacer preguntas de seguimiento, explicar el comportamiento o escribir y probar una implementación. Los comandos de CLI usan los mismos flujos de trabajo.
-
+
-[Abre la figura a tamaño completo](website/public/assets/figures/rea-investigation-flow.svg).
+[Abre la figura a tamaño completo](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ Tu agente llama a REA mediante MCP para inspeccionar el objetivo y seguir el có
REA requiere Node.js 22.x (>=22.19), 24.x (>=24.11) o 26+, además de npm. Las herramientas adicionales y los sistemas anfitriones compatibles dependen del objetivo:
-| Objetivo | Qué devuelve REA | Requisitos y guía |
-| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| Binarios nativos | Pseudocódigo, ensamblador, cadenas, símbolos, llamadas y referencias | Hopper, Ghidra o IDA; [análisis nativo](https://rea.tools/es/guides/native/) |
-| Estructura ELF sin ejecutar | Secciones, segmentos, símbolos/reubicaciones originales y posibles medidas de mitigación detectadas mediante análisis estático | pwntools proporcionado por quien llama, en Linux x64; [diagnóstico de binarios](docs/binary-diagnostics.md) |
-| Bytecode EVM | Selectores de despacho, desplazamientos en bytes, argumentos inferidos y mutabilidad | Entrada local con bytes sin procesar o representación hexadecimal, en Linux x64; [guía de EVM sin ejecutar](docs/evm-bytecode.md) |
-| Fallos de Linux registrados | Registros note sin procesar, registros/señales de cada hilo registrado y posibles correspondencias de memoria opcionales | pwntools proporcionado por quien llama, en Linux x64; GDB/pwndbg opcionales; [fallos registrados](docs/recorded-crashes.md) |
-| JavaScript / Electron | Módulos, importaciones, mapas de código fuente, rutas, IPC y relaciones con complementos nativos | Node.js y npm; [análisis de aplicaciones](https://rea.tools/es/guides/javascript/) |
-| Sitios web | Estructura de la página, scripts, observaciones de red y capturas de pantalla solicitadas | Un navegador de la familia Chrome; [análisis del navegador](https://rea.tools/es/guides/browser/) |
-| Capturas de red guardadas | Solicitudes, respuestas, contenido accesible de las cargas útiles y ubicaciones de origen | HAR; mitmdump en Linux para capturas en formato nativo de mitmproxy; [guía de capturas](docs/web-network-captures.md) |
-| Capturas de paquetes | Endpoints, DNS, TLS SNI, distribución de protocolos y solicitudes HTTP | tshark y capinfos suministrados por el autor de la llamada; [guía pcap](docs/pcap-analysis.md) |
-| Ensamblados .NET | Metadatos, instrucciones CIL, dependencias nativas declaradas y comparaciones de compilaciones | Inspección estática; [guía de código administrado](docs/managed-code-analysis.md) |
-| APK de Android | Declaraciones del manifiesto, clases, métodos descompilados y referencias | JADX sin interfaz gráfica y un JDK completo en Linux/macOS/Windows x64; [guía de Android](docs/android-analysis.md) |
-| Dispositivos Android | Dispositivos, paquetes, procesos, registros, volcados, capturas de pantalla y transferencias de APK/archivos | adb suministrado por el autor de la llamada (emulador o dispositivo); [guía de ADB](docs/adb-device-analysis.md) |
-| Proyectos JEB | Unidades de proyecto del motor, resúmenes de artefactos y pseudocódigo de tipos/métodos | Un cliente JEB iniciado por el autor de la llamada que sirve MCP, seleccionado con REA_JEB_MCP_URL; [guía de JEB](docs/jeb-analysis.md) |
-| Recursos de Android | Manifiesto decodificado, tablas de cadenas, idiomas y datos de versión | Lanzador de Apktool suministrado por el autor de la llamada; [guía de recursos](docs/apktool-resource-analysis.md) |
-| Aplicaciones Flutter | Hash de snapshot de Dart, resúmenes de bibliotecas por ABI y procedencia de compilación del motor | Ninguna (análisis APK estático); [guía de Flutter](docs/flutter-analysis.md) |
-| Firmware | Regiones, resultados de extracción y derivaciones al análisis nativo | Binwalk / Unblob en Linux; [guía de firmware](docs/firmware-analysis.md) |
-| Paquetes grabados | Campos seleccionados, valores repetidos, filtros y reglas de decodificación | Linux: TShark 4.x + prlimit; [guía de capturas](docs/packet-captures.md) |
-| Señales lógicas grabadas | Anotaciones del decodificador, rangos de muestras y diagnósticos | Linux: sigrok-cli 0.7.2 + prlimit; [guía de señales](docs/signal-recordings.md) |
-| Paquetes y recursos | Inventarios de archivos, resúmenes criptográficos, plists, estructura de paquetes de Apple y recursos extraídos | [Guía de artefactos y JavaScript](docs/javascript-artifact-reconstruction.md), [aplicaciones de Apple](docs/apple-application-analysis.md) |
-| Comportamiento de procesos | Salida de la terminal, interacciones, observaciones de salida y del sistema de archivos, y comparaciones entre ejecuciones | Linux/macOS con una PTY nativa; [captura de procesos](docs/process-capture.md) |
+| Objetivo | Qué devuelve REA | Requisitos y guía |
+| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
+| Binarios nativos | Pseudocódigo, ensamblador, cadenas, símbolos, llamadas y referencias | Hopper, Ghidra o IDA; [análisis nativo](https://rea.tools/es/guides/native/) |
+| Estructura ELF sin ejecutar | Secciones, segmentos, símbolos/reubicaciones originales y posibles medidas de mitigación detectadas mediante análisis estático | pwntools proporcionado por quien llama, en Linux x64; [diagnóstico de binarios](../binary-diagnostics.md) |
+| Bytecode EVM | Selectores de despacho, desplazamientos en bytes, argumentos inferidos y mutabilidad | Entrada local con bytes sin procesar o representación hexadecimal, en Linux x64; [guía de EVM sin ejecutar](../evm-bytecode.md) |
+| Fallos de Linux registrados | Registros note sin procesar, registros/señales de cada hilo registrado y posibles correspondencias de memoria opcionales | pwntools proporcionado por quien llama, en Linux x64; GDB/pwndbg opcionales; [fallos registrados](../recorded-crashes.md) |
+| JavaScript / Electron | Módulos, importaciones, mapas de código fuente, rutas, IPC y relaciones con complementos nativos | Node.js y npm; [análisis de aplicaciones](https://rea.tools/es/guides/javascript/) |
+| Sitios web | Estructura de la página, scripts, observaciones de red y capturas de pantalla solicitadas | Un navegador de la familia Chrome; [análisis del navegador](https://rea.tools/es/guides/browser/) |
+| Capturas de red guardadas | Solicitudes, respuestas, contenido accesible de las cargas útiles y ubicaciones de origen | HAR; mitmdump en Linux para capturas en formato nativo de mitmproxy; [guía de capturas](../web-network-captures.md) |
+| Capturas de paquetes | Endpoints, DNS, TLS SNI, distribución de protocolos y solicitudes HTTP | tshark y capinfos suministrados por el autor de la llamada; [guía pcap](../pcap-analysis.md) |
+| Ensamblados .NET | Metadatos, instrucciones CIL, dependencias nativas declaradas y comparaciones de compilaciones | Inspección estática; [guía de código administrado](../managed-code-analysis.md) |
+| APK de Android | Declaraciones del manifiesto, clases, métodos descompilados y referencias | JADX sin interfaz gráfica y un JDK completo en Linux/macOS/Windows x64; [guía de Android](../android-analysis.md) |
+| Dispositivos Android | Dispositivos, paquetes, procesos, registros, volcados, capturas de pantalla y transferencias de APK/archivos | adb suministrado por el autor de la llamada (emulador o dispositivo); [guía de ADB](../adb-device-analysis.md) |
+| Proyectos JEB | Unidades de proyecto del motor, resúmenes de artefactos y pseudocódigo de tipos/métodos | Un cliente JEB iniciado por el autor de la llamada que sirve MCP, seleccionado con REA_JEB_MCP_URL; [guía de JEB](../jeb-analysis.md) |
+| Recursos de Android | Manifiesto decodificado, tablas de cadenas, idiomas y datos de versión | Lanzador de Apktool suministrado por el autor de la llamada; [guía de recursos](../apktool-resource-analysis.md) |
+| Aplicaciones Flutter | Hash de snapshot de Dart, resúmenes de bibliotecas por ABI y procedencia de compilación del motor | Ninguna (análisis APK estático); [guía de Flutter](../flutter-analysis.md) |
+| Firmware | Regiones, resultados de extracción y derivaciones al análisis nativo | Binwalk / Unblob en Linux; [guía de firmware](../firmware-analysis.md) |
+| Paquetes grabados | Campos seleccionados, valores repetidos, filtros y reglas de decodificación | Linux: TShark 4.x + prlimit; [guía de capturas](../packet-captures.md) |
+| Señales lógicas grabadas | Anotaciones del decodificador, rangos de muestras y diagnósticos | Linux: sigrok-cli 0.7.2 + prlimit; [guía de señales](../signal-recordings.md) |
+| Paquetes y recursos | Inventarios de archivos, resúmenes criptográficos, plists, estructura de paquetes de Apple y recursos extraídos | [Guía de artefactos y JavaScript](../javascript-artifact-reconstruction.md), [aplicaciones de Apple](../apple-application-analysis.md) |
+| Comportamiento de procesos | Salida de la terminal, interacciones, observaciones de salida y del sistema de archivos, y comparaciones entre ejecuciones | Linux/macOS con una PTY nativa; [captura de procesos](../process-capture.md) |
La inspección estática de JavaScript y .NET lee los archivos suministrados sin ejecutar la aplicación. La captura en ejecución inicia el objetivo seleccionado o interactúa con él con los permisos de tu usuario; cada guía describe sus efectos.
-Los formatos nativos y los sistemas anfitriones compatibles varían según el proveedor. Consulta [configuración de Hopper y Ghidra](docs/installation.md#hopper), la [guía de IDA](docs/ida-provider.md) y la [compatibilidad experimental de Ghidra en Windows](docs/windows-ghidra-p0.md). Ghidra también admite [análisis de DOS de 16 bits](docs/ghidra-dos.md). Para elegir un proveedor, consulta la [guía de CLI](docs/cli.md#choose-a-provider). Comprueba la [disponibilidad por versión](docs/installation.md#released-package-and-main) de las funciones añadidas después de la última versión publicada en npm.
+Los formatos nativos y los sistemas anfitriones compatibles varían según el proveedor. Consulta [configuración de Hopper y Ghidra](../installation.md#hopper), la [guía de IDA](../ida-provider.md) y la [compatibilidad experimental de Ghidra en Windows](../windows-ghidra-p0.md). Ghidra también admite [análisis de DOS de 16 bits](../ghidra-dos.md). Para elegir un proveedor, consulta la [guía de CLI](../cli.md#choose-a-provider). Comprueba la [disponibilidad por versión](../installation.md#released-package-and-main) de las funciones añadidas después de la última versión publicada en npm.
## Casos prácticos
-[](https://rea.tools/es/showcase/)
+[](https://rea.tools/es/showcase/)
### DX-Ball: reconstruir un cálculo de panoramización de sonido
@@ -187,28 +187,28 @@ Si has usado REA para investigar algo interesante, nos gustaría verlo. Comparte
¿Qué agentes pueden usar REA?
-Cualquier agente que admita servidores MCP locales. La configuración prepara los [agentes compatibles](docs/installation.md#supported-agents); otros clientes pueden usar el [registro manual de MCP](docs/installation.md#mcp-registry).
+Cualquier agente que admita servidores MCP locales. La configuración prepara los [agentes compatibles](../installation.md#supported-agents); otros clientes pueden usar el [registro manual de MCP](../installation.md#mcp-registry).
¿Necesito Hopper, Ghidra o IDA?
-El análisis nativo en profundidad utiliza uno de ellos. La inspección estática de JavaScript y .NET funciona sin un motor de análisis nativo. La configuración puede instalar Hopper después de tu aprobación; Ghidra e IDA usan las instalaciones que ya tienes. Consulta [configuración de proveedores](docs/installation.md#hopper).
+El análisis nativo en profundidad utiliza uno de ellos. La inspección estática de JavaScript y .NET funciona sin un motor de análisis nativo. La configuración puede instalar Hopper después de tu aprobación; Ghidra e IDA usan las instalaciones que ya tienes. Consulta [configuración de proveedores](../installation.md#hopper).
¿Tengo que iniciar Hopper primero?
-REA inicia Hopper cuando una operación lo necesita. En macOS, puede aparecer un diálogo al iniciarlo por primera vez para elegir el modo de demostración o activar tu licencia. Consulta [inicio de Hopper y resolución de problemas](docs/installation.md#launcher-paths-and-troubleshooting).
+REA inicia Hopper cuando una operación lo necesita. En macOS, puede aparecer un diálogo al iniciarlo por primera vez para elegir el modo de demostración o activar tu licencia. Consulta [inicio de Hopper y resolución de problemas](../installation.md#launcher-paths-and-troubleshooting).
¿Qué hace la instalación de la skill desde skills.sh?
-La skill proporciona instrucciones de investigación a tu agente. Usa `npx rea-agents setup` para registrar el servidor MCP de REA e instalar las instrucciones correspondientes; después reinicia tu agente. Consulta [instalación solo de la skill](docs/installation.md#skill-only-installation).
+La skill proporciona instrucciones de investigación a tu agente. Usa `npx rea-agents setup` para registrar el servidor MCP de REA e instalar las instrucciones correspondientes; después reinicia tu agente. Consulta [instalación solo de la skill](../installation.md#skill-only-installation).
@@ -251,14 +251,14 @@ Si usas un agente, completa la [actualización de la configuración](#actualiza-
Empieza con las [guías prácticas](https://rea.tools/es/guides/) del sitio web. Para opciones exactas, requisitos y contratos de resultados:
-- [Instalación y configuración](docs/installation.md): registro de agentes, configuración de proveedores, actualizaciones y desinstalación.
-- [Preparación y resolución de problemas](docs/installation.md#check-readiness-for-your-task): diagnóstico de un agente o motor de análisis concreto.
-- [CLI y Evidence](docs/cli.md): comandos, selección de proveedores, instantáneas, importación/exportación y estados de salida.
-- [Contratos de MCP](docs/mcp-contracts.md) y [prompts para agentes](docs/mcp-prompts.md): resultados de herramientas, sesiones e investigaciones guiadas.
-- [Catálogo de herramientas](docs/mcp-contracts.md#generated-catalog): inventario de herramientas, proveedores y comandos de CLI generado durante la compilación.
-- [Hoja de ruta](docs/roadmap.md): trabajo previsto y seguimiento de capacidades.
+- [Instalación y configuración](../installation.md): registro de agentes, configuración de proveedores, actualizaciones y desinstalación.
+- [Preparación y resolución de problemas](../installation.md#check-readiness-for-your-task): diagnóstico de un agente o motor de análisis concreto.
+- [CLI y Evidence](../cli.md): comandos, selección de proveedores, instantáneas, importación/exportación y estados de salida.
+- [Contratos de MCP](../mcp-contracts.md) y [prompts para agentes](../mcp-prompts.md): resultados de herramientas, sesiones e investigaciones guiadas.
+- [Catálogo de herramientas](../mcp-contracts.md#generated-catalog): inventario de herramientas, proveedores y comandos de CLI generado durante la compilación.
+- [Hoja de ruta](../roadmap.md): trabajo previsto y seguimiento de capacidades.
-Informa de vulnerabilidades siguiendo [SECURITY.md](SECURITY.md).
+Informa de vulnerabilidades siguiendo [SECURITY.md](../../SECURITY.md).
## Historial de estrellas
@@ -276,7 +276,7 @@ Gracias a quienes usan REA, informan de errores, solicitan funciones, prueban co
## Aviso legal
-Consulta [DISCLAIMER.md](DISCLAIMER.md) para obtener orientación sobre el uso responsable.
+Consulta [DISCLAIMER.md](../../DISCLAIMER.md) para obtener orientación sobre el uso responsable.
REA está destinado a la investigación, la educación, la interoperabilidad, la preservación de software y el análisis de software propio o autorizado, dentro de la ley.
@@ -288,14 +288,14 @@ applicable licenses.
¡Nos encantaría que ayudaras con REA! [Abre una issue](https://github.com/morluto/rea/issues) para comunicar un error o proponer una función, o [envía una pull request](https://github.com/morluto/rea/pulls) para mejorar el código o la documentación.
-Consulta [CONTRIBUTING.md](CONTRIBUTING.md) para preparar el entorno de desarrollo y las comprobaciones, la [guía de pruebas](docs/testing.md) para los procesos de verificación y el [mapa de arquitectura](docs/architecture.mermaid) para la estructura del proyecto.
+Consulta [CONTRIBUTING.md](../../CONTRIBUTING.md) para preparar el entorno de desarrollo y las comprobaciones, la [guía de pruebas](../testing.md) para los procesos de verificación y el [mapa de arquitectura](../architecture.mermaid) para la estructura del proyecto.
## Licencia
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_fa.md b/docs/readme/README_fa.md
similarity index 74%
rename from README_fa.md
rename to docs/readme/README_fa.md
index 54af87c57..b24e4380c 100644
--- a/README_fa.md
+++ b/docs/readme/README_fa.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · **فارسی** · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · **فارسی** · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: مهندسی معکوس هر چیزی
@@ -9,27 +9,27 @@
**قابلیتی دیدهاید که دوستش دارید؟ سازوکارش را تا سطح باینری درک کنید.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

**[وبسایت](https://rea.tools/fa/) · [راهنماها](https://rea.tools/fa/guides/) · [نمونههای عملی](https://rea.tools/fa/showcase/)**
-[شروع سریع](#شروع-سریع) · [REA چگونه کار میکند؟](#rea-چگونه-کار-میکند) · [چه چیزهایی را میتوان تحلیل کرد؟](#چه-چیزهایی-را-میتوان-تحلیل-کرد) · [نمونههای عملی](#نمونههای-عملی) · [پرسشهای متداول](#پرسشهای-متداول) · [مستندات](#مستندات)
+[شروع سریع](#شروع-سریع) · [REA چگونه کار میکند؟](#rea-چگونه-کار-میکند) · [چه چیزهایی را میتوان تحلیل کرد؟](#چه-چیزهایی-را-میتوان-تحلیل-کرد) · [نمونههای عملی](#نمونههای-عملی) · [پرسشهای متداول](#پرسشهای-متداول) · [مستندات](#مستندات)
npx rea-agents setup
- 
+
-
+
@@ -59,7 +59,7 @@ npx rea-agents setup
ایجنتهای موردنظر را انتخاب کنید، تغییرات پیشنهادی را بررسی و تأیید کنید. فرایند راهاندازی، سرور MCP مربوط به REA و دستورالعملهای گردشکار متناظر را اضافه میکند و از پیکربندی موجود نسخهٔ پشتیبان میگیرد. پس از آن ایجنت خود را مجدداً راهاندازی کنید.
-راهاندازی از Claude Code، Codex، Cursor، Gemini CLI، Grok Build و [ایجنتهای دیگر](docs/installation.md#supported-agents) پشتیبانی میکند. برای پیکربندی ارائهدهنده و ثبت دستی MCP، [نصب و راهاندازی](docs/installation.md) را ببینید.
+راهاندازی از Claude Code، Codex، Cursor، Gemini CLI، Grok Build و [ایجنتهای دیگر](../installation.md#supported-agents) پشتیبانی میکند. برای پیکربندی ارائهدهنده و ثبت دستی MCP، [نصب و راهاندازی](../installation.md) را ببینید.
### از ایجنت خود بپرسید
@@ -86,7 +86,7 @@ npm install --global rea-agents
rea --help
```
-برای تحلیل بومی ابتدا یک ارائهدهنده پیکربندی کنید. برای دستورات بومی، انتخاب ارائهدهنده، snapshotها و اسکریپتنویسی، [راهنمای CLI و شواهد](docs/cli.md) را ببینید.
+برای تحلیل بومی ابتدا یک ارائهدهنده پیکربندی کنید. برای دستورات بومی، انتخاب ارائهدهنده، snapshotها و اسکریپتنویسی، [راهنمای CLI و شواهد](../cli.md) را ببینید.
### بهروزرسانی REA
@@ -112,9 +112,9 @@ npx rea-agents@latest setup
ایجنت شما از طریق MCP، REA را فراخوانی میکند تا هدف را بررسی و کد مرتبط را ردیابی کند. REA یافتهها را همراه با شواهد برمیگرداند. ایجنت از این نتایج برای طرح پرسشهای تکمیلی، توضیح رفتار یا نوشتن و آزمایش یک پیادهسازی استفاده میکند. دستورات CLI نیز از همین گردشکارها بهره میبرند.
-
+
-[نمایش تصویر در اندازهٔ کامل](website/public/assets/figures/rea-investigation-flow.svg).
+[نمایش تصویر در اندازهٔ کامل](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -122,37 +122,37 @@ npx rea-agents@latest setup
REA به Node.js 22.x (>=22.19)، 24.x (>=24.11) یا 26+، بههمراه npm نیاز دارد. ابزارهای اضافی و پشتیبانی سیستم میزبان به نوع هدف بستگی دارند:
-| هدف | خروجی REA | پیشنیازها و راهنما |
-| ---------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
-| باینریهای بومی | شبهکد، اسمبلی، رشتهها، نمادها، فراخوانیها و ارجاعات | Hopper، Ghidra یا IDA؛ [تحلیل بومی](https://rea.tools/fa/guides/native/) |
-| ساختار ELF آفلاین | بخشها، سگمنتها، نمادها و relocationهای اصلی و گزینههای احتمالی کاهش آسیبپذیری ایستا | pwntools تأمینشده توسط فراخواننده روی Linux x64؛ [تشخیص باینری](docs/binary-diagnostics.md) |
-| بایتکد EVM | selectorهای dispatch، offsetهای بایتی، آرگومانهای استنباطشده و قابلیت تغییر وضعیت | دادهٔ خام/hex محلی روی Linux x64؛ [راهنمای EVM آفلاین](docs/evm-bytecode.md) |
-| کرشهای ثبتشدهٔ لینوکس | یادداشتهای خام، رجیسترها/سیگنالهای تمام threadهای ثبتشده و گزینههای احتمالی نگاشت | pwntools تأمینشده توسط فراخواننده روی Linux x64؛ GDB/pwndbg اختیاری؛ [کرشهای ثبتشده](docs/recorded-crashes.md) |
-| JavaScript / Electron | ماژولها، importها، source mapها، مسیرها، IPC و ارتباط افزونههای بومی | Node.js و npm؛ [تحلیل برنامه](https://rea.tools/fa/guides/javascript/) |
-| وبسایتها | ساختار صفحه، اسکریپتها، مشاهدات شبکه و اسکرینشاتهای درخواستی | مرورگر مبتنی بر Chrome؛ [تحلیل مرورگر](https://rea.tools/fa/guides/browser/) |
-| دادههای ضبطشدهٔ شبکه | درخواستها، پاسخها، payloadهای آشکارشده و مکان آنها در منبع | HAR؛ ابزار mitmdump در لینوکس برای ضبطهای بومی mitmproxy؛ [راهنمای ضبط شبکه](docs/web-network-captures.md) |
-| اسمبلیهای .NET | فراداده، دستورالعملهای CIL، وابستگیهای بومی اعلامشده و مقایسهٔ buildها | بررسی ایستا؛ [راهنمای کد مدیریتشده](docs/managed-code-analysis.md) |
-| فایلهای APK اندروید | تعاریف Manifest، کلاسها، متدهای دیکامپایلشده و ارجاعات | JADX بدون رابط گرافیکی و JDK کامل در Linux/macOS/Windows x64؛ [راهنمای اندروید](docs/android-analysis.md) |
-| دستگاههای اندروید | دستگاهها، بستهها، فرایندها، لاگها، دامپها، اسکرینشاتها و انتقال APK/فایل | adb تأمینشده توسط فراخوانکننده (شبیهساز یا دستگاه)؛ [راهنمای ADB](docs/adb-device-analysis.md) |
-| پروژههای JEB | واحدهای پروژه از موتور، هشهای مصنوع و شبهکدِ نوع/متد | یک کلاینت JEB که توسط فراخوانکننده اجرا شده و MCP ارائه میدهد و با REA_JEB_MCP_URL انتخاب میشود؛ [راهنمای JEB](docs/jeb-analysis.md) |
-| منابع اندروید | مانیفست رمزگشاییشده، جداول رشتهها، زبانها و اطلاعات نسخه | راهانداز Apktool تأمینشده توسط فراخوانکننده؛ [راهنمای منابع](docs/apktool-resource-analysis.md) |
-| برنامههای فلاتر | هش اسنپشات دارت، هش کتابخانهها به تفکیک ABI و اصالت بیلد موتور | هیچ (تحلیل ایستا APK)؛ [راهنمای فلاتر](docs/flutter-analysis.md) |
-| Firmware | ناحیهها، نتایج استخراج و تحویل به ابزارهای تحلیل بومی | Binwalk / Unblob در لینوکس؛ [راهنمای Firmware](docs/firmware-analysis.md) |
-| بستههای ضبطشده | فیلدهای منتخب، مقادیر تکراری، فیلترها و قواعد رمزگشایی | Linux: TShark 4.x + prlimit; [راهنمای ضبط بسته](docs/packet-captures.md) |
-| ضبط بستهها | نقاط پایانی، DNS، TLS SNI، توزیع پروتکل و درخواستهای HTTP | tshark و capinfos تأمینشده توسط فراخوانکننده؛ [راهنمای pcap](docs/pcap-analysis.md) |
-| سیگنالهای منطقی ضبطشده | توضیحات رمزگشا، بازههای نمونه و اطلاعات عیبیابی | Linux: sigrok-cli 0.7.2 + prlimit; [راهنمای سیگنالها](docs/signal-recordings.md) |
-| بستهها و منابع | فهرست فایلها، digestها، فایلهای plist، ساختار bundle اپل و منابع استخراجشده | [راهنمای آرتیفکت و JavaScript](docs/javascript-artifact-reconstruction.md)، [برنامههای اپل](docs/apple-application-analysis.md) |
-| رفتار فرایند | خروجی ترمینال، تعاملات، وضعیت خروج، مشاهدات سیستم فایل و مقایسهٔ اجراها | Linux/macOS با PTY بومی؛ [ضبط فرایند](docs/process-capture.md) |
+| هدف | خروجی REA | پیشنیازها و راهنما |
+| ---------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| باینریهای بومی | شبهکد، اسمبلی، رشتهها، نمادها، فراخوانیها و ارجاعات | Hopper، Ghidra یا IDA؛ [تحلیل بومی](https://rea.tools/fa/guides/native/) |
+| ساختار ELF آفلاین | بخشها، سگمنتها، نمادها و relocationهای اصلی و گزینههای احتمالی کاهش آسیبپذیری ایستا | pwntools تأمینشده توسط فراخواننده روی Linux x64؛ [تشخیص باینری](../binary-diagnostics.md) |
+| بایتکد EVM | selectorهای dispatch، offsetهای بایتی، آرگومانهای استنباطشده و قابلیت تغییر وضعیت | دادهٔ خام/hex محلی روی Linux x64؛ [راهنمای EVM آفلاین](../evm-bytecode.md) |
+| کرشهای ثبتشدهٔ لینوکس | یادداشتهای خام، رجیسترها/سیگنالهای تمام threadهای ثبتشده و گزینههای احتمالی نگاشت | pwntools تأمینشده توسط فراخواننده روی Linux x64؛ GDB/pwndbg اختیاری؛ [کرشهای ثبتشده](../recorded-crashes.md) |
+| JavaScript / Electron | ماژولها، importها، source mapها، مسیرها، IPC و ارتباط افزونههای بومی | Node.js و npm؛ [تحلیل برنامه](https://rea.tools/fa/guides/javascript/) |
+| وبسایتها | ساختار صفحه، اسکریپتها، مشاهدات شبکه و اسکرینشاتهای درخواستی | مرورگر مبتنی بر Chrome؛ [تحلیل مرورگر](https://rea.tools/fa/guides/browser/) |
+| دادههای ضبطشدهٔ شبکه | درخواستها، پاسخها، payloadهای آشکارشده و مکان آنها در منبع | HAR؛ ابزار mitmdump در لینوکس برای ضبطهای بومی mitmproxy؛ [راهنمای ضبط شبکه](../web-network-captures.md) |
+| اسمبلیهای .NET | فراداده، دستورالعملهای CIL، وابستگیهای بومی اعلامشده و مقایسهٔ buildها | بررسی ایستا؛ [راهنمای کد مدیریتشده](../managed-code-analysis.md) |
+| فایلهای APK اندروید | تعاریف Manifest، کلاسها، متدهای دیکامپایلشده و ارجاعات | JADX بدون رابط گرافیکی و JDK کامل در Linux/macOS/Windows x64؛ [راهنمای اندروید](../android-analysis.md) |
+| دستگاههای اندروید | دستگاهها، بستهها، فرایندها، لاگها، دامپها، اسکرینشاتها و انتقال APK/فایل | adb تأمینشده توسط فراخوانکننده (شبیهساز یا دستگاه)؛ [راهنمای ADB](../adb-device-analysis.md) |
+| پروژههای JEB | واحدهای پروژه از موتور، هشهای مصنوع و شبهکدِ نوع/متد | یک کلاینت JEB که توسط فراخوانکننده اجرا شده و MCP ارائه میدهد و با REA_JEB_MCP_URL انتخاب میشود؛ [راهنمای JEB](../jeb-analysis.md) |
+| منابع اندروید | مانیفست رمزگشاییشده، جداول رشتهها، زبانها و اطلاعات نسخه | راهانداز Apktool تأمینشده توسط فراخوانکننده؛ [راهنمای منابع](../apktool-resource-analysis.md) |
+| برنامههای فلاتر | هش اسنپشات دارت، هش کتابخانهها به تفکیک ABI و اصالت بیلد موتور | هیچ (تحلیل ایستا APK)؛ [راهنمای فلاتر](../flutter-analysis.md) |
+| Firmware | ناحیهها، نتایج استخراج و تحویل به ابزارهای تحلیل بومی | Binwalk / Unblob در لینوکس؛ [راهنمای Firmware](../firmware-analysis.md) |
+| بستههای ضبطشده | فیلدهای منتخب، مقادیر تکراری، فیلترها و قواعد رمزگشایی | Linux: TShark 4.x + prlimit; [راهنمای ضبط بسته](../packet-captures.md) |
+| ضبط بستهها | نقاط پایانی، DNS، TLS SNI، توزیع پروتکل و درخواستهای HTTP | tshark و capinfos تأمینشده توسط فراخوانکننده؛ [راهنمای pcap](../pcap-analysis.md) |
+| سیگنالهای منطقی ضبطشده | توضیحات رمزگشا، بازههای نمونه و اطلاعات عیبیابی | Linux: sigrok-cli 0.7.2 + prlimit; [راهنمای سیگنالها](../signal-recordings.md) |
+| بستهها و منابع | فهرست فایلها، digestها، فایلهای plist، ساختار bundle اپل و منابع استخراجشده | [راهنمای آرتیفکت و JavaScript](../javascript-artifact-reconstruction.md)، [برنامههای اپل](../apple-application-analysis.md) |
+| رفتار فرایند | خروجی ترمینال، تعاملات، وضعیت خروج، مشاهدات سیستم فایل و مقایسهٔ اجراها | Linux/macOS با PTY بومی؛ [ضبط فرایند](../process-capture.md) |
بررسی ایستای JavaScript و .NET فایلهای ارائهشده را بدون اجرای برنامه میخواند. ضبط زمان اجرا، هدف انتخابشده را با مجوزهای کاربری شما اجرا میکند یا با آن تعامل دارد؛ آثار این عملیات در راهنمای مربوط به هر نوع ضبط توضیح داده شدهاند.
-فرمتهای بومی و پشتیبانی سیستم میزبان بر اساس ارائهدهنده متفاوتاند. [راهاندازی Hopper و Ghidra](docs/installation.md#hopper)، [راهنمای IDA](docs/ida-provider.md) و [پشتیبانی آزمایشی Ghidra در ویندوز](docs/windows-ghidra-p0.md) را ببینید. Ghidra همچنین از [تحلیل DOS شانزدهبیتی](docs/ghidra-dos.md) پشتیبانی میکند. برای انتخاب ارائهدهنده، به [راهنمای CLI](docs/cli.md#choose-a-provider) مراجعه کنید. برای قابلیتهایی که پس از آخرین انتشار npm اضافه شدهاند، [وضعیت انتشار](docs/installation.md#released-package-and-main) را بررسی کنید.
+فرمتهای بومی و پشتیبانی سیستم میزبان بر اساس ارائهدهنده متفاوتاند. [راهاندازی Hopper و Ghidra](../installation.md#hopper)، [راهنمای IDA](../ida-provider.md) و [پشتیبانی آزمایشی Ghidra در ویندوز](../windows-ghidra-p0.md) را ببینید. Ghidra همچنین از [تحلیل DOS شانزدهبیتی](../ghidra-dos.md) پشتیبانی میکند. برای انتخاب ارائهدهنده، به [راهنمای CLI](../cli.md#choose-a-provider) مراجعه کنید. برای قابلیتهایی که پس از آخرین انتشار npm اضافه شدهاند، [وضعیت انتشار](../installation.md#released-package-and-main) را بررسی کنید.
## نمونههای عملی
-[](https://rea.tools/fa/showcase/)
+[](https://rea.tools/fa/showcase/)
### DX-Ball: بازسازی محاسبهٔ موقعیت استریوی صدا
@@ -178,31 +178,31 @@ API کلیپبورد در renderer را پیدا کنید، مسیر آن ر
کدام ایجنتها میتوانند از REA استفاده کنند؟
-هر ایجنتی که از سرورهای MCP محلی پشتیبانی کند. فرایند setup، [ایجنتهای پشتیبانیشده](docs/installation.md#supported-agents) را پیکربندی میکند؛ سایر کلاینتها میتوانند از [ثبت دستی MCP](docs/installation.md#mcp-registry) استفاده کنند.
+هر ایجنتی که از سرورهای MCP محلی پشتیبانی کند. فرایند setup، [ایجنتهای پشتیبانیشده](../installation.md#supported-agents) را پیکربندی میکند؛ سایر کلاینتها میتوانند از [ثبت دستی MCP](../installation.md#mcp-registry) استفاده کنند.
آیا به Hopper، Ghidra یا IDA نیاز دارم؟
-تحلیل عمیق بومی به یکی از آنها نیاز دارد. بررسی ایستای JavaScript و .NET بدون موتور تحلیل بومی کار میکند. setup میتواند با تأیید شما Hopper را نصب کند؛ Ghidra و IDA از نصبهای موجود شما استفاده میکنند. [راهاندازی ارائهدهنده](docs/installation.md#hopper) را ببینید.
+تحلیل عمیق بومی به یکی از آنها نیاز دارد. بررسی ایستای JavaScript و .NET بدون موتور تحلیل بومی کار میکند. setup میتواند با تأیید شما Hopper را نصب کند؛ Ghidra و IDA از نصبهای موجود شما استفاده میکنند. [راهاندازی ارائهدهنده](../installation.md#hopper) را ببینید.
آیا باید ابتدا Hopper را اجرا کنم؟
-REA زمانی که عملیاتی به Hopper نیاز داشته باشد آن را اجرا میکند. در macOS، ممکن است هنگام نخستین اجرا پنجرهای برای انتخاب حالت آزمایشی یا فعالسازی مجوز نمایش داده شود. [راهاندازی Hopper و رفع اشکال](docs/installation.md#launcher-paths-and-troubleshooting) را ببینید.
+REA زمانی که عملیاتی به Hopper نیاز داشته باشد آن را اجرا میکند. در macOS، ممکن است هنگام نخستین اجرا پنجرهای برای انتخاب حالت آزمایشی یا فعالسازی مجوز نمایش داده شود. [راهاندازی Hopper و رفع اشکال](../installation.md#launcher-paths-and-troubleshooting) را ببینید.
نصب skill از skills.sh چه کاری انجام میدهد؟
-این skill دستورالعملهای بررسی را برای ایجنت فراهم میکند. برای ثبت سرور MCP مربوط به REA و نصب دستورالعملهای متناظر، `npx rea-agents setup` را اجرا کنید و سپس ایجنت را مجدداً راهاندازی کنید. [نصب مستقل skill](docs/installation.md#skill-only-installation) را ببینید.
+این skill دستورالعملهای بررسی را برای ایجنت فراهم میکند. برای ثبت سرور MCP مربوط به REA و نصب دستورالعملهای متناظر، `npx rea-agents setup` را اجرا کنید و سپس ایجنت را مجدداً راهاندازی کنید. [نصب مستقل skill](../installation.md#skill-only-installation) را ببینید.
REA چه نوع کدی برمیگرداند؟
-تحلیل بومی، شبهکد و اسمبلی برمیگرداند. تحلیل JavaScript/Electron ماژولها و روابط میان آنها را بازیابی میکند. ایجنت شما از این یافتهها برای نوشتن و آزمایش یک پیادهسازی استفاده میکند؛ [نمونههای عملی](#نمونههای-عملی) مثالهای گامبهگام ارائه میدهند.
+تحلیل بومی، شبهکد و اسمبلی برمیگرداند. تحلیل JavaScript/Electron ماژولها و روابط میان آنها را بازیابی میکند. ایجنت شما از این یافتهها برای نوشتن و آزمایش یک پیادهسازی استفاده میکند؛ [نمونههای عملی](#نمونههای-عملی) مثالهای گامبهگام ارائه میدهند.
@@ -228,7 +228,7 @@ rea update
npx rea-agents@latest setup
```
-اگر از ایجنت استفاده میکنید، [بهروزرسانی راهاندازی](#بهروزرسانی-rea) را تکمیل و ایجنت را مجدداً اجرا کنید. همان کار را دوباره امتحان کنید. اگر مشکل ادامه داشت، یک [issue ثبت کنید](https://github.com/morluto/rea/issues) و نسخهٔ REA، نوع هدف، مراحل بازتولید و خروجی خطا را ذکر کنید.
+اگر از ایجنت استفاده میکنید، [بهروزرسانی راهاندازی](#بهروزرسانی-rea) را تکمیل و ایجنت را مجدداً اجرا کنید. همان کار را دوباره امتحان کنید. اگر مشکل ادامه داشت، یک [issue ثبت کنید](https://github.com/morluto/rea/issues) و نسخهٔ REA، نوع هدف، مراحل بازتولید و خروجی خطا را ذکر کنید.
@@ -236,14 +236,14 @@ npx rea-agents@latest setup
از [راهنماهای عملی وبسایت](https://rea.tools/fa/guides/) شروع کنید. برای گزینههای دقیق، پیشنیازها و قراردادهای خروجی:
-- [نصب و راهاندازی](docs/installation.md): ثبت ایجنت، پیکربندی ارائهدهنده، بهروزرسانی و حذف نصب.
-- [آمادگی و رفع اشکال](docs/installation.md#check-readiness-for-your-task): عیبیابی یک ایجنت یا موتور تحلیل.
-- [CLI و شواهد](docs/cli.md): دستورات، انتخاب ارائهدهنده، snapshotها، ورود/خروج داده و وضعیتهای خروج.
-- [قراردادهای MCP](docs/mcp-contracts.md) و [پرامپتهای ایجنت](docs/mcp-prompts.md): نتایج ابزارها، نشستها و بررسیهای هدایتشده.
-- [فهرست ابزارها](docs/mcp-contracts.md#generated-catalog): فهرست تولیدشده هنگام build از ابزارها، ارائهدهندگان و دستورات CLI.
-- [نقشهٔ راه](docs/roadmap.md): برنامههای آینده و پیگیری قابلیتها.
+- [نصب و راهاندازی](../installation.md): ثبت ایجنت، پیکربندی ارائهدهنده، بهروزرسانی و حذف نصب.
+- [آمادگی و رفع اشکال](../installation.md#check-readiness-for-your-task): عیبیابی یک ایجنت یا موتور تحلیل.
+- [CLI و شواهد](../cli.md): دستورات، انتخاب ارائهدهنده، snapshotها، ورود/خروج داده و وضعیتهای خروج.
+- [قراردادهای MCP](../mcp-contracts.md) و [پرامپتهای ایجنت](../mcp-prompts.md): نتایج ابزارها، نشستها و بررسیهای هدایتشده.
+- [فهرست ابزارها](../mcp-contracts.md#generated-catalog): فهرست تولیدشده هنگام build از ابزارها، ارائهدهندگان و دستورات CLI.
+- [نقشهٔ راه](../roadmap.md): برنامههای آینده و پیگیری قابلیتها.
-آسیبپذیریها را از طریق [SECURITY.md](SECURITY.md) گزارش کنید.
+آسیبپذیریها را از طریق [SECURITY.md](../../SECURITY.md) گزارش کنید.
## تاریخچهٔ ستارهها
@@ -255,7 +255,7 @@ npx rea-agents@latest setup
## سلب مسئولیت
-برای راهنمای استفادهٔ مسئولانه، [DISCLAIMER.md](DISCLAIMER.md) را ببینید.
+برای راهنمای استفادهٔ مسئولانه، [DISCLAIMER.md](../../DISCLAIMER.md) را ببینید.
REA برای پژوهش، آموزش، تعاملپذیری، حفظ نرمافزار و تحلیل نرمافزارهایی است که مالک آنها هستید یا اجازهٔ بررسی آنها را دارید، در چارچوب قانون.
@@ -267,14 +267,14 @@ applicable licenses.
از کمک شما به REA استقبال میکنیم! برای گزارش خطا یا پیشنهاد قابلیت، یک [issue باز کنید](https://github.com/morluto/rea/issues) یا برای بهبود کد و مستندات [pull request بفرستید](https://github.com/morluto/rea/pulls).
-برای راهاندازی محیط توسعه و بررسیها، [CONTRIBUTING.md](CONTRIBUTING.md)، برای مراحل اعتبارسنجی [آزمایشها](docs/testing.md) و برای ساختار پروژه [نقشهٔ معماری](docs/architecture.mermaid) را ببینید.
+برای راهاندازی محیط توسعه و بررسیها، [CONTRIBUTING.md](../../CONTRIBUTING.md)، برای مراحل اعتبارسنجی [آزمایشها](../testing.md) و برای ساختار پروژه [نقشهٔ معماری](../architecture.mermaid) را ببینید.
## مجوز
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_fr.md b/docs/readme/README_fr.md
similarity index 76%
rename from README_fr.md
rename to docs/readme/README_fr.md
index 346210525..e6278ac93 100644
--- a/README_fr.md
+++ b/docs/readme/README_fr.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · **Français** · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · **Français** · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA : rétro-ingénierie de tout
@@ -9,10 +9,10 @@
**Repérez une fonctionnalité qui vous plaît. Comprenez son fonctionnement, jusqu'au niveau du binaire.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Rejoignez la communauté de rétro-ingénierie
Discord · Questions et réponses · Partage de projets
@@ -67,7 +67,7 @@ npx rea-agents setup
Choisissez vos agents, vérifiez les modifications proposées et approuvez-les. Setup ajoute le serveur MCP de REA et les instructions de workflow correspondantes, et sauvegarde la configuration existante. Redémarrez ensuite votre agent.
-Setup prend en charge Claude Code, Codex, Cursor, Gemini CLI, Grok Build et [d'autres agents](docs/installation.md#supported-agents). Consultez [Installation et configuration](docs/installation.md) pour la configuration des fournisseurs et l'enregistrement MCP manuel.
+Setup prend en charge Claude Code, Codex, Cursor, Gemini CLI, Grok Build et [d'autres agents](../installation.md#supported-agents). Consultez [Installation et configuration](../installation.md) pour la configuration des fournisseurs et l'enregistrement MCP manuel.
### Interroger votre agent
@@ -95,7 +95,7 @@ npm install --global rea-agents
rea --help
```
-Pour l'analyse native, configurez d'abord un fournisseur. Consultez le [guide CLI et Evidence](docs/cli.md) pour les commandes natives, le choix du fournisseur, les snapshots et l'utilisation dans des scripts.
+Pour l'analyse native, configurez d'abord un fournisseur. Consultez le [guide CLI et Evidence](../cli.md) pour les commandes natives, le choix du fournisseur, les snapshots et l'utilisation dans des scripts.
### Mettre à jour REA
@@ -123,9 +123,9 @@ Vérifiez les modifications proposées par Setup et redémarrez votre agent. Pou
Votre agent appelle REA via MCP pour inspecter la cible et suivre le code pertinent. REA renvoie ses constatations avec les preuves correspondantes. L'agent s'en sert pour poser des questions complémentaires, expliquer le comportement, ou écrire et tester une implémentation. Les commandes CLI utilisent les mêmes workflows.
-
+
-[Ouvrir la figure en taille réelle](website/public/assets/figures/rea-investigation-flow.svg).
+[Ouvrir la figure en taille réelle](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -133,38 +133,38 @@ Votre agent appelle REA via MCP pour inspecter la cible et suivre le code pertin
REA nécessite Node.js 22.x (>=22.19), 24.x (>=24.11) ou 26+, ainsi que npm. Les outils supplémentaires et les hôtes pris en charge dépendent de la cible :
-| Cible | Ce que REA renvoie | Prérequis et guide |
-| ---------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
-| Binaires natifs | Pseudo-code, assembleur, chaînes, symboles, appels et références | Hopper, Ghidra ou IDA ; [analyse native](https://rea.tools/fr/guides/native/) |
-| Structure ELF hors ligne | Sections, segments, symboles et relocations d'origine, et protections statiques candidates | pwntools fourni par l'utilisateur sous Linux x64 ; [diagnostics binaires](docs/binary-diagnostics.md) |
-| Artefact WASM | Validation, sections, formes WAT exactes d'import/export et WAT décodé | WABT 1.0.42 fourni par l'utilisateur ; `inspect_wasm_artifact` |
-| Bytecode EVM | Sélecteurs de dispatch, offsets en octets, arguments inférés et mutabilité | Fichier local brut ou hexadécimal sous Linux x64 ; [guide EVM hors ligne](docs/evm-bytecode.md) |
-| Crashs Linux enregistrés | Notes brutes, registres et signaux de chaque thread enregistré, et correspondances de mappings facultatives | pwntools fourni par l'utilisateur sous Linux x64 ; GDB/pwndbg en option ; [crashs enregistrés](docs/recorded-crashes.md) |
-| JavaScript / Electron | Modules, imports, source maps, routes, IPC et relations avec les modules natifs | Node.js et npm ; [analyse d'applications](https://rea.tools/fr/guides/javascript/) |
-| Sites web | Structure des pages, scripts, observations réseau et captures d'écran demandées | Un navigateur de la famille Chrome ; [analyse du navigateur](https://rea.tools/fr/guides/browser/) |
-| Captures réseau enregistrées | Requêtes, réponses, payloads exposés et emplacements dans le code source | HAR ; mitmdump sous Linux pour les captures mitmproxy natives ; [guide des captures](docs/web-network-captures.md) |
-| Captures de paquets | Points de terminaison, DNS, TLS SNI, distribution des protocoles et requêtes HTTP | tshark et capinfos fournis par l'appelant ; [guide pcap](docs/pcap-analysis.md) |
-| Assemblys .NET | Métadonnées, instructions CIL, dépendances natives déclarées et comparaisons de builds | Inspection statique ; [guide du code managé](docs/managed-code-analysis.md) |
-| APK Android | Déclarations du manifeste, classes, méthodes décompilées et références | JADX headless et un JDK complet sous Linux/macOS/Windows x64 ; [guide Android](docs/android-analysis.md) |
-| Appareils Android | Appareils, paquets, processus, journaux, dumps, captures d'écran et transferts d'APK/fichiers | adb fourni par l'appelant (émulateur ou appareil) ; [guide ADB](docs/adb-device-analysis.md) |
-| Projets JEB | Unités de projet fournies par le moteur, condensés d'artefacts et pseudo-code de types/méthodes | Un client JEB démarré par l'appelant servant MCP, sélectionné via REA_JEB_MCP_URL ; [guide JEB](docs/jeb-analysis.md) |
-| Ressources Android | Manifeste décodé, tables de chaînes, langues et faits de version | Lanceur Apktool fourni par l'appelant ; [guide des ressources](docs/apktool-resource-analysis.md) |
-| Applications Flutter | Empreinte de snapshot Dart, condensés de bibliothèques par ABI et provenance de build du moteur | Aucune (analyse APK statique) ; [guide Flutter](docs/flutter-analysis.md) |
-| Firmware | Régions, résultats d'extraction et passage de relais vers l'analyse native | Binwalk / Unblob sous Linux ; [guide firmware](docs/firmware-analysis.md) |
-| Paquets enregistrés | Champs sélectionnés, valeurs répétées, filtres et règles de décodage | Linux: TShark 4.x + prlimit; [guide des captures](docs/packet-captures.md) |
-| Signaux logiques enregistrés | Annotations du décodeur, plages d’échantillons et diagnostics | Linux: sigrok-cli 0.7.2 + prlimit; [guide des signaux](docs/signal-recordings.md) |
-| Paquets et ressources | Inventaires de fichiers, empreintes, plists, anatomie des bundles Apple et ressources extraites | [Guide artefacts et JavaScript](docs/javascript-artifact-reconstruction.md), [applications Apple](docs/apple-application-analysis.md) |
-| Comportement des processus | Sortie du terminal, interactions, code de sortie, observations du système de fichiers et comparaisons | Linux/macOS avec un PTY natif ; [capture de processus](docs/process-capture.md) |
+| Cible | Ce que REA renvoie | Prérequis et guide |
+| ---------------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| Binaires natifs | Pseudo-code, assembleur, chaînes, symboles, appels et références | Hopper, Ghidra ou IDA ; [analyse native](https://rea.tools/fr/guides/native/) |
+| Structure ELF hors ligne | Sections, segments, symboles et relocations d'origine, et protections statiques candidates | pwntools fourni par l'utilisateur sous Linux x64 ; [diagnostics binaires](../binary-diagnostics.md) |
+| Artefact WASM | Validation, sections, formes WAT exactes d'import/export et WAT décodé | WABT 1.0.42 fourni par l'utilisateur ; `inspect_wasm_artifact` |
+| Bytecode EVM | Sélecteurs de dispatch, offsets en octets, arguments inférés et mutabilité | Fichier local brut ou hexadécimal sous Linux x64 ; [guide EVM hors ligne](../evm-bytecode.md) |
+| Crashs Linux enregistrés | Notes brutes, registres et signaux de chaque thread enregistré, et correspondances de mappings facultatives | pwntools fourni par l'utilisateur sous Linux x64 ; GDB/pwndbg en option ; [crashs enregistrés](../recorded-crashes.md) |
+| JavaScript / Electron | Modules, imports, source maps, routes, IPC et relations avec les modules natifs | Node.js et npm ; [analyse d'applications](https://rea.tools/fr/guides/javascript/) |
+| Sites web | Structure des pages, scripts, observations réseau et captures d'écran demandées | Un navigateur de la famille Chrome ; [analyse du navigateur](https://rea.tools/fr/guides/browser/) |
+| Captures réseau enregistrées | Requêtes, réponses, payloads exposés et emplacements dans le code source | HAR ; mitmdump sous Linux pour les captures mitmproxy natives ; [guide des captures](../web-network-captures.md) |
+| Captures de paquets | Points de terminaison, DNS, TLS SNI, distribution des protocoles et requêtes HTTP | tshark et capinfos fournis par l'appelant ; [guide pcap](../pcap-analysis.md) |
+| Assemblys .NET | Métadonnées, instructions CIL, dépendances natives déclarées et comparaisons de builds | Inspection statique ; [guide du code managé](../managed-code-analysis.md) |
+| APK Android | Déclarations du manifeste, classes, méthodes décompilées et références | JADX headless et un JDK complet sous Linux/macOS/Windows x64 ; [guide Android](../android-analysis.md) |
+| Appareils Android | Appareils, paquets, processus, journaux, dumps, captures d'écran et transferts d'APK/fichiers | adb fourni par l'appelant (émulateur ou appareil) ; [guide ADB](../adb-device-analysis.md) |
+| Projets JEB | Unités de projet fournies par le moteur, condensés d'artefacts et pseudo-code de types/méthodes | Un client JEB démarré par l'appelant servant MCP, sélectionné via REA_JEB_MCP_URL ; [guide JEB](../jeb-analysis.md) |
+| Ressources Android | Manifeste décodé, tables de chaînes, langues et faits de version | Lanceur Apktool fourni par l'appelant ; [guide des ressources](../apktool-resource-analysis.md) |
+| Applications Flutter | Empreinte de snapshot Dart, condensés de bibliothèques par ABI et provenance de build du moteur | Aucune (analyse APK statique) ; [guide Flutter](../flutter-analysis.md) |
+| Firmware | Régions, résultats d'extraction et passage de relais vers l'analyse native | Binwalk / Unblob sous Linux ; [guide firmware](../firmware-analysis.md) |
+| Paquets enregistrés | Champs sélectionnés, valeurs répétées, filtres et règles de décodage | Linux: TShark 4.x + prlimit; [guide des captures](../packet-captures.md) |
+| Signaux logiques enregistrés | Annotations du décodeur, plages d’échantillons et diagnostics | Linux: sigrok-cli 0.7.2 + prlimit; [guide des signaux](../signal-recordings.md) |
+| Paquets et ressources | Inventaires de fichiers, empreintes, plists, anatomie des bundles Apple et ressources extraites | [Guide artefacts et JavaScript](../javascript-artifact-reconstruction.md), [applications Apple](../apple-application-analysis.md) |
+| Comportement des processus | Sortie du terminal, interactions, code de sortie, observations du système de fichiers et comparaisons | Linux/macOS avec un PTY natif ; [capture de processus](../process-capture.md) |
L'inspection statique JavaScript et .NET lit les fichiers fournis sans exécuter l'application. La capture à l'exécution lance la cible choisie ou interagit avec elle avec vos permissions utilisateur ; chaque guide d'exécution décrit ses effets.
-Les formats natifs et les hôtes pris en charge varient selon le fournisseur. Consultez [la configuration de Hopper et Ghidra](docs/installation.md#hopper), le [guide IDA](docs/ida-provider.md) et [la prise en charge expérimentale de Ghidra sous Windows](docs/windows-ghidra-p0.md). Ghidra prend aussi en charge [l'analyse DOS 16 bits](docs/ghidra-dos.md). Pour les gros binaires, augmentez son délai de démarrage avec `REA_GHIDRA_STARTUP_TIMEOUT_MS`. Pour le choix du fournisseur, consultez le [guide CLI](docs/cli.md#choose-a-provider). Vérifiez la [disponibilité dans les versions publiées](docs/installation.md#released-package-and-main) pour les fonctionnalités ajoutées depuis la dernière version npm.
+Les formats natifs et les hôtes pris en charge varient selon le fournisseur. Consultez [la configuration de Hopper et Ghidra](../installation.md#hopper), le [guide IDA](../ida-provider.md) et [la prise en charge expérimentale de Ghidra sous Windows](../windows-ghidra-p0.md). Ghidra prend aussi en charge [l'analyse DOS 16 bits](../ghidra-dos.md). Pour les gros binaires, augmentez son délai de démarrage avec `REA_GHIDRA_STARTUP_TIMEOUT_MS`. Pour le choix du fournisseur, consultez le [guide CLI](../cli.md#choose-a-provider). Vérifiez la [disponibilité dans les versions publiées](../installation.md#released-package-and-main) pour les fonctionnalités ajoutées depuis la dernière version npm.
## Études de cas
-[](https://rea.tools/fr/showcase/)
+[](https://rea.tools/fr/showcase/)
### DX-Ball : reconstruire un calcul de panoramique sonore
@@ -191,28 +191,28 @@ Si vous avez utilisé REA sur un projet intéressant, nous serions ravis de le d
Quels agents peuvent utiliser REA ?
-Tout agent compatible avec les serveurs MCP locaux. Setup configure les [agents pris en charge](docs/installation.md#supported-agents) ; les autres clients peuvent utiliser [l'enregistrement MCP manuel](docs/installation.md#mcp-registry).
+Tout agent compatible avec les serveurs MCP locaux. Setup configure les [agents pris en charge](../installation.md#supported-agents) ; les autres clients peuvent utiliser [l'enregistrement MCP manuel](../installation.md#mcp-registry).
Ai-je besoin de Hopper, Ghidra ou IDA ?
-L'analyse native approfondie utilise l'un d'eux. L'inspection statique JavaScript et .NET fonctionne sans moteur d'analyse native. Setup peut installer Hopper après votre accord ; Ghidra et IDA utilisent vos installations existantes. Consultez [la configuration des fournisseurs](docs/installation.md#hopper).
+L'analyse native approfondie utilise l'un d'eux. L'inspection statique JavaScript et .NET fonctionne sans moteur d'analyse native. Setup peut installer Hopper après votre accord ; Ghidra et IDA utilisent vos installations existantes. Consultez [la configuration des fournisseurs](../installation.md#hopper).
Dois-je lancer Hopper au préalable ?
-REA lance Hopper lorsqu'une opération en a besoin. Sous macOS, une boîte de dialogue de premier lancement peut vous demander de choisir le mode démo ou d'activer votre licence. Consultez [Démarrage et dépannage de Hopper](docs/installation.md#launcher-paths-and-troubleshooting).
+REA lance Hopper lorsqu'une opération en a besoin. Sous macOS, une boîte de dialogue de premier lancement peut vous demander de choisir le mode démo ou d'activer votre licence. Consultez [Démarrage et dépannage de Hopper](../installation.md#launcher-paths-and-troubleshooting).
Que fait l'installation du skill depuis skills.sh ?
-Le skill fournit des instructions d'investigation à votre agent. Utilisez `npx rea-agents setup` pour enregistrer le serveur MCP de REA et installer les instructions correspondantes, puis redémarrez votre agent. Consultez [l'installation du skill seul](docs/installation.md#skill-only-installation).
+Le skill fournit des instructions d'investigation à votre agent. Utilisez `npx rea-agents setup` pour enregistrer le serveur MCP de REA et installer les instructions correspondantes, puis redémarrez votre agent. Consultez [l'installation du skill seul](../installation.md#skill-only-installation).
@@ -255,14 +255,14 @@ Si vous utilisez un agent, terminez l'[actualisation de la configuration](#mettr
Commencez par les [guides pas à pas](https://rea.tools/fr/guides/) du site web. Pour les options exactes, les prérequis et les contrats de résultats :
-- [Installation et configuration](docs/installation.md) : enregistrement des agents, configuration des fournisseurs, mises à jour et désinstallation.
-- [Vérification et dépannage](docs/installation.md#check-readiness-for-your-task) : diagnostiquer un agent ou un moteur d'analyse donné.
-- [CLI et Evidence](docs/cli.md) : commandes, choix du fournisseur, snapshots, import/export et codes de sortie.
-- [Contrats MCP](docs/mcp-contracts.md) et [prompts pour agents](docs/mcp-prompts.md) : résultats des outils, sessions et investigations guidées.
-- [Catalogue des outils](docs/mcp-contracts.md#generated-catalog) : inventaire des outils, fournisseurs et commandes CLI, généré lors du build.
-- [Feuille de route](docs/roadmap.md) : travaux prévus et suivi des capacités.
+- [Installation et configuration](../installation.md) : enregistrement des agents, configuration des fournisseurs, mises à jour et désinstallation.
+- [Vérification et dépannage](../installation.md#check-readiness-for-your-task) : diagnostiquer un agent ou un moteur d'analyse donné.
+- [CLI et Evidence](../cli.md) : commandes, choix du fournisseur, snapshots, import/export et codes de sortie.
+- [Contrats MCP](../mcp-contracts.md) et [prompts pour agents](../mcp-prompts.md) : résultats des outils, sessions et investigations guidées.
+- [Catalogue des outils](../mcp-contracts.md#generated-catalog) : inventaire des outils, fournisseurs et commandes CLI, généré lors du build.
+- [Feuille de route](../roadmap.md) : travaux prévus et suivi des capacités.
-Signalez les vulnérabilités via [SECURITY.md](SECURITY.md).
+Signalez les vulnérabilités via [SECURITY.md](../../SECURITY.md).
## Historique des étoiles
@@ -280,7 +280,7 @@ Merci à toutes les personnes qui utilisent REA, signalent des bugs, proposent d
## Avertissement
-Consultez [DISCLAIMER.md](DISCLAIMER.md) pour les consignes d'utilisation responsable.
+Consultez [DISCLAIMER.md](../../DISCLAIMER.md) pour les consignes d'utilisation responsable.
REA est destiné à la recherche, à l’éducation, à l’interopérabilité, à la préservation logicielle et à l’analyse de logiciels que vous possédez ou êtes autorisé à examiner, dans le respect de la loi.
@@ -292,14 +292,14 @@ applicable licenses.
Votre aide sur REA est la bienvenue ! [Ouvrez une issue](https://github.com/morluto/rea/issues) pour signaler un bug ou proposer une fonctionnalité, ou [envoyez une pull request](https://github.com/morluto/rea/pulls) pour améliorer le code ou la documentation.
-Consultez [CONTRIBUTING.md](CONTRIBUTING.md) pour l'environnement de développement et les vérifications, la page [tests](docs/testing.md) pour les procédures de vérification, et la [carte de l'architecture](docs/architecture.mermaid) pour la structure du projet.
+Consultez [CONTRIBUTING.md](../../CONTRIBUTING.md) pour l'environnement de développement et les vérifications, la page [tests](../testing.md) pour les procédures de vérification, et la [carte de l'architecture](../architecture.mermaid) pour la structure du projet.
## Licence
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_id.md b/docs/readme/README_id.md
similarity index 75%
rename from README_id.md
rename to docs/readme/README_id.md
index 7a564c434..fba947fb2 100644
--- a/README_id.md
+++ b/docs/readme/README_id.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · **Bahasa Indonesia** · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · **Bahasa Indonesia** · [Italiano](README_it.md)
# REA: Rekayasa Balik Apa Pun
@@ -9,10 +9,10 @@
**Melihat fitur yang Anda sukai. Pahami cara kerjanya hingga ke tingkat biner.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Bergabunglah dengan Komunitas Rekayasa Balik
Discord · Tanya Jawab · Berbagi Hasil
@@ -67,7 +67,7 @@ npx rea-agents setup
Pilih agen yang ingin digunakan, tinjau perubahan yang diusulkan, lalu setujui perubahan tersebut. Proses penyiapan menambahkan server MCP REA dan instruksi alur kerja yang sesuai, serta membuat cadangan konfigurasi yang sudah ada. Setelah itu, mulai ulang agen Anda.
-Penyiapan mendukung Claude Code, Codex, Cursor, Gemini CLI, Grok Build, dan [agen lainnya](docs/installation.md#supported-agents). Lihat [instalasi dan penyiapan](docs/installation.md) untuk konfigurasi penyedia dan pendaftaran MCP secara manual.
+Penyiapan mendukung Claude Code, Codex, Cursor, Gemini CLI, Grok Build, dan [agen lainnya](../installation.md#supported-agents). Lihat [instalasi dan penyiapan](../installation.md) untuk konfigurasi penyedia dan pendaftaran MCP secara manual.
### Minta agen Anda
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-Untuk analisis native, konfigurasikan penyedia terlebih dahulu. Lihat [Panduan CLI dan Bukti](docs/cli.md) untuk perintah native, pemilihan penyedia, snapshot, dan pembuatan skrip.
+Untuk analisis native, konfigurasikan penyedia terlebih dahulu. Lihat [Panduan CLI dan Bukti](../cli.md) untuk perintah native, pemilihan penyedia, snapshot, dan pembuatan skrip.
### Perbarui REA
@@ -124,9 +124,9 @@ Agen Anda memanggil REA melalui MCP untuk memeriksa target dan menelusuri kode y
Perintah CLI menggunakan alur kerja yang sama.
-
+
-[Buka ilustrasi dalam ukuran penuh](website/public/assets/figures/rea-investigation-flow.svg).
+[Buka ilustrasi dalam ukuran penuh](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -136,46 +136,46 @@ REA memerlukan Node.js 22.x (>=22.19), 24.x (>=24.11), atau 26+, beserta npm.
Alat tambahan dan dukungan sistem host bergantung pada target yang dianalisis:
-| Target | Hasil yang diberikan REA | Persyaratan dan panduan |
-| -------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
-| Biner native | Pseudocode, assembly, string, simbol, pemanggilan, dan referensi | Hopper, Ghidra, atau IDA; [analisis native](https://rea.tools/id/guides/native/) |
-| Tata letak ELF offline | Bagian, segmen, simbol/relokasi asli, dan kandidat mitigasi statis | pwntools yang disediakan pemanggil pada Linux x64; [diagnostik biner](docs/binary-diagnostics.md) |
-| Artefak WASM | Validasi, bagian, bentuk WAT import/ekspor yang tepat, dan WAT yang didekode | WABT 1.0.42 yang disediakan pemanggil; `inspect_wasm_artifact` |
-| Bytecode EVM | Selector dispatch, offset byte, argumen yang disimpulkan, dan sifat mutabilitas | Pembawa data raw/hex lokal; [panduan EVM offline](docs/evm-bytecode.md) |
-| Crash Linux yang direkam | Catatan mentah, register/sinyal setiap thread yang direkam, dan kandidat pemetaan opsional | pwntools yang disediakan pemanggil; GDB/pwndbg opsional; [crash yang direkam](docs/recorded-crashes.md) |
-| JavaScript / Electron | Modul, impor, source map, rute, IPC, dan hubungan add-on native | Node.js dan npm; [analisis aplikasi](https://rea.tools/id/guides/javascript/) |
-| Situs web | Struktur halaman, skrip, pengamatan jaringan, dan tangkapan layar yang diminta | Peramban berbasis Chrome; [analisis peramban](https://rea.tools/id/guides/browser/) |
-| Rekaman jaringan tersimpan | Permintaan, respons, payload yang terekspos, dan lokasi sumber | HAR; mitmdump di Linux untuk rekaman native mitmproxy; [panduan rekaman](docs/web-network-captures.md) |
-| Capturan paket | Endpoint, DNS, TLS SNI, distribusi protokol, dan permintaan HTTP | tshark dan capinfos buatan pemanggil; [panduan pcap](docs/pcap-analysis.md) |
-| Assembly .NET | Metadata, instruksi CIL, dependensi native yang dideklarasikan, dan perbandingan build | Tidak ada (hanya analisis statis); [panduan kode terkelola](docs/managed-code-analysis.md) |
-| APK Android | Deklarasi manifest, kelas, metode hasil dekompilasi, dan referensi | JADX mode headless dan JDK lengkap di Linux/macOS/Windows x64; [panduan Android](docs/android-analysis.md) |
-| Perangkat Android | Perangkat, paket, proses, log, dump, tangkapan layar, serta transfer APK/berkas | adb buatan pemanggil (emulator atau perangkat); [panduan ADB](docs/adb-device-analysis.md) |
-| Proyek JEB | Unit proyek bertenaga mesin, hash artefak, dan pseudokode tipe/metode | Klien JEB yang dijalankan pemanggil dan menyajikan MCP, dipilih dengan REA_JEB_MCP_URL; [panduan JEB](docs/jeb-analysis.md) |
-| Resource Android | Manifest terdekode, tabel string, lokal, dan fakta versi | Peluncur Apktool buatan pemanggil; [panduan resource](docs/apktool-resource-analysis.md) |
-| Aplikasi Flutter | Hash snapshot Dart, hash pustaka per ABI, dan asal build engine | Tidak ada (parsing APK statis); [panduan Flutter](docs/flutter-analysis.md) |
-| Firmware | Wilayah, hasil ekstraksi, dan pengalihan ke analisis native | Binwalk / Unblob di Linux; [panduan firmware](docs/firmware-analysis.md) |
-| Paket rekaman | Kolom terpilih, nilai berulang, filter, dan aturan decode-as | Linux: TShark 4.x + prlimit; [panduan tangkapan](docs/packet-captures.md) |
-| Sinyal logika terekam | Anotasi dekoder, rentang sampel, dan diagnostik | Linux: sigrok-cli 0.7.2 + prlimit; [panduan sinyal](docs/signal-recordings.md) |
-| Paket dan sumber daya | Inventaris berkas, digest, plist, struktur paket Apple, dan sumber daya yang diekstrak | [Panduan artefak dan JavaScript](docs/javascript-artifact-reconstruction.md), [aplikasi Apple](docs/apple-application-analysis.md) |
-| Perilaku proses | Keluaran terminal, interaksi, pengamatan proses keluar dan sistem berkas, serta perbandingan eksekusi | Linux/macOS dengan PTY native; [perekaman proses](docs/process-capture.md) |
+| Target | Hasil yang diberikan REA | Persyaratan dan panduan |
+| -------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+| Biner native | Pseudocode, assembly, string, simbol, pemanggilan, dan referensi | Hopper, Ghidra, atau IDA; [analisis native](https://rea.tools/id/guides/native/) |
+| Tata letak ELF offline | Bagian, segmen, simbol/relokasi asli, dan kandidat mitigasi statis | pwntools yang disediakan pemanggil pada Linux x64; [diagnostik biner](../binary-diagnostics.md) |
+| Artefak WASM | Validasi, bagian, bentuk WAT import/ekspor yang tepat, dan WAT yang didekode | WABT 1.0.42 yang disediakan pemanggil; `inspect_wasm_artifact` |
+| Bytecode EVM | Selector dispatch, offset byte, argumen yang disimpulkan, dan sifat mutabilitas | Pembawa data raw/hex lokal; [panduan EVM offline](../evm-bytecode.md) |
+| Crash Linux yang direkam | Catatan mentah, register/sinyal setiap thread yang direkam, dan kandidat pemetaan opsional | pwntools yang disediakan pemanggil; GDB/pwndbg opsional; [crash yang direkam](../recorded-crashes.md) |
+| JavaScript / Electron | Modul, impor, source map, rute, IPC, dan hubungan add-on native | Node.js dan npm; [analisis aplikasi](https://rea.tools/id/guides/javascript/) |
+| Situs web | Struktur halaman, skrip, pengamatan jaringan, dan tangkapan layar yang diminta | Peramban berbasis Chrome; [analisis peramban](https://rea.tools/id/guides/browser/) |
+| Rekaman jaringan tersimpan | Permintaan, respons, payload yang terekspos, dan lokasi sumber | HAR; mitmdump di Linux untuk rekaman native mitmproxy; [panduan rekaman](../web-network-captures.md) |
+| Capturan paket | Endpoint, DNS, TLS SNI, distribusi protokol, dan permintaan HTTP | tshark dan capinfos buatan pemanggil; [panduan pcap](../pcap-analysis.md) |
+| Assembly .NET | Metadata, instruksi CIL, dependensi native yang dideklarasikan, dan perbandingan build | Tidak ada (hanya analisis statis); [panduan kode terkelola](../managed-code-analysis.md) |
+| APK Android | Deklarasi manifest, kelas, metode hasil dekompilasi, dan referensi | JADX mode headless dan JDK lengkap di Linux/macOS/Windows x64; [panduan Android](../android-analysis.md) |
+| Perangkat Android | Perangkat, paket, proses, log, dump, tangkapan layar, serta transfer APK/berkas | adb buatan pemanggil (emulator atau perangkat); [panduan ADB](../adb-device-analysis.md) |
+| Proyek JEB | Unit proyek bertenaga mesin, hash artefak, dan pseudokode tipe/metode | Klien JEB yang dijalankan pemanggil dan menyajikan MCP, dipilih dengan REA_JEB_MCP_URL; [panduan JEB](../jeb-analysis.md) |
+| Resource Android | Manifest terdekode, tabel string, lokal, dan fakta versi | Peluncur Apktool buatan pemanggil; [panduan resource](../apktool-resource-analysis.md) |
+| Aplikasi Flutter | Hash snapshot Dart, hash pustaka per ABI, dan asal build engine | Tidak ada (parsing APK statis); [panduan Flutter](../flutter-analysis.md) |
+| Firmware | Wilayah, hasil ekstraksi, dan pengalihan ke analisis native | Binwalk / Unblob di Linux; [panduan firmware](../firmware-analysis.md) |
+| Paket rekaman | Kolom terpilih, nilai berulang, filter, dan aturan decode-as | Linux: TShark 4.x + prlimit; [panduan tangkapan](../packet-captures.md) |
+| Sinyal logika terekam | Anotasi dekoder, rentang sampel, dan diagnostik | Linux: sigrok-cli 0.7.2 + prlimit; [panduan sinyal](../signal-recordings.md) |
+| Paket dan sumber daya | Inventaris berkas, digest, plist, struktur paket Apple, dan sumber daya yang diekstrak | [Panduan artefak dan JavaScript](../javascript-artifact-reconstruction.md), [aplikasi Apple](../apple-application-analysis.md) |
+| Perilaku proses | Keluaran terminal, interaksi, pengamatan proses keluar dan sistem berkas, serta perbandingan eksekusi | Linux/macOS dengan PTY native; [perekaman proses](../process-capture.md) |
Pemeriksaan JavaScript dan .NET statis membaca berkas yang disediakan tanpa menjalankan aplikasinya. Perekaman runtime menjalankan atau berinteraksi dengan target yang dipilih menggunakan izin pengguna Anda. Setiap panduan runtime menjelaskan dampaknya.
-Format native dan dukungan sistem host berbeda-beda menurut penyedia. Lihat [penyiapan Hopper dan Ghidra](docs/installation.md#hopper), [panduan IDA](docs/ida-provider.md), dan [dukungan eksperimental Ghidra di Windows](docs/windows-ghidra-p0.md).
+Format native dan dukungan sistem host berbeda-beda menurut penyedia. Lihat [penyiapan Hopper dan Ghidra](../installation.md#hopper), [panduan IDA](../ida-provider.md), dan [dukungan eksperimental Ghidra di Windows](../windows-ghidra-p0.md).
-Ghidra juga mendukung [analisis DOS 16-bit](docs/ghidra-dos.md).
+Ghidra juga mendukung [analisis DOS 16-bit](../ghidra-dos.md).
Untuk biner berukuran besar, tingkatkan batas waktu startup menggunakan `REA_GHIDRA_STARTUP_TIMEOUT_MS`.
-Untuk memilih penyedia, lihat [panduan CLI](docs/cli.md#choose-a-provider).
+Untuk memilih penyedia, lihat [panduan CLI](../cli.md#choose-a-provider).
-Periksa [ketersediaan rilis](docs/installation.md#released-package-and-main) untuk mengetahui fitur yang ditambahkan setelah rilis npm terbaru.
+Periksa [ketersediaan rilis](../installation.md#released-package-and-main) untuk mengetahui fitur yang ditambahkan setelah rilis npm terbaru.
## Contoh Penggunaan
-[](https://rea.tools/id/showcase/)
+[](https://rea.tools/id/showcase/)
### DX-Ball: merekonstruksi perhitungan sound-pan
@@ -202,7 +202,7 @@ Jika Anda telah menggunakan REA untuk menganalisis sesuatu yang menarik, kami in
Agen apa saja yang dapat menggunakan REA?
-Agen apa pun yang mendukung server MCP lokal dapat menggunakan REA. Proses penyiapan mengonfigurasi [agen yang didukung](docs/installation.md#supported-agents). Klien lain dapat menggunakan [pendaftaran MCP manual](docs/installation.md#mcp-registry).
+Agen apa pun yang mendukung server MCP lokal dapat menggunakan REA. Proses penyiapan mengonfigurasi [agen yang didukung](../installation.md#supported-agents). Klien lain dapat menggunakan [pendaftaran MCP manual](../installation.md#mcp-registry).
@@ -211,7 +211,7 @@ Agen apa pun yang mendukung server MCP lokal dapat menggunakan REA. Proses penyi
Analisis native mendalam menggunakan salah satu dari ketiganya. Pemeriksaan JavaScript dan .NET statis dapat dilakukan tanpa mesin analisis native.
-Proses penyiapan dapat memasang Hopper setelah memperoleh persetujuan. Ghidra dan IDA menggunakan instalasi yang sudah tersedia. Lihat [penyiapan penyedia](docs/installation.md#hopper).
+Proses penyiapan dapat memasang Hopper setelah memperoleh persetujuan. Ghidra dan IDA menggunakan instalasi yang sudah tersedia. Lihat [penyiapan penyedia](../installation.md#hopper).
@@ -220,7 +220,7 @@ Proses penyiapan dapat memasang Hopper setelah memperoleh persetujuan. Ghidra da
REA akan menjalankan Hopper saat suatu operasi membutuhkannya. Di macOS, dialog saat pertama kali dijalankan mungkin meminta Anda memilih mode demo atau mengaktifkan lisensi.
-Lihat [startup dan pemecahan masalah Hopper](docs/installation.md#launcher-paths-and-troubleshooting).
+Lihat [startup dan pemecahan masalah Hopper](../installation.md#launcher-paths-and-troubleshooting).
@@ -229,7 +229,7 @@ Lihat [startup dan pemecahan masalah Hopper](docs/installation.md#launcher-paths
Skill tersebut menyediakan instruksi investigasi untuk agen Anda. Gunakan `npx rea-agents setup` untuk mendaftarkan server MCP REA dan memasang instruksi yang sesuai, lalu mulai ulang agen Anda.
-Lihat [instalasi khusus skill](docs/installation.md#skill-only-installation).
+Lihat [instalasi khusus skill](../installation.md#skill-only-installation).
@@ -276,14 +276,14 @@ Mulailah dengan [panduan praktik di situs web](https://rea.tools/id/guides/).
Untuk mengetahui opsi, prasyarat, dan kontrak hasil secara tepat:
-- [Instalasi dan penyiapan](docs/installation.md): pendaftaran agen, konfigurasi penyedia, pembaruan, dan penghapusan instalasi.
-- [Kesiapan dan pemecahan masalah](docs/installation.md#check-readiness-for-your-task): mendiagnosis satu agen atau mesin analisis.
-- [CLI dan Bukti](docs/cli.md): perintah, pemilihan penyedia, snapshot, impor/ekspor, dan status keluar.
-- [Kontrak MCP](docs/mcp-contracts.md) dan [prompt agen](docs/mcp-prompts.md): hasil alat, sesi, dan investigasi terpandu.
-- [Katalog alat](docs/mcp-contracts.md#generated-catalog): inventaris alat, penyedia, dan perintah CLI yang dibuat secara otomatis.
-- [Peta jalan](docs/roadmap.md): pekerjaan yang direncanakan dan pelacak kemampuan.
+- [Instalasi dan penyiapan](../installation.md): pendaftaran agen, konfigurasi penyedia, pembaruan, dan penghapusan instalasi.
+- [Kesiapan dan pemecahan masalah](../installation.md#check-readiness-for-your-task): mendiagnosis satu agen atau mesin analisis.
+- [CLI dan Bukti](../cli.md): perintah, pemilihan penyedia, snapshot, impor/ekspor, dan status keluar.
+- [Kontrak MCP](../mcp-contracts.md) dan [prompt agen](../mcp-prompts.md): hasil alat, sesi, dan investigasi terpandu.
+- [Katalog alat](../mcp-contracts.md#generated-catalog): inventaris alat, penyedia, dan perintah CLI yang dibuat secara otomatis.
+- [Peta jalan](../roadmap.md): pekerjaan yang direncanakan dan pelacak kemampuan.
-Laporkan kerentanan melalui [SECURITY.md](SECURITY.md).
+Laporkan kerentanan melalui [SECURITY.md](../../SECURITY.md).
## Riwayat Bintang
@@ -301,7 +301,7 @@ Terima kasih kepada semua orang yang menggunakan REA, melaporkan bug, meminta fi
## Penafian
-Lihat [DISCLAIMER.md](DISCLAIMER.md) untuk panduan penggunaan yang bertanggung jawab.
+Lihat [DISCLAIMER.md](../../DISCLAIMER.md) untuk panduan penggunaan yang bertanggung jawab.
REA ditujukan untuk penelitian, pendidikan, interoperabilitas, pelestarian perangkat lunak, dan analisis perangkat lunak yang Anda miliki atau diizinkan untuk Anda periksa, sesuai hukum.
@@ -313,14 +313,14 @@ applicable licenses.
Kami sangat menghargai bantuan Anda untuk REA! [Buat issue](https://github.com/morluto/rea/issues) untuk melaporkan bug atau menyarankan fitur, atau [kirim pull request](https://github.com/morluto/rea/pulls) untuk meningkatkan kode atau dokumentasi.
-Lihat [CONTRIBUTING.md](CONTRIBUTING.md) untuk penyiapan pengembangan dan pemeriksaan, [pengujian](docs/testing.md) untuk tahapan verifikasi, serta [peta arsitektur](docs/architecture.mermaid) untuk struktur proyek.
+Lihat [CONTRIBUTING.md](../../CONTRIBUTING.md) untuk penyiapan pengembangan dan pemeriksaan, [pengujian](../testing.md) untuk tahapan verifikasi, serta [peta arsitektur](../architecture.mermaid) untuk struktur proyek.
## Lisensi
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_it.md b/docs/readme/README_it.md
similarity index 74%
rename from README_it.md
rename to docs/readme/README_it.md
index 8b1c55afe..b7e7c6100 100644
--- a/README_it.md
+++ b/docs/readme/README_it.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · **Italiano**
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · **Italiano**
# REA: Reverse Engineer Anything
@@ -9,10 +9,10 @@
**Vedi una funzionalità che ti piace. Capisci come funziona, fino al livello binario.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#cosa-puoi-analizzare)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Unisciti alla community di ingegneria inversa
Discord · Domande e risposte · Show and Tell
@@ -67,7 +67,7 @@ npx rea-agents setup
Scegli i tuoi agenti, rivedi le modifiche proposte e approvale. La configurazione aggiunge il server MCP di REA e le istruzioni di workflow corrispondenti, con backup della configurazione esistente. Riavvia quindi il tuo agente.
-La configurazione supporta Claude Code, Codex, Cursor, Gemini CLI, Grok Build e [altri agenti](docs/installation.md#supported-agents). Vedi [installazione e configurazione](docs/installation.md) per la configurazione dei provider e la registrazione manuale MCP.
+La configurazione supporta Claude Code, Codex, Cursor, Gemini CLI, Grok Build e [altri agenti](../installation.md#supported-agents). Vedi [installazione e configurazione](../installation.md) per la configurazione dei provider e la registrazione manuale MCP.
### Chiedi al tuo agente
@@ -83,7 +83,7 @@ Sostituisci Note con la tua app di destinazione e la funzionalità che vuoi capi
Ispeziona una directory di app JavaScript/Electron estratta o un ASAR:
```bash
-npx -y rea-agents@latest analyze-javascript-application /percorso/assoluto/verso/app --json
+npx -y rea-agents@latest analyze-javascript-application /absolute/path/to/app --json
```
Il risultato include moduli, import, confini Electron e le relative prove. Sostituisci il percorso con il tuo bersaglio, ad esempio `"D:/apps/example"` su Windows.
@@ -95,7 +95,7 @@ npm install --global rea-agents
rea --help
```
-Per l'analisi nativa, configura prima un provider. Vedi la [guida CLI ed Evidence](docs/cli.md) per i comandi nativi, la selezione del provider, gli snapshot e lo scripting.
+Per l'analisi nativa, configura prima un provider. Vedi la [guida CLI ed Evidence](../cli.md) per i comandi nativi, la selezione del provider, gli snapshot e lo scripting.
### Aggiorna REA
@@ -123,9 +123,9 @@ Rivedi le modifiche di configurazione e riavvia il tuo agente. Per comandi CLI s
Il tuo agente chiama REA tramite MCP per ispezionare il bersaglio e tracciare il codice rilevante. REA restituisce i risultati con le relative prove. L'agente li usa per fare domande di approfondimento, spiegare il comportamento o scrivere e testare un'implementazione. Anche i comandi CLI usano gli stessi workflow.
-
+
-[Apri la figura a dimensione intera](website/public/assets/figures/rea-investigation-flow.svg).
+[Apri la figura a dimensione intera](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -133,38 +133,38 @@ Il tuo agente chiama REA tramite MCP per ispezionare il bersaglio e tracciare il
REA richiede Node.js 22.x (>=22.19), 24.x (>=24.11) o 26+, oltre a npm. Strumenti aggiuntivi e supporto host dipendono dal bersaglio:
-| Obiettivo | Cosa restituisce REA | Requisiti e guida |
-| ---------------------------- | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
-| Binari nativi | Pseudocodice, assembly, stringhe, simboli, chiamate e riferimenti | Hopper, Ghidra o IDA; [analisi nativa](https://rea.tools/it/guides/native/) |
-| Layout ELF offline | Sezioni, segmenti, simboli/relocazioni originali e candidati mitigazioni statiche | pwntools fornito dal chiamante su Linux x64; [diagnostica binaria](docs/binary-diagnostics.md) |
-| Artefatto WASM | Convalida, sezioni, forme WAT di import/export esatte e WAT decodificato | WABT 1.0.42 fornito dal chiamante; `inspect_wasm_artifact` |
-| Bytecode EVM | Selettori di dispatch, offset dei byte, argomenti inferiti e mutabilità | Carrier raw/hex locale; [guida EVM offline](docs/evm-bytecode.md) |
-| Crash Linux registrati | Note grezze, registri/segnai di ogni thread registrato e candidati mapping opzionali | pwntools fornito dal chiamante; GDB/pwndbg opzionale; [crash registrati](docs/recorded-crashes.md) |
-| JavaScript / Electron | Moduli, import, source map, route, IPC e relazioni con add-on nativi | Node.js e npm; [analisi delle applicazioni](https://rea.tools/it/guides/javascript/) |
-| Siti web | Struttura della pagina, script, osservazioni di rete e screenshot richiesti | Un browser della famiglia Chrome; [analisi browser](https://rea.tools/it/guides/browser/) |
-| Acquisizioni di rete salvate | Richieste, risposte, payload esposti e posizioni sorgente | HAR; mitmdump su Linux per acquisizioni mitmproxy native; [guida alle acquisizioni](docs/web-network-captures.md) |
-| Captured di pacchetti | Endpoint, DNS, TLS SNI, distribuzione dei protocolli e richieste HTTP | tshark e capinfos forniti dal chiamante; [guida pcap](docs/pcap-analysis.md) |
-| Assembly .NET | Metadati, istruzioni CIL, dipendenze native dichiarate e confronti di build | Nessuno (solo statico); [guida managed-code](docs/managed-code-analysis.md) |
-| APK Android | Dichiarazioni manifest, classi, metodi decompilati e riferimenti | JADX headless e un JDK completo su Linux/macOS/Windows x64; [guida Android](docs/android-analysis.md) |
-| Dispositivi Android | Dispositivi, pacchetti, processi, log, dump, screenshot e trasferimenti APK/file | adb fornito dal chiamante (emulatore o hardware); [guida ADB](docs/adb-device-analysis.md) |
-| Progetti JEB | Unità di progetto dal motore, digest degli artifact e pseudocodice di tipi/metodi | Client JEB avviato dal chiamante via MCP, selezionato con REA_JEB_MCP_URL; [guida JEB](docs/jeb-analysis.md) |
-| Risorse Android | Manifest decodificato, tabelle stringhe, lingue e dati di versione | Launcher Apktool fornito dal chiamante; [guida alle risorse](docs/apktool-resource-analysis.md) |
-| App Flutter | Hash dello snapshot Dart, digest delle librerie per ABI e provenienza della build del motore | Nessuno (analisi APK statica); [guida Flutter](docs/flutter-analysis.md) |
-| Firmware | Regioni, risultati di estrazione e passaggi all'analisi nativa | Binwalk / Unblob su Linux; [guida firmware](docs/firmware-analysis.md) |
-| Pacchetti registrati | Campi selezionati, valori ripetuti, filtri e regole di decodifica | Linux: TShark 4.x + prlimit; [guida alle catture](docs/packet-captures.md) |
-| Segnali logici registrati | Annotazioni del decoder, intervalli di campioni e diagnostica | Linux: sigrok-cli 0.7.2 + prlimit; [guida ai segnali](docs/signal-recordings.md) |
-| Pacchetti e risorse | Inventari file, digest, plist, anatomia dei bundle Apple e risorse estratte | [Guida artifact e JavaScript](docs/javascript-artifact-reconstruction.md), [Applicazioni Apple](docs/apple-application-analysis.md) |
-| Comportamento dei processi | Output del terminale, interazioni, osservazioni su uscita e filesystem ed confronti di esecuzione | Linux/macOS con un PTY nativo; [cattura dei processi](docs/process-capture.md) |
+| Obiettivo | Cosa restituisce REA | Requisiti e guida |
+| ---------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| Binari nativi | Pseudocodice, assembly, stringhe, simboli, chiamate e riferimenti | Hopper, Ghidra o IDA; [analisi nativa](https://rea.tools/it/guides/native/) |
+| Layout ELF offline | Sezioni, segmenti, simboli/relocazioni originali e candidati mitigazioni statiche | pwntools fornito dal chiamante su Linux x64; [diagnostica binaria](../binary-diagnostics.md) |
+| Artefatto WASM | Convalida, sezioni, forme WAT di import/export esatte e WAT decodificato | WABT 1.0.42 fornito dal chiamante; `inspect_wasm_artifact` |
+| Bytecode EVM | Selettori di dispatch, offset dei byte, argomenti inferiti e mutabilità | Carrier raw/hex locale; [guida EVM offline](../evm-bytecode.md) |
+| Crash Linux registrati | Note grezze, registri/segnai di ogni thread registrato e candidati mapping opzionali | pwntools fornito dal chiamante; GDB/pwndbg opzionale; [crash registrati](../recorded-crashes.md) |
+| JavaScript / Electron | Moduli, import, source map, route, IPC e relazioni con add-on nativi | Node.js e npm; [analisi delle applicazioni](https://rea.tools/it/guides/javascript/) |
+| Siti web | Struttura della pagina, script, osservazioni di rete e screenshot richiesti | Un browser della famiglia Chrome; [analisi browser](https://rea.tools/it/guides/browser/) |
+| Acquisizioni di rete salvate | Richieste, risposte, payload esposti e posizioni sorgente | HAR; mitmdump su Linux per acquisizioni mitmproxy native; [guida alle acquisizioni](../web-network-captures.md) |
+| Captured di pacchetti | Endpoint, DNS, TLS SNI, distribuzione dei protocolli e richieste HTTP | tshark e capinfos forniti dal chiamante; [guida pcap](../pcap-analysis.md) |
+| Assembly .NET | Metadati, istruzioni CIL, dipendenze native dichiarate e confronti di build | Nessuno (solo statico); [guida managed-code](../managed-code-analysis.md) |
+| APK Android | Dichiarazioni manifest, classi, metodi decompilati e riferimenti | JADX headless e un JDK completo su Linux/macOS/Windows x64; [guida Android](../android-analysis.md) |
+| Dispositivi Android | Dispositivi, pacchetti, processi, log, dump, screenshot e trasferimenti APK/file | adb fornito dal chiamante (emulatore o hardware); [guida ADB](../adb-device-analysis.md) |
+| Progetti JEB | Unità di progetto dal motore, digest degli artifact e pseudocodice di tipi/metodi | Client JEB avviato dal chiamante via MCP, selezionato con REA_JEB_MCP_URL; [guida JEB](../jeb-analysis.md) |
+| Risorse Android | Manifest decodificato, tabelle stringhe, lingue e dati di versione | Launcher Apktool fornito dal chiamante; [guida alle risorse](../apktool-resource-analysis.md) |
+| App Flutter | Hash dello snapshot Dart, digest delle librerie per ABI e provenienza della build del motore | Nessuno (analisi APK statica); [guida Flutter](../flutter-analysis.md) |
+| Firmware | Regioni, risultati di estrazione e passaggi all'analisi nativa | Binwalk / Unblob su Linux; [guida firmware](../firmware-analysis.md) |
+| Pacchetti registrati | Campi selezionati, valori ripetuti, filtri e regole di decodifica | Linux: TShark 4.x + prlimit; [guida alle catture](../packet-captures.md) |
+| Segnali logici registrati | Annotazioni del decoder, intervalli di campioni e diagnostica | Linux: sigrok-cli 0.7.2 + prlimit; [guida ai segnali](../signal-recordings.md) |
+| Pacchetti e risorse | Inventari file, digest, plist, anatomia dei bundle Apple e risorse estratte | [Guida artifact e JavaScript](../javascript-artifact-reconstruction.md), [Applicazioni Apple](../apple-application-analysis.md) |
+| Comportamento dei processi | Output del terminale, interazioni, osservazioni su uscita e filesystem ed confronti di esecuzione | Linux/macOS con un PTY nativo; [cattura dei processi](../process-capture.md) |
L'ispezione statica di JavaScript e .NET legge i file forniti senza eseguire l'applicazione. La cattura a runtime esegue o interagisce con il bersaglio selezionato usando i tuoi permessi utente; ogni guida runtime descrive i suoi effetti.
-I formati nativi e il supporto host variano in base al provider. Vedi la [configurazione di Hopper e Ghidra](docs/installation.md#hopper), la [guida IDA](docs/ida-provider.md) e il [supporto sperimentale Windows Ghidra](docs/windows-ghidra-p0.md). Ghidra supporta anche l'[analisi DOS a 16 bit](docs/ghidra-dos.md). Per binari di grandi dimensioni, aumenta il timeout di avvio con `REA_GHIDRA_STARTUP_TIMEOUT_MS`. Per la selezione del provider, vedi la [guida CLI](docs/cli.md#choose-a-provider). Controlla la [disponibilità delle release](docs/installation.md#released-package-and-main) per le funzionalità aggiunte dall'ultima release npm.
+I formati nativi e il supporto host variano in base al provider. Vedi la [configurazione di Hopper e Ghidra](../installation.md#hopper), la [guida IDA](../ida-provider.md) e il [supporto sperimentale Windows Ghidra](../windows-ghidra-p0.md). Ghidra supporta anche l'[analisi DOS a 16 bit](../ghidra-dos.md). Per binari di grandi dimensioni, aumenta il timeout di avvio con `REA_GHIDRA_STARTUP_TIMEOUT_MS`. Per la selezione del provider, vedi la [guida CLI](../cli.md#choose-a-provider). Controlla la [disponibilità delle release](../installation.md#released-package-and-main) per le funzionalità aggiunte dall'ultima release npm.
## Showcase
-[](https://rea.tools/it/showcase/)
+[](https://rea.tools/it/showcase/)
### DX-Ball: ricostruisci un calcolo sound-pan
@@ -191,28 +191,28 @@ Se hai usato REA su qualcosa di interessante, ci piacerebbe vederlo. Condividi i
Quali agenti possono usare REA?
-Qualsiasi agente che supporti server MCP locali. La configurazione configura gli [agenti supportati](docs/installation.md#supported-agents); altri client possono usare la [registrazione MCP manuale](docs/installation.md#mcp-registry).
+Qualsiasi agente che supporti server MCP locali. La configurazione configura gli [agenti supportati](../installation.md#supported-agents); altri client possono usare la [registrazione MCP manuale](../installation.md#mcp-registry).
Ho bisogno di Hopper, Ghidra o IDA?
-L'analisi nativa profonda ne usa uno. L'ispezione statica di JavaScript e .NET funziona senza un motore di analisi nativo. La configurazione può installare Hopper previa approvazione; Ghidra e IDA usano le tue installazioni esistenti. Vedi [configurazione provider](docs/installation.md#hopper).
+L'analisi nativa profonda ne usa uno. L'ispezione statica di JavaScript e .NET funziona senza un motore di analisi nativo. La configurazione può installare Hopper previa approvazione; Ghidra e IDA usano le tue installazioni esistenti. Vedi [configurazione provider](../installation.md#hopper).
Devo avviare Hopper per primo?
-REA avvia Hopper quando un'operazione ne ha bisogno. Su macOS, una finestra di dialogo al primo avvio potrebbe chiederti di scegliere la modalità demo o di attivare la licenza. Vedi [avvio di Hopper e risoluzione dei problemi](docs/installation.md#launcher-paths-and-troubleshooting).
+REA avvia Hopper quando un'operazione ne ha bisogno. Su macOS, una finestra di dialogo al primo avvio potrebbe chiederti di scegliere la modalità demo o di attivare la licenza. Vedi [avvio di Hopper e risoluzione dei problemi](../installation.md#launcher-paths-and-troubleshooting).
Cosa fa l'installazione dello skill da skills.sh?
-Lo skill fornisce istruzioni di indagine per il tuo agente. Usa `npx rea-agents setup` per registrare il server MCP di REA e installare le istruzioni corrispondenti, quindi riavvia il tuo agente. Vedi [installazione solo skill](docs/installation.md#skill-only-installation).
+Lo skill fornisce istruzioni di indagine per il tuo agente. Usa `npx rea-agents setup` per registrare il server MCP di REA e installare le istruzioni corrispondenti, quindi riavvia il tuo agente. Vedi [installazione solo skill](../installation.md#skill-only-installation).
@@ -255,14 +255,14 @@ Se stai usando un agente, completa l'[aggiornamento della configurazione](#aggio
Inizia dalle [guide pratiche](https://rea.tools/it/guides/) del sito web. Per opzioni esatte, prerequisiti e contratti dei risultati:
-- [Installazione e configurazione](docs/installation.md): registrazione agente, configurazione provider, aggiornamenti e disinstallazione.
-- [Pronto all'uso e risoluzione dei problemi](docs/installation.md#check-readiness-for-your-task): diagnostica un agente o un motore di analisi.
-- [CLI ed Evidence](docs/cli.md): comandi, selezione provider, snapshot, import/export e stati di uscita.
-- [Contratti MCP](docs/mcp-contracts.md) e [prompt agente](docs/mcp-prompts.md): risultati degli strumenti, sessioni e indagini guidate.
-- [Catalogo strumenti](docs/mcp-contracts.md#generated-catalog): inventario generato di strumenti, provider e comandi CLI.
-- [Roadmap](docs/roadmap.md): lavoro pianificato e tracker delle capacità.
+- [Installazione e configurazione](../installation.md): registrazione agente, configurazione provider, aggiornamenti e disinstallazione.
+- [Pronto all'uso e risoluzione dei problemi](../installation.md#check-readiness-for-your-task): diagnostica un agente o un motore di analisi.
+- [CLI ed Evidence](../cli.md): comandi, selezione provider, snapshot, import/export e stati di uscita.
+- [Contratti MCP](../mcp-contracts.md) e [prompt agente](../mcp-prompts.md): risultati degli strumenti, sessioni e indagini guidate.
+- [Catalogo strumenti](../mcp-contracts.md#generated-catalog): inventario generato di strumenti, provider e comandi CLI.
+- [Roadmap](../roadmap.md): lavoro pianificato e tracker delle capacità.
-Segnala vulnerabilità tramite [SECURITY.md](SECURITY.md).
+Segnala vulnerabilità tramite [SECURITY.md](../../SECURITY.md).
## Cronologia delle stelle
@@ -280,7 +280,7 @@ Grazie a tutti coloro che usano REA, segnalano bug, propongono funzionalità, te
## Disclaimer
-Consulta [DISCLAIMER.md](DISCLAIMER.md) per le indicazioni sull'uso responsabile.
+Consulta [DISCLAIMER.md](../../DISCLAIMER.md) per le indicazioni sull'uso responsabile.
REA è destinato alla ricerca, alla formazione, all’interoperabilità, alla conservazione del software e all’analisi di software di tua proprietà o che sei autorizzato a esaminare, nel rispetto della legge.
@@ -292,14 +292,14 @@ applicable licenses.
Apprezzeremmo il tuo aiuto con REA! [Apri un issue](https://github.com/morluto/rea/issues) per segnalare un bug o suggerire una funzionalità, oppure [invia una pull request](https://github.com/morluto/rea/pulls) per migliorare il codice o la documentazione.
-Vedi [CONTRIBUTING.md](CONTRIBUTING.md) per la configurazione di sviluppo e i controlli, [testing](docs/testing.md) per le lane di verifica e la [mappa dell'architettura](docs/architecture.mermaid) per la struttura del progetto.
+Vedi [CONTRIBUTING.md](../../CONTRIBUTING.md) per la configurazione di sviluppo e i controlli, [testing](../testing.md) per le lane di verifica e la [mappa dell'architettura](../architecture.mermaid) per la struttura del progetto.
## License
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_ja.md b/docs/readme/README_ja.md
similarity index 76%
rename from README_ja.md
rename to docs/readme/README_ja.md
index 5fb42d096..c9d7981ba 100644
--- a/README_ja.md
+++ b/docs/readme/README_ja.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · **日本語** · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · **日本語** · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA:あらゆるものをリバースエンジニアリング
@@ -9,10 +9,10 @@
**気に入った機能を見つけたら、その仕組みをバイナリのレベルまで理解する。**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
リバースエンジニアリングのコミュニティに参加
Discord · 質問と回答 · 成果の共有
@@ -67,7 +67,7 @@ npx rea-agents setup
使うエージェントを選び、予定されている変更を確認して承認してください。セットアップは REA の MCP サーバーと対応するワークフローの手順を追加し、既存の設定をバックアップします。完了後にエージェントを再起動してください。
-セットアップは Claude Code、Codex、Cursor、Gemini CLI、Grok Build、および[その他のエージェント](docs/installation.md#supported-agents)に対応しています。プロバイダーの設定と MCP の手動登録については、[インストールとセットアップ](docs/installation.md)を参照してください。
+セットアップは Claude Code、Codex、Cursor、Gemini CLI、Grok Build、および[その他のエージェント](../installation.md#supported-agents)に対応しています。プロバイダーの設定と MCP の手動登録については、[インストールとセットアップ](../installation.md)を参照してください。
### エージェントに依頼する
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-ネイティブ分析には、先にプロバイダーの設定が必要です。ネイティブ分析のコマンド、プロバイダーの選択、スナップショット、スクリプトでの利用は、[CLI と Evidence のガイド](docs/cli.md)を参照してください。
+ネイティブ分析には、先にプロバイダーの設定が必要です。ネイティブ分析のコマンド、プロバイダーの選択、スナップショット、スクリプトでの利用は、[CLI と Evidence のガイド](../cli.md)を参照してください。
### REA を更新する
@@ -120,9 +120,9 @@ npx rea-agents@latest setup
エージェントは MCP 経由で REA を呼び出し、対象を調べて関連するコードを追跡します。REA は調査結果と根拠を返します。エージェントはそれを使って追加の質問をしたり、動作を説明したり、実装を書いてテストしたりします。CLI コマンドも同じワークフローを使います。
-
+
-[原寸大の図を開く](website/public/assets/figures/rea-investigation-flow.svg)。
+[原寸大の図を開く](../../website/public/assets/figures/rea-investigation-flow.svg)。
@@ -130,37 +130,37 @@ npx rea-agents@latest setup
REA には Node.js 22.x(>=22.19)、24.x(>=24.11)、または 26+ と npm が必要です。追加のツールや対応ホストは、対象によって異なります。
-| 対象 | REA が返すもの | 要件とガイド |
-| -------------------------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
-| ネイティブバイナリ | 疑似コード、アセンブリ、文字列、シンボル、呼び出し、参照 | Hopper、Ghidra、または IDA;[ネイティブ分析](https://rea.tools/ja/guides/native/) |
-| オフライン ELF レイアウト | セクション、セグメント、元のシンボル/再配置情報、静的解析によるセキュリティ対策の候補 | Linux x64 で利用者が用意する pwntools;[バイナリ診断](docs/binary-diagnostics.md) |
-| EVM バイトコード | ディスパッチセレクター、バイトオフセット、推定された引数と状態変更の可否 | Linux x64 上のローカルの生バイト/16 進数の入力ファイル;[オフライン EVM ガイド](docs/evm-bytecode.md) |
-| 記録済みの Linux クラッシュ | 生の note レコード、記録された全スレッドのレジスター/シグナル、任意のマッピング候補 | Linux x64 で利用者が用意する pwntools;GDB/pwndbg は任意;[記録済みクラッシュ](docs/recorded-crashes.md) |
-| JavaScript / Electron | モジュール、インポート、ソースマップ、ルート、IPC、ネイティブアドオンの関係 | Node.js と npm;[アプリケーション分析](https://rea.tools/ja/guides/javascript/) |
-| ウェブサイト | ページ構造、スクリプト、ネットワークの観測結果、依頼されたスクリーンショット | Chrome 系ブラウザー;[ブラウザー分析](https://rea.tools/ja/guides/browser/) |
-| 保存済みのネットワークキャプチャ | リクエスト、レスポンス、取得可能なペイロード、ソース内の位置 | HAR;mitmproxy ネイティブ形式のキャプチャには Linux 上の mitmdump;[キャプチャガイド](docs/web-network-captures.md) |
-| パケットキャプチャ | エンドポイント、DNS、TLS SNI、プロトコル分布、HTTPリクエスト | 呼び出し側が用意した tshark と capinfos;[pcapガイド](docs/pcap-analysis.md) |
-| .NET アセンブリ | メタデータ、CIL 命令、宣言されたネイティブ依存関係、ビルドの比較 | 静的な検査;[マネージドコードのガイド](docs/managed-code-analysis.md) |
-| Android APK | マニフェストの宣言、クラス、逆コンパイルされたメソッド、参照 | Linux/macOS/Windows x64 上のヘッドレス JADX と完全な JDK;[Android ガイド](docs/android-analysis.md) |
-| Android デバイス | デバイス、パッケージ、プロセス、ログ、ダンプ、スクリーンキャプチャ、APK/ファイル転送 | 呼び出し側が用意した adb(エミュレーターまたは実機);[ADB ガイド](docs/adb-device-analysis.md) |
-| JEBプロジェクト | エンジンによるプロジェクトユニット、アーティファクトのダイジェスト、型/メソッドの擬似コード | 呼び出し側が起動し MCP を提供する JEB クライアント(REA_JEB_MCP_URL で選択);[JEB ガイド](docs/jeb-analysis.md) |
-| Android リソース | デコードされたマニフェスト、文字列テーブル、ロケール、バージョン情報 | 呼び出し側が用意した Apktool ランチャー;[リソースガイド](docs/apktool-resource-analysis.md) |
-| Flutter アプリ | Dart スナップショットハッシュ、ABI ごとのライブラリダイジェスト、エンジンビルドの来歴 | 不要(静的 APK 解析);[Flutter ガイド](docs/flutter-analysis.md) |
-| ファームウェア | 領域、抽出結果、ネイティブ分析への引き継ぎ | Linux 上の Binwalk / Unblob;[ファームウェアガイド](docs/firmware-analysis.md) |
-| 記録済みパケット | 選択フィールド、繰り返し値、フィルター、デコード指定 | Linux: TShark 4.x + prlimit; [キャプチャガイド](docs/packet-captures.md) |
-| 記録済みロジック信号 | デコーダ注釈、サンプル範囲、診断情報 | Linux: sigrok-cli 0.7.2 + prlimit; [信号記録ガイド](docs/signal-recordings.md) |
-| パッケージとリソース | ファイル一覧、ダイジェスト、plist、Apple バンドルの構造、抽出されたリソース | [アーティファクトと JavaScript のガイド](docs/javascript-artifact-reconstruction.md)、[Apple アプリケーション](docs/apple-application-analysis.md) |
-| プロセスの動作 | ターミナル出力、対話、終了とファイルシステムの観測結果、実行の比較 | ネイティブ PTY を備えた Linux/macOS;[プロセスキャプチャ](docs/process-capture.md) |
+| 対象 | REA が返すもの | 要件とガイド |
+| -------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| ネイティブバイナリ | 疑似コード、アセンブリ、文字列、シンボル、呼び出し、参照 | Hopper、Ghidra、または IDA;[ネイティブ分析](https://rea.tools/ja/guides/native/) |
+| オフライン ELF レイアウト | セクション、セグメント、元のシンボル/再配置情報、静的解析によるセキュリティ対策の候補 | Linux x64 で利用者が用意する pwntools;[バイナリ診断](../binary-diagnostics.md) |
+| EVM バイトコード | ディスパッチセレクター、バイトオフセット、推定された引数と状態変更の可否 | Linux x64 上のローカルの生バイト/16 進数の入力ファイル;[オフライン EVM ガイド](../evm-bytecode.md) |
+| 記録済みの Linux クラッシュ | 生の note レコード、記録された全スレッドのレジスター/シグナル、任意のマッピング候補 | Linux x64 で利用者が用意する pwntools;GDB/pwndbg は任意;[記録済みクラッシュ](../recorded-crashes.md) |
+| JavaScript / Electron | モジュール、インポート、ソースマップ、ルート、IPC、ネイティブアドオンの関係 | Node.js と npm;[アプリケーション分析](https://rea.tools/ja/guides/javascript/) |
+| ウェブサイト | ページ構造、スクリプト、ネットワークの観測結果、依頼されたスクリーンショット | Chrome 系ブラウザー;[ブラウザー分析](https://rea.tools/ja/guides/browser/) |
+| 保存済みのネットワークキャプチャ | リクエスト、レスポンス、取得可能なペイロード、ソース内の位置 | HAR;mitmproxy ネイティブ形式のキャプチャには Linux 上の mitmdump;[キャプチャガイド](../web-network-captures.md) |
+| パケットキャプチャ | エンドポイント、DNS、TLS SNI、プロトコル分布、HTTPリクエスト | 呼び出し側が用意した tshark と capinfos;[pcapガイド](../pcap-analysis.md) |
+| .NET アセンブリ | メタデータ、CIL 命令、宣言されたネイティブ依存関係、ビルドの比較 | 静的な検査;[マネージドコードのガイド](../managed-code-analysis.md) |
+| Android APK | マニフェストの宣言、クラス、逆コンパイルされたメソッド、参照 | Linux/macOS/Windows x64 上のヘッドレス JADX と完全な JDK;[Android ガイド](../android-analysis.md) |
+| Android デバイス | デバイス、パッケージ、プロセス、ログ、ダンプ、スクリーンキャプチャ、APK/ファイル転送 | 呼び出し側が用意した adb(エミュレーターまたは実機);[ADB ガイド](../adb-device-analysis.md) |
+| JEBプロジェクト | エンジンによるプロジェクトユニット、アーティファクトのダイジェスト、型/メソッドの擬似コード | 呼び出し側が起動し MCP を提供する JEB クライアント(REA_JEB_MCP_URL で選択);[JEB ガイド](../jeb-analysis.md) |
+| Android リソース | デコードされたマニフェスト、文字列テーブル、ロケール、バージョン情報 | 呼び出し側が用意した Apktool ランチャー;[リソースガイド](../apktool-resource-analysis.md) |
+| Flutter アプリ | Dart スナップショットハッシュ、ABI ごとのライブラリダイジェスト、エンジンビルドの来歴 | 不要(静的 APK 解析);[Flutter ガイド](../flutter-analysis.md) |
+| ファームウェア | 領域、抽出結果、ネイティブ分析への引き継ぎ | Linux 上の Binwalk / Unblob;[ファームウェアガイド](../firmware-analysis.md) |
+| 記録済みパケット | 選択フィールド、繰り返し値、フィルター、デコード指定 | Linux: TShark 4.x + prlimit; [キャプチャガイド](../packet-captures.md) |
+| 記録済みロジック信号 | デコーダ注釈、サンプル範囲、診断情報 | Linux: sigrok-cli 0.7.2 + prlimit; [信号記録ガイド](../signal-recordings.md) |
+| パッケージとリソース | ファイル一覧、ダイジェスト、plist、Apple バンドルの構造、抽出されたリソース | [アーティファクトと JavaScript のガイド](../javascript-artifact-reconstruction.md)、[Apple アプリケーション](../apple-application-analysis.md) |
+| プロセスの動作 | ターミナル出力、対話、終了とファイルシステムの観測結果、実行の比較 | ネイティブ PTY を備えた Linux/macOS;[プロセスキャプチャ](../process-capture.md) |
静的な JavaScript と .NET の検査は、指定されたファイルを読み取り、アプリケーションを実行しません。実行時キャプチャは、あなたのユーザー権限で対象を実行したり、対象とやり取りしたりします。それぞれの実行時ガイドに、どのような操作が行われるかを記載しています。
-対応するネイティブ形式とホストは、プロバイダーによって異なります。[Hopper と Ghidra のセットアップ](docs/installation.md#hopper)、[IDA ガイド](docs/ida-provider.md)、[Windows 向け Ghidra の実験的対応](docs/windows-ghidra-p0.md)を参照してください。Ghidra は [16 ビット DOS 分析](docs/ghidra-dos.md)にも対応しています。プロバイダーの選択は [CLI ガイド](docs/cli.md#choose-a-provider)を参照してください。最新の npm リリース以降に追加された機能については、[リリースでの利用可否](docs/installation.md#released-package-and-main)を確認してください。
+対応するネイティブ形式とホストは、プロバイダーによって異なります。[Hopper と Ghidra のセットアップ](../installation.md#hopper)、[IDA ガイド](../ida-provider.md)、[Windows 向け Ghidra の実験的対応](../windows-ghidra-p0.md)を参照してください。Ghidra は [16 ビット DOS 分析](../ghidra-dos.md)にも対応しています。プロバイダーの選択は [CLI ガイド](../cli.md#choose-a-provider)を参照してください。最新の npm リリース以降に追加された機能については、[リリースでの利用可否](../installation.md#released-package-and-main)を確認してください。
## 事例
-[](https://rea.tools/ja/showcase/)
+[](https://rea.tools/ja/showcase/)
### DX-Ball:音声のパン計算を再構築する
@@ -189,28 +189,28 @@ REA で興味深い対象を調べたら、ぜひ共有してください。[iss
どのエージェントで REA を使えますか?
-ローカル MCP サーバーに対応するエージェントなら使えます。セットアップは[対応エージェント](docs/installation.md#supported-agents)を設定します。その他のクライアントでは、[MCP の手動登録](docs/installation.md#mcp-registry)を利用できます。
+ローカル MCP サーバーに対応するエージェントなら使えます。セットアップは[対応エージェント](../installation.md#supported-agents)を設定します。その他のクライアントでは、[MCP の手動登録](../installation.md#mcp-registry)を利用できます。
Hopper、Ghidra、IDA は必要ですか?
-深いネイティブ分析には、そのいずれかを使います。静的な JavaScript と .NET の検査には、ネイティブ分析エンジンは必要ありません。セットアップは承認後に Hopper をインストールできます。Ghidra と IDA は既存のインストールを使います。[プロバイダーのセットアップ](docs/installation.md#hopper)を参照してください。
+深いネイティブ分析には、そのいずれかを使います。静的な JavaScript と .NET の検査には、ネイティブ分析エンジンは必要ありません。セットアップは承認後に Hopper をインストールできます。Ghidra と IDA は既存のインストールを使います。[プロバイダーのセットアップ](../installation.md#hopper)を参照してください。
先に Hopper を起動する必要はありますか?
-REA は必要な操作の際に Hopper を起動します。macOS では、初回起動時にデモモードを選ぶか、ライセンスを有効化するよう求められることがあります。[Hopper の起動とトラブルシューティング](docs/installation.md#launcher-paths-and-troubleshooting)を参照してください。
+REA は必要な操作の際に Hopper を起動します。macOS では、初回起動時にデモモードを選ぶか、ライセンスを有効化するよう求められることがあります。[Hopper の起動とトラブルシューティング](../installation.md#launcher-paths-and-troubleshooting)を参照してください。
skills.sh からスキルをインストールすると何ができますか?
-スキルはエージェントに調査の手順を提供します。`npx rea-agents setup` で REA の MCP サーバーを登録し、対応する手順をインストールしてから、エージェントを再起動してください。[スキルのみのインストール](docs/installation.md#skill-only-installation)を参照してください。
+スキルはエージェントに調査の手順を提供します。`npx rea-agents setup` で REA の MCP サーバーを登録し、対応する手順をインストールしてから、エージェントを再起動してください。[スキルのみのインストール](../installation.md#skill-only-installation)を参照してください。
@@ -253,14 +253,14 @@ npx rea-agents@latest setup
まずはウェブサイトの[実践ガイド](https://rea.tools/ja/guides/)を参照してください。正確なオプション、前提条件、結果の契約については、以下を参照してください。
-- [インストールとセットアップ](docs/installation.md):エージェントの登録、プロバイダーの設定、更新、アンインストール。
-- [準備状況の確認とトラブルシューティング](docs/installation.md#check-readiness-for-your-task):特定のエージェントや分析エンジンを診断。
-- [CLI と Evidence](docs/cli.md):コマンド、プロバイダーの選択、スナップショット、インポート/エクスポート、終了ステータス。
-- [MCP 契約](docs/mcp-contracts.md)と[エージェント向けプロンプト](docs/mcp-prompts.md):ツールの結果、セッション、ガイド付き調査。
-- [ツールカタログ](docs/mcp-contracts.md#generated-catalog):ビルド時に生成されるツール、プロバイダー、CLI コマンドの一覧。
-- [ロードマップ](docs/roadmap.md):計画中の作業と機能の進捗。
+- [インストールとセットアップ](../installation.md):エージェントの登録、プロバイダーの設定、更新、アンインストール。
+- [準備状況の確認とトラブルシューティング](../installation.md#check-readiness-for-your-task):特定のエージェントや分析エンジンを診断。
+- [CLI と Evidence](../cli.md):コマンド、プロバイダーの選択、スナップショット、インポート/エクスポート、終了ステータス。
+- [MCP 契約](../mcp-contracts.md)と[エージェント向けプロンプト](../mcp-prompts.md):ツールの結果、セッション、ガイド付き調査。
+- [ツールカタログ](../mcp-contracts.md#generated-catalog):ビルド時に生成されるツール、プロバイダー、CLI コマンドの一覧。
+- [ロードマップ](../roadmap.md):計画中の作業と機能の進捗。
-脆弱性の報告は [SECURITY.md](SECURITY.md) に従ってください。
+脆弱性の報告は [SECURITY.md](../../SECURITY.md) に従ってください。
## スター履歴
@@ -278,7 +278,7 @@ REA の利用、バグ報告、機能の要望、ビルドのテスト、修正
## 免責事項
-責任ある利用については [DISCLAIMER.md](DISCLAIMER.md) を参照してください。
+責任ある利用については [DISCLAIMER.md](../../DISCLAIMER.md) を参照してください。
REA は、法令に従った研究、教育、相互運用性の確保、ソフトウェアの保存、および所有するソフトウェアや調査を許可されたソフトウェアの解析を目的としています。
@@ -290,14 +290,14 @@ applicable licenses.
REA への貢献を歓迎しますしてバグや機能の提案を報告したり、[pull request を送信](https://github.com/morluto/rea/pulls)してコードやドキュメントを改善したりできます。
-開発環境とチェックは [CONTRIBUTING.md](CONTRIBUTING.md)、検証レーンは[テストガイド](docs/testing.md)、プロジェクト構造は[アーキテクチャ図](docs/architecture.mermaid)を参照してください。
+開発環境とチェックは [CONTRIBUTING.md](../../CONTRIBUTING.md)、検証レーンは[テストガイド](../testing.md)、プロジェクト構造は[アーキテクチャ図](../architecture.mermaid)を参照してください。
## ライセンス
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_ko.md b/docs/readme/README_ko.md
similarity index 74%
rename from README_ko.md
rename to docs/readme/README_ko.md
index 5a9e7cd5d..26db0d824 100644
--- a/README_ko.md
+++ b/docs/readme/README_ko.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · **한국어** · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · **한국어** · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: 무엇이든 리버스 엔지니어링
@@ -9,10 +9,10 @@
**마음에 드는 기능을 발견했다면, 바이너리 수준까지 작동 원리를 이해하세요.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
리버스 엔지니어링 커뮤니티에 참여하세요
Discord · 질문과 답변 · 결과 공유
@@ -67,7 +67,7 @@ npx rea-agents setup
에이전트를 선택하고, 예정된 변경 사항을 검토한 뒤 승인하세요. 설정 과정은 기존 설정을 백업하고 REA의 MCP 서버와 버전에 맞는 워크플로 지침을 추가합니다. 완료 후 에이전트를 다시 시작하세요.
-설정은 Claude Code, Codex, Cursor, Gemini CLI, Grok Build 및 [다른 에이전트](docs/installation.md#supported-agents)를 지원합니다. 제공자 설정과 수동 MCP 등록은 [설치 및 설정](docs/installation.md)을 참고하세요.
+설정은 Claude Code, Codex, Cursor, Gemini CLI, Grok Build 및 [다른 에이전트](../installation.md#supported-agents)를 지원합니다. 제공자 설정과 수동 MCP 등록은 [설치 및 설정](../installation.md)을 참고하세요.
### 에이전트에게 요청
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-네이티브 분석에는 먼저 제공자를 설정해야 합니다. 네이티브 명령, 제공자 선택, 스냅샷, 스크립트 사용은 [CLI 및 Evidence 가이드](docs/cli.md)를 참고하세요.
+네이티브 분석에는 먼저 제공자를 설정해야 합니다. 네이티브 명령, 제공자 선택, 스냅샷, 스크립트 사용은 [CLI 및 Evidence 가이드](../cli.md)를 참고하세요.
### REA 업데이트
@@ -120,9 +120,9 @@ npx rea-agents@latest setup
에이전트는 MCP를 통해 REA를 호출하여 대상을 검사하고 관련 코드를 추적합니다. REA는 조사 결과와 근거를 반환합니다. 에이전트는 이를 바탕으로 추가 질문을 하고, 동작을 설명하거나, 구현을 작성하고 테스트합니다. CLI 명령도 같은 워크플로를 사용합니다.
-
+
-[원본 크기의 그림 열기](website/public/assets/figures/rea-investigation-flow.svg).
+[원본 크기의 그림 열기](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ npx rea-agents@latest setup
REA에는 Node.js 22.x(>=22.19), 24.x(>=24.11) 또는 26+와 npm이 필요합니다. 추가 도구와 호스트 지원은 대상에 따라 다릅니다.
-| 대상 | REA가 반환하는 내용 | 요구 사항 및 가이드 |
-| --------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
-| 네이티브 바이너리 | 의사 코드, 어셈블리, 문자열, 심볼, 호출, 참조 | Hopper, Ghidra 또는 IDA; [네이티브 분석](https://rea.tools/ko/guides/native/) |
-| 오프라인 ELF 레이아웃 | 섹션, 세그먼트, 원본 심볼/재배치 정보, 정적 분석으로 얻은 보안 완화 기법 후보 | Linux x64에서 호출자가 제공하는 pwntools; [바이너리 진단](docs/binary-diagnostics.md) |
-| EVM 바이트코드 | 디스패치 선택자, 바이트 오프셋, 추론한 인자와 상태 변경 가능 여부 | Linux x64의 로컬 원시 바이트/16진수 입력 파일; [오프라인 EVM 가이드](docs/evm-bytecode.md) |
-| 기록된 Linux 크래시 | 원시 note 레코드, 기록된 모든 스레드의 레지스터/시그널, 선택적 매핑 후보 | Linux x64에서 호출자가 제공하는 pwntools; GDB/pwndbg는 선택 사항; [기록된 크래시](docs/recorded-crashes.md) |
-| JavaScript / Electron | 모듈, 임포트, 소스 맵, 라우트, IPC, 네이티브 애드온 관계 | Node.js와 npm; [애플리케이션 분석](https://rea.tools/ko/guides/javascript/) |
-| 웹사이트 | 페이지 구조, 스크립트, 네트워크 관찰 결과, 요청한 스크린샷 | Chrome 계열 브라우저; [브라우저 분석](https://rea.tools/ko/guides/browser/) |
-| 저장된 네트워크 캡처 | 요청, 응답, 접근 가능한 페이로드, 소스 위치 | HAR; mitmproxy 네이티브 캡처에는 Linux의 mitmdump; [캡처 가이드](docs/web-network-captures.md) |
-| 패킷 캡처 | 엔드포인트, DNS, TLS SNI, 프로토콜 분포, HTTP 요청 | 호출자 제공 tshark 및 capinfos; [pcap 가이드](docs/pcap-analysis.md) |
-| .NET 어셈블리 | 메타데이터, CIL 명령, 선언된 네이티브 의존성, 빌드 비교 | 정적 검사; [관리 코드 가이드](docs/managed-code-analysis.md) |
-| Android APK | 매니페스트 선언, 클래스, 디컴파일된 메서드, 참조 | Linux/macOS/Windows x64의 헤드리스 JADX와 전체 JDK; [Android 가이드](docs/android-analysis.md) |
-| Android 기기 | 기기, 패키지, 프로세스, 로그, 덤프, 화면 캡처, APK/파일 전송 | 호출자 제공 adb(에뮬레이터 또는 실제 기기); [ADB 가이드](docs/adb-device-analysis.md) |
-| JEB 프로젝트 | 엔진 기반 프로젝트 유닛, 아티팩트 해시, 타입/메서드 의사코드 | 호출자가 시작하고 MCP를 제공하는 JEB 클라이언트(REA_JEB_MCP_URL로 선택); [JEB 가이드](docs/jeb-analysis.md) |
-| Android 리소스 | 디코딩된 매니페스트, 문자열 테이블, 로캘, 버전 정보 | 호출자 제공 Apktool 런처; [리소스 가이드](docs/apktool-resource-analysis.md) |
-| Flutter 앱 | Dart 스냅샷 해시, ABI별 라이브러리 해시, 엔진 빌드 출처 | 없음 (정적 APK 파싱); [Flutter 가이드](docs/flutter-analysis.md) |
-| 펌웨어 | 영역, 추출 결과, 네이티브 분석으로 전달할 정보 | Linux의 Binwalk / Unblob; [펌웨어 가이드](docs/firmware-analysis.md) |
-| 기록된 패킷 | 선택 필드, 반복 값, 필터 및 디코딩 규칙 | Linux: TShark 4.x + prlimit; [캡처 가이드](docs/packet-captures.md) |
-| 기록된 논리 신호 | 디코더 주석, 샘플 범위, 진단 정보 | Linux: sigrok-cli 0.7.2 + prlimit; [신호 기록 가이드](docs/signal-recordings.md) |
-| 패키지 및 리소스 | 파일 목록, 다이제스트, plist, Apple 번들 구조, 추출한 리소스 | [아티팩트 및 JavaScript 가이드](docs/javascript-artifact-reconstruction.md), [Apple 애플리케이션](docs/apple-application-analysis.md) |
-| 프로세스 동작 | 터미널 출력, 상호작용, 종료 및 파일 시스템 관찰 결과, 실행 비교 | 네이티브 PTY를 지원하는 Linux/macOS; [프로세스 캡처](docs/process-capture.md) |
+| 대상 | REA가 반환하는 내용 | 요구 사항 및 가이드 |
+| --------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| 네이티브 바이너리 | 의사 코드, 어셈블리, 문자열, 심볼, 호출, 참조 | Hopper, Ghidra 또는 IDA; [네이티브 분석](https://rea.tools/ko/guides/native/) |
+| 오프라인 ELF 레이아웃 | 섹션, 세그먼트, 원본 심볼/재배치 정보, 정적 분석으로 얻은 보안 완화 기법 후보 | Linux x64에서 호출자가 제공하는 pwntools; [바이너리 진단](../binary-diagnostics.md) |
+| EVM 바이트코드 | 디스패치 선택자, 바이트 오프셋, 추론한 인자와 상태 변경 가능 여부 | Linux x64의 로컬 원시 바이트/16진수 입력 파일; [오프라인 EVM 가이드](../evm-bytecode.md) |
+| 기록된 Linux 크래시 | 원시 note 레코드, 기록된 모든 스레드의 레지스터/시그널, 선택적 매핑 후보 | Linux x64에서 호출자가 제공하는 pwntools; GDB/pwndbg는 선택 사항; [기록된 크래시](../recorded-crashes.md) |
+| JavaScript / Electron | 모듈, 임포트, 소스 맵, 라우트, IPC, 네이티브 애드온 관계 | Node.js와 npm; [애플리케이션 분석](https://rea.tools/ko/guides/javascript/) |
+| 웹사이트 | 페이지 구조, 스크립트, 네트워크 관찰 결과, 요청한 스크린샷 | Chrome 계열 브라우저; [브라우저 분석](https://rea.tools/ko/guides/browser/) |
+| 저장된 네트워크 캡처 | 요청, 응답, 접근 가능한 페이로드, 소스 위치 | HAR; mitmproxy 네이티브 캡처에는 Linux의 mitmdump; [캡처 가이드](../web-network-captures.md) |
+| 패킷 캡처 | 엔드포인트, DNS, TLS SNI, 프로토콜 분포, HTTP 요청 | 호출자 제공 tshark 및 capinfos; [pcap 가이드](../pcap-analysis.md) |
+| .NET 어셈블리 | 메타데이터, CIL 명령, 선언된 네이티브 의존성, 빌드 비교 | 정적 검사; [관리 코드 가이드](../managed-code-analysis.md) |
+| Android APK | 매니페스트 선언, 클래스, 디컴파일된 메서드, 참조 | Linux/macOS/Windows x64의 헤드리스 JADX와 전체 JDK; [Android 가이드](../android-analysis.md) |
+| Android 기기 | 기기, 패키지, 프로세스, 로그, 덤프, 화면 캡처, APK/파일 전송 | 호출자 제공 adb(에뮬레이터 또는 실제 기기); [ADB 가이드](../adb-device-analysis.md) |
+| JEB 프로젝트 | 엔진 기반 프로젝트 유닛, 아티팩트 해시, 타입/메서드 의사코드 | 호출자가 시작하고 MCP를 제공하는 JEB 클라이언트(REA_JEB_MCP_URL로 선택); [JEB 가이드](../jeb-analysis.md) |
+| Android 리소스 | 디코딩된 매니페스트, 문자열 테이블, 로캘, 버전 정보 | 호출자 제공 Apktool 런처; [리소스 가이드](../apktool-resource-analysis.md) |
+| Flutter 앱 | Dart 스냅샷 해시, ABI별 라이브러리 해시, 엔진 빌드 출처 | 없음 (정적 APK 파싱); [Flutter 가이드](../flutter-analysis.md) |
+| 펌웨어 | 영역, 추출 결과, 네이티브 분석으로 전달할 정보 | Linux의 Binwalk / Unblob; [펌웨어 가이드](../firmware-analysis.md) |
+| 기록된 패킷 | 선택 필드, 반복 값, 필터 및 디코딩 규칙 | Linux: TShark 4.x + prlimit; [캡처 가이드](../packet-captures.md) |
+| 기록된 논리 신호 | 디코더 주석, 샘플 범위, 진단 정보 | Linux: sigrok-cli 0.7.2 + prlimit; [신호 기록 가이드](../signal-recordings.md) |
+| 패키지 및 리소스 | 파일 목록, 다이제스트, plist, Apple 번들 구조, 추출한 리소스 | [아티팩트 및 JavaScript 가이드](../javascript-artifact-reconstruction.md), [Apple 애플리케이션](../apple-application-analysis.md) |
+| 프로세스 동작 | 터미널 출력, 상호작용, 종료 및 파일 시스템 관찰 결과, 실행 비교 | 네이티브 PTY를 지원하는 Linux/macOS; [프로세스 캡처](../process-capture.md) |
정적 JavaScript 및 .NET 검사는 제공된 파일을 읽으며 애플리케이션을 실행하지 않습니다. 런타임 캡처는 사용자의 권한으로 선택한 대상을 실행하거나 대상과 상호작용합니다. 각 런타임 가이드에서 그 영향을 설명합니다.
-지원하는 네이티브 형식과 호스트는 제공자마다 다릅니다. [Hopper 및 Ghidra 설정](docs/installation.md#hopper), [IDA 가이드](docs/ida-provider.md), [실험적 Windows Ghidra 지원](docs/windows-ghidra-p0.md)을 참고하세요. Ghidra는 [16비트 DOS 분석](docs/ghidra-dos.md)도 지원합니다. 제공자 선택은 [CLI 가이드](docs/cli.md#choose-a-provider)를 참고하세요. 최신 npm 릴리스 이후 추가된 기능은 [릴리스에서의 사용 가능 여부](docs/installation.md#released-package-and-main)를 확인하세요.
+지원하는 네이티브 형식과 호스트는 제공자마다 다릅니다. [Hopper 및 Ghidra 설정](../installation.md#hopper), [IDA 가이드](../ida-provider.md), [실험적 Windows Ghidra 지원](../windows-ghidra-p0.md)을 참고하세요. Ghidra는 [16비트 DOS 분석](../ghidra-dos.md)도 지원합니다. 제공자 선택은 [CLI 가이드](../cli.md#choose-a-provider)를 참고하세요. 최신 npm 릴리스 이후 추가된 기능은 [릴리스에서의 사용 가능 여부](../installation.md#released-package-and-main)를 확인하세요.
## 사례
-[](https://rea.tools/ko/showcase/)
+[](https://rea.tools/ko/showcase/)
### DX-Ball: 사운드 패닝 계산 재구현
@@ -189,28 +189,28 @@ REA로 흥미로운 대상을 분석했다면 알려 주세요. [issue](https://
어떤 에이전트에서 REA를 사용할 수 있나요?
-로컬 MCP 서버를 지원하는 에이전트라면 사용할 수 있습니다. 설정 과정은 [지원하는 에이전트](docs/installation.md#supported-agents)를 구성합니다. 다른 클라이언트는 [수동 MCP 등록](docs/installation.md#mcp-registry)을 이용할 수 있습니다.
+로컬 MCP 서버를 지원하는 에이전트라면 사용할 수 있습니다. 설정 과정은 [지원하는 에이전트](../installation.md#supported-agents)를 구성합니다. 다른 클라이언트는 [수동 MCP 등록](../installation.md#mcp-registry)을 이용할 수 있습니다.
Hopper, Ghidra 또는 IDA가 필요한가요?
-심층 네이티브 분석에는 이 중 하나를 사용합니다. 정적 JavaScript 및 .NET 검사에는 네이티브 분석 엔진이 필요하지 않습니다. 설정 과정에서 승인 후 Hopper를 설치할 수 있으며, Ghidra와 IDA는 기존 설치를 사용합니다. [제공자 설정](docs/installation.md#hopper)을 참고하세요.
+심층 네이티브 분석에는 이 중 하나를 사용합니다. 정적 JavaScript 및 .NET 검사에는 네이티브 분석 엔진이 필요하지 않습니다. 설정 과정에서 승인 후 Hopper를 설치할 수 있으며, Ghidra와 IDA는 기존 설치를 사용합니다. [제공자 설정](../installation.md#hopper)을 참고하세요.
Hopper를 먼저 실행해야 하나요?
-REA는 작업에 필요할 때 Hopper를 실행합니다. macOS에서는 처음 실행할 때 데모 모드를 선택하거나 라이선스를 활성화하라는 대화 상자가 나타날 수 있습니다. [Hopper 실행 및 문제 해결](docs/installation.md#launcher-paths-and-troubleshooting)을 참고하세요.
+REA는 작업에 필요할 때 Hopper를 실행합니다. macOS에서는 처음 실행할 때 데모 모드를 선택하거나 라이선스를 활성화하라는 대화 상자가 나타날 수 있습니다. [Hopper 실행 및 문제 해결](../installation.md#launcher-paths-and-troubleshooting)을 참고하세요.
skills.sh에서 설치하는 스킬은 어떤 역할을 하나요?
-스킬은 에이전트에게 조사 지침을 제공합니다. `npx rea-agents setup`으로 REA의 MCP 서버를 등록하고 버전에 맞는 지침을 설치한 뒤 에이전트를 다시 시작하세요. [스킬만 설치하기](docs/installation.md#skill-only-installation)를 참고하세요.
+스킬은 에이전트에게 조사 지침을 제공합니다. `npx rea-agents setup`으로 REA의 MCP 서버를 등록하고 버전에 맞는 지침을 설치한 뒤 에이전트를 다시 시작하세요. [스킬만 설치하기](../installation.md#skill-only-installation)를 참고하세요.
@@ -253,14 +253,14 @@ npx rea-agents@latest setup
웹사이트의 [실습 가이드](https://rea.tools/ko/guides/)부터 읽어 보세요. 정확한 옵션, 사전 요구 사항, 결과 계약은 다음 문서를 참고하세요.
-- [설치 및 설정](docs/installation.md): 에이전트 등록, 제공자 설정, 업데이트, 제거.
-- [준비 상태 확인 및 문제 해결](docs/installation.md#check-readiness-for-your-task): 특정 에이전트 또는 분석 엔진 진단.
-- [CLI 및 Evidence](docs/cli.md): 명령, 제공자 선택, 스냅샷, 가져오기/내보내기, 종료 상태.
-- [MCP 계약](docs/mcp-contracts.md) 및 [에이전트 프롬프트](docs/mcp-prompts.md): 도구 결과, 세션, 안내에 따른 조사.
-- [도구 카탈로그](docs/mcp-contracts.md#generated-catalog): 빌드 시 생성되는 도구, 제공자, CLI 명령 목록.
-- [로드맵](docs/roadmap.md): 계획된 작업과 기능 진행 상황.
+- [설치 및 설정](../installation.md): 에이전트 등록, 제공자 설정, 업데이트, 제거.
+- [준비 상태 확인 및 문제 해결](../installation.md#check-readiness-for-your-task): 특정 에이전트 또는 분석 엔진 진단.
+- [CLI 및 Evidence](../cli.md): 명령, 제공자 선택, 스냅샷, 가져오기/내보내기, 종료 상태.
+- [MCP 계약](../mcp-contracts.md) 및 [에이전트 프롬프트](../mcp-prompts.md): 도구 결과, 세션, 안내에 따른 조사.
+- [도구 카탈로그](../mcp-contracts.md#generated-catalog): 빌드 시 생성되는 도구, 제공자, CLI 명령 목록.
+- [로드맵](../roadmap.md): 계획된 작업과 기능 진행 상황.
-취약점은 [SECURITY.md](SECURITY.md)에 따라 보고하세요.
+취약점은 [SECURITY.md](../../SECURITY.md)에 따라 보고하세요.
## 스타 기록
@@ -278,7 +278,7 @@ REA를 사용하고, 버그를 보고하고, 기능을 요청하고, 빌드를
## 면책 조항
-책임 있는 사용에 관한 안내는 [DISCLAIMER.md](DISCLAIMER.md)를 참고하세요.
+책임 있는 사용에 관한 안내는 [DISCLAIMER.md](../../DISCLAIMER.md)를 참고하세요.
REA는 법을 준수하는 연구, 교육, 상호운용성 확보, 소프트웨어 보존, 그리고 본인이 소유하거나 조사 권한을 가진 소프트웨어의 분석을 위한 도구입니다.
@@ -290,14 +290,14 @@ applicable licenses.
REA에 도움을 보태 주세요! [issue를 등록](https://github.com/morluto/rea/issues)해 버그나 기능을 제안하거나, [pull request를 보내](https://github.com/morluto/rea/pulls) 코드와 문서를 개선할 수 있습니다.
-개발 환경과 검사 항목은 [CONTRIBUTING.md](CONTRIBUTING.md), 검증 절차는 [테스트 가이드](docs/testing.md), 프로젝트 구조는 [아키텍처 지도](docs/architecture.mermaid)를 참고하세요.
+개발 환경과 검사 항목은 [CONTRIBUTING.md](../../CONTRIBUTING.md), 검증 절차는 [테스트 가이드](../testing.md), 프로젝트 구조는 [아키텍처 지도](../architecture.mermaid)를 참고하세요.
## 라이선스
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_pl.md b/docs/readme/README_pl.md
similarity index 76%
rename from README_pl.md
rename to docs/readme/README_pl.md
index c54af50fe..48200087d 100644
--- a/README_pl.md
+++ b/docs/readme/README_pl.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · **Polski** · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · **Polski** · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: Reverse Engineer Anything
@@ -9,10 +9,10 @@
**Widzisz funkcję, która Ci się podoba? Dowiedz się, jak działa, aż do poziomu kodu binarnego.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Dołącz do społeczności inżynierii wstecznej
Discord · Pytania i odpowiedzi · Pokaż swój projekt
@@ -67,7 +67,7 @@ npx rea-agents setup
Wybierz swoich agentów, sprawdź proponowane zmiany i zatwierdź je. Konfigurator dodaje serwer MCP REA i pasujące instrukcje pracy, tworząc kopie zapasowe istniejącej konfiguracji. Następnie uruchom agenta ponownie.
-Konfigurator obsługuje Claude Code, Codex, Cursor, Gemini CLI, Grok Build i [innych agentów](docs/installation.md#supported-agents). Konfigurację dostawców analizy i ręczną rejestrację MCP opisuje przewodnik [instalacji i konfiguracji](docs/installation.md).
+Konfigurator obsługuje Claude Code, Codex, Cursor, Gemini CLI, Grok Build i [innych agentów](../installation.md#supported-agents). Konfigurację dostawców analizy i ręczną rejestrację MCP opisuje przewodnik [instalacji i konfiguracji](../installation.md).
### Zapytaj agenta
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-Przed analizą kodu natywnego skonfiguruj dostawcę analizy. Polecenia analizy natywnej, wybór dostawcy, migawki i użycie w skryptach opisuje [przewodnik CLI i Evidence](docs/cli.md).
+Przed analizą kodu natywnego skonfiguruj dostawcę analizy. Polecenia analizy natywnej, wybór dostawcy, migawki i użycie w skryptach opisuje [przewodnik CLI i Evidence](../cli.md).
### Zaktualizuj REA
@@ -120,9 +120,9 @@ Sprawdź zmiany konfiguracji i uruchom agenta ponownie. Do jednorazowych polece
Twój agent wywołuje REA przez MCP, aby analizować cel i śledzić istotny kod. REA zwraca ustalenia wraz z dowodami. Agent wykorzystuje je do zadawania dalszych pytań, wyjaśniania zachowania lub pisania i testowania implementacji. Polecenia CLI korzystają z tych samych procedur.
-
+
-[Otwórz ilustrację w pełnym rozmiarze](website/public/assets/figures/rea-investigation-flow.svg).
+[Otwórz ilustrację w pełnym rozmiarze](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ Twój agent wywołuje REA przez MCP, aby analizować cel i śledzić istotny kod
REA wymaga Node.js 22.x (>=22.19), 24.x (>=24.11) lub 26+ oraz npm. Dodatkowe narzędzia i obsługiwane platformy zależą od celu analizy:
-| Cel | Co zwraca REA | Wymagania i przewodnik |
-| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| Natywne pliki binarne | Pseudokod, kod asemblera, ciągi znaków, symbole, wywołania i odwołania | Hopper, Ghidra lub IDA; [analiza kodu natywnego](https://rea.tools/pl/guides/native/) |
-| Układ pliku ELF w trybie offline | Sekcje, segmenty, oryginalne symbole/relokacje i potencjalne mechanizmy zabezpieczeń wskazane przez analizę statyczną | pwntools dostarczone przez użytkownika w systemie Linux x64; [diagnostyka plików binarnych](docs/binary-diagnostics.md) |
-| Kod bajtowy EVM | Selektory wywołań, przesunięcia bajtowe, wywnioskowane argumenty i mutowalność | Lokalny plik z surowymi bajtami lub zapisem szesnastkowym w systemie Linux x64; [przewodnik EVM offline](docs/evm-bytecode.md) |
-| Zarejestrowane awarie systemu Linux | Surowe rekordy note, rejestry/sygnały każdego zarejestrowanego wątku i opcjonalni kandydaci na mapowania | pwntools dostarczone przez użytkownika w systemie Linux x64; opcjonalnie GDB/pwndbg; [zarejestrowane awarie](docs/recorded-crashes.md) |
-| JavaScript / Electron | Moduły, importy, mapy źródeł, trasy, IPC i powiązania z natywnymi dodatkami | Node.js i npm; [analiza aplikacji](https://rea.tools/pl/guides/javascript/) |
-| Strony internetowe | Struktura strony, skrypty, obserwacje sieciowe i zamówione zrzuty ekranu | Przeglądarka z rodziny Chrome; [analiza w przeglądarce](https://rea.tools/pl/guides/browser/) |
-| Zapisane przechwycenia ruchu sieciowego | Żądania, odpowiedzi, dostępne dane przesyłane i lokalizacje źródłowe | HAR; mitmdump w systemie Linux dla natywnych przechwyceń mitmproxy; [przewodnik przechwytywania](docs/web-network-captures.md) |
-| Przechwytywanie pakietów | Punkty końcowe, DNS, TLS SNI, dystrybucja protokołów i żądania HTTP | Dostarczone przez wywołującego tshark i capinfos; [przewodnik pcap](docs/pcap-analysis.md) |
-| Zestawy .NET | Metadane, instrukcje CIL, zadeklarowane zależności natywne i porównania kompilacji | Analiza statyczna; [przewodnik kodu zarządzanego](docs/managed-code-analysis.md) |
-| Pakiety APK dla Androida | Deklaracje manifestu, klasy, zdekompilowane metody i odwołania | JADX bez interfejsu graficznego i pełny JDK w systemach Linux/macOS/Windows x64; [przewodnik Androida](docs/android-analysis.md) |
-| Urządzenia z Androidem | Urządzenia, pakiety, procesy, logi, zrzuty, zrzuty ekranu oraz transfery APK/plików | adb dostarczony przez wywołującego (emulator lub urządzenie); [przewodnik ADB](docs/adb-device-analysis.md) |
-| Projekty JEB | Jednostki projektu obsługiwane przez silnik, skróty artefaktów i pseudokod typów/metod | Uruchomiony przez wywołującego klient JEB udostępniający MCP, wybrany przez REA_JEB_MCP_URL; [przewodnik JEB](docs/jeb-analysis.md) |
-| Zasoby Androida | Zdekodowany manifest, tablice ciągów, języki i informacje o wersji | Należący do wywołującego launcher Apktool; [przewodnik zasobów](docs/apktool-resource-analysis.md) |
-| Aplikacje Flutter | Hash migawki Dart, sumy bibliotek per ABI i pochodzenie kompilacji silnika | Brak (statyczna analiza APK); [przewodnik Flutter](docs/flutter-analysis.md) |
-| Oprogramowanie układowe | Regiony, wyniki wyodrębniania i przekazanie do analizy kodu natywnego | Binwalk / Unblob w systemie Linux; [przewodnik oprogramowania układowego](docs/firmware-analysis.md) |
-| Zapisane pakiety | Wybrane pola, powtarzane wartości, filtry i reguły dekodowania | Linux: TShark 4.x + prlimit; [przewodnik po przechwyconych pakietach](docs/packet-captures.md) |
-| Zapisane sygnały logiczne | Adnotacje dekodera, zakresy próbek i diagnostyka | Linux: sigrok-cli 0.7.2 + prlimit; [przewodnik po sygnałach](docs/signal-recordings.md) |
-| Pakiety i zasoby | Spisy plików, skróty, pliki plist, struktura pakietów Apple i wyodrębnione zasoby | [Przewodnik artefaktów i JavaScript](docs/javascript-artifact-reconstruction.md), [aplikacje Apple](docs/apple-application-analysis.md) |
-| Zachowanie procesów | Wyjście terminala, interakcje, obserwacje zakończenia i systemu plików oraz porównania uruchomień | Linux/macOS z natywnym PTY; [przechwytywanie procesów](docs/process-capture.md) |
+| Cel | Co zwraca REA | Wymagania i przewodnik |
+| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
+| Natywne pliki binarne | Pseudokod, kod asemblera, ciągi znaków, symbole, wywołania i odwołania | Hopper, Ghidra lub IDA; [analiza kodu natywnego](https://rea.tools/pl/guides/native/) |
+| Układ pliku ELF w trybie offline | Sekcje, segmenty, oryginalne symbole/relokacje i potencjalne mechanizmy zabezpieczeń wskazane przez analizę statyczną | pwntools dostarczone przez użytkownika w systemie Linux x64; [diagnostyka plików binarnych](../binary-diagnostics.md) |
+| Kod bajtowy EVM | Selektory wywołań, przesunięcia bajtowe, wywnioskowane argumenty i mutowalność | Lokalny plik z surowymi bajtami lub zapisem szesnastkowym w systemie Linux x64; [przewodnik EVM offline](../evm-bytecode.md) |
+| Zarejestrowane awarie systemu Linux | Surowe rekordy note, rejestry/sygnały każdego zarejestrowanego wątku i opcjonalni kandydaci na mapowania | pwntools dostarczone przez użytkownika w systemie Linux x64; opcjonalnie GDB/pwndbg; [zarejestrowane awarie](../recorded-crashes.md) |
+| JavaScript / Electron | Moduły, importy, mapy źródeł, trasy, IPC i powiązania z natywnymi dodatkami | Node.js i npm; [analiza aplikacji](https://rea.tools/pl/guides/javascript/) |
+| Strony internetowe | Struktura strony, skrypty, obserwacje sieciowe i zamówione zrzuty ekranu | Przeglądarka z rodziny Chrome; [analiza w przeglądarce](https://rea.tools/pl/guides/browser/) |
+| Zapisane przechwycenia ruchu sieciowego | Żądania, odpowiedzi, dostępne dane przesyłane i lokalizacje źródłowe | HAR; mitmdump w systemie Linux dla natywnych przechwyceń mitmproxy; [przewodnik przechwytywania](../web-network-captures.md) |
+| Przechwytywanie pakietów | Punkty końcowe, DNS, TLS SNI, dystrybucja protokołów i żądania HTTP | Dostarczone przez wywołującego tshark i capinfos; [przewodnik pcap](../pcap-analysis.md) |
+| Zestawy .NET | Metadane, instrukcje CIL, zadeklarowane zależności natywne i porównania kompilacji | Analiza statyczna; [przewodnik kodu zarządzanego](../managed-code-analysis.md) |
+| Pakiety APK dla Androida | Deklaracje manifestu, klasy, zdekompilowane metody i odwołania | JADX bez interfejsu graficznego i pełny JDK w systemach Linux/macOS/Windows x64; [przewodnik Androida](../android-analysis.md) |
+| Urządzenia z Androidem | Urządzenia, pakiety, procesy, logi, zrzuty, zrzuty ekranu oraz transfery APK/plików | adb dostarczony przez wywołującego (emulator lub urządzenie); [przewodnik ADB](../adb-device-analysis.md) |
+| Projekty JEB | Jednostki projektu obsługiwane przez silnik, skróty artefaktów i pseudokod typów/metod | Uruchomiony przez wywołującego klient JEB udostępniający MCP, wybrany przez REA_JEB_MCP_URL; [przewodnik JEB](../jeb-analysis.md) |
+| Zasoby Androida | Zdekodowany manifest, tablice ciągów, języki i informacje o wersji | Należący do wywołującego launcher Apktool; [przewodnik zasobów](../apktool-resource-analysis.md) |
+| Aplikacje Flutter | Hash migawki Dart, sumy bibliotek per ABI i pochodzenie kompilacji silnika | Brak (statyczna analiza APK); [przewodnik Flutter](../flutter-analysis.md) |
+| Oprogramowanie układowe | Regiony, wyniki wyodrębniania i przekazanie do analizy kodu natywnego | Binwalk / Unblob w systemie Linux; [przewodnik oprogramowania układowego](../firmware-analysis.md) |
+| Zapisane pakiety | Wybrane pola, powtarzane wartości, filtry i reguły dekodowania | Linux: TShark 4.x + prlimit; [przewodnik po przechwyconych pakietach](../packet-captures.md) |
+| Zapisane sygnały logiczne | Adnotacje dekodera, zakresy próbek i diagnostyka | Linux: sigrok-cli 0.7.2 + prlimit; [przewodnik po sygnałach](../signal-recordings.md) |
+| Pakiety i zasoby | Spisy plików, skróty, pliki plist, struktura pakietów Apple i wyodrębnione zasoby | [Przewodnik artefaktów i JavaScript](../javascript-artifact-reconstruction.md), [aplikacje Apple](../apple-application-analysis.md) |
+| Zachowanie procesów | Wyjście terminala, interakcje, obserwacje zakończenia i systemu plików oraz porównania uruchomień | Linux/macOS z natywnym PTY; [przechwytywanie procesów](../process-capture.md) |
Statyczna analiza JavaScript i .NET odczytuje dostarczone pliki bez uruchamiania aplikacji. Przechwytywanie w czasie wykonywania uruchamia wybrany cel lub wchodzi z nim w interakcje z uprawnieniami Twojego użytkownika; skutki opisano w odpowiednich przewodnikach.
-Obsługiwane formaty natywne i platformy zależą od dostawcy analizy. Zobacz [konfigurację Hoppera i Ghidry](docs/installation.md#hopper), [przewodnik IDA](docs/ida-provider.md) oraz [eksperymentalną obsługę Ghidry w systemie Windows](docs/windows-ghidra-p0.md). Ghidra obsługuje też [analizę 16-bitowego DOS-a](docs/ghidra-dos.md). Wybór dostawcy opisuje [przewodnik CLI](docs/cli.md#choose-a-provider). Sprawdź [dostępność w wydaniach](docs/installation.md#released-package-and-main) dla funkcji dodanych po najnowszym wydaniu npm.
+Obsługiwane formaty natywne i platformy zależą od dostawcy analizy. Zobacz [konfigurację Hoppera i Ghidry](../installation.md#hopper), [przewodnik IDA](../ida-provider.md) oraz [eksperymentalną obsługę Ghidry w systemie Windows](../windows-ghidra-p0.md). Ghidra obsługuje też [analizę 16-bitowego DOS-a](../ghidra-dos.md). Wybór dostawcy opisuje [przewodnik CLI](../cli.md#choose-a-provider). Sprawdź [dostępność w wydaniach](../installation.md#released-package-and-main) dla funkcji dodanych po najnowszym wydaniu npm.
## Przykłady zastosowań
-[](https://rea.tools/pl/showcase/)
+[](https://rea.tools/pl/showcase/)
### DX-Ball: odtworzenie obliczania panoramy dźwięku
@@ -187,28 +187,28 @@ Jeśli użyłeś REA do czegoś ciekawego, chętnie to zobaczymy. Opisz swój pr
Którzy agenci mogą korzystać z REA?
-Każdy agent obsługujący lokalne serwery MCP. Konfigurator konfiguruje [obsługiwanych agentów](docs/installation.md#supported-agents); inne klienty mogą użyć [ręcznej rejestracji MCP](docs/installation.md#mcp-registry).
+Każdy agent obsługujący lokalne serwery MCP. Konfigurator konfiguruje [obsługiwanych agentów](../installation.md#supported-agents); inne klienty mogą użyć [ręcznej rejestracji MCP](../installation.md#mcp-registry).
Czy potrzebuję Hoppera, Ghidry lub IDA?
-Dogłębna analiza kodu natywnego używa jednego z nich. Statyczna analiza JavaScript i .NET działa bez silnika analizy natywnej. Konfigurator może zainstalować Hoppera po uzyskaniu zgody; Ghidra i IDA korzystają z istniejących instalacji. Zobacz [konfigurację dostawców analizy](docs/installation.md#hopper).
+Dogłębna analiza kodu natywnego używa jednego z nich. Statyczna analiza JavaScript i .NET działa bez silnika analizy natywnej. Konfigurator może zainstalować Hoppera po uzyskaniu zgody; Ghidra i IDA korzystają z istniejących instalacji. Zobacz [konfigurację dostawców analizy](../installation.md#hopper).
Czy muszę najpierw uruchomić Hoppera?
-REA uruchamia Hoppera, gdy wymaga tego operacja. W systemie macOS przy pierwszym uruchomieniu okno dialogowe może poprosić o wybór trybu demonstracyjnego lub aktywację licencji. Zobacz [uruchamianie Hoppera i rozwiązywanie problemów](docs/installation.md#launcher-paths-and-troubleshooting).
+REA uruchamia Hoppera, gdy wymaga tego operacja. W systemie macOS przy pierwszym uruchomieniu okno dialogowe może poprosić o wybór trybu demonstracyjnego lub aktywację licencji. Zobacz [uruchamianie Hoppera i rozwiązywanie problemów](../installation.md#launcher-paths-and-troubleshooting).
Co daje zainstalowanie umiejętności z skills.sh?
-Umiejętność dostarcza agentowi instrukcje prowadzenia analizy. Użyj `npx rea-agents setup`, aby zarejestrować serwer MCP REA i zainstalować pasujące instrukcje, a następnie uruchom agenta ponownie. Zobacz [instalację samej umiejętności](docs/installation.md#skill-only-installation).
+Umiejętność dostarcza agentowi instrukcje prowadzenia analizy. Użyj `npx rea-agents setup`, aby zarejestrować serwer MCP REA i zainstalować pasujące instrukcje, a następnie uruchom agenta ponownie. Zobacz [instalację samej umiejętności](../installation.md#skill-only-installation).
@@ -251,14 +251,14 @@ Jeśli używasz agenta, wykonaj [odświeżenie konfiguracji](#zaktualizuj-rea) i
Zacznij od [przewodników z przykładami](https://rea.tools/pl/guides/) na stronie internetowej. Dokładne opcje, wymagania wstępne i kontrakty wyników opisano tutaj:
-- [Instalacja i konfiguracja](docs/installation.md): rejestracja agentów, konfiguracja dostawców analizy, aktualizacje i odinstalowanie.
-- [Gotowość i rozwiązywanie problemów](docs/installation.md#check-readiness-for-your-task): diagnostyka jednego agenta lub silnika analizy.
-- [CLI i Evidence](docs/cli.md): polecenia, wybór dostawcy, migawki, import/eksport i kody zakończenia.
-- [Kontrakty MCP](docs/mcp-contracts.md) i [prompty dla agentów](docs/mcp-prompts.md): wyniki narzędzi, sesje i prowadzone analizy.
-- [Katalog narzędzi](docs/mcp-contracts.md#generated-catalog): generowany podczas kompilacji wykaz narzędzi, dostawców i poleceń CLI.
-- [Plan rozwoju](docs/roadmap.md): planowane prace i śledzenie funkcjonalności.
+- [Instalacja i konfiguracja](../installation.md): rejestracja agentów, konfiguracja dostawców analizy, aktualizacje i odinstalowanie.
+- [Gotowość i rozwiązywanie problemów](../installation.md#check-readiness-for-your-task): diagnostyka jednego agenta lub silnika analizy.
+- [CLI i Evidence](../cli.md): polecenia, wybór dostawcy, migawki, import/eksport i kody zakończenia.
+- [Kontrakty MCP](../mcp-contracts.md) i [prompty dla agentów](../mcp-prompts.md): wyniki narzędzi, sesje i prowadzone analizy.
+- [Katalog narzędzi](../mcp-contracts.md#generated-catalog): generowany podczas kompilacji wykaz narzędzi, dostawców i poleceń CLI.
+- [Plan rozwoju](../roadmap.md): planowane prace i śledzenie funkcjonalności.
-Zgłaszaj podatności zgodnie z [SECURITY.md](SECURITY.md).
+Zgłaszaj podatności zgodnie z [SECURITY.md](../../SECURITY.md).
## Historia gwiazdek
@@ -276,7 +276,7 @@ Dziękujemy wszystkim, którzy używają REA, zgłaszają błędy, proponują no
## Zastrzeżenie
-Wskazówki dotyczące odpowiedzialnego korzystania znajdziesz w [DISCLAIMER.md](DISCLAIMER.md).
+Wskazówki dotyczące odpowiedzialnego korzystania znajdziesz w [DISCLAIMER.md](../../DISCLAIMER.md).
REA służy zgodnym z prawem badaniom, edukacji, zapewnianiu interoperacyjności, zachowaniu oprogramowania oraz analizie oprogramowania, które posiadasz lub masz prawo badać.
@@ -288,14 +288,14 @@ applicable licenses.
Chętnie przyjmiemy Twoją pomoc w rozwoju REA! [Otwórz zgłoszenie](https://github.com/morluto/rea/issues), aby poinformować o błędzie lub zaproponować funkcję, albo [wyślij pull request](https://github.com/morluto/rea/pulls) z ulepszeniami kodu lub dokumentacji.
-Zobacz [CONTRIBUTING.md](CONTRIBUTING.md), aby poznać konfigurację środowiska programistycznego i kontrole, [testowanie](docs/testing.md), aby poznać ścieżki weryfikacji, oraz [mapę architektury](docs/architecture.mermaid), aby poznać strukturę projektu.
+Zobacz [CONTRIBUTING.md](../../CONTRIBUTING.md), aby poznać konfigurację środowiska programistycznego i kontrole, [testowanie](../testing.md), aby poznać ścieżki weryfikacji, oraz [mapę architektury](../architecture.mermaid), aby poznać strukturę projektu.
## Licencja
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_pt-BR.md b/docs/readme/README_pt-BR.md
similarity index 75%
rename from README_pt-BR.md
rename to docs/readme/README_pt-BR.md
index dd138f7ff..6c3f34e35 100644
--- a/README_pt-BR.md
+++ b/docs/readme/README_pt-BR.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · **Português (Brasil)** · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · **Português (Brasil)** · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: Faça engenharia reversa de qualquer coisa
@@ -9,10 +9,10 @@
**Viu uma funcionalidade de que gostou? Entenda como ela funciona, até o nível binário.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Participe da comunidade de engenharia reversa
Discord · Perguntas e respostas · Compartilhe seus resultados
@@ -67,7 +67,7 @@ npx rea-agents setup
Escolha seus agentes, revise as alterações propostas e aprove-as. A configuração adiciona o servidor MCP do REA e as instruções de fluxo de trabalho correspondentes, com backups das configurações existentes. Reinicie seu agente depois.
-A configuração oferece suporte ao Claude Code, Codex, Cursor, Gemini CLI, Grok Build e [outros agentes](docs/installation.md#supported-agents). Consulte [instalação e configuração](docs/installation.md) para configurar provedores e registrar o MCP manualmente.
+A configuração oferece suporte ao Claude Code, Codex, Cursor, Gemini CLI, Grok Build e [outros agentes](../installation.md#supported-agents). Consulte [instalação e configuração](../installation.md) para configurar provedores e registrar o MCP manualmente.
### Peça ao seu agente
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-Para análise nativa, configure primeiro um provedor. Consulte o [guia de CLI e Evidence](docs/cli.md) para comandos nativos, seleção de provedores, snapshots e uso em scripts.
+Para análise nativa, configure primeiro um provedor. Consulte o [guia de CLI e Evidence](../cli.md) para comandos nativos, seleção de provedores, snapshots e uso em scripts.
### Atualize o REA
@@ -120,9 +120,9 @@ Revise as alterações de configuração e reinicie seu agente. Para comandos av
Seu agente chama o REA por MCP para inspecionar o alvo e rastrear o código relevante. O REA retorna os resultados com suas evidências. O agente usa esses resultados para fazer novas perguntas, explicar o comportamento ou escrever e testar uma implementação. Os comandos da CLI usam os mesmos fluxos de trabalho.
-
+
-[Abra a figura em tamanho completo](website/public/assets/figures/rea-investigation-flow.svg).
+[Abra a figura em tamanho completo](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ Seu agente chama o REA por MCP para inspecionar o alvo e rastrear o código rele
O REA requer Node.js 22.x (>=22.19), 24.x (>=24.11) ou 26+, além do npm. As ferramentas adicionais e os sistemas anfitriões compatíveis dependem do alvo:
-| Alvo | O que o REA retorna | Requisitos e guia |
-| --------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
-| Binários nativos | Pseudocódigo, assembly, strings, símbolos, chamadas e referências | Hopper, Ghidra ou IDA; [análise nativa](https://rea.tools/pt-BR/guides/native/) |
-| Estrutura ELF sem execução | Seções, segmentos, símbolos/relocações originais e possíveis mecanismos de mitigação identificados por análise estática | pwntools fornecido pelo chamador no Linux x64; [diagnóstico de binários](docs/binary-diagnostics.md) |
-| Bytecode EVM | Seletores de despacho, offsets de bytes, argumentos inferidos e mutabilidade | Entrada local com bytes brutos ou representação hexadecimal no Linux x64; [guia de EVM sem execução](docs/evm-bytecode.md) |
-| Falhas do Linux registradas | Registros note brutos, registradores/sinais de cada thread registrada e candidatos opcionais a mapeamentos | pwntools fornecido pelo chamador no Linux x64; GDB/pwndbg opcionais; [falhas registradas](docs/recorded-crashes.md) |
-| JavaScript / Electron | Módulos, importações, source maps, rotas, IPC e relações com complementos nativos | Node.js e npm; [análise de aplicativos](https://rea.tools/pt-BR/guides/javascript/) |
-| Sites | Estrutura da página, scripts, observações de rede e capturas de tela solicitadas | Um navegador da família Chrome; [análise do navegador](https://rea.tools/pt-BR/guides/browser/) |
-| Capturas de rede salvas | Requisições, respostas, payloads acessíveis e localizações de origem | HAR; mitmdump no Linux para capturas no formato nativo do mitmproxy; [guia de capturas](docs/web-network-captures.md) |
-| Capturas de pacotes | Endpoints, DNS, TLS SNI, distribuição de protocolos e requisições HTTP | tshark e capinfos fornecidos pelo chamador; [guia pcap](docs/pcap-analysis.md) |
-| Assemblies .NET | Metadados, instruções CIL, dependências nativas declaradas e comparações de builds | Inspeção estática; [guia de código gerenciado](docs/managed-code-analysis.md) |
-| APKs Android | Declarações do manifesto, classes, métodos descompilados e referências | JADX sem interface gráfica e um JDK completo no Linux/macOS/Windows x64; [guia de Android](docs/android-analysis.md) |
-| Dispositivos Android | Dispositivos, pacotes, processos, logs, despejos, capturas de tela e transferências de APK/arquivos | adb fornecido pelo chamador (emulador ou aparelho); [guia de ADB](docs/adb-device-analysis.md) |
-| Projetos JEB | Unidades de projeto do motor, hashes de artefatos e pseudocódigo de tipos/métodos | Um cliente JEB iniciado pelo chamador servindo MCP, selecionado com REA_JEB_MCP_URL; [guia de JEB](docs/jeb-analysis.md) |
-| Recursos do Android | Manifesto decodificado, tabelas de strings, idiomas e fatos de versão | Lançador do Apktool fornecido pelo chamador; [guia de recursos](docs/apktool-resource-analysis.md) |
-| Aplicativos Flutter | Hash de snapshot Dart, hashes de bibliotecas por ABI e procedência de build do motor | Nenhuma (análise estática de APK); [guia Flutter](docs/flutter-analysis.md) |
-| Firmware | Regiões, resultados de extração e encaminhamentos à análise nativa | Binwalk / Unblob no Linux; [guia de firmware](docs/firmware-analysis.md) |
-| Pacotes gravados | Campos selecionados, valores repetidos, filtros e regras de decodificação | Linux: TShark 4.x + prlimit; [guia de capturas](docs/packet-captures.md) |
-| Sinais lógicos gravados | Anotações do decodificador, intervalos de amostras e diagnósticos | Linux: sigrok-cli 0.7.2 + prlimit; [guia de sinais](docs/signal-recordings.md) |
-| Pacotes e recursos | Inventários de arquivos, digests, plists, estrutura de bundles Apple e recursos extraídos | [Guia de artefatos e JavaScript](docs/javascript-artifact-reconstruction.md), [aplicativos Apple](docs/apple-application-analysis.md) |
-| Comportamento de processos | Saída do terminal, interações, observações de encerramento e do sistema de arquivos, e comparações entre execuções | Linux/macOS com PTY nativo; [captura de processos](docs/process-capture.md) |
+| Alvo | O que o REA retorna | Requisitos e guia |
+| --------------------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| Binários nativos | Pseudocódigo, assembly, strings, símbolos, chamadas e referências | Hopper, Ghidra ou IDA; [análise nativa](https://rea.tools/pt-BR/guides/native/) |
+| Estrutura ELF sem execução | Seções, segmentos, símbolos/relocações originais e possíveis mecanismos de mitigação identificados por análise estática | pwntools fornecido pelo chamador no Linux x64; [diagnóstico de binários](../binary-diagnostics.md) |
+| Bytecode EVM | Seletores de despacho, offsets de bytes, argumentos inferidos e mutabilidade | Entrada local com bytes brutos ou representação hexadecimal no Linux x64; [guia de EVM sem execução](../evm-bytecode.md) |
+| Falhas do Linux registradas | Registros note brutos, registradores/sinais de cada thread registrada e candidatos opcionais a mapeamentos | pwntools fornecido pelo chamador no Linux x64; GDB/pwndbg opcionais; [falhas registradas](../recorded-crashes.md) |
+| JavaScript / Electron | Módulos, importações, source maps, rotas, IPC e relações com complementos nativos | Node.js e npm; [análise de aplicativos](https://rea.tools/pt-BR/guides/javascript/) |
+| Sites | Estrutura da página, scripts, observações de rede e capturas de tela solicitadas | Um navegador da família Chrome; [análise do navegador](https://rea.tools/pt-BR/guides/browser/) |
+| Capturas de rede salvas | Requisições, respostas, payloads acessíveis e localizações de origem | HAR; mitmdump no Linux para capturas no formato nativo do mitmproxy; [guia de capturas](../web-network-captures.md) |
+| Capturas de pacotes | Endpoints, DNS, TLS SNI, distribuição de protocolos e requisições HTTP | tshark e capinfos fornecidos pelo chamador; [guia pcap](../pcap-analysis.md) |
+| Assemblies .NET | Metadados, instruções CIL, dependências nativas declaradas e comparações de builds | Inspeção estática; [guia de código gerenciado](../managed-code-analysis.md) |
+| APKs Android | Declarações do manifesto, classes, métodos descompilados e referências | JADX sem interface gráfica e um JDK completo no Linux/macOS/Windows x64; [guia de Android](../android-analysis.md) |
+| Dispositivos Android | Dispositivos, pacotes, processos, logs, despejos, capturas de tela e transferências de APK/arquivos | adb fornecido pelo chamador (emulador ou aparelho); [guia de ADB](../adb-device-analysis.md) |
+| Projetos JEB | Unidades de projeto do motor, hashes de artefatos e pseudocódigo de tipos/métodos | Um cliente JEB iniciado pelo chamador servindo MCP, selecionado com REA_JEB_MCP_URL; [guia de JEB](../jeb-analysis.md) |
+| Recursos do Android | Manifesto decodificado, tabelas de strings, idiomas e fatos de versão | Lançador do Apktool fornecido pelo chamador; [guia de recursos](../apktool-resource-analysis.md) |
+| Aplicativos Flutter | Hash de snapshot Dart, hashes de bibliotecas por ABI e procedência de build do motor | Nenhuma (análise estática de APK); [guia Flutter](../flutter-analysis.md) |
+| Firmware | Regiões, resultados de extração e encaminhamentos à análise nativa | Binwalk / Unblob no Linux; [guia de firmware](../firmware-analysis.md) |
+| Pacotes gravados | Campos selecionados, valores repetidos, filtros e regras de decodificação | Linux: TShark 4.x + prlimit; [guia de capturas](../packet-captures.md) |
+| Sinais lógicos gravados | Anotações do decodificador, intervalos de amostras e diagnósticos | Linux: sigrok-cli 0.7.2 + prlimit; [guia de sinais](../signal-recordings.md) |
+| Pacotes e recursos | Inventários de arquivos, digests, plists, estrutura de bundles Apple e recursos extraídos | [Guia de artefatos e JavaScript](../javascript-artifact-reconstruction.md), [aplicativos Apple](../apple-application-analysis.md) |
+| Comportamento de processos | Saída do terminal, interações, observações de encerramento e do sistema de arquivos, e comparações entre execuções | Linux/macOS com PTY nativo; [captura de processos](../process-capture.md) |
A inspeção estática de JavaScript e .NET lê os arquivos fornecidos sem executar o aplicativo. A captura em execução inicia o alvo selecionado ou interage com ele usando as permissões do seu usuário; cada guia descreve seus efeitos.
-Os formatos nativos e os sistemas anfitriões compatíveis variam por provedor. Consulte [configuração do Hopper e Ghidra](docs/installation.md#hopper), o [guia do IDA](docs/ida-provider.md) e o [suporte experimental ao Ghidra no Windows](docs/windows-ghidra-p0.md). O Ghidra também oferece [análise de DOS de 16 bits](docs/ghidra-dos.md). Para selecionar um provedor, consulte o [guia da CLI](docs/cli.md#choose-a-provider). Verifique a [disponibilidade nas versões](docs/installation.md#released-package-and-main) das funcionalidades adicionadas após a versão mais recente no npm.
+Os formatos nativos e os sistemas anfitriões compatíveis variam por provedor. Consulte [configuração do Hopper e Ghidra](../installation.md#hopper), o [guia do IDA](../ida-provider.md) e o [suporte experimental ao Ghidra no Windows](../windows-ghidra-p0.md). O Ghidra também oferece [análise de DOS de 16 bits](../ghidra-dos.md). Para selecionar um provedor, consulte o [guia da CLI](../cli.md#choose-a-provider). Verifique a [disponibilidade nas versões](../installation.md#released-package-and-main) das funcionalidades adicionadas após a versão mais recente no npm.
## Casos de uso
-[](https://rea.tools/pt-BR/showcase/)
+[](https://rea.tools/pt-BR/showcase/)
### DX-Ball: reconstruir um cálculo de panorâmica de áudio
@@ -187,28 +187,28 @@ Se você usou o REA em algo interessante, gostaríamos de conhecer. Compartilhe
Quais agentes podem usar o REA?
-Qualquer agente que ofereça suporte a servidores MCP locais. A configuração prepara os [agentes compatíveis](docs/installation.md#supported-agents); outros clientes podem usar o [registro manual do MCP](docs/installation.md#mcp-registry).
+Qualquer agente que ofereça suporte a servidores MCP locais. A configuração prepara os [agentes compatíveis](../installation.md#supported-agents); outros clientes podem usar o [registro manual do MCP](../installation.md#mcp-registry).
Preciso do Hopper, Ghidra ou IDA?
-A análise nativa aprofundada usa um desses motores. A inspeção estática de JavaScript e .NET funciona sem um motor de análise nativa. A configuração pode instalar o Hopper após aprovação; Ghidra e IDA usam as instalações existentes. Consulte [configuração dos provedores](docs/installation.md#hopper).
+A análise nativa aprofundada usa um desses motores. A inspeção estática de JavaScript e .NET funciona sem um motor de análise nativa. A configuração pode instalar o Hopper após aprovação; Ghidra e IDA usam as instalações existentes. Consulte [configuração dos provedores](../installation.md#hopper).
Preciso iniciar o Hopper antes?
-O REA inicia o Hopper quando uma operação precisa dele. No macOS, um diálogo na primeira execução pode pedir que você escolha o modo de demonstração ou ative a licença. Consulte [inicialização do Hopper e solução de problemas](docs/installation.md#launcher-paths-and-troubleshooting).
+O REA inicia o Hopper quando uma operação precisa dele. No macOS, um diálogo na primeira execução pode pedir que você escolha o modo de demonstração ou ative a licença. Consulte [inicialização do Hopper e solução de problemas](../installation.md#launcher-paths-and-troubleshooting).
O que faz a instalação da skill pelo skills.sh?
-A skill fornece instruções de investigação ao seu agente. Use `npx rea-agents setup` para registrar o servidor MCP do REA e instalar as instruções correspondentes, depois reinicie seu agente. Consulte [instalação apenas da skill](docs/installation.md#skill-only-installation).
+A skill fornece instruções de investigação ao seu agente. Use `npx rea-agents setup` para registrar o servidor MCP do REA e instalar as instruções correspondentes, depois reinicie seu agente. Consulte [instalação apenas da skill](../installation.md#skill-only-installation).
@@ -251,14 +251,14 @@ Se você usa um agente, conclua a [atualização da configuração](#atualize-o-
Comece pelos [guias práticos](https://rea.tools/pt-BR/guides/) do site. Para opções exatas, pré-requisitos e contratos dos resultados:
-- [Instalação e configuração](docs/installation.md): registro de agentes, configuração de provedores, atualizações e desinstalação.
-- [Prontidão e solução de problemas](docs/installation.md#check-readiness-for-your-task): diagnóstico de um agente ou motor de análise específico.
-- [CLI e Evidence](docs/cli.md): comandos, seleção de provedores, snapshots, importação/exportação e status de saída.
-- [Contratos MCP](docs/mcp-contracts.md) e [prompts para agentes](docs/mcp-prompts.md): resultados das ferramentas, sessões e investigações guiadas.
-- [Catálogo de ferramentas](docs/mcp-contracts.md#generated-catalog): inventário de ferramentas, provedores e comandos da CLI gerado durante o build.
-- [Roadmap](docs/roadmap.md): trabalho planejado e acompanhamento das capacidades.
+- [Instalação e configuração](../installation.md): registro de agentes, configuração de provedores, atualizações e desinstalação.
+- [Prontidão e solução de problemas](../installation.md#check-readiness-for-your-task): diagnóstico de um agente ou motor de análise específico.
+- [CLI e Evidence](../cli.md): comandos, seleção de provedores, snapshots, importação/exportação e status de saída.
+- [Contratos MCP](../mcp-contracts.md) e [prompts para agentes](../mcp-prompts.md): resultados das ferramentas, sessões e investigações guiadas.
+- [Catálogo de ferramentas](../mcp-contracts.md#generated-catalog): inventário de ferramentas, provedores e comandos da CLI gerado durante o build.
+- [Roadmap](../roadmap.md): trabalho planejado e acompanhamento das capacidades.
-Relate vulnerabilidades conforme [SECURITY.md](SECURITY.md).
+Relate vulnerabilidades conforme [SECURITY.md](../../SECURITY.md).
## Histórico de estrelas
@@ -276,7 +276,7 @@ Obrigado a todos que usam o REA, relatam bugs, sugerem funcionalidades, testam b
## Aviso legal
-Consulte [DISCLAIMER.md](DISCLAIMER.md) para orientações sobre o uso responsável.
+Consulte [DISCLAIMER.md](../../DISCLAIMER.md) para orientações sobre o uso responsável.
O REA destina-se à pesquisa, à educação, à interoperabilidade, à preservação de software e à análise de software que você possui ou está autorizado a examinar, dentro da lei.
@@ -288,14 +288,14 @@ applicable licenses.
Sua ajuda com o REA é bem-vinda! [Abra uma issue](https://github.com/morluto/rea/issues) para relatar um bug ou sugerir uma funcionalidade, ou [envie um pull request](https://github.com/morluto/rea/pulls) para melhorar o código ou a documentação.
-Consulte [CONTRIBUTING.md](CONTRIBUTING.md) para configurar o ambiente de desenvolvimento e as verificações, o [guia de testes](docs/testing.md) para os fluxos de verificação e o [mapa da arquitetura](docs/architecture.mermaid) para a estrutura do projeto.
+Consulte [CONTRIBUTING.md](../../CONTRIBUTING.md) para configurar o ambiente de desenvolvimento e as verificações, o [guia de testes](../testing.md) para os fluxos de verificação e o [mapa da arquitetura](../architecture.mermaid) para a estrutura do projeto.
## Licença
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_ru.md b/docs/readme/README_ru.md
similarity index 80%
rename from README_ru.md
rename to docs/readme/README_ru.md
index 34e7d3af2..744e26f6c 100644
--- a/README_ru.md
+++ b/docs/readme/README_ru.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · **Русский** · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · **Русский** · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: Реверс-инжиниринг чего угодно
@@ -9,10 +9,10 @@
**Нашли интересную функцию? Разберитесь, как она работает, вплоть до двоичного кода.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Присоединяйтесь к сообществу реверс-инжиниринга
Discord · Вопросы и ответы · Обмен результатами
@@ -67,7 +67,7 @@ npx rea-agents setup
Выберите агентов, проверьте предлагаемые изменения и подтвердите их. Настройка добавляет MCP-сервер REA и соответствующие рабочие инструкции, сохраняя резервные копии существующих настроек. После этого перезапустите агента.
-Настройка поддерживает Claude Code, Codex, Cursor, Gemini CLI, Grok Build и [других агентов](docs/installation.md#supported-agents). Настройка провайдеров и ручная регистрация MCP описаны в разделе [установка и настройка](docs/installation.md).
+Настройка поддерживает Claude Code, Codex, Cursor, Gemini CLI, Grok Build и [других агентов](../installation.md#supported-agents). Настройка провайдеров и ручная регистрация MCP описаны в разделе [установка и настройка](../installation.md).
### Задайте вопрос агенту
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-Для нативного анализа сначала настройте провайдер. Нативные команды, выбор провайдера, снимки и работу со скриптами описывает [руководство по CLI и Evidence](docs/cli.md).
+Для нативного анализа сначала настройте провайдер. Нативные команды, выбор провайдера, снимки и работу со скриптами описывает [руководство по CLI и Evidence](../cli.md).
### Обновите REA
@@ -120,9 +120,9 @@ npx rea-agents@latest setup
Агент вызывает REA через MCP, чтобы исследовать цель и проследить связанный код. REA возвращает результаты вместе с подтверждающими данными. Агент использует их для уточняющих вопросов, объяснения поведения или написания и тестирования реализации. Команды CLI используют те же рабочие процессы.
-
+
-[Открыть рисунок в полном размере](website/public/assets/figures/rea-investigation-flow.svg).
+[Открыть рисунок в полном размере](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ npx rea-agents@latest setup
REA требует Node.js 22.x (>=22.19), 24.x (>=24.11) или 26+, а также npm. Дополнительные инструменты и поддерживаемые системы зависят от цели:
-| Цель | Что возвращает REA | Требования и руководство |
-| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| Нативные бинарные файлы | Псевдокод, ассемблер, строки, символы, вызовы и ссылки | Hopper, Ghidra или IDA; [нативный анализ](https://rea.tools/ru/guides/native/) |
-| Структура ELF без запуска | Секции, сегменты, исходные символы/релокации и возможные механизмы защиты по данным статического анализа | pwntools, предоставленный вызывающей стороной, в Linux x64; [диагностика бинарных файлов](docs/binary-diagnostics.md) |
-| Байт-код EVM | Селекторы диспетчеризации, смещения байтов, предполагаемые аргументы и изменяемость состояния | Локальные необработанные байты или шестнадцатеричное представление в Linux x64; [руководство по EVM без запуска](docs/evm-bytecode.md) |
-| Записанные сбои Linux | Необработанные записи note, регистры/сигналы каждого записанного потока и необязательные кандидаты сопоставления с памятью | pwntools, предоставленный вызывающей стороной, в Linux x64; необязательные GDB/pwndbg; [записанные сбои](docs/recorded-crashes.md) |
-| JavaScript / Electron | Модули, импорты, карты исходного кода, маршруты, IPC и связи с нативными дополнениями | Node.js и npm; [анализ приложений](https://rea.tools/ru/guides/javascript/) |
-| Сайты | Структура страницы, скрипты, наблюдения за сетью и запрошенные снимки экрана | Браузер семейства Chrome; [анализ браузера](https://rea.tools/ru/guides/browser/) |
-| Сохранённые сетевые захваты | Запросы, ответы, доступные полезные данные и позиции в источнике | HAR; mitmdump в Linux для захватов в собственном формате mitmproxy; [руководство по сетевым захватам](docs/web-network-captures.md) |
-| Сборки .NET | Метаданные, инструкции CIL, объявленные нативные зависимости и сравнения сборок | Статическое исследование; [руководство по управляемому коду](docs/managed-code-analysis.md) |
-| Android APK | Объявления манифеста, классы, декомпилированные методы и ссылки | JADX без графического интерфейса и полный JDK в Linux/macOS/Windows x64; [руководство по Android](docs/android-analysis.md) |
-| Устройства Android | Устройства, пакеты, процессы, журналы, дампы, снимки экрана и передача APK/файлов | adb, предоставленный вызывающей стороной (эмулятор или устройство); [руководство по ADB](docs/adb-device-analysis.md) |
-| Проекты JEB | Единицы проекта от движка, дайджесты артефактов и псевдокод типов/методов | Запущенный вызывающей стороной клиент JEB с интерфейсом MCP, выбирается через REA_JEB_MCP_URL; [руководство по JEB](docs/jeb-analysis.md) |
-| Ресурсы Android | Декодированный манифест, таблицы строк, языки и сведения о версии | Запуск Apktool, предоставленный вызывающей стороной; [руководство по ресурсам](docs/apktool-resource-analysis.md) |
-| Приложения Flutter | Хеш снапшота Dart, дайджесты библиотек по ABI и происхождение сборки движка | Не требуется (статический разбор APK); [руководство по Flutter](docs/flutter-analysis.md) |
-| Прошивки | Области, результаты извлечения и передача в нативный анализ | Binwalk / Unblob в Linux; [руководство по прошивкам](docs/firmware-analysis.md) |
-| Записанные пакеты | Выбранные поля, повторяющиеся значения, фильтры и правила декодирования | Linux: TShark 4.x + prlimit; [руководство по захватам](docs/packet-captures.md) |
-| Захват пакетов | Конечные точки, DNS, TLS SNI, распределение протоколов и HTTP-запросы | Предоставленные вызывающей стороной tshark и capinfos; [руководство по pcap](docs/pcap-analysis.md) |
-| Записанные логические сигналы | Аннотации декодера, диапазоны отсчётов и диагностика | Linux: sigrok-cli 0.7.2 + prlimit; [руководство по сигналам](docs/signal-recordings.md) |
-| Пакеты и ресурсы | Списки файлов, хеши, plist, структура пакетов Apple и извлечённые ресурсы | [Руководство по артефактам и JavaScript](docs/javascript-artifact-reconstruction.md), [приложения Apple](docs/apple-application-analysis.md) |
-| Поведение процессов | Вывод терминала, взаимодействия, наблюдения за завершением и файловой системой, сравнения запусков | Linux/macOS с нативным PTY; [захват процессов](docs/process-capture.md) |
+| Цель | Что возвращает REA | Требования и руководство |
+| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| Нативные бинарные файлы | Псевдокод, ассемблер, строки, символы, вызовы и ссылки | Hopper, Ghidra или IDA; [нативный анализ](https://rea.tools/ru/guides/native/) |
+| Структура ELF без запуска | Секции, сегменты, исходные символы/релокации и возможные механизмы защиты по данным статического анализа | pwntools, предоставленный вызывающей стороной, в Linux x64; [диагностика бинарных файлов](../binary-diagnostics.md) |
+| Байт-код EVM | Селекторы диспетчеризации, смещения байтов, предполагаемые аргументы и изменяемость состояния | Локальные необработанные байты или шестнадцатеричное представление в Linux x64; [руководство по EVM без запуска](../evm-bytecode.md) |
+| Записанные сбои Linux | Необработанные записи note, регистры/сигналы каждого записанного потока и необязательные кандидаты сопоставления с памятью | pwntools, предоставленный вызывающей стороной, в Linux x64; необязательные GDB/pwndbg; [записанные сбои](../recorded-crashes.md) |
+| JavaScript / Electron | Модули, импорты, карты исходного кода, маршруты, IPC и связи с нативными дополнениями | Node.js и npm; [анализ приложений](https://rea.tools/ru/guides/javascript/) |
+| Сайты | Структура страницы, скрипты, наблюдения за сетью и запрошенные снимки экрана | Браузер семейства Chrome; [анализ браузера](https://rea.tools/ru/guides/browser/) |
+| Сохранённые сетевые захваты | Запросы, ответы, доступные полезные данные и позиции в источнике | HAR; mitmdump в Linux для захватов в собственном формате mitmproxy; [руководство по сетевым захватам](../web-network-captures.md) |
+| Сборки .NET | Метаданные, инструкции CIL, объявленные нативные зависимости и сравнения сборок | Статическое исследование; [руководство по управляемому коду](../managed-code-analysis.md) |
+| Android APK | Объявления манифеста, классы, декомпилированные методы и ссылки | JADX без графического интерфейса и полный JDK в Linux/macOS/Windows x64; [руководство по Android](../android-analysis.md) |
+| Устройства Android | Устройства, пакеты, процессы, журналы, дампы, снимки экрана и передача APK/файлов | adb, предоставленный вызывающей стороной (эмулятор или устройство); [руководство по ADB](../adb-device-analysis.md) |
+| Проекты JEB | Единицы проекта от движка, дайджесты артефактов и псевдокод типов/методов | Запущенный вызывающей стороной клиент JEB с интерфейсом MCP, выбирается через REA_JEB_MCP_URL; [руководство по JEB](../jeb-analysis.md) |
+| Ресурсы Android | Декодированный манифест, таблицы строк, языки и сведения о версии | Запуск Apktool, предоставленный вызывающей стороной; [руководство по ресурсам](../apktool-resource-analysis.md) |
+| Приложения Flutter | Хеш снапшота Dart, дайджесты библиотек по ABI и происхождение сборки движка | Не требуется (статический разбор APK); [руководство по Flutter](../flutter-analysis.md) |
+| Прошивки | Области, результаты извлечения и передача в нативный анализ | Binwalk / Unblob в Linux; [руководство по прошивкам](../firmware-analysis.md) |
+| Записанные пакеты | Выбранные поля, повторяющиеся значения, фильтры и правила декодирования | Linux: TShark 4.x + prlimit; [руководство по захватам](../packet-captures.md) |
+| Захват пакетов | Конечные точки, DNS, TLS SNI, распределение протоколов и HTTP-запросы | Предоставленные вызывающей стороной tshark и capinfos; [руководство по pcap](../pcap-analysis.md) |
+| Записанные логические сигналы | Аннотации декодера, диапазоны отсчётов и диагностика | Linux: sigrok-cli 0.7.2 + prlimit; [руководство по сигналам](../signal-recordings.md) |
+| Пакеты и ресурсы | Списки файлов, хеши, plist, структура пакетов Apple и извлечённые ресурсы | [Руководство по артефактам и JavaScript](../javascript-artifact-reconstruction.md), [приложения Apple](../apple-application-analysis.md) |
+| Поведение процессов | Вывод терминала, взаимодействия, наблюдения за завершением и файловой системой, сравнения запусков | Linux/macOS с нативным PTY; [захват процессов](../process-capture.md) |
Статическое исследование JavaScript и .NET читает предоставленные файлы, не запуская приложение. Захват во время выполнения запускает выбранную цель или взаимодействует с ней с правами вашего пользователя; соответствующие руководства описывают последствия.
-Нативные форматы и поддерживаемые системы различаются у разных провайдеров. См. [настройку Hopper и Ghidra](docs/installation.md#hopper), [руководство по IDA](docs/ida-provider.md) и [экспериментальную поддержку Ghidra в Windows](docs/windows-ghidra-p0.md). Ghidra также поддерживает [анализ 16-битного DOS](docs/ghidra-dos.md). Выбор провайдера описан в [руководстве по CLI](docs/cli.md#choose-a-provider). Для функций, добавленных после последней версии в npm, проверьте [доступность в релизах](docs/installation.md#released-package-and-main).
+Нативные форматы и поддерживаемые системы различаются у разных провайдеров. См. [настройку Hopper и Ghidra](../installation.md#hopper), [руководство по IDA](../ida-provider.md) и [экспериментальную поддержку Ghidra в Windows](../windows-ghidra-p0.md). Ghidra также поддерживает [анализ 16-битного DOS](../ghidra-dos.md). Выбор провайдера описан в [руководстве по CLI](../cli.md#choose-a-provider). Для функций, добавленных после последней версии в npm, проверьте [доступность в релизах](../installation.md#released-package-and-main).
## Примеры
-[](https://rea.tools/ru/showcase/)
+[](https://rea.tools/ru/showcase/)
### DX-Ball: восстановление расчёта звуковой панорамы
@@ -187,28 +187,28 @@ REA требует Node.js 22.x (>=22.19), 24.x (>=24.11) или 26+, а так
Какие агенты могут использовать REA?
-Любой агент с поддержкой локальных MCP-серверов. Настройка конфигурирует [поддерживаемых агентов](docs/installation.md#supported-agents); другие клиенты могут использовать [ручную регистрацию MCP](docs/installation.md#mcp-registry).
+Любой агент с поддержкой локальных MCP-серверов. Настройка конфигурирует [поддерживаемых агентов](../installation.md#supported-agents); другие клиенты могут использовать [ручную регистрацию MCP](../installation.md#mcp-registry).
Нужны ли мне Hopper, Ghidra или IDA?
-Углублённый нативный анализ использует один из этих инструментов. Статическое исследование JavaScript и .NET работает без движка нативного анализа. Настройка может установить Hopper после подтверждения; Ghidra и IDA используют существующие установки. См. [настройку провайдеров](docs/installation.md#hopper).
+Углублённый нативный анализ использует один из этих инструментов. Статическое исследование JavaScript и .NET работает без движка нативного анализа. Настройка может установить Hopper после подтверждения; Ghidra и IDA используют существующие установки. См. [настройку провайдеров](../installation.md#hopper).
Нужно ли сначала запускать Hopper?
-REA запускает Hopper, когда он нужен для операции. В macOS при первом запуске может появиться диалог выбора деморежима или активации лицензии. См. [запуск Hopper и устранение неполадок](docs/installation.md#launcher-paths-and-troubleshooting).
+REA запускает Hopper, когда он нужен для операции. В macOS при первом запуске может появиться диалог выбора деморежима или активации лицензии. См. [запуск Hopper и устранение неполадок](../installation.md#launcher-paths-and-troubleshooting).
Что даёт установка skill с skills.sh?
-Skill предоставляет агенту инструкции по исследованию. Используйте `npx rea-agents setup`, чтобы зарегистрировать MCP-сервер REA и установить соответствующие инструкции, затем перезапустите агента. См. [установку только skill](docs/installation.md#skill-only-installation).
+Skill предоставляет агенту инструкции по исследованию. Используйте `npx rea-agents setup`, чтобы зарегистрировать MCP-сервер REA и установить соответствующие инструкции, затем перезапустите агента. См. [установку только skill](../installation.md#skill-only-installation).
@@ -251,14 +251,14 @@ npx rea-agents@latest setup
Начните с [практических руководств](https://rea.tools/ru/guides/) на сайте. Точные параметры, требования и контракты результатов описаны здесь:
-- [Установка и настройка](docs/installation.md): регистрация агентов, настройка провайдеров, обновление и удаление.
-- [Готовность и устранение неполадок](docs/installation.md#check-readiness-for-your-task): диагностика конкретного агента или движка анализа.
-- [CLI и Evidence](docs/cli.md): команды, выбор провайдера, снимки, импорт/экспорт и коды завершения.
-- [Контракты MCP](docs/mcp-contracts.md) и [промпты агентов](docs/mcp-prompts.md): результаты инструментов, сеансы и исследования с подсказками.
-- [Каталог инструментов](docs/mcp-contracts.md#generated-catalog): создаваемый при сборке перечень инструментов, провайдеров и команд CLI.
-- [План развития](docs/roadmap.md): запланированные работы и отслеживание возможностей.
+- [Установка и настройка](../installation.md): регистрация агентов, настройка провайдеров, обновление и удаление.
+- [Готовность и устранение неполадок](../installation.md#check-readiness-for-your-task): диагностика конкретного агента или движка анализа.
+- [CLI и Evidence](../cli.md): команды, выбор провайдера, снимки, импорт/экспорт и коды завершения.
+- [Контракты MCP](../mcp-contracts.md) и [промпты агентов](../mcp-prompts.md): результаты инструментов, сеансы и исследования с подсказками.
+- [Каталог инструментов](../mcp-contracts.md#generated-catalog): создаваемый при сборке перечень инструментов, провайдеров и команд CLI.
+- [План развития](../roadmap.md): запланированные работы и отслеживание возможностей.
-Сообщайте об уязвимостях согласно [SECURITY.md](SECURITY.md).
+Сообщайте об уязвимостях согласно [SECURITY.md](../../SECURITY.md).
## История звёзд
@@ -276,7 +276,7 @@ npx rea-agents@latest setup
## Отказ от ответственности
-Рекомендации по ответственному использованию приведены в [DISCLAIMER.md](DISCLAIMER.md).
+Рекомендации по ответственному использованию приведены в [DISCLAIMER.md](../../DISCLAIMER.md).
REA предназначен для законных исследований, обучения, обеспечения совместимости, сохранения программного обеспечения и анализа программ, которыми вы владеете или которые вам разрешено изучать.
@@ -288,14 +288,14 @@ applicable licenses.
Будем рады вашей помощи с REA! [Откройте issue](https://github.com/morluto/rea/issues), чтобы сообщить об ошибке или предложить функцию, либо [отправьте pull request](https://github.com/morluto/rea/pulls) с улучшениями кода или документации.
-Настройка среды разработки и проверки описаны в [CONTRIBUTING.md](CONTRIBUTING.md), направления проверки — в [руководстве по тестированию](docs/testing.md), а структура проекта — на [схеме архитектуры](docs/architecture.mermaid).
+Настройка среды разработки и проверки описаны в [CONTRIBUTING.md](../../CONTRIBUTING.md), направления проверки — в [руководстве по тестированию](../testing.md), а структура проекта — на [схеме архитектуры](../architecture.mermaid).
## Лицензия
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_th.md b/docs/readme/README_th.md
similarity index 81%
rename from README_th.md
rename to docs/readme/README_th.md
index d07bbb6a3..734b28c86 100644
--- a/README_th.md
+++ b/docs/readme/README_th.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · **ไทย** · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · **ไทย** · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: Reverse Engineer Anything
@@ -9,10 +9,10 @@
**เห็นฟีเจอร์ที่ชอบแล้วอยากรู้ว่าทำงานอย่างไร? เข้าใจได้ลึกถึงระดับไบนารี**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
เข้าร่วมชุมชนวิศวกรรมย้อนกลับ
Discord · ถามตอบ · แบ่งปันผลงาน
@@ -67,7 +67,7 @@ npx rea-agents setup
เลือกเอเจนต์ ตรวจสอบการเปลี่ยนแปลงที่เสนอ แล้วอนุมัติ ขั้นตอนตั้งค่าจะเพิ่มเซิร์ฟเวอร์ MCP ของ REA และคำแนะนำการทำงานที่ตรงกัน พร้อมสำรองการตั้งค่าที่มีอยู่ จากนั้นเริ่มเอเจนต์ใหม่
-ขั้นตอนตั้งค่ารองรับ Claude Code, Codex, Cursor, Gemini CLI, Grok Build และ[เอเจนต์อื่น ๆ](docs/installation.md#supported-agents) ดู[การติดตั้งและตั้งค่า](docs/installation.md) สำหรับการตั้งค่าผู้ให้บริการวิเคราะห์และการลงทะเบียน MCP ด้วยตนเอง
+ขั้นตอนตั้งค่ารองรับ Claude Code, Codex, Cursor, Gemini CLI, Grok Build และ[เอเจนต์อื่น ๆ](../installation.md#supported-agents) ดู[การติดตั้งและตั้งค่า](../installation.md) สำหรับการตั้งค่าผู้ให้บริการวิเคราะห์และการลงทะเบียน MCP ด้วยตนเอง
### ถามเอเจนต์
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-สำหรับการวิเคราะห์เนทีฟ ให้ตั้งค่าผู้ให้บริการวิเคราะห์ก่อน ดู[คู่มือ CLI และ Evidence](docs/cli.md) สำหรับคำสั่งเนทีฟ การเลือกผู้ให้บริการ สแนปช็อต และการใช้งานในสคริปต์
+สำหรับการวิเคราะห์เนทีฟ ให้ตั้งค่าผู้ให้บริการวิเคราะห์ก่อน ดู[คู่มือ CLI และ Evidence](../cli.md) สำหรับคำสั่งเนทีฟ การเลือกผู้ให้บริการ สแนปช็อต และการใช้งานในสคริปต์
### อัปเดต REA
@@ -120,9 +120,9 @@ npx rea-agents@latest setup
เอเจนต์เรียก REA ผ่าน MCP เพื่อตรวจสอบเป้าหมายและติดตามโค้ดที่เกี่ยวข้อง REA ส่งข้อค้นพบกลับมาพร้อมหลักฐาน เอเจนต์ใช้ข้อมูลนี้เพื่อถามคำถามต่อ อธิบายพฤติกรรม หรือเขียนและทดสอบการนำไปใช้งาน คำสั่ง CLI ใช้กระบวนการเดียวกัน
-
+
-[เปิดภาพขนาดเต็ม](website/public/assets/figures/rea-investigation-flow.svg)
+[เปิดภาพขนาดเต็ม](../../website/public/assets/figures/rea-investigation-flow.svg)
@@ -130,37 +130,37 @@ npx rea-agents@latest setup
REA ต้องใช้ Node.js 22.x (>=22.19), 24.x (>=24.11) หรือ 26+ และ npm เครื่องมือเพิ่มเติมและแพลตฟอร์มที่รองรับขึ้นอยู่กับเป้าหมาย:
-| เป้าหมาย | สิ่งที่ REA ส่งกลับ | ข้อกำหนดและคู่มือ |
-| ---------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
-| ไบนารีเนทีฟ | โค้ดเทียม แอสเซมบลี สตริง สัญลักษณ์ การเรียก และการอ้างอิง | Hopper, Ghidra หรือ IDA; [การวิเคราะห์เนทีฟ](https://rea.tools/th/guides/native/) |
-| โครงสร้าง ELF แบบออฟไลน์ | เซกชัน เซกเมนต์ สัญลักษณ์/รีโลเคชันต้นฉบับ และตัวเลือกกลไกป้องกันที่พบจากการวิเคราะห์แบบสถิต | pwntools ที่ผู้ใช้จัดเตรียมบน Linux x64; [การวินิจฉัยไบนารี](docs/binary-diagnostics.md) |
-| ไบต์โค้ด EVM | ตัวเลือกฟังก์ชันสำหรับการเรียก ออฟเซ็ตไบต์ อาร์กิวเมนต์และความสามารถในการเปลี่ยนสถานะที่อนุมานได้ | ไฟล์บนเครื่องที่มีไบต์ดิบหรือข้อมูลเลขฐานสิบหกบน Linux x64; [คู่มือ EVM แบบออฟไลน์](docs/evm-bytecode.md) |
-| ข้อมูลการแครชของ Linux ที่บันทึกไว้ | ระเบียน note ดิบ รีจิสเตอร์/สัญญาณของทุกเธรดที่บันทึกไว้ และตัวเลือกการแมปเพิ่มเติม | pwntools ที่ผู้ใช้จัดเตรียมบน Linux x64; เลือกใช้ GDB/pwndbg เพิ่มเติมได้; [การแครชที่บันทึกไว้](docs/recorded-crashes.md) |
-| JavaScript / Electron | โมดูล การนำเข้า ซอร์สแมป เส้นทาง IPC และความสัมพันธ์กับส่วนเสริมเนทีฟ | Node.js และ npm; [การวิเคราะห์แอปพลิเคชัน](https://rea.tools/th/guides/javascript/) |
-| เว็บไซต์ | โครงสร้างหน้า สคริปต์ ข้อมูลเครือข่ายที่สังเกตได้ และภาพหน้าจอที่ร้องขอ | เบราว์เซอร์ในตระกูล Chrome; [การวิเคราะห์ผ่านเบราว์เซอร์](https://rea.tools/th/guides/browser/) |
-| ข้อมูลเครือข่ายที่บันทึกไว้ | คำขอ คำตอบ เพย์โหลดที่ปรากฏ และตำแหน่งต้นทาง | HAR; mitmdump บน Linux สำหรับข้อมูลที่บันทึกในรูปแบบเนทีฟของ mitmproxy; [คู่มือการบันทึกข้อมูล](docs/web-network-captures.md) |
-| การจับแพ็กเก็ต | จุดเชื่อมต่อ, DNS, TLS SNI, การกระจายโปรโตคอล และคำขอ HTTP | tshark และ capinfos ที่ผู้เรียกจัดเตรียม; [คู่มือ pcap](docs/pcap-analysis.md) |
-| แอสเซมบลี .NET | เมทาดาทา คำสั่ง CIL การพึ่งพาเนทีฟที่ประกาศไว้ และการเปรียบเทียบผลการบิลด์ | การตรวจสอบแบบสถิต; [คู่มือโค้ดแบบจัดการ](docs/managed-code-analysis.md) |
-| APK ของ Android | การประกาศใน manifest คลาส เมธอดที่ดีคอมไพล์ และการอ้างอิง | JADX แบบไม่มี GUI และ JDK แบบเต็มบน Linux/macOS/Windows x64; [คู่มือ Android](docs/android-analysis.md) |
-| อุปกรณ์ Android | อุปกรณ์ แพ็กเกจ โพรเซส บันทึก ดัมพ์ ภาพหน้าจอ และการถ่ายโอน APK/ไฟล์ | adb ที่ผู้เรียกจัดเตรียม (โปรแกรมจำลองหรืออุปกรณ์จริง); [คู่มือ ADB](docs/adb-device-analysis.md) |
-| โปรเจกต์ JEB | หน่วยโปรเจกต์จากเอนจิน, แฮชของอาร์ติแฟกต์ และซูโดโค้ดของไทป์/เมท็อด | ไคลเอนต์ JEB ที่ผู้เรียกเริ่มและให้บริการ MCP เลือกด้วย REA_JEB_MCP_URL; [คู่มือ JEB](docs/jeb-analysis.md) |
-| ทรัพยากร Android | ไฟล์ manifest ที่ถอดรหัสแล้ว ตารางสตริง ภาษา และข้อมูลเวอร์ชัน | ตัวเรียก Apktool ที่ผู้เรียกจัดเตรียม; [คู่มือทรัพยากร](docs/apktool-resource-analysis.md) |
-| แอป Flutter | แฮชสแนปชอต Dart, แฮชไลบรารีราย ABI และที่มาของบิลด์เอนจิน | ไม่ต้อง (วิเคราะห์ APK แบบ static); [คู่มือ Flutter](docs/flutter-analysis.md) |
-| เฟิร์มแวร์ | พื้นที่ข้อมูล ผลการแตกไฟล์ และการส่งต่อไปวิเคราะห์เนทีฟ | Binwalk / Unblob บน Linux; [คู่มือเฟิร์มแวร์](docs/firmware-analysis.md) |
-| แพ็กเก็ตที่บันทึกไว้ | ฟิลด์ที่เลือก ค่าซ้ำ ตัวกรอง และกฎการถอดรหัส | Linux: TShark 4.x + prlimit; [คู่มือไฟล์แคปเจอร์](docs/packet-captures.md) |
-| สัญญาณลอจิกที่บันทึกไว้ | คำอธิบายจากตัวถอดรหัส ช่วงตัวอย่าง และข้อมูลวินิจฉัย | Linux: sigrok-cli 0.7.2 + prlimit; [คู่มือสัญญาณ](docs/signal-recordings.md) |
-| แพ็กเกจและทรัพยากร | รายการไฟล์ ค่าแฮช plist โครงสร้างบันเดิลของ Apple และทรัพยากรที่แตกออกมา | [คู่มืออาร์ติแฟกต์และ JavaScript](docs/javascript-artifact-reconstruction.md), [แอปพลิเคชัน Apple](docs/apple-application-analysis.md) |
-| พฤติกรรมของโปรเซส | เอาต์พุตเทอร์มินัล การโต้ตอบ ข้อมูลการสิ้นสุดและระบบไฟล์ที่สังเกตได้ และการเปรียบเทียบการรัน | Linux/macOS ที่มี PTY เนทีฟ; [การบันทึกโปรเซส](docs/process-capture.md) |
+| เป้าหมาย | สิ่งที่ REA ส่งกลับ | ข้อกำหนดและคู่มือ |
+| ---------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| ไบนารีเนทีฟ | โค้ดเทียม แอสเซมบลี สตริง สัญลักษณ์ การเรียก และการอ้างอิง | Hopper, Ghidra หรือ IDA; [การวิเคราะห์เนทีฟ](https://rea.tools/th/guides/native/) |
+| โครงสร้าง ELF แบบออฟไลน์ | เซกชัน เซกเมนต์ สัญลักษณ์/รีโลเคชันต้นฉบับ และตัวเลือกกลไกป้องกันที่พบจากการวิเคราะห์แบบสถิต | pwntools ที่ผู้ใช้จัดเตรียมบน Linux x64; [การวินิจฉัยไบนารี](../binary-diagnostics.md) |
+| ไบต์โค้ด EVM | ตัวเลือกฟังก์ชันสำหรับการเรียก ออฟเซ็ตไบต์ อาร์กิวเมนต์และความสามารถในการเปลี่ยนสถานะที่อนุมานได้ | ไฟล์บนเครื่องที่มีไบต์ดิบหรือข้อมูลเลขฐานสิบหกบน Linux x64; [คู่มือ EVM แบบออฟไลน์](../evm-bytecode.md) |
+| ข้อมูลการแครชของ Linux ที่บันทึกไว้ | ระเบียน note ดิบ รีจิสเตอร์/สัญญาณของทุกเธรดที่บันทึกไว้ และตัวเลือกการแมปเพิ่มเติม | pwntools ที่ผู้ใช้จัดเตรียมบน Linux x64; เลือกใช้ GDB/pwndbg เพิ่มเติมได้; [การแครชที่บันทึกไว้](../recorded-crashes.md) |
+| JavaScript / Electron | โมดูล การนำเข้า ซอร์สแมป เส้นทาง IPC และความสัมพันธ์กับส่วนเสริมเนทีฟ | Node.js และ npm; [การวิเคราะห์แอปพลิเคชัน](https://rea.tools/th/guides/javascript/) |
+| เว็บไซต์ | โครงสร้างหน้า สคริปต์ ข้อมูลเครือข่ายที่สังเกตได้ และภาพหน้าจอที่ร้องขอ | เบราว์เซอร์ในตระกูล Chrome; [การวิเคราะห์ผ่านเบราว์เซอร์](https://rea.tools/th/guides/browser/) |
+| ข้อมูลเครือข่ายที่บันทึกไว้ | คำขอ คำตอบ เพย์โหลดที่ปรากฏ และตำแหน่งต้นทาง | HAR; mitmdump บน Linux สำหรับข้อมูลที่บันทึกในรูปแบบเนทีฟของ mitmproxy; [คู่มือการบันทึกข้อมูล](../web-network-captures.md) |
+| การจับแพ็กเก็ต | จุดเชื่อมต่อ, DNS, TLS SNI, การกระจายโปรโตคอล และคำขอ HTTP | tshark และ capinfos ที่ผู้เรียกจัดเตรียม; [คู่มือ pcap](../pcap-analysis.md) |
+| แอสเซมบลี .NET | เมทาดาทา คำสั่ง CIL การพึ่งพาเนทีฟที่ประกาศไว้ และการเปรียบเทียบผลการบิลด์ | การตรวจสอบแบบสถิต; [คู่มือโค้ดแบบจัดการ](../managed-code-analysis.md) |
+| APK ของ Android | การประกาศใน manifest คลาส เมธอดที่ดีคอมไพล์ และการอ้างอิง | JADX แบบไม่มี GUI และ JDK แบบเต็มบน Linux/macOS/Windows x64; [คู่มือ Android](../android-analysis.md) |
+| อุปกรณ์ Android | อุปกรณ์ แพ็กเกจ โพรเซส บันทึก ดัมพ์ ภาพหน้าจอ และการถ่ายโอน APK/ไฟล์ | adb ที่ผู้เรียกจัดเตรียม (โปรแกรมจำลองหรืออุปกรณ์จริง); [คู่มือ ADB](../adb-device-analysis.md) |
+| โปรเจกต์ JEB | หน่วยโปรเจกต์จากเอนจิน, แฮชของอาร์ติแฟกต์ และซูโดโค้ดของไทป์/เมท็อด | ไคลเอนต์ JEB ที่ผู้เรียกเริ่มและให้บริการ MCP เลือกด้วย REA_JEB_MCP_URL; [คู่มือ JEB](../jeb-analysis.md) |
+| ทรัพยากร Android | ไฟล์ manifest ที่ถอดรหัสแล้ว ตารางสตริง ภาษา และข้อมูลเวอร์ชัน | ตัวเรียก Apktool ที่ผู้เรียกจัดเตรียม; [คู่มือทรัพยากร](../apktool-resource-analysis.md) |
+| แอป Flutter | แฮชสแนปชอต Dart, แฮชไลบรารีราย ABI และที่มาของบิลด์เอนจิน | ไม่ต้อง (วิเคราะห์ APK แบบ static); [คู่มือ Flutter](../flutter-analysis.md) |
+| เฟิร์มแวร์ | พื้นที่ข้อมูล ผลการแตกไฟล์ และการส่งต่อไปวิเคราะห์เนทีฟ | Binwalk / Unblob บน Linux; [คู่มือเฟิร์มแวร์](../firmware-analysis.md) |
+| แพ็กเก็ตที่บันทึกไว้ | ฟิลด์ที่เลือก ค่าซ้ำ ตัวกรอง และกฎการถอดรหัส | Linux: TShark 4.x + prlimit; [คู่มือไฟล์แคปเจอร์](../packet-captures.md) |
+| สัญญาณลอจิกที่บันทึกไว้ | คำอธิบายจากตัวถอดรหัส ช่วงตัวอย่าง และข้อมูลวินิจฉัย | Linux: sigrok-cli 0.7.2 + prlimit; [คู่มือสัญญาณ](../signal-recordings.md) |
+| แพ็กเกจและทรัพยากร | รายการไฟล์ ค่าแฮช plist โครงสร้างบันเดิลของ Apple และทรัพยากรที่แตกออกมา | [คู่มืออาร์ติแฟกต์และ JavaScript](../javascript-artifact-reconstruction.md), [แอปพลิเคชัน Apple](../apple-application-analysis.md) |
+| พฤติกรรมของโปรเซส | เอาต์พุตเทอร์มินัล การโต้ตอบ ข้อมูลการสิ้นสุดและระบบไฟล์ที่สังเกตได้ และการเปรียบเทียบการรัน | Linux/macOS ที่มี PTY เนทีฟ; [การบันทึกโปรเซส](../process-capture.md) |
การตรวจสอบ JavaScript และ .NET แบบสถิตอ่านไฟล์ที่ให้มาโดยไม่รันแอปพลิเคชัน การบันทึกขณะทำงานจะรันหรือโต้ตอบกับเป้าหมายที่เลือกโดยใช้สิทธิ์ของผู้ใช้คุณ คู่มือการทำงานแต่ละฉบับอธิบายผลที่เกิดขึ้นไว้
-รูปแบบไบนารีเนทีฟและแพลตฟอร์มที่รองรับแตกต่างกันตามผู้ให้บริการวิเคราะห์ ดู[การตั้งค่า Hopper และ Ghidra](docs/installation.md#hopper), [คู่มือ IDA](docs/ida-provider.md) และ[การรองรับ Ghidra บน Windows แบบทดลอง](docs/windows-ghidra-p0.md) Ghidra ยังรองรับ[การวิเคราะห์ DOS แบบ 16 บิต](docs/ghidra-dos.md) สำหรับการเลือกผู้ให้บริการ ดู[คู่มือ CLI](docs/cli.md#choose-a-provider) ตรวจสอบ[ความพร้อมใช้งานในแต่ละรุ่น](docs/installation.md#released-package-and-main) สำหรับฟีเจอร์ที่เพิ่มหลังรุ่นล่าสุดบน npm
+รูปแบบไบนารีเนทีฟและแพลตฟอร์มที่รองรับแตกต่างกันตามผู้ให้บริการวิเคราะห์ ดู[การตั้งค่า Hopper และ Ghidra](../installation.md#hopper), [คู่มือ IDA](../ida-provider.md) และ[การรองรับ Ghidra บน Windows แบบทดลอง](../windows-ghidra-p0.md) Ghidra ยังรองรับ[การวิเคราะห์ DOS แบบ 16 บิต](../ghidra-dos.md) สำหรับการเลือกผู้ให้บริการ ดู[คู่มือ CLI](../cli.md#choose-a-provider) ตรวจสอบ[ความพร้อมใช้งานในแต่ละรุ่น](../installation.md#released-package-and-main) สำหรับฟีเจอร์ที่เพิ่มหลังรุ่นล่าสุดบน npm
## ตัวอย่างการใช้งาน
-[](https://rea.tools/th/showcase/)
+[](https://rea.tools/th/showcase/)
### DX-Ball: สร้างการคำนวณแพนเสียงขึ้นใหม่
@@ -187,28 +187,28 @@ REA ต้องใช้ Node.js 22.x (>=22.19), 24.x (>=24.11) หรือ 26
เอเจนต์ใดใช้ REA ได้บ้าง?
-เอเจนต์ใดก็ตามที่รองรับเซิร์ฟเวอร์ MCP บนเครื่อง ขั้นตอนตั้งค่าจะกำหนดค่าให้กับ[เอเจนต์ที่รองรับ](docs/installation.md#supported-agents) ส่วนไคลเอนต์อื่นใช้[การลงทะเบียน MCP ด้วยตนเอง](docs/installation.md#mcp-registry) ได้
+เอเจนต์ใดก็ตามที่รองรับเซิร์ฟเวอร์ MCP บนเครื่อง ขั้นตอนตั้งค่าจะกำหนดค่าให้กับ[เอเจนต์ที่รองรับ](../installation.md#supported-agents) ส่วนไคลเอนต์อื่นใช้[การลงทะเบียน MCP ด้วยตนเอง](../installation.md#mcp-registry) ได้
จำเป็นต้องมี Hopper, Ghidra หรือ IDA หรือไม่?
-การวิเคราะห์เนทีฟเชิงลึกต้องใช้หนึ่งในเครื่องมือเหล่านี้ การตรวจสอบ JavaScript และ .NET แบบสถิตทำงานได้โดยไม่มีเอนจินวิเคราะห์เนทีฟ ขั้นตอนตั้งค่าสามารถติดตั้ง Hopper หลังได้รับอนุมัติ ส่วน Ghidra และ IDA ใช้การติดตั้งที่คุณมีอยู่แล้ว ดู[การตั้งค่าผู้ให้บริการวิเคราะห์](docs/installation.md#hopper)
+การวิเคราะห์เนทีฟเชิงลึกต้องใช้หนึ่งในเครื่องมือเหล่านี้ การตรวจสอบ JavaScript และ .NET แบบสถิตทำงานได้โดยไม่มีเอนจินวิเคราะห์เนทีฟ ขั้นตอนตั้งค่าสามารถติดตั้ง Hopper หลังได้รับอนุมัติ ส่วน Ghidra และ IDA ใช้การติดตั้งที่คุณมีอยู่แล้ว ดู[การตั้งค่าผู้ให้บริการวิเคราะห์](../installation.md#hopper)
ต้องเริ่ม Hopper ก่อนหรือไม่?
-REA เริ่ม Hopper เมื่อการดำเนินการต้องใช้ บน macOS อาจมีหน้าต่างเมื่อรันครั้งแรกให้เลือกโหมดทดลองหรือเปิดใช้ใบอนุญาต ดู[การเริ่ม Hopper และการแก้ไขปัญหา](docs/installation.md#launcher-paths-and-troubleshooting)
+REA เริ่ม Hopper เมื่อการดำเนินการต้องใช้ บน macOS อาจมีหน้าต่างเมื่อรันครั้งแรกให้เลือกโหมดทดลองหรือเปิดใช้ใบอนุญาต ดู[การเริ่ม Hopper และการแก้ไขปัญหา](../installation.md#launcher-paths-and-troubleshooting)
การติดตั้งสกิลจาก skills.sh ทำอะไร?
-สกิลให้คำแนะนำการตรวจสอบแก่เอเจนต์ ใช้ `npx rea-agents setup` เพื่อลงทะเบียนเซิร์ฟเวอร์ MCP ของ REA และติดตั้งคำแนะนำที่ตรงกัน แล้วเริ่มเอเจนต์ใหม่ ดู[การติดตั้งเฉพาะสกิล](docs/installation.md#skill-only-installation)
+สกิลให้คำแนะนำการตรวจสอบแก่เอเจนต์ ใช้ `npx rea-agents setup` เพื่อลงทะเบียนเซิร์ฟเวอร์ MCP ของ REA และติดตั้งคำแนะนำที่ตรงกัน แล้วเริ่มเอเจนต์ใหม่ ดู[การติดตั้งเฉพาะสกิล](../installation.md#skill-only-installation)
@@ -251,14 +251,14 @@ npx rea-agents@latest setup
เริ่มจาก[คู่มือพร้อมตัวอย่าง](https://rea.tools/th/guides/) บนเว็บไซต์ สำหรับตัวเลือก ข้อกำหนดเบื้องต้น และสัญญาผลลัพธ์ที่แน่นอน:
-- [การติดตั้งและตั้งค่า](docs/installation.md): การลงทะเบียนเอเจนต์ การตั้งค่าผู้ให้บริการ การอัปเดต และการถอนการติดตั้ง
-- [ความพร้อมใช้งานและการแก้ไขปัญหา](docs/installation.md#check-readiness-for-your-task): ตรวจวินิจฉัยเอเจนต์หรือเอนจินวิเคราะห์หนึ่งตัว
-- [CLI และ Evidence](docs/cli.md): คำสั่ง การเลือกผู้ให้บริการ สแนปช็อต การนำเข้า/ส่งออก และรหัสการสิ้นสุด
-- [สัญญา MCP](docs/mcp-contracts.md) และ[พรอมป์ต์สำหรับเอเจนต์](docs/mcp-prompts.md): ผลลัพธ์เครื่องมือ เซสชัน และการตรวจสอบตามคำแนะนำ
-- [แค็ตตาล็อกเครื่องมือ](docs/mcp-contracts.md#generated-catalog): รายการเครื่องมือ ผู้ให้บริการ และคำสั่ง CLI ที่สร้างระหว่างการบิลด์
-- [แผนพัฒนา](docs/roadmap.md): งานที่วางแผนไว้และรายการติดตามความสามารถ
+- [การติดตั้งและตั้งค่า](../installation.md): การลงทะเบียนเอเจนต์ การตั้งค่าผู้ให้บริการ การอัปเดต และการถอนการติดตั้ง
+- [ความพร้อมใช้งานและการแก้ไขปัญหา](../installation.md#check-readiness-for-your-task): ตรวจวินิจฉัยเอเจนต์หรือเอนจินวิเคราะห์หนึ่งตัว
+- [CLI และ Evidence](../cli.md): คำสั่ง การเลือกผู้ให้บริการ สแนปช็อต การนำเข้า/ส่งออก และรหัสการสิ้นสุด
+- [สัญญา MCP](../mcp-contracts.md) และ[พรอมป์ต์สำหรับเอเจนต์](../mcp-prompts.md): ผลลัพธ์เครื่องมือ เซสชัน และการตรวจสอบตามคำแนะนำ
+- [แค็ตตาล็อกเครื่องมือ](../mcp-contracts.md#generated-catalog): รายการเครื่องมือ ผู้ให้บริการ และคำสั่ง CLI ที่สร้างระหว่างการบิลด์
+- [แผนพัฒนา](../roadmap.md): งานที่วางแผนไว้และรายการติดตามความสามารถ
-รายงานช่องโหว่ผ่าน [SECURITY.md](SECURITY.md)
+รายงานช่องโหว่ผ่าน [SECURITY.md](../../SECURITY.md)
## ประวัติดาว
@@ -276,7 +276,7 @@ npx rea-agents@latest setup
## ข้อสงวนสิทธิ์
-ดูแนวทางการใช้งานอย่างรับผิดชอบใน [DISCLAIMER.md](DISCLAIMER.md)
+ดูแนวทางการใช้งานอย่างรับผิดชอบใน [DISCLAIMER.md](../../DISCLAIMER.md)
REA มีไว้สำหรับการวิจัย การศึกษา การทำงานร่วมกัน การอนุรักษ์ซอฟต์แวร์ และการวิเคราะห์ซอฟต์แวร์ที่คุณเป็นเจ้าของหรือได้รับอนุญาตให้ตรวจสอบ โดยปฏิบัติตามกฎหมาย
@@ -288,14 +288,14 @@ applicable licenses.
เรายินดีรับความช่วยเหลือในการพัฒนา REA! [เปิด issue](https://github.com/morluto/rea/issues) เพื่อรายงานบั๊กหรือเสนอฟีเจอร์ หรือ[ส่ง pull request](https://github.com/morluto/rea/pulls) เพื่อปรับปรุงโค้ดหรือเอกสาร
-ดู [CONTRIBUTING.md](CONTRIBUTING.md) สำหรับการตั้งค่าสภาพแวดล้อมพัฒนาและการตรวจสอบ ดู[การทดสอบ](docs/testing.md) สำหรับแนวทางการตรวจยืนยัน และ[แผนผังสถาปัตยกรรม](docs/architecture.mermaid) สำหรับโครงสร้างโปรเจกต์
+ดู [CONTRIBUTING.md](../../CONTRIBUTING.md) สำหรับการตั้งค่าสภาพแวดล้อมพัฒนาและการตรวจสอบ ดู[การทดสอบ](../testing.md) สำหรับแนวทางการตรวจยืนยัน และ[แผนผังสถาปัตยกรรม](../architecture.mermaid) สำหรับโครงสร้างโปรเจกต์
## สัญญาอนุญาต
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_tr.md b/docs/readme/README_tr.md
similarity index 76%
rename from README_tr.md
rename to docs/readme/README_tr.md
index 1daaaf9d0..dc33a4a38 100644
--- a/README_tr.md
+++ b/docs/readme/README_tr.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · **Türkçe** · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · **Türkçe** · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: Her şeyi tersine mühendislikle inceleyin
@@ -9,10 +9,10 @@
**Beğendiğiniz bir özellik mi gördünüz? İkili kod düzeyine kadar nasıl çalıştığını anlayın.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Tersine mühendislik topluluğuna katılın
Discord · Soru-cevap · Sonuç paylaşımı
@@ -67,7 +67,7 @@ npx rea-agents setup
Ajanlarınızı seçin, önerilen değişiklikleri inceleyin ve onaylayın. Kurulum, mevcut yapılandırmaları yedekleyerek REA'nın MCP sunucusunu ve uyumlu iş akışı talimatlarını ekler. Ardından ajanınızı yeniden başlatın.
-Kurulum Claude Code, Codex, Cursor, Gemini CLI, Grok Build ve [diğer ajanları](docs/installation.md#supported-agents) destekler. Sağlayıcı yapılandırması ve elle MCP kaydı için [yükleme ve kurulum](docs/installation.md) belgesine bakın.
+Kurulum Claude Code, Codex, Cursor, Gemini CLI, Grok Build ve [diğer ajanları](../installation.md#supported-agents) destekler. Sağlayıcı yapılandırması ve elle MCP kaydı için [yükleme ve kurulum](../installation.md) belgesine bakın.
### Ajanınıza sorun
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-Yerel makine kodu analizi için önce bir sağlayıcı yapılandırın. Yerel analiz komutları, sağlayıcı seçimi, anlık görüntüler ve betik kullanımı için [CLI ve Evidence rehberine](docs/cli.md) bakın.
+Yerel makine kodu analizi için önce bir sağlayıcı yapılandırın. Yerel analiz komutları, sağlayıcı seçimi, anlık görüntüler ve betik kullanımı için [CLI ve Evidence rehberine](../cli.md) bakın.
### REA'yı güncelleyin
@@ -120,9 +120,9 @@ Kurulum değişikliklerini inceleyin ve ajanınızı yeniden başlatın. Tek sef
Ajanınız, hedefi incelemek ve ilgili kodu izlemek için MCP üzerinden REA'yı çağırır. REA bulguları kanıtlarıyla birlikte döndürür. Ajan bunları takip soruları sormak, davranışı açıklamak veya bir uygulama yazıp test etmek için kullanır. CLI komutları aynı iş akışlarını kullanır.
-
+
-[Şekli tam boyutuyla açın](website/public/assets/figures/rea-investigation-flow.svg).
+[Şekli tam boyutuyla açın](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ Ajanınız, hedefi incelemek ve ilgili kodu izlemek için MCP üzerinden REA'yı
REA; Node.js 22.x (>=22.19), 24.x (>=24.11) veya 26+ ve npm gerektirir. Ek araçlar ve desteklenen ana bilgisayar sistemleri hedefe bağlıdır:
-| Hedef | REA'nın döndürdükleri | Gereksinimler ve rehber |
-| --------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| Yerel makine kodu içeren ikili dosyalar | Sözde kod, assembly kodu, dizeler, semboller, çağrılar ve referanslar | Hopper, Ghidra veya IDA; [yerel kod analizi](https://rea.tools/tr/guides/native/) |
-| Çevrimdışı ELF yapısı | Bölümler, segmentler, özgün semboller/yeniden konumlandırmalar ve statik analizden olası güvenlik önlemleri | Linux x64 üzerinde çağıranın sağladığı pwntools; [ikili dosya tanılama](docs/binary-diagnostics.md) |
-| EVM bayt kodu | Yönlendirme seçicileri, bayt ofsetleri, çıkarımla belirlenen argümanlar ve durum değiştirilebilirliği | Linux x64 üzerinde yerel ham bayt/onaltılık girdi; [çevrimdışı EVM rehberi](docs/evm-bytecode.md) |
-| Kaydedilmiş Linux çökmeleri | Ham note kayıtları, kaydedilen her iş parçacığının yazmaçları/sinyalleri ve isteğe bağlı eşleme adayları | Linux x64 üzerinde çağıranın sağladığı pwntools; isteğe bağlı GDB/pwndbg; [kaydedilmiş çökmeler](docs/recorded-crashes.md) |
-| JavaScript / Electron | Modüller, içe aktarmalar, kaynak haritaları, rotalar, IPC ve yerel eklenti ilişkileri | Node.js ve npm; [uygulama analizi](https://rea.tools/tr/guides/javascript/) |
-| Web siteleri | Sayfa yapısı, betikler, ağ gözlemleri ve istenen ekran görüntüleri | Chrome ailesinden bir tarayıcı; [tarayıcı analizi](https://rea.tools/tr/guides/browser/) |
-| Kaydedilmiş ağ yakalamaları | İstekler, yanıtlar, erişilebilir yük içerikleri ve kaynak konumları | HAR; mitmproxy'nin kendi biçimindeki yakalamalar için Linux üzerinde mitmdump; [ağ yakalama rehberi](docs/web-network-captures.md) |
-| Paket yakalamaları | Uç noktalar, DNS, TLS SNI, protokol dağılımı ve HTTP istekleri | Çağıranın sağladığı tshark ve capinfos; [pcap rehberi](docs/pcap-analysis.md) |
-| .NET derlemeleri | Meta veriler, CIL talimatları, bildirilmiş yerel bağımlılıklar ve derleme karşılaştırmaları | Statik inceleme; [yönetilen kod rehberi](docs/managed-code-analysis.md) |
-| Android APK'leri | Manifest bildirimleri, sınıflar, tersine derlenmiş metotlar ve referanslar | Linux/macOS/Windows x64 üzerinde arayüzsüz JADX ve tam bir JDK; [Android rehberi](docs/android-analysis.md) |
-| Android cihazları | Cihazlar, paketler, süreçler, günlükler, dökümler, ekran görüntüleri ve APK/dosya aktarımları | Çağıranın sağladığı adb (emülatör veya cihaz); [ADB rehberi](docs/adb-device-analysis.md) |
-| JEB projeleri | Motor destekli proje birimleri, artefakt özetleri ve tür/metot sözdekodu | Çağıranın başlattığı, MCP sunan bir JEB istemcisi, REA_JEB_MCP_URL ile seçilir; [JEB rehberi](docs/jeb-analysis.md) |
-| Android kaynakları | Çözülmüş manifest, dize tabloları, diller ve sürüm bilgileri | Çağıranın sağladığı Apktool başlatıcısı; [kaynak rehberi](docs/apktool-resource-analysis.md) |
-| Flutter uygulamaları | Dart anlık görüntü karması, ABI başına kitaplık özetleri ve motor derleme kökeni | Yok (statik APK çözümleme); [Flutter rehberi](docs/flutter-analysis.md) |
-| Donanım yazılımı | Bölgeler, çıkarma sonuçları ve yerel kod analizine devirler | Linux üzerinde Binwalk / Unblob; [donanım yazılımı rehberi](docs/firmware-analysis.md) |
-| Kaydedilmiş paketler | Seçilen alanlar, yinelenen değerler, filtreler ve çözümleme kuralları | Linux: TShark 4.x + prlimit; [yakalama kılavuzu](docs/packet-captures.md) |
-| Kaydedilmiş mantık sinyalleri | Kod çözücü açıklamaları, örnek aralıkları ve tanılama | Linux: sigrok-cli 0.7.2 + prlimit; [sinyal kılavuzu](docs/signal-recordings.md) |
-| Paketler ve kaynaklar | Dosya envanterleri, özet değerleri, plist'ler, Apple paket yapısı ve çıkarılmış kaynaklar | [Artefakt ve JavaScript rehberi](docs/javascript-artifact-reconstruction.md), [Apple uygulamaları](docs/apple-application-analysis.md) |
-| Süreç davranışı | Terminal çıktısı, etkileşimler, sonlanma ve dosya sistemi gözlemleri, çalıştırma karşılaştırmaları | Yerel PTY ile Linux/macOS; [süreç yakalama](docs/process-capture.md) |
+| Hedef | REA'nın döndürdükleri | Gereksinimler ve rehber |
+| --------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| Yerel makine kodu içeren ikili dosyalar | Sözde kod, assembly kodu, dizeler, semboller, çağrılar ve referanslar | Hopper, Ghidra veya IDA; [yerel kod analizi](https://rea.tools/tr/guides/native/) |
+| Çevrimdışı ELF yapısı | Bölümler, segmentler, özgün semboller/yeniden konumlandırmalar ve statik analizden olası güvenlik önlemleri | Linux x64 üzerinde çağıranın sağladığı pwntools; [ikili dosya tanılama](../binary-diagnostics.md) |
+| EVM bayt kodu | Yönlendirme seçicileri, bayt ofsetleri, çıkarımla belirlenen argümanlar ve durum değiştirilebilirliği | Linux x64 üzerinde yerel ham bayt/onaltılık girdi; [çevrimdışı EVM rehberi](../evm-bytecode.md) |
+| Kaydedilmiş Linux çökmeleri | Ham note kayıtları, kaydedilen her iş parçacığının yazmaçları/sinyalleri ve isteğe bağlı eşleme adayları | Linux x64 üzerinde çağıranın sağladığı pwntools; isteğe bağlı GDB/pwndbg; [kaydedilmiş çökmeler](../recorded-crashes.md) |
+| JavaScript / Electron | Modüller, içe aktarmalar, kaynak haritaları, rotalar, IPC ve yerel eklenti ilişkileri | Node.js ve npm; [uygulama analizi](https://rea.tools/tr/guides/javascript/) |
+| Web siteleri | Sayfa yapısı, betikler, ağ gözlemleri ve istenen ekran görüntüleri | Chrome ailesinden bir tarayıcı; [tarayıcı analizi](https://rea.tools/tr/guides/browser/) |
+| Kaydedilmiş ağ yakalamaları | İstekler, yanıtlar, erişilebilir yük içerikleri ve kaynak konumları | HAR; mitmproxy'nin kendi biçimindeki yakalamalar için Linux üzerinde mitmdump; [ağ yakalama rehberi](../web-network-captures.md) |
+| Paket yakalamaları | Uç noktalar, DNS, TLS SNI, protokol dağılımı ve HTTP istekleri | Çağıranın sağladığı tshark ve capinfos; [pcap rehberi](../pcap-analysis.md) |
+| .NET derlemeleri | Meta veriler, CIL talimatları, bildirilmiş yerel bağımlılıklar ve derleme karşılaştırmaları | Statik inceleme; [yönetilen kod rehberi](../managed-code-analysis.md) |
+| Android APK'leri | Manifest bildirimleri, sınıflar, tersine derlenmiş metotlar ve referanslar | Linux/macOS/Windows x64 üzerinde arayüzsüz JADX ve tam bir JDK; [Android rehberi](../android-analysis.md) |
+| Android cihazları | Cihazlar, paketler, süreçler, günlükler, dökümler, ekran görüntüleri ve APK/dosya aktarımları | Çağıranın sağladığı adb (emülatör veya cihaz); [ADB rehberi](../adb-device-analysis.md) |
+| JEB projeleri | Motor destekli proje birimleri, artefakt özetleri ve tür/metot sözdekodu | Çağıranın başlattığı, MCP sunan bir JEB istemcisi, REA_JEB_MCP_URL ile seçilir; [JEB rehberi](../jeb-analysis.md) |
+| Android kaynakları | Çözülmüş manifest, dize tabloları, diller ve sürüm bilgileri | Çağıranın sağladığı Apktool başlatıcısı; [kaynak rehberi](../apktool-resource-analysis.md) |
+| Flutter uygulamaları | Dart anlık görüntü karması, ABI başına kitaplık özetleri ve motor derleme kökeni | Yok (statik APK çözümleme); [Flutter rehberi](../flutter-analysis.md) |
+| Donanım yazılımı | Bölgeler, çıkarma sonuçları ve yerel kod analizine devirler | Linux üzerinde Binwalk / Unblob; [donanım yazılımı rehberi](../firmware-analysis.md) |
+| Kaydedilmiş paketler | Seçilen alanlar, yinelenen değerler, filtreler ve çözümleme kuralları | Linux: TShark 4.x + prlimit; [yakalama kılavuzu](../packet-captures.md) |
+| Kaydedilmiş mantık sinyalleri | Kod çözücü açıklamaları, örnek aralıkları ve tanılama | Linux: sigrok-cli 0.7.2 + prlimit; [sinyal kılavuzu](../signal-recordings.md) |
+| Paketler ve kaynaklar | Dosya envanterleri, özet değerleri, plist'ler, Apple paket yapısı ve çıkarılmış kaynaklar | [Artefakt ve JavaScript rehberi](../javascript-artifact-reconstruction.md), [Apple uygulamaları](../apple-application-analysis.md) |
+| Süreç davranışı | Terminal çıktısı, etkileşimler, sonlanma ve dosya sistemi gözlemleri, çalıştırma karşılaştırmaları | Yerel PTY ile Linux/macOS; [süreç yakalama](../process-capture.md) |
Statik JavaScript ve .NET incelemesi, uygulamayı çalıştırmadan sağlanan dosyaları okur. Çalışma zamanı yakalaması, seçilen hedefi kullanıcı izinlerinizle çalıştırır veya onunla etkileşime girer; her çalışma zamanı rehberi etkilerini açıklar.
-Yerel makine kodu içeren ikili dosya biçimleri ve ana bilgisayar desteği sağlayıcıya göre değişir. [Hopper ve Ghidra kurulumu](docs/installation.md#hopper), [IDA rehberi](docs/ida-provider.md) ve [Windows için deneysel Ghidra desteği](docs/windows-ghidra-p0.md) belgelerine bakın. Ghidra ayrıca [16 bit DOS analizini](docs/ghidra-dos.md) destekler. Sağlayıcı seçimi için [CLI rehberine](docs/cli.md#choose-a-provider) bakın. En son npm sürümünden sonra eklenen özellikler için [sürümlerde kullanılabilirliği](docs/installation.md#released-package-and-main) kontrol edin.
+Yerel makine kodu içeren ikili dosya biçimleri ve ana bilgisayar desteği sağlayıcıya göre değişir. [Hopper ve Ghidra kurulumu](../installation.md#hopper), [IDA rehberi](../ida-provider.md) ve [Windows için deneysel Ghidra desteği](../windows-ghidra-p0.md) belgelerine bakın. Ghidra ayrıca [16 bit DOS analizini](../ghidra-dos.md) destekler. Sağlayıcı seçimi için [CLI rehberine](../cli.md#choose-a-provider) bakın. En son npm sürümünden sonra eklenen özellikler için [sürümlerde kullanılabilirliği](../installation.md#released-package-and-main) kontrol edin.
## Örnek çalışmalar
-[](https://rea.tools/tr/showcase/)
+[](https://rea.tools/tr/showcase/)
### DX-Ball: Sesin stereo konumlandırma hesabını yeniden oluşturma
@@ -187,28 +187,28 @@ REA'yı ilginç bir konuda kullandıysanız görmek isteriz. Hedefi, sorunuzu, R
Hangi ajanlar REA'yı kullanabilir?
-Yerel MCP sunucularını destekleyen her ajan REA'yı kullanabilir. Kurulum, [desteklenen ajanları](docs/installation.md#supported-agents) yapılandırır; diğer istemciler [elle MCP kaydını](docs/installation.md#mcp-registry) kullanabilir.
+Yerel MCP sunucularını destekleyen her ajan REA'yı kullanabilir. Kurulum, [desteklenen ajanları](../installation.md#supported-agents) yapılandırır; diğer istemciler [elle MCP kaydını](../installation.md#mcp-registry) kullanabilir.
Hopper, Ghidra veya IDA gerekiyor mu?
-Derin yerel kod analizi bunlardan birini kullanır. Statik JavaScript ve .NET incelemesi yerel analiz motoru olmadan çalışır. Kurulum onaydan sonra Hopper yükleyebilir; Ghidra ve IDA mevcut kurulumlarınızı kullanır. [Sağlayıcı kurulumuna](docs/installation.md#hopper) bakın.
+Derin yerel kod analizi bunlardan birini kullanır. Statik JavaScript ve .NET incelemesi yerel analiz motoru olmadan çalışır. Kurulum onaydan sonra Hopper yükleyebilir; Ghidra ve IDA mevcut kurulumlarınızı kullanır. [Sağlayıcı kurulumuna](../installation.md#hopper) bakın.
Önce Hopper'ı başlatmam gerekiyor mu?
-REA, bir işlem gerektirdiğinde Hopper'ı başlatır. macOS'ta ilk çalıştırmada demo modunu seçmenizi veya lisansınızı etkinleştirmenizi isteyen bir iletişim kutusu açılabilir. [Hopper başlatma ve sorun giderme](docs/installation.md#launcher-paths-and-troubleshooting) belgesine bakın.
+REA, bir işlem gerektirdiğinde Hopper'ı başlatır. macOS'ta ilk çalıştırmada demo modunu seçmenizi veya lisansınızı etkinleştirmenizi isteyen bir iletişim kutusu açılabilir. [Hopper başlatma ve sorun giderme](../installation.md#launcher-paths-and-troubleshooting) belgesine bakın.
skills.sh üzerinden skill yüklemek ne yapar?
-Skill, ajanınıza araştırma talimatları sağlar. REA'nın MCP sunucusunu kaydetmek ve uyumlu talimatları yüklemek için `npx rea-agents setup` kullanın, ardından ajanınızı yeniden başlatın. [Yalnızca skill yükleme](docs/installation.md#skill-only-installation) belgesine bakın.
+Skill, ajanınıza araştırma talimatları sağlar. REA'nın MCP sunucusunu kaydetmek ve uyumlu talimatları yüklemek için `npx rea-agents setup` kullanın, ardından ajanınızı yeniden başlatın. [Yalnızca skill yükleme](../installation.md#skill-only-installation) belgesine bakın.
@@ -251,14 +251,14 @@ Ajan kullanıyorsanız [kurulum yenilemesini](#reayı-güncelleyin) tamamlayın
Web sitesindeki [uygulamalı rehberlerden](https://rea.tools/tr/guides/) başlayın. Kesin seçenekler, ön koşullar ve sonuç sözleşmeleri için:
-- [Yükleme ve kurulum](docs/installation.md): ajan kaydı, sağlayıcı yapılandırması, güncellemeler ve kaldırma.
-- [Hazırlık ve sorun giderme](docs/installation.md#check-readiness-for-your-task): belirli bir ajanı veya analiz motorunu tanılama.
-- [CLI ve Evidence](docs/cli.md): komutlar, sağlayıcı seçimi, anlık görüntüler, içe/dışa aktarma ve çıkış durumları.
-- [MCP sözleşmeleri](docs/mcp-contracts.md) ve [ajan istemleri](docs/mcp-prompts.md): araç sonuçları, oturumlar ve yönlendirmeli araştırmalar.
-- [Araç kataloğu](docs/mcp-contracts.md#generated-catalog): derleme sırasında oluşturulan araç, sağlayıcı ve CLI komutu envanteri.
-- [Yol haritası](docs/roadmap.md): planlanan çalışmalar ve yetenek takibi.
+- [Yükleme ve kurulum](../installation.md): ajan kaydı, sağlayıcı yapılandırması, güncellemeler ve kaldırma.
+- [Hazırlık ve sorun giderme](../installation.md#check-readiness-for-your-task): belirli bir ajanı veya analiz motorunu tanılama.
+- [CLI ve Evidence](../cli.md): komutlar, sağlayıcı seçimi, anlık görüntüler, içe/dışa aktarma ve çıkış durumları.
+- [MCP sözleşmeleri](../mcp-contracts.md) ve [ajan istemleri](../mcp-prompts.md): araç sonuçları, oturumlar ve yönlendirmeli araştırmalar.
+- [Araç kataloğu](../mcp-contracts.md#generated-catalog): derleme sırasında oluşturulan araç, sağlayıcı ve CLI komutu envanteri.
+- [Yol haritası](../roadmap.md): planlanan çalışmalar ve yetenek takibi.
-Güvenlik açıklarını [SECURITY.md](SECURITY.md) üzerinden bildirin.
+Güvenlik açıklarını [SECURITY.md](../../SECURITY.md) üzerinden bildirin.
## Yıldız geçmişi
@@ -276,7 +276,7 @@ REA'yı kullanan, hata bildiren, özellik talep eden, derlemeleri test eden ve d
## Sorumluluk reddi
-Sorumlu kullanım yönergeleri için [DISCLAIMER.md](DISCLAIMER.md) dosyasına bakın.
+Sorumlu kullanım yönergeleri için [DISCLAIMER.md](../../DISCLAIMER.md) dosyasına bakın.
REA; yasal araştırma, eğitim, birlikte çalışabilirlik, yazılımın korunması ve sahibi olduğunuz ya da inceleme yetkiniz bulunan yazılımların analizi için tasarlanmıştır.
@@ -288,14 +288,14 @@ applicable licenses.
REA'ya katkınızı bekliyoruz! Hata bildirmek veya özellik önermek için bir [issue açın](https://github.com/morluto/rea/issues); kodu veya belgeleri geliştirmek için bir [pull request gönderin](https://github.com/morluto/rea/pulls).
-Geliştirme ortamı ve kontroller için [CONTRIBUTING.md](CONTRIBUTING.md), doğrulama süreçleri için [test rehberi](docs/testing.md) ve proje yapısı için [mimari harita](docs/architecture.mermaid) belgelerine bakın.
+Geliştirme ortamı ve kontroller için [CONTRIBUTING.md](../../CONTRIBUTING.md), doğrulama süreçleri için [test rehberi](../testing.md) ve proje yapısı için [mimari harita](../architecture.mermaid) belgelerine bakın.
## Lisans
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_uk.md b/docs/readme/README_uk.md
similarity index 80%
rename from README_uk.md
rename to docs/readme/README_uk.md
index 14c3d4984..5c77d80b0 100644
--- a/README_uk.md
+++ b/docs/readme/README_uk.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · **Українська** · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · **Українська** · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: Реверс-інжиніринг будь-чого
@@ -9,10 +9,10 @@
**Побачили цікаву функцію? Зрозумійте, як вона працює, аж до рівня двійкового коду.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Приєднуйтеся до спільноти реверс-інжинірингу
Discord · Запитання й відповіді · Обмін результатами
@@ -67,7 +67,7 @@ npx rea-agents setup
Виберіть агентів, перевірте запропоновані зміни та схваліть їх. Налаштування додає MCP-сервер REA та відповідні інструкції робочих процесів, створюючи резервні копії наявної конфігурації. Після цього перезапустіть агента.
-Налаштування підтримує Claude Code, Codex, Cursor, Gemini CLI, Grok Build та [інших агентів](docs/installation.md#supported-agents). Конфігурацію провайдерів і ручну реєстрацію MCP описано в розділі [встановлення й налаштування](docs/installation.md).
+Налаштування підтримує Claude Code, Codex, Cursor, Gemini CLI, Grok Build та [інших агентів](../installation.md#supported-agents). Конфігурацію провайдерів і ручну реєстрацію MCP описано в розділі [встановлення й налаштування](../installation.md).
### Запитайте агента
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-Для нативного аналізу спочатку налаштуйте провайдера. Нативні команди, вибір провайдера, знімки та використання у скриптах описує [посібник CLI та Evidence](docs/cli.md).
+Для нативного аналізу спочатку налаштуйте провайдера. Нативні команди, вибір провайдера, знімки та використання у скриптах описує [посібник CLI та Evidence](../cli.md).
### Оновіть REA
@@ -120,9 +120,9 @@ npx rea-agents@latest setup
Агент викликає REA через MCP, щоб перевірити ціль і простежити пов'язаний код. REA повертає знахідки разом із підтвердженнями. Агент використовує їх для уточнювальних запитань, пояснення поведінки або написання й тестування реалізації. Команди CLI використовують ті самі робочі процеси.
-
+
-[Відкрити зображення в повному розмірі](website/public/assets/figures/rea-investigation-flow.svg).
+[Відкрити зображення в повному розмірі](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ npx rea-agents@latest setup
REA потребує Node.js 22.x (>=22.19), 24.x (>=24.11) або 26+, а також npm. Додаткові інструменти й підтримувані системи залежать від цілі:
-| Ціль | Що повертає REA | Вимоги й посібник |
-| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Нативні бінарні файли | Псевдокод, асемблерний код, рядки, символи, виклики й посилання | Hopper, Ghidra або IDA; [нативний аналіз](https://rea.tools/uk/guides/native/) |
-| Структура ELF без запуску | Секції, сегменти, початкові символи/релокації та можливі захисні механізми за даними статичного аналізу | pwntools, наданий стороною, що викликає інструмент, у Linux x64; [діагностика бінарних файлів](docs/binary-diagnostics.md) |
-| Байт-код EVM | Селектори диспетчеризації, зміщення байтів, виведені припущення про аргументи та змінюваність стану | Локальні необроблені байти або шістнадцяткове представлення у Linux x64; [посібник EVM без запуску](docs/evm-bytecode.md) |
-| Записані аварійні завершення в Linux | Необроблені записи note, регістри/сигнали кожного записаного потоку й необов'язкові кандидати зіставлення пам'яті | pwntools, наданий стороною, що викликає інструмент, у Linux x64; необов'язкові GDB/pwndbg; [записані аварійні завершення](docs/recorded-crashes.md) |
-| JavaScript / Electron | Модулі, імпорти, карти вихідного коду, маршрути, IPC і зв'язки з нативними доповненнями | Node.js і npm; [аналіз застосунків](https://rea.tools/uk/guides/javascript/) |
-| Сайти | Структура сторінки, скрипти, мережеві спостереження й запитані знімки екрана | Браузер сімейства Chrome; [аналіз браузера](https://rea.tools/uk/guides/browser/) |
-| Збережені мережеві захоплення | Запити, відповіді, доступні корисні дані та місця в джерелі | HAR; mitmdump у Linux для захоплень у власному форматі mitmproxy; [посібник мережевих захоплень](docs/web-network-captures.md) |
-| Захоплення пакетів | Кінцеві точки, DNS, TLS SNI, розподіл протоколів та HTTP-запити | Надані викликаючою стороною tshark та capinfos; [підручник pcap](docs/pcap-analysis.md) |
-| Збірки .NET | Метадані, інструкції CIL, оголошені нативні залежності й порівняння збірок | Статична перевірка; [посібник керованого коду](docs/managed-code-analysis.md) |
-| Android APK | Оголошення маніфесту, класи, декомпільовані методи й посилання | JADX без графічного інтерфейсу й повний JDK у Linux/macOS/Windows x64; [посібник Android](docs/android-analysis.md) |
-| Пристрої Android | Пристрої, пакети, процеси, журнали, дампи, знімки екрана та передавання APK/файлів | adb, наданий викликаючою стороною (емулятор або пристрій); [підручник ADB](docs/adb-device-analysis.md) |
-| Проєкти JEB | Єдиниці проєкту від рушія, дайджести артефактів і псевдокод типів/методів | Запущений викликаною стороною клієнт JEB з MCP, обирається через REA_JEB_MCP_URL; [посібник JEB](docs/jeb-analysis.md) |
-| Ресурси Android | Декодований маніфест, таблиці рядків, мови та відомості про версію | Засіб запуску Apktool, наданий викликаючою стороною; [підручник ресурсів](docs/apktool-resource-analysis.md) |
-| Додатки Flutter | Хеш знімка Dart, дайджести бібліотек за ABI та походження збірки рушія | Не потрібні (статичний розбір APK); [підручник Flutter](docs/flutter-analysis.md) |
-| Прошивки | Області, результати видобування й передавання до нативного аналізу | Binwalk / Unblob у Linux; [посібник прошивок](docs/firmware-analysis.md) |
-| Записані пакети | Вибрані поля, повторювані значення, фільтри та правила декодування | Linux: TShark 4.x + prlimit; [посібник із записів пакетів](docs/packet-captures.md) |
-| Записані логічні сигнали | Анотації декодера, діапазони відліків і діагностика | Linux: sigrok-cli 0.7.2 + prlimit; [посібник із сигналів](docs/signal-recordings.md) |
-| Пакети й ресурси | Переліки файлів, хеші, plist, структура пакетів Apple та видобуті ресурси | [Посібник артефактів і JavaScript](docs/javascript-artifact-reconstruction.md), [застосунки Apple](docs/apple-application-analysis.md) |
-| Поведінка процесів | Вивід термінала, взаємодії, спостереження за завершенням і файловою системою та порівняння запусків | Linux/macOS із нативним PTY; [захоплення процесів](docs/process-capture.md) |
+| Ціль | Що повертає REA | Вимоги й посібник |
+| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Нативні бінарні файли | Псевдокод, асемблерний код, рядки, символи, виклики й посилання | Hopper, Ghidra або IDA; [нативний аналіз](https://rea.tools/uk/guides/native/) |
+| Структура ELF без запуску | Секції, сегменти, початкові символи/релокації та можливі захисні механізми за даними статичного аналізу | pwntools, наданий стороною, що викликає інструмент, у Linux x64; [діагностика бінарних файлів](../binary-diagnostics.md) |
+| Байт-код EVM | Селектори диспетчеризації, зміщення байтів, виведені припущення про аргументи та змінюваність стану | Локальні необроблені байти або шістнадцяткове представлення у Linux x64; [посібник EVM без запуску](../evm-bytecode.md) |
+| Записані аварійні завершення в Linux | Необроблені записи note, регістри/сигнали кожного записаного потоку й необов'язкові кандидати зіставлення пам'яті | pwntools, наданий стороною, що викликає інструмент, у Linux x64; необов'язкові GDB/pwndbg; [записані аварійні завершення](../recorded-crashes.md) |
+| JavaScript / Electron | Модулі, імпорти, карти вихідного коду, маршрути, IPC і зв'язки з нативними доповненнями | Node.js і npm; [аналіз застосунків](https://rea.tools/uk/guides/javascript/) |
+| Сайти | Структура сторінки, скрипти, мережеві спостереження й запитані знімки екрана | Браузер сімейства Chrome; [аналіз браузера](https://rea.tools/uk/guides/browser/) |
+| Збережені мережеві захоплення | Запити, відповіді, доступні корисні дані та місця в джерелі | HAR; mitmdump у Linux для захоплень у власному форматі mitmproxy; [посібник мережевих захоплень](../web-network-captures.md) |
+| Захоплення пакетів | Кінцеві точки, DNS, TLS SNI, розподіл протоколів та HTTP-запити | Надані викликаючою стороною tshark та capinfos; [підручник pcap](../pcap-analysis.md) |
+| Збірки .NET | Метадані, інструкції CIL, оголошені нативні залежності й порівняння збірок | Статична перевірка; [посібник керованого коду](../managed-code-analysis.md) |
+| Android APK | Оголошення маніфесту, класи, декомпільовані методи й посилання | JADX без графічного інтерфейсу й повний JDK у Linux/macOS/Windows x64; [посібник Android](../android-analysis.md) |
+| Пристрої Android | Пристрої, пакети, процеси, журнали, дампи, знімки екрана та передавання APK/файлів | adb, наданий викликаючою стороною (емулятор або пристрій); [підручник ADB](../adb-device-analysis.md) |
+| Проєкти JEB | Єдиниці проєкту від рушія, дайджести артефактів і псевдокод типів/методів | Запущений викликаною стороною клієнт JEB з MCP, обирається через REA_JEB_MCP_URL; [посібник JEB](../jeb-analysis.md) |
+| Ресурси Android | Декодований маніфест, таблиці рядків, мови та відомості про версію | Засіб запуску Apktool, наданий викликаючою стороною; [підручник ресурсів](../apktool-resource-analysis.md) |
+| Додатки Flutter | Хеш знімка Dart, дайджести бібліотек за ABI та походження збірки рушія | Не потрібні (статичний розбір APK); [підручник Flutter](../flutter-analysis.md) |
+| Прошивки | Області, результати видобування й передавання до нативного аналізу | Binwalk / Unblob у Linux; [посібник прошивок](../firmware-analysis.md) |
+| Записані пакети | Вибрані поля, повторювані значення, фільтри та правила декодування | Linux: TShark 4.x + prlimit; [посібник із записів пакетів](../packet-captures.md) |
+| Записані логічні сигнали | Анотації декодера, діапазони відліків і діагностика | Linux: sigrok-cli 0.7.2 + prlimit; [посібник із сигналів](../signal-recordings.md) |
+| Пакети й ресурси | Переліки файлів, хеші, plist, структура пакетів Apple та видобуті ресурси | [Посібник артефактів і JavaScript](../javascript-artifact-reconstruction.md), [застосунки Apple](../apple-application-analysis.md) |
+| Поведінка процесів | Вивід термінала, взаємодії, спостереження за завершенням і файловою системою та порівняння запусків | Linux/macOS із нативним PTY; [захоплення процесів](../process-capture.md) |
Статична перевірка JavaScript і .NET читає надані файли, не запускаючи застосунок. Захоплення під час виконання запускає вибрану ціль або взаємодіє з нею з правами вашого користувача; відповідні посібники описують його вплив.
-Нативні формати й підтримка систем відрізняються залежно від провайдера. Дивіться [налаштування Hopper і Ghidra](docs/installation.md#hopper), [посібник IDA](docs/ida-provider.md) та [експериментальну підтримку Ghidra у Windows](docs/windows-ghidra-p0.md). Ghidra також підтримує [аналіз 16-бітного DOS](docs/ghidra-dos.md). Для вибору провайдера дивіться [посібник CLI](docs/cli.md#choose-a-provider). Для функцій, доданих після найновішої версії в npm, перевірте [доступність у випусках](docs/installation.md#released-package-and-main).
+Нативні формати й підтримка систем відрізняються залежно від провайдера. Дивіться [налаштування Hopper і Ghidra](../installation.md#hopper), [посібник IDA](../ida-provider.md) та [експериментальну підтримку Ghidra у Windows](../windows-ghidra-p0.md). Ghidra також підтримує [аналіз 16-бітного DOS](../ghidra-dos.md). Для вибору провайдера дивіться [посібник CLI](../cli.md#choose-a-provider). Для функцій, доданих після найновішої версії в npm, перевірте [доступність у випусках](../installation.md#released-package-and-main).
## Приклади
-[](https://rea.tools/uk/showcase/)
+[](https://rea.tools/uk/showcase/)
### DX-Ball: відновлення розрахунку звукової панорами
@@ -187,28 +187,28 @@ REA потребує Node.js 22.x (>=22.19), 24.x (>=24.11) або 26+, а та
Які агенти можуть використовувати REA?
-Будь-який агент, що підтримує локальні MCP-сервери. Налаштування конфігурує [підтримуваних агентів](docs/installation.md#supported-agents); інші клієнти можуть використати [ручну реєстрацію MCP](docs/installation.md#mcp-registry).
+Будь-який агент, що підтримує локальні MCP-сервери. Налаштування конфігурує [підтримуваних агентів](../installation.md#supported-agents); інші клієнти можуть використати [ручну реєстрацію MCP](../installation.md#mcp-registry).
Чи потрібні мені Hopper, Ghidra або IDA?
-Поглиблений нативний аналіз використовує один із цих інструментів. Статична перевірка JavaScript і .NET працює без рушія нативного аналізу. Налаштування може встановити Hopper після схвалення; Ghidra й IDA використовують наявні встановлення. Дивіться [налаштування провайдерів](docs/installation.md#hopper).
+Поглиблений нативний аналіз використовує один із цих інструментів. Статична перевірка JavaScript і .NET працює без рушія нативного аналізу. Налаштування може встановити Hopper після схвалення; Ghidra й IDA використовують наявні встановлення. Дивіться [налаштування провайдерів](../installation.md#hopper).
Чи потрібно спочатку запускати Hopper?
-REA запускає Hopper, коли він потрібен для операції. У macOS під час першого запуску може з'явитися діалог вибору деморежиму або активації ліцензії. Дивіться [запуск Hopper та усунення неполадок](docs/installation.md#launcher-paths-and-troubleshooting).
+REA запускає Hopper, коли він потрібен для операції. У macOS під час першого запуску може з'явитися діалог вибору деморежиму або активації ліцензії. Дивіться [запуск Hopper та усунення неполадок](../installation.md#launcher-paths-and-troubleshooting).
Що дає встановлення skill із skills.sh?
-Skill надає агенту інструкції дослідження. Використовуйте `npx rea-agents setup`, щоб зареєструвати MCP-сервер REA та встановити відповідні інструкції, а потім перезапустіть агента. Дивіться [встановлення лише skill](docs/installation.md#skill-only-installation).
+Skill надає агенту інструкції дослідження. Використовуйте `npx rea-agents setup`, щоб зареєструвати MCP-сервер REA та встановити відповідні інструкції, а потім перезапустіть агента. Дивіться [встановлення лише skill](../installation.md#skill-only-installation).
@@ -251,14 +251,14 @@ npx rea-agents@latest setup
Почніть із [практичних посібників](https://rea.tools/uk/guides/) на сайті. Точні параметри, передумови й контракти результатів описано тут:
-- [Встановлення й налаштування](docs/installation.md): реєстрація агентів, конфігурація провайдерів, оновлення та видалення.
-- [Готовність та усунення неполадок](docs/installation.md#check-readiness-for-your-task): діагностика конкретного агента або рушія аналізу.
-- [CLI та Evidence](docs/cli.md): команди, вибір провайдера, знімки, імпорт/експорт і статуси завершення.
-- [Контракти MCP](docs/mcp-contracts.md) і [промпти агентів](docs/mcp-prompts.md): результати інструментів, сеанси й керовані дослідження.
-- [Каталог інструментів](docs/mcp-contracts.md#generated-catalog): створюваний під час збірки перелік інструментів, провайдерів і команд CLI.
-- [План розвитку](docs/roadmap.md): заплановані роботи й відстеження можливостей.
+- [Встановлення й налаштування](../installation.md): реєстрація агентів, конфігурація провайдерів, оновлення та видалення.
+- [Готовність та усунення неполадок](../installation.md#check-readiness-for-your-task): діагностика конкретного агента або рушія аналізу.
+- [CLI та Evidence](../cli.md): команди, вибір провайдера, знімки, імпорт/експорт і статуси завершення.
+- [Контракти MCP](../mcp-contracts.md) і [промпти агентів](../mcp-prompts.md): результати інструментів, сеанси й керовані дослідження.
+- [Каталог інструментів](../mcp-contracts.md#generated-catalog): створюваний під час збірки перелік інструментів, провайдерів і команд CLI.
+- [План розвитку](../roadmap.md): заплановані роботи й відстеження можливостей.
-Повідомляйте про вразливості згідно з [SECURITY.md](SECURITY.md).
+Повідомляйте про вразливості згідно з [SECURITY.md](../../SECURITY.md).
## Історія зірок
@@ -276,7 +276,7 @@ npx rea-agents@latest setup
## Відмова від відповідальності
-Рекомендації щодо відповідального використання наведено в [DISCLAIMER.md](DISCLAIMER.md).
+Рекомендації щодо відповідального використання наведено в [DISCLAIMER.md](../../DISCLAIMER.md).
REA призначений для законних досліджень, навчання, забезпечення сумісності, збереження програмного забезпечення й аналізу програм, якими ви володієте або які маєте дозвіл досліджувати.
@@ -288,14 +288,14 @@ applicable licenses.
Будемо раді вашій допомозі з REA! [Відкрийте issue](https://github.com/morluto/rea/issues), щоб повідомити про помилку чи запропонувати функцію, або [надішліть pull request](https://github.com/morluto/rea/pulls) з поліпшеннями коду чи документації.
-Налаштування середовища розробки й перевірки описано в [CONTRIBUTING.md](CONTRIBUTING.md), шляхи верифікації — у [посібнику тестування](docs/testing.md), а структуру проєкту — на [схемі архітектури](docs/architecture.mermaid).
+Налаштування середовища розробки й перевірки описано в [CONTRIBUTING.md](../../CONTRIBUTING.md), шляхи верифікації — у [посібнику тестування](../testing.md), а структуру проєкту — на [схемі архітектури](../architecture.mermaid).
## Ліцензія
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_vi.md b/docs/readme/README_vi.md
similarity index 75%
rename from README_vi.md
rename to docs/readme/README_vi.md
index 86544a535..3d2062da6 100644
--- a/README_vi.md
+++ b/docs/readme/README_vi.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · **Tiếng Việt** · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · **Tiếng Việt** · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA: Kỹ thuật dịch ngược cho mọi thứ
@@ -9,10 +9,10 @@
**Thấy một tính năng bạn thích? Hiểu cách nó hoạt động, đến tận mức mã nhị phân.**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
Tham gia cộng đồng kỹ thuật dịch ngược
Discord · Hỏi đáp · Chia sẻ kết quả
@@ -67,7 +67,7 @@ npx rea-agents setup
Chọn các tác nhân, xem lại những thay đổi được đề xuất và chấp thuận. Quá trình thiết lập thêm máy chủ MCP của REA cùng hướng dẫn quy trình tương ứng, đồng thời sao lưu cấu hình hiện có. Sau đó khởi động lại tác nhân.
-Quá trình thiết lập hỗ trợ Claude Code, Codex, Cursor, Gemini CLI, Grok Build và [các tác nhân khác](docs/installation.md#supported-agents). Xem [cài đặt và thiết lập](docs/installation.md) để cấu hình trình phân tích và đăng ký MCP thủ công.
+Quá trình thiết lập hỗ trợ Claude Code, Codex, Cursor, Gemini CLI, Grok Build và [các tác nhân khác](../installation.md#supported-agents). Xem [cài đặt và thiết lập](../installation.md) để cấu hình trình phân tích và đăng ký MCP thủ công.
### Hỏi tác nhân
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-Để phân tích mã máy, trước tiên hãy cấu hình trình phân tích. Xem [hướng dẫn CLI và Evidence](docs/cli.md) về các lệnh phân tích mã máy, lựa chọn trình phân tích, ảnh chụp trạng thái và sử dụng trong script.
+Để phân tích mã máy, trước tiên hãy cấu hình trình phân tích. Xem [hướng dẫn CLI và Evidence](../cli.md) về các lệnh phân tích mã máy, lựa chọn trình phân tích, ảnh chụp trạng thái và sử dụng trong script.
### Cập nhật REA
@@ -120,9 +120,9 @@ Xem lại thay đổi cấu hình và khởi động lại tác nhân. Với l
Tác nhân gọi REA qua MCP để kiểm tra mục tiêu và lần theo mã liên quan. REA trả về các phát hiện kèm bằng chứng. Tác nhân dùng chúng để đặt câu hỏi tiếp theo, giải thích hành vi hoặc viết và kiểm thử một cách triển khai. Các lệnh CLI sử dụng cùng quy trình.
-
+
-[Mở hình ở kích thước đầy đủ](website/public/assets/figures/rea-investigation-flow.svg).
+[Mở hình ở kích thước đầy đủ](../../website/public/assets/figures/rea-investigation-flow.svg).
@@ -130,37 +130,37 @@ Tác nhân gọi REA qua MCP để kiểm tra mục tiêu và lần theo mã li
REA yêu cầu Node.js 22.x (>=22.19), 24.x (>=24.11) hoặc 26+, cùng với npm. Công cụ bổ sung và nền tảng chạy REA được hỗ trợ tùy thuộc vào mục tiêu:
-| Mục tiêu | REA trả về gì | Yêu cầu và hướng dẫn |
-| ----------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
-| Tệp nhị phân mã máy | Mã giả, hợp ngữ, chuỗi, ký hiệu, lời gọi và tham chiếu | Hopper, Ghidra hoặc IDA; [phân tích mã máy](https://rea.tools/vi/guides/native/) |
-| Bố cục ELF ngoại tuyến | Các section, segment, ký hiệu/thông tin tái định vị gốc và các biện pháp giảm thiểu có thể có từ phân tích tĩnh | pwntools do bên gọi cung cấp trên Linux x64; [chẩn đoán tệp nhị phân](docs/binary-diagnostics.md) |
-| Bytecode EVM | Bộ chọn điều phối, độ lệch byte, tham số suy luận và khả năng thay đổi trạng thái | Đầu vào cục bộ chứa byte thô hoặc dạng thập lục phân trên Linux x64; [hướng dẫn EVM ngoại tuyến](docs/evm-bytecode.md) |
-| Sự cố Linux đã ghi lại | Bản ghi note thô, thanh ghi/tín hiệu của mọi luồng được ghi lại và các ứng viên ánh xạ tùy chọn | pwntools do bên gọi cung cấp trên Linux x64; GDB/pwndbg tùy chọn; [sự cố đã ghi lại](docs/recorded-crashes.md) |
-| JavaScript / Electron | Mô-đun, các khai báo import, source map, tuyến, IPC và quan hệ với tiện ích mở rộng mã máy | Node.js và npm; [phân tích ứng dụng](https://rea.tools/vi/guides/javascript/) |
-| Trang web | Cấu trúc trang, script, quan sát mạng và ảnh chụp màn hình được yêu cầu | Trình duyệt thuộc họ Chrome; [phân tích trình duyệt](https://rea.tools/vi/guides/browser/) |
-| Bản ghi lưu lượng mạng đã lưu | Yêu cầu, phản hồi, payload có thể truy cập và vị trí nguồn | HAR; mitmdump trên Linux cho bản ghi định dạng gốc của mitmproxy; [hướng dẫn bản ghi mạng](docs/web-network-captures.md) |
-| Bắt gói tin | Điểm cuối, DNS, TLS SNI, phân bố giao thức và yêu cầu HTTP | tshark và capinfos do nơi gọi cung cấp; [hướng dẫn pcap](docs/pcap-analysis.md) |
-| Assembly .NET | Siêu dữ liệu, lệnh CIL, các phụ thuộc mã máy được khai báo và so sánh bản dựng | Kiểm tra tĩnh; [hướng dẫn mã được quản lý](docs/managed-code-analysis.md) |
-| APK Android | Khai báo manifest, lớp, phương thức được dịch ngược và tham chiếu | JADX không giao diện đồ họa và JDK đầy đủ trên Linux/macOS/Windows x64; [hướng dẫn Android](docs/android-analysis.md) |
-| Thiết bị Android | Thiết bị, gói, tiến trình, nhật ký, dump, ảnh chụp màn hình và truyền APK/tệp | adb do nơi gọi cung cấp (trình giả lập hoặc thiết bị); [hướng dẫn ADB](docs/adb-device-analysis.md) |
-| Dự án JEB | Đơn vị dự án từ engine, hash của artifact và mã giả của kiểu/phương thức | Một ứng dụng JEB do nơi gọi khởi động, phục vụ MCP, chọn bằng REA_JEB_MCP_URL; [hướng dẫn JEB](docs/jeb-analysis.md) |
-| Tài nguyên Android | Manifest đã giải mã, bảng chuỗi, ngôn ngữ và thông tin phiên bản | Trình khởi chạy Apktool do nơi gọi cung cấp; [hướng dẫn tài nguyên](docs/apktool-resource-analysis.md) |
-| Ứng dụng Flutter | Băm snapshot Dart, hash thư viện theo ABI và nguồn gốc build engine | Không cần (phân tích APK tĩnh); [hướng dẫn Flutter](docs/flutter-analysis.md) |
-| Phần sụn | Các vùng, kết quả trích xuất và dữ liệu chuyển sang phân tích mã máy | Binwalk / Unblob trên Linux; [hướng dẫn phần sụn](docs/firmware-analysis.md) |
-| Gói tin đã ghi | Trường được chọn, giá trị lặp, bộ lọc và quy tắc giải mã | Linux: TShark 4.x + prlimit; [hướng dẫn bản ghi gói tin](docs/packet-captures.md) |
-| Tín hiệu logic đã ghi | Chú thích bộ giải mã, phạm vi mẫu và chẩn đoán | Linux: sigrok-cli 0.7.2 + prlimit; [hướng dẫn tín hiệu](docs/signal-recordings.md) |
-| Gói và tài nguyên | Danh sách tệp, giá trị băm, plist, cấu trúc bundle Apple và tài nguyên được trích xuất | [Hướng dẫn hiện vật phần mềm và JavaScript](docs/javascript-artifact-reconstruction.md), [ứng dụng Apple](docs/apple-application-analysis.md) |
-| Hành vi tiến trình | Đầu ra terminal, tương tác, quan sát khi thoát và hệ thống tệp, cùng so sánh các lần chạy | Linux/macOS có PTY gốc; [ghi lại tiến trình](docs/process-capture.md) |
+| Mục tiêu | REA trả về gì | Yêu cầu và hướng dẫn |
+| ----------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| Tệp nhị phân mã máy | Mã giả, hợp ngữ, chuỗi, ký hiệu, lời gọi và tham chiếu | Hopper, Ghidra hoặc IDA; [phân tích mã máy](https://rea.tools/vi/guides/native/) |
+| Bố cục ELF ngoại tuyến | Các section, segment, ký hiệu/thông tin tái định vị gốc và các biện pháp giảm thiểu có thể có từ phân tích tĩnh | pwntools do bên gọi cung cấp trên Linux x64; [chẩn đoán tệp nhị phân](../binary-diagnostics.md) |
+| Bytecode EVM | Bộ chọn điều phối, độ lệch byte, tham số suy luận và khả năng thay đổi trạng thái | Đầu vào cục bộ chứa byte thô hoặc dạng thập lục phân trên Linux x64; [hướng dẫn EVM ngoại tuyến](../evm-bytecode.md) |
+| Sự cố Linux đã ghi lại | Bản ghi note thô, thanh ghi/tín hiệu của mọi luồng được ghi lại và các ứng viên ánh xạ tùy chọn | pwntools do bên gọi cung cấp trên Linux x64; GDB/pwndbg tùy chọn; [sự cố đã ghi lại](../recorded-crashes.md) |
+| JavaScript / Electron | Mô-đun, các khai báo import, source map, tuyến, IPC và quan hệ với tiện ích mở rộng mã máy | Node.js và npm; [phân tích ứng dụng](https://rea.tools/vi/guides/javascript/) |
+| Trang web | Cấu trúc trang, script, quan sát mạng và ảnh chụp màn hình được yêu cầu | Trình duyệt thuộc họ Chrome; [phân tích trình duyệt](https://rea.tools/vi/guides/browser/) |
+| Bản ghi lưu lượng mạng đã lưu | Yêu cầu, phản hồi, payload có thể truy cập và vị trí nguồn | HAR; mitmdump trên Linux cho bản ghi định dạng gốc của mitmproxy; [hướng dẫn bản ghi mạng](../web-network-captures.md) |
+| Bắt gói tin | Điểm cuối, DNS, TLS SNI, phân bố giao thức và yêu cầu HTTP | tshark và capinfos do nơi gọi cung cấp; [hướng dẫn pcap](../pcap-analysis.md) |
+| Assembly .NET | Siêu dữ liệu, lệnh CIL, các phụ thuộc mã máy được khai báo và so sánh bản dựng | Kiểm tra tĩnh; [hướng dẫn mã được quản lý](../managed-code-analysis.md) |
+| APK Android | Khai báo manifest, lớp, phương thức được dịch ngược và tham chiếu | JADX không giao diện đồ họa và JDK đầy đủ trên Linux/macOS/Windows x64; [hướng dẫn Android](../android-analysis.md) |
+| Thiết bị Android | Thiết bị, gói, tiến trình, nhật ký, dump, ảnh chụp màn hình và truyền APK/tệp | adb do nơi gọi cung cấp (trình giả lập hoặc thiết bị); [hướng dẫn ADB](../adb-device-analysis.md) |
+| Dự án JEB | Đơn vị dự án từ engine, hash của artifact và mã giả của kiểu/phương thức | Một ứng dụng JEB do nơi gọi khởi động, phục vụ MCP, chọn bằng REA_JEB_MCP_URL; [hướng dẫn JEB](../jeb-analysis.md) |
+| Tài nguyên Android | Manifest đã giải mã, bảng chuỗi, ngôn ngữ và thông tin phiên bản | Trình khởi chạy Apktool do nơi gọi cung cấp; [hướng dẫn tài nguyên](../apktool-resource-analysis.md) |
+| Ứng dụng Flutter | Băm snapshot Dart, hash thư viện theo ABI và nguồn gốc build engine | Không cần (phân tích APK tĩnh); [hướng dẫn Flutter](../flutter-analysis.md) |
+| Phần sụn | Các vùng, kết quả trích xuất và dữ liệu chuyển sang phân tích mã máy | Binwalk / Unblob trên Linux; [hướng dẫn phần sụn](../firmware-analysis.md) |
+| Gói tin đã ghi | Trường được chọn, giá trị lặp, bộ lọc và quy tắc giải mã | Linux: TShark 4.x + prlimit; [hướng dẫn bản ghi gói tin](../packet-captures.md) |
+| Tín hiệu logic đã ghi | Chú thích bộ giải mã, phạm vi mẫu và chẩn đoán | Linux: sigrok-cli 0.7.2 + prlimit; [hướng dẫn tín hiệu](../signal-recordings.md) |
+| Gói và tài nguyên | Danh sách tệp, giá trị băm, plist, cấu trúc bundle Apple và tài nguyên được trích xuất | [Hướng dẫn hiện vật phần mềm và JavaScript](../javascript-artifact-reconstruction.md), [ứng dụng Apple](../apple-application-analysis.md) |
+| Hành vi tiến trình | Đầu ra terminal, tương tác, quan sát khi thoát và hệ thống tệp, cùng so sánh các lần chạy | Linux/macOS có PTY gốc; [ghi lại tiến trình](../process-capture.md) |
Kiểm tra tĩnh JavaScript và .NET đọc các tệp được cung cấp mà không chạy ứng dụng. Ghi lại khi chạy sẽ khởi chạy hoặc tương tác với mục tiêu đã chọn bằng quyền người dùng của bạn; từng hướng dẫn mô tả tác động của nó.
-Định dạng mã máy và nền tảng chạy REA được hỗ trợ khác nhau tùy trình phân tích. Xem [thiết lập Hopper và Ghidra](docs/installation.md#hopper), [hướng dẫn IDA](docs/ida-provider.md) và [hỗ trợ Ghidra thử nghiệm trên Windows](docs/windows-ghidra-p0.md). Ghidra cũng hỗ trợ [phân tích DOS 16 bit](docs/ghidra-dos.md). Để chọn trình phân tích, xem [hướng dẫn CLI](docs/cli.md#choose-a-provider). Kiểm tra [khả năng sử dụng theo bản phát hành](docs/installation.md#released-package-and-main) đối với tính năng được bổ sung sau phiên bản npm mới nhất.
+Định dạng mã máy và nền tảng chạy REA được hỗ trợ khác nhau tùy trình phân tích. Xem [thiết lập Hopper và Ghidra](../installation.md#hopper), [hướng dẫn IDA](../ida-provider.md) và [hỗ trợ Ghidra thử nghiệm trên Windows](../windows-ghidra-p0.md). Ghidra cũng hỗ trợ [phân tích DOS 16 bit](../ghidra-dos.md). Để chọn trình phân tích, xem [hướng dẫn CLI](../cli.md#choose-a-provider). Kiểm tra [khả năng sử dụng theo bản phát hành](../installation.md#released-package-and-main) đối với tính năng được bổ sung sau phiên bản npm mới nhất.
## Các nghiên cứu điển hình
-[](https://rea.tools/vi/showcase/)
+[](https://rea.tools/vi/showcase/)
### DX-Ball: tái tạo phép tính phân bố âm thanh trái phải
@@ -187,28 +187,28 @@ Nếu bạn dùng REA cho một mục tiêu thú vị, chúng tôi muốn biết
Tác nhân nào có thể dùng REA?
-Bất kỳ tác nhân nào hỗ trợ máy chủ MCP cục bộ. Quá trình thiết lập cấu hình các [tác nhân được hỗ trợ](docs/installation.md#supported-agents); ứng dụng khách khác có thể dùng [đăng ký MCP thủ công](docs/installation.md#mcp-registry).
+Bất kỳ tác nhân nào hỗ trợ máy chủ MCP cục bộ. Quá trình thiết lập cấu hình các [tác nhân được hỗ trợ](../installation.md#supported-agents); ứng dụng khách khác có thể dùng [đăng ký MCP thủ công](../installation.md#mcp-registry).
Tôi có cần Hopper, Ghidra hoặc IDA không?
-Phân tích mã máy chuyên sâu sử dụng một trong những công cụ đó. Kiểm tra tĩnh JavaScript và .NET hoạt động mà không cần bộ máy phân tích mã máy. Quá trình thiết lập có thể cài Hopper sau khi được chấp thuận; Ghidra và IDA dùng bản cài đặt sẵn có. Xem [thiết lập trình phân tích](docs/installation.md#hopper).
+Phân tích mã máy chuyên sâu sử dụng một trong những công cụ đó. Kiểm tra tĩnh JavaScript và .NET hoạt động mà không cần bộ máy phân tích mã máy. Quá trình thiết lập có thể cài Hopper sau khi được chấp thuận; Ghidra và IDA dùng bản cài đặt sẵn có. Xem [thiết lập trình phân tích](../installation.md#hopper).
Tôi có cần khởi chạy Hopper trước không?
-REA khởi chạy Hopper khi một thao tác cần đến nó. Trên macOS, hộp thoại lần chạy đầu có thể yêu cầu chọn chế độ dùng thử hoặc kích hoạt giấy phép. Xem [khởi động Hopper và khắc phục sự cố](docs/installation.md#launcher-paths-and-troubleshooting).
+REA khởi chạy Hopper khi một thao tác cần đến nó. Trên macOS, hộp thoại lần chạy đầu có thể yêu cầu chọn chế độ dùng thử hoặc kích hoạt giấy phép. Xem [khởi động Hopper và khắc phục sự cố](../installation.md#launcher-paths-and-troubleshooting).
Cài skill từ skills.sh có tác dụng gì?
-Skill cung cấp hướng dẫn điều tra cho tác nhân. Dùng `npx rea-agents setup` để đăng ký máy chủ MCP của REA và cài hướng dẫn tương ứng, sau đó khởi động lại tác nhân. Xem [chỉ cài skill](docs/installation.md#skill-only-installation).
+Skill cung cấp hướng dẫn điều tra cho tác nhân. Dùng `npx rea-agents setup` để đăng ký máy chủ MCP của REA và cài hướng dẫn tương ứng, sau đó khởi động lại tác nhân. Xem [chỉ cài skill](../installation.md#skill-only-installation).
@@ -251,14 +251,14 @@ Nếu dùng tác nhân, hãy hoàn tất [làm mới thiết lập](#cập-nhậ
Bắt đầu với [hướng dẫn thực hành](https://rea.tools/vi/guides/) trên trang web. Để biết tùy chọn cụ thể, điều kiện tiên quyết và hợp đồng kết quả:
-- [Cài đặt và thiết lập](docs/installation.md): đăng ký tác nhân, cấu hình trình phân tích, cập nhật và gỡ cài đặt.
-- [Kiểm tra mức sẵn sàng và khắc phục sự cố](docs/installation.md#check-readiness-for-your-task): chẩn đoán một tác nhân hoặc bộ máy phân tích cụ thể.
-- [CLI và Evidence](docs/cli.md): lệnh, lựa chọn trình phân tích, ảnh chụp trạng thái, nhập/xuất và trạng thái thoát.
-- [Hợp đồng MCP](docs/mcp-contracts.md) và [prompt cho tác nhân](docs/mcp-prompts.md): kết quả công cụ, phiên làm việc và điều tra có hướng dẫn.
-- [Danh mục công cụ](docs/mcp-contracts.md#generated-catalog): danh sách công cụ, trình phân tích và lệnh CLI được tạo khi dựng dự án.
-- [Lộ trình](docs/roadmap.md): công việc dự kiến và theo dõi các khả năng.
+- [Cài đặt và thiết lập](../installation.md): đăng ký tác nhân, cấu hình trình phân tích, cập nhật và gỡ cài đặt.
+- [Kiểm tra mức sẵn sàng và khắc phục sự cố](../installation.md#check-readiness-for-your-task): chẩn đoán một tác nhân hoặc bộ máy phân tích cụ thể.
+- [CLI và Evidence](../cli.md): lệnh, lựa chọn trình phân tích, ảnh chụp trạng thái, nhập/xuất và trạng thái thoát.
+- [Hợp đồng MCP](../mcp-contracts.md) và [prompt cho tác nhân](../mcp-prompts.md): kết quả công cụ, phiên làm việc và điều tra có hướng dẫn.
+- [Danh mục công cụ](../mcp-contracts.md#generated-catalog): danh sách công cụ, trình phân tích và lệnh CLI được tạo khi dựng dự án.
+- [Lộ trình](../roadmap.md): công việc dự kiến và theo dõi các khả năng.
-Báo cáo lỗ hổng theo [SECURITY.md](SECURITY.md).
+Báo cáo lỗ hổng theo [SECURITY.md](../../SECURITY.md).
## Lịch sử sao
@@ -276,7 +276,7 @@ Cảm ơn mọi người đã sử dụng REA, báo lỗi, đề xuất tính n
## Miễn trừ trách nhiệm
-Xem [DISCLAIMER.md](DISCLAIMER.md) để biết hướng dẫn sử dụng có trách nhiệm.
+Xem [DISCLAIMER.md](../../DISCLAIMER.md) để biết hướng dẫn sử dụng có trách nhiệm.
REA dành cho nghiên cứu, giáo dục, khả năng tương tác, bảo tồn phần mềm và phân tích phần mềm bạn sở hữu hoặc được phép kiểm tra, trong khuôn khổ pháp luật.
@@ -288,14 +288,14 @@ applicable licenses.
Chúng tôi hoan nghênh bạn giúp phát triển REA! [Mở issue](https://github.com/morluto/rea/issues) để báo lỗi hoặc đề xuất tính năng, hoặc [gửi pull request](https://github.com/morluto/rea/pulls) để cải thiện mã hay tài liệu.
-Xem [CONTRIBUTING.md](CONTRIBUTING.md) về thiết lập môi trường phát triển và các bước kiểm tra, [hướng dẫn kiểm thử](docs/testing.md) về các luồng xác minh và [sơ đồ kiến trúc](docs/architecture.mermaid) về cấu trúc dự án.
+Xem [CONTRIBUTING.md](../../CONTRIBUTING.md) về thiết lập môi trường phát triển và các bước kiểm tra, [hướng dẫn kiểm thử](../testing.md) về các luồng xác minh và [sơ đồ kiến trúc](../architecture.mermaid) về cấu trúc dự án.
## Giấy phép
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA-authored code is licensed under MIT. Third-party material retains its own
-licenses and copyright notices; see [Third-party notices](THIRD_PARTY_NOTICES.md)
+licenses and copyright notices; see [Third-party notices](../../THIRD_PARTY_NOTICES.md)
for the dependency inventory, preserved license texts, and external-tool terms.
**You must legally obtain and be authorized to use commercial tools**, including
diff --git a/README_zh-TW.md b/docs/readme/README_zh-TW.md
similarity index 73%
rename from README_zh-TW.md
rename to docs/readme/README_zh-TW.md
index 62c9ab2f3..44956b8eb 100644
--- a/README_zh-TW.md
+++ b/docs/readme/README_zh-TW.md
@@ -1,6 +1,6 @@
-[English](README.md) · [简体中文](README_zh.md) · **繁體中文** · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · [简体中文](README_zh.md) · **繁體中文** · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA:逆向一切
@@ -9,10 +9,10 @@
**看到喜歡的功能,弄清它的工作原理,深入到二進位層面。**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
加入逆向工程社群
Discord · 問答 · 成果分享
@@ -67,7 +67,7 @@ npx rea-agents setup
選擇 AI 代理,檢查計劃中的變更並核准。設定流程會添加 REA 的 MCP 服務和對應的工作流程指引,並備份已有組態。完成後重新啟動 AI 代理。
-設定流程支援 Claude Code、Codex、Cursor、Gemini CLI、Grok Build 和[其他 AI 代理](docs/installation.md#supported-agents)。提供者組態和手動註冊 MCP 的方法見[安裝與設定](docs/installation.md)。
+設定流程支援 Claude Code、Codex、Cursor、Gemini CLI、Grok Build 和[其他 AI 代理](../installation.md#supported-agents)。提供者組態和手動註冊 MCP 的方法見[安裝與設定](../installation.md)。
### 詢問 AI 代理
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-原生分析需要先設定分析提供者。原生命令、提供者選擇、快照和腳本用法見 [CLI 與 Evidence 指南](docs/cli.md)。
+原生分析需要先設定分析提供者。原生命令、提供者選擇、快照和腳本用法見 [CLI 與 Evidence 指南](../cli.md)。
### 更新 REA
@@ -120,9 +120,9 @@ npx rea-agents@latest setup
AI 代理通過 MCP 呼叫 REA,檢查目標並追蹤相關程式碼。REA 返回發現及對應證據。AI 代理據此提出後續問題、解釋行為,或編寫並測試實現。CLI 命令使用同樣的工作流程。
-
+
-[打開完整尺寸的圖示](website/public/assets/figures/rea-investigation-flow.svg)。
+[打開完整尺寸的圖示](../../website/public/assets/figures/rea-investigation-flow.svg)。
@@ -130,37 +130,37 @@ AI 代理通過 MCP 呼叫 REA,檢查目標並追蹤相關程式碼。REA 返
REA 需要 Node.js 22.x(>=22.19)、24.x(>=24.11)或 26+,以及 npm。額外工具和主機支援取決於分析目標:
-| 目標 | REA 返回的內容 | 要求與指南 |
-| --------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| 原生二進位檔案 | 偽程式碼、組合語言、字串、符號、呼叫和引用 | Hopper、Ghidra 或 IDA;[原生分析](https://rea.tools/zh-TW/guides/native/) |
-| 離線 ELF 佈局 | 節、段、原始符號/重定位資訊及靜態防護機制候選項 | Linux x64 上由呼叫方提供的 pwntools;[二進位診斷](docs/binary-diagnostics.md) |
-| EVM 位元組碼 | 分派選擇器、位元組偏移、推斷的參數和狀態可變性 | Linux x64 上的本地原始位元組/十六進位輸入載體;[離線 EVM 指南](docs/evm-bytecode.md) |
-| 已記錄的 Linux 崩潰 | 原始 note 記錄、每個已記錄執行緒的暫存器/訊號及可選的對映候選項 | Linux x64 上由呼叫方提供的 pwntools;可選的 GDB/pwndbg;[已記錄崩潰](docs/recorded-crashes.md) |
-| JavaScript / Electron | 模組、匯入、source map、路由、IPC 和原生附加元件關係 | Node.js 和 npm;[應用分析](https://rea.tools/zh-TW/guides/javascript/) |
-| 網站 | 頁面結構、腳本、網路觀察結果和按請求獲取的螢幕擷取畫面 | Chrome 系瀏覽器;[瀏覽器分析](https://rea.tools/zh-TW/guides/browser/) |
-| 已保存的網路擷取 | 請求、回應、可訪問的酬載和來源位置 | HAR;原生 mitmproxy 擷取需要 Linux 上的 mitmdump;[擷取指南](docs/web-network-captures.md) |
-| 封包擷取 | 端點、DNS、TLS SNI、通訊協定分佈和 HTTP 請求 | 呼叫端提供的 tshark 和 capinfos;[pcap 指南](docs/pcap-analysis.md) |
-| .NET 程式集 | 中繼資料、CIL 指令、聲明的原生依賴和建置對比 | 靜態檢查;[托管程式碼指南](docs/managed-code-analysis.md) |
-| Android APK | 清單聲明、類別、反編譯的方法和引用 | Linux/macOS/Windows x64 上的無界面 JADX 和完整 JDK;[Android 指南](docs/android-analysis.md) |
-| Android 裝置 | 裝置、套件、程序、日誌、傾印、螢幕擷取以及 APK/檔案傳輸 | 呼叫端提供的 adb(模擬器或實體裝置);[ADB 指南](docs/adb-device-analysis.md) |
-| JEB 專案 | 引擎支援的專案單元、成品摘要和型別/方法的虛擬碼 | 由呼叫端啟動、提供 MCP 的 JEB 用戶端,透過 REA_JEB_MCP_URL 選擇;[JEB 指南](docs/jeb-analysis.md) |
-| Android 資源 | 解碼後的清單、字串表、語系和版本資訊 | 呼叫端提供的 Apktool 啟動器;[資源指南](docs/apktool-resource-analysis.md) |
-| Flutter 應用 | Dart 快照雜湊、依 ABI 的程式庫雜湊及引擎建置來源 | 無(靜態 APK 解析);[Flutter 指南](docs/flutter-analysis.md) |
-| 韌體 | 區域、提取結果和轉交原生分析的內容 | Linux 上的 Binwalk / Unblob;[韌體指南](docs/firmware-analysis.md) |
-| 封包記錄 | 指定欄位、重複值、篩選條件與解碼規則 | Linux: TShark 4.x + prlimit; [封包分析指南](docs/packet-captures.md) |
-| 錄製的邏輯訊號 | 解碼註解、樣本範圍與診斷資訊 | Linux: sigrok-cli 0.7.2 + prlimit; [訊號記錄指南](docs/signal-recordings.md) |
-| 軟體包與資源 | 檔案清單、摘要、plist、Apple bundle 結構和提取的資源 | [製品與 JavaScript 指南](docs/javascript-artifact-reconstruction.md)、[Apple 應用](docs/apple-application-analysis.md) |
-| 處理程序行為 | 終端輸出、互動、退出和檔案系統觀察結果,以及執行對比 | 支援原生 PTY 的 Linux/macOS;[處理程序擷取](docs/process-capture.md) |
+| 目標 | REA 返回的內容 | 要求與指南 |
+| --------------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| 原生二進位檔案 | 偽程式碼、組合語言、字串、符號、呼叫和引用 | Hopper、Ghidra 或 IDA;[原生分析](https://rea.tools/zh-TW/guides/native/) |
+| 離線 ELF 佈局 | 節、段、原始符號/重定位資訊及靜態防護機制候選項 | Linux x64 上由呼叫方提供的 pwntools;[二進位診斷](../binary-diagnostics.md) |
+| EVM 位元組碼 | 分派選擇器、位元組偏移、推斷的參數和狀態可變性 | Linux x64 上的本地原始位元組/十六進位輸入載體;[離線 EVM 指南](../evm-bytecode.md) |
+| 已記錄的 Linux 崩潰 | 原始 note 記錄、每個已記錄執行緒的暫存器/訊號及可選的對映候選項 | Linux x64 上由呼叫方提供的 pwntools;可選的 GDB/pwndbg;[已記錄崩潰](../recorded-crashes.md) |
+| JavaScript / Electron | 模組、匯入、source map、路由、IPC 和原生附加元件關係 | Node.js 和 npm;[應用分析](https://rea.tools/zh-TW/guides/javascript/) |
+| 網站 | 頁面結構、腳本、網路觀察結果和按請求獲取的螢幕擷取畫面 | Chrome 系瀏覽器;[瀏覽器分析](https://rea.tools/zh-TW/guides/browser/) |
+| 已保存的網路擷取 | 請求、回應、可訪問的酬載和來源位置 | HAR;原生 mitmproxy 擷取需要 Linux 上的 mitmdump;[擷取指南](../web-network-captures.md) |
+| 封包擷取 | 端點、DNS、TLS SNI、通訊協定分佈和 HTTP 請求 | 呼叫端提供的 tshark 和 capinfos;[pcap 指南](../pcap-analysis.md) |
+| .NET 程式集 | 中繼資料、CIL 指令、聲明的原生依賴和建置對比 | 靜態檢查;[托管程式碼指南](../managed-code-analysis.md) |
+| Android APK | 清單聲明、類別、反編譯的方法和引用 | Linux/macOS/Windows x64 上的無界面 JADX 和完整 JDK;[Android 指南](../android-analysis.md) |
+| Android 裝置 | 裝置、套件、程序、日誌、傾印、螢幕擷取以及 APK/檔案傳輸 | 呼叫端提供的 adb(模擬器或實體裝置);[ADB 指南](../adb-device-analysis.md) |
+| JEB 專案 | 引擎支援的專案單元、成品摘要和型別/方法的虛擬碼 | 由呼叫端啟動、提供 MCP 的 JEB 用戶端,透過 REA_JEB_MCP_URL 選擇;[JEB 指南](../jeb-analysis.md) |
+| Android 資源 | 解碼後的清單、字串表、語系和版本資訊 | 呼叫端提供的 Apktool 啟動器;[資源指南](../apktool-resource-analysis.md) |
+| Flutter 應用 | Dart 快照雜湊、依 ABI 的程式庫雜湊及引擎建置來源 | 無(靜態 APK 解析);[Flutter 指南](../flutter-analysis.md) |
+| 韌體 | 區域、提取結果和轉交原生分析的內容 | Linux 上的 Binwalk / Unblob;[韌體指南](../firmware-analysis.md) |
+| 封包記錄 | 指定欄位、重複值、篩選條件與解碼規則 | Linux: TShark 4.x + prlimit; [封包分析指南](../packet-captures.md) |
+| 錄製的邏輯訊號 | 解碼註解、樣本範圍與診斷資訊 | Linux: sigrok-cli 0.7.2 + prlimit; [訊號記錄指南](../signal-recordings.md) |
+| 軟體包與資源 | 檔案清單、摘要、plist、Apple bundle 結構和提取的資源 | [製品與 JavaScript 指南](../javascript-artifact-reconstruction.md)、[Apple 應用](../apple-application-analysis.md) |
+| 處理程序行為 | 終端輸出、互動、退出和檔案系統觀察結果,以及執行對比 | 支援原生 PTY 的 Linux/macOS;[處理程序擷取](../process-capture.md) |
靜態 JavaScript 和 .NET 檢查讀取提供的檔案,不執行應用。執行階段擷取會以你的使用者權限執行目標或與之互動;各執行階段指南說明瞭具體影響。
-不同提供者支援的原生格式和主機系統有所不同。請參閱 [Hopper 與 Ghidra 設定](docs/installation.md#hopper)、[IDA 指南](docs/ida-provider.md)和[實驗性 Windows Ghidra 支援](docs/windows-ghidra-p0.md)。Ghidra 也支援 [16 位 DOS 分析](docs/ghidra-dos.md)。提供者選擇見 [CLI 指南](docs/cli.md#choose-a-provider)。對於最新 npm 版本發佈後新增的功能,請查看[發佈可用性](docs/installation.md#released-package-and-main)。
+不同提供者支援的原生格式和主機系統有所不同。請參閱 [Hopper 與 Ghidra 設定](../installation.md#hopper)、[IDA 指南](../ida-provider.md)和[實驗性 Windows Ghidra 支援](../windows-ghidra-p0.md)。Ghidra 也支援 [16 位 DOS 分析](../ghidra-dos.md)。提供者選擇見 [CLI 指南](../cli.md#choose-a-provider)。對於最新 npm 版本發佈後新增的功能,請查看[發佈可用性](../installation.md#released-package-and-main)。
## 案例
-[](https://rea.tools/zh-TW/showcase/)
+[](https://rea.tools/zh-TW/showcase/)
### DX-Ball:重建聲像計算
@@ -189,28 +189,28 @@ REA 需要 Node.js 22.x(>=22.19)、24.x(>=24.11)或 26+,以及 npm。
哪些 AI 代理可以使用 REA?
-任何支援本地 MCP 服務的 AI 代理都可以使用。設定流程會設定[受支援的 AI 代理](docs/installation.md#supported-agents);其他客戶端可通過[手動註冊 MCP](docs/installation.md#mcp-registry) 使用。
+任何支援本地 MCP 服務的 AI 代理都可以使用。設定流程會設定[受支援的 AI 代理](../installation.md#supported-agents);其他客戶端可通過[手動註冊 MCP](../installation.md#mcp-registry) 使用。
需要 Hopper、Ghidra 或 IDA 嗎?
-深入的原生分析需要其中一個引擎。靜態 JavaScript 和 .NET 檢查不需要原生分析引擎。設定流程可以在你核准後安裝 Hopper;Ghidra 和 IDA 則使用已有安裝。見[提供者設定](docs/installation.md#hopper)。
+深入的原生分析需要其中一個引擎。靜態 JavaScript 和 .NET 檢查不需要原生分析引擎。設定流程可以在你核准後安裝 Hopper;Ghidra 和 IDA 則使用已有安裝。見[提供者設定](../installation.md#hopper)。
需要先啟動 Hopper 嗎?
-REA 會在操作需要時啟動 Hopper。在 macOS 上,首次執行時可能會出現對話框,讓你選擇演示模式或啟用授權。見 [Hopper 啟動與故障排查](docs/installation.md#launcher-paths-and-troubleshooting)。
+REA 會在操作需要時啟動 Hopper。在 macOS 上,首次執行時可能會出現對話框,讓你選擇演示模式或啟用授權。見 [Hopper 啟動與故障排查](../installation.md#launcher-paths-and-troubleshooting)。
從 skills.sh 安裝 skill 有什麼作用?
-skill 為 AI 代理提供調查指引。使用 `npx rea-agents setup` 註冊 REA 的 MCP 服務並安裝對應的指引,然後重新啟動 AI 代理。見[僅安裝 skill](docs/installation.md#skill-only-installation)。
+skill 為 AI 代理提供調查指引。使用 `npx rea-agents setup` 註冊 REA 的 MCP 服務並安裝對應的指引,然後重新啟動 AI 代理。見[僅安裝 skill](../installation.md#skill-only-installation)。
@@ -253,14 +253,14 @@ npx rea-agents@latest setup
可以先閱讀網站上的[實操指南](https://rea.tools/zh-TW/guides/)。具體選項、前提條件和結果契約見:
-- [安裝與設定](docs/installation.md):AI 代理註冊、提供者組態、更新和卸載。
-- [就緒檢查與故障排查](docs/installation.md#check-readiness-for-your-task):診斷特定 AI 代理或分析引擎。
-- [CLI 與 Evidence](docs/cli.md):命令、提供者選擇、快照、匯入/匯出和退出狀態。
-- [MCP 契約](docs/mcp-contracts.md)和[AI 代理提示詞](docs/mcp-prompts.md):工具結果、會話和引導式調查。
-- [工具目錄](docs/mcp-contracts.md#generated-catalog):建置時生成的工具、提供者和 CLI 命令清單。
-- [路線圖](docs/roadmap.md):計劃中的工作和能力跟蹤。
+- [安裝與設定](../installation.md):AI 代理註冊、提供者組態、更新和卸載。
+- [就緒檢查與故障排查](../installation.md#check-readiness-for-your-task):診斷特定 AI 代理或分析引擎。
+- [CLI 與 Evidence](../cli.md):命令、提供者選擇、快照、匯入/匯出和退出狀態。
+- [MCP 契約](../mcp-contracts.md)和[AI 代理提示詞](../mcp-prompts.md):工具結果、會話和引導式調查。
+- [工具目錄](../mcp-contracts.md#generated-catalog):建置時生成的工具、提供者和 CLI 命令清單。
+- [路線圖](../roadmap.md):計劃中的工作和能力跟蹤。
-請按照 [SECURITY.md](SECURITY.md) 報告漏洞。
+請按照 [SECURITY.md](../../SECURITY.md) 報告漏洞。
## Star 歷史
@@ -278,7 +278,7 @@ npx rea-agents@latest setup
## 免責聲明
-負責任使用的相關指引請見 [DISCLAIMER.md](DISCLAIMER.md)。
+負責任使用的相關指引請見 [DISCLAIMER.md](../../DISCLAIMER.md)。
REA 用於合法的研究、教育、互通性、軟體保存,以及分析你擁有或獲准檢查的軟體。
@@ -289,14 +289,14 @@ REA 用於合法的研究、教育、互通性、軟體保存,以及分析你
歡迎幫助改進 REA!你可以[提交 issue](https://github.com/morluto/rea/issues) 報告錯誤或建議功能,也可以[提交 pull request](https://github.com/morluto/rea/pulls) 改進程式碼或文件。
-開發設定和檢查見 [CONTRIBUTING.md](CONTRIBUTING.md),驗證流程見[測試指南](docs/testing.md),專案結構見[架構圖](docs/architecture.mermaid)。
+開發設定和檢查見 [CONTRIBUTING.md](../../CONTRIBUTING.md),驗證流程見[測試指南](../testing.md),專案結構見[架構圖](../architecture.mermaid)。
## 授權條款
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA 自行編寫的程式碼採用 MIT 授權;第三方內容保留各自的授權和著作權聲明。
-依賴清單、授權原文及外部工具條款見[第三方聲明](THIRD_PARTY_NOTICES.md)。
+依賴清單、授權原文及外部工具條款見[第三方聲明](../../THIRD_PARTY_NOTICES.md)。
**使用者須自行合法取得商用工具及所需使用權**,包括 IDA Pro / Hex-Rays 反編譯器、
Hopper 和 JEB,並遵守各自授權。REA 不提供工具授權、金鑰或啟用權利;試用版和
diff --git a/README_zh.md b/docs/readme/README_zh.md
similarity index 73%
rename from README_zh.md
rename to docs/readme/README_zh.md
index c8d66ce08..85e51651f 100644
--- a/README_zh.md
+++ b/docs/readme/README_zh.md
@@ -1,6 +1,6 @@
-[English](README.md) · **简体中文** · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
+[English](../../README.md) · **简体中文** · [繁體中文](README_zh-TW.md) · [日本語](README_ja.md) · [한국어](README_ko.md) · [Türkçe](README_tr.md) · [Русский](README_ru.md) · [Tiếng Việt](README_vi.md) · [ไทย](README_th.md) · [Deutsch](README_de.md) · [Español](README_es.md) · [Français](README_fr.md) · [Українська](README_uk.md) · [Polski](README_pl.md) · [Português (Brasil)](README_pt-BR.md) · [العربية](README_ar.md) · [فارسی](README_fa.md) · [Bahasa Indonesia](README_id.md) · [Italiano](README_it.md)
# REA:逆向一切
@@ -9,10 +9,10 @@
**看到喜欢的功能,弄清它的工作原理,深入到二进制层面。**
[](https://www.npmjs.com/package/rea-agents)
-[](docs/mcp-contracts.md#generated-catalog)
+[](../mcp-contracts.md#generated-catalog)
[](#current-status)
[](https://skills.sh/morluto/rea/reverse-engineer-anything)
-[](LICENSE)
+[](../../LICENSE)
[](https://discord.gg/GkcryMnJDM)

@@ -25,7 +25,7 @@
- 
+
@@ -33,7 +33,7 @@
- 
+ 
加入逆向工程社区
Discord · 问答 · 成果分享
@@ -67,7 +67,7 @@ npx rea-agents setup
选择智能体,检查计划中的变更并批准。设置流程会添加 REA 的 MCP 服务和匹配的工作流指引,并备份已有配置。完成后重启智能体。
-设置流程支持 Claude Code、Codex、Cursor、Gemini CLI、Grok Build 和[其他智能体](docs/installation.md#supported-agents)。提供方配置和手动注册 MCP 的方法见[安装与设置](docs/installation.md)。
+设置流程支持 Claude Code、Codex、Cursor、Gemini CLI、Grok Build 和[其他智能体](../installation.md#supported-agents)。提供方配置和手动注册 MCP 的方法见[安装与设置](../installation.md)。
### 询问智能体
@@ -94,7 +94,7 @@ npm install --global rea-agents
rea --help
```
-原生分析需要先配置分析提供方。原生命令、提供方选择、快照和脚本用法见 [CLI 与 Evidence 指南](docs/cli.md)。
+原生分析需要先配置分析提供方。原生命令、提供方选择、快照和脚本用法见 [CLI 与 Evidence 指南](../cli.md)。
### 更新 REA
@@ -120,9 +120,9 @@ npx rea-agents@latest setup
智能体通过 MCP 调用 REA,检查目标并追踪相关代码。REA 返回发现及对应证据。智能体据此提出后续问题、解释行为,或编写并测试实现。CLI 命令使用同样的工作流。
-
+
-[打开完整尺寸的图示](website/public/assets/figures/rea-investigation-flow.svg)。
+[打开完整尺寸的图示](../../website/public/assets/figures/rea-investigation-flow.svg)。
@@ -130,37 +130,37 @@ npx rea-agents@latest setup
REA 需要 Node.js 22.x(>=22.19)、24.x(>=24.11)或 26+,以及 npm。额外工具和主机支持取决于分析目标:
-| 目标 | REA 返回的内容 | 要求与指南 |
-| --------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| 原生二进制文件 | 伪代码、汇编、字符串、符号、调用和引用 | Hopper、Ghidra 或 IDA;[原生分析](https://rea.tools/zh-CN/guides/native/) |
-| 离线 ELF 布局 | 节、段、原始符号/重定位信息及静态防护机制候选项 | Linux x64 上由调用方提供的 pwntools;[二进制诊断](docs/binary-diagnostics.md) |
-| EVM 字节码 | 分派选择器、字节偏移、推断的参数和状态可变性 | Linux x64 上的本地原始字节/十六进制输入载体;[离线 EVM 指南](docs/evm-bytecode.md) |
-| 已记录的 Linux 崩溃 | 原始 note 记录、每个已记录线程的寄存器/信号及可选的映射候选项 | Linux x64 上由调用方提供的 pwntools;可选的 GDB/pwndbg;[已记录崩溃](docs/recorded-crashes.md) |
-| JavaScript / Electron | 模块、导入、source map、路由、IPC 和原生扩展关系 | Node.js 和 npm;[应用分析](https://rea.tools/zh-CN/guides/javascript/) |
-| 网站 | 页面结构、脚本、网络观察结果和按请求获取的截图 | Chrome 系浏览器;[浏览器分析](https://rea.tools/zh-CN/guides/browser/) |
-| 已保存的网络捕获 | 请求、响应、可访问的载荷和来源位置 | HAR;原生 mitmproxy 捕获需要 Linux 上的 mitmdump;[捕获指南](docs/web-network-captures.md) |
-| 数据包捕获 | 端点、DNS、TLS SNI、协议分布和 HTTP 请求 | 调用方提供的 tshark 和 capinfos;[pcap 指南](docs/pcap-analysis.md) |
-| .NET 程序集 | 元数据、CIL 指令、声明的原生依赖和构建对比 | 静态检查;[托管代码指南](docs/managed-code-analysis.md) |
-| Android APK | 清单声明、类、反编译的方法和引用 | Linux/macOS/Windows x64 上的无界面 JADX 和完整 JDK;[Android 指南](docs/android-analysis.md) |
-| Android 设备 | 设备、软件包、进程、日志、转储、屏幕截图以及 APK/文件传输 | 调用方提供的 adb(模拟器或实体设备);[ADB 指南](docs/adb-device-analysis.md) |
-| JEB 项目 | 引擎支持的项目单元、工件摘要和类型/方法的伪代码 | 由调用方启动、提供 MCP 的 JEB 客户端,通过 REA_JEB_MCP_URL 选择;[JEB 指南](docs/jeb-analysis.md) |
-| Android 资源 | 解码后的清单、字符串表、语言区域和版本信息 | 调用方提供的 Apktool 启动器;[资源指南](docs/apktool-resource-analysis.md) |
-| Flutter 应用 | Dart 快照哈希、按 ABI 的库摘要及引擎构建溯源 | 无(静态 APK 解析);[Flutter 指南](docs/flutter-analysis.md) |
-| 固件 | 区域、提取结果和转交原生分析的内容 | Linux 上的 Binwalk / Unblob;[固件指南](docs/firmware-analysis.md) |
-| 抓包文件 | 指定字段、重复值、过滤条件与解码规则 | Linux: TShark 4.x + prlimit; [抓包分析指南](docs/packet-captures.md) |
-| 录制的逻辑信号 | 解码注释、样本范围和诊断信息 | Linux: sigrok-cli 0.7.2 + prlimit; [信号记录指南](docs/signal-recordings.md) |
-| 软件包与资源 | 文件清单、摘要、plist、Apple bundle 结构和提取的资源 | [制品与 JavaScript 指南](docs/javascript-artifact-reconstruction.md)、[Apple 应用](docs/apple-application-analysis.md) |
-| 进程行为 | 终端输出、交互、退出和文件系统观察结果,以及运行对比 | 支持原生 PTY 的 Linux/macOS;[进程捕获](docs/process-capture.md) |
+| 目标 | REA 返回的内容 | 要求与指南 |
+| --------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+| 原生二进制文件 | 伪代码、汇编、字符串、符号、调用和引用 | Hopper、Ghidra 或 IDA;[原生分析](https://rea.tools/zh-CN/guides/native/) |
+| 离线 ELF 布局 | 节、段、原始符号/重定位信息及静态防护机制候选项 | Linux x64 上由调用方提供的 pwntools;[二进制诊断](../binary-diagnostics.md) |
+| EVM 字节码 | 分派选择器、字节偏移、推断的参数和状态可变性 | Linux x64 上的本地原始字节/十六进制输入载体;[离线 EVM 指南](../evm-bytecode.md) |
+| 已记录的 Linux 崩溃 | 原始 note 记录、每个已记录线程的寄存器/信号及可选的映射候选项 | Linux x64 上由调用方提供的 pwntools;可选的 GDB/pwndbg;[已记录崩溃](../recorded-crashes.md) |
+| JavaScript / Electron | 模块、导入、source map、路由、IPC 和原生扩展关系 | Node.js 和 npm;[应用分析](https://rea.tools/zh-CN/guides/javascript/) |
+| 网站 | 页面结构、脚本、网络观察结果和按请求获取的截图 | Chrome 系浏览器;[浏览器分析](https://rea.tools/zh-CN/guides/browser/) |
+| 已保存的网络捕获 | 请求、响应、可访问的载荷和来源位置 | HAR;原生 mitmproxy 捕获需要 Linux 上的 mitmdump;[捕获指南](../web-network-captures.md) |
+| 数据包捕获 | 端点、DNS、TLS SNI、协议分布和 HTTP 请求 | 调用方提供的 tshark 和 capinfos;[pcap 指南](../pcap-analysis.md) |
+| .NET 程序集 | 元数据、CIL 指令、声明的原生依赖和构建对比 | 静态检查;[托管代码指南](../managed-code-analysis.md) |
+| Android APK | 清单声明、类、反编译的方法和引用 | Linux/macOS/Windows x64 上的无界面 JADX 和完整 JDK;[Android 指南](../android-analysis.md) |
+| Android 设备 | 设备、软件包、进程、日志、转储、屏幕截图以及 APK/文件传输 | 调用方提供的 adb(模拟器或实体设备);[ADB 指南](../adb-device-analysis.md) |
+| JEB 项目 | 引擎支持的项目单元、工件摘要和类型/方法的伪代码 | 由调用方启动、提供 MCP 的 JEB 客户端,通过 REA_JEB_MCP_URL 选择;[JEB 指南](../jeb-analysis.md) |
+| Android 资源 | 解码后的清单、字符串表、语言区域和版本信息 | 调用方提供的 Apktool 启动器;[资源指南](../apktool-resource-analysis.md) |
+| Flutter 应用 | Dart 快照哈希、按 ABI 的库摘要及引擎构建溯源 | 无(静态 APK 解析);[Flutter 指南](../flutter-analysis.md) |
+| 固件 | 区域、提取结果和转交原生分析的内容 | Linux 上的 Binwalk / Unblob;[固件指南](../firmware-analysis.md) |
+| 抓包文件 | 指定字段、重复值、过滤条件与解码规则 | Linux: TShark 4.x + prlimit; [抓包分析指南](../packet-captures.md) |
+| 录制的逻辑信号 | 解码注释、样本范围和诊断信息 | Linux: sigrok-cli 0.7.2 + prlimit; [信号记录指南](../signal-recordings.md) |
+| 软件包与资源 | 文件清单、摘要、plist、Apple bundle 结构和提取的资源 | [制品与 JavaScript 指南](../javascript-artifact-reconstruction.md)、[Apple 应用](../apple-application-analysis.md) |
+| 进程行为 | 终端输出、交互、退出和文件系统观察结果,以及运行对比 | 支持原生 PTY 的 Linux/macOS;[进程捕获](../process-capture.md) |
静态 JavaScript 和 .NET 检查读取提供的文件,不运行应用。运行时捕获会以你的用户权限运行目标或与之交互;各运行时指南说明了具体影响。
-不同提供方支持的原生格式和主机系统有所不同。请参阅 [Hopper 与 Ghidra 设置](docs/installation.md#hopper)、[IDA 指南](docs/ida-provider.md)和[实验性 Windows Ghidra 支持](docs/windows-ghidra-p0.md)。Ghidra 也支持 [16 位 DOS 分析](docs/ghidra-dos.md)。提供方选择见 [CLI 指南](docs/cli.md#choose-a-provider)。对于最新 npm 版本发布后新增的功能,请查看[发布可用性](docs/installation.md#released-package-and-main)。
+不同提供方支持的原生格式和主机系统有所不同。请参阅 [Hopper 与 Ghidra 设置](../installation.md#hopper)、[IDA 指南](../ida-provider.md)和[实验性 Windows Ghidra 支持](../windows-ghidra-p0.md)。Ghidra 也支持 [16 位 DOS 分析](../ghidra-dos.md)。提供方选择见 [CLI 指南](../cli.md#choose-a-provider)。对于最新 npm 版本发布后新增的功能,请查看[发布可用性](../installation.md#released-package-and-main)。
## 案例
-[](https://rea.tools/zh-CN/showcase/)
+[](https://rea.tools/zh-CN/showcase/)
### DX-Ball:重建声像计算
@@ -189,28 +189,28 @@ REA 需要 Node.js 22.x(>=22.19)、24.x(>=24.11)或 26+,以及 npm。
哪些智能体可以使用 REA?
-任何支持本地 MCP 服务的智能体都可以使用。设置流程会配置[受支持的智能体](docs/installation.md#supported-agents);其他客户端可通过[手动注册 MCP](docs/installation.md#mcp-registry) 使用。
+任何支持本地 MCP 服务的智能体都可以使用。设置流程会配置[受支持的智能体](../installation.md#supported-agents);其他客户端可通过[手动注册 MCP](../installation.md#mcp-registry) 使用。
需要 Hopper、Ghidra 或 IDA 吗?
-深入的原生分析需要其中一个引擎。静态 JavaScript 和 .NET 检查不需要原生分析引擎。设置流程可以在你批准后安装 Hopper;Ghidra 和 IDA 则使用已有安装。见[提供方设置](docs/installation.md#hopper)。
+深入的原生分析需要其中一个引擎。静态 JavaScript 和 .NET 检查不需要原生分析引擎。设置流程可以在你批准后安装 Hopper;Ghidra 和 IDA 则使用已有安装。见[提供方设置](../installation.md#hopper)。
需要先启动 Hopper 吗?
-REA 会在操作需要时启动 Hopper。在 macOS 上,首次运行时可能会出现对话框,让你选择演示模式或激活许可证。见 [Hopper 启动与故障排查](docs/installation.md#launcher-paths-and-troubleshooting)。
+REA 会在操作需要时启动 Hopper。在 macOS 上,首次运行时可能会出现对话框,让你选择演示模式或激活许可证。见 [Hopper 启动与故障排查](../installation.md#launcher-paths-and-troubleshooting)。
从 skills.sh 安装 skill 有什么作用?
-skill 为智能体提供调查指引。使用 `npx rea-agents setup` 注册 REA 的 MCP 服务并安装匹配的指引,然后重启智能体。见[仅安装 skill](docs/installation.md#skill-only-installation)。
+skill 为智能体提供调查指引。使用 `npx rea-agents setup` 注册 REA 的 MCP 服务并安装匹配的指引,然后重启智能体。见[仅安装 skill](../installation.md#skill-only-installation)。
@@ -253,14 +253,14 @@ npx rea-agents@latest setup
可以先阅读网站上的[实操指南](https://rea.tools/zh-CN/guides/)。具体选项、前提条件和结果契约见:
-- [安装与设置](docs/installation.md):智能体注册、提供方配置、更新和卸载。
-- [就绪检查与故障排查](docs/installation.md#check-readiness-for-your-task):诊断特定智能体或分析引擎。
-- [CLI 与 Evidence](docs/cli.md):命令、提供方选择、快照、导入/导出和退出状态。
-- [MCP 契约](docs/mcp-contracts.md)和[智能体提示词](docs/mcp-prompts.md):工具结果、会话和引导式调查。
-- [工具目录](docs/mcp-contracts.md#generated-catalog):构建时生成的工具、提供方和 CLI 命令清单。
-- [路线图](docs/roadmap.md):计划中的工作和能力跟踪。
+- [安装与设置](../installation.md):智能体注册、提供方配置、更新和卸载。
+- [就绪检查与故障排查](../installation.md#check-readiness-for-your-task):诊断特定智能体或分析引擎。
+- [CLI 与 Evidence](../cli.md):命令、提供方选择、快照、导入/导出和退出状态。
+- [MCP 契约](../mcp-contracts.md)和[智能体提示词](../mcp-prompts.md):工具结果、会话和引导式调查。
+- [工具目录](../mcp-contracts.md#generated-catalog):构建时生成的工具、提供方和 CLI 命令清单。
+- [路线图](../roadmap.md):计划中的工作和能力跟踪。
-请按照 [SECURITY.md](SECURITY.md) 报告漏洞。
+请按照 [SECURITY.md](../../SECURITY.md) 报告漏洞。
## Star 历史
@@ -278,7 +278,7 @@ npx rea-agents@latest setup
## 免责声明
-负责任使用的相关指引请见 [DISCLAIMER.md](DISCLAIMER.md)。
+负责任使用的相关指引请见 [DISCLAIMER.md](../../DISCLAIMER.md)。
REA 用于合法的研究、教育、互操作性、软件保存,以及分析你拥有或获准检查的软件。
@@ -289,14 +289,14 @@ REA 用于合法的研究、教育、互操作性、软件保存,以及分析
欢迎帮助改进 REA!你可以[提交 issue](https://github.com/morluto/rea/issues) 报告错误或建议功能,也可以[提交 pull request](https://github.com/morluto/rea/pulls) 改进代码或文档。
-开发设置和检查见 [CONTRIBUTING.md](CONTRIBUTING.md),验证流程见[测试指南](docs/testing.md),项目结构见[架构图](docs/architecture.mermaid)。
+开发设置和检查见 [CONTRIBUTING.md](../../CONTRIBUTING.md),验证流程见[测试指南](../testing.md),项目结构见[架构图](../architecture.mermaid)。
## 许可证
-[MIT](LICENSE)
+[MIT](../../LICENSE)
REA 自行编写的代码采用 MIT 许可;第三方内容保留各自的许可和著作权声明。
-依赖清单、许可原文及外部工具条款见[第三方声明](THIRD_PARTY_NOTICES.md)。
+依赖清单、许可原文及外部工具条款见[第三方声明](../../THIRD_PARTY_NOTICES.md)。
**用户须自行合法取得商用工具及所需使用权**,包括 IDA Pro / Hex-Rays 反编译器、
Hopper 和 JEB,并遵守各自许可。REA 不提供工具许可、密钥或激活权利;试用版和
diff --git a/docs/recorded-crashes.md b/docs/recorded-crashes.md
index d68db74fd..8b1a51662 100644
--- a/docs/recorded-crashes.md
+++ b/docs/recorded-crashes.md
@@ -72,9 +72,13 @@ debugger context is `observed`.
Initial Linux x64 limits: 32 MiB input, 64 MiB decoder reply, 1 MiB diagnostics per
stage, 30 seconds owned wall deadline per stage, 3 GiB address-space soft ceiling
-and 30 seconds CPU soft ceiling. Tighter inherited soft/hard limits are retained;
-hard limits are not raised. Complete oversized results fail explicitly. These
-process limits do not constitute a sandbox for caller-supplied engine code.
+and 30 seconds CPU soft ceiling. `REA_PWNTOOLS_MAX_INPUT_BYTES` raises the input
+bound alone, up to 1 GiB, and returns `provider_unavailable` when it is not a
+decimal integer in range; the reply, diagnostic and deadline bounds stay fixed, so a
+large core that outruns them still fails explicitly instead of partially. Tighter
+inherited soft/hard limits are retained; hard limits are not raised. Complete
+oversized results fail explicitly. These process limits do not constitute a sandbox
+for caller-supplied engine code.
Resource exit statuses need matching private failure-branch markers. Unmarked
launcher failures retain their actual status/output and unknown resource cause.
diff --git a/docs/specs/solidity/cbor-metadata/plan.md b/docs/specs/solidity/cbor-metadata/plan.md
new file mode 100644
index 000000000..04b601b66
--- /dev/null
+++ b/docs/specs/solidity/cbor-metadata/plan.md
@@ -0,0 +1,33 @@
+# Implementation plan
+
+1. Use cborg 6.1.3 (Apache-2.0) as a pinned format decoder, with a bounded
+ tokenizer at its owning adapter boundary. Decode maps as Map, preserve integer
+ precision and strictly validate emitted text bytes before conversion.
+2. Add the portable metadata-result schema in src/domain/evm/. Use exact byte
+ ranges into the already retained bytecode rather than copying an opaque CBOR
+ hex payload into every selected summary.
+3. Add src/evm/SolidityMetadata.ts to interpret the terminal length/root-map
+ candidate. Return unavailable, decoded, partial or not-decoded facts; keep
+ unsupported nested values explicit instead of recursively expanding them.
+4. Compute the facts in EvmoleInterfaceWorker from its selected bytes. The host
+ provider validates ranges/identity and projects the additive metadata field.
+ Preserve raw engine output without rewriting its unknown-precision metadata.
+5. Ensure the canonical EVM bytecode shape carries the optional field into complete
+ and summary Evidence. Include decoding profile, coverage and limitations.
+6. Add producer, worker, historical contract and public MCP boundary coverage.
+ Compile an owned Solidity fixture with a pinned caller-supplied solc module,
+ and verify its CBOR compiler version. Run relevant static/architecture checks.
+7. Extend the existing real Linux CLI/MCP verifier with independent metadata
+ assertions. Run the compiler-setting matrix in its CI lane and classify its
+ verifier as EVM-owned, with a production CI-planner regression.
+
+No new execution provider or target authority is introduced: a format parser is
+added inside the existing EVM worker. Linux x64 provider admission, target-free
+semantics, cleanup, limits and complete original Evidence remain unchanged.
+No metadata JSON or source URL is automatically acquired.
+
+The parser bounds nesting to 64 and token/collection growth to the selected
+terminal payload's byte count (the format's terminal length is at most 65535).
+Every data item consumes encoded bytes; broad declared collection lengths cannot
+justify allocation without that lower bound. Expanded results still pass the
+worker's existing 16 MiB output check.
diff --git a/docs/specs/solidity/cbor-metadata/spec.md b/docs/specs/solidity/cbor-metadata/spec.md
new file mode 100644
index 000000000..ea08dcc90
--- /dev/null
+++ b/docs/specs/solidity/cbor-metadata/spec.md
@@ -0,0 +1,43 @@
+# Solidity terminal metadata inspection
+
+Issue: https://github.com/morluto/rea/issues/2388
+
+## Outcome
+
+The existing EVM interface operation should retain independently decoded terminal
+CBOR candidate facts from the exact selected bytes instead of relying on precision
+unknowns in the engine's reported metadata. This increment covers trailer ranges,
+bounded decoding, exact integer/non-text scalar key evidence and compiler-version
+representations.
+
+## Requirements
+
+- Preserve the existing carrier/decoded identities and original full bytecode.
+- Report a plausible terminal root-map candidate separately from proof of Solidity
+ origin. Missing or non-map trailers remain unavailable, not proven absent.
+- Interpret scalar root-map keys/values losslessly: integers as decimal strings,
+ bytes as hex, strings, booleans and null. Preserve undecoded/unsupported values
+ through the original bytecode plus exact candidate offset/length.
+- Report partial and not-decoded coverage, parser/profile failures and unsupported
+ CBOR forms explicitly. Do not silently coerce unknown keys into object properties.
+- Interpret admitted solc release/prerelease representations only from observed
+ entries; preserve ambiguity if duplicate compiler-version keys occur.
+- Keep the additive field compatible with historical Evidence and retain
+ it through selected summary delivery and public CLI/MCP.
+ Historical omission parses as a null unknown facet without mutating the source.
+- Bound nesting before decoder recursion and collection lengths before allocation.
+ Keep parsing inside the existing owned worker and its resource/output budgets.
+- Do not fetch metadata or source content, contact RPC or execute contract code.
+
+## Acceptance and limits
+
+Owned compiler fixtures and malformed/synthetic trailers cover integers beyond
+Number precision, non-text keys, nested/uninterpreted values, invalid UTF-8,
+invalid lengths, unsupported tags and nesting bounds. Public boundary tests
+preserve the field and older omission. A real pinned solc artifact verifies actual
+metadata facts; the existing Linux-only EVM host profile remains unchanged.
+
+## Deferred issue criteria
+
+Binding a supplied metadata JSON to IPFS/Swarm commitments is a later independent
+increment of #2388. This PR must reference rather than close the whole issue.
diff --git a/docs/specs/solidity/cbor-metadata/tasks.md b/docs/specs/solidity/cbor-metadata/tasks.md
new file mode 100644
index 000000000..e80aefa01
--- /dev/null
+++ b/docs/specs/solidity/cbor-metadata/tasks.md
@@ -0,0 +1,8 @@
+# Tasks
+
+- [x] Define single-feature requirements and implementation plan before code.
+- [x] Add the pinned decoder and bounded owner boundary.
+- [x] Implement lossless scalar metadata facts and compiler-version evidence.
+- [x] Integrate worker/provider contracts and summary/historical compatibility.
+- [x] Verify producer, worker and public boundary behavior with owned fixtures.
+- [x] Run relevant repository checks and prepare a separately scoped PR.
diff --git a/docs/specs/solidity/cbor-metadata/verification.md b/docs/specs/solidity/cbor-metadata/verification.md
new file mode 100644
index 000000000..dae558d94
--- /dev/null
+++ b/docs/specs/solidity/cbor-metadata/verification.md
@@ -0,0 +1,43 @@
+# Verification
+
+After integrating upstream c462a4ebd, 47 tests passed
+across the parser, domain contract, application service, compiled worker and MCP
+boundary (five files). Compiled-worker goldens include BOM text, partial nested
+values, unavailable trailers, malformed UTF-8 and unsupported floats. Five
+upstream adapter tests also passed after its stricter integer validation landed.
+All six static tasks and architecture guards
+passed. After integration, test discovery found all 1004 files exactly once.
+The CI-planner selection passed all 85 tests, including the new EVM-verifier case.
+
+The parser regressions cover exact large integers and typed keys, malformed UTF-8,
+duplicate keys, excessive nesting, unsupported tags/floats, length bounds and
+historical omission. A real defect in the decoder's default text handling removed
+an initial U+FEFF. The owning tokenizer now validates and decodes the retained
+text bytes with BOM preservation; independent fixtures check both values and
+compiler-key identity.
+
+The owned fixture was compiled with caller-selected solc 0.8.30, using unoptimized,
+optimized via-IR, content-hash-free and CBOR-free settings. All four metadata
+checks passed again after integration. No contract was executed. Local first decode
+took approximately 0.81 ms or less. The originally reported approximately 2.92 ms
+for 100 warm iterations included equality assertions and is not a decode-only
+measurement. The verifier now measures parsing separately from those assertions;
+updated warm timings have not been collected. These historical figures describe
+these fixtures and this host, not a general workload.
+Peak process RSS
+included the compiler (299536 KiB); complete process-family CPU/memory and agent
+token costs were not measured.
+
+Compiled worker tests exercise unchanged EVMole WASM on this macOS host. MCP tests
+use the production server and contracts with an injected provider seam. The full
+Linux-only provider CLI/MCP, resource-limit and cleanup lane remains unverified
+here. Metadata JSON commitment binding remains deferred under issue #2388.
+
+The Linux CLI/MCP verifier asserts exact compiler bytes, declared version and
+candidate ranges for its existing owned raw/hex artifacts. Its CI lane additionally
+runs the new compiler-setting matrix. A regression using the actual CI planner
+checks that edits to the new verifier select the EVM lane.
+
+The later merge/review correction adds decoded-summary and omitted historical
+metadata coverage. Tests and provider reruns for that correction were skipped at
+the maintainer's request; the earlier runs above do not validate the changed head.
diff --git a/docs/testing.md b/docs/testing.md
index 1288a954a..7aa80d22a 100644
--- a/docs/testing.md
+++ b/docs/testing.md
@@ -682,7 +682,9 @@ use `--second-procedure rea_fixture_subtract --second-marker='- 13'`.
The lane invokes the production CLI dispatcher and connects the pinned MCP
client SDK to the production REA server. It verifies function Evidence and
CLI/MCP parity, inventory/search, pseudocode, instructions, xrefs, malformed
-input, original-input preservation, and lifecycle cleanup. For headless
+input, original-input preservation, and lifecycle cleanup. The headless
+profile also checks containing procedures, the admitted program as the
+document, address context, and feature tracing. For headless
analysis it confirms that the owned database IDs disappear from upstream
discovery and private workspaces are removed. For attached analysis it confirms
the existing GUI target remains reachable with the same input identity.
@@ -732,6 +734,16 @@ truncation constraint, while leading-zero coordinates still resolve correctly.
It has the same Ghidra/JDK prerequisites as the MZ lane. Neither lane claims DOS
runtime or PC-98 device execution.
+`npm run verify:ghidra:6502` uses `ca65` and `ld65` to build the source-owned
+NMOS 6502 fixture from `tests/conformance/ghidra/6502.s` and `6502.cfg`. Set
+`REA_CA65` and `REA_LD65` for non-PATH installations (tested with cc65 `V2.19`).
+With an installed Ghidra 12.1.4 and full JDK, it verifies real CLI/stdio MCP
+mapping parity, exact source bytes, functions, a direct call reference,
+decompilation, 16-bit overflow rejection without replacing the active session,
+and runtime cleanup. Windows additionally requires the matching native addon;
+its verifier lineage remains explicitly unavailable outside the provider's
+retained Job Object, as in the other Windows lanes.
+
`npm run verify:ghidra:raw` uses a generated ARM little-endian headerless image
through the compiled CLI and stdio MCP server. With the same Ghidra/JDK
prerequisites, it checks preparation and bridge startup, verified load mappings,
diff --git a/docs/windows-ghidra-p0.md b/docs/windows-ghidra-p0.md
index 9cd3bb6d8..5def0dae4 100644
--- a/docs/windows-ghidra-p0.md
+++ b/docs/windows-ghidra-p0.md
@@ -17,14 +17,16 @@ additional permission flag or degraded mode is required.
- Node.js 22.x (>=22.19), 24.x (>=24.11), or 26+;
- an operator-installed Ghidra 12.1.x distribution (verified with 12.1.4);
- a 64-bit full JDK inside that installation's declared Java range (JDK 21 or newer, with no maximum, for current 12.1 releases);
-- an explicit native, non-managed x86 or x86-64 PE application or DLL; and
+- an explicit native, non-managed x86 or x86-64 PE application/DLL, or a
+ [raw NMOS 6502 image](raw-binary.md#nmos-6502) with a caller-supplied entry; and
- the 25 read-only Ghidra inventory, memory, and function-analysis operations.
Loaded memory reads and file offsets preserve Ghidra's observed source mappings.
PE load-image inspection returns an explicit unsupported attestation status.
Independent verification covers admitted DOS MZ, explicit COM, and explicit
-[raw-binary imports](raw-binary.md) on their supported hosts. This does not
-extend Windows P0 admission beyond native PE. For x64 PE
+[raw-binary imports](raw-binary.md) on their supported hosts, including the
+admitted raw NMOS 6502 mapping on Windows. Windows P0 admission remains limited
+to native PE and raw NMOS 6502 images. For x64 PE
NativeAOT RTR 9.1, the read-only snapshot parser can report metadata through
`inspect_native_load_image` and `inspect_native_data_type` without a JAR or
database mutation. A real Windows-host NativeAOT Ghidra run is still required
@@ -35,6 +37,12 @@ state, annotations, other target architectures and formats, and Hopper-only
operations remain unavailable through this provider. Managed PE/CLI inspection
uses its separate execution-free provider.
+Raw 6502 imports retain the same native filesystem and process ownership
+requirements. The complete image must fit in the 16-bit address space; no
+console-specific cartridge loader, CPU variant, or bank-switching model is
+implied. Run `npm run verify:ghidra:6502` with caller-installed `ca65`/`ld65`
+to check the source-built fixture through real CLI and MCP workflows.
+
REA does not install or upgrade Ghidra, Java, Python, npm, Node.js, Hopper, or a
compiler. The adapter uses the packaged Java `HeadlessScript`; Python and
PyGhidra are not prerequisites. Users do not build the native addon.
diff --git a/experiments/analysis-efficiency/agent-trial.py b/experiments/analysis-efficiency/agent-trial.py
index 6dcc7d7f8..dc13e8781 100644
--- a/experiments/analysis-efficiency/agent-trial.py
+++ b/experiments/analysis-efficiency/agent-trial.py
@@ -94,6 +94,9 @@ def main():
if undeclared:
raise ValueError('Declare inherited provider settings explicitly in --providers: '
+ ', '.join(undeclared) + '. Values are not logged.')
+ source_auth_home = (Path(os.environ['CODEX_HOME']) if 'CODEX_HOME' in os.environ
+ else Path.home() / '.codex')
+ source_auth = source_auth_home / 'auth.json'
args.output.mkdir(parents=True, exist_ok=False, mode=0o700)
runtime_files, runtime_digest = runtime_fingerprint(repository)
(args.output / 'runtime-files.json').write_text(json.dumps(runtime_files))
@@ -103,7 +106,6 @@ def main():
workspace = profile / 'workspace'
for directory in [trial_codex_home, account, workspace]:
directory.mkdir(mode=0o700)
- source_auth = Path(os.environ.get('CODEX_HOME', str(Path.home() / '.codex'))) / 'auth.json'
auth = trial_codex_home / 'auth.json'
started = time.monotonic()
timeout = False
diff --git a/experiments/analysis-efficiency/test_codex_context.py b/experiments/analysis-efficiency/test_codex_context.py
index 37df83a7c..0b8e0247c 100644
--- a/experiments/analysis-efficiency/test_codex_context.py
+++ b/experiments/analysis-efficiency/test_codex_context.py
@@ -71,7 +71,9 @@ class ContextCaptureTests(unittest.TestCase):
self.assertNotIn(marker, text)
self.assertIn('caller-selected evidence and paths', text)
self.assertIn('original-response', text)
- self.assertEqual((output / 'codex-tool-context.jsonl').stat().st_mode & 0o777, 0o600)
+ # Windows mode bits do not describe access control; this is a POSIX assertion.
+ if os.name == 'posix':
+ self.assertEqual((output / 'codex-tool-context.jsonl').stat().st_mode & 0o777, 0o600)
def test_missing_rollouts_are_unknown_and_malformed_lines_remain_partial(self):
with tempfile.TemporaryDirectory() as directory:
@@ -124,6 +126,7 @@ class ContextCaptureTests(unittest.TestCase):
patch.object(agent.subprocess, 'check_output', return_value='v24.18.0\n'), \
patch.object(agent.subprocess, 'Popen', return_value=child), \
patch.object(agent, 'capture_tool_context', side_effect=OSError('fixture capture failure')), \
+ patch.object(agent.Path, 'home', side_effect=AssertionError('Explicit CODEX_HOME must not resolve the default home')), \
patch('builtins.print'):
with self.assertRaisesRegex(OSError, 'fixture capture failure'):
agent.main()
diff --git a/experiments/analysis-efficiency/windows-posix-reconciliation.md b/experiments/analysis-efficiency/windows-posix-reconciliation.md
new file mode 100644
index 000000000..0df06ac3e
--- /dev/null
+++ b/experiments/analysis-efficiency/windows-posix-reconciliation.md
@@ -0,0 +1,128 @@
+# Windows reconciliation of recorded POSIX paths
+
+Follow-up to [#2422](https://github.com/morluto/rea/pull/2422), including
+@Aurantium-47's diagnosis of the host-dependent relative-path operation.
+
+## Source pins and real data
+
+The initial reproduction and passive producer used main
+fa4b8288655188426222773ead2ccbdaf76334fd. Before branching, main was updated
+to 8b181716aca2cb467be499cba226abfb5ae19141. The owning matcher and its
+affected reconciliation consumers were unchanged between those revisions.
+The newer baseline again reproduced both errors on the real Windows host.
+
+Input: npm 11.16.0's published lib/utils/validate-lockfile.js, 1,023 bytes,
+SHA-256 2295e2dac1c5816e1eae2d417804960ebbef17b64a0a44db4f3483ce6e6d9526.
+The installed copy was independently checked against the exact module in the
+[official registry package](https://registry.npmjs.org/npm/11.16.0).
+The 2,945,850-byte tarball matched its published SHA-512 SRI before reading
+that member; no archive extraction or installation occurred, and the tarball
+was not retained.
+
+Two actual Linux filesystem directories, Runtime/App and Runtime/app,
+held byte-identical module copies and had distinct directory identities.
+A controlled Node 24.18.0 process loaded the public module and ran its real
+function against 587 locked dependency records: compatible trees returned zero
+errors, and one controlled version mismatch returned one error. A passive REA
+Inspector capture recorded 114 loaded scripts, including the selected module.
+The provider did not evaluate, pause, resume or read source. The owned process
+exited normally. Function execution is established by the harness receipt;
+REA's passive script metadata establishes loaded status.
+
+Production static analysis inspected both directories plus an independent
+Static/public-module copy. The latter prevents implicit root matching from
+hiding the explicit mapping result. Complete static/runtime Evidence was then
+consumed by the actual **Windows** CLI and SDK 2.3.1 stdio MCP server, using
+Windows 11 10.0.22631.0 and official Windows x64 Node 24.18.0.
+No Electron GUI, IDA or Ghidra engine was used.
+
+## Correctness and provenance
+
+| Windows reconciliation | Baseline | Candidate |
+| -------------------------------------- | ------------------------------ | ----------------------------------- |
+| Exact POSIX input root | Matched, artifact path | Same complete normalized result |
+| Case-mismatched POSIX input root | Incorrectly matched and loaded | Unknown; static load states unknown |
+| Exact explicit POSIX mapping | Matched, operator file mapping | Same complete normalized result |
+| Case-mismatched explicit POSIX mapping | Incorrectly matched and loaded | Unknown; static load states unknown |
+
+All four CLI and same-connection MCP normalized results agree. The input
+Evidence, recorded runtime facts and caller-selected root spellings are
+preserved. Rejected location membership does not establish that a module was
+absent or unexecuted. The operation remains offline and performs no target or
+filesystem inspection.
+
+The shared matcher now chooses posix.relative after identifying POSIX input;
+Windows coordinates continue to use win32.relative. Both location matching
+and active-layer scope use this owner. The obsolete host-default import is
+removed; no downstream repair or new path abstraction is introduced.
+
+The related suite passed 102 tests: 15 workflow tests, 85 CI scope tests and
+two curated-path checks. Four simulated Electron Evidence controls cover
+POSIX mismatch/exact matching, Windows case-insensitive matching, the resulting
+asset load state and retained mapping spelling. They are service regressions,
+not real Electron-provider verification. The existing workflow test file is
+registered in both the Windows execution lane and its package-change scope.
+
+## Delivery and resource observations
+
+Probes ran serially at BelowNormal priority with one CPU and 512 MiB Node heap
+settings for CLI/server/client work. Heap settings do not bound aggregate memory.
+Four corrected CLI exit-time observations reported 7.343–15.827 seconds CPU and
+322,308–324,280 KiB peak working set, excluding the probe parent. Wall times
+ranged from 7.785 to 17.601 seconds. There is no paired resource baseline.
+
+One complete MCP trial connected in 18,296 ms and discovered 189 tools in
+875 ms (2,588,336 serialized bytes). The four subsequent same-connection calls
+took 879, 320, 353 and 422 ms. Their serialized replies were 918,133 / 913,765 /
+918,571 / 914,171 bytes; inputs totalled 681,312 bytes. Discovery plus these
+inputs and replies totalled 6,934,288 bytes, excluding initialization, framing
+and notifications. This is delivery volume, not model token usage. Actual
+model context and total model task cost were not measured.
+
+A process-generation sampler recorded 233 observations over 25,671 ms:
+15,797 ms aggregate observed CPU as a lower bound and a peak sampled working-set
+sum of 491,597,824 bytes (about 469 MiB). Exited-process tails can be missed;
+shared pages can be counted twice. This excludes the observer and is not an
+exact physical-memory peak. The server wrote four structured completion records
+to stderr; tool replies and normalized results passed the recorded checks.
+
+Cold/warm caches and observer differences were not normalized. No latency,
+CPU, memory or model-token improvement is claimed. The fix adds no lookup I/O,
+engine invocation, retry or cache. Complete default replies remain available;
+only compact selected findings and hashes were sent to the investigating agent.
+
+## Main integration replay
+
+Runtime cb0d8a9fef2b907cff2ba27f1e017493e1173eb2, rebased onto main
+73dd8d6ed, again passed the 101 related tests and all four real Windows CLI/MCP
+cases using the unchanged older producer Evidence. Positive results and original
+runtime/layer facts remain identical. Typecheck, lint, dependency and metadata
+checks passed; all five changed files passed formatting independently.
+The full format gate at that main revision failed on the unchanged upstream
+GhidraDoctor.test.ts and GhidraSnapshotCache.test.ts files. The PR does not
+repair those unrelated baseline files. Resource figures above refer to the
+earlier candidate; the integration replay does not establish a speedup.
+
+Review found that owning only the Windows test path would still skip that lane
+on a later implementation-only edit. The matcher implementation is now also
+registered in package scope. A source-only classifier case verifies that it
+selects both Windows package and JavaScript recovery lanes; 85 scope checks and
+two curated-path checks pass. Runtime code and the real-data checks are unchanged.
+
+The original production fix merged as
+[1a1b67c88](https://github.com/morluto/rea/commit/1a1b67c88) while this follow-up
+was open. The follow-up was then rebased onto main fb28ec153 and contains only
+the stronger workflow assertions, Windows lane ownership, scope classification
+and this verification record. The updated 131 related tests, two representative
+Ghidra boundary tests, seven IDA input-thinning tests, 24 semantic-structure
+tests, 16 required-lane checks, 39 release-checkpoint tests and 11 dyld CLI
+tests passed after the rebase (230 total).
+Upstream a0317cf73 corrected the invalid FAT fixture and consolidated unrelated
+duplicated helpers; e05d3399f aligned the older parameter-provenance assertion
+with the upstream semantics. Those changes, the threshold change and the new
+CI qualification tiers are part of main, outside this follow-up's diff.
+Upstream 747e72991 restored release preflight coverage for reusable workflow
+jobs. The independently reviewed, fully green #2755 fixture correction merged
+as fb28ec153 and restored real x64 dyld CLI admission without altering the
+original same-named arm64e assertions.
+No production source is duplicated by the follow-up.
diff --git a/licenses/npm-dependencies.txt b/licenses/npm-dependencies.txt
index ce45f7459..05fc2f173 100644
--- a/licenses/npm-dependencies.txt
+++ b/licenses/npm-dependencies.txt
@@ -2,7 +2,7 @@ REA npm dependency inventory
Prepared from the root package-lock.json; refresh this inventory when locked dependencies change.
License identifiers are upstream lockfile declarations, not a legal assessment.
Runtime includes transitive and optional platform packages; development includes build, test and website tooling.
-Locked package entries: 586; runtime: 174.
+Locked package entries: 587; runtime: 175.
Full runtime copyright/license/NOTICE texts: npm-runtime-notices.txt.
@algolia/abtesting@1.25.0 | development | MIT
@@ -1430,6 +1430,11 @@ canonicalize@3.0.0 | runtime | Apache-2.0
Package: https://www.npmjs.com/package/canonicalize/v/3.0.0
Archive: https://registry.npmjs.org/canonicalize/-/canonicalize-3.0.0.tgz
Integrity: sha512-yYLfHyDMIXRyRqsKBRLX023riFLpXY2YOfdtqKXZRZy9qsfOJ9U+4F9YZL7MEzL5+ziN2x2nlBvY/Voi3EBljA==
+cborg@6.1.3 | runtime | Apache-2.0
+ Lockfile path: node_modules/cborg
+ Package: https://www.npmjs.com/package/cborg/v/6.1.3
+ Archive: https://registry.npmjs.org/cborg/-/cborg-6.1.3.tgz
+ Integrity: sha512-Kb/wD/AFuVcqvVjR+HYNOjNiuhVJ2C+RWxQE2Yqq2WVlVkRjdvVLkkM6QsL3NMsBRh+rgNc+aXmcraA+X0HObQ==
ccount@2.0.1 | development | MIT
Lockfile path: node_modules/ccount
Package: https://www.npmjs.com/package/ccount/v/2.0.1
diff --git a/licenses/npm-runtime-notices.txt b/licenses/npm-runtime-notices.txt
index d981aa68a..2a0c45d24 100644
--- a/licenses/npm-runtime-notices.txt
+++ b/licenses/npm-runtime-notices.txt
@@ -1,7 +1,7 @@
REA third-party npm runtime copyright, license and NOTICE texts
Collected from integrity-verified locked npm archives. Release-specific supplements and upstream notice gaps are identified in their entries.
External engines are separately obtained; see THIRD_PARTY_NOTICES.md.
-Runtime dependency fingerprint (SHA-256): 5de9cf97e7c327da1892efeff30b40507e4c7f8e496b5d305b8016c162bc15e3
+Runtime dependency fingerprint (SHA-256): 63d5b55e027a0cfb3e77989ca337aca905f1652d10cfbfc4d4dd876d3ecd4f3a
===== @babel/helper-string-parser@8.0.0 =====
Declared license: MIT
@@ -2456,6 +2456,234 @@ Scope: npm runtime dependency, including optional platform packages.
limitations under the License.
+===== cborg@6.1.3 =====
+Declared license: Apache-2.0
+Archive: https://registry.npmjs.org/cborg/-/cborg-6.1.3.tgz
+Integrity: sha512-Kb/wD/AFuVcqvVjR+HYNOjNiuhVJ2C+RWxQE2Yqq2WVlVkRjdvVLkkM6QsL3NMsBRh+rgNc+aXmcraA+X0HObQ==
+Scope: npm runtime dependency, including optional platform packages.
+
+--- package/LICENSE ---
+
+Copyright 2020 Rod Vagg
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+--- Apache-2.0 full license (licenses/Apache-2.0.txt) ---
+
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+
===== clean-git-ref@2.0.1 =====
Declared license: Apache-2.0
Archive: https://registry.npmjs.org/clean-git-ref/-/clean-git-ref-2.0.1.tgz
diff --git a/native/windows/README.md b/native/windows/README.md
index e2543260f..86103ce9a 100644
--- a/native/windows/README.md
+++ b/native/windows/README.md
@@ -90,8 +90,10 @@ without this lane reports Windows native controls as unavailable.
root and ancestor leases for retry; a partially removed runtime accepts only
cleanup, and its registry entry remains until removal succeeds. Normal close, cancellation,
startup failure, and timeout release provider resources. Abrupt owner death
- kills the owned job; it can leave private runtime files for later operator
- cleanup and does not claim transactional deletion after a crash.
+ kills the owned job. The Android provider additionally uses a detached helper
+ that owns its private runtime directory and cleans it when the owner pipe
+ closes. Other providers can leave private runtime files after owner death;
+ helper death and host power loss are not transactional deletion.
Windows failures retain their constraint, requested coordinate, Win32 code,
and system message. Unsupported filesystems and reparse paths are distinct
@@ -115,8 +117,10 @@ the supported device/UNC namespaces; existing admission checks still apply.
The bearer-token descriptor remains under its immutable private lease until
`runtime_close` on Windows; POSIX removes the descriptor after the bridge reads
-it. Job ownership guarantees process termination on owner death, not deletion
-of private files after a crash. SUBST drive aliases and changing DOS-device
+it. Job ownership guarantees process termination on owner death. Android's
+detached workspace helper provides a separate cleanup owner for that provider,
+but simultaneous helper death or power loss can still leave private files.
+SUBST drive aliases and changing DOS-device
namespaces are outside the verified P0 scope and are not detected as a separate
alias policy. Mounted-folder paths that report a reparse tag are rejected by
component admission; broader namespace variants remain unverified. Preserve
@@ -163,9 +167,14 @@ V8 heap flags cannot bound (limit notification, peak commit at the limit, all
members settled, with the notification present in the first native exit report
and the wrapper's exit event), and a control under the same limit that
completes normally.
-An optional independently built
-`tests/fixtures/windows/processBoundary.cc` executable adds breakaway and
-caller/child token observations and an in-place ancestor reparse attempt:
+A separately built `tests/fixtures/windows/processBoundary.cc` executable adds
+breakaway, caller/child token and environment semantics observations and an
+in-place ancestor reparse attempt. The lane skips all of them when the
+executable is absent, so both Windows workflows cross-build it in the same
+MinGW job that builds their artifact and pass it: the capability and package
+lane in `.github/workflows/ci.yml`, and the real Ghidra proof run in
+`.github/workflows/real-ghidra-windows.yml`. Build it locally with any Windows
+C++ compiler, or the same way they do, and pass its path:
```powershell
node scripts/verify-windows-native.mjs . C:\fixtures\process-boundary.exe
diff --git a/native/windows/src/filesystem.cc b/native/windows/src/filesystem.cc
index c8f66e5c1..71c8bbd44 100644
--- a/native/windows/src/filesystem.cc
+++ b/native/windows/src/filesystem.cc
@@ -1,6 +1,7 @@
#include "authority.hpp"
#include
#include
+#include
namespace rea {
@@ -165,7 +166,9 @@ static Handle createRelative(HANDLE parent, const std::wstring& name, DWORD acce
IO_STATUS_BLOCK observation{};
HANDLE raw = INVALID_HANDLE_VALUE;
const auto status = NtCreateFile(&raw, access | SYNCHRONIZE, &attributes, &observation, nullptr,
- FILE_ATTRIBUTE_NORMAL, FILE_SHARE_READ, FILE_CREATE,
+ FILE_ATTRIBUTE_NORMAL,
+ directory ? FILE_SHARE_READ | FILE_SHARE_DELETE : FILE_SHARE_READ,
+ FILE_CREATE,
FILE_SYNCHRONOUS_IO_NONALERT | FILE_OPEN_REPARSE_POINT |
(directory ? FILE_DIRECTORY_FILE : FILE_NON_DIRECTORY_FILE), nullptr, 0);
if (status < 0) throw Failure("Create private object relative to its admitted parent failed", path,
@@ -176,6 +179,30 @@ static Handle createRelative(HANDLE parent, const std::wstring& name, DWORD acce
return result;
}
+// Lookup relative to an already-owned directory; path is diagnostic only.
+static Handle openRelative(HANDLE parent, const std::wstring& name, DWORD access,
+ DWORD sharing, ULONG kind, const std::wstring& path) {
+ require(!name.empty() && name.find_first_of(L"\\/:\"<>|?*") == std::wstring::npos && name.size() < 32768,
+ "Private lookup requires one filename component", path, ERROR_INVALID_PARAMETER);
+ UNICODE_STRING coordinate{};
+ coordinate.Buffer = const_cast(name.data());
+ coordinate.Length = static_cast(name.size() * sizeof(wchar_t));
+ coordinate.MaximumLength = coordinate.Length;
+ OBJECT_ATTRIBUTES attributes;
+ InitializeObjectAttributes(&attributes, &coordinate, OBJ_CASE_INSENSITIVE, parent, nullptr);
+ IO_STATUS_BLOCK observation{};
+ HANDLE raw = INVALID_HANDLE_VALUE;
+ const auto status = NtCreateFile(&raw, access | SYNCHRONIZE, &attributes, &observation,
+ nullptr, FILE_ATTRIBUTE_NORMAL, sharing, FILE_OPEN,
+ FILE_SYNCHRONOUS_IO_NONALERT | FILE_OPEN_REPARSE_POINT | kind, nullptr, 0);
+ if (status < 0)
+ throw Failure("Open private object relative to its directory handle failed", path,
+ RtlNtStatusToDosError(status));
+ Handle result(raw);
+ require(result.valid(), "Private lookup returned an invalid handle", path);
+ return result;
+}
+
static void verifyPrivate(HANDLE handle, const std::wstring& path, bool root) {
Security expected;
PSID owner = nullptr;
@@ -258,7 +285,16 @@ static std::unique_ptr runtimeDirectory(Runtime& root, const std::wstring&
size_t offset = root.path.size() + 1;
while (offset < path.size()) {
const auto end = path.find(L'\\', offset);
- result->handles.push_back(openComponent(path.substr(0, end), 0, true));
+ const auto name = path.substr(offset, end == std::wstring::npos ? end : end - offset);
+ auto child = openRelative(result->get(), name,
+ FILE_LIST_DIRECTORY | FILE_READ_ATTRIBUTES | READ_CONTROL,
+ FILE_SHARE_READ, FILE_DIRECTORY_FILE, path.substr(0, end));
+ FILE_ATTRIBUTE_TAG_INFO info{};
+ require(GetFileInformationByHandleEx(child.get(), FileAttributeTagInfo, &info, sizeof(info)),
+ "Read private directory tag failed", path);
+ require((info.FileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) == 0,
+ "Reparse private directory is unsupported", path, ERROR_NOT_SUPPORTED);
+ result->handles.push_back(std::move(child));
if (end == std::wstring::npos) break;
offset = end + 1;
}
@@ -320,7 +356,9 @@ static void disposeSnapshot(Runtime& root, Handle& file, const std::wstring& pat
require(GetFileInformationByHandleEx(file.get(), FileIdInfo, &expected, sizeof(expected)),
"Read incomplete snapshot identity failed", path);
file.reset();
- auto cleanup = openComponent(path, DELETE | GENERIC_READ | FILE_WRITE_ATTRIBUTES, false);
+ auto cleanup = openRelative(parent->get(), path.substr(path.find_last_of(L'\\') + 1),
+ DELETE | GENERIC_READ | FILE_WRITE_ATTRIBUTES,
+ FILE_SHARE_READ, FILE_NON_DIRECTORY_FILE, path);
FILE_ID_INFO observed{};
require(GetFileInformationByHandleEx(cleanup.get(), FileIdInfo, &observed, sizeof(observed)),
"Read snapshot cleanup identity failed", path);
@@ -339,21 +377,51 @@ void closeRuntime(Runtime& root) {
// cleanup. POSIX removes its consumed descriptor earlier. Abrupt owner death
// closes process jobs but cannot run this walk, so private files can remain.
root.immutableFiles.clear();
- // Each traversed directory stays locked against replacement. Reparse entries
- // are unlinked as objects; their targets are never enumerated or deleted.
+ // Enumerate and open children through the retained directory handles. Paths
+ // below are diagnostic labels only: renames and ancestor junction replacement
+ // cannot redirect cleanup into an unrelated tree.
struct Frame {
Handle directory;
- HANDLE search = INVALID_HANDLE_VALUE;
std::wstring path;
- WIN32_FIND_DATAW next{};
- bool pending = false;
- Frame(Handle handle, std::wstring path) : directory(std::move(handle)), path(std::move(path)) {
- search = FindFirstFileExW((L"\\\\?\\" + this->path + L"\\*").c_str(), FindExInfoBasic, &next,
- FindExSearchNameMatch, nullptr, 0);
- pending = search != INVALID_HANDLE_VALUE;
- require(pending || GetLastError() == ERROR_FILE_NOT_FOUND, "Enumerate runtime cleanup failed", this->path);
+ // One NTFS component is at most 255 UTF-16 units; 1 KiB fits a record
+ // without retaining a large batch at every directory depth.
+ alignas(FILE_ID_BOTH_DIR_INFO) std::array entries{};
+ size_t offset = 0;
+ bool buffered = false;
+ bool restart = true;
+ Frame(Handle handle, std::wstring path) : directory(std::move(handle)), path(std::move(path)) {}
+ bool next(std::wstring& name) {
+ for (;;) {
+ if (!buffered) {
+ const auto kind = restart ? FileIdBothDirectoryRestartInfo : FileIdBothDirectoryInfo;
+ restart = false;
+ if (!GetFileInformationByHandleEx(directory.get(), kind, entries.data(),
+ static_cast(entries.size()))) {
+ const auto code = GetLastError();
+ if (code == ERROR_NO_MORE_FILES) return false;
+ throw Failure("Enumerate runtime cleanup by handle failed", path, code);
+ }
+ offset = 0;
+ buffered = true;
+ }
+ require(offset <= entries.size() - offsetof(FILE_ID_BOTH_DIR_INFO, FileName),
+ "Cleanup directory record is truncated", path, ERROR_INVALID_DATA);
+ const auto* entry = reinterpret_cast(entries.data() + offset);
+ require(entry->FileNameLength % sizeof(wchar_t) == 0 &&
+ entry->FileNameLength <= entries.size() - offset - offsetof(FILE_ID_BOTH_DIR_INFO, FileName),
+ "Cleanup directory filename is truncated", path, ERROR_INVALID_DATA);
+ name.assign(entry->FileName, entry->FileNameLength / sizeof(wchar_t));
+ if (entry->NextEntryOffset == 0) buffered = false;
+ else {
+ require(entry->NextEntryOffset % alignof(FILE_ID_BOTH_DIR_INFO) == 0 &&
+ entry->NextEntryOffset >= offsetof(FILE_ID_BOTH_DIR_INFO, FileName) + entry->FileNameLength &&
+ entry->NextEntryOffset <= entries.size() - offset - offsetof(FILE_ID_BOTH_DIR_INFO, FileName),
+ "Cleanup directory record offset is invalid", path, ERROR_INVALID_DATA);
+ offset += entry->NextEntryOffset;
+ }
+ if (name != L"." && name != L"..") return true;
+ }
}
- ~Frame() { if (search != INVALID_HANDLE_VALUE) FindClose(search); }
};
std::vector> frames;
HANDLE duplicate;
@@ -362,21 +430,16 @@ void closeRuntime(Runtime& root) {
frames.push_back(std::make_unique(Handle(duplicate), root.path));
while (!frames.empty()) {
auto& frame = *frames.back();
- if (!frame.pending) {
- if (frame.search != INVALID_HANDLE_VALUE) { FindClose(frame.search); frame.search = INVALID_HANDLE_VALUE; }
+ std::wstring name;
+ if (!frame.next(name)) {
dispose(frame.directory.get(), frame.path);
frames.pop_back();
continue;
}
- const auto name = std::wstring(frame.next.cFileName);
- frame.pending = FindNextFileW(frame.search, &frame.next) != FALSE;
- require(frame.pending || GetLastError() == ERROR_NO_MORE_FILES, "Continue runtime cleanup enumeration failed", frame.path);
- if (name == L"." || name == L"..") continue;
const auto path = frame.path + L"\\" + name;
- Handle child(CreateFileW((L"\\\\?\\" + path).c_str(), DELETE | GENERIC_READ | FILE_WRITE_ATTRIBUTES,
- FILE_SHARE_READ, nullptr, OPEN_EXISTING,
- FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS, nullptr));
- require(child.valid(), "Open owned cleanup object failed", path);
+ auto child = openRelative(frame.directory.get(), name,
+ DELETE | FILE_LIST_DIRECTORY | FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES,
+ FILE_SHARE_READ | FILE_SHARE_DELETE, 0, path);
FILE_ATTRIBUTE_TAG_INFO info{};
require(GetFileInformationByHandleEx(child.get(), FileAttributeTagInfo, &info, sizeof(info)), "Read cleanup object tag failed", path);
if ((info.FileAttributes & FILE_ATTRIBUTE_DIRECTORY) != 0 && (info.FileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) == 0)
@@ -551,9 +614,16 @@ napi_value filesystemCall(napi_env env, const std::wstring& operation, const std
// must share both to pass Windows' symmetric share check. Those retained
// handles still omit FILE_SHARE_WRITE and FILE_SHARE_DELETE, blocking
// competing writes and delete opens.
- file->handles.push_back(openComponent(path, GENERIC_READ, false,
- FILE_SHARE_READ | FILE_SHARE_WRITE |
- FILE_SHARE_DELETE));
+ auto child = openRelative(file->get(), path.substr(path.find_last_of(L'\\') + 1),
+ GENERIC_READ | FILE_READ_ATTRIBUTES | READ_CONTROL,
+ FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
+ FILE_NON_DIRECTORY_FILE, path);
+ FILE_ATTRIBUTE_TAG_INFO info{};
+ require(GetFileInformationByHandleEx(child.get(), FileAttributeTagInfo, &info, sizeof(info)),
+ "Read private file tag failed", path);
+ require((info.FileAttributes & FILE_ATTRIBUTE_REPARSE_POINT) == 0,
+ "Reparse private file is unsupported", path, ERROR_NOT_SUPPORTED);
+ file->handles.push_back(std::move(child));
verifyPrivate(file->get(), path, false);
auto result = identity(env, file->get(), path);
set(env, result, "handle", wrap(env, std::move(file)));
diff --git a/package-lock.json b/package-lock.json
index 5af71e98e..7eae3799e 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -24,6 +24,7 @@
"ajv": "8.20.0",
"ajv-formats": "3.0.1",
"canonicalize": "3.0.0",
+ "cborg": "6.1.3",
"cross-spawn": "7.0.6",
"diff": "9.0.0",
"evmole": "0.9.3",
@@ -4181,6 +4182,15 @@
"node": ">=18"
}
},
+ "node_modules/cborg": {
+ "version": "6.1.3",
+ "resolved": "https://registry.npmjs.org/cborg/-/cborg-6.1.3.tgz",
+ "integrity": "sha512-Kb/wD/AFuVcqvVjR+HYNOjNiuhVJ2C+RWxQE2Yqq2WVlVkRjdvVLkkM6QsL3NMsBRh+rgNc+aXmcraA+X0HObQ==",
+ "license": "Apache-2.0",
+ "bin": {
+ "cborg": "lib/bin.js"
+ }
+ },
"node_modules/ccount": {
"version": "2.0.1",
"resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz",
diff --git a/package.json b/package.json
index b2e2a51d3..70ab60d1e 100644
--- a/package.json
+++ b/package.json
@@ -62,6 +62,7 @@
"bridge/android/ReaJadxBridge.java",
"bridge/mitmproxy/capture.py",
"scripts/rea.mjs",
+ "scripts/rea-android-workspace-guardian.mjs",
"scripts/electron-active-hook.cjs",
"scripts/electron-active-hook-boundaries.cjs",
"scripts/hopper-demo-x11.py",
@@ -174,6 +175,7 @@
"verify:ghidra:seeds": "npm run build:cached && node scripts/verify/ghidra/seeds.mjs",
"verify:ghidra:mips": "npm run build:cached && node scripts/verify-real-ghidra-mips.mjs",
"verify:ghidra:riscv": "npm run build:cached && node scripts/verify-real-ghidra-riscv.mjs",
+ "verify:ghidra:6502": "npm run build:cached && node scripts/verify-real-ghidra-6502.mjs",
"verify:ghidra:mips-shared": "npm run build:cached && node scripts/verify-real-ghidra-mips-shared.mjs",
"verify:ghidra:mips-relocatable": "npm run build:cached && node scripts/verify-real-ghidra-mips-relocatable.mjs",
"verify:ghidra:swift": "npm run build:cached && node scripts/verify-real-ghidra-swift.mjs",
@@ -269,6 +271,7 @@
"verify:wasm:package": "npm run build:cached && node scripts/verify-packaged-wasm-artifact.mjs",
"verify:wasm:artifact": "npm run build:cached && node scripts/verify-wasm-artifact.mjs",
"verify:evm:interface": "npm run build:cached && node scripts/verify-evm-interface.mjs",
+ "verify:solidity:metadata": "npm run build:cached && node scripts/verify-solidity-metadata.mjs",
"verify:recorded:crash": "npm run build:cached && node scripts/verify-recorded-crash.mjs",
"mcp-catalog:check:built": "node scripts/generate-mcp-tool-catalog.mjs --check",
"compile": "node scripts/clean-build-output.mjs && tsc -p tsconfig.build.json && node scripts/bundle-runtime.mjs",
@@ -308,6 +311,7 @@
"ajv": "8.20.0",
"ajv-formats": "3.0.1",
"canonicalize": "3.0.0",
+ "cborg": "6.1.3",
"cross-spawn": "7.0.6",
"diff": "9.0.0",
"evmole": "0.9.3",
diff --git a/scripts/ci/scopes.mjs b/scripts/ci/scopes.mjs
index a8679726c..a4f0f0fac 100644
--- a/scripts/ci/scopes.mjs
+++ b/scripts/ci/scopes.mjs
@@ -55,7 +55,12 @@ export const SCOPES = {
"tests/boundary/providers/native/artifactProvider.extractionCompleteness.test.ts",
"tests/boundary/filesystem/setupUnavailableProvider.test.ts",
"tests/boundary/filesystem/windowsNpxRegistration.test.ts",
+ "tests/boundary/android/workspaceGuardianRetry.test.ts",
+ "src/android/JadxWorkspaceRoot.ts",
+ "scripts/rea-android-workspace-guardian.mjs",
"tests/acceptance/setup/homeDirectoryFallback.test.ts",
+ "tests/boundary/filesystem/javascriptApplicationWorkflows.test.ts",
+ "src/domain/javascript/javascriptRuntimeStaticCandidates.ts",
"tests/boundary/filesystem/webScriptManifestPaths.test.ts",
"tests/boundary/process/ProcessEvidence.host.test.ts",
"tests/acceptance/webModuleCli.test.ts",
@@ -216,6 +221,7 @@ export const SCOPES = {
"src/artifacts/readStableArtifact*.ts",
"src/artifacts/ArtifactReader.ts",
"scripts/verify-evm-interface.mjs",
+ "scripts/verify-solidity-metadata.mjs",
"scripts/fixtures/evm-interface.sol",
"third_party/evmole/**",
],
@@ -357,6 +363,7 @@ export const SCOPES = {
"website/**",
"scripts/*website*.py",
"README*.md",
+ "docs/readme/README*.md",
".github/workflows/website-check.yml",
".github/workflows/website-pages.yml",
],
diff --git a/scripts/lib/browser-runtime-fixture-lifecycle.mjs b/scripts/lib/browser-runtime-fixture-lifecycle.mjs
index d39617f58..88a76e573 100644
--- a/scripts/lib/browser-runtime-fixture-lifecycle.mjs
+++ b/scripts/lib/browser-runtime-fixture-lifecycle.mjs
@@ -8,7 +8,10 @@ import { spawnOwnedProviderProcess } from "../../dist/process/ProviderProcess.js
import { createSystemProcessOwnershipHost } from "../../dist/process/ProcessOwnershipObservation.js";
import { liveProcesses } from "../../dist/process/ProcessOwnershipProcessTree.js";
import { CdpConnection } from "../../dist/browser/CdpConnection.js";
-import { waitForBrowserDevtoolsPort } from "../../dist/browser/BrowserProcessStartup.js";
+import {
+ BROWSER_DEVTOOLS_STARTUP_TIMEOUT_MS,
+ waitForBrowserDevtoolsPort,
+} from "../../dist/browser/BrowserProcessStartup.js";
/** Launch the synthetic fixture browser and await CDP in its own verified process group. */
export async function startRuntimeFixtureBrowser(executable, origin) {
@@ -50,7 +53,7 @@ export async function startRuntimeFixtureBrowser(executable, origin) {
stderr: () => stderr,
// Match the broader real-browser verifier's allowance for cold Chrome
// startup on shared runners; early process failures still reject at once.
- timeoutMs: 60_000,
+ timeoutMs: BROWSER_DEVTOOLS_STARTUP_TIMEOUT_MS,
});
return {
port,
diff --git a/scripts/lib/docs-facts.mjs b/scripts/lib/docs-facts.mjs
index 26d9a4ac3..dda249aaa 100644
--- a/scripts/lib/docs-facts.mjs
+++ b/scripts/lib/docs-facts.mjs
@@ -1,13 +1,41 @@
import { readFile, readdir, stat } from "node:fs/promises";
import { dirname, isAbsolute, join, relative, resolve, sep } from "node:path";
-const readmeLinkTargets = (content, language = "en") =>
- [...content.matchAll(/\]\(([^)\s]+)\)/gu)]
- .map((match) => match[1] ?? "")
+const repoRelative = (root, from, target) => {
+ const index = target.search(/[#?]/u);
+ const pathPart = index === -1 ? target : target.slice(0, index);
+ const suffix = index === -1 ? "" : target.slice(index);
+ if (pathPart.length === 0 || /^[a-z][a-z0-9+.-]*:/iu.test(pathPart))
+ return target;
+ const absolute = resolve(root, dirname(from), pathPart);
+ const withinRepo = relative(root, absolute);
+ if (
+ withinRepo === ".." ||
+ withinRepo.startsWith(`..${sep}`) ||
+ isAbsolute(withinRepo)
+ )
+ return target;
+ return `${withinRepo.split(sep).join("/")}${suffix}`;
+};
+
+const isLanguageNavigation = (target) => {
+ const path = target.split(/[#?]/u)[0];
+ return (
+ path === "README.md" ||
+ /^docs\/readme\/README_[A-Za-z0-9-]+\.md$/u.test(path)
+ );
+};
+
+const readmeDestinations = (content) => [
+ ...content.matchAll(/\]\(([^)\s]+)\)/gu),
+ ...content.matchAll(/\b(?:src|href)="([^"]+)"/gu),
+];
+
+const readmeLinkTargets = (root, from, content, language = "en") =>
+ readmeDestinations(content)
+ .map((match) => repoRelative(root, from, match[1] ?? ""))
.filter(
- (target) =>
- !target.startsWith("#") &&
- !/^README(?:_[A-Za-z0-9-]+)?\.md$/u.test(target),
+ (target) => !target.startsWith("#") && !isLanguageNavigation(target),
)
.map((target) => {
if (language === "en" || !URL.canParse(target)) return target;
@@ -70,9 +98,19 @@ export const documentationFactIssues = async (root, catalog) => {
const issues = await skillReferenceIssues(
join(root, "skills/reverse-engineer-anything"),
);
- const readmePaths = (await readdir(root))
- .filter((path) => /^README(?:_[A-Za-z0-9-]+)?\.md$/u.test(path))
- .sort();
+ const translatedFolder = join(root, "docs/readme");
+ let translatedNames = [];
+ try {
+ translatedNames = await readdir(translatedFolder);
+ } catch (cause) {
+ if (cause?.code !== "ENOENT") throw cause;
+ }
+ const readmePaths = [
+ "README.md",
+ ...translatedNames
+ .filter((name) => /^README_[A-Za-z0-9-]+\.md$/u.test(name))
+ .map((name) => `docs/readme/${name}`),
+ ].sort();
const readmes = new Map();
for (const path of readmePaths) {
const content = await readFile(join(root, path), "utf8");
@@ -94,7 +132,11 @@ export const documentationFactIssues = async (root, catalog) => {
);
}
}
- const canonicalLinks = readmeLinkTargets(readmes.get("README.md") ?? "");
+ const canonicalLinks = readmeLinkTargets(
+ root,
+ "README.md",
+ readmes.get("README.md") ?? "",
+ );
const languageInventory = JSON.parse(
await readFile(join(root, "website/locales/languages.json"), "utf8"),
);
@@ -104,7 +146,12 @@ export const documentationFactIssues = async (root, catalog) => {
for (const path of readmePaths.filter((path) => path !== "README.md"))
if (
JSON.stringify(
- readmeLinkTargets(readmes.get(path) ?? "", readmeLanguages.get(path)),
+ readmeLinkTargets(
+ root,
+ path,
+ readmes.get(path) ?? "",
+ readmeLanguages.get(path),
+ ),
) !== JSON.stringify(canonicalLinks)
)
issues.push(`${path}: documentation links differ from README.md`);
diff --git a/scripts/lib/ida-feature-trace.d.mts b/scripts/lib/ida-feature-trace.d.mts
new file mode 100644
index 000000000..13c84df27
--- /dev/null
+++ b/scripts/lib/ida-feature-trace.d.mts
@@ -0,0 +1,9 @@
+export function assertFeatureTrace(
+ trace: unknown,
+ procedure: { readonly address: string },
+): void;
+
+export function findMappedNonFunction(
+ strings: readonly { readonly address: string }[],
+ resolveAt: (address: string) => Promise,
+): Promise;
diff --git a/scripts/lib/ida-feature-trace.mjs b/scripts/lib/ida-feature-trace.mjs
new file mode 100644
index 000000000..3c4778d25
--- /dev/null
+++ b/scripts/lib/ida-feature-trace.mjs
@@ -0,0 +1,52 @@
+import assert from "node:assert/strict";
+
+const NEGATIVE_REASONS = new Set(["not_in_procedure", "outside_segments"]);
+
+/**
+ * Assert the `trace_feature` result of the real IDA lane for one selected
+ * procedure. The query is a substring search, so the trace may also match other
+ * procedures and strings; each reference is checked against its own matched
+ * target, and a source outside every function (a data reference) is valid.
+ */
+export function assertFeatureTrace(trace, procedure) {
+ assert.ok(
+ trace.matches.some(
+ ({ type, address }) =>
+ type === "procedure" && address === procedure.address,
+ ),
+ "The trace omitted the selected procedure's match.",
+ );
+ assert.equal(typeof trace.truncated, "boolean");
+ const matched = new Set(trace.matches.map(({ address }) => address));
+ for (const reference of trace.references) {
+ assert.ok(
+ matched.has(reference.target_address),
+ `A reference targets ${reference.target_address}, which is not a match.`,
+ );
+ const { containing_procedure: containing } = reference;
+ if (containing.found)
+ assert.equal(typeof containing.procedure.address, "string");
+ else assert.ok(NEGATIVE_REASONS.has(containing.reason));
+ }
+}
+
+/**
+ * Find a string that IDA maps outside every function. A string inside a
+ * function chunk (inline data in code) is valid and skipped, so the strings are
+ * tried in order. Any other answer must be "not in a procedure": IDA lists only
+ * mapped strings, so an unmapped answer is a containment defect and fails the
+ * lane. Returns the address, or undefined when every string is inside a function.
+ */
+export async function findMappedNonFunction(strings, resolveAt) {
+ for (const { address } of strings) {
+ const resolved = await resolveAt(address);
+ if (resolved.found) continue;
+ assert.equal(
+ resolved.reason,
+ "not_in_procedure",
+ `The listed string at ${address} resolved as ${resolved.reason}.`,
+ );
+ return address;
+ }
+ return undefined;
+}
diff --git a/scripts/rea-android-workspace-guardian.mjs b/scripts/rea-android-workspace-guardian.mjs
new file mode 100644
index 000000000..93ba42d2d
--- /dev/null
+++ b/scripts/rea-android-workspace-guardian.mjs
@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+import { setTimeout as delay } from "node:timers/promises";
+import { WindowsPrivateRuntime } from "../dist/windows/WindowsPrivateRuntime.js";
+
+if (process.platform !== "win32" || process.argv.length !== 3)
+ throw new Error(
+ "Android workspace guardian requires Windows and one parent directory",
+ );
+
+// This process owns the native directory handle. Detached process creation
+// keeps it alive when the REA owner is terminated without running JS cleanup.
+const runtime = WindowsPrivateRuntime.create(process.argv[2], "rea-android-");
+const ready = await new Promise((resolve) => {
+ process.stdout.once("error", () => resolve(false));
+ process.stdout.write(
+ JSON.stringify({
+ path: runtime.observation.path,
+ volumeSerial: runtime.observation.volumeSerial,
+ fileId: runtime.observation.fileId,
+ privateDacl: runtime.observation.privateDacl,
+ }) + "\n",
+ (error) => resolve(error == null),
+ );
+});
+
+// The owner holds the write end until close/death. A failed readiness pipe
+// also grants cleanup authority, including owner death during startup.
+if (ready) {
+ for await (const _ of process.stdin) {
+ // No commands are accepted; only EOF grants cleanup authority.
+ }
+} else {
+ process.stdin.destroy();
+}
+
+// A failed native walk retains the directory identity lease for a later retry.
+// Keep this process alive so a transient sharing violation cannot orphan it.
+for (;;) {
+ try {
+ await runtime.close();
+ process.exit(0);
+ } catch {
+ await delay(1000);
+ }
+}
diff --git a/scripts/test-website.py b/scripts/test-website.py
index 5c1aef876..ba87c9f15 100644
--- a/scripts/test-website.py
+++ b/scripts/test-website.py
@@ -261,7 +261,9 @@ class WebsiteTranslationChecks(unittest.TestCase):
inventory = [item for item in languages(ROOT) if item["code"] in {"en", "zh-CN", "ar"}]
(root / "website/locales/languages.json").write_text(json.dumps(inventory))
for item in inventory:
- (root / item["readme"]).write_text("# REA\n")
+ destination = root / item["readme"]
+ destination.parent.mkdir(parents=True, exist_ok=True)
+ destination.write_text("# REA\n")
WEBSITE.sync_pages(root)
extract_catalogs(root)
yield root
diff --git a/scripts/verify-evm-interface.mjs b/scripts/verify-evm-interface.mjs
index b0bfdafa4..4bacc4bdf 100644
--- a/scripts/verify-evm-interface.mjs
+++ b/scripts/verify-evm-interface.mjs
@@ -225,6 +225,26 @@ try {
for (const mode of ["cli", "mcp"]) {
const report = await inspect(mode, path, encoding);
assert.equal(report.bytecode.hex, hex);
+ assert.equal(report.bytecode.metadata.status, "decoded");
+ assert.deepEqual(report.bytecode.metadata.compiler_version, {
+ representation: "release-bytes",
+ value: "0.8.30",
+ });
+ assert.equal(
+ report.bytecode.metadata.bytecode_offset +
+ report.bytecode.metadata.cbor_bytes +
+ 2,
+ Buffer.from(hex, "hex").length,
+ );
+ assert.ok(
+ report.bytecode.metadata.entries.some(
+ ({ key, value }) =>
+ key.kind === "text" &&
+ key.value === "solc" &&
+ value.kind === "bytes" &&
+ value.value === "00081e",
+ ),
+ );
assert.deepEqual(
report.functions
.filter(({ dispatch }) => dispatch === "abi")
diff --git a/scripts/verify-flutter.mjs b/scripts/verify-flutter.mjs
index 061ad8b20..76b5a1fda 100644
--- a/scripts/verify-flutter.mjs
+++ b/scripts/verify-flutter.mjs
@@ -1,12 +1,12 @@
import assert from "node:assert/strict";
import { execFile } from "node:child_process";
-import { readdir, readFile } from "node:fs/promises";
-import { resolve } from "node:path";
+import { mkdtemp, readdir, readFile, rm } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { join, resolve } from "node:path";
import { promisify } from "node:util";
import { Client } from "@modelcontextprotocol/client";
import { StdioClientTransport } from "@modelcontextprotocol/client/stdio";
import { toolContract } from "../dist/contracts/toolContracts.js";
-import { PrivateRuntimeRoot } from "../dist/process/PrivateRuntimeRoot.js";
import { hashStableFile } from "../dist/filesystem/StableFileHash.js";
import { mcpTextValue } from "./lib/mcp-verifier-results.mjs";
@@ -27,17 +27,16 @@ const expectations =
options.expectations === null
? null
: JSON.parse(await readFile(options.expectations, "utf8"));
-const root = await PrivateRuntimeRoot.create({
- prefix: "rea-flutter-verifier-",
-});
+// This is a shared test parent, not a leased provider-owned Windows runtime.
+const root = await mkdtemp(join(tmpdir(), "rea-flutter-verifier-"));
const entrypoint = resolve("scripts/rea.mjs");
const environment = Object.fromEntries(
Object.entries(process.env).filter(([, value]) => typeof value === "string"),
);
Object.assign(environment, {
- TMPDIR: root.path,
- TMP: root.path,
- TEMP: root.path,
+ TMPDIR: root,
+ TMP: root,
+ TEMP: root,
});
const client = new Client({ name: "flutter-verifier", version: "1" });
const transport = new StdioClientTransport({
@@ -190,15 +189,18 @@ try {
} finally {
// Server shutdown retries retained provider cleanup and must settle before success.
try {
- await client.close();
- await transport.close();
+ try {
+ await client.close();
+ } finally {
+ await transport.close();
+ }
assert.deepEqual(
- await readdir(root.path),
+ await readdir(root),
[],
- "Provider snapshots must be released before verification succeeds",
+ `Provider snapshots remain under ${root}`,
);
} finally {
- await root.close();
+ await rm(root, { recursive: true, force: true });
}
}
process.stdout.write(
diff --git a/scripts/verify-package-environment.mjs b/scripts/verify-package-environment.mjs
index cd84655b2..e57f7784b 100644
--- a/scripts/verify-package-environment.mjs
+++ b/scripts/verify-package-environment.mjs
@@ -76,6 +76,7 @@ export async function verifyPackageEnvironment({
HOME: home,
USERPROFILE: home,
APPDATA: join(home, "AppData", "Roaming"),
+ LOCALAPPDATA: join(home, "AppData", "Local"),
CLAUDE_CONFIG_DIR: home,
CODEX_HOME: codexDir,
COPILOT_HOME: join(home, ".copilot"),
diff --git a/scripts/verify-package-update.mjs b/scripts/verify-package-update.mjs
index 5998ab77f..8d8582b44 100644
--- a/scripts/verify-package-update.mjs
+++ b/scripts/verify-package-update.mjs
@@ -98,6 +98,7 @@ export async function verifyPackageUpdate({
HOME: home,
USERPROFILE: home,
APPDATA: join(home, "AppData", "Roaming"),
+ LOCALAPPDATA: join(home, "AppData", "Local"),
CLAUDE_CONFIG_DIR: home,
CODEX_HOME: join(home, ".codex"),
COPILOT_HOME: join(home, ".copilot"),
diff --git a/scripts/verify-published-package.mjs b/scripts/verify-published-package.mjs
index 8c0281d56..8a5eb48d8 100644
--- a/scripts/verify-published-package.mjs
+++ b/scripts/verify-published-package.mjs
@@ -118,6 +118,7 @@ async function verifyPublishedUpdate({ version: targetVersion, canaryRoot }) {
HOME: home,
USERPROFILE: home,
APPDATA: join(home, "AppData", "Roaming"),
+ LOCALAPPDATA: join(home, "AppData", "Local"),
CLAUDE_CONFIG_DIR: home,
CODEX_HOME: join(home, ".codex"),
COPILOT_HOME: join(home, ".copilot"),
diff --git a/scripts/verify-qwen-client.mjs b/scripts/verify-qwen-client.mjs
index ed60ccd4c..fff4338b7 100644
--- a/scripts/verify-qwen-client.mjs
+++ b/scripts/verify-qwen-client.mjs
@@ -8,7 +8,7 @@ import {
realpath,
} from "node:fs/promises";
import { tmpdir } from "node:os";
-import { join } from "node:path";
+import { join, resolve, sep } from "node:path";
import { fileURLToPath } from "node:url";
import { createHash } from "node:crypto";
import { exec } from "./lib/verify-package-core.mjs";
@@ -18,10 +18,6 @@ import {
toolContract,
} from "../dist/contracts/toolContracts.js";
-assert(
- process.platform !== "win32",
- "The Qwen real-client verifier currently requires a POSIX host; native Windows is unverified.",
-);
const repo = fileURLToPath(new URL("..", import.meta.url));
const runtimeRoot = process.env.REA_VERIFY_RUNTIME_ROOT ?? repo;
const lab = await mkdtemp(join(tmpdir(), "rea-qwen-client-"));
@@ -32,6 +28,13 @@ assert(
"Usage: node scripts/verify-qwen-client.mjs [chat|call]",
);
const command = process.env.REA_VERIFY_QWEN_COMMAND ?? "qwen";
+// npm exposes only qwen.cmd on Windows. Resolve a selected JavaScript entry
+// before the verifier switches to its disposable workspace.
+const entryPoint = /\.(c|m)?js$/iu.test(command) ? resolve(command) : undefined;
+const launch = (args) =>
+ entryPoint === undefined
+ ? [command, args]
+ : [process.execPath, [entryPoint, ...args]];
const verifier = createVerifierRun();
const profile = join(lab, "selected profile");
const account = join(lab, "account");
@@ -54,14 +57,18 @@ const baseEnvironment = {
let clientVersion;
try {
clientVersion = (
- await exec(command, ["--version"], {
+ await exec(...launch(["--version"]), {
env: baseEnvironment,
timeout: 30_000,
})
).stdout.trim();
} catch (cause) {
+ const windowsHint =
+ process.platform === "win32"
+ ? " On Windows, select node_modules/@qwen-code/qwen-code/cli-entry.js."
+ : "";
throw new Error(
- `Qwen client preflight failed for ${command}; install Qwen Code or set REA_VERIFY_QWEN_COMMAND. ${String(cause)}`,
+ `Qwen client preflight failed for ${command}; install Qwen Code or set REA_VERIFY_QWEN_COMMAND.${windowsHint} ${String(cause)}`,
);
}
const original = JSON.stringify(
@@ -93,8 +100,8 @@ for (const step of [
assert(
result.plannedActions.every(
(a) =>
- a.target.startsWith(profile + "/") ||
- a.target.startsWith(sharedSkills + "/"),
+ a.target.startsWith(profile + sep) ||
+ a.target.startsWith(sharedSkills + sep),
),
);
await writeFile(
@@ -163,7 +170,14 @@ const fixture = await createOpenAiModelFixture({
skillSeen ||= JSON.stringify(body.messages ?? []).includes(
"reverse-engineer-anything",
);
- selectedSkillLoaded ||= JSON.stringify(body.messages ?? []).includes(
+ const messageText = (body.messages ?? [])
+ .map((message) =>
+ typeof message.content === "string"
+ ? message.content
+ : (message.content ?? []).map((part) => part.text ?? "").join("\n"),
+ )
+ .join("\n");
+ selectedSkillLoaded ||= messageText.includes(
join(sharedSkills, "reverse-engineer-anything"),
);
const toolText = JSON.stringify(
@@ -243,9 +257,7 @@ const fixture = await createOpenAiModelFixture({
const invoke = tools.find((t) => t.name === "tool_call");
const skill = tools.find((t) => t.name === "skill");
const shell = tools.find((t) => t.name === "run_shell_command");
- const persisted = toolText.match(
- /Full output saved to: ([^\\"\n]+)(?:\\n|\n)/u,
- );
+ const persisted = messageText.match(/Full output saved to: ([^\r\n]+)/u);
const call = (name, args) => ({
role: "assistant",
content: null,
@@ -268,13 +280,14 @@ const fixture = await createOpenAiModelFixture({
artifactPath = persisted[1];
assert(
(await realpath(artifactPath)).startsWith(
- (await realpath(runtime)) + "/",
+ (await realpath(runtime)) + sep,
),
);
const script = `const fs=require('node:fs');const e=JSON.parse(fs.readFileSync(${JSON.stringify(artifactPath)},'utf8'));console.log(JSON.stringify({REA_CLIENT_FIXTURE:JSON.stringify(e.normalized_result).includes('REA_CLIENT_FIXTURE'),evidence_id:e.evidence_id,graph_nodes:e.normalized_result.graph.nodes.length}));`;
- const quote = (value) => "'" + value.replaceAll("'", "'\\''") + "'";
+ // Keep paths and JSON quotes out of shell syntax on Windows and POSIX.
+ const encodedScript = Buffer.from(script).toString("base64");
message = call(shell.name, {
- command: `node -e ${quote(script)}`,
+ command: `node -e "eval(Buffer.from('${encodedScript}','base64').toString('utf8'))"`,
description:
"Read the complete saved REA Evidence and verify the fixture facts.",
});
@@ -329,7 +342,7 @@ const args = [
let response;
let failure;
try {
- response = await exec(command, args, {
+ response = await exec(...launch(args), {
env,
cwd: workspace,
timeout: 120_000,
diff --git a/scripts/verify-real-browser.mjs b/scripts/verify-real-browser.mjs
index 48c9bec08..27c0c5e52 100644
--- a/scripts/verify-real-browser.mjs
+++ b/scripts/verify-real-browser.mjs
@@ -9,7 +9,10 @@ import { join } from "node:path";
import { fileURLToPath } from "node:url";
import { CdpBrowserProvider } from "../dist/browser/CdpBrowserProvider.js";
-import { waitForBrowserDevtoolsPort } from "../dist/browser/BrowserProcessStartup.js";
+import {
+ BROWSER_DEVTOOLS_STARTUP_TIMEOUT_MS,
+ waitForBrowserDevtoolsPort,
+} from "../dist/browser/BrowserProcessStartup.js";
import { createBrowserScenarioProvider } from "../dist/composition/browserScenario.js";
import {
inspectWebPageInputSchema,
@@ -47,7 +50,6 @@ import { artifactCliEvidence, artifactMcpResult } from "./lib/artifact-e2e.mjs";
import { verifyScenarioEnvironment } from "./lib/browser-scenario-environment-e2e.mjs";
import { verifyScenarioStorage } from "./lib/browser-scenario-storage-e2e.mjs";
-const REAL_BROWSER_STARTUP_TIMEOUT_MS = 60_000;
const SCENARIO_SECRET_VALUE = "rea-browser-verifier-secret";
const SCENARIO_URL_SECRET_VALUE = "rea-browser-url-verifier-secret";
process.env.REA_BROWSER_VERIFIER_SECRET = SCENARIO_SECRET_VALUE;
@@ -92,7 +94,7 @@ try {
executable,
activePortPath: join(profile, "DevToolsActivePort"),
stderr: () => stderr,
- timeoutMs: REAL_BROWSER_STARTUP_TIMEOUT_MS,
+ timeoutMs: BROWSER_DEVTOOLS_STARTUP_TIMEOUT_MS,
});
const endpoint = `http://127.0.0.1:${String(port)}`;
const provider = new CdpBrowserProvider();
diff --git a/scripts/verify-real-ghidra-6502.mjs b/scripts/verify-real-ghidra-6502.mjs
new file mode 100644
index 000000000..87fb01d41
--- /dev/null
+++ b/scripts/verify-real-ghidra-6502.mjs
@@ -0,0 +1,479 @@
+import assert from "node:assert/strict";
+import { execFile } from "node:child_process";
+import { createHash } from "node:crypto";
+import {
+ mkdir,
+ mkdtemp,
+ readFile,
+ readdir,
+ rm,
+ symlink,
+ unlink,
+ writeFile,
+} from "node:fs/promises";
+import { join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { promisify } from "node:util";
+
+import { Client } from "@modelcontextprotocol/client";
+import { StdioClientTransport } from "@modelcontextprotocol/client/stdio";
+import { parseEvidence } from "../dist/domain/evidence.js";
+import { requireMcpOperationResult } from "./lib/mcp-verifier-results.mjs";
+import { createVerifierRun, completeVerifierRun } from "./lib/verifier-run.mjs";
+
+if (process.argv.length !== 2)
+ throw new Error("Usage: node scripts/verify-real-ghidra-6502.mjs");
+if (process.env.GHIDRA_INSTALL_DIR === undefined)
+ throw new Error(
+ "Set GHIDRA_INSTALL_DIR to a bring-your-own Ghidra installation.",
+ );
+const exec = promisify(execFile);
+const run = createVerifierRun();
+const root = fileURLToPath(new URL("..", import.meta.url));
+const ca65 = process.env.REA_CA65 ?? "ca65";
+const ld65 = process.env.REA_LD65 ?? "ld65";
+const toolchain = {};
+for (const [name, command] of Object.entries({ ca65, ld65 })) {
+ const version = await exec(command, ["--version"], { timeout: 10000 });
+ toolchain[name] = (version.stdout + version.stderr).trim();
+}
+await mkdir(join(root, "build"), { recursive: true });
+const workspace = await mkdtemp(join(root, "build", "rea-6502-proof-"));
+const runtime = join(workspace, "runtime");
+await mkdir(runtime);
+const path = join(workspace, "image.bin");
+const object = join(workspace, "image.o");
+const entrypoint = join(root, "scripts", "rea.mjs");
+const env = {
+ ...process.env,
+ TMPDIR: runtime,
+ TMP: runtime,
+ TEMP: runtime,
+ REA_LOG_LEVEL: "silent",
+ REA_ANALYSIS_PROVIDER: "ghidra",
+ REA_PROCESS_RUN_ID: run.run_id,
+};
+const transport = new StdioClientTransport({
+ command: process.execPath,
+ args: [entrypoint, "mcp"],
+ env,
+ stderr: "pipe",
+});
+const client = new Client({ name: "rea-real-6502-proof", version: "1" });
+let stderr = "";
+transport.stderr?.on("data", (chunk) => {
+ stderr = (stderr + chunk.toString()).slice(-65536);
+});
+let report;
+try {
+ await exec(
+ ca65,
+ [join(root, "tests/conformance/ghidra/6502.s"), "-o", object],
+ { timeout: 10000 },
+ );
+ await exec(
+ ld65,
+ ["-C", join(root, "tests/conformance/ghidra/6502.cfg"), "-o", path, object],
+ { timeout: 10000 },
+ );
+ const bytes = await readFile(path);
+ // Independently known opcodes and link addresses from the source fixture.
+ assert.equal(bytes.toString("hex"), "a907201080c90ad003a92a60a9006018690360");
+ const sha256 = createHash("sha256").update(bytes).digest("hex");
+ await client.connect(transport);
+ const opened = await call("open_binary", {
+ path,
+ format: "raw-binary",
+ architecture: "6502",
+ entry_point: "0x008001",
+ provider_id: "ghidra",
+ });
+ assert.equal(opened.architecture, "6502");
+ assert.equal(opened.entry_point, "0x8001");
+ const status = await call("binary_session");
+ const image = evidence(await call("inspect_native_load_image"), sha256);
+ assert.equal(
+ image.normalized_result.status,
+ "verified",
+ JSON.stringify(image.normalized_result),
+ );
+ assert.equal(image.normalized_result.architecture, "6502");
+ assert.equal(image.normalized_result.base_address, "0x8001");
+ assert.equal(image.normalized_result.language_id, "6502:LE:16:default");
+ assert.equal(image.normalized_result.compiler_spec_id, "default");
+ assert.equal(image.normalized_result.file_bytes, bytes.length);
+ const memory = evidence(
+ await call("read_bytes", { address: "0x8001", length: bytes.length }),
+ sha256,
+ );
+ assert.equal(memory.normalized_result.bytes_hex, bytes.toString("hex"));
+ const procedures = evidence(await call("list_procedures"), sha256);
+ for (const address of ["0x8001", "0x8010"])
+ assert.ok(
+ procedures.normalized_result.some(
+ (procedure) => procedure.address === address,
+ ),
+ );
+ const instruction = evidence(
+ await call("inspect_native_instruction", { address: "0x8003" }),
+ sha256,
+ );
+ assert.equal(instruction.normalized_result.mnemonic.toUpperCase(), "JSR");
+ assert.ok(
+ instruction.normalized_result.references.some(
+ (reference) => reference.call && reference.target_address === "0x8010",
+ ),
+ );
+ const pseudo = evidence(
+ await call("procedure_pseudo_code", { procedure: "0x8010" }),
+ sha256,
+ );
+ assert.match(pseudo.normalized_result, /\+\s*(?:3|0x3|'\\x03')/u);
+ const filePseudo = evidence(
+ await call("procedure_pseudo_code", { procedure: "file-offset:0xf" }),
+ sha256,
+ );
+ assert.equal(filePseudo.normalized_result, pseudo.normalized_result);
+ assert.ok(
+ filePseudo.locations.some(
+ (location) => location.kind === "file-offset" && location.offset === 15,
+ ),
+ );
+ const rejected = await client.callTool({
+ name: "open_binary",
+ arguments: {
+ path,
+ format: "raw-binary",
+ architecture: "6502",
+ entry_point: "0xffff",
+ },
+ });
+ assert.equal(rejected.isError, true);
+ assert.match(JSON.stringify(rejected.content), /6502 address width/u);
+ const preserved = await call("binary_session");
+ assert.equal(preserved.analysis_run.run_id, status.analysis_run.run_id);
+ assert.equal(preserved.entry_point, "0x8001");
+ await call("close_binary");
+ await client.ping();
+ const { stdout } = await exec(
+ process.execPath,
+ [
+ entrypoint,
+ "inspect-native-load-image",
+ path,
+ "--target-format",
+ "raw-binary",
+ "--architecture",
+ "6502",
+ "--entry-point",
+ "0x8001",
+ "--provider",
+ "ghidra",
+ "--json",
+ ],
+ { env, timeout: 240000, maxBuffer: 16 * 1024 * 1024 },
+ );
+ const cli = parseEvidence(JSON.parse(stdout));
+ assert.deepEqual(cli.normalized_result, image.normalized_result);
+ assert.equal(cli.analysis_profile.digest, image.analysis_profile.digest);
+ assert.equal(cli.subject.digest.sha256, sha256);
+ const fileCli = await exec(
+ process.execPath,
+ [
+ entrypoint,
+ "decompile",
+ path,
+ "--file-offset=0xf",
+ "--target-format",
+ "raw-binary",
+ "--architecture",
+ "6502",
+ "--entry-point",
+ "0x8001",
+ "--provider",
+ "ghidra",
+ "--json",
+ ],
+ { env, timeout: 240000, maxBuffer: 16 * 1024 * 1024 },
+ );
+ const fileCliEvidence = parseEvidence(JSON.parse(fileCli.stdout));
+ assert.equal(fileCliEvidence.normalized_result, filePseudo.normalized_result);
+ assert.deepEqual(fileCliEvidence.locations, filePseudo.locations);
+ assert.equal(fileCliEvidence.subject.digest.sha256, sha256);
+ assert.deepEqual(await readFile(path), bytes);
+ assert.deepEqual(await readdir(runtime), []);
+ const lowMemory = [];
+ // BinaryLoader maps file bytes before trying processor-defined blocks. Prove
+ // that overlapping zero-page/stack definitions never overlay the selected image.
+ for (const [entry, fullAddressSpace] of [
+ [0xff, false],
+ [0, true],
+ ]) {
+ const lowPath = join(workspace, `low-${entry}.bin`);
+ await exec(
+ ld65,
+ [
+ "-C",
+ join(root, "tests/conformance/ghidra/6502.cfg"),
+ "--start-addr",
+ String(entry),
+ "-o",
+ lowPath,
+ object,
+ ],
+ { timeout: 10000 },
+ );
+ const linked = await readFile(lowPath);
+ const expectedCode = Buffer.from(
+ "a907200000c90ad003a92a60a9006018690360",
+ "hex",
+ );
+ expectedCode.writeUInt16LE(entry + 15, 3);
+ assert.deepEqual(linked, expectedCode);
+ const lowBytes = fullAddressSpace
+ ? Buffer.concat([linked, Buffer.alloc(65536 - linked.length)])
+ : linked;
+ await writeFile(lowPath, lowBytes);
+ const lowSha256 = createHash("sha256").update(lowBytes).digest("hex");
+ const lowEntry = `0x${entry.toString(16)}`;
+ const lowOpened = await call("open_binary", {
+ path: lowPath,
+ format: "raw-binary",
+ architecture: "6502",
+ entry_point: lowEntry,
+ provider_id: "ghidra",
+ });
+ assert.equal(lowOpened.entry_point, lowEntry);
+ const lowImage = evidence(
+ await call("inspect_native_load_image"),
+ lowSha256,
+ );
+ assert.equal(
+ lowImage.normalized_result.status,
+ "verified",
+ JSON.stringify(lowImage.normalized_result),
+ );
+ assert.equal(lowImage.normalized_result.base_address, lowEntry);
+ assert.equal(lowImage.normalized_result.file_bytes, lowBytes.length);
+ const fileMappings =
+ lowImage.normalized_result.observations.mappings.filter(
+ (mapping) => mapping.source_file_index !== null,
+ );
+ assert.equal(fileMappings.length, 1);
+ assert.equal(
+ fileMappings[0].address_space,
+ lowImage.normalized_result.observations.default_address_space,
+ );
+ assert.equal(fileMappings[0].overlay, false);
+ assert.equal(fileMappings[0].start, lowEntry);
+ assert.equal(fileMappings[0].length, lowBytes.length);
+ const lowRead = evidence(
+ await call("read_bytes", { address: lowEntry, length: linked.length }),
+ lowSha256,
+ );
+ assert.equal(lowRead.normalized_result.bytes_hex, linked.toString("hex"));
+ const lowCall = evidence(
+ await call("inspect_native_instruction", {
+ address: `0x${(entry + 2).toString(16)}`,
+ }),
+ lowSha256,
+ );
+ assert.equal(lowCall.normalized_result.mnemonic.toUpperCase(), "JSR");
+ assert.ok(
+ lowCall.normalized_result.references.some(
+ (reference) =>
+ reference.call &&
+ reference.target_address === `0x${(entry + 15).toString(16)}`,
+ ),
+ );
+ await call("close_binary");
+ const lowCli = await exec(
+ process.execPath,
+ [
+ entrypoint,
+ "inspect-native-load-image",
+ lowPath,
+ "--target-format",
+ "raw-binary",
+ "--architecture",
+ "6502",
+ "--entry-point",
+ lowEntry,
+ "--provider",
+ "ghidra",
+ "--json",
+ ],
+ { env, timeout: 240000, maxBuffer: 16 * 1024 * 1024 },
+ );
+ const lowCliEvidence = evidence(JSON.parse(lowCli.stdout), lowSha256);
+ assert.deepEqual(
+ lowCliEvidence.normalized_result,
+ lowImage.normalized_result,
+ );
+ assert.equal(
+ lowCliEvidence.analysis_profile.digest,
+ lowImage.analysis_profile.digest,
+ );
+ assert.deepEqual(await readFile(lowPath), lowBytes);
+ assert.deepEqual(await readdir(runtime), []);
+ lowMemory.push({
+ entry: lowEntry,
+ bytes: lowBytes.length,
+ sha256: lowSha256,
+ });
+ }
+ let windowsReparseAdmission = "not-applicable";
+ if (process.platform === "win32") {
+ const junction = join(workspace, "linked");
+ await symlink(workspace, junction, "junction");
+ try {
+ const linkedPath = join(junction, "image.bin");
+ // Reopening the same bytes through a junction must replace the direct session.
+ await call("open_binary", {
+ path,
+ format: "raw-binary",
+ architecture: "6502",
+ entry_point: "0x8001",
+ provider_id: "ghidra",
+ });
+ const directImage = evidence(
+ await call("inspect_native_load_image"),
+ sha256,
+ );
+ assert.equal(directImage.normalized_result.status, "verified");
+ // Canonical file identity must not bypass admission of the new path.
+ await call("open_binary", {
+ path: linkedPath,
+ format: "raw-binary",
+ architecture: "6502",
+ entry_point: "0x8001",
+ provider_id: "ghidra",
+ });
+ // open_binary selects a lazy session; the first analysis admits the snapshot.
+ const linkedImage = await client.callTool(
+ { name: "inspect_native_load_image", arguments: {} },
+ { timeout: 240000 },
+ );
+ assert.equal(linkedImage.isError, true);
+ assert.match(
+ JSON.stringify(linkedImage),
+ /Reparse path component is unsupported/u,
+ );
+ await call("close_binary");
+ const snapshotPath = join(workspace, "direct-snapshot.json");
+ const cliArgs = (selectedPath) => [
+ entrypoint,
+ "analyze",
+ selectedPath,
+ "--target-format",
+ "raw-binary",
+ "--architecture",
+ "6502",
+ "--entry-point",
+ "0x8001",
+ "--provider",
+ "ghidra",
+ "--snapshot",
+ snapshotPath,
+ "--json",
+ ];
+ const saved = await exec(process.execPath, cliArgs(path), {
+ env,
+ timeout: 240000,
+ maxBuffer: 16 * 1024 * 1024,
+ });
+ assert.equal(
+ evidence(JSON.parse(saved.stdout), sha256).operation,
+ "binary_overview",
+ );
+ const savedSnapshot = JSON.parse(await readFile(snapshotPath, "utf8"));
+ assert.ok(
+ savedSnapshot.workflow_entries.some(
+ ({ operation }) => operation === "binary_overview",
+ ),
+ );
+ assert.deepEqual(await readdir(runtime), []);
+ // Replaying a matching snapshot must still reach native path admission.
+ await assert.rejects(
+ exec(process.execPath, cliArgs(linkedPath), {
+ env,
+ timeout: 240000,
+ maxBuffer: 16 * 1024 * 1024,
+ }),
+ (cause) => {
+ assert.match(
+ cause.stdout + cause.stderr,
+ /Reparse path component is unsupported/u,
+ );
+ return true;
+ },
+ );
+ assert.deepEqual(await readFile(path), bytes);
+ assert.deepEqual(await readdir(runtime), []);
+ windowsReparseAdmission = "cli-snapshot-mcp-rejected";
+ } finally {
+ await unlink(junction);
+ }
+ }
+ report = {
+ ok: true,
+ mocked: false,
+ lane: "ghidra-6502",
+ host: process.platform,
+ toolchain,
+ provider: image.provider,
+ target: {
+ sha256,
+ bytes: bytes.length,
+ architecture: "6502",
+ entry: "0x8001",
+ },
+ cli_mcp_load_image_parity: true,
+ instructions_and_call_reference: true,
+ decompilation: true,
+ file_offset_decompilation_cli_mcp: true,
+ invalid_mapping_preserves_session: true,
+ low_memory_cli_mcp_parity: lowMemory,
+ windows_reparse_admission: windowsReparseAdmission,
+ source_unchanged: true,
+ runtime_cleanup: "complete",
+ };
+} catch (cause) {
+ if (stderr) process.stderr.write(stderr);
+ throw cause;
+} finally {
+ try {
+ await client.close();
+ } finally {
+ await transport.close();
+ }
+}
+const verifierRun = await completeVerifierRun(run);
+if (process.platform !== "win32") {
+ assert.equal(verifierRun.process_lineage.status, "verified");
+ assert.deepEqual(verifierRun.process_lineage.descendants, []);
+}
+// Keep the workspace for diagnosis unless verification and cleanup both pass.
+await rm(workspace, { recursive: true, force: true });
+process.stdout.write(
+ JSON.stringify({ verifier_run: verifierRun, ...report }) + "\n",
+);
+
+async function call(name, args = {}) {
+ const result = await client.callTool(
+ { name, arguments: args },
+ { timeout: 240000 },
+ );
+ assert.notEqual(result.isError, true, JSON.stringify(result));
+ if (["open_binary", "binary_session", "close_binary"].includes(name))
+ return requireMcpOperationResult(result, name);
+ return result.structuredContent;
+}
+
+function evidence(value, sha256) {
+ const result = parseEvidence(value);
+ assert.equal(result.subject.digest.sha256, sha256);
+ assert.equal(result.subject.architecture, "6502");
+ assert.equal(result.subject.format, "raw-binary");
+ return result;
+}
diff --git a/scripts/verify-real-ghidra-mips.mjs b/scripts/verify-real-ghidra-mips.mjs
index 1c04ea978..12c00366d 100644
--- a/scripts/verify-real-ghidra-mips.mjs
+++ b/scripts/verify-real-ghidra-mips.mjs
@@ -12,6 +12,7 @@ import { StdioClientTransport } from "@modelcontextprotocol/client/stdio";
import { parseBinaryTarget } from "../dist/application/BinaryTargetResolver.js";
import {
inspectMipsReadelf,
+ inspectLegacyMipsReadelf,
assertMipsLoadedImage,
assertMipsProbe,
assertMipsGlobal,
@@ -122,6 +123,157 @@ async function verifySoftFloat(call, symbols, byteOrder) {
const reports = [];
let primaryFailure;
try {
+ if (!psp) {
+ // Recordless legacy admission: ABI field 0, no ABI flags record, pinned
+ // 32-bit language. Independent GNU readelf checks the header interpretation.
+ for (const byteOrder of ["little", "big"]) {
+ const fixture = await buildMipsFixture(workspace, byteOrder, "hard", {
+ legacy: true,
+ });
+ const legacy = await inspectLegacyMipsReadelf(fixture.path, byteOrder);
+ const resolved = await parseBinaryTarget(fixture.path);
+ if (!resolved.ok) throw resolved.error;
+ assert.equal(resolved.value.mips.flags, 0x50000001);
+ assert.equal(resolved.value.mips.abiFlags, null);
+ assert.deepEqual(
+ resolved.value.mips.limitations ?? [],
+ legacy.limitations,
+ "REA legacy ABI-record absence interpretation disagrees with GNU readelf",
+ );
+ assert.equal(resolved.value.sha256, fixture.sha256);
+ const snapshotPath = join(workspace, `${byteOrder}-legacy.snapshot.json`);
+ const transport = new StdioClientTransport({
+ command: process.execPath,
+ args: [entrypoint, "mcp"],
+ env,
+ stderr: "pipe",
+ });
+ const client = new Client({
+ name: "rea-real-mips-legacy-proof",
+ version: "1",
+ });
+ let stderr = "";
+ transport.stderr?.on("data", (chunk) => {
+ stderr = (stderr + chunk.toString()).slice(-65536);
+ });
+ const call = async (name, args = {}) => {
+ const reply = await client.callTool(
+ { name, arguments: args },
+ undefined,
+ { timeout: 180000 },
+ );
+ return requireMcpOperationResult(reply, name);
+ };
+ try {
+ await client.connect(transport);
+ const selected = await call("open_binary", {
+ path: fixture.path,
+ provider_id: "ghidra",
+ });
+ assert.equal(selected.architecture, "mips");
+ assert.equal(selected.sha256, fixture.sha256);
+ const image = await call("inspect_native_load_image");
+ assertMipsLoadedImage(image.observations, byteOrder, fixture.sha256);
+ // The pinned import language is the checked one, not an auto-selection.
+ assert.equal(
+ image.observations.language_id,
+ `MIPS:${byteOrder === "little" ? "LE" : "BE"}:32:default`,
+ );
+ const procedures = await call("list_procedures");
+ const entry = procedures.find((p) => p.value === "rea_mips_entry");
+ assert.ok(entry, "Entry function missing from legacy inventory");
+ assert.equal(
+ BigInt(entry.address),
+ BigInt(legacy.symbols.rea_mips_entry),
+ );
+ const probe = await call("inspect_native_instruction", {
+ address: legacy.symbols.rea_mips_probe,
+ });
+ const probeBranch = await call("inspect_native_instruction", {
+ address: `0x${(BigInt(legacy.symbols.rea_mips_probe) + 4n).toString(16)}`,
+ });
+ assertMipsProbe(
+ probe,
+ probeBranch,
+ byteOrder,
+ legacy.symbols.rea_mips_probe,
+ );
+ const dossier = functionDossierSchema.parse(
+ await call("analyze_function", { procedure: entry.address }),
+ );
+ assert.ok(dossier.pseudocode.trim().length > 0);
+ const saved = await call("close_binary", {
+ snapshot_path: snapshotPath,
+ });
+ assert.ok(saved.evidence_records > 0);
+ const snapshot = parseAnalysisSnapshot(
+ JSON.parse(await readFile(snapshotPath, "utf8")),
+ );
+ assert.equal(snapshot.target.architecture, "mips");
+ const parameters = snapshot.binding.analysis_profile.parameters;
+ assert.equal(
+ parameters.language_id,
+ `MIPS:${byteOrder === "little" ? "LE" : "BE"}:32:default`,
+ );
+ assert.equal(parameters.language_selection, "provider-pinned-v1");
+ assert.equal(
+ parameters.mips_support_lane,
+ "elf32-exec-arch32-legacy-pinned-v1",
+ );
+ assert.equal(parameters.mips_abi_basis, "inferred-o32-assumption-v1");
+ assert.ok(
+ snapshot.evidence_bundle.records.some((record) =>
+ parseEvidence(record).limitations.some((item) =>
+ item.includes("analysis assumption"),
+ ),
+ ),
+ "Legacy o32 assumption limitation missing from retained Evidence",
+ );
+ assert.ok(
+ snapshot.evidence_bundle.records.some((record) =>
+ parseEvidence(record).limitations.some((item) =>
+ item.includes("Floating-point ABI semantics are unverified"),
+ ),
+ ),
+ "Legacy floating-point uncertainty missing from retained Evidence",
+ );
+ await call("open_binary", {
+ path: fixture.path,
+ provider_id: "ghidra",
+ snapshot_path: snapshotPath,
+ });
+ assert.deepEqual(await call("list_procedures"), procedures);
+ await call("close_binary");
+ } catch (cause) {
+ throw new Error(
+ `MIPS legacy ${byteOrder} verification failed; MCP stderr: ${stderr}`,
+ { cause },
+ );
+ } finally {
+ try {
+ await client.close();
+ } finally {
+ await transport.close();
+ }
+ }
+ reports.push({
+ ...fixture,
+ independent_reader: legacy,
+ variant: "recordless-legacy-pinned",
+ effective_language: `MIPS:${
+ byteOrder === "little" ? "LE" : "BE"
+ }:32:default`,
+ procedures: "verified-through-snapshot",
+ checks: [
+ "recordless header admitted with inferred o32 assumption",
+ "pinned 32-bit language checked after import",
+ "legacy limitations retained in Evidence",
+ "snapshot round-trip and profile parameters",
+ ],
+ status: "passed",
+ });
+ }
+ }
for (const [byteOrder, floatAbi] of psp
? [["little", "hard"]]
: [
diff --git a/scripts/verify-real-ghidra-swift.mjs b/scripts/verify-real-ghidra-swift.mjs
index 0593408b0..0aa58e2f0 100644
--- a/scripts/verify-real-ghidra-swift.mjs
+++ b/scripts/verify-real-ghidra-swift.mjs
@@ -45,8 +45,13 @@ const transport = new StdioClientTransport({
const source = fileURLToPath(
new URL("../tests/conformance/swift/type-inventory.swift", import.meta.url),
);
+const literalSource = fileURLToPath(
+ new URL("../tests/conformance/swift/string-literals.swift", import.meta.url),
+);
const binary = join(root, "swift-inventory");
+const literalBinary = join(root, "swift-literals");
const reports = [];
+let literalReport;
try {
await execute("swiftc", ["-O", "-g", source, "-o", binary], {
timeout: 60_000,
@@ -54,6 +59,19 @@ try {
await mkdir(join(root, "copied"));
const copied = join(root, "copied", "swift-inventory");
await copyFile(binary, copied);
+ // Decoding covers AArch64 register pairs, so build that slice on any Mac host.
+ await execute(
+ "swiftc",
+ [
+ "-O",
+ "-target",
+ "arm64-apple-macosx13.0",
+ literalSource,
+ "-o",
+ literalBinary,
+ ],
+ { timeout: 60_000 },
+ );
await client.connect(transport);
for (const [variant, path] of [
["debug", binary],
@@ -132,6 +150,7 @@ try {
await call("close_binary", {});
}
}
+ literalReport = await verifyStringLiterals();
} finally {
await client.close();
await transport.close();
@@ -143,6 +162,7 @@ console.log(
ok: true,
provider: "ghidra",
fixtures: reports,
+ swift_string_literals: literalReport,
verifier_run: await completeVerifierRun(run),
},
null,
@@ -159,3 +179,51 @@ async function call(name, arguments_) {
toolContract(name).outputSchema.parse(response.structuredContent);
return requireMcpOperationResult(response, name);
}
+
+// Literal text lives only in register constants, so it must come from the decoded pairs.
+async function verifyStringLiterals() {
+ await call("open_binary", { path: literalBinary, provider_id: "ghidra" });
+ try {
+ const procedures = await call("list_procedures", {});
+ const expected = {
+ smallLiteral: [["SleepDisabled", "small"]],
+ largeLiteral: [["The power setting could not be changed.", "large"]],
+ unicodeLiterals: [
+ ["café", "small"],
+ ["Résumé of the naïve décor, written twice", "large"],
+ ],
+ emptyAndControlLiterals: [
+ ["", "small"],
+ ["tab\there", "small"],
+ ],
+ returnedLiteral: [["Holding awake", "small"]],
+ };
+ const decoded = {};
+ for (const [name, literals] of Object.entries(expected)) {
+ const procedure = procedures.find(({ value }) => value.includes(name));
+ assert(procedure, `${name} is missing from the procedure inventory`);
+ const dossier = await call("analyze_function", {
+ procedure: procedure.address,
+ });
+ const observed = dossier.swift_string_literals;
+ assert(Array.isArray(observed), `${name} recorded no Swift literals`);
+ assert.deepEqual(dossier.swift_string_literal_omissions, []);
+ assert.deepEqual(
+ observed.map(({ value, representation }) => [value, representation]),
+ literals,
+ );
+ for (const literal of observed) {
+ assert.deepEqual(literal.registers, ["x0", "x1"]);
+ assert.equal(
+ literal.address === null,
+ literal.representation === "small",
+ `${literal.value} storage does not match its representation`,
+ );
+ }
+ decoded[name] = observed.length;
+ }
+ return decoded;
+ } finally {
+ await call("close_binary", {});
+ }
+}
diff --git a/scripts/verify-real-ida.mjs b/scripts/verify-real-ida.mjs
index cedbf5076..bed0519a9 100644
--- a/scripts/verify-real-ida.mjs
+++ b/scripts/verify-real-ida.mjs
@@ -1,4 +1,8 @@
#!/usr/bin/env node
+import {
+ assertFeatureTrace,
+ findMappedNonFunction,
+} from "./lib/ida-feature-trace.mjs";
import { requireMcpToolError } from "./lib/mcp-verifier-results.mjs";
import assert from "node:assert/strict";
@@ -6,7 +10,7 @@ import { execFile } from "node:child_process";
import { createHash } from "node:crypto";
import { createReadStream } from "node:fs";
import { access, writeFile } from "node:fs/promises";
-import { dirname, join, resolve } from "node:path";
+import { basename, dirname, join, resolve } from "node:path";
import { fileURLToPath, pathToFileURL } from "node:url";
import { parseArgs, promisify } from "node:util";
import { Client } from "@modelcontextprotocol/client";
@@ -261,6 +265,61 @@ const mcp = async (cliDossier) => {
break;
}
}
+ if (config.mode === "headless") {
+ const documents = observe(await call("list_documents", {}));
+ assert.equal(documents.length, 1);
+ assert.equal(basename(documents[0]), basename(target));
+ assert.ok(
+ !workspaces.has(dirname(documents[0])),
+ "list_documents reported the private workspace copy.",
+ );
+ const resolveAt = async (address) =>
+ observe(await call("resolve_containing_procedure", { address }));
+ const instructionAddresses = dossier.assembly
+ .map((line) => /^(0x[0-9a-f]+)/iu.exec(line)?.[1])
+ .filter((address) => address !== undefined);
+ const queries = [
+ dossier.procedure.address,
+ ...instructionAddresses.slice(1, 2),
+ ];
+ for (const queried of queries) {
+ const containing = await resolveAt(queried);
+ assert.equal(containing.found, true);
+ assert.equal(containing.procedure.address, dossier.procedure.address);
+ assert.equal(containing.procedure.name, dossier.procedure.name);
+ }
+ const unmapped = await resolveAt("0xffffffffffffff00");
+ assert.equal(unmapped.found, false);
+ assert.equal(unmapped.reason, "outside_segments");
+ const strings = observe(await call("list_strings", {}));
+ const mappedString = await findMappedNonFunction(strings, resolveAt);
+ if (mappedString === undefined)
+ report.unverified.push(
+ "Mapped non-function containment: no string of the target is mapped outside every function.",
+ );
+ const context = await client.callTool({
+ name: "inspect_address_context",
+ arguments: { address: dossier.procedure.address },
+ });
+ assert.notEqual(context.isError, true);
+ const contextResult = context.structuredContent.result;
+ assert.equal(contextResult.document, documents[0]);
+ assert.equal(contextResult.procedure.state, "available");
+ assert.equal(
+ contextResult.procedure.value.procedure.address,
+ dossier.procedure.address,
+ );
+ const traced = await client.callTool({
+ name: "trace_feature",
+ arguments: { query: dossier.procedure.name },
+ });
+ assert.notEqual(traced.isError, true);
+ const trace = traced.structuredContent.normalized_result;
+ assertFeatureTrace(trace, dossier.procedure);
+ report.checks.push(
+ "headless containing procedures, the admitted program as the document, address context, and the procedure match and references of feature tracing",
+ );
+ }
if (values["expected-string"] === undefined)
report.unverified.push(
"String inventory/search correctness: no independent expected literal supplied.",
diff --git a/scripts/verify-solidity-metadata.mjs b/scripts/verify-solidity-metadata.mjs
new file mode 100644
index 000000000..f927477d8
--- /dev/null
+++ b/scripts/verify-solidity-metadata.mjs
@@ -0,0 +1,105 @@
+import assert from "node:assert/strict";
+import { readFile } from "node:fs/promises";
+import { isAbsolute } from "node:path";
+import { pathToFileURL } from "node:url";
+import { performance } from "node:perf_hooks";
+import { inspectSolidityMetadata } from "../dist/evm/SolidityMetadata.js";
+
+const compilerModule = process.env.REA_VERIFY_SOLC_MODULE;
+if (!isAbsolute(compilerModule ?? ""))
+ throw new Error(
+ "Select an absolute caller-installed solc 0.8.30 module with REA_VERIFY_SOLC_MODULE.",
+ );
+const solc = (await import(pathToFileURL(compilerModule).href)).default;
+assert.equal(solc.version(), "0.8.30+commit.73712a01.Emscripten.clang");
+const source = await readFile(
+ new URL("./fixtures/evm-interface.sol", import.meta.url),
+ "utf8",
+);
+const cases = [
+ { name: "unoptimized", optimizer: false, viaIR: false, metadata: {} },
+ { name: "viaIR", optimizer: true, viaIR: true, metadata: {} },
+ {
+ name: "without-content-hash",
+ optimizer: false,
+ viaIR: false,
+ metadata: { bytecodeHash: "none" },
+ },
+ {
+ name: "without-CBOR",
+ optimizer: false,
+ viaIR: false,
+ metadata: { appendCBOR: false },
+ },
+];
+const reports = [];
+for (const fixture of cases) {
+ const compiled = JSON.parse(
+ solc.compile(
+ JSON.stringify({
+ language: "Solidity",
+ sources: { "fixture.sol": { content: source } },
+ settings: {
+ optimizer: { enabled: fixture.optimizer },
+ viaIR: fixture.viaIR,
+ metadata: fixture.metadata,
+ outputSelection: { "*": { "*": ["evm.deployedBytecode.object"] } },
+ },
+ }),
+ ),
+ );
+ assert.ok(
+ !(compiled.errors ?? []).some((error) => error.severity === "error"),
+ JSON.stringify(compiled.errors),
+ );
+ const bytes = Buffer.from(
+ compiled.contracts["fixture.sol"].InterfaceFixture.evm.deployedBytecode
+ .object,
+ "hex",
+ );
+ const cpu = process.cpuUsage();
+ const started = performance.now();
+ const parsed = inspectSolidityMetadata(bytes);
+ const firstMs = performance.now() - started;
+ const firstCpu = process.cpuUsage(cpu);
+ if (fixture.metadata.appendCBOR === false)
+ assert.equal(parsed.status, "unavailable");
+ else {
+ assert.equal(parsed.status, "decoded");
+ assert.deepEqual(parsed.compiler_version, {
+ representation: "release-bytes",
+ value: "0.8.30",
+ });
+ assert.equal(parsed.bytecode_offset + parsed.cbor_bytes + 2, bytes.length);
+ if (fixture.metadata.bytecodeHash === "none")
+ assert.deepEqual(
+ parsed.entries.map(({ key }) => key),
+ [{ kind: "text", value: "solc" }],
+ );
+ }
+ const warmResults = new Array(100);
+ const warmStart = performance.now();
+ for (let index = 0; index < warmResults.length; index++)
+ warmResults[index] = inspectSolidityMetadata(bytes);
+ const warmMs = performance.now() - warmStart;
+ for (const result of warmResults) assert.deepEqual(result, parsed);
+ reports.push({
+ fixture: fixture.name,
+ bytes: bytes.length,
+ status: parsed.status,
+ first_decode_ms: firstMs,
+ first_decode_cpu_us: firstCpu,
+ warm_100_decode_ms: warmMs,
+ });
+}
+console.log(
+ JSON.stringify({
+ ok: true,
+ compiler_version: solc.version(),
+ contract_execution: "not-performed",
+ cases: reports,
+ process_peak_rss_kib: process.resourceUsage().maxRSS,
+ measurements:
+ "In-process decode timings; peak RSS includes the compiler. End-to-end Linux provider/CLI costs and agent tokens were not measured.",
+ }),
+);
diff --git a/scripts/verify-windows-native-artifact.mjs b/scripts/verify-windows-native-artifact.mjs
index 1a6777322..4db66e0ee 100644
--- a/scripts/verify-windows-native-artifact.mjs
+++ b/scripts/verify-windows-native-artifact.mjs
@@ -27,9 +27,9 @@ if (
);
const offset = bytes.length >= 64 ? bytes.readUInt32LE(0x3c) : bytes.length;
if (
- bytes.toString("ascii", 0, 2) !== "MZ" ||
+ bytes.toString("latin1", 0, 2) !== "MZ" ||
offset > bytes.length - 26 ||
- bytes.toString("ascii", offset, offset + 4) !== "PE\0\0" ||
+ bytes.toString("latin1", offset, offset + 4) !== "PE\0\0" ||
bytes.readUInt16LE(offset + 4) !== 0x8664 ||
bytes.readUInt16LE(offset + 24) !== 0x20b
)
diff --git a/scripts/verify-windows-native.mjs b/scripts/verify-windows-native.mjs
index 8623081f9..0a42cb604 100644
--- a/scripts/verify-windows-native.mjs
+++ b/scripts/verify-windows-native.mjs
@@ -472,10 +472,9 @@ process.stdout.write(JSON.stringify({executable:basename(process.execPath),abiVe
signal: AbortSignal.timeout(15_000),
});
assert.equal(String(ready).trim(), "ready");
- await assert.rejects(
- retryRuntime.close(),
- /owned cleanup object|Delete owned object/u,
- );
+ // The reader denies delete sharing. Cleanup must retain ownership when
+ // its handle-relative open receives ERROR_SHARING_VIOLATION (32).
+ await assert.rejects(retryRuntime.close(), { win32Code: 32 });
assert.equal(
windowsPrivateRuntime(retryRuntime.observation.path),
retryRuntime,
diff --git a/scripts/verify-windows-package.mjs b/scripts/verify-windows-package.mjs
index 67dee06c2..425b5cbd3 100644
--- a/scripts/verify-windows-package.mjs
+++ b/scripts/verify-windows-package.mjs
@@ -52,8 +52,10 @@ try {
"bridge/ghidra/ReaGhidraBridge.java",
"native/windows/build/manifest.json",
"native/windows/build/rea-windows-x64.node",
+ "dist/android/JadxWorkspaceRoot.js",
"dist/main.js",
"dist/cli.js",
+ "scripts/rea-android-workspace-guardian.mjs",
"scripts/rea.mjs",
])
if (!packagedPaths.has(required))
@@ -108,6 +110,7 @@ try {
HOME: home,
USERPROFILE: home,
APPDATA: join(home, "AppData", "Roaming"),
+ LOCALAPPDATA: join(home, "AppData", "Local"),
CLAUDE_CONFIG_DIR: home,
CODEX_HOME: join(home, ".codex"),
XDG_CONFIG_HOME: join(home, ".config"),
diff --git a/scripts/verify/android/analysis.mjs b/scripts/verify/android/analysis.mjs
index 43c51d82b..30024b557 100644
--- a/scripts/verify/android/analysis.mjs
+++ b/scripts/verify/android/analysis.mjs
@@ -173,6 +173,50 @@ try {
assert.deepEqual(structured.normalized_result, evidence.normalized_result);
console.log(`PASS MCP/CLI parity ${task.name}`);
}
+ const overloadedInput = {
+ path,
+ class_name: "androidx.activity.ComponentActivity",
+ method_name: "setContentView",
+ overload_index: 0,
+ };
+ const overloadedCli = await execute(
+ process.execPath,
+ [
+ entrypoint,
+ "trace-android-references",
+ path,
+ overloadedInput.class_name,
+ "--method-name",
+ overloadedInput.method_name,
+ "--overload-index",
+ "0",
+ "--format",
+ "json",
+ ],
+ {
+ cwd: repository,
+ env: environment,
+ timeout: 150_000,
+ maxBuffer: 8 * 1024 * 1024,
+ },
+ );
+ const overloadedEvidence = parseEvidence(JSON.parse(overloadedCli.stdout));
+ assert.equal(overloadedEvidence.normalized_result.overload_index, 0);
+ assert.equal(
+ overloadedEvidence.normalized_result.reported_signature,
+ "setContentView(int): void",
+ );
+ assert.equal(overloadedEvidence.normalized_result.total, 1);
+ const overloadedMcp = await client.callTool(
+ { name: "trace_android_references", arguments: overloadedInput },
+ { timeout: 150_000 },
+ );
+ assert.notEqual(overloadedMcp.isError, true, JSON.stringify(overloadedMcp));
+ assert.deepEqual(
+ parseEvidence(overloadedMcp.structuredContent).normalized_result,
+ overloadedEvidence.normalized_result,
+ );
+ console.log("PASS real overloaded method references through CLI/MCP");
} catch (cause) {
process.stderr.write(stderr);
throw cause;
@@ -205,7 +249,7 @@ assert.equal(method.body_status, "available");
assert.equal(method.source.status, "complete");
assert.ok(method.source.text.includes("getIntent()"));
assert.ok(method.source.text.includes("setListAdapter"));
-assert.equal(method.method.dex_descriptor, null);
+assert.equal(method.method.dex_descriptor, "(Landroid/os/Bundle;)V");
const references = cliResults.get("trace_android_references").normalized_result;
assert.ok(references.total > 0);
assert.ok(
@@ -264,3 +308,8 @@ if (process.env.REA_ANDROID_REPORT !== undefined)
JSON.stringify(report, null, 2) + "\n",
);
console.log(JSON.stringify(report, null, 2));
+assert.notEqual(
+ windowsLifecycle?.cli_abrupt_owner_exit_workspace_cleanup,
+ false,
+ "Android workspace remained after abrupt owner exit",
+);
diff --git a/scripts/verify/android/direct-invokes.mjs b/scripts/verify/android/direct-invokes.mjs
new file mode 100644
index 000000000..7cb9972db
--- /dev/null
+++ b/scripts/verify/android/direct-invokes.mjs
@@ -0,0 +1,112 @@
+import assert from "node:assert/strict";
+import { Client } from "@modelcontextprotocol/client";
+import { StdioClientTransport } from "@modelcontextprotocol/client/stdio";
+import { parseEvidence } from "../../../dist/domain/evidence.js";
+import { hashAndroidFile } from "./digest.mjs";
+
+/** The public result keeps one using node and exposes its two raw DEX invokes. */
+export const verifyAndroidDirectInvokes = async ({
+ apk,
+ dexEntry,
+ repository,
+ entrypoint,
+ environment,
+ execute,
+}) => {
+ const digest = await hashAndroidFile(apk);
+ const check = (value) => {
+ const evidence = parseEvidence(value);
+ assert.equal(evidence.subject.digest.sha256, digest);
+ assert.equal(evidence.operation, "trace_android_references");
+ const result = evidence.normalized_result;
+ assert.equal(result.class_name, "fixture.Target");
+ assert.equal(result.method_name, "mark");
+ assert.equal(result.dex_descriptor, "()V");
+ assert.equal(result.reference_unit, "using_node");
+ assert.equal(result.total, 1);
+ assert.equal(result.references.length, 1);
+ const source = result.references[0];
+ assert.equal(source.reported_full_name, "fixture.Caller.twice");
+ assert.deepEqual(
+ source.direct_invokes.map((site) => site.dex_code_unit_offset),
+ [0, 3],
+ );
+ for (const site of source.direct_invokes) {
+ assert.equal(site.dex_entry, dexEntry);
+ assert.equal(site.source_raw_method_id, "fixture.Caller.twice()V");
+ assert.equal(site.opcode, "INVOKE_STATIC");
+ }
+ assert.equal(
+ source.direct_invokes[0].dex_method_index,
+ source.direct_invokes[1].dex_method_index,
+ );
+ return evidence;
+ };
+ const cliResponse = await execute(
+ process.execPath,
+ [
+ entrypoint,
+ "trace-android-references",
+ apk,
+ "fixture.Target",
+ "--method-name",
+ "mark",
+ "--format",
+ "json",
+ ],
+ {
+ cwd: repository,
+ env: environment,
+ timeout: 150_000,
+ maxBuffer: 8 * 1024 * 1024,
+ },
+ );
+ const cli = check(JSON.parse(cliResponse.stdout));
+ const transport = new StdioClientTransport({
+ command: process.execPath,
+ args: [entrypoint, "mcp"],
+ cwd: repository,
+ env: environment,
+ stderr: "pipe",
+ });
+ let stderr = "";
+ transport.stderr?.on("data", (chunk) => {
+ stderr += chunk.toString();
+ });
+ const client = new Client({
+ name: "rea-real-android-direct-invokes",
+ version: "1",
+ });
+ try {
+ await client.connect(transport, { timeout: 30_000 });
+ const response = await client.callTool(
+ {
+ name: "trace_android_references",
+ arguments: {
+ path: apk,
+ class_name: "fixture.Target",
+ method_name: "mark",
+ },
+ },
+ { timeout: 150_000 },
+ );
+ assert.notEqual(response.isError, true, JSON.stringify(response));
+ const mcp = check(response.structuredContent);
+ assert.deepEqual(mcp.normalized_result, cli.normalized_result);
+ assert.deepEqual(mcp.parameters, cli.parameters);
+ assert.deepEqual(mcp.provider, cli.provider);
+ } catch (cause) {
+ process.stderr.write(stderr);
+ throw cause;
+ } finally {
+ await client.close();
+ }
+ assert.equal(
+ await hashAndroidFile(apk),
+ digest,
+ "Static inspection changed fixture bytes",
+ );
+ console.log(
+ `PASS real CLI/MCP direct-invoke offsets from ${dexEntry}, parity and unchanged APK`,
+ );
+};
diff --git a/scripts/verify/android/metadata.mjs b/scripts/verify/android/metadata.mjs
index eebcaf812..a44da336c 100644
--- a/scripts/verify/android/metadata.mjs
+++ b/scripts/verify/android/metadata.mjs
@@ -3,6 +3,7 @@ import { mkdtemp, rm } from "node:fs/promises";
import { tmpdir } from "node:os";
import { delimiter, join, resolve } from "node:path";
import { verifyAndroidInitializers } from "./initializers.mjs";
+import { verifyAndroidDirectInvokes } from "./direct-invokes.mjs";
/** Prove cold metadata stays unmaterialized and overload identities survive code generation. */
export const verifyAndroidMetadata = async ({
@@ -60,6 +61,7 @@ export const verifyAndroidMetadata = async ({
apk,
resolve(repository, "tests/fixtures/android/static-initializers"),
classes,
+ resolve(repository, "tests/fixtures/android/direct-invokes"),
],
{ timeout: 120_000, maxBuffer: 8 * 1024 * 1024 },
);
@@ -71,12 +73,19 @@ export const verifyAndroidMetadata = async ({
result.stdout,
/INITIALIZER_REGRESSION_PASS folded=2 bounded=true/u,
);
+ assert.match(
+ result.stdout,
+ /DIRECT_INVOKE_REGRESSION_PASS nodes=1 offsets=0,3 cross_dex=true/u,
+ );
console.log(
"PASS real cold metadata, full generic types and stable overloaded method selection",
);
console.log(
"PASS real folded and mixed static initializers, absent bodies and bounded smali",
);
+ console.log(
+ "PASS real raw DEX direct-invoke offsets and cross-DEX source identity",
+ );
await verifyAndroidInitializers({
apk: resolve(classes, "initializers.apk"),
repository,
@@ -84,6 +93,22 @@ export const verifyAndroidMetadata = async ({
environment,
execute,
});
+ await verifyAndroidDirectInvokes({
+ apk: resolve(classes, "direct-invokes.apk"),
+ dexEntry: "classes.dex",
+ repository,
+ entrypoint,
+ environment,
+ execute,
+ });
+ await verifyAndroidDirectInvokes({
+ apk: resolve(classes, "direct-invokes-multidex.apk"),
+ dexEntry: "classes2.dex",
+ repository,
+ entrypoint,
+ environment,
+ execute,
+ });
} finally {
await rm(classes, { recursive: true, force: true });
}
diff --git a/scripts/verify/android/windows-guardian-isolation.mjs b/scripts/verify/android/windows-guardian-isolation.mjs
new file mode 100644
index 000000000..1a6308970
--- /dev/null
+++ b/scripts/verify/android/windows-guardian-isolation.mjs
@@ -0,0 +1,105 @@
+import assert from "node:assert/strict";
+import { spawn } from "node:child_process";
+import { stat, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+import { createInterface } from "node:readline";
+import { setTimeout as delay } from "node:timers/promises";
+import { fileURLToPath } from "node:url";
+import { createJadxWorkspaceRoot } from "../../../dist/android/JadxWorkspaceRoot.js";
+
+const source = fileURLToPath(import.meta.url);
+const marker = "REA synthetic guardian isolation test\n";
+const exists = (path) =>
+ stat(path).then(
+ () => true,
+ () => false,
+ );
+
+if (process.argv[1] === source && process.argv[2] === "owner") {
+ const root = await createJadxWorkspaceRoot();
+ await writeFile(join(root.path, "synthetic.txt"), marker);
+ process.stdout.write(JSON.stringify({ path: root.path }) + "\n");
+ await new Promise(() => {});
+}
+
+const bounded = async (promise, milliseconds, label) => {
+ let timer;
+ try {
+ return await Promise.race([
+ promise,
+ new Promise((_, reject) => {
+ timer = setTimeout(() => reject(new Error(label)), milliseconds);
+ }),
+ ]);
+ } finally {
+ clearTimeout(timer);
+ }
+};
+
+const launch = async () => {
+ const child = spawn(process.execPath, [source, "owner"], {
+ stdio: ["ignore", "pipe", "pipe"],
+ windowsHide: true,
+ });
+ let stderr = "";
+ child.stderr.on("data", (chunk) => {
+ stderr = (stderr + chunk.toString()).slice(-8192);
+ });
+ const exit = new Promise((resolve, reject) => {
+ child.once("close", resolve);
+ child.once("error", reject);
+ });
+ const lines = createInterface({ input: child.stdout, crlfDelay: Infinity });
+ try {
+ const ready = await bounded(
+ lines[Symbol.asyncIterator]().next(),
+ 20000,
+ `Android guardian owner readiness timed out: ${stderr}`,
+ );
+ assert.equal(ready.done, false, stderr);
+ const { path } = JSON.parse(ready.value);
+ assert.equal(typeof path, "string");
+ assert.equal(await exists(join(path, "synthetic.txt")), true);
+ return { child, exit, path };
+ } catch (cause) {
+ child.kill();
+ await bounded(exit, 15000, "Android guardian owner did not exit");
+ throw cause;
+ }
+};
+
+const stop = async ({ child, exit, path }) => {
+ assert.equal(child.kill(), true);
+ await bounded(exit, 15000, "Android guardian owner did not exit");
+ for (let attempt = 0; attempt < 100; attempt++) {
+ if (!(await exists(path))) return;
+ await delay(100);
+ }
+ throw new Error(`Android guardian retained ${path} after owner death`);
+};
+
+/** Two independent owners must never delete one another's private workspace. */
+export async function verifyWindowsGuardianIsolation() {
+ assert.equal(process.platform, "win32");
+ const first = await launch();
+ let second;
+ try {
+ second = await launch();
+ assert.notEqual(first.path, second.path);
+ await stop(first);
+ assert.equal(
+ await exists(join(second.path, "synthetic.txt")),
+ true,
+ "First owner deleted the second owner's workspace",
+ );
+ await stop(second);
+ console.log("PASS Windows Android guardian two-owner cleanup isolation");
+ } finally {
+ for (const owner of [first, second]) {
+ if (owner === undefined) continue;
+ if (owner.child.exitCode === null && owner.child.signalCode === null)
+ owner.child.kill();
+ await bounded(owner.exit, 15000, "Android guardian owner did not exit");
+ }
+ }
+}
diff --git a/scripts/verify/android/windows-lifecycle.mjs b/scripts/verify/android/windows-lifecycle.mjs
index 5c1a9c02d..d2b281c60 100644
--- a/scripts/verify/android/windows-lifecycle.mjs
+++ b/scripts/verify/android/windows-lifecycle.mjs
@@ -17,6 +17,7 @@ import {
resolveJadxConfigurationInputs,
validateJadxConfiguration,
} from "../../../dist/android/JadxConfiguration.js";
+import { verifyWindowsGuardianIsolation } from "./windows-guardian-isolation.mjs";
/** Verify real Windows cancellation, disconnect and abrupt CLI owner exit. */
export async function verifyWindowsAndroidLifecycle(options) {
@@ -24,15 +25,16 @@ export async function verifyWindowsAndroidLifecycle(options) {
await verifyJavaSelection(options.environment);
const cancellation = await verifyMcp(options, "cancel");
await verifyMcp(options, "disconnect");
- await verifyCliOwnerExit(options);
+ const abruptWorkspaceRemoved = await verifyCliOwnerExit(options);
+ await verifyWindowsGuardianIsolation();
return {
mcp_cancelled_engine_exited: true,
mcp_cancelled_workspace_removed: true,
mcp_ping_and_next_call: true,
mcp_disconnect_engine_exited: true,
cli_abrupt_owner_exit_engine_exited: true,
- // A forced Windows process exit cannot execute JavaScript workspace cleanup.
- cli_abrupt_owner_exit_workspace_cleanup: false,
+ cli_abrupt_owner_exit_workspace_cleanup: abruptWorkspaceRemoved,
+ guardian_two_owner_isolation: true,
observed_resources: cancellation,
java_home_and_quoted_case_insensitive_path: true,
};
@@ -161,6 +163,7 @@ async function verifyCliOwnerExit({
path,
repository,
}) {
+ const baseline = new Set(await runtimeRoots());
const child = spawn(
process.execPath,
[entrypoint, "inspect-android-package", path, "--format", "json"],
@@ -185,7 +188,40 @@ async function verifyCliOwnerExit({
await deadline(exited, 15000);
await observer.verifyExit();
assert.equal(output, "", "Aborted CLI published successful Evidence");
- console.log("PASS Windows CLI abrupt owner exit: real Java job cleanup");
+ const created = (await runtimeRoots()).filter(
+ (name) => !baseline.has(name),
+ );
+ assert.ok(
+ created.length <= 1,
+ "Concurrent Android workspaces make abrupt cleanup observation ambiguous",
+ );
+ if (created.length === 0) {
+ console.log(
+ "PASS Windows CLI abrupt owner exit: real Java job and workspace cleanup",
+ );
+ return true;
+ }
+ const ownedName = created[0];
+ try {
+ await waitFor(
+ async () => !(await runtimeRoots()).includes(ownedName),
+ 5000,
+ "Android workspace remained after abrupt owner exit",
+ );
+ } catch (cause) {
+ if (
+ !(cause instanceof Error) ||
+ cause.message !== "Android workspace remained after abrupt owner exit"
+ )
+ throw cause;
+ }
+ const removed = !(await runtimeRoots()).includes(ownedName);
+ console.log(
+ removed
+ ? "PASS Windows CLI abrupt owner exit: real Java job and workspace cleanup"
+ : "OBSERVED Windows CLI abrupt owner exit: Java job cleaned, workspace residue remains",
+ );
+ return removed;
} finally {
if (child.exitCode === null && child.signalCode === null) child.kill();
await deadline(exited, 15000);
diff --git a/scripts/verify/firmware/analysis.mjs b/scripts/verify/firmware/analysis.mjs
index 1f84681c9..804e8fffa 100644
--- a/scripts/verify/firmware/analysis.mjs
+++ b/scripts/verify/firmware/analysis.mjs
@@ -1,15 +1,8 @@
import assert from "node:assert/strict";
import { execFile } from "node:child_process";
-import {
- access,
- mkdir,
- mkdtemp,
- readFile,
- rm,
- symlink,
-} from "node:fs/promises";
+import * as fs from "node:fs/promises";
import { tmpdir } from "node:os";
-import { dirname, join, resolve } from "node:path";
+import * as nodePath from "node:path";
import { fileURLToPath } from "node:url";
import { promisify } from "node:util";
import { Client } from "@modelcontextprotocol/client";
@@ -18,247 +11,348 @@ import { firmwareResultSchemas } from "../../../dist/domain/firmware/firmwareAna
import { parseEvidence } from "../../../dist/domain/evidence.js";
import { hashFirmwareFile } from "../../../dist/firmware/FirmwareFiles.js";
-const exec = promisify(execFile);
-const repository = resolve(dirname(fileURLToPath(import.meta.url)), "../../..");
-const entrypoint = resolve(
+const execFileAsync = promisify(execFile);
+const { join, resolve, dirname } = nodePath;
+
+const CALL_TIMEOUT_MS = 150_000;
+const CONNECT_TIMEOUT_MS = 30_000;
+const SEVENZIP_TIMEOUT_MS = 10_000;
+const MAX_STDOUT_BYTES = 16 * 1024 * 1024;
+
+const REPO_ROOT = resolve(dirname(fileURLToPath(import.meta.url)), "../../..");
+const ENTRYPOINT = resolve(
process.env.REA_FIRMWARE_TEST_ENTRYPOINT ??
- join(repository, "scripts/rea.mjs"),
+ join(REPO_ROOT, "scripts/rea.mjs"),
);
-if (process.platform !== "linux")
- throw new Error(
- "verify:firmware requires Linux; other hosts are not verified",
- );
-for (const variable of ["REA_BINWALK_COMMAND", "REA_UNBLOB_COMMAND"]) {
- const path = process.env[variable];
- if (path === undefined)
- throw new Error(
- `verify:firmware requires ${variable}; see docs/firmware-analysis.md`,
- );
- await access(path);
-}
-try {
- await exec("7z", ["i"], { timeout: 10_000 });
-} catch (cause) {
- throw new Error(
- "verify:firmware prerequisite unavailable: Unblob's gzip/USTAR fixture extraction requires 7z on PATH",
- { cause },
- );
-}
-const fixtureRoot = resolve(
+const FIXTURE_ROOT = resolve(
process.env.REA_FIRMWARE_FIXTURE_ROOT ??
- join(repository, "_reference/firmware-integration/generated"),
+ join(REPO_ROOT, "_reference/firmware-integration/generated"),
);
-await access(join(fixtureRoot, "oracle.json")).catch((cause) => {
- throw new Error(
- "verify:firmware requires generated fixtures; run npm run fixtures:firmware",
- { cause },
- );
-});
+
+// ---------------------------------------------------------------------------
+// Prerequisite checks
+// ---------------------------------------------------------------------------
+
+async function checkPrerequisites() {
+ if (process.platform !== "linux") {
+ throw new Error(
+ "verify:firmware requires Linux; other hosts are not verified",
+ );
+ }
+
+ for (const name of ["REA_BINWALK_COMMAND", "REA_UNBLOB_COMMAND"]) {
+ const value = process.env[name];
+ if (value === undefined) {
+ throw new Error(
+ `verify:firmware requires ${name}; see docs/firmware-analysis.md`,
+ );
+ }
+ await fs.access(value);
+ }
+
+ try {
+ await execFileAsync("7z", ["i"], { timeout: SEVENZIP_TIMEOUT_MS });
+ } catch (cause) {
+ throw new Error(
+ "verify:firmware prerequisite unavailable: Unblob's gzip/USTAR fixture extraction requires 7z on PATH",
+ { cause },
+ );
+ }
+
+ try {
+ await fs.access(join(FIXTURE_ROOT, "oracle.json"));
+ } catch (cause) {
+ throw new Error(
+ "verify:firmware requires generated fixtures; run npm run fixtures:firmware",
+ { cause },
+ );
+ }
+}
+
+await checkPrerequisites();
+
+// ---------------------------------------------------------------------------
+// Shared state
+// ---------------------------------------------------------------------------
+
const oracle = JSON.parse(
- await readFile(join(fixtureRoot, "oracle.json"), "utf8"),
+ await fs.readFile(join(FIXTURE_ROOT, "oracle.json"), "utf8"),
);
-const path = join(fixtureRoot, "firmware.bin");
-assert.equal(await hashFirmwareFile(path), oracle.sha256);
-const root = await mkdtemp(join(tmpdir(), "rea-real-firmware-"));
-const environment = Object.fromEntries(
- Object.entries(process.env).filter(([, value]) => value !== undefined),
+const firmwarePath = join(FIXTURE_ROOT, "firmware.bin");
+assert.equal(await hashFirmwareFile(firmwarePath), oracle.sha256);
+
+const workDir = await fs.mkdtemp(join(tmpdir(), "rea-real-firmware-"));
+const baseEnv = Object.fromEntries(
+ Object.entries(process.env).filter(([, v]) => v !== undefined),
);
-const client = new Client({ name: "rea-real-firmware-verifier", version: "1" });
-const cli = async (args, env = environment) => {
- const response = await exec(
+const mcpClient = new Client({
+ name: "rea-real-firmware-verifier",
+ version: "1",
+});
+
+// ---------------------------------------------------------------------------
+// Invocation helpers
+// ---------------------------------------------------------------------------
+
+async function runCli(args, env = baseEnv) {
+ const { stdout } = await execFileAsync(
process.execPath,
- [entrypoint, ...args, "--format", "json"],
+ [ENTRYPOINT, ...args, "--format", "json"],
{
env,
- cwd: repository,
- timeout: 150_000,
- maxBuffer: 16 * 1024 * 1024,
+ cwd: REPO_ROOT,
+ timeout: CALL_TIMEOUT_MS,
+ maxBuffer: MAX_STDOUT_BYTES,
},
);
- return parseEvidence(JSON.parse(response.stdout));
-};
-const call = async (name, args) => {
- const response = await client.callTool(
+ return parseEvidence(JSON.parse(stdout));
+}
+
+async function callTool(name, args) {
+ const result = await mcpClient.callTool(
{ name, arguments: args },
- { timeout: 150_000 },
+ { timeout: CALL_TIMEOUT_MS },
);
- assert.notEqual(response.isError, true, JSON.stringify(response));
- assert.ok(response.structuredContent !== undefined);
- return response.structuredContent;
-};
-const verifyRegions = (evidence) => {
+ assert.notEqual(result.isError, true, JSON.stringify(result));
+ assert.ok(result.structuredContent !== undefined);
+ return result.structuredContent;
+}
+
+// ---------------------------------------------------------------------------
+// Result verifiers
+// ---------------------------------------------------------------------------
+
+function verifyRegions(evidence) {
assert.equal(evidence.subject.digest.sha256, oracle.sha256);
- const result = firmwareResultSchemas.inspect_firmware_regions.parse(
+
+ const parsed = firmwareResultSchemas.inspect_firmware_regions.parse(
evidence.normalized_result,
);
- const gzip = result.regions.find(
- (region) => region.signature === "gzip" && region.offset === oracle.offset,
+
+ const gzipRegion = parsed.regions.find(
+ (r) => r.signature === "gzip" && r.offset === oracle.offset,
);
assert.ok(
- gzip !== undefined,
+ gzipRegion !== undefined,
"Binwalk must find the independently generated gzip offset",
);
- assert.equal(gzip.reported_size, oracle.length);
- assert.equal(gzip.size_basis, "provider_reported_validation_unknown");
- return result.regions.map(
- ({ provider_id: _provider_id, ...region }) => region,
- );
-};
-const verifyFiles = async (evidence) => {
- const result = firmwareResultSchemas.extract_firmware.parse(
+ assert.equal(gzipRegion.reported_size, oracle.length);
+ assert.equal(gzipRegion.size_basis, "provider_reported_validation_unknown");
+
+ // Strip provider-specific ids so CLI and MCP results compare equal.
+ return parsed.regions.map((region) => {
+ const { provider_id: _ignored, ...rest } = region;
+ return rest;
+ });
+}
+
+async function verifyFiles(evidence) {
+ const parsed = firmwareResultSchemas.extract_firmware.parse(
evidence.normalized_result,
);
- assert.ok(result.chunks.some((chunk) => chunk.handler === "gzip"));
+
+ assert.ok(parsed.chunks.some((c) => c.handler === "gzip"));
+
for (const [suffix, expected] of Object.entries(oracle.files)) {
- const file = result.files.find((candidate) =>
- candidate.relative_path.endsWith(`/${suffix}`),
+ const entry = parsed.files.find((f) =>
+ f.relative_path.endsWith(`/${suffix}`),
);
- assert.ok(file !== undefined, `Missing extracted ${suffix}`);
- assert.equal(file.sha256, expected.sha256);
- assert.equal(file.size, expected.size);
- assert.equal(await hashFirmwareFile(file.path), expected.sha256);
- assert.equal(file.original_file_range, null);
- assert.equal(file.runtime_address, null);
+ assert.ok(entry !== undefined, `Missing extracted ${suffix}`);
+ assert.equal(entry.sha256, expected.sha256);
+ assert.equal(entry.size, expected.size);
+ assert.equal(await hashFirmwareFile(entry.path), expected.sha256);
+ assert.equal(entry.original_file_range, null);
+ assert.equal(entry.runtime_address, null);
}
- return result;
-};
-try {
- const inspected = await cli(["inspect-firmware-regions", path]);
- const cliRegions = verifyRegions(inspected);
- const extracted = await cli([
- "extract-firmware",
- path,
- join(root, "cli-output"),
+
+ return parsed;
+}
+
+const toContentIdentity = (parsed) =>
+ parsed.files.map(({ relative_path, sha256, size }) => ({
+ relative_path,
+ sha256,
+ size,
+ }));
+
+// ---------------------------------------------------------------------------
+// Verification stages
+// ---------------------------------------------------------------------------
+
+async function stageCli() {
+ const regionsEvidence = await runCli([
+ "inspect-firmware-regions",
+ firmwarePath,
]);
- const cliFiles = await verifyFiles(extracted);
- assert.equal(cliFiles.coverage, "partial");
+ const regions = verifyRegions(regionsEvidence);
+
+ const extractEvidence = await runCli([
+ "extract-firmware",
+ firmwarePath,
+ join(workDir, "cli-output"),
+ ]);
+ const files = await verifyFiles(extractEvidence);
+
+ assert.equal(files.coverage, "partial");
assert.ok(
- cliFiles.chunks.some(
- (chunk) =>
- chunk.handler === null &&
- chunk.range.offset === 0 &&
- chunk.range.length === 64,
+ files.chunks.some(
+ (c) =>
+ c.handler === null && c.range.offset === 0 && c.range.length === 64,
),
);
- await client.connect(
- new StdioClientTransport({
- command: process.execPath,
- args: [entrypoint, "mcp"],
- cwd: repository,
- env: environment,
- stderr: "pipe",
- }),
- { timeout: 30_000 },
- );
- const inspectedMcp = await call("inspect_firmware_regions", { path });
- const mcpEvidence = parseEvidence(inspectedMcp);
- assert.deepEqual(verifyRegions(mcpEvidence), cliRegions);
- const extractedMcp = await call("extract_firmware", {
- path,
- output_directory: join(root, "mcp-output"),
+
+ return { regions, files };
+}
+
+async function connectMcp() {
+ const transport = new StdioClientTransport({
+ command: process.execPath,
+ args: [ENTRYPOINT, "mcp"],
+ cwd: REPO_ROOT,
+ env: baseEnv,
+ stderr: "pipe",
});
- const mcpFiles = await verifyFiles(parseEvidence(extractedMcp));
- const contentIdentity = (result) =>
- result.files.map(({ relative_path, sha256, size }) => ({
- relative_path,
- sha256,
- size,
- }));
- assert.deepEqual(contentIdentity(mcpFiles), contentIdentity(cliFiles));
- const selected = await call("extract_firmware", {
- path,
- output_directory: join(root, "selected-output"),
+ await mcpClient.connect(transport, { timeout: CONNECT_TIMEOUT_MS });
+}
+
+async function stageMcp(cli) {
+ const regionsRaw = await callTool("inspect_firmware_regions", {
+ path: firmwarePath,
+ });
+ assert.deepEqual(verifyRegions(parseEvidence(regionsRaw)), cli.regions);
+
+ const extractRaw = await callTool("extract_firmware", {
+ path: firmwarePath,
+ output_directory: join(workDir, "mcp-output"),
+ });
+ const mcpFiles = await verifyFiles(parseEvidence(extractRaw));
+ assert.deepEqual(toContentIdentity(mcpFiles), toContentIdentity(cli.files));
+
+ const rangedRaw = await callTool("extract_firmware", {
+ path: firmwarePath,
+ output_directory: join(workDir, "selected-output"),
range: { offset: oracle.offset, length: oracle.length },
});
- const selectedFiles = await verifyFiles(parseEvidence(selected));
- assert.equal(selectedFiles.selection.offset, oracle.offset);
- assert.equal(selectedFiles.selection.length, oracle.length);
- const depth = await call("extract_firmware", {
- path,
- output_directory: join(root, "depth-output"),
+ const ranged = await verifyFiles(parseEvidence(rangedRaw));
+ assert.equal(ranged.selection.offset, oracle.offset);
+ assert.equal(ranged.selection.length, oracle.length);
+
+ const depthRaw = await callTool("extract_firmware", {
+ path: firmwarePath,
+ output_directory: join(workDir, "depth-output"),
max_depth: 1,
});
- const depthResult = firmwareResultSchemas.extract_firmware.parse(
- depth.normalized_result,
+ const depthParsed = firmwareResultSchemas.extract_firmware.parse(
+ depthRaw.normalized_result,
);
- assert.equal(depthResult.coverage, "partial");
- assert.ok(depthResult.depth_limited_paths.length > 0);
+ assert.equal(depthParsed.coverage, "partial");
+ assert.ok(depthParsed.depth_limited_paths.length > 0);
+
console.log(
"PASS real Binwalk/Unblob: CLI, MCP, independent offsets/digests, range extraction, unknown chunks and depth limits",
);
- if (process.env.REA_FIRMWARE_VERIFY_EXT4 === "1") {
- const ext4 = join(fixtureRoot, "ext4.bin");
- await access(ext4);
- const response = await call("extract_firmware", {
- path: ext4,
- output_directory: join(root, "ext4-output"),
- });
- const result = firmwareResultSchemas.extract_firmware.parse(
- response.normalized_result,
+
+ return mcpFiles;
+}
+
+async function stageExt4() {
+ const ext4Path = join(FIXTURE_ROOT, "ext4.bin");
+ await fs.access(ext4Path);
+
+ const raw = await callTool("extract_firmware", {
+ path: ext4Path,
+ output_directory: join(workDir, "ext4-output"),
+ });
+ const parsed = firmwareResultSchemas.extract_firmware.parse(
+ raw.normalized_result,
+ );
+ assert.ok(parsed.chunks.some((c) => c.handler === "extfs"));
+ assert.equal(parsed.coverage, "complete");
+
+ for (const [suffix, expected] of Object.entries(oracle.files)) {
+ const match = parsed.files.find((f) =>
+ f.relative_path.endsWith(`/${suffix}`),
);
- assert.ok(result.chunks.some((chunk) => chunk.handler === "extfs"));
- assert.equal(result.coverage, "complete");
- for (const [suffix, expected] of Object.entries(oracle.files))
- assert.equal(
- result.files.find((file) => file.relative_path.endsWith(`/${suffix}`))
- ?.sha256,
- expected.sha256,
- );
- console.log("PASS real ext4 extraction with debugfs; no mounts");
- // Preserve the process-ownership utility while withholding all extractors.
- const withoutExtractors = join(root, "without-extractors");
- await access("/bin/ps");
- await mkdir(withoutExtractors);
- await symlink("/bin/ps", join(withoutExtractors, "ps"));
- const missing = await cli(
- ["extract-firmware", ext4, join(root, "missing-extractor-output")],
- { ...environment, PATH: withoutExtractors },
- );
- const partial = firmwareResultSchemas.extract_firmware.parse(
- missing.normalized_result,
- );
- assert.equal(partial.coverage, "partial");
- assert.ok(JSON.stringify(partial.diagnostics).includes("debugfs"));
- console.log(
- "PASS real missing-extractor diagnostics retained despite Unblob exit 1",
- );
- }
- if (process.env.REA_FIRMWARE_VERIFY_GHIDRA === "1") {
- if (process.env.GHIDRA_INSTALL_DIR === undefined)
- throw new Error(
- "Firmware Ghidra handoff requires GHIDRA_INSTALL_DIR and Java; see docs/ghidra.md",
- );
- const child = mcpFiles.files.find((file) =>
- file.relative_path.endsWith("/usr/bin/probe"),
- );
- assert.ok(child !== undefined);
- await call("open_binary", { path: child.path, provider_id: "ghidra" });
- const dossier = await call("analyze_function", {
- procedure: "firmware_probe",
- });
- const evidence = parseEvidence(dossier);
- assert.equal(
- evidence.subject.digest.sha256,
- oracle.files["usr/bin/probe"].sha256,
- );
- const pseudocode = await call("procedure_pseudo_code", {
- procedure: "firmware_probe",
- });
- assert.equal(parseEvidence(pseudocode).provider.id, "ghidra");
- assert.ok(
- JSON.stringify(evidence.normalized_result).includes("firmware_probe"),
- );
- await call("close_binary", {});
- console.log(
- "PASS real Ghidra handoff of the selected extracted host ELF, bound to its digest",
+ assert.equal(match?.sha256, expected.sha256);
+ }
+ console.log("PASS real ext4 extraction with debugfs; no mounts");
+
+ // Keep the process-ownership utility available but hide every extractor.
+ const emptyBin = join(workDir, "without-extractors");
+ await fs.access("/bin/ps");
+ await fs.mkdir(emptyBin);
+ await fs.symlink("/bin/ps", join(emptyBin, "ps"));
+
+ const degraded = await runCli(
+ ["extract-firmware", ext4Path, join(workDir, "missing-extractor-output")],
+ { ...baseEnv, PATH: emptyBin },
+ );
+ const degradedParsed = firmwareResultSchemas.extract_firmware.parse(
+ degraded.normalized_result,
+ );
+ assert.equal(degradedParsed.coverage, "partial");
+ assert.ok(JSON.stringify(degradedParsed.diagnostics).includes("debugfs"));
+ console.log(
+ "PASS real missing-extractor diagnostics retained despite Unblob exit 1",
+ );
+}
+
+async function stageGhidra(mcpFiles) {
+ if (process.env.GHIDRA_INSTALL_DIR === undefined) {
+ throw new Error(
+ "Firmware Ghidra handoff requires GHIDRA_INSTALL_DIR and Java; see docs/ghidra.md",
);
}
+
+ const probe = mcpFiles.files.find((f) =>
+ f.relative_path.endsWith("/usr/bin/probe"),
+ );
+ assert.ok(probe !== undefined);
+
+ await callTool("open_binary", { path: probe.path, provider_id: "ghidra" });
+
+ const dossierRaw = await callTool("analyze_function", {
+ procedure: "firmware_probe",
+ });
+ const dossier = parseEvidence(dossierRaw);
assert.equal(
- await hashFirmwareFile(path),
+ dossier.subject.digest.sha256,
+ oracle.files["usr/bin/probe"].sha256,
+ );
+
+ const pseudoRaw = await callTool("procedure_pseudo_code", {
+ procedure: "firmware_probe",
+ });
+ assert.equal(parseEvidence(pseudoRaw).provider.id, "ghidra");
+ assert.ok(
+ JSON.stringify(dossier.normalized_result).includes("firmware_probe"),
+ );
+
+ await callTool("close_binary", {});
+ console.log(
+ "PASS real Ghidra handoff of the selected extracted host ELF, bound to its digest",
+ );
+}
+
+// ---------------------------------------------------------------------------
+// Entry point
+// ---------------------------------------------------------------------------
+
+try {
+ const cli = await stageCli();
+ await connectMcp();
+ const mcpFiles = await stageMcp(cli);
+
+ if (process.env.REA_FIRMWARE_VERIFY_EXT4 === "1") await stageExt4();
+ if (process.env.REA_FIRMWARE_VERIFY_GHIDRA === "1")
+ await stageGhidra(mcpFiles);
+
+ assert.equal(
+ await hashFirmwareFile(firmwarePath),
oracle.sha256,
"Original firmware bytes must remain unchanged",
);
} finally {
- await client.close();
- await rm(root, { recursive: true, force: true });
+ await mcpClient.close();
+ await fs.rm(workDir, { recursive: true, force: true });
}
diff --git a/scripts/website_i18n.py b/scripts/website_i18n.py
index 928594df7..0f93546f0 100644
--- a/scripts/website_i18n.py
+++ b/scripts/website_i18n.py
@@ -25,11 +25,27 @@ LITERALS = {"REA", "Reverse Engineer Anything", "REA · Reverse Engineer Anythin
FALLBACK_NOTICE = "Translation is being updated. Read this page in English for now."
+def readme_edition_paths(root):
+ """Return repo-relative README editions: root English plus docs/readme translations."""
+ editions = set()
+ if (root / "README.md").is_file():
+ editions.add("README.md")
+ folder = root / "docs" / "readme"
+ if folder.is_dir():
+ editions.update(
+ f"docs/readme/{path.name}"
+ for path in folder.glob("README_*.md")
+ if path.is_file()
+ )
+ return editions
+
+
def languages(root):
"""Load the website language inventory and check it against README editions."""
path = root / "website/locales/languages.json"
+ editions = readme_edition_paths(root)
if not path.exists():
- if any(root.glob("README_*.md")):
+ if any(edition != "README.md" for edition in editions):
raise ValueError("Missing languages.json for the translated README editions")
return [{"code": "en", "name": "English", "readme": "README.md", "dir": "ltr"}]
data = json.loads(path.read_text(encoding="utf-8"))
@@ -49,8 +65,7 @@ def languages(root):
raise ValueError(f"Duplicate README edition: {item['readme']}")
codes.add(item["code"])
filenames.add(item["readme"])
- readmes = {path.name for path in root.glob("README*.md")}
- if readmes and ({item["readme"] for item in data} != readmes):
+ if editions and ({item["readme"] for item in data} != editions):
raise ValueError("Website languages must match the README language editions")
return data
diff --git a/src/adb/AdbProvider.test.ts b/src/adb/AdbProvider.test.ts
index ae81353c7..23645e456 100644
--- a/src/adb/AdbProvider.test.ts
+++ b/src/adb/AdbProvider.test.ts
@@ -810,6 +810,36 @@ exit 1`,
expect(result.error.message).toContain("overwrite");
});
+it.each([
+ ["offline", false, "error: device offline"],
+ ["unauthorized", false, "error: device unauthorized"],
+ ["offline", true, "error: device offline"],
+] as const)(
+ "reports the %s device state when the push existence probe cannot run (overwrite %s)",
+ async (state, overwrite, stderr) => {
+ const { binary, root } = await writeAdbStub(
+ (stubRoot) => `if [ "$1" = "version" ]; then ${VERSION_BLOCK}; exit 0; fi
+if [ "$1" = "-s" ]; then printf '%s\\n' "$3" >> "${stubRoot}/calls"; printf '%s\\n' "${stderr}" >&2; exit 1; fi`,
+ );
+ const localFile = join(root, "payload.bin");
+ await writeFile(localFile, "x");
+ const projected = await refusedBy(providerOver(binary), {
+ operation: "push_adb_file",
+ input: {
+ serial: "emulator-5554",
+ local_path: localFile,
+ device_path: "/data/local/tmp/payload.bin",
+ overwrite,
+ },
+ });
+ // Existence is unknown, so nothing is claimed about the path and no push runs.
+ expect(projected).toMatchObject({ code: "unsupported_target" });
+ expect(projected.message).toContain(state);
+ expect(projected.message).not.toContain("already exists");
+ expect(await readFile(join(root, "calls"), "utf8")).toBe("shell\n");
+ },
+);
+
it("reports a local push source that does not exist", async () => {
const { binary } = await writeAdbStub(
() => `if [ "$1" = "version" ]; then ${VERSION_BLOCK}; exit 0; fi
diff --git a/src/adb/AdbProvider.ts b/src/adb/AdbProvider.ts
index b9af6d14f..d26345eba 100644
--- a/src/adb/AdbProvider.ts
+++ b/src/adb/AdbProvider.ts
@@ -1623,17 +1623,15 @@ export class AdbProvider {
{ timeoutMs: SETTINGS_TIMEOUT_MS, maxOutputBytes: 1024 },
signal,
);
- let deviceExists: boolean;
- if (existsProbe.ok) deviceExists = true;
- else if (existsProbe.error instanceof AnalysisProtocolError)
- deviceExists = false;
- else if (existsProbe.error instanceof AnalysisTimeoutError)
+ // `test -e` exits nonzero with no adb diagnosis when the path is absent.
+ // Any other probe failure leaves existence unknown, so it is reported as
+ // is rather than read as an existing path or followed by a push.
+ if (
+ !existsProbe.ok &&
+ !(existsProbe.error instanceof AnalysisProtocolError)
+ )
return existsProbe;
- else if (existsProbe.error instanceof AnalysisCancelledError)
- return existsProbe;
- else if (existsProbe.error instanceof AnalysisResourceConstraintError)
- return existsProbe;
- else deviceExists = true; // authorization/refusal states surface on push instead
+ const deviceExists = existsProbe.ok;
if (deviceExists && !input.overwrite)
return err(
new AnalysisOutputError(
diff --git a/src/android/JadxAnalysis.ts b/src/android/JadxAnalysis.ts
index d8afed20c..502c90a69 100644
--- a/src/android/JadxAnalysis.ts
+++ b/src/android/JadxAnalysis.ts
@@ -45,7 +45,7 @@ const methodsOf = (summary: ClassSummary) => {
reported_signature: method.signature,
overload_index: index,
is_constructor: method.is_constructor,
- dex_descriptor: null,
+ dex_descriptor: method.dex_descriptor,
};
});
};
@@ -314,11 +314,25 @@ const traceReferences = async (
): Promise => {
const methodName = request.input.method_name;
const candidates = matchingMethods(summary, request);
- if (candidates.length > 1)
- throw new AnalysisCapabilityUnavailableError(
- "jadx",
- request.operation,
- `References require a unique method name; ${summary.full_name}.${methodName} has ${candidates.length} overloads. No unambiguous reference result is available.`,
+ if (methodName === undefined && request.input.overload_index !== undefined)
+ inputFailure(
+ request,
+ "overload_index",
+ "Method name is required for an overload index.",
+ );
+ if (candidates.length > 1 && request.input.overload_index === undefined)
+ inputFailure(
+ request,
+ "overload_index",
+ `Select one of ${candidates.length} overloads: ${candidates.map((method) => `${method.overload_index}: ${method.reported_signature}`).join("; ")}`,
+ );
+ const index = request.input.overload_index ?? 0;
+ const selected = methodName === undefined ? undefined : candidates[index];
+ if (methodName !== undefined && selected === undefined)
+ inputFailure(
+ request,
+ "overload_index",
+ `Index ${index} is outside the ${candidates.length} matching overloads.`,
);
const expectedTarget =
methodName === undefined
@@ -329,7 +343,9 @@ const traceReferences = async (
methodName === undefined ? "get_xrefs_to_class" : "get_xrefs_to_method",
{
class_name: summary.full_name,
- ...(methodName === undefined ? {} : { method_name: methodName }),
+ ...(methodName === undefined
+ ? {}
+ : { method_name: methodName, overload_index: index }),
limit: 2_147_483_647,
resolve_line: false,
},
@@ -337,6 +353,9 @@ const traceReferences = async (
);
if (
xrefs.target !== expectedTarget ||
+ (selected !== undefined &&
+ (xrefs.overload_index !== index ||
+ xrefs.reported_signature !== selected.reported_signature)) ||
xrefs.total !== xrefs.count ||
xrefs.count !== xrefs.items.length
)
@@ -348,6 +367,9 @@ const traceReferences = async (
engine,
class_name: summary.full_name,
method_name: methodName ?? null,
+ overload_index: selected?.overload_index ?? null,
+ reported_signature: selected?.reported_signature ?? null,
+ dex_descriptor: selected?.dex_descriptor ?? null,
total: xrefs.total,
references: xrefs.items.map((reference) => ({
kind: reference.kind,
@@ -357,7 +379,10 @@ const traceReferences = async (
top_class: reference.top_class,
source_line: null,
dex_offset: null,
+ direct_invokes: reference.direct_invokes ?? null,
+ direct_invokes_exhaustive: reference.direct_invokes_exhaustive ?? null,
})),
coverage: "complete",
+ reference_unit: "using_node",
});
};
diff --git a/src/android/JadxProtocol.ts b/src/android/JadxProtocol.ts
index 804b7ffa7..22a457b0f 100644
--- a/src/android/JadxProtocol.ts
+++ b/src/android/JadxProtocol.ts
@@ -2,6 +2,7 @@ import { z } from "zod";
import { AnalysisOutputError } from "../domain/analysisErrorCore.js";
import { jsonValueSchema } from "../domain/jsonValue.js";
import type { AndroidOperation } from "../domain/android/androidAnalysis.js";
+import { dexDescriptorSchema } from "../domain/android/androidAnalysis.js";
const count = z.number().int().nonnegative();
/** Selector failures authored by REA's bridge, separate from arbitrary engine errors. */
@@ -50,6 +51,7 @@ export const jadxClassSchema = z.object({
z.object({
name: z.string(),
signature: z.string(),
+ dex_descriptor: dexDescriptorSchema,
is_constructor: z.boolean(),
def_pos: z.number().int(),
}),
@@ -72,6 +74,8 @@ export const jadxMethodSchema = z.object({
});
export const jadxXrefsSchema = z.object({
target: z.string(),
+ overload_index: count.optional(),
+ reported_signature: z.string().optional(),
total: count,
count,
resolve_line: z.literal(false),
@@ -83,6 +87,18 @@ export const jadxXrefsSchema = z.object({
containing_class: z.string(),
top_class: z.string(),
def_pos: z.number().int(),
+ direct_invokes_exhaustive: z.boolean().optional(),
+ direct_invokes: z
+ .array(
+ z.object({
+ dex_entry: z.string().min(1),
+ source_raw_method_id: z.string().min(1),
+ dex_code_unit_offset: count,
+ dex_method_index: count,
+ opcode: z.string().regex(/^INVOKE_/u),
+ }),
+ )
+ .optional(),
}),
),
});
diff --git a/src/android/JadxProvider.ts b/src/android/JadxProvider.ts
index 6fda5a143..3980ce318 100644
--- a/src/android/JadxProvider.ts
+++ b/src/android/JadxProvider.ts
@@ -18,7 +18,10 @@ import { projectAnalysisError } from "../domain/analysisErrorProjection.js";
import type { AndroidRequest } from "../domain/android/androidAnalysis.js";
import type { BinaryTarget } from "../domain/binaryTargetTypes.js";
import { err, ok, type Result } from "../domain/result.js";
-import { PrivateRuntimeRoot } from "../process/PrivateRuntimeRoot.js";
+import {
+ createJadxWorkspaceRoot,
+ type JadxWorkspaceRoot,
+} from "./JadxWorkspaceRoot.js";
import {
snapshotAndroidEngine,
snapshotAndroidTarget,
@@ -152,7 +155,7 @@ const hashAndroidSource = async (
interface PendingCleanup {
session: JadxSession | undefined;
- root: PrivateRuntimeRoot | undefined;
+ root: JadxWorkspaceRoot | undefined;
readonly previousError: AnalysisError | undefined;
}
@@ -211,7 +214,7 @@ const cleanup = async (
interface RetainedSession {
readonly key: string;
- readonly root: PrivateRuntimeRoot;
+ readonly root: JadxWorkspaceRoot;
readonly session: JadxSession;
readonly snapshot: string;
readonly jarHash: string;
@@ -325,7 +328,7 @@ export class JadxProvider implements AndroidAnalysisPort {
options?.signal === undefined
? timeout
: AbortSignal.any([options.signal, timeout]);
- let root: PrivateRuntimeRoot | undefined;
+ let root: JadxWorkspaceRoot | undefined;
let session: JadxSession | undefined;
try {
if (target.format !== "apk")
@@ -389,20 +392,24 @@ export class JadxProvider implements AndroidAnalysisPort {
request.operation,
signal,
);
- root = await PrivateRuntimeRoot.create({ prefix: "rea-android-" });
+ root = await createJadxWorkspaceRoot();
+ const workspaceSignal =
+ root.failureSignal === undefined
+ ? signal
+ : AbortSignal.any([signal, root.failureSignal]);
const engine = await snapshotAndroidEngine(
configuration.jar,
jarHash,
root.path,
request.operation,
- signal,
+ workspaceSignal,
);
const snapshot = await snapshotAndroidTarget(
target.path,
target.sha256,
root.path,
request.operation,
- signal,
+ workspaceSignal,
);
const bridge = join(root.path, "ReaJadxBridge.java");
await copyFile(BRIDGE_SOURCE, bridge);
@@ -410,7 +417,7 @@ export class JadxProvider implements AndroidAnalysisPort {
const copiedBridgeHash = await hashAndroidSource(
bridge,
request.operation,
- signal,
+ workspaceSignal,
);
if (copiedBridgeHash !== bridgeHash)
throw androidSourceChanged(
@@ -418,7 +425,7 @@ export class JadxProvider implements AndroidAnalysisPort {
BRIDGE_SOURCE,
undefined,
);
- signal.throwIfAborted();
+ workspaceSignal.throwIfAborted();
session = new JadxSession(
{
command: configuration.java,
@@ -430,7 +437,7 @@ export class JadxProvider implements AndroidAnalysisPort {
],
cwd: root.path,
hostEnvironment: this.environment,
- signal,
+ signal: workspaceSignal,
},
this.launcher,
);
@@ -445,6 +452,10 @@ export class JadxProvider implements AndroidAnalysisPort {
}
root = retained.root;
session = retained.session;
+ const activeSignal =
+ root.failureSignal === undefined
+ ? signal
+ : AbortSignal.any([signal, root.failureSignal]);
const { snapshot } = retained;
const outcome = ok(
await session.execute({
@@ -453,10 +464,10 @@ export class JadxProvider implements AndroidAnalysisPort {
snapshot,
jarHash: retained.jarHash,
bridgeHash: retained.bridgeHash,
- signal,
+ signal: activeSignal,
}),
);
- signal.throwIfAborted();
+ activeSignal.throwIfAborted();
this.#retained = retained;
return outcome;
} catch (cause) {
diff --git a/src/android/JadxRelease.ts b/src/android/JadxRelease.ts
index b5b6bd058..8c7d16840 100644
--- a/src/android/JadxRelease.ts
+++ b/src/android/JadxRelease.ts
@@ -25,7 +25,8 @@ export const JADX_PROVIDER_IDENTITY = Object.freeze({
/** Audited engine coverage, kept outside portable Android semantics. */
export const JADX_LIMITATIONS = [
"Static decompiler observations do not establish runtime behavior; the APK is never executed.",
- "Method signatures use provider display types; exact DEX descriptors and instruction offsets are unavailable. Overload indices are local to this engine and artifact.",
+ "Method signatures use provider display types; DEX prototypes come from frozen JADX metadata. Display names may be aliases, and overload indices are local to this engine and artifact.",
"Class inventories use parsed metadata before code generation, including synthetic members that may be omitted from decompiled source. Source positions remain unknown.",
+ "Incoming reference totals count JADX using nodes. Direct invoke entries within a using method report raw DEX code-unit offsets and method indexes, but coverage is limited to those nodes and directly matched invokes; it does not establish every possible dynamic or reflective call site.",
"Manifest summary fields are extracted by the upstream engine; decoded XML is retained for verification. APK signatures, split APKs, native libraries and Android runtime capture are not verified by this provider.",
] as const;
diff --git a/src/android/JadxWorkspaceRoot.ts b/src/android/JadxWorkspaceRoot.ts
new file mode 100644
index 000000000..15b862320
--- /dev/null
+++ b/src/android/JadxWorkspaceRoot.ts
@@ -0,0 +1,224 @@
+import { spawn, type ChildProcessWithoutNullStreams } from "node:child_process";
+import { lstat } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { win32 } from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { z } from "zod";
+
+import { PrivateRuntimeRoot } from "../process/PrivateRuntimeRoot.js";
+
+/** Match the native owner's ordinary spelling only for extended local drive paths. */
+const localDrivePath = (path: string): string =>
+ path.replace(/^\\\\\?\\(?=[A-Za-z]:\\)/u, "");
+
+const guardianSource = fileURLToPath(
+ new URL("../../scripts/rea-android-workspace-guardian.mjs", import.meta.url),
+);
+const readySchema = z.strictObject({
+ path: z.string(),
+ volumeSerial: z.string().regex(/^[a-f0-9]{16}$/u),
+ fileId: z.string().regex(/^[a-f0-9]{32}$/u),
+ privateDacl: z.literal(true),
+});
+
+/** The Android provider needs a path and a cleanup owner, regardless of host. */
+export interface JadxWorkspaceRoot {
+ readonly path: string;
+ readonly failureSignal?: AbortSignal;
+ close(): Promise;
+}
+
+type GuardianExit = {
+ readonly code: number | null;
+ readonly signal: NodeJS.Signals | null;
+ readonly error?: Error;
+};
+
+const boundedWait = async (
+ promise: Promise,
+ milliseconds: number,
+ label: string,
+): Promise => {
+ let timer: NodeJS.Timeout | undefined;
+ try {
+ return await Promise.race([
+ promise,
+ new Promise((_resolve, reject) => {
+ timer = setTimeout(() => reject(new Error(label)), milliseconds);
+ }),
+ ]);
+ } finally {
+ clearTimeout(timer);
+ }
+};
+
+/** A detached guardian retains native cleanup ownership without keeping its caller alive. */
+const releaseGuardianReferences = (
+ child: ChildProcessWithoutNullStreams,
+): void => {
+ child.stdin.destroy();
+ child.stdout.destroy();
+ child.stderr.destroy();
+ child.unref();
+};
+
+class WindowsJadxWorkspaceRoot implements JadxWorkspaceRoot {
+ readonly #failure = new AbortController();
+ readonly failureSignal = this.#failure.signal;
+ readonly #child: ChildProcessWithoutNullStreams;
+ readonly #exit: Promise;
+ readonly #diagnostics: () => string;
+ #closing = false;
+ #closePromise: Promise | undefined;
+
+ private constructor(
+ readonly path: string,
+ child: ChildProcessWithoutNullStreams,
+ exit: Promise,
+ diagnostics: () => string,
+ ) {
+ this.#child = child;
+ this.#exit = exit;
+ this.#diagnostics = diagnostics;
+ void this.#exit.then((result) => {
+ if (!this.#closing)
+ this.#failure.abort(
+ new Error(
+ `Android workspace guardian exited before cleanup: ${result.error?.message ?? result.code ?? result.signal ?? "unknown"}`,
+ ),
+ );
+ });
+ }
+
+ static async create(): Promise {
+ const parent = tmpdir();
+ const child = spawn(process.execPath, [guardianSource, parent], {
+ detached: true,
+ windowsHide: true,
+ stdio: ["pipe", "pipe", "pipe"],
+ env: {
+ SystemRoot: process.env.SystemRoot,
+ WINDIR: process.env.WINDIR,
+ TEMP: parent,
+ TMP: parent,
+ },
+ });
+ let diagnostics = "";
+ child.stderr.on("data", (chunk: Buffer) => {
+ diagnostics = (diagnostics + chunk.toString()).slice(-8192);
+ });
+ const exit = new Promise((resolve) => {
+ child.once("error", (error: Error) =>
+ resolve({ code: null, signal: null, error }),
+ );
+ child.once("close", (code, signal) => resolve({ code, signal }));
+ });
+ const ready = new Promise((resolve, reject) => {
+ let frame = "";
+ child.stdout.on("data", (chunk: Buffer) => {
+ frame += chunk.toString();
+ if (frame.length > 4096) {
+ reject(
+ new Error("Android workspace guardian readiness exceeded 4 KiB"),
+ );
+ return;
+ }
+ const end = frame.indexOf("\n");
+ if (end !== -1) resolve(frame.slice(0, end));
+ });
+ child.stdout.once("error", reject);
+ });
+ try {
+ const line = await boundedWait(
+ Promise.race([
+ ready,
+ exit.then((result) => {
+ throw new Error(
+ `Android workspace guardian exited during startup: ${result.error?.message ?? result.code ?? result.signal ?? "unknown"}; ${diagnostics}`,
+ );
+ }),
+ ]),
+ 15000,
+ "Android workspace guardian startup timed out",
+ );
+ const observation = readySchema.parse(JSON.parse(line));
+ if (
+ win32.dirname(localDrivePath(observation.path)).toLowerCase() !==
+ localDrivePath(win32.resolve(parent)).toLowerCase() ||
+ !/^rea-android-[a-f0-9]{32}$/u.test(win32.basename(observation.path))
+ )
+ throw new Error(
+ "Android workspace guardian returned an unexpected root",
+ );
+ child.stdout.resume();
+ return new WindowsJadxWorkspaceRoot(
+ observation.path,
+ child,
+ exit,
+ () => diagnostics,
+ );
+ } catch (cause) {
+ if (!child.stdin.destroyed) child.stdin.end();
+ try {
+ await boundedWait(
+ exit,
+ 30000,
+ "Android workspace guardian did not settle after startup failure",
+ );
+ } catch (cleanupFailure) {
+ throw new AggregateError(
+ [cause, cleanupFailure],
+ "Android workspace guardian startup and cleanup failed",
+ );
+ } finally {
+ releaseGuardianReferences(child);
+ }
+ throw cause;
+ }
+ }
+
+ close(): Promise {
+ this.#closing = true;
+ this.#closePromise ??= this.#finish().catch((cause: unknown) => {
+ this.#closePromise = undefined;
+ throw cause;
+ });
+ return this.#closePromise;
+ }
+
+ async #finish(): Promise {
+ if (!this.#child.stdin.destroyed) this.#child.stdin.end();
+ let result: GuardianExit;
+ try {
+ result = await boundedWait(
+ this.#exit,
+ 120000,
+ `Android workspace guardian cleanup timed out for ${this.path}`,
+ );
+ } catch (cause) {
+ releaseGuardianReferences(this.#child);
+ throw cause;
+ }
+ if (result.error !== undefined || result.code !== 0)
+ throw new Error(
+ `Android workspace guardian cleanup failed for ${this.path}: ${result.error?.message ?? result.code ?? result.signal ?? "unknown"}; ${this.#diagnostics()}`,
+ );
+ try {
+ await lstat(this.path);
+ } catch (cause) {
+ if (cause instanceof Error && "code" in cause && cause.code === "ENOENT")
+ return;
+ throw cause;
+ }
+ throw new Error(
+ `Android workspace guardian exited but retained ${this.path}`,
+ );
+ }
+}
+
+/** POSIX retains its in-process root; Windows keeps a detached native owner. */
+export const createJadxWorkspaceRoot = (): Promise =>
+ process.platform === "win32"
+ ? WindowsJadxWorkspaceRoot.create()
+ : PrivateRuntimeRoot.create({ prefix: "rea-android-" });
diff --git a/src/apktool/ApktoolConfiguration.test.ts b/src/apktool/ApktoolConfiguration.test.ts
index d2d84874c..39cf1c652 100644
--- a/src/apktool/ApktoolConfiguration.test.ts
+++ b/src/apktool/ApktoolConfiguration.test.ts
@@ -1,4 +1,4 @@
-import { describe, expect, it } from "vitest";
+import { beforeEach, describe, expect, it, vi } from "vitest";
import {
APKTOOL_COMMAND_ENV,
@@ -10,29 +10,43 @@ import {
resolveApktoolCommand,
} from "./ApktoolConfiguration.js";
+const lookup = vi.hoisted(() => ({ stat: vi.fn() }));
+vi.mock("node:fs/promises", async (importOriginal) => ({
+ ...(await importOriginal()),
+ stat: lookup.stat,
+}));
+beforeEach(() => {
+ lookup.stat
+ .mockReset()
+ .mockRejectedValue(Object.assign(new Error("missing"), { code: "ENOENT" }));
+});
+
describe("resolveApktoolCommand", () => {
- it("prefers an absolute REA_APKTOOL_COMMAND", () => {
+ it("prefers an absolute REA_APKTOOL_COMMAND", async () => {
expect(
- resolveApktoolCommand({
- [APKTOOL_COMMAND_ENV]: "/usr/local/bin/apktool",
- }),
+ await resolveApktoolCommand(
+ {
+ [APKTOOL_COMMAND_ENV]: "/usr/local/bin/apktool",
+ },
+ "linux",
+ ),
).toEqual({
command: "/usr/local/bin/apktool",
commandSource: "environment",
});
});
- it("falls back to PATH resolution without the environment key", () => {
- expect(resolveApktoolCommand({})).toEqual({
+ it("leaves POSIX PATH lookup to process creation", async () => {
+ expect(await resolveApktoolCommand({}, "linux")).toEqual({
command: "apktool",
commandSource: "path",
});
});
- it("rejects a relative environment path explicitly", () => {
- expect(() =>
+ it("rejects a relative environment path explicitly", async () => {
+ await expect(
resolveApktoolCommand({ [APKTOOL_COMMAND_ENV]: "bin/apktool" }),
- ).toThrow(/must be an absolute path/u);
+ ).rejects.toThrow(/must be an absolute path/u);
});
});
@@ -119,3 +133,250 @@ describe("apktoolInvocation", () => {
});
});
});
+
+describe("Windows PATH launcher selection", () => {
+ const environment = {
+ Path: '"C:\\Selected Tools";C:\\Other Tools',
+ PathExt: ".EXE;.CMD;.BAT",
+ ComSpec: "C:\\Windows\\System32\\cmd.exe",
+ NoDefaultCurrentDirectoryInExePath: "",
+ };
+ const files = (...paths: string[]) => {
+ const selected = new Set(paths.map((path) => path.toLowerCase()));
+ lookup.stat.mockImplementation(async (path: string) => {
+ if (selected.has(path.toLowerCase())) return { isFile: () => true };
+ throw Object.assign(new Error("missing"), { code: "ENOENT" });
+ });
+ };
+
+ it.each([".BAT", ".CMD"])(
+ "resolves a default %s launcher before choosing cmd.exe for version and decode",
+ async (extension) => {
+ const command = `C:\\Selected Tools\\apktool${extension}`;
+ files(command);
+ const selection = await resolveApktoolCommand(environment, "win32");
+ expect(selection).toEqual({ command, commandSource: "path" });
+ for (const arguments_ of [
+ ["--version"],
+ ["d", "-o", "C:\\output folder", "C:\\target.apk"],
+ ]) {
+ const invocation = apktoolInvocation(
+ selection,
+ arguments_,
+ environment,
+ "win32",
+ );
+ expect(invocation).toEqual({
+ command: environment.ComSpec,
+ arguments: [
+ "/d",
+ "/e:on",
+ "/v:off",
+ "/s",
+ "/c",
+ `"${[command, ...arguments_].map((token) => `"${token}"`).join(" ")}"`,
+ ],
+ windowsVerbatimArguments: true,
+ });
+ }
+ },
+ );
+
+ it("honors PATH directory order before extension order", async () => {
+ files("C:\\Selected Tools\\apktool.CMD", "C:\\Other Tools\\apktool.EXE");
+ expect(await resolveApktoolCommand(environment, "win32")).toMatchObject({
+ command: "C:\\Selected Tools\\apktool.CMD",
+ });
+ });
+
+ it("honors the selected PATHEXT ordering", async () => {
+ files("C:\\Selected Tools\\apktool.CMD", "C:\\Selected Tools\\apktool.EXE");
+ expect(
+ await resolveApktoolCommand(
+ { ...environment, PathExt: ".CMD;.EXE" },
+ "win32",
+ ),
+ ).toMatchObject({ command: "C:\\Selected Tools\\apktool.CMD" });
+ });
+
+ it("keeps native executable arguments outside cmd.exe interpretation", async () => {
+ const command = "C:\\Selected Tools\\apktool.EXE";
+ files(command);
+ const selection = await resolveApktoolCommand(environment, "win32");
+ const arguments_ = ["d", "C:\\input & literal.apk"];
+ expect(
+ apktoolInvocation(selection, arguments_, environment, "win32"),
+ ).toEqual({
+ command,
+ arguments: arguments_,
+ windowsVerbatimArguments: false,
+ });
+ });
+
+ it("preserves explicit launcher spelling without searching PATH", async () => {
+ const command = "C:\\selected alias\\APKTOOL.cmd";
+ expect(
+ await resolveApktoolCommand(
+ { ...environment, [APKTOOL_COMMAND_ENV]: command },
+ "win32",
+ ),
+ ).toEqual({ command, commandSource: "environment" });
+ expect(lookup.stat).not.toHaveBeenCalled();
+ });
+
+ it("does not inspect the current directory when the caller disables it", async () => {
+ await expect(
+ resolveApktoolCommand(environment, "win32"),
+ ).rejects.toMatchObject({ code: "command_missing" });
+ expect(
+ lookup.stat.mock.calls.every(
+ ([path]) =>
+ String(path).startsWith("C:\\Selected Tools\\") ||
+ String(path).startsWith("C:\\Other Tools\\"),
+ ),
+ ).toBe(true);
+ });
+
+ it("does not turn an explicitly empty PATHEXT into default extensions", async () => {
+ files("C:\\Selected Tools\\apktool.EXE");
+ await expect(
+ resolveApktoolCommand({ ...environment, PathExt: "" }, "win32"),
+ ).rejects.toMatchObject({ code: "command_missing" });
+ expect(lookup.stat).not.toHaveBeenCalled();
+ });
+
+ it("skips directories without treating them as executable launchers", async () => {
+ files("C:\\Other Tools\\apktool.EXE");
+ const stat = lookup.stat.getMockImplementation()!;
+ lookup.stat.mockImplementation(async (path: string) =>
+ path === "C:\\Selected Tools\\apktool.EXE"
+ ? { isFile: () => false }
+ : stat(path),
+ );
+ expect(await resolveApktoolCommand(environment, "win32")).toMatchObject({
+ command: "C:\\Other Tools\\apktool.EXE",
+ });
+ });
+
+ it("preserves inspection failures instead of reporting a missing command or selecting a later file", async () => {
+ lookup.stat.mockRejectedValue(
+ Object.assign(new Error("denied"), { code: "EACCES" }),
+ );
+ const failure = await resolveApktoolCommand(environment, "win32").catch(
+ (cause: unknown) => cause,
+ );
+ expect(failure).toBeInstanceOf(ApktoolConfigurationFailure);
+ if (!(failure instanceof ApktoolConfigurationFailure)) throw failure;
+ expect(failure).toMatchObject({
+ code: "command_unresolved",
+ diagnostics: {
+ candidate_path: "C:\\Selected Tools\\apktool.EXE",
+ filesystem_error: "EACCES",
+ },
+ });
+ expect(apktoolConfigurationAvailability(failure)).toMatchObject({
+ code: "not_configured",
+ });
+ expect(lookup.stat).toHaveBeenCalledTimes(1);
+ });
+
+ it("honors cancellation before inspecting launchers", async () => {
+ const controller = new AbortController();
+ controller.abort();
+ await expect(
+ resolveApktoolCommand(environment, "win32", controller.signal),
+ ).rejects.toMatchObject({ _tag: "AnalysisCancelledError" });
+ expect(lookup.stat).not.toHaveBeenCalled();
+ });
+});
+
+it("does not select a launcher when cancellation arrives during lookup", async () => {
+ const controller = new AbortController();
+ lookup.stat.mockImplementation(async () => {
+ controller.abort();
+ return { isFile: () => true };
+ });
+ await expect(
+ resolveApktoolCommand(
+ {
+ PATH: "C:\\Tools",
+ PATHEXT: ".CMD",
+ NoDefaultCurrentDirectoryInExePath: "1",
+ },
+ "win32",
+ controller.signal,
+ ),
+ ).rejects.toMatchObject({ _tag: "AnalysisCancelledError" });
+ expect(lookup.stat).toHaveBeenCalledTimes(1);
+});
+
+it.each(["EXE", ".CMD\\..\\outside.exe", ".CMD\0"])(
+ "rejects malformed PATHEXT %j before path lookup",
+ async (PATHEXT) => {
+ await expect(
+ resolveApktoolCommand({ PATH: "C:\\Tools", PATHEXT }, "win32"),
+ ).rejects.toMatchObject({
+ code: "command_unresolved",
+ diagnostics: { invalid_extension: PATHEXT },
+ });
+ expect(lookup.stat).not.toHaveBeenCalled();
+ },
+);
+
+it("cancels a pending filesystem lookup and owns its eventual rejection", async () => {
+ const controller = new AbortController();
+ let started!: () => void;
+ let rejectLookup!: (cause: Error) => void;
+ const pendingStat = new Promise((_resolve, reject) => {
+ rejectLookup = reject;
+ });
+ const observed = new Promise((resolve) => {
+ started = resolve;
+ });
+ lookup.stat.mockImplementation(() => {
+ started();
+ return pendingStat;
+ });
+ const pending = resolveApktoolCommand(
+ {
+ PATH: "C:\\Tools",
+ PATHEXT: ".CMD",
+ NODEFAULTCURRENTDIRECTORYINEXEPATH: "1",
+ },
+ "win32",
+ controller.signal,
+ );
+ await observed;
+ controller.abort();
+ await expect(pending).rejects.toMatchObject({
+ _tag: "AnalysisCancelledError",
+ });
+ rejectLookup(new Error("filesystem completed after cancellation"));
+ await Promise.resolve();
+ expect(lookup.stat).toHaveBeenCalledTimes(1);
+});
+
+it("bounds the entire pending PATH lookup by the selection deadline", async () => {
+ vi.useFakeTimers();
+ try {
+ lookup.stat.mockReturnValue(new Promise(() => {}));
+ const failure = expect(
+ resolveApktoolCommand(
+ {
+ PATH: "C:\\Tools",
+ PATHEXT: ".CMD",
+ NODEFAULTCURRENTDIRECTORYINEXEPATH: "1",
+ },
+ "win32",
+ ),
+ ).rejects.toMatchObject({
+ _tag: "AnalysisTimeoutError",
+ timeoutMs: 20_000,
+ });
+ await vi.advanceTimersByTimeAsync(20_000);
+ await failure;
+ expect(lookup.stat).toHaveBeenCalledTimes(1);
+ } finally {
+ vi.useRealTimers();
+ }
+});
diff --git a/src/apktool/ApktoolConfiguration.ts b/src/apktool/ApktoolConfiguration.ts
index 12532b104..b1861f2ac 100644
--- a/src/apktool/ApktoolConfiguration.ts
+++ b/src/apktool/ApktoolConfiguration.ts
@@ -1,5 +1,12 @@
-import { AnalysisCancelledError } from "../domain/analysisErrorCore.js";
-import { isAbsolute } from "node:path";
+import {
+ AnalysisCancelledError,
+ AnalysisTimeoutError,
+} from "../domain/analysisErrorCore.js";
+import { isAbsolute, win32 } from "node:path";
+import { stat } from "node:fs/promises";
+import { snapshotEnvironment } from "../process/snapshotEnvironment.js";
+import { ABORTED, waitForAbortable } from "../process/AbortablePromise.js";
+import { ProviderStartupDeadline } from "../process/ProviderDeadline.js";
import {
execFileOutput,
@@ -27,30 +34,119 @@ export interface ApktoolCommandSelection {
}
/**
- * Resolve the caller-supplied apktool launcher. `REA_APKTOOL_COMMAND` must
- * be absolute so the selection stays explicit; without it, apktool is
- * resolved from `PATH` at run time. Both the upstream wrapper script and
- * `java -jar` launcher scripts work: REA only runs ` --version`
- * and ` d ...`.
+ * Preserve an explicit launcher, or resolve the default Windows command before
+ * choosing native versus batch process creation. POSIX keeps execFile's PATH
+ * lookup. The resolved selection is reused for the version and decode runs.
*/
-export const resolveApktoolCommand = (
+export const resolveApktoolCommand = async (
environment: Readonly>,
-): ApktoolCommandSelection => {
- const configured = environment[APKTOOL_COMMAND_ENV];
- if (configured === undefined || configured.trim() === "")
+ platform: NodeJS.Platform = process.platform,
+ signal?: AbortSignal,
+): Promise => {
+ if (signal?.aborted === true)
+ throw new AnalysisCancelledError("inspect_apktool_client");
+ const selectedEnvironment = snapshotEnvironment(environment, platform);
+ const configured = selectedEnvironment[APKTOOL_COMMAND_ENV];
+ if (configured !== undefined && configured.trim() !== "") {
+ if (
+ !(platform === "win32"
+ ? win32.isAbsolute(configured)
+ : isAbsolute(configured))
+ )
+ throw new ApktoolConfigurationFailure(
+ "not_absolute",
+ `${APKTOOL_COMMAND_ENV} must be an absolute path to the apktool launcher`,
+ { configured_command: configured },
+ );
+ return { command: configured, commandSource: "environment" };
+ }
+ if (platform !== "win32")
return { command: "apktool", commandSource: "path" };
- if (!isAbsolute(configured))
- throw new ApktoolConfigurationFailure(
- "not_absolute",
- `${APKTOOL_COMMAND_ENV} must be an absolute path to the apktool launcher`,
- { configured_command: configured },
- );
- return { command: configured, commandSource: "environment" };
+ const extensions = (selectedEnvironment.PATHEXT ?? ".EXE;.COM;.BAT;.CMD")
+ .split(";")
+ .filter((extension) => extension !== "");
+ for (const extension of extensions)
+ if (!extension.startsWith(".") || /[\\/:\0]/u.test(extension))
+ throw new ApktoolConfigurationFailure(
+ "command_unresolved",
+ "Windows PATHEXT must contain filename extensions, not paths",
+ {
+ selected_command: "apktool",
+ command_source: "path",
+ invalid_extension: extension,
+ },
+ );
+ const directories = (selectedEnvironment.PATH ?? "")
+ .split(";")
+ .filter((directory) => directory !== "");
+ if (selectedEnvironment.NODEFAULTCURRENTDIRECTORYINEXEPATH === undefined)
+ directories.unshift(process.cwd());
+ // A single deadline owns the whole PATH search, including filesystem waits.
+ const deadline = new ProviderStartupDeadline(VERSION_TIMEOUT_MS, signal);
+ const lookupInterruption = () =>
+ deadline.interruption === "cancelled"
+ ? new AnalysisCancelledError("inspect_apktool_client")
+ : new AnalysisTimeoutError("inspect_apktool_client", VERSION_TIMEOUT_MS, {
+ diagnostics: { phase: "windows_path_lookup" },
+ });
+ try {
+ for (const entry of directories) {
+ const directory =
+ entry.startsWith('"') && entry.endsWith('"')
+ ? entry.slice(1, -1)
+ : entry;
+ for (const extension of extensions) {
+ if (deadline.interruption !== undefined) throw lookupInterruption();
+ const candidate = win32.resolve(directory, `apktool${extension}`);
+ try {
+ const metadata = await waitForAbortable(
+ stat(candidate),
+ deadline.signal,
+ );
+ if (metadata === ABORTED || deadline.interruption !== undefined)
+ throw lookupInterruption();
+ if (metadata.isFile())
+ return { command: candidate, commandSource: "path" };
+ } catch (cause: unknown) {
+ if (deadline.interruption !== undefined) throw lookupInterruption();
+ const code =
+ typeof cause === "object" && cause !== null
+ ? Reflect.get(cause, "code")
+ : undefined;
+ if (code === "ENOENT" || code === "ENOTDIR") continue;
+ throw new ApktoolConfigurationFailure(
+ "command_unresolved",
+ `The PATH-selected apktool launcher could not be inspected: ${candidate}`,
+ {
+ selected_command: "apktool",
+ command_source: "path",
+ candidate_path: candidate,
+ ...(typeof code === "string" ? { filesystem_error: code } : {}),
+ },
+ { cause },
+ );
+ }
+ }
+ }
+ } finally {
+ deadline.dispose();
+ }
+
+ throw new ApktoolConfigurationFailure(
+ "command_missing",
+ "The apktool launcher was not found on the selected Windows PATH/PATHEXT",
+ {
+ selected_command: "apktool",
+ command_source: "path",
+ remediation: `Set ${APKTOOL_COMMAND_ENV} to an absolute apktool launcher, or add its directory and extension to PATH and PATHEXT`,
+ },
+ );
};
export type ApktoolConfigurationFailureCode =
| "not_absolute"
| "command_missing"
+ | "command_unresolved"
| "launcher_unsupported"
| "version_unresolved";
@@ -121,7 +217,7 @@ export const inspectApktoolClient = async (
environment: Readonly> = process.env,
platform: NodeJS.Platform = process.platform,
): Promise => {
- const hostEnvironment = { ...process.env, ...environment };
+ const hostEnvironment = snapshotEnvironment(environment, platform);
let invocation: ApktoolInvocation;
try {
invocation = apktoolInvocation(
@@ -195,7 +291,9 @@ const rejectionCodeOf = (
): ProviderRejectionCode =>
code === "command_missing"
? "executable_missing"
- : code === "not_absolute" || code === "launcher_unsupported"
+ : code === "not_absolute" ||
+ code === "launcher_unsupported" ||
+ code === "command_unresolved"
? "not_configured"
: "version_unresolved";
diff --git a/src/apktool/ApktoolProvider.ts b/src/apktool/ApktoolProvider.ts
index 1e1f187c0..c58ea1f49 100644
--- a/src/apktool/ApktoolProvider.ts
+++ b/src/apktool/ApktoolProvider.ts
@@ -51,6 +51,7 @@ import type { ProviderProcessSupervisor } from "../process/ProviderProcess.js";
import { snapshotEnvironment } from "../process/snapshotEnvironment.js";
import { WindowsBatchCommandError } from "../process/WindowsBatchCommand.js";
import {
+ APKTOOL_COMMAND_ENV,
ApktoolConfigurationFailure,
apktoolConfigurationAvailability,
apktoolInvocation,
@@ -155,10 +156,9 @@ const runApktool = async (
): Promise> => {
if (signal?.aborted === true)
return err(new AnalysisCancelledError(operation));
- const hostEnvironment = { ...process.env, ...environment };
let invocation: ReturnType;
try {
- invocation = apktoolInvocation(selection, arguments_, hostEnvironment);
+ invocation = apktoolInvocation(selection, arguments_, environment);
} catch (cause) {
if (!(cause instanceof WindowsBatchCommandError)) throw cause;
const reason = `The apktool batch launcher cannot receive REA's decode paths through cmd.exe: ${cause.message}`;
@@ -178,7 +178,7 @@ const runApktool = async (
arguments: invocation.arguments,
windowsVerbatimArguments: invocation.windowsVerbatimArguments,
runId: randomUUID(),
- hostEnvironment,
+ hostEnvironment: environment,
},
{
timeoutMs: limits.timeoutMs,
@@ -317,7 +317,9 @@ export interface ApktoolProviderOptions {
* (`--no-src`) because Java-source recovery belongs to the JADX family.
*/
export class ApktoolProvider {
- private readonly environment: Readonly>;
+ private readonly selectedEnvironment:
+ | Readonly>
+ | undefined;
private readonly workspaces = new Set();
private readonly removeWorkspace: (path: string) => Promise;
@@ -328,14 +330,25 @@ export class ApktoolProvider {
#closePromise: Promise | undefined;
constructor(options: ApktoolProviderOptions = {}) {
- this.environment = snapshotEnvironment(options.environment ?? process.env);
+ this.selectedEnvironment =
+ options.environment === undefined
+ ? undefined
+ : snapshotEnvironment(options.environment);
this.removeWorkspace =
options.removeWorkspace ??
((path) => rm(path, { recursive: true, force: true }));
}
- private selection(): ApktoolCommandSelection {
- return resolveApktoolCommand(this.environment);
+ private operationEnvironment(): Readonly {
+ const ambient = snapshotEnvironment(process.env);
+ if (this.selectedEnvironment === undefined) return ambient;
+ // Child inheritance is sampled per operation. An explicit map keeps its
+ // launcher choice authoritative, including an omitted command selecting PATH.
+ return snapshotEnvironment({
+ ...ambient,
+ ...this.selectedEnvironment,
+ [APKTOOL_COMMAND_ENV]: this.selectedEnvironment[APKTOOL_COMMAND_ENV],
+ });
}
/** Probe the selected apktool launcher; decodes nothing. */
@@ -354,9 +367,14 @@ export class ApktoolProvider {
async #inspectAvailability(
signal: AbortSignal,
): Promise {
+ const environment = this.operationEnvironment();
try {
- const selection = this.selection();
- await inspectApktoolClient(selection, signal, this.environment);
+ const selection = await resolveApktoolCommand(
+ environment,
+ process.platform,
+ signal,
+ );
+ await inspectApktoolClient(selection, signal, environment);
throwIfCancelled("inspect_apktool_client", signal);
return {
status: "available",
@@ -406,17 +424,22 @@ export class ApktoolProvider {
): Promise> {
if (signal?.aborted === true)
return err(new AnalysisCancelledError(request.operation));
+ const environment = this.operationEnvironment();
let selection: ApktoolCommandSelection;
let identity: ApktoolClientIdentity;
try {
- selection = this.selection();
- identity = await inspectApktoolClient(
- selection,
+ selection = await resolveApktoolCommand(
+ environment,
+ process.platform,
signal,
- this.environment,
);
+ identity = await inspectApktoolClient(selection, signal, environment);
} catch (cause) {
- if (cause instanceof AnalysisCancelledError) return err(cause);
+ if (
+ cause instanceof AnalysisCancelledError ||
+ cause instanceof AnalysisTimeoutError
+ )
+ return err(cause);
if (cause instanceof ApktoolConfigurationFailure) {
return err(
providerConfigurationRefusal(
@@ -449,6 +472,7 @@ export class ApktoolProvider {
return this.decodeResources(
request.operation,
selection,
+ environment,
client,
provider,
request.input,
@@ -500,6 +524,7 @@ export class ApktoolProvider {
private async decodeResources(
operation: "decode_android_resources",
selection: ApktoolCommandSelection,
+ environment: Readonly,
client: {
command: string;
command_source: string;
@@ -628,7 +653,7 @@ export class ApktoolProvider {
maxOutputBytes: DECODE_MAX_OUTPUT_BYTES,
},
signal,
- this.environment,
+ environment,
(owner) => this.#pendingCommandOwners.set(owner, root),
);
if (!decoded.ok) {
diff --git a/src/application/AnalysisProvider.ts b/src/application/AnalysisProvider.ts
index f3b51257a..376036fa1 100644
--- a/src/application/AnalysisProvider.ts
+++ b/src/application/AnalysisProvider.ts
@@ -50,6 +50,13 @@ export interface AnalysisExecution {
readonly limitations: readonly string[];
/** Provider-owned completeness assessment for caller/callee observations. */
readonly relationshipCoverage?: RelationshipCoverage;
+ /**
+ * Whether the provider capped an `xrefs` read: true when it reported a
+ * truncation, false when it explicitly reported none. Absent when it reports
+ * nothing, which is not a completeness claim. Never part of Evidence or tool
+ * output.
+ */
+ readonly referencesTruncated?: boolean;
readonly locations: readonly EvidenceLocation[];
readonly subject: EvidenceSubjectTarget | null;
}
@@ -59,6 +66,7 @@ interface CreateAnalysisExecutionOptions {
readonly analysisProfile?: AnalysisProfileCommitment;
readonly limitations?: readonly string[];
readonly relationshipCoverage?: RelationshipCoverage;
+ readonly referencesTruncated?: boolean;
readonly locations?: readonly EvidenceLocation[];
readonly subject?: EvidenceSubjectTarget;
}
@@ -103,6 +111,9 @@ export function createAnalysisExecution(
options.relationshipCoverage,
),
}),
+ ...(options.referencesTruncated === undefined
+ ? {}
+ : { referencesTruncated: options.referencesTruncated }),
locations: [...(options.locations ?? [])],
subject: options.subject ?? null,
};
diff --git a/src/application/BinaryTargetResolver.ts b/src/application/BinaryTargetResolver.ts
index ac691b55e..6f1bc4366 100644
--- a/src/application/BinaryTargetResolver.ts
+++ b/src/application/BinaryTargetResolver.ts
@@ -76,6 +76,8 @@ export const parseBinaryTarget = async (
await access(candidate, constants.R_OK);
throwIfTargetResolutionCancelled(signal);
const canonical = await realpath(candidate);
+ // Windows native admission must inspect the caller-selected reparse components.
+ const sourcePath = process.platform === "win32" ? candidate : canonical;
throwIfTargetResolutionCancelled(signal);
const resolved = await resolveAppBundle(canonical);
throwIfTargetResolutionCancelled(signal);
@@ -113,7 +115,7 @@ export const parseBinaryTarget = async (
);
return ok({
path,
- sourcePath: canonical,
+ sourcePath,
sha256: await sha256Handle(handle, path, metadata, signal),
kind: "executable",
format: "raw-binary",
@@ -152,7 +154,7 @@ export const parseBinaryTarget = async (
);
return ok({
path,
- sourcePath: canonical,
+ sourcePath,
sha256: await sha256Handle(handle, path, metadata, signal),
kind: "executable",
format: "dos-com",
@@ -166,7 +168,7 @@ export const parseBinaryTarget = async (
)
return ok({
path,
- sourcePath: process.platform === "win32" ? candidate : canonical,
+ sourcePath,
sha256: await sha256Handle(handle, path, metadata, signal),
kind: "database",
format: "analysis-database",
@@ -175,7 +177,7 @@ export const parseBinaryTarget = async (
if (artifactFormat !== undefined) {
const identity = {
path,
- sourcePath: process.platform === "win32" ? candidate : canonical,
+ sourcePath,
sha256: await sha256Handle(handle, path, metadata, signal),
};
return isArchiveFormat(artifactFormat)
@@ -195,7 +197,7 @@ export const parseBinaryTarget = async (
);
return ok({
path,
- sourcePath: process.platform === "win32" ? candidate : canonical,
+ sourcePath,
...bundle,
sha256: await sha256Handle(handle, path, metadata, signal),
kind: "executable",
diff --git a/src/application/CapabilityInventory.test.ts b/src/application/CapabilityInventory.test.ts
index 1b8ec6411..4286ff1d0 100644
--- a/src/application/CapabilityInventory.test.ts
+++ b/src/application/CapabilityInventory.test.ts
@@ -497,3 +497,71 @@ it("reports host denial before target mismatch but keeps composed workflow prere
).reason,
).toBe("target_required");
});
+
+describe("trace_feature requirements", () => {
+ const capabilities = (operations: readonly string[]) =>
+ operations.map((operation) => ({
+ operation,
+ available: true,
+ reason: null,
+ }));
+
+ it("needs the search operations the workflow actually calls", () => {
+ expect(
+ entry(
+ "trace_feature",
+ status({
+ open: true,
+ kind: "executable",
+ capabilities: capabilities([
+ "search_strings",
+ "search_procedures",
+ "xrefs",
+ "resolve_containing_procedure",
+ ]),
+ }),
+ ),
+ ).toMatchObject({ available: true, reason: "available" });
+ });
+
+ it.each(["search_strings", "search_procedures"])(
+ "is unavailable without %s",
+ (missing) => {
+ const operations = [
+ "search_strings",
+ "search_procedures",
+ "xrefs",
+ "resolve_containing_procedure",
+ ].filter((operation) => operation !== missing);
+
+ expect(
+ entry(
+ "trace_feature",
+ status({
+ open: true,
+ kind: "executable",
+ capabilities: capabilities(operations),
+ }),
+ ),
+ ).toMatchObject({ available: false, reason: "provider_missing" });
+ },
+ );
+
+ it("is unavailable when only the list operations exist", () => {
+ expect(
+ entry(
+ "trace_feature",
+ status({
+ open: true,
+ kind: "executable",
+ capabilities: capabilities([
+ "list_strings",
+ "list_procedures",
+ "xrefs",
+ "resolve_containing_procedure",
+ ]),
+ }),
+ ),
+ ).toMatchObject({ available: false, reason: "provider_missing" });
+ });
+});
diff --git a/src/application/CapabilityInventory.ts b/src/application/CapabilityInventory.ts
index 6fefb8e20..f4584eb29 100644
--- a/src/application/CapabilityInventory.ts
+++ b/src/application/CapabilityInventory.ts
@@ -121,8 +121,8 @@ const ENHANCED_REQUIREMENTS: Readonly> = {
analyze_function: ["analyze_function"],
inspect_native_api: ["analyze_function"],
trace_feature: [
- "list_strings",
- "list_procedures",
+ "search_strings",
+ "search_procedures",
"xrefs",
"resolve_containing_procedure",
],
@@ -141,6 +141,7 @@ const FRIDA_OPERATION_NAMES: ReadonlySet = new Set(
/** Native contracts defined only for an active Mach-O executable. */
const MACHO_TARGET_OPERATIONS: ReadonlySet = new Set([
+ "inspect_signature",
"inspect_macho",
"list_architectures",
"observe_native_calls",
diff --git a/src/application/ClaudeDesktopConfigLocation.test.ts b/src/application/ClaudeDesktopConfigLocation.test.ts
new file mode 100644
index 000000000..84d8ca8bc
--- /dev/null
+++ b/src/application/ClaudeDesktopConfigLocation.test.ts
@@ -0,0 +1,341 @@
+import { basename, dirname, join, sep } from "node:path";
+
+import { describe, expect, it } from "vitest";
+
+import {
+ CLAUDE_DESKTOP_PACKAGE_FAMILY,
+ resolveWindowsClaudeDesktopLocation,
+ type ClaudeDesktopLocationFileSystem,
+} from "./ClaudeDesktopConfigLocation.js";
+import {
+ packagePrivateLauncherBlocker,
+ packagePrivateStorageFamily,
+ redirectedWriteBlocker,
+ type MsixPackageView,
+} from "./MsixPackageStorage.js";
+
+const home = join("/profile", "a");
+const env = {
+ APPDATA: join(home, "AppData", "Roaming"),
+ LOCALAPPDATA: join(home, "AppData", "Local"),
+};
+const packages = join(env.LOCALAPPDATA, "Packages");
+const appDataConfig = join(env.APPDATA, "Claude", "claude_desktop_config.json");
+const privateConfig = join(
+ packages,
+ CLAUDE_DESKTOP_PACKAGE_FAMILY,
+ "LocalCache",
+ "Roaming",
+ "Claude",
+ "claude_desktop_config.json",
+);
+
+const failure = (code: string): Error =>
+ Object.assign(new Error(`${code}: injected`), { code });
+
+const file = { isFile: () => true };
+const privateDirectory = dirname(privateConfig);
+const privatePreferences = join(privateDirectory, "Preferences");
+const appDataDirectory = dirname(appDataConfig);
+
+/** Package storage holding `privateFiles`; realpath decides the process view. */
+const packagedFileSystem = (
+ realpath: ClaudeDesktopLocationFileSystem["realpath"],
+ privateFiles: readonly string[] = [privateConfig],
+): ClaudeDesktopLocationFileSystem => ({
+ readdir: (path) => {
+ if (path === packages) return [CLAUDE_DESKTOP_PACKAGE_FAMILY];
+ if (path === privateDirectory)
+ return privateFiles.map((name) => basename(name));
+ throw failure("ENOENT");
+ },
+ lstat: (path) => {
+ if (!privateFiles.includes(path)) throw failure("ENOENT");
+ return file;
+ },
+ realpath,
+});
+
+describe("Claude Desktop MSIX process view", () => {
+ it("recognizes a process that sees the private copy at the AppData path", () => {
+ const location = resolveWindowsClaudeDesktopLocation(
+ home,
+ env,
+ packagedFileSystem((path) =>
+ path === appDataConfig ? privateConfig : path,
+ ),
+ );
+ expect(location).toEqual({
+ ok: true,
+ value: expect.objectContaining({
+ configPath: privateConfig,
+ msixPackage: expect.objectContaining({ processView: "redirected" }),
+ }),
+ });
+ });
+
+ it("treats an absent AppData file as an unredirected process", () => {
+ const location = resolveWindowsClaudeDesktopLocation(
+ home,
+ env,
+ packagedFileSystem((path) => {
+ if (path === appDataConfig) throw failure("ENOENT");
+ return path;
+ }),
+ );
+ expect(location.ok && location.value.msixPackage?.processView).toBe(
+ "direct",
+ );
+ });
+
+ it("recognizes redirection through another private file before the configuration exists", () => {
+ const location = resolveWindowsClaudeDesktopLocation(
+ home,
+ env,
+ packagedFileSystem(
+ (path) =>
+ path === join(appDataDirectory, "Preferences")
+ ? privatePreferences
+ : path,
+ [privatePreferences],
+ ),
+ );
+ expect(location.ok && location.value.configPath).toBe(privateConfig);
+ expect(location.ok && location.value.msixPackage?.processView).toBe(
+ "redirected",
+ );
+ });
+
+ it("continues after a listed private file disappears", () => {
+ const fs = packagedFileSystem(
+ (path) =>
+ path === join(appDataDirectory, "Preferences")
+ ? privatePreferences
+ : path,
+ [privatePreferences],
+ );
+ const location = resolveWindowsClaudeDesktopLocation(home, env, {
+ ...fs,
+ readdir: (path) =>
+ path === privateDirectory
+ ? ["vanished", "Preferences"]
+ : fs.readdir(path),
+ });
+ expect(location.ok && location.value.msixPackage?.processView).toBe(
+ "redirected",
+ );
+ });
+
+ it("keeps the view unknown when the package has no private files", () => {
+ const location = resolveWindowsClaudeDesktopLocation(
+ home,
+ env,
+ packagedFileSystem((path) => path, []),
+ );
+ expect(location.ok && location.value.msixPackage?.processView).toBe(
+ "unknown",
+ );
+ });
+
+ it("keeps the view unknown when the AppData path cannot be resolved", () => {
+ const location = resolveWindowsClaudeDesktopLocation(
+ home,
+ env,
+ packagedFileSystem((path) => {
+ if (path === appDataConfig) throw failure("EACCES");
+ return path;
+ }),
+ );
+ expect(location.ok && location.value.msixPackage?.processView).toBe(
+ "unknown",
+ );
+ });
+});
+
+describe("unresolved Claude Desktop package identity", () => {
+ it("reports unreadable package storage instead of assuming AppData", () => {
+ const location = resolveWindowsClaudeDesktopLocation(home, env, {
+ readdir: () => {
+ throw failure("EACCES");
+ },
+ lstat: () => file,
+ realpath: (path) => path,
+ });
+ expect(location).toEqual({
+ ok: false,
+ error: {
+ path: packages,
+ message: expect.stringContaining("could not be inspected"),
+ },
+ });
+ });
+
+ it("reports an uninspectable private copy instead of choosing a file", () => {
+ const location = resolveWindowsClaudeDesktopLocation(home, env, {
+ readdir: () => [CLAUDE_DESKTOP_PACKAGE_FAMILY],
+ lstat: () => {
+ throw failure("EPERM");
+ },
+ realpath: (path) => path,
+ });
+ expect(location.ok).toBe(false);
+ expect(!location.ok && location.error.path).toBe(privateConfig);
+ });
+
+ it("matches the package family case-insensitively, as Windows does", () => {
+ const location = resolveWindowsClaudeDesktopLocation(home, env, {
+ readdir: () => [CLAUDE_DESKTOP_PACKAGE_FAMILY.toUpperCase()],
+ lstat: () => {
+ throw failure("ENOENT");
+ },
+ realpath: (path) => path,
+ });
+ expect(location.ok && location.value.msixPackage?.packageFamilyName).toBe(
+ CLAUDE_DESKTOP_PACKAGE_FAMILY.toUpperCase(),
+ );
+ });
+});
+
+describe("package-private REA launchers", () => {
+ const launcher = join(
+ env.APPDATA,
+ "npm",
+ "node_modules",
+ "rea-agents",
+ "scripts",
+ "rea.mjs",
+ );
+ const stored = join(
+ packages,
+ CLAUDE_DESKTOP_PACKAGE_FAMILY,
+ "LocalCache",
+ "Roaming",
+ "npm",
+ "node_modules",
+ "rea-agents",
+ "scripts",
+ "rea.mjs",
+ );
+
+ it("names the package that privately stores a path", () => {
+ expect(packagePrivateStorageFamily(stored, packages)).toBe(
+ CLAUDE_DESKTOP_PACKAGE_FAMILY,
+ );
+ expect(packagePrivateStorageFamily(launcher, packages)).toBeUndefined();
+ expect(
+ packagePrivateStorageFamily(
+ join(packages, CLAUDE_DESKTOP_PACKAGE_FAMILY, "LocalState", "x"),
+ packages,
+ ),
+ ).toBeUndefined();
+ });
+
+ it("blocks a launcher that only the package's processes can see", () => {
+ const blocker = packagePrivateLauncherBlocker(
+ [join("/Program Files", "nodejs", "node.exe"), launcher, "mcp"],
+ packages,
+ (path) => (path === launcher ? stored : path),
+ );
+ expect(blocker).toContain(stored);
+ expect(blocker).toContain(CLAUDE_DESKTOP_PACKAGE_FAMILY);
+ expect(blocker).toContain("npm install -g rea-agents");
+ });
+
+ it("compares the launcher with the canonical package storage path", () => {
+ const shortProfilePackages = join(
+ "/profile",
+ "A~1",
+ "AppData",
+ "Local",
+ "Packages",
+ );
+ const blocker = packagePrivateLauncherBlocker(
+ [launcher, "mcp"],
+ shortProfilePackages,
+ (path) =>
+ path === shortProfilePackages
+ ? packages
+ : path === launcher
+ ? stored
+ : path,
+ );
+ expect(blocker).toContain(CLAUDE_DESKTOP_PACKAGE_FAMILY);
+ });
+
+ it("allows ordinary and unresolvable launchers", () => {
+ expect(
+ packagePrivateLauncherBlocker(
+ ["cmd.exe", "/d", "/c", "npx", "-y", "rea-agents@6.4.0", "mcp"],
+ packages,
+ () => {
+ throw new Error("package runners are not resolved");
+ },
+ ),
+ ).toBeUndefined();
+ expect(
+ packagePrivateLauncherBlocker([launcher, "mcp"], packages, () => {
+ throw failure("ENOENT");
+ }),
+ ).toBeUndefined();
+ });
+});
+
+describe("writes from a redirected AppData view", () => {
+ const view: MsixPackageView = {
+ packageFamilyName: CLAUDE_DESKTOP_PACKAGE_FAMILY,
+ privateConfigPath: privateConfig,
+ appDataConfigPath: appDataConfig,
+ virtualizedRoots: [env.APPDATA, env.LOCALAPPDATA],
+ processView: "redirected",
+ };
+ const vscode = join(env.APPDATA, "Code", "User", "mcp.json");
+ const hermes = join(env.LOCALAPPDATA, "hermes", "config.yaml");
+ const codex = join(home, ".codex", "config.toml");
+
+ it("refuses only targets under the package's virtualized roots", () => {
+ const blocker = redirectedWriteBlocker(
+ view,
+ [vscode, codex, hermes],
+ "setup",
+ );
+ expect(blocker).toContain(`${vscode}, ${hermes}`);
+ expect(blocker).not.toContain(codex);
+ expect(blocker).toContain("Rerun setup from a terminal");
+ expect(redirectedWriteBlocker(view, [codex], "setup")).toBeUndefined();
+ });
+
+ it("compares aliases through the existing parent of a new destination", () => {
+ const alias = join(home, "skill-alias");
+ const target = join(alias, "skills", "reverse-engineer-anything");
+ const blocker = redirectedWriteBlocker(
+ view,
+ [target],
+ "uninstall",
+ (path) => {
+ if (path === alias) return join(env.APPDATA, "dsh");
+ if (path.startsWith(`${alias}${sep}`)) throw failure("ENOENT");
+ return path;
+ },
+ );
+ expect(blocker).toContain(target);
+ expect(blocker).toContain("Rerun uninstall");
+ });
+
+ it("keeps canonicalization failures visible instead of assuming a target is outside AppData", () => {
+ expect(
+ redirectedWriteBlocker(view, [codex], "setup", () => {
+ throw failure("EACCES");
+ }),
+ ).toContain("Cannot establish the MSIX write location");
+ });
+
+ it("allows every target without positive evidence of redirection", () => {
+ for (const processView of ["direct", "unknown"] as const)
+ expect(
+ redirectedWriteBlocker({ ...view, processView }, [vscode], "uninstall"),
+ ).toBeUndefined();
+ expect(
+ redirectedWriteBlocker(undefined, [vscode], "setup"),
+ ).toBeUndefined();
+ });
+});
diff --git a/src/application/ClaudeDesktopConfigLocation.ts b/src/application/ClaudeDesktopConfigLocation.ts
new file mode 100644
index 000000000..899aadbbb
--- /dev/null
+++ b/src/application/ClaudeDesktopConfigLocation.ts
@@ -0,0 +1,199 @@
+import { lstatSync, readdirSync, realpathSync } from "node:fs";
+import { join } from "node:path";
+
+import { err, ok, type Result } from "../domain/result.js";
+import {
+ windowsAppDataRoots,
+ type MsixPackageView,
+} from "./MsixPackageStorage.js";
+
+const CONFIG_FILE = "claude_desktop_config.json";
+
+/** Private files compared at most when looking for a redirected AppData view. */
+const PROCESS_VIEW_PROBES = 8;
+
+/**
+ * Claude Desktop's MSIX package family: package name `Claude` and the
+ * publisher ID Windows derives from `CN="Anthropic, PBC", O="Anthropic, PBC",
+ * L=San Francisco, S=California, C=US, …`.
+ */
+export const CLAUDE_DESKTOP_PACKAGE_FAMILY = "Claude_pzs8sxrjxfjjc";
+
+/** `Claude_` plus a 13-character Crockford base32 MSIX publisher ID. */
+const CLAUDE_PACKAGE_FAMILY = /^Claude_[0-9a-hjkmnp-tv-z]{13}$/iu;
+
+/** The configuration Claude Desktop reads and the evidence that it is installed. */
+export interface ClaudeDesktopLocation {
+ readonly configPath: string;
+ readonly markerPath: string;
+ readonly msixPackage?: MsixPackageView;
+}
+
+/** Unresolved Claude Desktop identity, reported instead of guessing a file. */
+export interface ClaudeDesktopLocationFailure {
+ readonly path: string;
+ readonly message: string;
+}
+
+/** Synchronous probes; each throws for failures other than absence. */
+export interface ClaudeDesktopLocationFileSystem {
+ readonly readdir: (path: string) => readonly string[];
+ readonly lstat: (path: string) => { isFile(): boolean };
+ readonly realpath: (path: string) => string;
+}
+
+const systemFileSystem: ClaudeDesktopLocationFileSystem = {
+ readdir: (path) => readdirSync(path),
+ lstat: (path) => lstatSync(path),
+ realpath: (path) => realpathSync.native(path),
+};
+
+/**
+ * Resolve the `claude_desktop_config.json` that Windows Claude Desktop reads.
+ * Without its MSIX package storage, that is the AppData file. With it, the
+ * package reads its private copy when one exists and the AppData file
+ * otherwise; a new registration goes to the private copy. A `Claude_*`
+ * package from another publisher leaves the reader unknown.
+ */
+export const resolveWindowsClaudeDesktopLocation = (
+ home: string,
+ env: Readonly,
+ fileSystem: ClaudeDesktopLocationFileSystem = systemFileSystem,
+): Result => {
+ const roots = windowsAppDataRoots(home, env);
+ const appDataDirectory = join(roots.roaming, "Claude");
+ const appDataConfigPath = join(appDataDirectory, CONFIG_FILE);
+ const packagesDirectory = join(roots.local, "Packages");
+ let families: readonly string[];
+ try {
+ families = fileSystem
+ .readdir(packagesDirectory)
+ .filter((name) => CLAUDE_PACKAGE_FAMILY.test(name));
+ } catch (cause: unknown) {
+ if (!isMissing(cause))
+ return err({
+ path: packagesDirectory,
+ message: `MSIX package storage ${packagesDirectory} could not be inspected, so REA cannot establish whether Claude Desktop reads ${appDataConfigPath} or a package-private copy: ${errorMessage(cause)}. Repair access to that directory, then rerun.`,
+ });
+ families = [];
+ }
+ const foreign = families.filter(
+ (name) =>
+ name.toLowerCase() !== CLAUDE_DESKTOP_PACKAGE_FAMILY.toLowerCase(),
+ );
+ if (foreign.length > 0)
+ return err({
+ path: join(packagesDirectory, foreign[0] ?? ""),
+ message: `MSIX package storage ${foreign.map((name) => join(packagesDirectory, name)).join(", ")} uses Claude Desktop's package name with an unrecognized publisher (Claude Desktop is ${CLAUDE_DESKTOP_PACKAGE_FAMILY}). REA cannot establish which ${CONFIG_FILE} that package reads and does not fall back to ${appDataConfigPath}. Remove the unrecognized package, or register REA in the configuration it reads.`,
+ });
+ const family = families[0];
+ if (family === undefined)
+ return ok({ configPath: appDataConfigPath, markerPath: appDataDirectory });
+ const container = join(packagesDirectory, family);
+ const privateDirectory = join(container, "LocalCache", "Roaming", "Claude");
+ const privateConfigPath = join(privateDirectory, CONFIG_FILE);
+ const privateCopy = present(fileSystem, privateConfigPath);
+ if (!privateCopy.ok) return privateCopy;
+ const appDataCopy = privateCopy.value
+ ? ok(false)
+ : present(fileSystem, appDataConfigPath);
+ if (!appDataCopy.ok) return appDataCopy;
+ return ok({
+ configPath:
+ privateCopy.value || !appDataCopy.value
+ ? privateConfigPath
+ : appDataConfigPath,
+ markerPath: container,
+ msixPackage: {
+ packageFamilyName: family,
+ privateConfigPath,
+ appDataConfigPath,
+ virtualizedRoots: [roots.roaming, roots.local],
+ processView: processView(
+ fileSystem,
+ privateDirectory,
+ appDataDirectory,
+ privateCopy.value,
+ ),
+ },
+ });
+};
+
+/**
+ * A process the package started sees the package's private files at their
+ * AppData paths; any other process sees the real AppData files or nothing.
+ * Claude Desktop saves its user data there while it runs, so the
+ * configuration, or any other private file, can show which view this is.
+ */
+const processView = (
+ fileSystem: ClaudeDesktopLocationFileSystem,
+ privateDirectory: string,
+ appDataDirectory: string,
+ privateConfig: boolean,
+): MsixPackageView["processView"] => {
+ let probes: readonly string[];
+ try {
+ probes = privateConfig
+ ? [CONFIG_FILE]
+ : fileSystem
+ .readdir(privateDirectory)
+ .filter((name) => {
+ try {
+ return fileSystem.lstat(join(privateDirectory, name)).isFile();
+ } catch (cause: unknown) {
+ // A candidate may vanish or become unreadable while listed.
+ void cause;
+ return false;
+ }
+ })
+ .slice(0, PROCESS_VIEW_PROBES);
+ } catch (cause: unknown) {
+ // No private file can be listed, so no view can be compared.
+ void cause;
+ return "unknown";
+ }
+ let view: MsixPackageView["processView"] = "unknown";
+ for (const name of probes) {
+ let privateTarget: string;
+ try {
+ privateTarget = fileSystem.realpath(join(privateDirectory, name));
+ } catch (cause: unknown) {
+ // A private file that vanished cannot be compared; try another.
+ void cause;
+ continue;
+ }
+ try {
+ if (fileSystem.realpath(join(appDataDirectory, name)) === privateTarget)
+ return "redirected";
+ view = "direct";
+ } catch (cause: unknown) {
+ if (!isMissing(cause)) return "unknown";
+ view = "direct";
+ }
+ }
+ return view;
+};
+
+const present = (
+ fileSystem: ClaudeDesktopLocationFileSystem,
+ path: string,
+): Result => {
+ try {
+ fileSystem.lstat(path);
+ return ok(true);
+ } catch (cause: unknown) {
+ if (isMissing(cause)) return ok(false);
+ return err({
+ path,
+ message: `${path} could not be inspected, so REA cannot establish which ${CONFIG_FILE} Claude Desktop's MSIX package reads: ${errorMessage(cause)}. Repair access to that path, then rerun.`,
+ });
+ }
+};
+
+const isMissing = (cause: unknown): boolean =>
+ cause instanceof Error &&
+ "code" in cause &&
+ (cause.code === "ENOENT" || cause.code === "ENOTDIR");
+
+const errorMessage = (cause: unknown): string =>
+ cause instanceof Error ? cause.message : String(cause);
diff --git a/src/application/ClientConfigurationDocument.ts b/src/application/ClientConfigurationDocument.ts
index b32df3fd0..1b241a98b 100644
--- a/src/application/ClientConfigurationDocument.ts
+++ b/src/application/ClientConfigurationDocument.ts
@@ -1,9 +1,5 @@
import { parse as parseToml, stringify as stringifyToml } from "smol-toml";
-import {
- parse as parseYaml,
- parseDocument as parseYamlDocument,
- stringify as stringifyYaml,
-} from "yaml";
+import { stringify as stringifyYaml } from "yaml";
import { isDeepStrictEqual } from "node:util";
import {
@@ -12,6 +8,10 @@ import {
editDshDocument,
dshClientRegistrationEntry,
} from "./DshCordisPatch.js";
+import {
+ editHermesConfigurationYaml,
+ parseHermesConfigurationYaml,
+} from "./HermesConfigurationYaml.js";
import {
applyEdits,
findNodeAtLocation,
@@ -118,7 +118,10 @@ const parseDocument = (
if (isEmptyClientConfigurationText(text)) return {};
// Hermes stores MCP servers in `mcp_servers` inside a YAML document.
if (format === "hermes")
- return requireObject(parseYaml(text), "The configuration root");
+ return requireObject(
+ parseHermesConfigurationYaml(text),
+ "The configuration root",
+ );
// ZCode loads nonempty native files with strict JSON.parse.
if (format === "zcode")
return requireObject(JSON.parse(text), "The configuration root");
@@ -1419,12 +1422,11 @@ const serializeHermesConfiguration = (
typeof servers === "object" && servers !== null
? (servers as Record)[PRODUCT_IDENTITY.mcpServerKey]
: undefined;
- const yamlDocument = parseYamlDocument(originalText);
- if (entry === undefined)
- yamlDocument.deleteIn([serversKey, PRODUCT_IDENTITY.mcpServerKey]);
- else yamlDocument.setIn([serversKey, PRODUCT_IDENTITY.mcpServerKey], entry);
- // Editing REA must not reflow unrelated user prompts or other YAML scalars.
- return yamlDocument.toString({ lineWidth: 0 });
+ return editHermesConfigurationYaml(
+ originalText,
+ [serversKey, PRODUCT_IDENTITY.mcpServerKey],
+ entry,
+ );
};
/** Build the stdio entry shape expected by one client's configuration dialect. */
diff --git a/src/application/ClientRegistrationStatus.ts b/src/application/ClientRegistrationStatus.ts
index caeba4fb6..d107c5f32 100644
--- a/src/application/ClientRegistrationStatus.ts
+++ b/src/application/ClientRegistrationStatus.ts
@@ -155,7 +155,7 @@ export const readClientRegistrationInspections = async (
}
const parsed = effectiveClientConfiguration(files.value);
if (parsed === undefined) {
- record(unavailableStatus(client.name, client.configPath, "missing"));
+ record(unavailableStatus(client, "missing"));
continue;
}
const policy = await readClientPolicyBlock(
@@ -191,7 +191,7 @@ export const readClientRegistrationInspections = async (
});
continue;
}
- record(unavailableStatus(client.name, client.configPath, "missing"));
+ record(unavailableStatus(client, "missing"));
continue;
}
const registration = parseRegistration(raw, client);
@@ -202,8 +202,7 @@ export const readClientRegistrationInspections = async (
const activation = registrationActivation(registration, client, parsed);
record(
configuredStatus(
- client.name,
- client.configPath,
+ client,
command,
activation === "enabled" &&
registrationAligned(
@@ -222,11 +221,7 @@ export const readClientRegistrationInspections = async (
);
} catch (cause: unknown) {
record(
- unavailableStatus(
- client.name,
- client.configPath,
- isMissing(cause) ? "missing" : "invalid",
- ),
+ unavailableStatus(client, isMissing(cause) ? "missing" : "invalid"),
);
}
}
@@ -352,36 +347,45 @@ const parseRegistration = (
return registration;
};
-const remediation =
- "Run rea setup to refresh this registration, then restart the client.";
+/** A client that rewrites its file from memory must be quit before setup. */
+const remediation = (client: SetupClient): string => {
+ if (client.quitBeforeSetup !== true)
+ return "Run rea setup to refresh this registration, then restart the client.";
+ const name = client.displayName ?? client.name;
+ return `Quit ${name} fully, run rea setup to refresh this registration, then start ${name} again. A running ${name} can rewrite its configuration from memory and drop the registration.`;
+};
const configuredStatus = (
- client: string,
- configPath: string,
+ client: SetupClient,
command: RegistrationCommand,
state: "aligned" | "stale",
policyRemediation?: string,
): ClientRegistrationStatus =>
state === "aligned"
- ? { client, config_path: configPath, command, state, remediation: null }
- : {
- client,
- config_path: configPath,
+ ? {
+ client: client.name,
+ config_path: client.configPath,
command,
state,
- remediation: policyRemediation ?? remediation,
+ remediation: null,
+ }
+ : {
+ client: client.name,
+ config_path: client.configPath,
+ command,
+ state,
+ remediation: policyRemediation ?? remediation(client),
};
const unavailableStatus = (
- client: string,
- configPath: string,
+ client: SetupClient,
state: "missing" | "invalid",
): ClientRegistrationStatus => ({
- client,
- config_path: configPath,
+ client: client.name,
+ config_path: client.configPath,
command: [],
state,
- remediation,
+ remediation: remediation(client),
});
const clientEvidencePresent = async (client: SetupClient): Promise => {
diff --git a/src/application/DirectAnalysis.ts b/src/application/DirectAnalysis.ts
index c4d130f63..0bdb69864 100644
--- a/src/application/DirectAnalysis.ts
+++ b/src/application/DirectAnalysis.ts
@@ -23,6 +23,7 @@ import { projectAnalysisError } from "../domain/analysisErrorProjection.js";
import type { AnalysisError } from "../domain/analysisErrorBase.js";
import { access } from "node:fs/promises";
import { readAnalysisSnapshot } from "./binary/AnalysisSnapshotFiles.js";
+import { requiresNativeSourceAdmissionBeforeReplay } from "./binary/AnalysisSnapshotCache.js";
import { parseBinaryTarget } from "./BinaryTargetResolver.js";
import type { BinaryTarget } from "../domain/binaryTargetTypes.js";
import {
@@ -254,9 +255,14 @@ const runAnalysis = async (
const route = preview.value.route;
const bindingProfile = route.profile ?? undefined;
const evidenceProfile = analysisProfileForRoute(route, tool);
+ // A parsed Windows path does not prove Ghidra's native snapshot owner
+ // admitted the selected source; CLI replay must wait for that client.
if (
bindingProfile !== undefined &&
evidenceProfile !== undefined &&
+ !requiresNativeSourceAdmissionBeforeReplay(
+ route.binding?.identity.id,
+ ) &&
allowsSnapshotReplay(route, tool)
) {
const cached = snapshotEvidenceForQuery(snapshot, {
diff --git a/src/application/EnhancedLiteralTracing.ts b/src/application/EnhancedLiteralTracing.ts
index 9c86781bc..79684ce0f 100644
--- a/src/application/EnhancedLiteralTracing.ts
+++ b/src/application/EnhancedLiteralTracing.ts
@@ -1,5 +1,8 @@
import { z } from "zod";
-import type { AnalysisOperation } from "./AnalysisProvider.js";
+import type {
+ AnalysisExecution,
+ AnalysisOperation,
+} from "./AnalysisProvider.js";
import { AnalysisOutputError } from "../domain/analysisErrorCore.js";
import type { AnalysisError } from "../domain/analysisErrorBase.js";
import type { JsonValue } from "../domain/jsonValue.js";
@@ -16,6 +19,12 @@ type AnalysisCall = (
signal?: AbortSignal,
) => Promise>;
+type ObserveCall = (
+ name: AnalysisOperation,
+ arguments_: Readonly>,
+ signal?: AbortSignal,
+) => Promise>;
+
type LiteralSearchSource = readonly [
"search_strings" | "search_procedures",
"string" | "procedure",
@@ -39,6 +48,7 @@ export interface LiteralTraceInput {
/** Trace matching strings and procedures through provider xrefs. */
export const traceLiteralFeature = async (
call: AnalysisCall,
+ observe: ObserveCall,
input: LiteralTraceInput,
signal?: AbortSignal,
): EnhancedResult => {
@@ -49,7 +59,7 @@ export const traceLiteralFeature = async (
signal,
);
if (!searched.ok) return searched;
- const traced = await traceReferences(call, {
+ const traced = await traceReferences(call, observe, {
matches: searched.value.matches,
...(signal === undefined ? {} : { signal }),
});
@@ -59,8 +69,8 @@ export const traceLiteralFeature = async (
search_mode: "literal",
matches: searched.value.matches,
references: traced.value.references,
- truncated: false,
- residual_unknowns: [],
+ truncated: traced.value.residual.length > 0,
+ residual_unknowns: traced.value.residual,
});
};
@@ -126,24 +136,39 @@ const addPageMatches = (input: {
const traceReferences = async (
call: AnalysisCall,
+ observe: ObserveCall,
request: ReferenceTraceRequest,
-): Promise> => {
+): Promise<
+ Result<{ references: TraceReference[]; residual: string[] }, AnalysisError>
+> => {
const references: TraceReference[] = [];
+ const residual: string[] = [];
+ // A source address is resolved once however many matches reference it.
+ const containing = new Map();
for (const match of request.matches) {
- const xrefs = await call(
+ const observed = await observe(
"xrefs",
{ address: match.address },
request.signal,
);
- if (!xrefs.ok) return xrefs;
- if (!Array.isArray(xrefs.value))
+ if (!observed.ok) return observed;
+ // Only an explicit producer report of truncation is a coverage gap; a
+ // provider that reports nothing keeps its previous, unqualified result.
+ const unknown = `References to ${match.address} were truncated by the provider; additional references may exist.`;
+ if (
+ observed.value.referencesTruncated === true &&
+ !residual.includes(unknown)
+ )
+ residual.push(unknown);
+ const sources = observed.value.result;
+ if (!Array.isArray(sources))
return err(
new AnalysisOutputError(
"xrefs",
"provider returned a non-array result",
),
);
- for (const source of xrefs.value) {
+ for (const source of sources) {
if (typeof source !== "string")
return err(
new AnalysisOutputError(
@@ -151,18 +176,23 @@ const traceReferences = async (
"provider returned a non-address value",
),
);
- const resolved = await call(
- "resolve_containing_procedure",
- { address: source },
- request.signal,
- );
- if (!resolved.ok) return resolved;
+ let containingProcedure = containing.get(source);
+ if (containingProcedure === undefined) {
+ const resolved = await call(
+ "resolve_containing_procedure",
+ { address: source },
+ request.signal,
+ );
+ if (!resolved.ok) return resolved;
+ containingProcedure = resolved.value;
+ containing.set(source, containingProcedure);
+ }
references.push({
target_address: match.address,
source_address: source,
- containing_procedure: resolved.value,
+ containing_procedure: containingProcedure,
});
}
}
- return ok({ references });
+ return ok({ references, residual });
};
diff --git a/src/application/EnhancedTools.ts b/src/application/EnhancedTools.ts
index 87d27fc5f..207186ccc 100644
--- a/src/application/EnhancedTools.ts
+++ b/src/application/EnhancedTools.ts
@@ -163,6 +163,8 @@ export class EnhancedTools {
return traceLiteralFeature(
(name, arguments_, operationSignal) =>
this.#call(name, arguments_, operationSignal),
+ (name, arguments_, operationSignal) =>
+ this.#observe(name, arguments_, operationSignal),
call.input,
signal,
);
diff --git a/src/application/EvidenceBundleCommands.ts b/src/application/EvidenceBundleCommands.ts
index a72d17cb5..1255ea68f 100644
--- a/src/application/EvidenceBundleCommands.ts
+++ b/src/application/EvidenceBundleCommands.ts
@@ -11,6 +11,7 @@ import { compareBundles } from "../domain/bundleComparison.js";
import { ArtifactResourceScope } from "../artifacts/ArtifactResourceScope.js";
import {
readEvidenceBundle,
+ readImmutableEvidenceBundle,
writeEvidenceBundle,
} from "./EvidenceBundleFiles.js";
@@ -33,7 +34,8 @@ export const exportEvidenceBundleCommand = async (
outputPath: string,
overwrite: boolean,
): Promise> => {
- const loaded = await readEvidenceBundle(sourcePath);
+ // The sealed snapshot lets the writer reuse this authentication.
+ const loaded = await readImmutableEvidenceBundle(sourcePath);
if (!loaded.ok) return loaded;
const resources = new ArtifactResourceScope();
const written = await writeEvidenceBundle(
@@ -69,9 +71,11 @@ export const compareEvidenceBundlesCommand = async (input: {
readonly leftPath: string;
readonly rightPath: string;
}): Promise> => {
+ // Sealed snapshots let comparison and its bundle digests reuse this
+ // authentication instead of re-validating every record twice more.
const [left, right] = await Promise.all([
- readEvidenceBundle(input.leftPath),
- readEvidenceBundle(input.rightPath),
+ readImmutableEvidenceBundle(input.leftPath),
+ readImmutableEvidenceBundle(input.rightPath),
]);
if (!left.ok) return left;
if (!right.ok) return right;
diff --git a/src/application/HermesConfigurationYaml.test.ts b/src/application/HermesConfigurationYaml.test.ts
new file mode 100644
index 000000000..41b74fcc9
--- /dev/null
+++ b/src/application/HermesConfigurationYaml.test.ts
@@ -0,0 +1,21 @@
+import { describe, expect, it } from "vitest";
+
+import {
+ editHermesConfigurationYaml,
+ parseHermesConfigurationYaml,
+} from "./HermesConfigurationYaml.js";
+
+describe("Hermes configuration YAML", () => {
+ it("writes an edited number from its new value", () => {
+ expect(
+ editHermesConfigurationYaml("mode: 0600\nmask: 0x1F\n", ["mode"], 384),
+ ).toBe("mode: 384\nmask: 0x1F\n");
+ });
+
+ it("accepts keys Hermes reads as distinct and rejects a repeated key", () => {
+ expect(() =>
+ parseHermesConfigurationYaml("0600: octal\n600: decimal\n"),
+ ).not.toThrow();
+ expect(() => parseHermesConfigurationYaml('a: 1\n"a": 2\n')).toThrow();
+ });
+});
diff --git a/src/application/HermesConfigurationYaml.ts b/src/application/HermesConfigurationYaml.ts
new file mode 100644
index 000000000..8d245da37
--- /dev/null
+++ b/src/application/HermesConfigurationYaml.ts
@@ -0,0 +1,74 @@
+import {
+ isScalar,
+ parse,
+ parseDocument,
+ type ParsedNode,
+ type ScalarTag,
+ type Tags,
+} from "yaml";
+
+const NUMBER_TAGS = new Set([
+ "tag:yaml.org,2002:int",
+ "tag:yaml.org,2002:float",
+]);
+
+/**
+ * Write a parsed number with its source spelling while that spelling still
+ * reads as the node's value. Hermes reads config.yaml as YAML 1.1 with exact
+ * integers, so re-printing a JavaScript number changes what it reads: a
+ * Discord channel ID loses its low digits, `0600` (octal) becomes `600`, and
+ * `0.0000001` becomes `1e-7`, which YAML 1.1 does not define as a float.
+ */
+const keepNumberSource = (tag: Tags[number]): Tags[number] => {
+ if (typeof tag === "string" || tag.collection !== undefined) return tag;
+ const { stringify } = tag;
+ if (!NUMBER_TAGS.has(tag.tag) || stringify === undefined) return tag;
+ return {
+ ...tag,
+ stringify: (item, context, ...rest) => {
+ const { source } = item;
+ if (source === undefined) return stringify(item, context, ...rest);
+ const reader = context.doc.schema.tags.find(
+ (candidate): candidate is ScalarTag =>
+ candidate.default === true && candidate.test?.test(source) === true,
+ );
+ const read = reader?.resolve(
+ source,
+ () => undefined,
+ context.doc.options,
+ );
+ return Object.is(isScalar(read) ? read.value : read, item.value)
+ ? source
+ : stringify(item, context, ...rest);
+ },
+ };
+};
+
+const HERMES_YAML_OPTIONS = {
+ customTags: (tags: Tags) => tags.map(keepNumberSource),
+ // Hermes keeps integers exact, so IDs that round to one double, or `0600`
+ // and `600`, are distinct keys.
+ uniqueKeys: (a: ParsedNode, b: ParsedNode) =>
+ a === b ||
+ (isScalar(a) &&
+ isScalar(b) &&
+ a.value === b.value &&
+ a.source === b.source),
+};
+
+/** Parse a Hermes `config.yaml`. */
+export const parseHermesConfigurationYaml = (text: string): unknown =>
+ parse(text, HERMES_YAML_OPTIONS);
+
+/** Set or delete one value in a Hermes `config.yaml`, keeping the rest as written. */
+export const editHermesConfigurationYaml = (
+ text: string,
+ path: readonly string[],
+ value: unknown,
+): string => {
+ const document = parseDocument(text, HERMES_YAML_OPTIONS);
+ if (value === undefined) document.deleteIn(path);
+ else document.setIn(path, value);
+ // Editing REA must not reflow unrelated user prompts or other YAML scalars.
+ return document.toString({ lineWidth: 0 });
+};
diff --git a/src/application/InvestigationProviders.ts b/src/application/InvestigationProviders.ts
index 5dcb18150..af23463f4 100644
--- a/src/application/InvestigationProviders.ts
+++ b/src/application/InvestigationProviders.ts
@@ -20,7 +20,9 @@ export const workflowAnalysisProfile = (
upstream_analysis_profile: upstream,
...(operation === "binary_overview"
? { workflow_revision: 3 }
- : operation === "batch_decompile" || operation === "get_call_graph"
+ : operation === "batch_decompile" ||
+ operation === "get_call_graph" ||
+ operation === "trace_feature"
? { workflow_revision: 2 }
: {}),
});
diff --git a/src/application/MsixPackageStorage.ts b/src/application/MsixPackageStorage.ts
new file mode 100644
index 000000000..098b2f1db
--- /dev/null
+++ b/src/application/MsixPackageStorage.ts
@@ -0,0 +1,187 @@
+import { lstat } from "node:fs/promises";
+import { realpathSync } from "node:fs";
+import { basename, dirname, isAbsolute, join, relative, sep } from "node:path";
+import { err, ok, type Result } from "../domain/result.js";
+
+/**
+ * How one MSIX-packaged client reads its AppData configuration. A package
+ * with write virtualization saves AppData files to its private
+ * `LocalCache\Roaming` copy, then reads that copy whenever it exists and the
+ * ordinary AppData file otherwise.
+ */
+export interface MsixPackageView {
+ readonly packageFamilyName: string;
+ /** The package-private copy, which shadows the AppData file once it exists. */
+ readonly privateConfigPath: string;
+ /** The AppData path that unpackaged processes read and write. */
+ readonly appDataConfigPath: string;
+ /** Roots whose writes the package redirects for processes it starts. */
+ readonly virtualizedRoots: readonly string[];
+ /**
+ * `redirected`: this process sees one of the package's private files at its
+ * AppData path, so the running package started it. `direct`: it does not.
+ * `unknown`: no private file could be compared.
+ */
+ readonly processView: "redirected" | "direct" | "unknown";
+}
+
+/** Windows' roaming and local application data roots; empty means unset. */
+export const windowsAppDataRoots = (
+ home: string,
+ env: Readonly,
+): { readonly roaming: string; readonly local: string } => ({
+ roaming: env.APPDATA?.trim() || join(home, "AppData", "Roaming"),
+ local: env.LOCALAPPDATA?.trim() || join(home, "AppData", "Local"),
+});
+
+/** The per-user root of MSIX package data containers. */
+export const msixPackagesDirectory = (
+ home: string,
+ env: Readonly,
+): string => join(windowsAppDataRoots(home, env).local, "Packages");
+
+/** Whether `path` is `root` or inside it, using the host's path comparison. */
+const pathWithin = (path: string, root: string): boolean => {
+ const inner = relative(root, path);
+ return (
+ inner === "" ||
+ (inner !== ".." && !inner.startsWith(`..${sep}`) && !isAbsolute(inner))
+ );
+};
+
+/**
+ * Name the package whose private `LocalCache` holds a canonical path. Its
+ * processes see those files at virtual AppData locations; other processes do
+ * not, and Windows removes them with the package.
+ */
+export const packagePrivateStorageFamily = (
+ canonicalPath: string,
+ packagesDirectory: string,
+): string | undefined => {
+ if (!pathWithin(canonicalPath, packagesDirectory)) return undefined;
+ const [family, storage] = relative(packagesDirectory, canonicalPath).split(
+ /[\\/]/u,
+ );
+ return family !== undefined &&
+ family !== "" &&
+ storage?.toLowerCase() === "localcache"
+ ? family
+ : undefined;
+};
+
+/**
+ * Explain why setup must not register a launcher that exists only in one
+ * package's private storage. Other clients could not start it, and doctor
+ * outside that package could not verify it.
+ */
+export const packagePrivateLauncherBlocker = (
+ command: readonly string[],
+ packagesDirectory: string,
+ canonicalPath: (path: string) => string = realpathSync.native,
+): string | undefined => {
+ // Compare canonical forms: a short-name, junctioned or substituted profile
+ // spells the same directory differently.
+ let packages = packagesDirectory;
+ try {
+ packages = canonicalPath(packagesDirectory);
+ } catch (cause: unknown) {
+ // Without package storage, the spelled path is the only comparison.
+ void cause;
+ }
+ for (const part of command) {
+ if (!isAbsolute(part)) continue;
+ let resolved: string;
+ try {
+ resolved = canonicalPath(part);
+ } catch (cause: unknown) {
+ // A launcher that cannot be resolved is not evidence of package storage.
+ void cause;
+ continue;
+ }
+ const family = packagePrivateStorageFamily(resolved, packages);
+ if (family !== undefined)
+ return `The REA launcher ${part} is stored at ${resolved}, inside the private storage of MSIX package ${family}. Only processes started by that app can see it at ${part}, and Windows removes it with the package, so other clients could not start this registration. Install REA from a terminal that the app did not start (for example with \`npm install -g rea-agents\`), then rerun setup from that terminal.`;
+ }
+ return undefined;
+};
+
+/**
+ * Explain why this process must not write `targets`: the running package
+ * started it, so writes under its virtualized roots land in that package's
+ * private storage, which the targets' owners never read.
+ */
+const canonicalDestination = (
+ path: string,
+ canonicalPath: (path: string) => string,
+): Result => {
+ let ancestor = path;
+ const missing: string[] = [];
+ while (true) {
+ try {
+ return ok(join(canonicalPath(ancestor), ...missing));
+ } catch (cause: unknown) {
+ if (
+ cause instanceof Error &&
+ "code" in cause &&
+ (cause.code === "ENOENT" || cause.code === "ENOTDIR") &&
+ dirname(ancestor) !== ancestor
+ ) {
+ missing.unshift(basename(ancestor));
+ ancestor = dirname(ancestor);
+ continue;
+ }
+ return err({
+ path,
+ detail: cause instanceof Error ? cause.message : String(cause),
+ });
+ }
+ }
+};
+
+export const redirectedWriteBlocker = (
+ view: MsixPackageView | undefined,
+ targets: readonly string[],
+ operation: "setup" | "uninstall",
+ canonicalPath: (path: string) => string = realpathSync.native,
+): string | undefined => {
+ if (view?.processView !== "redirected" || targets.length === 0)
+ return undefined;
+ const roots: string[] = [];
+ const redirected: string[] = [];
+ for (const root of view.virtualizedRoots) {
+ const resolved = canonicalDestination(root, canonicalPath);
+ if (!resolved.ok)
+ return `Cannot establish the MSIX write location for ${resolved.error.path}: ${resolved.error.detail}. Rerun ${operation} from a terminal that this app did not start.`;
+ roots.push(resolved.value);
+ }
+ for (const target of targets) {
+ const resolved = canonicalDestination(target, canonicalPath);
+ if (!resolved.ok)
+ return `Cannot establish the MSIX write location for ${resolved.error.path}: ${resolved.error.detail}. Rerun ${operation} from a terminal that this app did not start.`;
+ if (roots.some((root) => pathWithin(resolved.value, root)))
+ redirected.push(target);
+ }
+ if (redirected.length === 0) return undefined;
+ return `This process was started by MSIX package ${view.packageFamilyName}, which redirects its writes under ${view.virtualizedRoots.join(" and ")} into the package's private storage. Changes to ${redirected.join(", ")} would not reach the files other apps read. Rerun ${operation} from a terminal that this app did not start.`;
+};
+
+/**
+ * Whether the package began reading its private copy after the AppData file
+ * was chosen, for example by saving its settings when it quit.
+ */
+export const packageReadTargetChanged = async (
+ view: MsixPackageView,
+ configPath: string,
+): Promise => {
+ if (configPath !== view.appDataConfigPath) return false;
+ try {
+ await lstat(view.privateConfigPath);
+ return true;
+ } catch (cause: unknown) {
+ return !(
+ cause instanceof Error &&
+ "code" in cause &&
+ (cause.code === "ENOENT" || cause.code === "ENOTDIR")
+ );
+ }
+};
diff --git a/src/application/Setup.configuration.test.ts b/src/application/Setup.configuration.test.ts
index 4ba11f622..3bd08cd4f 100644
--- a/src/application/Setup.configuration.test.ts
+++ b/src/application/Setup.configuration.test.ts
@@ -1,9 +1,43 @@
import { describe, expect, it } from "vitest";
-import { resolve } from "node:path";
+import { join, resolve } from "node:path";
import { FakeSetupHost, options } from "./Setup.fixture.js";
import { runSetup } from "./Setup.js";
import { setupRegistrationCommand } from "./SetupHost.js";
+import type { MsixPackageView } from "./MsixPackageStorage.js";
+import type { SetupClient } from "./SupportedClients.js";
+
+// Host joins keep containment checks meaningful on POSIX test hosts too.
+const PROFILE = String.raw`C:\Users\a`;
+const ROAMING = join(PROFILE, "AppData", "Roaming");
+const LOCAL = join(PROFILE, "AppData", "Local");
+const PRIVATE_CONFIG = join(
+ LOCAL,
+ "Packages",
+ "Claude_pzs8sxrjxfjjc",
+ "LocalCache",
+ "Roaming",
+ "Claude",
+ "claude_desktop_config.json",
+);
+const APPDATA_CONFIG = join(ROAMING, "Claude", "claude_desktop_config.json");
+
+/** Claude Desktop as setup resolves it from its MSIX package storage. */
+const msixClaudeDesktop = (
+ processView: MsixPackageView["processView"],
+): SetupClient => ({
+ name: "claude_desktop",
+ displayName: "Claude Desktop",
+ configPath: PRIVATE_CONFIG,
+ quitBeforeSetup: true,
+ msixPackage: {
+ packageFamilyName: "Claude_pzs8sxrjxfjjc",
+ privateConfigPath: PRIVATE_CONFIG,
+ appDataConfigPath: APPDATA_CONFIG,
+ virtualizedRoots: [ROAMING, LOCAL],
+ processView,
+ },
+});
describe("setup workflow", () => {
it("omits an aligned managed skill from an otherwise empty plan", async () => {
@@ -293,3 +327,85 @@ describe("setup workflow action selection", () => {
expect(result.remediation).not.toContain("internal_client_key");
});
});
+
+describe("MSIX Claude Desktop setup", () => {
+ it("discloses which file MSIX Claude Desktop reads and that it must be quit", async () => {
+ const host = new FakeSetupHost("win32");
+ host.hopper = join(PROFILE, "Hopper");
+ host.skill = "unchanged";
+ host.clients = [msixClaudeDesktop("direct")];
+
+ const result = await runSetup(
+ { ...options(false), clientIds: ["claude_desktop"], dryRun: true },
+ host,
+ );
+
+ expect(result.status).toBe("planned");
+ const [action] = result.plannedActions;
+ expect(action?.target).toBe(PRIVATE_CONFIG);
+ expect(action?.detail).toContain(
+ `Claude Desktop is installed as MSIX package Claude_pzs8sxrjxfjjc, which reads this package-private file instead of ${APPDATA_CONFIG}.`,
+ );
+ expect(action?.detail).toContain(
+ "Quit Claude Desktop fully before approving; closing its window is not enough.",
+ );
+ });
+
+ it("refuses AppData writes from a process the MSIX package started", async () => {
+ const host = new FakeSetupHost("win32");
+ host.hopper = join(PROFILE, "Hopper");
+ host.skill = "unchanged";
+ const vscode = join(ROAMING, "Code", "User", "mcp.json");
+ host.clients = [
+ msixClaudeDesktop("redirected"),
+ { name: "vscode", displayName: "VS Code", configPath: vscode },
+ {
+ name: "codex",
+ displayName: "Codex",
+ configPath: join(PROFILE, ".codex", "config.toml"),
+ },
+ ];
+
+ const blocked = await runSetup(
+ { ...options(true), clientIds: ["vscode", "codex"] },
+ host,
+ );
+ expect(blocked.status).toBe("needs_human");
+ expect(blocked.remediation).toContain(
+ `Changes to ${vscode} would not reach the files other apps read.`,
+ );
+ expect(host.configurations).toBe(0);
+
+ const homeOnly = await runSetup(
+ { ...options(true), clientIds: ["codex"] },
+ host,
+ );
+ expect(homeOnly.status).toBe("ready");
+ expect(host.configurations).toBe(1);
+ });
+
+ it("refuses registrations whose launcher only one MSIX package can see", async () => {
+ const host = new FakeSetupHost("win32");
+ host.hopper = join(PROFILE, "Hopper");
+ host.registrationCommandBlocker = "Install REA outside the package.";
+ host.clients = [
+ { name: "codex", displayName: "Codex", configPath: "/codex.toml" },
+ ];
+
+ const blocked = await runSetup(
+ { ...options(true), clientIds: ["codex"] },
+ host,
+ );
+ expect(blocked.status).toBe("needs_human");
+ expect(blocked.remediation).toBe("Install REA outside the package.");
+ expect(host.configurations).toBe(0);
+ expect(host.skillInstalls).toBe(0);
+
+ const skillOnly = await runSetup(
+ { ...options(true), clientIds: [], installSkill: true },
+ host,
+ );
+ expect(skillOnly.status).toBe("ready");
+ expect(host.skillInstalls).toBe(1);
+ });
+});
diff --git a/src/application/Setup.fixture.ts b/src/application/Setup.fixture.ts
index a99897494..3c7c21d35 100644
--- a/src/application/Setup.fixture.ts
+++ b/src/application/Setup.fixture.ts
@@ -25,6 +25,7 @@ export class FakeSetupHost implements SetupHost {
return skillDestinations(this.homeDirectory, clientIds);
}
readonly registrationCommand: readonly string[];
+ registrationCommandBlocker?: string;
nodeVersion = "24.18.0";
version: string | undefined = "14.5";
distribution: LinuxDistribution | undefined;
diff --git a/src/application/SetupClientConfiguration.ts b/src/application/SetupClientConfiguration.ts
index 981b829a4..a868c6177 100644
--- a/src/application/SetupClientConfiguration.ts
+++ b/src/application/SetupClientConfiguration.ts
@@ -29,6 +29,7 @@ import { PRODUCT_IDENTITY } from "../identity.js";
import { npxRegistrationCommand } from "./ClientRegistrationIdentity.js";
import { MCP_STARTUP_POLICY } from "../mcpStartupPolicy.js";
import { resolveClientConfigTransactionPath } from "./ClientConfigPath.js";
+import { packageReadTargetChanged } from "./MsixPackageStorage.js";
import {
readRegularFile,
readRegularFileText,
@@ -40,7 +41,10 @@ import type {
ClientConfigurationResult,
SetupProviderEnvironment,
} from "./SetupTypes.js";
-import type { SetupClient } from "./SupportedClients.js";
+import {
+ registrationWriteBlocker,
+ type SetupClient,
+} from "./SupportedClients.js";
export class ClientConfigurationCleanupRollbackFailure extends RegularFileCleanupFailure {
constructor(
@@ -187,6 +191,13 @@ const persistClientConfiguration = async ({
desired,
fallbackServers,
}: ClientConfigurationUpdate): Promise => {
+ // The plan chose this file; an MSIX package may have switched to its
+ // private copy since, for example when it quit.
+ if (
+ client.msixPackage !== undefined &&
+ (await packageReadTargetChanged(client.msixPackage, client.configPath))
+ )
+ return { status: "failed", reason: "target_changed" };
const backupPath =
original === undefined ? undefined : `${client.configPath}.rea.backup`;
let recoveryBackupPath: string | undefined;
@@ -358,6 +369,25 @@ export const inspectClientConfiguration = async (
client: SetupClient,
providerEnvironment: SetupProviderEnvironment,
command: readonly string[],
+): Promise => {
+ const inspection = await inspectClientDocument(
+ client,
+ providerEnvironment,
+ command,
+ );
+ if (inspection.status !== "create" && inspection.status !== "update")
+ return inspection;
+ // A change the running client would overwrite is not a persisted registration.
+ const blocker = registrationWriteBlocker(client, "setup");
+ return blocker === undefined
+ ? inspection
+ : { status: "invalid", remediation: blocker };
+};
+
+const inspectClientDocument = async (
+ client: SetupClient,
+ providerEnvironment: SetupProviderEnvironment,
+ command: readonly string[],
): Promise => {
if (client.configPathError !== undefined)
return { status: "invalid", remediation: client.configPathError };
diff --git a/src/application/SetupClients.ts b/src/application/SetupClients.ts
index d86d04b9e..5ceccb21a 100644
--- a/src/application/SetupClients.ts
+++ b/src/application/SetupClients.ts
@@ -9,6 +9,8 @@ import type { SetupClient } from "./SupportedClients.js";
export const failedConfigurationMessage = (
result: Extract,
): string => {
+ if (result.reason === "target_changed")
+ return "The client began reading a different configuration file after the plan was shown, so no change was made. Rerun setup to review the new target.";
if (result.reason === "path")
return "Agent configuration path could not be safely verified. Check its permissions and, if it is a symbolic link, verify that the link resolves to a regular file owned by the current user, then rerun setup.";
if (result.reason === "backup")
diff --git a/src/application/SetupHost.ts b/src/application/SetupHost.ts
index 7ac6828fd..022cecc62 100644
--- a/src/application/SetupHost.ts
+++ b/src/application/SetupHost.ts
@@ -44,6 +44,10 @@ import {
retryRegularFileCleanup,
} from "./RegularFileRead.js";
import { providerRegistrationEnvironment } from "./SetupRegistrationEnvironment.js";
+import {
+ msixPackagesDirectory,
+ packagePrivateLauncherBlocker,
+} from "./MsixPackageStorage.js";
import type {
SetupHost,
SetupInitialState,
@@ -66,6 +70,31 @@ export const setupRegistrationCommand = (
]
: [resolve(process.argv[1] ?? PRODUCT_IDENTITY.cliBinary), "mcp"];
+/**
+ * The launcher setup registers, and why it must not be registered when it
+ * exists only inside one MSIX package's private storage.
+ */
+const setupRegistration = (
+ platform: NodeJS.Platform,
+ homeDirectory: string,
+ environment: Readonly,
+): Pick => {
+ const registrationCommand = setupRegistrationCommand(
+ platform,
+ invokingPackageRunner(environment, platform),
+ );
+ const registrationCommandBlocker =
+ platform === "win32"
+ ? packagePrivateLauncherBlocker(
+ registrationCommand,
+ msixPackagesDirectory(homeDirectory, environment),
+ )
+ : undefined;
+ return registrationCommandBlocker === undefined
+ ? { registrationCommand }
+ : { registrationCommand, registrationCommandBlocker };
+};
+
export const filterClientsNeedingConfigure = async (
host: SetupHost,
detectedClients: readonly SetupClient[],
@@ -117,10 +146,7 @@ export const systemSetupHost = (
homeDirectory,
skillDestinations: (clientIds) =>
skillDestinations(homeDirectory, clientIds, environment, platform),
- registrationCommand: setupRegistrationCommand(
- platform,
- invokingPackageRunner(environment, platform),
- ),
+ ...setupRegistration(platform, homeDirectory, environment),
nodeVersion: process.versions.node,
macosVersion: () => doctorHost.macosVersion(),
linuxDistribution: readLinuxDistribution,
diff --git a/src/application/SetupPlan.ts b/src/application/SetupPlan.ts
index a78697c80..35db28de4 100644
--- a/src/application/SetupPlan.ts
+++ b/src/application/SetupPlan.ts
@@ -8,12 +8,18 @@ import {
import type { SkillDestination } from "./SetupSkill.js";
import { macHopperInstallDisclosure } from "./MacHopper.js";
import type {
+ ClientConfigurationInspection,
SetupAction,
SetupClientState,
SetupHost,
SetupProviderEnvironment,
} from "./SetupTypes.js";
-import type { SetupClient } from "./SupportedClients.js";
+import {
+ appDataRedirection,
+ registrationPersistenceDetail,
+ type SetupClient,
+} from "./SupportedClients.js";
+import { redirectedWriteBlocker } from "./MsixPackageStorage.js";
import type { DoctorReport } from "./Doctor.js";
import { compareUnicodeCodePoints } from "../domain/unicodeCodePointOrder.js";
@@ -161,12 +167,58 @@ export const planSetupActions = async (input: {
blocker: `${invalid.client.displayName ?? invalid.client.name}: ${invalid.inspection.remediation}`,
};
}
- const clientPlans = inspections.flatMap(({ client, inspection }) =>
+ const clientPlans = plannedClientWrites(
+ inspections,
+ input.discovery.installHopper,
+ );
+ const plannedActions = setupPlan({
+ platform: input.host.platform,
+ homeDirectory: input.host.homeDirectory,
+ installHopper: input.discovery.installHopper,
+ installSkill: input.installSkill,
+ skillClientIds: input.skillClientIds,
+ skillDestinations: input.host.skillDestinations(input.skillClientIds),
+ clients: clientPlans,
+ providerEnvironment: input.providerEnvironment,
+ ...(input.discovery.linuxPackageFamily === undefined
+ ? {}
+ : { linuxPackageFamily: input.discovery.linuxPackageFamily }),
+ command: input.command,
+ });
+ const blocker =
+ (clientPlans.length > 0
+ ? input.host.registrationCommandBlocker
+ : undefined) ??
+ redirectedWriteBlocker(
+ appDataRedirection(input.discovery.clients),
+ plannedActions
+ .filter(({ kind }) => kind !== "install_hopper")
+ .map(({ target }) => target),
+ "setup",
+ );
+ return {
+ plannedActions,
+ selectedClients,
+ clientsToConfigure: selectedClients.filter((client) =>
+ clientPlans.some(({ client: planned }) => planned.name === client.name),
+ ),
+ ...(blocker === undefined ? {} : { blocker }),
+ };
+};
+
+/** Selected clients whose registration setup writes, with the disclosed operation. */
+const plannedClientWrites = (
+ inspections: readonly {
+ readonly client: SetupClient;
+ readonly inspection: ClientConfigurationInspection;
+ }[],
+ installHopper: boolean,
+) =>
+ inspections.flatMap(({ client, inspection }) =>
client.format !== "unsupported" &&
(inspection.status === "create" ||
inspection.status === "update" ||
- (input.discovery.installHopper &&
- inspection.status === "already_current"))
+ (installHopper && inspection.status === "already_current"))
? [
{
client,
@@ -182,27 +234,6 @@ export const planSetupActions = async (input: {
]
: [],
);
- return {
- plannedActions: setupPlan({
- platform: input.host.platform,
- homeDirectory: input.host.homeDirectory,
- installHopper: input.discovery.installHopper,
- installSkill: input.installSkill,
- skillClientIds: input.skillClientIds,
- skillDestinations: input.host.skillDestinations(input.skillClientIds),
- clients: clientPlans,
- providerEnvironment: input.providerEnvironment,
- ...(input.discovery.linuxPackageFamily === undefined
- ? {}
- : { linuxPackageFamily: input.discovery.linuxPackageFamily }),
- command: input.command,
- }),
- selectedClients,
- clientsToConfigure: selectedClients.filter((client) =>
- clientPlans.some(({ client: planned }) => planned.name === client.name),
- ),
- };
-};
/** Describe every selected setup mutation before user approval. */
const setupPlan = (input: {
@@ -259,7 +290,7 @@ const setupPlan = (input: {
label: client.displayName ?? client.name,
target: client.configPath,
detail: clientConfigurationDetail(
- client.displayName ?? client.name,
+ client,
input.command,
input.providerEnvironment,
input.installHopper,
@@ -303,7 +334,7 @@ const majorVersion = (version: string): number =>
Number.parseInt(version.split(".")[0] ?? "0", 10);
const clientConfigurationDetail = (
- client: string,
+ client: SetupClient,
command: readonly string[],
environment: SetupProviderEnvironment,
installHopper: boolean,
@@ -320,5 +351,6 @@ const clientConfigurationDetail = (
? " If this plan installs Hopper, REA will add HOPPER_LAUNCHER_PATH using the launcher path reported by that installation."
: " The HOPPER_LAUNCHER_PATH value shown above is the current fallback; if this plan installs Hopper, REA will replace it with the launcher path reported by that installation."
: "";
- return `Add the REA MCP registration for ${client}; preserve unrelated configuration. The backup path reflects the configuration inspected for this plan; if that file changes before execution, setup will select a recovery path for its current contents. Command: ${command.map((part) => JSON.stringify(part)).join(" ")}.${environmentDetail}${hopperDetail}`;
+ const persistence = registrationPersistenceDetail(client);
+ return `Add the REA MCP registration for ${client.displayName ?? client.name}; preserve unrelated configuration. The backup path reflects the configuration inspected for this plan; if that file changes before execution, setup will select a recovery path for its current contents. Command: ${command.map((part) => JSON.stringify(part)).join(" ")}.${environmentDetail}${hopperDetail}${persistence === undefined ? "" : ` ${persistence}`}`;
};
diff --git a/src/application/SetupTypes.ts b/src/application/SetupTypes.ts
index 241e0f6dd..f0cf61c59 100644
--- a/src/application/SetupTypes.ts
+++ b/src/application/SetupTypes.ts
@@ -25,7 +25,12 @@ export type ClientConfigurationResult =
}
| {
readonly status: "failed";
- readonly reason: "path" | "backup" | "write" | "readback";
+ readonly reason:
+ | "path"
+ | "target_changed"
+ | "backup"
+ | "write"
+ | "readback";
}
| {
readonly status: "failed";
@@ -55,6 +60,8 @@ export interface SetupHost {
readonly homeDirectory: string;
skillDestinations(clientIds: readonly string[]): readonly SkillDestination[];
readonly registrationCommand: readonly string[];
+ /** Why no client may be registered with `registrationCommand` from this host. */
+ readonly registrationCommandBlocker?: string;
readonly nodeVersion: string;
macosVersion(): Promise;
linuxDistribution(): Promise;
diff --git a/src/application/SupportedClients.ts b/src/application/SupportedClients.ts
index 5839409d4..8407da4c0 100644
--- a/src/application/SupportedClients.ts
+++ b/src/application/SupportedClients.ts
@@ -7,6 +7,8 @@ import {
resolveHermesClientHome,
} from "./HermesClientHome.js";
import { compareUnicodeCodePoints } from "../domain/unicodeCodePointOrder.js";
+import { resolveWindowsClaudeDesktopLocation } from "./ClaudeDesktopConfigLocation.js";
+import type { MsixPackageView } from "./MsixPackageStorage.js";
/** One supported client configuration location. */
export interface SetupClient {
@@ -29,6 +31,10 @@ export interface SetupClient {
/** Same-scope fallback ZCode stops loading after its first native server. */
readonly zcodeFallbackPath?: string;
readonly markerPath?: string;
+ /** MSIX package storage that decides which configuration the client reads. */
+ readonly msixPackage?: MsixPackageView;
+ /** A running client can rewrite its configuration from memory. */
+ readonly quitBeforeSetup?: boolean;
readonly format?:
| "json"
| "toml"
@@ -61,12 +67,35 @@ interface ClientPathContext {
readonly env: Readonly;
}
-interface ClientDefinition {
+/** One resolved configuration location and its detection evidence. */
+interface ClientLocation {
+ readonly configPath: string;
+ readonly markerPath: string;
+ readonly msixPackage?: MsixPackageView;
+}
+
+type ClientDefinition = ClientDefinitionBase &
+ (
+ | {
+ readonly configPath: ClientPath;
+ readonly markerPath: ClientPath;
+ readonly location?: undefined;
+ }
+ | {
+ /** Resolve configuration and marker together when they share probes. */
+ readonly location: (
+ context: ClientPathContext,
+ ) => Result;
+ readonly configPath?: undefined;
+ readonly markerPath?: undefined;
+ }
+ );
+
+interface ClientDefinitionBase {
readonly name: string;
readonly displayName: string;
- readonly configPath: ClientPath;
- readonly markerPath: ClientPath;
readonly format: NonNullable;
+ readonly quitBeforeSetup?: boolean;
readonly zcodeFallbackPath?: (context: ClientPathContext) => string;
readonly skillPath?: ClientPath;
readonly configPaths?: (context: ClientPathContext) => readonly string[];
@@ -111,16 +140,20 @@ const traeUserDirectory = ({
return join(xdgConfigHome({ home, platform, env }), "Trae", "User");
};
-const claudeDesktopDirectory = ({
- home,
- platform,
- env,
-}: ClientPathContext): string => {
- if (platform === "win32")
- return join(env.APPDATA ?? join(home, "AppData", "Roaming"), "Claude");
- if (platform === "linux")
- return join(xdgConfigHome({ home, platform, env }), "Claude");
- return join(home, "Library", "Application Support", "Claude");
+/** Windows packaging decides which file Claude Desktop reads; see its resolver. */
+const claudeDesktopLocation = (
+ context: ClientPathContext,
+): Result => {
+ if (context.platform === "win32")
+ return resolveWindowsClaudeDesktopLocation(context.home, context.env);
+ const directory =
+ context.platform === "linux"
+ ? join(xdgConfigHome(context), "Claude")
+ : join(context.home, "Library", "Application Support", "Claude");
+ return ok({
+ configPath: join(directory, "claude_desktop_config.json"),
+ markerPath: directory,
+ });
};
const claudeCodeConfigDirectory = ({ home, env }: ClientPathContext): string =>
@@ -135,6 +168,9 @@ const codexDirectory = ({ home, env }: ClientPathContext): string =>
const qoderDirectory = ({ home, env }: ClientPathContext): string =>
env.QODER_CONFIG_DIR || join(home, ".qoder");
+const factoryDirectory = ({ home }: ClientPathContext): string =>
+ join(home, ".factory");
+
/** Match Qwen Code's home override, including tilde and cwd-relative paths. */
const qwenCodeDirectory = ({ home, env }: ClientPathContext): string => {
const override = env.QWEN_HOME;
@@ -208,6 +244,55 @@ export const manualRegistrationRemediation = (
? GROK_BOT_MANUAL_REGISTRATION_REMEDIATION
: undefined;
+/**
+ * Facts a setup plan must disclose so an approved registration persists:
+ * which file an MSIX package reads, and that a running client can overwrite it.
+ */
+export const registrationPersistenceDetail = (
+ client: SetupClient,
+): string | undefined => {
+ const name = client.displayName ?? client.name;
+ const msix = client.msixPackage;
+ const packageDetail =
+ msix === undefined
+ ? undefined
+ : client.configPath === msix.privateConfigPath
+ ? `${name} is installed as MSIX package ${msix.packageFamilyName}, which reads this package-private file instead of ${msix.appDataConfigPath}.`
+ : `${name} is installed as MSIX package ${msix.packageFamilyName}, which reads this file until it saves its own copy at ${msix.privateConfigPath}.`;
+ const quitDetail =
+ client.quitBeforeSetup === true
+ ? `Quit ${name} fully before approving; closing its window is not enough. A running ${name} can rewrite this file from memory and drop the registration. Start it again after setup.`
+ : undefined;
+ const details = [packageDetail, quitDetail].filter(
+ (detail): detail is string => detail !== undefined,
+ );
+ return details.length === 0 ? undefined : details.join(" ");
+};
+
+/**
+ * Why this process must not change an MSIX client's configuration. A process
+ * the running app started sees its redirected AppData, and the app would
+ * overwrite the change from memory; an unknown view cannot rule that out.
+ */
+export const registrationWriteBlocker = (
+ client: SetupClient,
+ operation: "setup" | "uninstall",
+): string | undefined => {
+ const msix = client.msixPackage;
+ if (msix === undefined || msix.processView === "direct") return undefined;
+ const name = client.displayName ?? client.name;
+ return msix.processView === "redirected"
+ ? `This process was started from ${name}'s MSIX package ${msix.packageFamilyName}: its AppData is redirected into that package, so ${name} is running and would overwrite ${msix.privateConfigPath} from memory. Quit ${name} fully, then rerun ${operation} from a terminal that ${name} did not start.`
+ : `REA cannot tell whether ${name}'s MSIX package ${msix.packageFamilyName} started this process, because none of its files under ${dirname(msix.privateConfigPath)} could be compared with ${dirname(msix.appDataConfigPath)}. A running ${name} would overwrite the change. Open ${name} once if it has never run, quit it fully, then rerun ${operation} from a terminal that ${name} did not start.`;
+};
+
+/** The MSIX package view, if any, that redirects this process's AppData writes. */
+export const appDataRedirection = (
+ clients: readonly SetupClient[],
+): MsixPackageView | undefined =>
+ clients.find(({ msixPackage }) => msixPackage?.processView === "redirected")
+ ?.msixPackage;
+
const OMP_PROFILE_NAME = /^[a-z0-9][a-z0-9._-]{0,63}$/u;
const OMP_RESERVED_PROFILE =
/^(?:CON|PRN|AUX|NUL|COM[0-9]|LPT[0-9])(?:\..*)?$/iu;
@@ -405,9 +490,8 @@ export const SUPPORTED_CLIENT_DEFINITIONS = [
{
name: "claude_desktop",
displayName: "Claude Desktop",
- configPath: (context: ClientPathContext) =>
- join(claudeDesktopDirectory(context), "claude_desktop_config.json"),
- markerPath: claudeDesktopDirectory,
+ location: claudeDesktopLocation,
+ quitBeforeSetup: true,
format: "json",
},
{
@@ -558,6 +642,16 @@ export const SUPPORTED_CLIENT_DEFINITIONS = [
markerPath: qoderDirectory,
format: "json",
},
+ {
+ name: "droid",
+ displayName: "Factory Droid",
+ skillPath: (context: ClientPathContext) =>
+ join(factoryDirectory(context), "skills"),
+ configPath: (context: ClientPathContext) =>
+ join(factoryDirectory(context), "mcp.json"),
+ markerPath: factoryDirectory,
+ format: "json",
+ },
{
name: "zcode",
zcodeFallbackPath: ({ home }: ClientPathContext) =>
@@ -614,6 +708,19 @@ const resolvePath = (
return typeof resolved === "string" ? ok(resolved) : resolved;
};
+const resolveLocation = (
+ definition: ClientDefinition,
+ context: ClientPathContext,
+): Result => {
+ if (definition.location !== undefined) return definition.location(context);
+ const config = resolvePath(definition.configPath, context);
+ if (!config.ok) return config;
+ const marker = resolvePath(definition.markerPath, context);
+ return marker.ok
+ ? ok({ configPath: config.value, markerPath: marker.value })
+ : marker;
+};
+
/** Describe every client location that setup, doctor, or uninstall may inspect. */
export const supportedClients = (
home: string,
@@ -624,27 +731,16 @@ export const supportedClients = (
const definitions: readonly ClientDefinition[] = SUPPORTED_CLIENT_DEFINITIONS;
return definitions.map((definition) => {
try {
- const config = resolvePath(definition.configPath, context);
- const marker = config.ok
- ? resolvePath(definition.markerPath, context)
- : config;
- if (!config.ok)
+ const location = resolveLocation(definition, context);
+ if (!location.ok)
return {
name: definition.name,
displayName: definition.displayName,
format: definition.format,
- configPath: config.error.path,
- configPathError: config.error.message,
+ configPath: location.error.path,
+ configPathError: location.error.message,
};
- if (!marker.ok)
- return {
- name: definition.name,
- displayName: definition.displayName,
- format: definition.format,
- configPath: marker.error.path,
- configPathError: marker.error.message,
- };
- const configPath = config.value;
+ const { configPath, markerPath, msixPackage } = location.value;
return {
name: definition.name,
displayName: definition.displayName,
@@ -662,7 +758,11 @@ export const supportedClients = (
...(definition.zcodeFallbackPath === undefined
? {}
: { zcodeFallbackPath: definition.zcodeFallbackPath(context) }),
- markerPath: marker.value,
+ markerPath,
+ ...(msixPackage === undefined ? {} : { msixPackage }),
+ ...(definition.quitBeforeSetup === true
+ ? { quitBeforeSetup: true }
+ : {}),
format: definition.format,
};
} catch (cause: unknown) {
diff --git a/src/application/Uninstall.ts b/src/application/Uninstall.ts
index a7f051a49..a4561c45e 100644
--- a/src/application/Uninstall.ts
+++ b/src/application/Uninstall.ts
@@ -32,10 +32,16 @@ import {
} from "./RegularFileRead.js";
import { ArtifactResourceScope } from "../artifacts/ArtifactResourceScope.js";
import {
+ appDataRedirection,
manualRegistrationRemediation,
+ registrationWriteBlocker,
supportedClients,
type SetupClient,
} from "./SupportedClients.js";
+import {
+ redirectedWriteBlocker,
+ type MsixPackageView,
+} from "./MsixPackageStorage.js";
export { isUninstallFailure } from "./UninstallFailure.js";
interface ManagedPathStats {
@@ -93,6 +99,7 @@ export interface UninstallHost {
/** Report a configuration that cannot be read safely, before any removal. */
inspectClient(client: SetupClient): Promise;
removeClient(client: SetupClient): Promise;
+ inspectSkill?(): Promise;
removeSkill(): Promise;
purgeData(): Promise;
close?(): Promise;
@@ -118,6 +125,8 @@ export const runUninstall = async (
const blocking = await host.inspectClient(client);
if (blocking !== undefined) blocked.push(blocking);
}
+ const skillBlocker = await host.inspectSkill?.();
+ if (skillBlocker !== undefined) blocked.push(skillBlocker);
const items: UninstallItem[] =
blocked.length > 0
? [
@@ -209,27 +218,70 @@ export const systemUninstallHost = (
selectedHome ?? homeDirectoryFromEnvironment(environment, platform);
const resources = new ArtifactResourceScope();
const fileSystem = selectedFileSystem ?? systemFileSystem(resources);
+ // Set with the client list: the package view that redirects this
+ // process's AppData writes, if any.
+ let redirection: MsixPackageView | undefined;
+ const clientWriteBlocker = (client: SetupClient): string | undefined =>
+ registrationWriteBlocker(client, "uninstall") ??
+ redirectedWriteBlocker(redirection, [client.configPath], "uninstall");
+ const skillWriteBlocker = (path: string): string | undefined =>
+ redirectedWriteBlocker(redirection, [path], "uninstall");
return {
- clients: () =>
- Promise.resolve(
- supportedClients(home, platform, environment).flatMap((client) =>
- client.configPaths === undefined
- ? [client]
- : client.configPaths.map((configPath) => ({
- ...client,
- configPath,
- })),
+ clients: () => {
+ const clients = supportedClients(home, platform, environment);
+ redirection = appDataRedirection(clients);
+ return Promise.resolve(
+ clients.flatMap((client) =>
+ uninstallConfigPaths(client).map((configPath) => ({
+ ...client,
+ configPath,
+ })),
),
- ),
+ );
+ },
inspectClient: async (client) => {
const read = await readClientConfiguration(client, fileSystem);
- return read.kind === "item" && read.item.status === "failed"
- ? read.item
- : undefined;
+ if (read.kind === "item")
+ return read.item.status === "failed" ? read.item : undefined;
+ const removal = clientRegistrationRemoval(read.parsed, client);
+ if (!removal.removeNative && removal.legacyPath === undefined)
+ return undefined;
+ // A removal the running package would revert, or redirect into its
+ // private storage, would leave the registration in place.
+ const blocker = clientWriteBlocker(client);
+ return blocker === undefined
+ ? undefined
+ : item(client.name, "failed", blocker);
+ },
+ removeClient: (client) =>
+ removeClient(client, fileSystem, () => clientWriteBlocker(client)),
+ inspectSkill: async () => {
+ for (const destination of skillDestinations(
+ home,
+ undefined,
+ environment,
+ platform,
+ )) {
+ const inspected = await inspectManagedSkill(
+ destination.path,
+ destination.client,
+ fileSystem,
+ );
+ if (inspected?.status === "failed") return inspected;
+ if (inspected !== undefined) continue;
+ const blocker = skillWriteBlocker(destination.path);
+ if (blocker !== undefined) return item("skill", "failed", blocker);
+ }
+ return undefined;
},
- removeClient: (client) => removeClient(client, fileSystem),
removeSkill: () =>
- removeManagedSkills(home, fileSystem, environment, platform),
+ removeManagedSkills(
+ home,
+ fileSystem,
+ environment,
+ platform,
+ skillWriteBlocker,
+ ),
purgeData: () => purgeManagedData(join(home, ".rea"), fileSystem),
close: async () => {
try {
@@ -242,6 +294,36 @@ export const systemUninstallHost = (
};
};
+/**
+ * Every user file that can hold REA's registration for one client. An MSIX
+ * package can read either its private copy or the AppData file, and earlier
+ * setups wrote the AppData file, so both lose REA's entry.
+ */
+const uninstallConfigPaths = (client: SetupClient): readonly string[] => [
+ ...new Set([
+ ...(client.configPaths ?? [client.configPath]),
+ ...(client.msixPackage === undefined
+ ? []
+ : [
+ client.msixPackage.privateConfigPath,
+ client.msixPackage.appDataConfigPath,
+ ]),
+ ]),
+];
+
+/** Whether removal would change this configuration. */
+const registrationPresent = (parsed: ClientConfigurationDocument): boolean => {
+ const name = PRODUCT_IDENTITY.mcpServerKey;
+ return (
+ Object.hasOwn(parsed.servers, name) ||
+ // Beside a native OpenCode V2 table, OpenCode also loads a V1 `mcp.rea`.
+ legacyClientServerPath(parsed, name) !== undefined ||
+ // Harness ownership is the stable entry id. A stale or malformed launcher
+ // still belongs to that id, and so does a direct patch that projects no row.
+ (parsed.dialect === "dsh" && dshDocument(parsed.document).carriesEntry)
+ );
+};
+
type ClientConfigurationRead =
| { readonly kind: "item"; readonly item: UninstallItem }
| {
@@ -308,21 +390,47 @@ const itemRead = (result: UninstallItem): ClientConfigurationRead => ({
item: result,
});
+/**
+ * Share the exact ownership and applicability decision with preflight. A
+ * removable legacy entry carries its document path, so removal edits exactly
+ * the entry this decision admitted.
+ */
+const clientRegistrationRemoval = (
+ parsed: ClientConfigurationDocument,
+ client: SetupClient,
+): {
+ readonly removeNative: boolean;
+ readonly legacyPath: readonly string[] | undefined;
+} => {
+ const name = PRODUCT_IDENTITY.mcpServerKey;
+ if (
+ parsed.dialect === "dsh" &&
+ dshDocument(parsed.document).hasUnknownStructure
+ )
+ return { removeNative: false, legacyPath: undefined };
+ const legacyPath = legacyClientServerPath(parsed, name);
+ return {
+ removeNative:
+ (parsed.dialect === "dsh" && dshDocument(parsed.document).carriesEntry) ||
+ (Object.hasOwn(parsed.servers, name) &&
+ isOwnedRegistration(parsed.servers[name], client)),
+ legacyPath:
+ legacyPath !== undefined &&
+ isOwnedRegistration(parsed.legacyServers[name], client)
+ ? legacyPath
+ : undefined,
+ };
+};
+
const removeClient = async (
client: SetupClient,
fileSystem: UninstallFileSystem,
+ writeBlocker?: () => string | undefined,
): Promise => {
const read = await readClientConfiguration(client, fileSystem);
if (read.kind === "item") return read.item;
const { transactionPath, original, parsed } = read;
const name = PRODUCT_IDENTITY.mcpServerKey;
- // Beside a native OpenCode V2 table, OpenCode also loads a V1 `mcp.rea`.
- const legacyPath = legacyClientServerPath(parsed, name);
- const hasNative = Object.hasOwn(parsed.servers, name);
- // Harness ownership is the stable entry id. A stale or malformed launcher
- // still belongs to that id, and so does a direct patch that projects no row.
- const carriesDshEntry =
- parsed.dialect === "dsh" && dshDocument(parsed.document).carriesEntry;
if (
parsed.dialect === "dsh" &&
dshDocument(parsed.document).hasUnknownStructure
@@ -332,20 +440,21 @@ const removeClient = async (
"retained",
"A Cordis expression may produce registration rows, so the patch was retained without changes.",
);
- if (!hasNative && legacyPath === undefined && !carriesDshEntry)
+ if (!registrationPresent(parsed))
return item(client.name, "skipped", "REA registration is absent.");
- const removeNative =
- carriesDshEntry ||
- (hasNative && isOwnedRegistration(parsed.servers[name], client));
- const removeLegacy =
- legacyPath !== undefined &&
- isOwnedRegistration(parsed.legacyServers[name], client);
+ const { removeNative, legacyPath } = clientRegistrationRemoval(
+ parsed,
+ client,
+ );
+ const removeLegacy = legacyPath !== undefined;
if (!removeNative && !removeLegacy)
return item(
client.name,
"retained",
"The rea-named registration is not REA-owned.",
);
+ const blocker = writeBlocker?.();
+ if (blocker !== undefined) return item(client.name, "failed", blocker);
const remaining = { ...parsed.servers };
if (removeNative) delete remaining[name];
const document = withClientServers(
@@ -355,7 +464,7 @@ const removeClient = async (
);
const editedPaths = [
...(removeNative ? [clientServerPath(parsed, name)] : []),
- ...(removeLegacy ? [legacyPath] : []),
+ ...(legacyPath === undefined ? [] : [legacyPath]),
];
const backupPath = `${client.configPath}.rea.backup`;
try {
@@ -516,12 +625,13 @@ const removeManagedSkills = async (
fileSystem: UninstallFileSystem,
environment: Readonly,
platform: NodeJS.Platform,
+ writeBlocker?: (path: string) => string | undefined,
): Promise => {
// Every destination shares one summary item, so each result is labeled by
// the directory it refers to.
const results = await Promise.all(
skillDestinations(home, undefined, environment, platform).map(({ path }) =>
- removeManagedSkill(path, path, fileSystem),
+ removeManagedSkill(path, path, fileSystem, writeBlocker),
),
);
const failed = results.find(({ status }) => status === "failed");
@@ -552,11 +662,11 @@ const removeManagedSkills = async (
);
};
-const removeManagedSkill = async (
+const inspectManagedSkill = async (
path: string,
name: string,
fileSystem: UninstallFileSystem,
-): Promise => {
+): Promise => {
let root: ManagedPathStats;
try {
root = await fileSystem.stat(path);
@@ -594,6 +704,20 @@ const removeManagedSkill = async (
if (!isManagedSkillManifest(content))
return item(name, "retained", "Skill manifest is not REA-owned.");
+ return undefined;
+};
+
+const removeManagedSkill = async (
+ path: string,
+ name: string,
+ fileSystem: UninstallFileSystem,
+ writeBlocker?: (path: string) => string | undefined,
+): Promise => {
+ const inspection = await inspectManagedSkill(path, name, fileSystem);
+ if (inspection !== undefined) return inspection;
+ const blocker = writeBlocker?.(path);
+ if (blocker !== undefined) return item(name, "failed", blocker);
+
const manifestName = "SKILL.md";
const otherFiles = MANAGED_SKILL_FILES.filter(
(relativePath) => relativePath !== manifestName,
diff --git a/src/application/binary/AnalysisProviderEvaluation.ts b/src/application/binary/AnalysisProviderEvaluation.ts
index 1654ab783..27292ed31 100644
--- a/src/application/binary/AnalysisProviderEvaluation.ts
+++ b/src/application/binary/AnalysisProviderEvaluation.ts
@@ -12,7 +12,7 @@ import { jsonObjectSchema, type JsonValue } from "../../domain/jsonValue.js";
import { err, ok, type Result } from "../../domain/result.js";
import type { AnalysisProviderCandidate } from "../AnalysisProvider.js";
import type { AnalysisProviderCandidateStatus } from "./AnalysisProviderRegistry.js";
-import { ABORTED, waitForAbortable } from "./AbortablePromise.js";
+import { ABORTED, waitForAbortable } from "../../process/AbortablePromise.js";
/** Profile-resolution truth for one discovered provider candidate. */
export interface AnalysisProviderCandidateEvaluation {
diff --git a/src/application/binary/AnalysisSnapshotCache.test.ts b/src/application/binary/AnalysisSnapshotCache.test.ts
index 48c2a54bd..91b9f8807 100644
--- a/src/application/binary/AnalysisSnapshotCache.test.ts
+++ b/src/application/binary/AnalysisSnapshotCache.test.ts
@@ -661,3 +661,52 @@ it("does not replay pre-envelope call graphs under the revised workflow profile"
}).success,
).toBe(false);
});
+
+describe("executions that report truncated references", () => {
+ const record = (referencesTruncated: boolean | undefined) => {
+ const cache = new AnalysisSnapshotCache();
+ const parameters = { address: "0x1000", document: "fixture" };
+ cache.record({
+ target: ANALYSIS_SNAPSHOT_TARGET,
+ profile: ANALYSIS_SNAPSHOT_PROFILE,
+ operation: "xrefs",
+ parameters,
+ execution: createAnalysisExecution(
+ ["0x2000"],
+ ANALYSIS_SNAPSHOT_PROVIDER,
+ {
+ subject: ANALYSIS_SNAPSHOT_TARGET,
+ analysisProfile: ANALYSIS_SNAPSHOT_PROFILE,
+ ...(referencesTruncated === undefined ? {} : { referencesTruncated }),
+ },
+ ),
+ });
+ return cache.lookup(
+ ANALYSIS_SNAPSHOT_TARGET,
+ ANALYSIS_SNAPSHOT_PROFILE,
+ "xrefs",
+ parameters,
+ );
+ };
+
+ it("are not replayed, because a replay would lose the truncation", () => {
+ expect(record(true)).toBeUndefined();
+ });
+
+ it("do not stop an execution that is complete or silent from being replayed", () => {
+ expect(record(false)?.result).toEqual(["0x2000"]);
+ expect(record(undefined)?.result).toEqual(["0x2000"]);
+ });
+});
+
+it("revises the trace_feature workflow profile so earlier results are not replayed", () => {
+ const profile = ANALYSIS_SNAPSHOT_PROFILE;
+
+ expect(workflowAnalysisProfile(profile, "trace_feature")).not.toEqual(
+ workflowAnalysisProfile(profile),
+ );
+ expect(
+ workflowAnalysisProfile(profile, "trace_call_path"),
+ "other workflows keep their profile",
+ ).toEqual(workflowAnalysisProfile(profile));
+});
diff --git a/src/application/binary/AnalysisSnapshotCache.ts b/src/application/binary/AnalysisSnapshotCache.ts
index bdaa9f68d..79e212cac 100644
--- a/src/application/binary/AnalysisSnapshotCache.ts
+++ b/src/application/binary/AnalysisSnapshotCache.ts
@@ -84,6 +84,11 @@ export const isSnapshotCacheable = (
descriptor.effects.mayWriteFilesystem === false) &&
descriptor.effects.changesPermissions === false;
+/** Windows Ghidra must admit the selected source through its native snapshot owner. */
+export const requiresNativeSourceAdmissionBeforeReplay = (
+ providerId: string | undefined,
+): boolean => process.platform === "win32" && providerId === "ghidra";
+
/** Bounded in-memory cache for one immutable binary identity. */
export class AnalysisSnapshotCache {
readonly #entries = new Map();
@@ -337,6 +342,9 @@ export class AnalysisSnapshotCache {
}): void {
const { target, profile, operation, parameters, execution } = input;
this.select(target, profile);
+ // The snapshot format does not carry reference truncation; a replay would
+ // present a capped read as complete, so it is not recorded.
+ if (execution.referencesTruncated === true) return;
const queryId = analysisQueryId(
snapshotTarget(target),
snapshotBinding(profile),
diff --git a/src/application/binary/BinarySession.ts b/src/application/binary/BinarySession.ts
index f7b2d3529..3da571832 100644
--- a/src/application/binary/BinarySession.ts
+++ b/src/application/binary/BinarySession.ts
@@ -58,6 +58,7 @@ interface SessionBinding {
readonly profile: AnalysisProfileCommitment | null;
readonly route: SessionProviderRoute;
readonly runId: string;
+ nativeSourceAdmitted: boolean;
}
/**
@@ -323,6 +324,7 @@ export class BinarySession
profile,
route,
runId,
+ nativeSourceAdmitted: false,
};
this.#clearRuntimeAvailability();
this.resetSnapshotInvalidation();
@@ -609,6 +611,7 @@ export class BinarySession
active: this.#active,
operation: name,
parameters: arguments_,
+ nativeSourceAdmitted: this.#active?.nativeSourceAdmitted === true,
unboundOperationError: (operation, route) =>
this.#providerRouter.unboundOperationError(operation, route),
lookupSnapshot: (target, profile, operation, parameters) =>
@@ -645,6 +648,14 @@ export class BinarySession
},
})
: profiled;
+ // A successful Ghidra operation proves this client's native source snapshot
+ // was admitted; a composite health response and parsed path do not.
+ if (
+ execution.ok &&
+ capability.provider.id === "ghidra" &&
+ this.#active === active
+ )
+ this.#active.nativeSourceAdmitted = true;
this.#observeRuntimeAvailability(name, execution);
if (
execution.ok &&
@@ -838,6 +849,7 @@ export class BinarySession
profile: previous.profile,
route: previous.route,
runId,
+ nativeSourceAdmitted: false,
};
return ok(null);
}
diff --git a/src/application/binary/BinarySessionExecution.ts b/src/application/binary/BinarySessionExecution.ts
index 996749aae..73dfe4eea 100644
--- a/src/application/binary/BinarySessionExecution.ts
+++ b/src/application/binary/BinarySessionExecution.ts
@@ -13,7 +13,10 @@ import type {
AnalysisOperation,
CapabilityDescriptor,
} from "../AnalysisProvider.js";
-import { isSnapshotCacheable } from "./AnalysisSnapshotCache.js";
+import {
+ isSnapshotCacheable,
+ requiresNativeSourceAdmissionBeforeReplay,
+} from "./AnalysisSnapshotCache.js";
import type { SessionProviderRoute } from "./SessionProviderRouter.js";
interface ActiveExecutionBinding {
@@ -35,6 +38,7 @@ interface PrepareSessionExecutionInput {
readonly active: ActiveExecutionBinding | undefined;
readonly operation: AnalysisOperation;
readonly parameters: Readonly>;
+ readonly nativeSourceAdmitted: boolean;
readonly unboundOperationError: (
operation: AnalysisOperation,
route: SessionProviderRoute,
@@ -55,6 +59,7 @@ export const prepareSessionExecution = (
active,
operation,
parameters,
+ nativeSourceAdmitted,
unboundOperationError,
lookupSnapshot,
} = input;
@@ -79,9 +84,12 @@ export const prepareSessionExecution = (
const cacheable =
profile !== undefined &&
isSnapshotCacheable(operation, capability, parameters);
- const cached = cacheable
- ? lookupSnapshot(active.target, profile, operation, parameters)
- : undefined;
+ const cached =
+ cacheable &&
+ (!requiresNativeSourceAdmissionBeforeReplay(capability.provider.id) ||
+ nativeSourceAdmitted)
+ ? lookupSnapshot(active.target, profile, operation, parameters)
+ : undefined;
return ok({ active, capability, profile, cacheable, cached });
};
diff --git a/src/application/binary/BinarySessionOpen.ts b/src/application/binary/BinarySessionOpen.ts
index 8d810e671..cd5f6be4a 100644
--- a/src/application/binary/BinarySessionOpen.ts
+++ b/src/application/binary/BinarySessionOpen.ts
@@ -92,9 +92,7 @@ export const resolveSessionTarget = async (
input: ResolveSessionTargetInput,
): Promise> => {
const { router, current, target, options } = input;
- const sameTarget =
- current?.target.path === target.path &&
- snapshotMatchesTarget(snapshotTarget(current.target), target);
+ const sameTarget = sameSessionTarget(current?.target, target);
const resolvedRoute =
sameTarget && options.providerId === undefined && current !== undefined
? ({ ok: true, value: current.route } as const)
@@ -113,9 +111,7 @@ export const validateResolvedSessionTarget = (
},
): Result => {
const { current, target, route, options, stagedSnapshotMatches } = input;
- const sameTarget =
- current?.target.path === target.path &&
- snapshotMatchesTarget(snapshotTarget(current.target), target);
+ const sameTarget = sameSessionTarget(current?.target, target);
const snapshotError = validateSnapshot({
snapshot: options.snapshot,
target,
@@ -127,6 +123,16 @@ export const validateResolvedSessionTarget = (
return { ok: true, value: { target, route, sameTarget } };
};
+const sameSessionTarget = (
+ current: BinaryTarget | undefined,
+ target: BinaryTarget,
+): boolean =>
+ current !== undefined &&
+ current.path === target.path &&
+ // Native admission is bound to the requested path, not just its realpath.
+ (current.sourcePath ?? current.path) === (target.sourcePath ?? target.path) &&
+ snapshotMatchesTarget(snapshotTarget(current), target);
+
interface ValidateSnapshotInput {
readonly snapshot: AnalysisSnapshot | undefined;
readonly target: BinaryTarget;
diff --git a/src/application/binary/LazyAnalysisProvider.ts b/src/application/binary/LazyAnalysisProvider.ts
index a87e77445..095acf5ed 100644
--- a/src/application/binary/LazyAnalysisProvider.ts
+++ b/src/application/binary/LazyAnalysisProvider.ts
@@ -5,7 +5,7 @@ import { AnalysisError } from "../../domain/analysisErrorBase.js";
import { ProviderAdapterError } from "../../domain/providerAdapterError.js";
import type { ProviderOperationHealth } from "../../domain/providerOperationHealth.js";
import { err, ok } from "../../domain/result.js";
-import { ABORTED, waitForAbortable } from "./AbortablePromise.js";
+import { ABORTED, waitForAbortable } from "../../process/AbortablePromise.js";
import type {
AnalysisClient,
AnalysisClientContext,
diff --git a/src/application/javascript/ElectronBoundaryGraphCallPaths.ts b/src/application/javascript/ElectronBoundaryGraphCallPaths.ts
index 4447d59db..b815e82bf 100644
--- a/src/application/javascript/ElectronBoundaryGraphCallPaths.ts
+++ b/src/application/javascript/ElectronBoundaryGraphCallPaths.ts
@@ -51,6 +51,9 @@ export const addElectronCallPaths = (
properties: {
path_id: pathId,
entry: path.entry,
+ ...(path.entry_path === undefined
+ ? {}
+ : { entry_path: [...path.entry_path] }),
entry_kind: path.entry_kind,
channel: path.channel,
terminal: path.terminal,
@@ -97,6 +100,9 @@ export const addElectronCallPaths = (
properties: {
path_id: pathId,
entry: path.entry,
+ ...(path.entry_path === undefined
+ ? {}
+ : { entry_path: [...path.entry_path] }),
resolution: "candidate",
},
});
@@ -119,6 +125,9 @@ export const addElectronCallPaths = (
properties: {
path_id: pathId,
entry: path.entry,
+ ...(path.entry_path === undefined
+ ? {}
+ : { entry_path: [...path.entry_path] }),
channel: path.channel,
resolution: "candidate",
conditions: path.conditions,
diff --git a/src/application/javascript/JavaScriptSemanticGraphElectronProjection.ts b/src/application/javascript/JavaScriptSemanticGraphElectronProjection.ts
index 53b5bdce6..c10e8f632 100644
--- a/src/application/javascript/JavaScriptSemanticGraphElectronProjection.ts
+++ b/src/application/javascript/JavaScriptSemanticGraphElectronProjection.ts
@@ -34,6 +34,9 @@ export function* projectElectronSemanticCallPaths(
properties: {
path_id: pathId,
entry: path.entry,
+ ...(path.entry_path === undefined
+ ? {}
+ : { entry_path: [...path.entry_path] }),
channel: path.channel,
terminal: path.terminal,
step_kind: step.kind,
@@ -62,6 +65,9 @@ export function* projectElectronSemanticCallPaths(
properties: {
path_id: pathId,
entry: path.entry,
+ ...(path.entry_path === undefined
+ ? {}
+ : { entry_path: [...path.entry_path] }),
channel: path.channel,
basis: "lexical-wrapper-substitution",
},
diff --git a/src/artifacts/ArtifactProvider.ts b/src/artifacts/ArtifactProvider.ts
index c95cec6d5..47d5906ea 100644
--- a/src/artifacts/ArtifactProvider.ts
+++ b/src/artifacts/ArtifactProvider.ts
@@ -40,6 +40,7 @@ import { ArtifactResourceScope } from "./ArtifactResourceScope.js";
import { artifactCapabilities } from "./ArtifactProviderMetadata.js";
import { ARTIFACT_GRAPH_PROVIDER } from "../application/InvestigationProviders.js";
import { createEvidence } from "../domain/evidence.js";
+import { freezeJsonSnapshot } from "../domain/immutableJson.js";
import { createArtifactInspection } from "../domain/artifactInspection.js";
import { ProviderCleanupError } from "../domain/providerCleanupError.js";
@@ -341,7 +342,11 @@ class ArtifactClient implements AnalysisClient {
total: 1,
message: "inventory substep started",
});
- const inventory = await this.inventory(inventoryParameters, options);
+ // The freshly parsed inventory is exclusively owned here. Sealing it lets
+ // the nested Evidence share it instead of cloning and re-digesting it.
+ const inventory = freezeJsonSnapshot(
+ await this.inventory(inventoryParameters, options),
+ );
const subject = subjectFor(
this.target.sourcePath ?? this.target.path,
inventory.manifest,
@@ -355,7 +360,10 @@ class ArtifactClient implements AnalysisClient {
// The nested inventory already names every occurrence's logical path.
locations: [],
});
- const result = createArtifactInspection(inventoryEvidence);
+ // The returned execution and its Evidence then reuse this owned report.
+ const result = freezeJsonSnapshot(
+ createArtifactInspection(inventoryEvidence),
+ );
await options?.progress?.report({
phase: "inspect_artifact.inventory",
completed: 1,
diff --git a/src/artifacts/MachOSliceArtifactReader.ts b/src/artifacts/MachOSliceArtifactReader.ts
index f567458c7..b57b0247e 100644
--- a/src/artifacts/MachOSliceArtifactReader.ts
+++ b/src/artifacts/MachOSliceArtifactReader.ts
@@ -8,7 +8,7 @@ import {
type NativeCommandRunner,
} from "../native/CommandRunner.js";
import {
- parseLipoArchitectures,
+ parseLipoOutput,
type LipoArchitecture,
} from "../native/parsers/lipo.js";
import type { MachoSlice } from "../domain/apple/dylibResolution.js";
@@ -114,7 +114,7 @@ export class MachOSliceArtifactReader implements ArtifactReader {
};
await this.#verifySource(source);
const fileSize = source.initial.size;
- const architectures = parseLipoArchitectures(captured.value.stdout);
+ const { architectures } = parseLipoOutput(captured.value.stdout, this.path);
const structural = await readStructuralSlices(source.handle, fileSize);
await this.#verifySource(source);
if (structural.status === "malformed")
diff --git a/src/artifacts/RegularFileAdmission.test.ts b/src/artifacts/RegularFileAdmission.test.ts
index 17926799a..97f61fc34 100644
--- a/src/artifacts/RegularFileAdmission.test.ts
+++ b/src/artifacts/RegularFileAdmission.test.ts
@@ -1,5 +1,6 @@
import type { BigIntStats, Stats } from "node:fs";
import type { FileHandle } from "node:fs/promises";
+import { tmpdir } from "node:os";
import { afterEach, expect, it, vi } from "vitest";
import {
@@ -88,3 +89,36 @@ it("compares available nanosecond timestamps without rounding away source change
sameRegularFileState(before, { ...before, ctimeNs: before.ctimeNs + 1n }),
).toBe(false);
});
+
+it.each([
+ ["EACCES", -13, "keeps"],
+ ["ENXIO", -6, "reclassifies"],
+] as const)(
+ "%s from opening a non-regular path: admission %s the failure",
+ async (code, errno, outcome) => {
+ const failure = Object.assign(new Error(`open ${code}`), { code, errno });
+ mockOpen.mockRejectedValue(failure);
+ // The selected path itself is a directory that stat can still describe.
+ const cause = await openRegularFile(tmpdir(), { symlinks: "follow" }).catch(
+ (rejected: unknown) => rejected,
+ );
+ if (outcome === "keeps") expect(cause).toBe(failure);
+ else expect(cause).toBeInstanceOf(NonRegularFileReadError);
+ },
+);
+
+it("keeps cancellation that arrives during the non-regular metadata probe", async () => {
+ const controller = new AbortController();
+ const cancellation = new Error("cancelled during probe");
+ mockOpen.mockImplementation(async () => {
+ // The probe stats the path after this rejection; abort before it settles.
+ queueMicrotask(() => controller.abort(cancellation));
+ throw Object.assign(new Error("open ENXIO"), { code: "ENXIO", errno: -6 });
+ });
+ await expect(
+ openRegularFile(tmpdir(), {
+ symlinks: "follow",
+ signal: controller.signal,
+ }),
+ ).rejects.toBe(cancellation);
+});
diff --git a/src/artifacts/apple/InterfaceBuilderAnalysis.ts b/src/artifacts/apple/InterfaceBuilderAnalysis.ts
index fb90594b3..02ecd9821 100644
--- a/src/artifacts/apple/InterfaceBuilderAnalysis.ts
+++ b/src/artifacts/apple/InterfaceBuilderAnalysis.ts
@@ -56,6 +56,7 @@ export const analyzeInterfaceBuilderBundle = async (input: {
const omittedArchives: Array<{ path: string; reason: string }> = [];
let unreportedOmittedArchives = 0;
const incompleteHierarchies = new Map();
+ const unresolvedConnections = new Map();
const prototypeKeyOmissions = new Map();
let omitted = 0;
let attempted = 0;
@@ -136,6 +137,8 @@ export const analyzeInterfaceBuilderBundle = async (input: {
: { value: nib.raw, omittedPrototypeKeys: 0 };
if (nib !== null && nib.omitted > 0)
incompleteHierarchies.set(entry.path, nib.omitted);
+ if (nib !== null && nib.unresolvedConnections > 0)
+ unresolvedConnections.set(entry.path, nib.unresolvedConnections);
if (omittedPrototypeKeys !== 0)
prototypeKeyOmissions.set(entry.path, omittedPrototypeKeys);
const documentHash = createHash("sha256").update(bytes).digest("hex");
@@ -170,6 +173,7 @@ export const analyzeInterfaceBuilderBundle = async (input: {
});
return finalizeHierarchyCoverage(result, {
incompleteHierarchies,
+ unresolvedConnections,
prototypeKeyOmissions,
invalid,
omittedArchives,
@@ -237,6 +241,7 @@ const finalizeHierarchyCoverage = (
result: ReturnType,
counts: {
incompleteHierarchies: ReadonlyMap;
+ unresolvedConnections: ReadonlyMap;
prototypeKeyOmissions: ReadonlyMap;
invalid: readonly string[];
omittedArchives: readonly { path: string; reason: string }[];
@@ -247,6 +252,7 @@ const finalizeHierarchyCoverage = (
) => {
const {
incompleteHierarchies,
+ unresolvedConnections,
prototypeKeyOmissions,
invalid,
omittedArchives,
@@ -260,6 +266,13 @@ const finalizeHierarchyCoverage = (
...result,
documents: result.documents.map((document) => ({
...document,
+ // The dictionary parser only sees connectors that were projected, so the
+ // omission recorded where an ownerless connector was dropped has to be
+ // added here for this producer to report the same document count as the
+ // keyed-archive producer for the same recognized connector.
+ connection_count:
+ document.connection_count +
+ (unresolvedConnections.get(document.relative_path) ?? 0),
hierarchy_complete:
document.hierarchy_complete &&
!incompleteHierarchies.has(document.relative_path),
@@ -268,15 +281,32 @@ const finalizeHierarchyCoverage = (
...result.graph,
coverage: [
...result.graph.coverage.map((facet) => {
- const omitted = incompleteHierarchies.get(
+ const omittedHierarchy = incompleteHierarchies.get(
facet.facet.replace(/^hierarchy:/u, ""),
);
- return facet.facet.startsWith("hierarchy:") && omitted !== undefined
+ if (
+ facet.facet.startsWith("hierarchy:") &&
+ omittedHierarchy !== undefined
+ )
+ return {
+ ...facet,
+ status: "partial" as const,
+ reason: "serialized_view_hierarchy_incomplete",
+ omitted: facet.omitted + omittedHierarchy,
+ };
+ const omittedConnection = unresolvedConnections.get(
+ facet.facet.replace(/^connections:/u, ""),
+ );
+ return facet.facet.startsWith("connections:") &&
+ omittedConnection !== undefined
? {
...facet,
status: "partial" as const,
- reason: "serialized_view_hierarchy_incomplete",
- omitted: facet.omitted + omitted,
+ // A connection dropped by the limit is recoverable by raising
+ // it, so that cause keeps the reason the graph already named.
+ // Only a facet with no other cause reports the omission.
+ reason: facet.reason ?? "connection_unresolved",
+ omitted: facet.omitted + omittedConnection,
}
: facet;
}),
@@ -306,7 +336,8 @@ const finalizeHierarchyCoverage = (
result.graph.truncated ||
counts.omitted > 0 ||
archiveDecodePartial ||
- incompleteHierarchies.size > 0,
+ incompleteHierarchies.size > 0 ||
+ unresolvedConnections.size > 0,
},
limitations: [
...result.limitations,
@@ -316,6 +347,11 @@ const finalizeHierarchyCoverage = (
: [
"Some serialized hierarchy links could not be projected within the bounded hierarchy; their parentage remains unknown.",
]),
+ ...(unresolvedConnections.size === 0
+ ? []
+ : [
+ "Some recognized NIBArchive connectors declare no resolvable owner; they carry no connection evidence and are reported as omissions.",
+ ]),
...(invalid.length === 0
? []
: [
@@ -496,6 +532,10 @@ const projectNibArchive = (
);
const connections: Record = {};
const hierarchy: NibHierarchyNode[] = [];
+ // A recognized connector whose owner reference cannot be resolved produces no
+ // connection entry, so the omission has to be counted here: the projected
+ // dictionary carries no trace of it for a downstream consumer to find.
+ let unresolvedConnections = 0;
const reference = (value: JsonValue | undefined): number | null => {
if (typeof value !== "object" || value === null || Array.isArray(value))
return null;
@@ -512,7 +552,10 @@ const projectNibArchive = (
const values = object.values;
const connectionFields = interfaceBuilderConnectionFieldNames(className);
const source = reference(values[connectionFields.source]);
- if (source === null) continue;
+ if (source === null) {
+ unresolvedConnections += 1;
+ continue;
+ }
const destination = reference(values[connectionFields.destination]);
const label = referencedString(values[connectionFields.label]);
const type = className.includes("Outlet")
@@ -608,6 +651,7 @@ const projectNibArchive = (
);
return {
omitted: viewHierarchy.omitted + hierarchyOmitted + merged.omitted,
+ unresolvedConnections,
raw: jsonValueSchema.parse({
"com.apple.ibtool.document.objects": objects,
"com.apple.ibtool.document.connections": connections,
diff --git a/src/artifacts/apple/NibArchive.test.ts b/src/artifacts/apple/NibArchive.test.ts
index 10579d011..665617d28 100644
--- a/src/artifacts/apple/NibArchive.test.ts
+++ b/src/artifacts/apple/NibArchive.test.ts
@@ -36,6 +36,22 @@ const archiveWithOverlappingObjectRanges = (objectCount: number): Buffer => {
};
describe("NIBArchive decoder", () => {
+ it("keeps leading U+FEFF in length-prefixed keys and class names", () => {
+ const archive = encodeArchive({
+ classes: ["\uFEFFWidget"],
+ objects: [{ classIndex: 0, values: { count: 1, "\uFEFFcount": 2 } }],
+ });
+ expect(decodeNibArchive(archive).objects).toEqual([
+ {
+ id: 0,
+ class_name: "\uFEFFWidget",
+ values: { count: 1, "\uFEFFcount": 2 },
+ },
+ ]);
+ const invalid = Buffer.from(archive);
+ invalid[invalid.indexOf(Buffer.from("\uFEFFcount"))] = 0xff;
+ expect(() => decodeNibArchive(invalid)).toThrow(/not valid UTF-8/u);
+ });
it("decodes bounded object, key, class, and reference tables", () => {
const archive = encodeArchive({
classes: ["NSView\0", "NSString\0"],
diff --git a/src/artifacts/inventory/ArtifactGraphConstruction.test.ts b/src/artifacts/inventory/ArtifactGraphConstruction.test.ts
new file mode 100644
index 000000000..925d3543a
--- /dev/null
+++ b/src/artifacts/inventory/ArtifactGraphConstruction.test.ts
@@ -0,0 +1,103 @@
+import { describe, expect, it } from "vitest";
+
+import { CPU, fatImage, machoImage } from "../apple/MachoImage.fixture.js";
+import { classifyArtifactContent } from "./ArtifactGraphConstruction.js";
+
+const fat = (wide = false): Buffer =>
+ Buffer.from(fatImage([{ cpu: CPU.arm64, bytes: machoImage({}) }], wide));
+
+describe("bounded FAT inventory classification", () => {
+ it("requires the complete table but not slice bytes in the retained prefix", () => {
+ const bytes = fat();
+ for (const length of [4, 7, 8, 27]) {
+ expect(
+ classifyArtifactContent(
+ "native",
+ bytes.subarray(0, length),
+ bytes.length,
+ ),
+ ).toEqual({ kind: "unknown", format: "unknown" });
+ }
+ expect(
+ classifyArtifactContent(
+ "native.class",
+ bytes.subarray(0, 28),
+ bytes.length,
+ ),
+ ).toEqual({ kind: "executable", format: "mach-o-universal" });
+ });
+
+ it.each([
+ ["empty table", (bytes: Buffer) => bytes.writeUInt32BE(0, 4)],
+ ["slice overlapping table", (bytes: Buffer) => bytes.writeUInt32BE(0, 16)],
+ ["empty slice", (bytes: Buffer) => bytes.writeUInt32BE(0, 20)],
+ [
+ "slice beyond file",
+ (bytes: Buffer) => bytes.writeUInt32BE(bytes.length, 20),
+ ],
+ ["unaligned slice", (bytes: Buffer) => bytes.writeUInt32BE(4097, 16)],
+ ["unsupported alignment", (bytes: Buffer) => bytes.writeUInt32BE(53, 24)],
+ ] as const)("keeps %s unknown", (_label, mutate) => {
+ const bytes = fat();
+ mutate(bytes);
+ expect(classifyArtifactContent("native", bytes)).toEqual({
+ kind: "unknown",
+ format: "unknown",
+ });
+ });
+
+ it("does not infer Mach-O from an out-of-bounds architecture count", () => {
+ const bytes = fat();
+ bytes.writeUInt32BE(0xffffffff, 4);
+ expect(classifyArtifactContent("native", bytes)).toEqual({
+ kind: "resource",
+ format: "file",
+ });
+ });
+
+ it("does not lose unsafe FAT64 range values to number conversion", () => {
+ const bytes = fat(true);
+ bytes.writeBigUInt64BE(BigInt(Number.MAX_SAFE_INTEGER) + 1n, 16);
+ expect(classifyArtifactContent("native", bytes)).toEqual({
+ kind: "unknown",
+ format: "unknown",
+ });
+ });
+
+ it("requires valid ranges for every declared slice", () => {
+ const bytes = Buffer.from(
+ fatImage([
+ { cpu: CPU.arm64, bytes: machoImage({}) },
+ { cpu: CPU.x86_64, bytes: machoImage({ cpu: CPU.x86_64 }) },
+ ]),
+ );
+ bytes.writeUInt32BE(bytes.length, 40);
+ expect(classifyArtifactContent("native", bytes)).toEqual({
+ kind: "unknown",
+ format: "unknown",
+ });
+ });
+
+ it("requires observed slice magic for an unknown CPU type", () => {
+ const cpu = { type: 0x12345678, subtype: 0 };
+ const bytes = Buffer.from(fatImage([{ cpu, bytes: machoImage({ cpu }) }]));
+ expect(
+ classifyArtifactContent("native", bytes.subarray(0, 28), bytes.length),
+ ).toEqual({ kind: "unknown", format: "unknown" });
+ expect(classifyArtifactContent("native", bytes)).toEqual({
+ kind: "executable",
+ format: "mach-o-universal",
+ });
+ });
+
+ it.each([NaN, Infinity, -1, 8.5, Number.MAX_SAFE_INTEGER + 1, 27])(
+ "keeps invalid or contradictory file size %s unknown",
+ (size) => {
+ const bytes = fat();
+ expect(classifyArtifactContent("native", bytes, size)).toEqual({
+ kind: "unknown",
+ format: "unknown",
+ });
+ },
+ );
+});
diff --git a/src/artifacts/javascript/JavaScriptArtifactFiles.ts b/src/artifacts/javascript/JavaScriptArtifactFiles.ts
index e3849f814..78d8cf750 100644
--- a/src/artifacts/javascript/JavaScriptArtifactFiles.ts
+++ b/src/artifacts/javascript/JavaScriptArtifactFiles.ts
@@ -37,6 +37,7 @@ interface ExpectedFile {
interface ExpectedContainer {
readonly hash_status: ArtifactOccurrence["hash_status"];
+ readonly format: ArtifactOccurrence["artifact_format"];
readonly inventory: JavaScriptArtifactContainer | null;
}
@@ -219,6 +220,9 @@ const visitReader = async (
"integrity",
`Nested ASAR was not integrity-verified: ${path}`,
);
+ // Inventory expands an ASAR-named file only when its bytes are an
+ // ASAR. One it recorded as ordinary bytes has no members to read.
+ if (container.format !== "asar") continue;
const inventory = container.inventory;
if (inventory === null)
throw new ArtifactReaderFailure(
@@ -395,6 +399,7 @@ const expectedInventory = (
if (isNestedAsar)
containers.set(occurrence.logical_path, {
hash_status: occurrence.hash_status,
+ format: occurrence.artifact_format,
inventory: null,
});
continue;
@@ -412,6 +417,7 @@ const expectedInventory = (
if (isNestedAsar)
containers.set(occurrence.logical_path, {
hash_status: occurrence.hash_status,
+ format: occurrence.artifact_format,
inventory: {
path: occurrence.logical_path,
sha256: node.sha256,
diff --git a/src/browser/BrowserProcessStartup.ts b/src/browser/BrowserProcessStartup.ts
index 85eae0553..48367c432 100644
--- a/src/browser/BrowserProcessStartup.ts
+++ b/src/browser/BrowserProcessStartup.ts
@@ -14,6 +14,7 @@ export class BrowserStartupError extends Error {
readonly failure: BrowserStartupFailure;
readonly executable: string;
readonly elapsedMs: number;
+ readonly startupTimeoutMs: number;
readonly exitCode: number | null;
readonly signalCode: NodeJS.Signals | null;
readonly stderr: string;
@@ -23,6 +24,7 @@ export class BrowserStartupError extends Error {
readonly failure: BrowserStartupFailure;
readonly executable: string;
readonly elapsedMs: number;
+ readonly startupTimeoutMs: number;
readonly exitCode: number | null;
readonly signalCode: NodeJS.Signals | null;
readonly stderr: string;
@@ -33,12 +35,22 @@ export class BrowserStartupError extends Error {
this.failure = diagnostics.failure;
this.executable = diagnostics.executable;
this.elapsedMs = diagnostics.elapsedMs;
+ this.startupTimeoutMs = diagnostics.startupTimeoutMs;
this.exitCode = diagnostics.exitCode;
this.signalCode = diagnostics.signalCode;
this.stderr = diagnostics.stderr;
}
}
+/**
+ * Single owner of the wait for Chrome to publish its DevToolsActivePort.
+ *
+ * Callers that need a different budget pass `timeoutMs`; nobody else should
+ * restate this number, because a per-caller literal silently changes how long
+ * a cold Chrome launch is tolerated before the failure names its ceiling.
+ */
+export const BROWSER_DEVTOOLS_STARTUP_TIMEOUT_MS = 60_000;
+
/** Owned child process and startup policy for Chrome CDP discovery. */
export interface BrowserStartupOptions {
readonly child: ChildProcess;
@@ -53,23 +65,23 @@ export interface BrowserStartupOptions {
export const waitForBrowserDevtoolsPort = async (
options: BrowserStartupOptions,
): Promise => {
- const timeoutMs = options.timeoutMs ?? 15_000;
+ const timeoutMs = options.timeoutMs ?? BROWSER_DEVTOOLS_STARTUP_TIMEOUT_MS;
const pollIntervalMs = options.pollIntervalMs ?? 25;
const startedAt = performance.now();
- const terminal = childTermination(options, startedAt);
+ const terminal = childTermination(options, startedAt, timeoutMs);
const deadline = startedAt + timeoutMs;
while (true) {
const terminalState = currentTerminalState(options.child);
if (terminalState !== null)
- throw startupError(options, startedAt, terminalState);
+ throw startupError(options, startedAt, timeoutMs, terminalState);
const port = await readDevtoolsPort(options.activePortPath);
if (port !== null) return port;
const remainingMs = deadline - performance.now();
if (remainingMs <= 0)
- throw startupError(options, startedAt, { failure: "timeout" });
+ throw startupError(options, startedAt, timeoutMs, { failure: "timeout" });
const outcome = await Promise.race([
terminal,
@@ -88,11 +100,12 @@ type TerminalState =
const childTermination = (
options: BrowserStartupOptions,
startedAt: number,
+ startupTimeoutMs: number,
): Promise =>
new Promise((resolve) => {
options.child.once("error", (cause: unknown) => {
resolve(
- startupError(options, startedAt, {
+ startupError(options, startedAt, startupTimeoutMs, {
failure: "spawn-error",
cause,
}),
@@ -103,6 +116,7 @@ const childTermination = (
startupError(
options,
startedAt,
+ startupTimeoutMs,
options.child.signalCode === null
? { failure: "exited" }
: { failure: "signalled" },
@@ -120,6 +134,7 @@ const currentTerminalState = (child: ChildProcess): TerminalState | null => {
const startupError = (
options: BrowserStartupOptions,
startedAt: number,
+ startupTimeoutMs: number,
state: TerminalState,
): BrowserStartupError =>
new BrowserStartupError(
@@ -127,6 +142,7 @@ const startupError = (
failure: state.failure,
executable: options.executable,
elapsedMs: Math.max(0, Math.round(performance.now() - startedAt)),
+ startupTimeoutMs,
exitCode: options.child.exitCode,
signalCode: options.child.signalCode,
stderr: options.stderr(),
@@ -156,9 +172,10 @@ const browserStartupMessage = (
diagnostics: {
readonly executable: string;
readonly elapsedMs: number;
+ readonly startupTimeoutMs: number;
readonly exitCode: number | null;
readonly signalCode: NodeJS.Signals | null;
readonly stderr: string;
},
): string =>
- `Chrome CDP startup ${failure}; executable=${diagnostics.executable}; elapsed_ms=${String(diagnostics.elapsedMs)}; exit_code=${diagnostics.exitCode === null ? "null" : String(diagnostics.exitCode)}; signal=${diagnostics.signalCode ?? "null"}; stderr=${diagnostics.stderr.length === 0 ? "" : diagnostics.stderr}`;
+ `Chrome CDP startup ${failure}; executable=${diagnostics.executable}; elapsed_ms=${String(diagnostics.elapsedMs)}; startup_timeout_ms=${String(diagnostics.startupTimeoutMs)}; exit_code=${diagnostics.exitCode === null ? "null" : String(diagnostics.exitCode)}; signal=${diagnostics.signalCode ?? "null"}; stderr=${diagnostics.stderr.length === 0 ? "" : diagnostics.stderr}`;
diff --git a/src/browser/CdpCaptureDocuments.baseUrl.test.ts b/src/browser/CdpCaptureDocuments.baseUrl.test.ts
index a5481c161..e3201eade 100644
--- a/src/browser/CdpCaptureDocuments.baseUrl.test.ts
+++ b/src/browser/CdpCaptureDocuments.baseUrl.test.ts
@@ -2,6 +2,8 @@ import { describe, expect, it } from "vitest";
import { inspectWebPageInputSchema } from "../domain/browserObservation.js";
import { captureDom } from "./CdpCaptureDocuments.js";
+import { capturedSvgNodeKind } from "./CdpCaptureDomSvg.js";
+import { CdpCaptureCompleteness } from "./CdpCaptureCompleteness.js";
const origin = "https://app.example.test";
const documentUrl = `${origin}/screens/app`;
@@ -50,8 +52,11 @@ const snapshot = (
],
});
-const capture = (value: ReturnType) =>
- captureDom(value, new Set([origin]), input);
+const capture = (value: ReturnType) => {
+ const step = captureDom(value, new Set([origin]), input).next();
+ if (!step.done) throw new Error("Unexpected SVG identity query");
+ return step.value;
+};
describe("DOM metadata document base URLs", () => {
it("resolves links, actions and agent hints against the captured document base", () => {
@@ -282,6 +287,7 @@ interface SvgSnapshotNode {
readonly name: string;
readonly parent: number;
readonly attributes?: readonly (readonly [string, string])[];
+ readonly svg?: boolean;
}
const svgDocument = (
@@ -300,7 +306,13 @@ const svgDocument = (
const nodeValue = [intern("")];
const parentIndex = [-1];
const attributes: number[][] = [[]];
+ const backendNodeId = [1];
+ const svgNodeKinds = new Map();
for (const element of elements) {
+ const id = backendNodeId.length + 1;
+ backendNodeId.push(id);
+ if (element.svg !== undefined)
+ svgNodeKinds.set(`${String(id)}:${element.name}`, element.svg);
nodeType.push(1);
nodeName.push(intern(element.name));
nodeValue.push(intern(""));
@@ -316,14 +328,35 @@ const svgDocument = (
{
documentURL: 0,
baseURL: 1,
- nodes: { nodeType, nodeName, nodeValue, parentIndex, attributes },
+ nodes: {
+ nodeType,
+ nodeName,
+ nodeValue,
+ parentIndex,
+ attributes,
+ backendNodeId,
+ },
+ svgNodeKinds,
},
],
};
};
-const captureSvg = (value: ReturnType) =>
- captureDom(value, new Set([origin]), input);
+const captureSvg = (value: ReturnType) => {
+ const kinds = new Map(
+ value.documents.flatMap((document) => [...document.svgNodeKinds]),
+ );
+ const capture = captureDom(value, new Set([origin]), input);
+ let step = capture.next();
+ while (!step.done) {
+ step = capture.next(
+ step.value.map((query) =>
+ kinds.get(`${String(query.backendNodeId)}:${query.nodeName}`),
+ ),
+ );
+ }
+ return step.value;
+};
const urlFor = (
result: ReturnType,
@@ -331,6 +364,136 @@ const urlFor = (
): (typeof result.urls)[number] | undefined =>
result.urls.find((url) => url.node_index === nodeIndex);
+describe("browser SVG identity", () => {
+ const query = { backendNodeId: 42, nodeName: "a" };
+ const node = { ...query, nodeType: 1 };
+
+ it("uses only a matching described element's SVG flag", () => {
+ expect(capturedSvgNodeKind(query, { node: { ...node, isSVG: true } })).toBe(
+ true,
+ );
+ expect(
+ capturedSvgNodeKind(query, { node: { ...node, isSVG: false } }),
+ ).toBe(false);
+ expect(capturedSvgNodeKind(query, { node })).toBe(false);
+ for (const invalid of [
+ {},
+ { node: { ...node, backendNodeId: 43, isSVG: true } },
+ { node: { ...node, nodeName: "A", isSVG: true } },
+ { node: { ...node, nodeType: 3, isSVG: true } },
+ { node: { ...node, isSVG: "true" } },
+ ])
+ expect(capturedSvgNodeKind(query, invalid)).toBeUndefined();
+ });
+
+ it("distinguishes identically named SVG and MathML elements regardless of parent", () => {
+ const result = captureSvg(
+ svgDocument([
+ { name: "svg", parent: 0 },
+ { name: "desc", parent: 1 },
+ {
+ name: "a",
+ svg: true,
+ parent: 2,
+ attributes: [["xlink:href", "/svg"]],
+ },
+ {
+ name: "a",
+ svg: false,
+ parent: 2,
+ attributes: [["xlink:href", "/math"]],
+ },
+ {
+ name: "A",
+ svg: false,
+ parent: 1,
+ attributes: [["xlink:href", "/html"]],
+ },
+ {
+ name: "a",
+ svg: true,
+ parent: 0,
+ attributes: [["xlink:href", "/orphan"]],
+ },
+ ]),
+ );
+ expect(result.urls.map(({ url }) => url)).toEqual([
+ `${origin}/svg`,
+ `${origin}/orphan`,
+ ]);
+ });
+
+ it("records unresolved identity without inventing a destination or hiding attributes", () => {
+ const value = svgDocument([
+ { name: "a", parent: 0, attributes: [["xlink:href", "/unknown"]] },
+ ]);
+ const completeness = new CdpCaptureCompleteness();
+ const capture = captureDom(value, new Set([origin]), input, completeness);
+ expect(capture.next()).toEqual({
+ done: false,
+ value: [{ backendNodeId: 2, nodeName: "a" }],
+ });
+ const step = capture.next([undefined]);
+ expect(step.done).toBe(true);
+ if (!step.done) throw new Error("Unexpected second query");
+ expect(step.value.unresolvedSvgNodes).toBe(1);
+ expect(step.value.urls).toEqual([]);
+ expect(step.value.nodes[1]?.attribute_names).toEqual(["xlink:href"]);
+ expect(completeness.snapshot().excluded).toEqual(
+ expect.arrayContaining([
+ expect.objectContaining({
+ section: "metadata",
+ reason: "provider_unavailable",
+ count: 1,
+ }),
+ ]),
+ );
+ });
+});
+
+it("keeps batched SVG identities aligned around missing IDs and ordinary links", () => {
+ const value = svgDocument([
+ { name: "a", parent: 0, attributes: [["xlink:href", "/svg"]] },
+ { name: "A", parent: 0, attributes: [["href", "/ordinary"]] },
+ { name: "a", parent: 0, attributes: [["xlink:href", "/missing-id"]] },
+ { name: "a", parent: 0, attributes: [["xlink:href", "/non-svg"]] },
+ ]);
+ const completeness = new CdpCaptureCompleteness();
+ const capture = captureDom(
+ {
+ ...value,
+ documents: value.documents.map((document) => ({
+ ...document,
+ nodes: { ...document.nodes, backendNodeId: [1, 2, 3, null, 5] },
+ })),
+ },
+ new Set([origin]),
+ input,
+ completeness,
+ );
+ expect(capture.next()).toEqual({
+ done: false,
+ value: [
+ { backendNodeId: 2, nodeName: "a" },
+ { backendNodeId: 5, nodeName: "a" },
+ ],
+ });
+ const step = capture.next([true, false]);
+ if (!step.done) throw new Error("Unexpected second batch");
+ expect(
+ step.value.urls.map(({ node_index, url }) => [node_index, url]),
+ ).toEqual([
+ [1, `${origin}/svg`],
+ [2, `${origin}/ordinary`],
+ ]);
+ expect(step.value.unresolvedSvgNodes).toBe(1);
+ expect(completeness.snapshot().excluded).toContainEqual({
+ section: "metadata",
+ reason: "provider_unavailable",
+ count: 1,
+ });
+});
+
describe("SVG xlink:href destinations", () => {
it("reports an SVG anchor that only has xlink:href, keeping the first value", () => {
const result = captureSvg(
@@ -339,6 +502,7 @@ describe("SVG xlink:href destinations", () => {
{ name: "g", parent: 1 },
{
name: "a",
+ svg: true,
parent: 2,
attributes: [
["xlink:href", "/xl-s2h"],
@@ -371,6 +535,7 @@ describe("SVG xlink:href destinations", () => {
{ name: "svg", parent: 0 },
{
name: "a",
+ svg: true,
parent: 1,
attributes: [
[first, valueFor(first)],
@@ -395,18 +560,21 @@ describe("SVG xlink:href destinations", () => {
svgDocument([
{
name: "A",
+ svg: false,
parent: 0,
attributes: [["xlink:href", "/xl-html"]],
},
{ name: "math", parent: 0 },
{
name: "mrow",
+ svg: false,
parent: 2,
attributes: [["xlink:href", "/xl-math"]],
},
{ name: "svg", parent: 0 },
{
name: "a",
+ svg: true,
parent: 4,
attributes: [["xlink:href", "/xl-s2h"]],
},
@@ -425,6 +593,7 @@ describe("SVG xlink:href destinations", () => {
{ name: "svg", parent: 0 },
{
name: "a",
+ svg: true,
parent: 1,
attributes: [["xlink:href", "https://cdn.example.test/out"]],
},
@@ -444,8 +613,18 @@ describe("SVG xlink:href destinations", () => {
const result = captureSvg(
svgDocument([
{ name: "svg", parent: 0 },
- { name: "image", parent: 1, attributes: [["xlink:href", "guide"]] },
- { name: "use", parent: 1, attributes: [["xlink:href", "icon.svg"]] },
+ {
+ name: "image",
+ svg: true,
+ parent: 1,
+ attributes: [["xlink:href", "guide"]],
+ },
+ {
+ name: "use",
+ svg: true,
+ parent: 1,
+ attributes: [["xlink:href", "icon.svg"]],
+ },
]),
);
expect(result.urls).toEqual([
@@ -466,14 +645,24 @@ describe("SVG xlink:href destinations", () => {
});
describe("SVG xlink:href context", () => {
- it("keeps forward ancestor context local to each document", () => {
+ it("binds SVG identity to the selected element across documents", () => {
const svg = svgDocument([
- { name: "a", parent: 2, attributes: [["xlink:href", "/svg-link"]] },
+ {
+ name: "a",
+ svg: true,
+ parent: 2,
+ attributes: [["xlink:href", "/svg-link"]],
+ },
{ name: "g", parent: 3 },
{ name: "svg", parent: 0 },
]);
const html = svgDocument([
- { name: "A", parent: 2, attributes: [["xlink:href", "/html-link"]] },
+ {
+ name: "A",
+ svg: false,
+ parent: 2,
+ attributes: [["xlink:href", "/html-link"]],
+ },
{ name: "DIV", parent: 3 },
{ name: "BODY", parent: 0 },
]);
@@ -507,32 +696,39 @@ describe("SVG xlink:href context", () => {
]);
});
- it("stops SVG context at foreignObject and resumes it for a nested svg", () => {
- const result = captureSvg(
- svgDocument([
- { name: "svg", parent: 0 },
- { name: "foreignObject", parent: 1 },
- {
- name: "A",
- parent: 2,
- attributes: [["xlink:href", "/xl-html-fo"]],
- },
- { name: "svg", parent: 2 },
- {
- name: "a",
- parent: 4,
- attributes: [["xlink:href", "/xl-nested"]],
- },
- ]),
- );
- expect(urlFor(result, 3)).toBeUndefined();
- expect(urlFor(result, 5)).toMatchObject({
- attribute: "href",
- url: `${origin}/xl-nested`,
- destination_scope: "approved",
- });
- });
+ it.each(["foreignObject", "desc", "title"])(
+ "preserves browser SVG identity across %s HTML integration points",
+ (integrationPoint) => {
+ const result = captureSvg(
+ svgDocument([
+ { name: "svg", parent: 0 },
+ { name: integrationPoint, parent: 1 },
+ {
+ name: "A",
+ svg: false,
+ parent: 2,
+ attributes: [["xlink:href", "/xl-html-fo"]],
+ },
+ { name: "svg", parent: 2 },
+ {
+ name: "a",
+ svg: true,
+ parent: 4,
+ attributes: [["xlink:href", "/xl-nested"]],
+ },
+ ]),
+ );
+ expect(urlFor(result, 3)).toBeUndefined();
+ expect(urlFor(result, 5)).toMatchObject({
+ attribute: "href",
+ url: `${origin}/xl-nested`,
+ destination_scope: "approved",
+ });
+ },
+ );
+});
+describe("SVG XLink precedence and unknown identity", () => {
it("keeps an empty href ahead of xlink:href", () => {
const baseUrl = `${origin}/screens/assets/`;
const result = captureSvg(
@@ -541,6 +737,7 @@ describe("SVG xlink:href context", () => {
{ name: "svg", parent: 0 },
{
name: "a",
+ svg: true,
parent: 1,
attributes: [
["href", ""],
@@ -567,6 +764,7 @@ describe("SVG xlink:href context", () => {
{ name: "svg", parent: 0 },
{
name: "a",
+ svg: true,
parent: 1,
attributes: [["xlink:href", "javascript:void(0)"]],
},
@@ -582,7 +780,7 @@ describe("SVG xlink:href context", () => {
]);
});
- it("does not treat a cyclic or dangling parent chain as SVG", () => {
+ it("keeps an unavailable SVG identity unknown despite ancestor names", () => {
const cyclic = captureSvg(
svgDocument([
{ name: "g", parent: 2 },
@@ -652,7 +850,12 @@ describe("XML SVG roots and namespace scope restoration", () => {
["xmlns:p", XLINK_NAMESPACE],
],
},
- { name: "a", parent: 1, attributes: [["p:href", "/linked"]] },
+ {
+ name: "a",
+ svg: true,
+ parent: 1,
+ attributes: [["p:href", "/linked"]],
+ },
]),
);
expect(result.urls).toEqual([approvedHref(2, `${origin}/linked`)]);
@@ -764,6 +967,7 @@ describe("XHTML and XML SVG namespace prefixes", () => {
{ name: "svg:foreignObject", parent: 2 },
{
name: "a",
+ svg: true,
parent: 3,
attributes: [["xlink:href", "/xl-html-fo"]],
},
@@ -799,6 +1003,7 @@ describe("XHTML and XML SVG namespace prefixes", () => {
},
{
name: "a",
+ svg: true,
parent: 2,
attributes: [
["xlink:href", "/not-xlink"],
@@ -918,11 +1123,13 @@ describe("XHTML SVG exclusions, HTML documents, and prefix scope", () => {
},
{
name: "a",
+ svg: true,
parent: 2,
attributes: [["xlink:href", "/xl-literal"]],
},
{
name: "a",
+ svg: true,
parent: 2,
attributes: [["x:href", "/xl-custom-html"]],
},
@@ -937,6 +1144,7 @@ describe("XHTML SVG exclusions, HTML documents, and prefix scope", () => {
},
{
name: "A",
+ svg: false,
parent: 1,
attributes: [["xlink:href", "/xl-html-anchor"]],
},
@@ -944,7 +1152,9 @@ describe("XHTML SVG exclusions, HTML documents, and prefix scope", () => {
);
expect(result.urls).toEqual([approvedHref(3, `${origin}/xl-literal`)]);
});
+});
+describe("XML namespace resolution ordering and capacity", () => {
it("applies an element's own xmlns declarations to its name and href", () => {
const result = captureSvg(
svgDocument([
diff --git a/src/browser/CdpCaptureDocuments.ts b/src/browser/CdpCaptureDocuments.ts
index 3c7fb98ed..f7eb4fe31 100644
--- a/src/browser/CdpCaptureDocuments.ts
+++ b/src/browser/CdpCaptureDocuments.ts
@@ -11,7 +11,11 @@ import {
} from "./CdpCaptureValues.js";
import { exclusionReasonForUrl } from "./CdpCaptureEventHelpers.js";
import type { CdpCaptureCompleteness } from "./CdpCaptureCompleteness.js";
-import { createDocumentSvgAncestry, domSvgLink } from "./CdpCaptureDomSvg.js";
+import {
+ createDocumentSvgAncestry,
+ domSvgLink,
+ type DomSvgNodeQuery,
+} from "./CdpCaptureDomSvg.js";
import { compareUnicodeCodePoints } from "../domain/unicodeCodePointOrder.js";
export type CapturedResource = Omit<
@@ -135,18 +139,39 @@ export const walkFrameTrees = function* (
}
};
-export const captureDom = (
+interface DomMetadataCapture {
+ readonly urls: WebPageInspection["metadata"]["dom_urls"];
+ readonly agentHints: WebPageInspection["metadata"]["agent_hints"];
+ readonly excludedUrls: number;
+ readonly unresolvedSvgNodes: number;
+}
+
+export interface DomCapture extends DomMetadataCapture {
+ readonly total: number;
+ readonly nodes: WebPageInspection["dom"]["nodes"];
+}
+
+// Bound retained projections and outstanding CDP reads independently of page size.
+// Eight leaves room for the session's other cancellation listeners.
+const DOM_METADATA_BATCH_SIZE = 8;
+
+interface PendingDomMetadata {
+ readonly options: DomMetadataOptions;
+ // Undefined means no query is needed; null means the candidate has no valid ID.
+ readonly svgQuery: DomSvgNodeQuery | null | undefined;
+}
+
+/** Project one snapshot, requesting bounded batches of SVG identity facts. */
+export function* captureDom(
result: unknown,
allowedOrigins: ReadonlySet,
input: InspectWebPageInput,
completeness?: CdpCaptureCompleteness,
-): {
- readonly total: number;
- readonly nodes: WebPageInspection["dom"]["nodes"];
- readonly urls: WebPageInspection["metadata"]["dom_urls"];
- readonly agentHints: WebPageInspection["metadata"]["agent_hints"];
- readonly excludedUrls: number;
-} => {
+): Generator<
+ readonly DomSvgNodeQuery[],
+ DomCapture,
+ readonly (boolean | undefined)[]
+> {
const root = requiredRecord(result);
const strings = Array.isArray(root.strings)
? root.strings.map((value) => cdpStringValue(value) ?? "")
@@ -156,6 +181,7 @@ export const captureDom = (
const agentHints: WebPageInspection["metadata"]["agent_hints"] = [];
let excludedUrls = 0;
let total = 0;
+ let unresolvedSvgNodes = 0;
for (const document of recordsValue(root.documents)) {
const documentUrl = indexedString(strings, document.documentURL);
if (allowedSanitizedUrl(documentUrl, allowedOrigins) === undefined) {
@@ -172,6 +198,9 @@ export const captureDom = (
const attributes = Array.isArray(documentNodes.attributes)
? documentNodes.attributes
: [];
+ const backendNodeIds = Array.isArray(documentNodes.backendNodeId)
+ ? documentNodes.backendNodeId
+ : [];
const baseIndex = nodes.length;
const ancestry = createDocumentSvgAncestry({
nodeTypes,
@@ -181,12 +210,29 @@ export const captureDom = (
attributes,
});
total += nodeTypes.length;
+ const pendingMetadata: PendingDomMetadata[] = [];
for (let index = 0; index < nodeTypes.length; index += 1) {
const attributeIndexes = numberArray(attributes[index]);
const parent = Math.trunc(parents[index] ?? -1);
const nodeIndex = nodes.length;
const nodeName = indexedString(strings, nodeNames[index]);
const attributeNames = uniqueAttributeNames(attributeIndexes, strings);
+ const svgLink = domSvgLink(ancestry, index);
+ let svgQuery: DomSvgNodeQuery | null | undefined;
+ if (
+ !svgLink.xmlDocument &&
+ nodeTypes[index] === 1 &&
+ attributeNames.includes("xlink:href") &&
+ !attributeNames.includes("href")
+ ) {
+ const backendNodeId = numberValue(backendNodeIds[index]);
+ svgQuery =
+ backendNodeId !== undefined &&
+ Number.isSafeInteger(backendNodeId) &&
+ backendNodeId > 0
+ ? { backendNodeId, nodeName }
+ : null;
+ }
nodes.push({
index: nodeIndex,
parent_index: parent < 0 ? -1 : baseIndex + parent,
@@ -195,30 +241,34 @@ export const captureDom = (
node_value_length: indexedString(strings, nodeValues[index]).length,
attribute_names: attributeNames,
});
- const metadata = domMetadata({
- strings,
- attributes: attributeIndexes,
- // The BASE element itself resolves against the document fallback URL.
- baseUrl: nodeName.toLowerCase() === "base" ? documentUrl : baseUrl,
- documentUrl,
- nodeIndex,
- nodeName,
- allowedOrigins,
- ...domSvgLink(ancestry, index),
+ pendingMetadata.push({
+ svgQuery,
+ options: {
+ strings,
+ attributes: attributeIndexes,
+ // The BASE element itself resolves against the document fallback URL.
+ baseUrl: nodeName.toLowerCase() === "base" ? documentUrl : baseUrl,
+ documentUrl,
+ nodeIndex,
+ nodeName,
+ allowedOrigins,
+ ...svgLink,
+ },
});
- for (const url of metadata.urls) {
- urls.push(url);
- if (url.destination_scope !== "approved") {
- excludedUrls += 1;
- completeness?.exclude(
- "metadata",
- url.destination_scope === "outside_policy"
- ? "disallowed_origin"
- : "unsupported_url",
- );
- }
+ if (
+ pendingMetadata.length === DOM_METADATA_BATCH_SIZE ||
+ index === nodeTypes.length - 1
+ ) {
+ const metadata = yield* captureDomMetadata(
+ pendingMetadata,
+ completeness,
+ );
+ urls.push(...metadata.urls);
+ agentHints.push(...metadata.agentHints);
+ excludedUrls += metadata.excludedUrls;
+ unresolvedSvgNodes += metadata.unresolvedSvgNodes;
+ pendingMetadata.length = 0;
}
- agentHints.push(...metadata.agentHints);
}
}
return {
@@ -227,8 +277,54 @@ export const captureDom = (
urls,
agentHints,
excludedUrls,
+ unresolvedSvgNodes,
};
-};
+}
+
+function* captureDomMetadata(
+ pending: readonly PendingDomMetadata[],
+ completeness: CdpCaptureCompleteness | undefined,
+): Generator<
+ readonly DomSvgNodeQuery[],
+ DomMetadataCapture,
+ readonly (boolean | undefined)[]
+> {
+ const queries = pending.flatMap(({ svgQuery }) =>
+ svgQuery == null ? [] : [svgQuery],
+ );
+ const kinds = queries.length > 0 ? yield queries : [];
+ const urls: DomMetadataCapture["urls"] = [];
+ const agentHints: DomMetadataCapture["agentHints"] = [];
+ let queryIndex = 0;
+ let unresolvedSvgNodes = 0;
+ let excludedUrls = 0;
+ for (const { options, svgQuery } of pending) {
+ let svgElement = options.svgElement;
+ if (svgQuery !== undefined) {
+ const kind = svgQuery === null ? undefined : kinds[queryIndex++];
+ svgElement = kind === true;
+ if (kind === undefined) {
+ unresolvedSvgNodes += 1;
+ completeness?.exclude("metadata", "provider_unavailable");
+ }
+ }
+ const metadata = domMetadata({ ...options, svgElement });
+ for (const url of metadata.urls) {
+ urls.push(url);
+ if (url.destination_scope !== "approved") {
+ excludedUrls += 1;
+ completeness?.exclude(
+ "metadata",
+ url.destination_scope === "outside_policy"
+ ? "disallowed_origin"
+ : "unsupported_url",
+ );
+ }
+ }
+ agentHints.push(...metadata.agentHints);
+ }
+ return { urls, agentHints, unresolvedSvgNodes, excludedUrls };
+}
export const captureAccessibility = (
results: readonly unknown[],
diff --git a/src/browser/CdpCaptureDomSvg.ts b/src/browser/CdpCaptureDomSvg.ts
index 3d1a5c977..4d021766c 100644
--- a/src/browser/CdpCaptureDomSvg.ts
+++ b/src/browser/CdpCaptureDomSvg.ts
@@ -1,4 +1,4 @@
-import { numberValue } from "./CdpCaptureValues.js";
+import { numberValue, recordValue } from "./CdpCaptureValues.js";
const SVG_NAMESPACE = "http://www.w3.org/2000/svg";
const XLINK_NAMESPACE = "http://www.w3.org/1999/xlink";
@@ -18,11 +18,34 @@ interface XmlSvgLink {
interface DocumentSvgAncestry {
readonly xml: boolean;
- readonly nodes: DomSnapshotNodes;
- readonly svgContexts: Map;
readonly xmlLinks: Map;
}
+export interface DomSvgNodeQuery {
+ readonly backendNodeId: number;
+ readonly nodeName: string;
+}
+
+/** Bind the browser's SVG flag to the exact snapshotted element. */
+export const capturedSvgNodeKind = (
+ query: DomSvgNodeQuery,
+ result: unknown,
+): boolean | undefined => {
+ const node = recordValue(recordValue(result)?.node);
+ if (
+ node?.backendNodeId !== query.backendNodeId ||
+ node.nodeName !== query.nodeName ||
+ node.nodeType !== 1
+ )
+ return undefined;
+ // CDP omits isSVG for non-SVG nodes. Other values are malformed, not false.
+ return node.isSVG === undefined
+ ? false
+ : typeof node.isSVG === "boolean"
+ ? node.isSVG
+ : undefined;
+};
+
interface DomSvgLink {
readonly svgElement: boolean;
readonly xmlDocument: boolean;
@@ -79,8 +102,6 @@ export const createDocumentSvgAncestry = (
const xml = xmlDocument(nodes);
return {
xml,
- nodes,
- svgContexts: new Map(),
xmlLinks: xml ? resolveXmlElements(nodes) : new Map(),
};
};
@@ -91,11 +112,7 @@ export const domSvgLink = (
): DomSvgLink => {
if (!ancestry.xml) {
return {
- svgElement: elementInSvgContext(
- index,
- ancestry.nodes,
- ancestry.svgContexts,
- ),
+ svgElement: false,
xmlDocument: false,
xlinkHref: undefined,
};
@@ -108,43 +125,6 @@ export const domSvgLink = (
};
};
-// Chrome's HTML parser records SVG local names (`svg`, `foreignObject`).
-// Descendants of foreignObject are HTML until a nested `svg`.
-const elementInSvgContext = (
- index: number,
- nodes: DomSnapshotNodes,
- contexts: Map,
-): boolean => {
- let current = index;
- const seen = new Set();
- let inSvg = false;
- while (
- current >= 0 &&
- current < nodes.nodeNames.length &&
- !seen.has(current)
- ) {
- const cached = contexts.get(current);
- if (cached !== undefined) {
- inSvg = cached;
- break;
- }
- seen.add(current);
- if (stringAt(nodes.strings, nodes.nodeNames[current]) === "svg") {
- inSvg = true;
- break;
- }
- const parent = Math.trunc(nodes.parents[current] ?? -1);
- if (parent < 0 || parent === current) break;
- if (stringAt(nodes.strings, nodes.nodeNames[parent]) === "foreignObject")
- break;
- current = parent;
- }
- // Cache the entire examined chain, including forward references and cycles,
- // so shared ancestors are examined once per document.
- for (const node of seen) contexts.set(node, inSvg);
- return inSvg;
-};
-
interface NamespaceRestore {
readonly prefix: string;
readonly previous: string | undefined;
diff --git a/src/browser/CdpPageCapture.ts b/src/browser/CdpPageCapture.ts
index 0d97576b5..f49d4e186 100644
--- a/src/browser/CdpPageCapture.ts
+++ b/src/browser/CdpPageCapture.ts
@@ -17,8 +17,10 @@ import {
captureFrames,
captureResources,
type CapturedResource,
+ type DomCapture,
mainFrameUrl,
} from "./CdpCaptureDocuments.js";
+import { capturedSvgNodeKind } from "./CdpCaptureDomSvg.js";
import {
allowedSanitizedUrl,
delayWithCancellation,
@@ -52,7 +54,7 @@ interface CaptureState {
interface CapturedSections {
readonly attachedUrl: string;
readonly frames: WebPageInspection["frames"];
- readonly dom: ReturnType;
+ readonly dom: DomCapture;
readonly accessibility: ReturnType;
readonly scripts: WebPageInspection["scripts"];
readonly resources: WebPageInspection["resources"];
@@ -260,9 +262,7 @@ const authorizeObservationWindow = async (
throw new BrowserObservationError("inspect_web_page", "target_not_allowed");
};
-const capturePageDom = async (
- state: CaptureState,
-): Promise> => {
+const capturePageDom = async (state: CaptureState): Promise => {
const { context, allowedOrigins } = state;
const result = await context.connection.send(
"DOMSnapshot.captureSnapshot",
@@ -274,12 +274,56 @@ const capturePageDom = async (
context.sessionId,
context.signal,
);
- return captureDom(
+ const capture = captureDom(
result,
allowedOrigins,
context.input,
state.events.completeness,
);
+ let step = capture.next();
+ let descriptionUnavailable = false;
+ const pendingController = new AbortController();
+ const signal =
+ context.signal === undefined
+ ? pendingController.signal
+ : AbortSignal.any([context.signal, pendingController.signal]);
+ while (!step.done) {
+ const pending = step.value.map(async (query) => {
+ if (descriptionUnavailable) return undefined;
+ try {
+ return capturedSvgNodeKind(
+ query,
+ await context.connection.send(
+ "DOM.describeNode",
+ { backendNodeId: query.backendNodeId, depth: 0 },
+ context.sessionId,
+ signal,
+ ),
+ );
+ } catch (cause: unknown) {
+ // A detached node can disappear between snapshot and description.
+ // Preserve partial metadata, but propagate transport/cancellation errors.
+ if (!(cause instanceof CdpCommandRejection)) throw cause;
+ if (cause.code === -32_601) descriptionUnavailable = true;
+ else if (cause.code !== -32_000) throw cause;
+ return undefined;
+ }
+ });
+ try {
+ // Promise.all preserves snapshot order even when CDP replies out of order.
+ step = capture.next(await Promise.all(pending));
+ } catch (cause: unknown) {
+ // Stop and settle this bounded batch before the session can be detached.
+ pendingController.abort();
+ await Promise.allSettled(pending);
+ throw cause;
+ }
+ }
+ if (step.value.unresolvedSvgNodes > 0)
+ state.limitations.push(
+ `SVG identity was unavailable for ${String(step.value.unresolvedSvgNodes)} snapshotted XLink candidate nodes; their URL destinations remain unknown.`,
+ );
+ return step.value;
};
const normalizedInspection = (
diff --git a/src/browser/CdpSafeMetadata.test.ts b/src/browser/CdpSafeMetadata.test.ts
index 0cff4e094..ef9c42e14 100644
--- a/src/browser/CdpSafeMetadata.test.ts
+++ b/src/browser/CdpSafeMetadata.test.ts
@@ -289,4 +289,25 @@ describe("safe CDP response metadata referrer policy", () => {
expect(captured.response.policies.referrer_policy).toBe(expected);
expect(captured.response.policies.coop).toBe("same-origin");
});
+
+ it.each<[string | number | undefined, number | null]>([
+ ["100", 100],
+ [" 0 ", 0],
+ [100, 100],
+ ["-5", null],
+ ["+12", null],
+ ["0x10", null],
+ ["1e3", null],
+ ["9007199254740991", 9007199254740991],
+ ["9007199254740992", null],
+ [undefined, null],
+ ])("declares Content-Length %j only for decimal digits", (raw, expected) => {
+ const captured = safeResponseMetadata(
+ "request-length",
+ `${origin}/api`,
+ { headers: raw === undefined ? {} : { "Content-Length": raw } },
+ new Set([origin]),
+ );
+ expect(captured.response.content_length).toBe(expected);
+ });
});
diff --git a/src/browser/CdpSafeMetadata.ts b/src/browser/CdpSafeMetadata.ts
index 589c00367..1347cdcca 100644
--- a/src/browser/CdpSafeMetadata.ts
+++ b/src/browser/CdpSafeMetadata.ts
@@ -1,10 +1,6 @@
import type { WebPageInspection } from "../domain/browserObservationSchemas.js";
import { sanitizeBrowserUrl } from "../domain/browserObservation.js";
-import {
- numberValue,
- cdpStringValue,
- type UnknownRecord,
-} from "./CdpCaptureValues.js";
+import { cdpStringValue, type UnknownRecord } from "./CdpCaptureValues.js";
type ResponseMetadata = WebPageInspection["metadata"]["responses"][number];
type LinkMetadata = ResponseMetadata["links"][number];
@@ -43,7 +39,7 @@ export const safeResponseMetadata = (
request_id: requestId,
url,
mime_type: boundedHeader(cdpStringValue(response.mimeType)),
- content_length: nonnegativeInteger(headers.get("content-length")),
+ content_length: contentLength(headers.get("content-length")),
content_encoding: boundedHeader(headers.get("content-encoding")),
csp,
links,
@@ -343,9 +339,12 @@ const policyToken = (value: string | undefined): string | null => {
return /^[a-z][a-z0-9_.\x2d]*$/u.test(token) ? token : null;
};
-const nonnegativeInteger = (value: string | undefined): number | null => {
- const number = numberValue(value === undefined ? undefined : Number(value));
- return number === undefined ? null : Math.max(0, Math.trunc(number));
+// RFC 9110 section 8.6: Content-Length = 1*DIGIT. Other spellings declare no length.
+const contentLength = (value: string | undefined): number | null => {
+ const token = (value ?? "").trim();
+ if (!/^[0-9]+$/u.test(token)) return null;
+ const length = Number(token);
+ return Number.isSafeInteger(length) ? length : null;
};
const boundedHeader = (value: string | undefined): string | null =>
diff --git a/src/browser/PlaywrightScenarioBrowser.test.ts b/src/browser/PlaywrightScenarioBrowser.test.ts
index 79e903975..ffd2dba95 100644
--- a/src/browser/PlaywrightScenarioBrowser.test.ts
+++ b/src/browser/PlaywrightScenarioBrowser.test.ts
@@ -164,7 +164,15 @@ it("keeps attached-target ownership after the cleanup response timeout", async (
cleanup: { reason: expect.stringContaining("timed out") },
});
await closeStarted.promise;
- await vi.advanceTimersByTimeAsync(1_000);
+ let responseSettled = false;
+ void timedOutClose
+ .finally(() => {
+ responseSettled = true;
+ })
+ .catch(() => {});
+ await vi.advanceTimersByTimeAsync(29_999);
+ expect(responseSettled).toBe(false);
+ await vi.advanceTimersByTimeAsync(1);
await timeoutExpectation;
expect(settled).toEqual([]);
diff --git a/src/browser/PlaywrightScenarioBrowser.ts b/src/browser/PlaywrightScenarioBrowser.ts
index 615ad055e..3af9ade9c 100644
--- a/src/browser/PlaywrightScenarioBrowser.ts
+++ b/src/browser/PlaywrightScenarioBrowser.ts
@@ -11,6 +11,9 @@ import { BrowserObservationError } from "../domain/browserObservationError.js";
import { withPlaywrightExecutionBoundary } from "./PlaywrightExecutionBoundary.js";
const OPERATION = "capture_browser_scenario" as const;
+// Closing a real Chrome persistent context can take several seconds even when
+// it succeeds. The shorter operation deadline must not misreport cleanup.
+const CLEANUP_CONFIRMATION_TIMEOUT_MS = 30_000;
const throwIfScenarioCancelled = (signal: AbortSignal | undefined): void => {
if (signal?.aborted === true)
@@ -71,7 +74,11 @@ export class PlaywrightScenarioBrowserCleanupOwner {
signal?: AbortSignal,
): Promise {
try {
- await withPlaywrightExecutionBoundary(() => cleanup, 1_000, signal);
+ await withPlaywrightExecutionBoundary(
+ () => cleanup,
+ CLEANUP_CONFIRMATION_TIMEOUT_MS,
+ signal,
+ );
} catch (cause: unknown) {
throw new BrowserObservationError(OPERATION, "cleanup_failed", {
cause,
diff --git a/src/browser/PlaywrightScenarioEvents.sharedContext.test.ts b/src/browser/PlaywrightScenarioEvents.sharedContext.test.ts
new file mode 100644
index 000000000..8e20a83ae
--- /dev/null
+++ b/src/browser/PlaywrightScenarioEvents.sharedContext.test.ts
@@ -0,0 +1,130 @@
+import { EventEmitter } from "node:events";
+import type { Page } from "playwright-core";
+import { expect, it } from "vitest";
+
+import { browserScenarioSchema } from "../domain/browserScenario.js";
+import { BrowserScenarioSecrets } from "./BrowserScenarioSecrets.js";
+import { PlaywrightScenarioEvents } from "./PlaywrightScenarioEvents.js";
+
+it("omits a request without a frame in a shared context", () => {
+ const context = new EventEmitter();
+ const page = new EventEmitter() as unknown as Page;
+ const scenario = browserScenarioSchema.parse({
+ browser: { mode: "launch", executable_path: "/opt/chromium" },
+ start_url: { url: "https://app.example.test/" },
+ actions: [{ step_id: "wait", action: "wait_for_timeout", duration_ms: 1 }],
+ capture: { events: ["network"] },
+ });
+ const secrets = BrowserScenarioSecrets.resolve(scenario, {});
+ if (secrets === undefined) throw new Error("Expected resolved secrets");
+ const events = new PlaywrightScenarioEvents({
+ page,
+ context: context as never,
+ ownsContext: false,
+ enabled: new Set(["network"]),
+ secrets,
+ });
+ const unknownRequest = {
+ frame: () => {
+ throw new Error("Frame for this navigation request is unavailable");
+ },
+ url: () => "https://unrelated.example.test/private",
+ };
+ context.emit("request", unknownRequest);
+ expect(events.result().items).toEqual([]);
+ expect(events.limitations()).toContain(
+ "Shared-context network capture excludes requests without a known root or descendant Page frame.",
+ );
+});
+
+it("detaches root and popup listeners when a scenario finishes", async () => {
+ const context = new EventEmitter();
+ const page = new EventEmitter() as unknown as Page;
+ const popup = Object.assign(new EventEmitter(), {
+ url: () => "https://app.example.test/popup",
+ });
+ const scenario = browserScenarioSchema.parse({
+ browser: { mode: "launch", executable_path: "/opt/chromium" },
+ start_url: { url: "https://app.example.test/" },
+ actions: [{ step_id: "wait", action: "wait_for_timeout", duration_ms: 1 }],
+ capture: { events: ["console", "popups"] },
+ });
+ const secrets = BrowserScenarioSecrets.resolve(scenario, {});
+ if (secrets === undefined) throw new Error("Expected resolved secrets");
+ const events = new PlaywrightScenarioEvents({
+ page,
+ context: context as never,
+ ownsContext: false,
+ enabled: new Set(["console", "popups"]),
+ secrets,
+ });
+ (page as unknown as EventEmitter).emit("popup", popup);
+ expect((page as unknown as EventEmitter).listenerCount("console")).toBe(1);
+ expect(popup.listenerCount("console")).toBe(1);
+ // Popup closure is recorded, then its page-owned listeners are released.
+ expect(popup.listenerCount("close")).toBe(2);
+ await events.finish();
+ expect((page as unknown as EventEmitter).listenerCount("console")).toBe(0);
+ expect((page as unknown as EventEmitter).listenerCount("popup")).toBe(0);
+ expect(popup.listenerCount("console")).toBe(0);
+ expect(popup.listenerCount("popup")).toBe(0);
+ expect(popup.listenerCount("close")).toBe(0);
+});
+
+it("detaches worker and websocket listeners when a scenario finishes", async () => {
+ const context = new EventEmitter();
+ const page = new EventEmitter() as unknown as Page;
+ const socket = Object.assign(new EventEmitter(), {
+ url: () => "wss://app.example.test/socket",
+ });
+ const worker = Object.assign(new EventEmitter(), {
+ url: () => "https://app.example.test/worker.js",
+ });
+ const scenario = browserScenarioSchema.parse({
+ browser: { mode: "launch", executable_path: "/opt/chromium" },
+ start_url: { url: "https://app.example.test/" },
+ actions: [{ step_id: "wait", action: "wait_for_timeout", duration_ms: 1 }],
+ capture: { events: ["websockets", "workers"] },
+ });
+ const secrets = BrowserScenarioSecrets.resolve(scenario, {});
+ if (secrets === undefined) throw new Error("Expected resolved secrets");
+ const events = new PlaywrightScenarioEvents({
+ page,
+ context: context as never,
+ ownsContext: false,
+ enabled: new Set(["websockets", "workers"]),
+ secrets,
+ });
+ (page as unknown as EventEmitter).emit("websocket", socket);
+ (page as unknown as EventEmitter).emit("worker", worker);
+ expect(socket.listenerCount("framesent")).toBe(1);
+ expect(worker.listenerCount("close")).toBe(1);
+ await events.finish();
+ expect(socket.listenerCount("framesent")).toBe(0);
+ expect(socket.listenerCount("framereceived")).toBe(0);
+ expect(socket.listenerCount("close")).toBe(0);
+ expect(worker.listenerCount("close")).toBe(0);
+});
+
+it("detaches owned-context popup discovery when a scenario finishes", async () => {
+ const context = new EventEmitter();
+ const page = new EventEmitter() as unknown as Page;
+ const scenario = browserScenarioSchema.parse({
+ browser: { mode: "launch", executable_path: "/opt/chromium" },
+ start_url: { url: "https://app.example.test/" },
+ actions: [{ step_id: "wait", action: "wait_for_timeout", duration_ms: 1 }],
+ capture: { events: ["console"] },
+ });
+ const secrets = BrowserScenarioSecrets.resolve(scenario, {});
+ if (secrets === undefined) throw new Error("Expected resolved secrets");
+ const events = new PlaywrightScenarioEvents({
+ page,
+ context: context as never,
+ ownsContext: true,
+ enabled: new Set(["console"]),
+ secrets,
+ });
+ expect(context.listenerCount("page")).toBe(1);
+ await events.finish();
+ expect(context.listenerCount("page")).toBe(0);
+});
diff --git a/src/browser/PlaywrightScenarioEvents.ts b/src/browser/PlaywrightScenarioEvents.ts
index 18e1f0e3b..aee9db630 100644
--- a/src/browser/PlaywrightScenarioEvents.ts
+++ b/src/browser/PlaywrightScenarioEvents.ts
@@ -54,10 +54,11 @@ export class PlaywrightScenarioEvents {
private readonly enabled: ReadonlySet;
private readonly secrets: BrowserScenarioSecrets;
private readonly ownsContext: boolean;
- private readonly pages = new Set();
+ private pages = new WeakSet();
private readonly incompleteFamilies = new Set();
private readonly network: PlaywrightScenarioNetwork | undefined;
private stopNetwork: (() => void) | undefined;
+ private readonly stopListeners = new Map | | | | | | | | | | | | | | | | |