หน้าแรก>ซอร์สโค้ด JSP>หมวดหมู่อื่นๆ
ดาวน์โหลด

API ไบนารีนินจา

พื้นที่เก็บข้อมูลนี้ประกอบด้วยเอกสารประกอบและซอร์สโค้ดของ C++, Python และ Rust API สำหรับแพลตฟอร์มวิศวกรรมย้อนกลับของ Binary Ninja

เอกสารประกอบ

เอกสารออนไลน์มีให้สำหรับ API ต่อไปนี้:

  • C++ API สาขาที่เสถียร
  • Python API สาขาที่เสถียร
  • Python API สาขา Dev
  • Rust API สาขาที่เสถียร
  • Rust API สาขา Dev

คำแนะนำการใช้งานและการสร้าง

ในการสร้าง 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

นอกเหนือจากการตั้งค่าบิลด์เริ่มต้นแล้ว คุณอาจต้องการ:

  • สร้างตัวอย่าง หากต้องการสร้างตัวอย่าง API ให้ส่ง -DBN_API_BUILD_EXAMPLES=ON ไปที่ CMake เมื่อกำหนดค่าบิลด์ หลังจากที่บิลด์สำเร็จ คุณสามารถติดตั้งปลั๊กอินที่สร้างขึ้นได้โดยการรันเป้าหมาย install เมื่อใช้ตัวสร้างบิลด์ "Unix Makefiles" ดูเหมือนว่า: make install
  • สร้างปลั๊กอิน UI คุณจะต้องติดตั้ง Qt 6.7.2 (ณ วันที่เขียน) เพื่อสร้างปลั๊กอิน UI
  • สร้างแบบไม่มีหัว หากคุณใช้การกระจาย Binary Ninja แบบไม่มีส่วนหัวหรือคุณไม่ต้องการสร้างปลั๊กอิน UI ให้ส่ง -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++ ได้แก่:

  • background_task เป็นปลั๊กอินที่สาธิตการจัดการงานพื้นหลัง*
  • bin-info เป็นไฟล์ปฏิบัติการแบบสแตนด์อโลนที่พิมพ์ข้อมูลบางอย่างเกี่ยวกับไบนารีที่กำหนดไปยังเทอร์มินัล *
  • เบรกพอยต์เป็นปลั๊กอินที่ช่วยให้คุณสามารถเลือกภูมิภาคภายในไบนารี x86 และใช้เมนูบริบทเพื่อเติมไบต์ของเบรกพอยต์
  • การแยกส่วนบรรทัดคำสั่งสาธิตวิธีการถ่ายโอนข้อมูลการแยกส่วนไปยังบรรทัดคำสั่ง*
  • llil-parser แยกวิเคราะห์ IL ระดับต่ำ สาธิตวิธีจับคู่ประเภทและใช้คลาสผู้เยี่ยมชม*
  • mlil-parser แยกวิเคราะห์ IL ระดับกลาง สาธิตวิธีจับคู่ประเภทและใช้คลาสผู้เยี่ยมชม*
  • print_syscalls เป็นปฏิบัติการแบบสแตนด์อโลนที่พิมพ์ syscalls ที่ใช้ในไบนารีที่กำหนด *
  • Triage เป็นปลั๊กอินที่มีคุณลักษณะครบถ้วนซึ่งจัดส่งและเปิดใช้งานตามค่าเริ่มต้น ซึ่งสาธิตวิธีการทำงานที่หลากหลาย รวมถึงการขยาย UI ผ่าน QT
  • เวิร์กโฟลว์คือชุดของปลั๊กอินที่สาธิตการใช้เวิร์กโฟลว์เพื่อขยายไปป์ไลน์การวิเคราะห์
  • ส่วนขยาย x86 สร้างส่วนขยายสถาปัตยกรรมซึ่งแสดงวิธีปรับเปลี่ยนพฤติกรรมของสถาปัตยกรรมบิวด์อินโดยไม่ต้องสร้างการแทนที่โดยสมบูรณ์

* ต้องมีใบอนุญาตที่รองรับการเข้าถึง API แบบไม่มีหัว

ปัญหา

ตัวติดตามปัญหาสำหรับพื้นที่เก็บข้อมูลนี้ไม่เพียงแต่ติดตามปัญหาเกี่ยวกับซอร์สโค้ดที่มีอยู่ที่นี่ แต่ยังรวมถึงผลิตภัณฑ์ Binary Ninja ที่กว้างขึ้นด้วย

สาขา

พื้นที่เก็บข้อมูลนี้มีสองสาขาหลัก dev และ master

สาขา dev มีการอัปเดตล่าสุดและติดตามการพัฒนาล่าสุดของ Binary Ninja ควรทำการร้องขอการดึงกับสาขานี้ สาขา master ติดตามโครงสร้างที่มั่นคงของ Binary Ninja หากคุณเพิ่งติดตั้ง Binary Ninja เป็นครั้งแรก คุณน่าจะอยู่ในช่องทางการเผยแพร่ที่เสถียร

มีส่วนร่วม

การมีส่วนร่วมของสาธารณะยินดีต้อนรับสู่พื้นที่เก็บข้อมูลนี้ API และเอกสารประกอบส่วนใหญ่ในพื้นที่เก็บข้อมูลนี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT อย่างไรก็ตาม อินเทอร์เฟซ API กับแอปพลิเคชันเชิงพาณิชย์แบบปิดอย่าง Binary Ninja นอกจากนี้ Rust API ยังได้รับใบอนุญาตภายใต้ใบอนุญาต Apache 2.0

หากคุณสนใจที่จะมีส่วนร่วมเมื่อคุณส่ง PR ครั้งแรก คุณจะได้รับการแจ้งเตือนจากผู้ช่วย CLA ที่อนุญาตให้คุณลงนามในข้อตกลงใบอนุญาตการให้การสนับสนุนทางออนไลน์

แพลตฟอร์ม

พื้นที่เก็บข้อมูลนี้มีปลั๊กอินแพลตฟอร์มทั้งหมดของเราที่นี่:

  • หน้าต่าง
  • ลินุกซ์
  • ระบบปฏิบัติการ macOS
  • ฟรีBSD
  • พระราชกฤษฎีกา
  • อีเอฟไอ

สถาปัตยกรรม

พื้นที่เก็บข้อมูลนี้มีปลั๊กอินสถาปัตยกรรมทั้งหมดที่มีอยู่ใน Binary Ninja รุ่น Personal และ Commercial คุณสามารถค้นหาแต่ละสถาปัตยกรรมได้ที่นี่:

  • x86/x86_64
  • ARM64
  • ARMv7
  • ต่อหนึ่งคลิก
  • เอ็มไอพีเอส
  • RISC-V
  • เอ็มเอสพี430

BinaryViewTypes

พื้นที่เก็บข้อมูลนี้มีปลั๊กอิน Binary View Type ทั้งหมดของเราที่นี่:

  • ผู้ชาย
  • เอลฟ์
  • PE/กาแฟ/TE
  • MD1Rom

ข้อมูลการแก้ไขข้อบกพร่อง

  • นำเข้าแคระ
  • การนำเข้า PDB
  • ไอดีบีนำเข้า

ที่เก็บข้อมูลที่เกี่ยวข้อง

นอกจากที่เก็บ API หลักนี้ที่เป็นโอเพ่นซอร์ส Vector35 ยังมีโอเพ่นซอร์ส Debugger และปลั๊กอิน Objective-C โอเพ่นซอร์สเช่นกัน:

  • ดีบักเกอร์
  • เวิร์กโฟลว์_objc

การออกใบอนุญาต

ส่วนประกอบบางอย่างอาจเผยแพร่ภายใต้ใบอนุญาตโอเพ่นซอร์สที่เข้ากันได้แต่แตกต่างกันเล็กน้อย และจะมีไฟล์ใบอนุญาตของตัวเองตามความเหมาะสม

ส่วนประกอบที่เหลือได้รับการเผยแพร่ภายใต้ใบอนุญาต MIT

โปรดทราบว่าไฟล์ .lib จะรวมอยู่ในไบนารี่ดั้งเดิมของ Binary Ninja สำหรับ windows ไฟล์ lib เหล่านั้นยังได้รับการเผยแพร่ภายใต้ใบอนุญาตเดียวกันกับพื้นที่เก็บข้อมูลนี้ และอาจเผยแพร่ตามนั้น

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด