binaryninja api

ثنائي النينجا API

يحتوي هذا المستودع على الوثائق والتعليمات البرمجية المصدرية لواجهات برمجة تطبيقات C++ وPython وRust لمنصة الهندسة العكسية Binary Ninja.

التوثيق

تتوفر الوثائق عبر الإنترنت لواجهات برمجة التطبيقات التالية:

• C++ API، فرع مستقر
• Python API، فرع مستقر
• واجهة برمجة تطبيقات بايثون، فرع التطوير
• Rust API، فرع مستقر
• Rust API، فرع التطوير

تعليمات الاستخدام والبناء

من أجل إنشاء Binary Ninja API، ستحتاج إلى استخدام المراجعة المحددة التي تطابق التجزئة من الملف api_REVISION.txt . يجب أن يكون هذا الملف موجودًا في مجلد التثبيت الجذر لنظامي التشغيل Linux وWindows أو المجلد الفرعي Contents/Resources الخاص بالتطبيق على نظام التشغيل macOS. أسهل طريقة للقيام بذلك هي عن طريق استنساخ هذا المستودع (أو إضافته كوحدة فرعية) والقيام بشيء مثل git checkout $(cat api_REVISION.txt | awk -F/ '{print $NF}') . يمكن العثور هنا على وثائق حول كيفية إعداد هذا باستخدام شيء مثل cmake .

لكتابة ملحقات Binary Ninja باستخدام C++، ستحتاج إلى إنشاء C++ API. يتم إنشاء مكتبة API بشكل مشابه لمعظم المشاريع المستندة إلى CMake؛ تم توضيح الخطوات الأساسية على النحو التالي:

 # Get the source
git clone https://github.com/Vector35/binaryninja-api.git
cd binaryninja-api
git submodule update --init --recursive

# Configure an out-of-source build setup
cmake -S . -B build # (additional arguments go here if needed)

# Compile
cmake --build build -j8

بالإضافة إلى إعداد البناء الافتراضي، قد ترغب في:

• بناء الأمثلة. لإنشاء أمثلة واجهة برمجة التطبيقات، قم بتمرير -DBN_API_BUILD_EXAMPLES=ON إلى CMake عند تكوين البنية. بعد نجاح البناء، يمكنك تثبيت المكونات الإضافية المضمنة عن طريق تشغيل هدف install . عند استخدام منشئ البنية "Unix Makefiles"، يبدو هذا كما يلي: make install .
• بناء المكونات الإضافية لواجهة المستخدم. ستحتاج إلى تثبيت Qt 6.7.2 (حتى وقت كتابة هذا التقرير) لإنشاء المكونات الإضافية لواجهة المستخدم.
• بناء بلا رأس. إذا كنت تستخدم توزيعة Binary Ninja بدون رأس أو كنت لا ترغب في إنشاء مكونات إضافية لواجهة المستخدم، فقم بتمرير -DHEADLESS=ON إلى CMake عند تكوين البنية.

استكشاف الأخطاء وإصلاحها

• إذا تم تثبيت Binary Ninja في موقع مختلف عن الموقع الافتراضي للنظام الأساسي (المحدد في CMakeLists.txt)، فمن المحتمل أن تحصل على خطأ يفيد "لم يتم العثور على Binary Ninja Core". حدد المسار إلى تثبيت Binary Ninja الخاص بك عن طريق تمرير -DBN_INSTALL_DIR=/path/to/binaryninja إلى CMake عند تكوين إعداد البناء.
• نظرًا لأن Binary Ninja هو منتج 64 بت فقط، تأكد من أنك تستخدم بيئة تجميع وربط 64 بت. قد تشير الأخطاء الموجودة على نظام التشغيل Windows مثل LNK1107 إلى أن وحدات البت الخاصة بك غير متطابقة.

أمثلة

هناك العديد من الأمثلة المتاحة. يوضح مجلد أمثلة Python العديد من التطبيقات المختلفة لـ Python API، بينما تتضمن أمثلة C++ ما يلي:

• تعتبر الخلفية_مهمة مكونًا إضافيًا يوضح كيفية إدارة مهمة في الخلفية.*
• bin-info هو ملف قابل للتنفيذ مستقل يطبع بعض المعلومات حول ملف ثنائي معين على الجهاز.*
• نقطة التوقف هي مكون إضافي يسمح لك بتحديد منطقة ضمن ملف ثنائي x86 واستخدام قائمة السياق لملئها بوحدات البايت الخاصة بنقطة التوقف.
• يوضح التفكيك في سطر الأوامر كيفية تفريغ التفكيك في سطر الأوامر.*
• يقوم llil-parser بتوزيع المستوى المنخفض من IL، موضحًا كيفية مطابقة الأنواع واستخدام فئة الزائر.*
• يقوم mlil-parser بتحليل مستوى IL المتوسط، مما يوضح كيفية مطابقة الأنواع واستخدام فئة الزائر.*
• print_syscalls هو ملف قابل للتنفيذ مستقل يقوم بطباعة syscalls المستخدمة في ثنائي معين.*
• الفرز عبارة عن مكون إضافي مميز بالكامل يتم شحنه وتمكينه افتراضيًا، مما يوضح كيفية القيام بمجموعة واسعة من المهام بما في ذلك توسيع واجهة المستخدم من خلال QT.
• مسارات العمل عبارة عن مجموعة من المكونات الإضافية التي توضح استخدام مسارات العمل لتوسيع مسار التحليل.
• ينشئ ملحق x86 امتدادًا للهندسة المعمارية يوضح كيفية تعديل سلوك البنى المضمنة دون إنشاء بديل كامل.

* يتطلب ترخيصًا يدعم الوصول إلى واجهة برمجة التطبيقات بدون رأس.

مشاكل

لا يقوم متتبع المشكلات لهذا المستودع بتتبع المشكلات المتعلقة بكود المصدر الموجود هنا فحسب، بل يتتبع أيضًا مشكلات منتج Binary Ninja الأوسع.

الفروع

يحتوي هذا المستودع على فرعين أساسيين dev و master .

يحتوي فرع dev على آخر التحديثات ويتتبع أحدث إصدار من تطوير Binary Ninja؛ يجب تقديم طلبات السحب ضد هذا الفرع. يتتبع الفرع master البناء المستقر لـ Binary Ninja. إذا قمت للتو بتثبيت Binary Ninja لأول مرة، فمن المحتمل أنك في قناة الإصدار المستقر.

المساهمة

المساهمات العامة هي موضع ترحيب في هذا المستودع. معظم واجهات برمجة التطبيقات (API) والوثائق الموجودة في هذا المستودع مرخصة بموجب ترخيص MIT، ومع ذلك، فإن واجهة برمجة التطبيقات (API) تتعامل مع تطبيق تجاري مغلق المصدر، Binary Ninja. بالإضافة إلى ذلك، تم ترخيص Rust API بموجب ترخيص Apache 2.0.

إذا كنت مهتمًا بالمساهمة عند إرسال علاقاتك العامة الأولى، فستتلقى إشعارًا من CLA Assistant الذي يسمح لك بالتوقيع على اتفاقية ترخيص المساهمة الخاصة بنا عبر الإنترنت.

المنصات

يحتوي هذا المستودع على جميع المكونات الإضافية للنظام الأساسي المتوفرة لدينا هنا:

• ويندوز
• لينكس
• ماك
• فري بي إس دي
• مرسوم
• إيفي

أبنية

يحتوي هذا المستودع على جميع المكونات الإضافية للهندسة المعمارية المتوفرة في الإصدارات الشخصية والتجارية من Binary Ninja. يمكنك العثور على كل بنية هنا:

• x86/x86_64
• أرم64
• أرمv7
• قدرة شرائية
• MIPS
• RISC-V
• MSP430

BinaryViewTypes

يحتوي هذا المستودع على جميع المكونات الإضافية لنوع العرض الثنائي المتوفرة هنا:

• ماخ-O
• قزم
• بي/كوف/تي
• MD1روم

معلومات التصحيح

• استيراد القزم
• استيراد بي دي بي
• استيراد بنك التنمية الإسلامي

المستودعات ذات الصلة

بالإضافة إلى أن مستودع API الرئيسي هذا مفتوح المصدر، فإن Vector35 لديه أيضًا مصدر مفتوح لـ Debugger ومكونات Objective-C مفتوحة المصدر أيضًا:

• مصحح الأخطاء
• Workflow_objc

الترخيص

قد يتم إصدار بعض المكونات بموجب تراخيص مفتوحة المصدر متوافقة ولكنها مختلفة قليلاً وسيكون لها ملف ترخيص خاص بها حسب الاقتضاء.

يتم إصدار المكونات المتبقية بموجب ترخيص MIT.

لاحظ أن ملفات .lib مضمنة في الإصدارات الثنائية الأصلية لـ Binary Ninja لنظام التشغيل Windows. يتم أيضًا إصدار ملفات lib هذه بموجب نفس ترخيص هذا المستودع ويمكن توزيعها وفقًا لذلك.