joern

Joern - The Bug Hunter's Workbench

Joern เป็นแพลตฟอร์มสำหรับการวิเคราะห์ซอร์สโค้ด ไบต์โค้ด และไฟล์ปฏิบัติการแบบไบนารี มันสร้างกราฟคุณสมบัติโค้ด (CPG) ซึ่งเป็นการแสดงกราฟของโค้ดสำหรับการวิเคราะห์โค้ดข้ามภาษา กราฟคุณสมบัติของโค้ดจะถูกจัดเก็บไว้ในฐานข้อมูลกราฟแบบกำหนดเอง ซึ่งช่วยให้สามารถขุดโค้ดได้โดยใช้คำค้นหาที่สร้างขึ้นในภาษาสืบค้นเฉพาะโดเมนที่ใช้ Scala Joern ได้รับการพัฒนาโดยมีเป้าหมายในการจัดหาเครื่องมือที่มีประโยชน์สำหรับการค้นหาช่องโหว่และการวิจัยในการวิเคราะห์โปรแกรมแบบคงที่

เว็บไซต์: https://joern.io

เอกสารประกอบ: https://docs.joern.io/

ข้อมูลจำเพาะ: https://cpg.joern.io

ข่าว / บันทึกการเปลี่ยนแปลง

• Joern v4.0.0 ย้ายจาก overflowdb ไปเป็น flatgraph
• Joern v2.0.0 อัปเกรดจาก Scala2 เป็น Scala3
• Joern v1.2.0 ลบคลาส overflowdb.traversal.Traversal การเปลี่ยนแปลงนี้ไม่สามารถเข้ากันได้แบบย้อนหลังได้อย่างสมบูรณ์ ดูที่นี่สำหรับการเขียนรายละเอียด

ความต้องการ

• JDK 21 (เวอร์ชันอื่น อาจ ใช้งานได้ แต่ยังไม่ได้รับการทดสอบอย่างเหมาะสม)
• optional : gcc and g++ (for auto-discovery of C/C++ system header files if included/used in your C/C++ code)

ข้อกำหนดการพัฒนา

• mvn https://maven.apache.org/install.html

การติดตั้งอย่างรวดเร็ว

 wget https://github.com/joernio/joern/releases/latest/download/joern-install.sh
chmod +x ./joern-install.sh
sudo ./joern-install.sh
joern

     ██╗ ██████╗ ███████╗██████╗ ███╗   ██╗
     ██║██╔═══██╗██╔════╝██╔══██╗████╗  ██║
     ██║██║   ██║█████╗  ██████╔╝██╔██╗ ██║
██   ██║██║   ██║██╔══╝  ██╔══██╗██║╚██╗██║
╚█████╔╝╚██████╔╝███████╗██║  ██║██║ ╚████║
 ╚════╝  ╚═════╝ ╚══════╝╚═╝  ╚═╝╚═╝  ╚═══╝
Version: 2.0.1
Type `help` to begin

joern>

หากสคริปต์การติดตั้งล้มเหลวไม่ว่าด้วยเหตุผลใดก็ตาม ให้ลอง

 ./joern-install --interactive

การดำเนินการตามนักเทียบท่า

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern joern

วิธีรัน joern ในโหมดเซิร์ฟเวอร์:

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern joern --server

Almalinux 9 ต้องการให้ CPU รองรับ SSE4.2 สำหรับ kvm64 VM ให้ใช้เวอร์ชัน Almalinux 8 แทน

 docker run --rm -it -v /tmp:/tmp -v $(pwd):/app:rw -w /app -t ghcr.io/joernio/joern-alma8 joern

ข่าวประชาสัมพันธ์

ระบบจะสร้างรุ่นใหม่โดยอัตโนมัติวันละครั้ง ผู้มีส่วนร่วมยังสามารถเรียกใช้เวิร์กโฟลว์การเผยแพร่ได้ด้วยตนเอง หากต้องการการเผยแพร่เร็วกว่านี้

นักพัฒนา

แนวทางการบริจาค

ขอขอบคุณที่สละเวลาบริจาคให้กับ Joern! ต่อไปนี้เป็นหลักเกณฑ์บางประการเพื่อให้แน่ใจว่าคำขอดึงของคุณจะถูกรวมเข้าด้วยกันโดยเร็วที่สุด:

• พยายามใช้เทมเพลตให้มากที่สุดเท่าที่จะเป็นไปได้ แต่อาจไม่เหมาะกับทุกความต้องการ ขั้นต่ำที่เราต้องการเห็นคือ:
  • หัวเรื่องที่อธิบายการเปลี่ยนแปลงและวัตถุประสงค์โดยย่อของ PR โดยควรมีโมดูลที่ได้รับผลกระทบอยู่ในวงเล็บเหลี่ยม เช่น [javasrc2cpg] Addition Operator Fix
  • คำอธิบายสั้น ๆ เกี่ยวกับการเปลี่ยนแปลงเนื้อหาของ PR อาจเป็นหัวข้อย่อยหรือย่อหน้า
  • ลิงก์หรือการอ้างอิงถึงปัญหาที่เกี่ยวข้อง หากมี
• อย่า:
  • ทันที CC/@/ส่งอีเมลสแปมผู้มีส่วนร่วมรายอื่น ทีมงานจะตรวจสอบ PR และมอบหมายผู้มีส่วนร่วมที่เหมาะสมที่สุดเพื่อตรวจสอบ PR Joern ได้รับการดูแลโดยพันธมิตรในอุตสาหกรรมและนักวิจัย โดยส่วนใหญ่มีเป้าหมายและลำดับความสำคัญของตนเอง และความช่วยเหลือเพิ่มเติมส่วนใหญ่เป็นงานอาสาสมัคร หาก PR ของคุณล้าสมัย โปรดติดต่อเราในความคิดเห็นติดตามผลโดย @ เพื่อขอคำอธิบายเกี่ยวกับลำดับความสำคัญหรือการวางแผนว่าจะได้รับการแก้ไขเมื่อใด (หากเคย ขึ้นอยู่กับคุณภาพ)
  • ปล่อยเนื้อหาคำอธิบายว่างไว้ ซึ่งจะทำให้การทบทวนวัตถุประสงค์ของการประชาสัมพันธ์ทำได้ยาก
• อย่าลืม:
  • อย่าลืมจัดรูปแบบโค้ดของคุณ เช่น เรียกใช้ sbt scalafmt Test/scalafmt
  • เพิ่มการทดสอบหน่วยเพื่อตรวจสอบการเปลี่ยนแปลงของคุณ

การตั้งค่า IDE

Intellij IDEA

• ดาวน์โหลดชุมชน Intellij
• ติดตั้งและรันมัน
• ติดตั้งปลั๊กอิน Scala - เพียงค้นหาและติดตั้งจากภายใน Intellij
• สำคัญ: เปิด sbt ในพื้นที่เก็บข้อมูล joern ในพื้นที่ของคุณ รัน compile และเปิดไว้ - ซึ่งจะทำให้เราใช้ BSP บิลด์ในขั้นตอนถัดไป
• กลับไปที่ Intellij: เปิดโครงการ: เลือกโคลน joern ในพื้นที่ของคุณ: เลือกเพื่อเปิดเป็น BSP project (เช่น ไม่ใช่ sbt project !)
• รอให้การนำเข้าและการจัดทำดัชนีเสร็จสมบูรณ์ จากนั้นคุณจึงเริ่มต้นได้ เช่น Build -> build project หรือรันการทดสอบ

vscode

• ติดตั้ง VSCode และ Docker
• ติดตั้งปลั๊กอิน ms-vscode-remote.remote-containers
• เปิดโฟลเดอร์โครงการ Joern ใน VSCode Visual Studio Code ตรวจพบไฟล์ใหม่และเปิดกล่องข้อความว่า: Folder contains a Dev Container configuration file. Reopen to folder to develop in a container.
• เลือกปุ่ม Reopen in Container เพื่อเปิดโฟลเดอร์อีกครั้งในคอนเทนเนอร์ที่สร้างโดยไฟล์ .devcontainer/Dockerfile
• สลับไปที่แถบด้านข้าง scalameta.metals ใน VSCode และเลือก import build ใน BUILD COMMANDS
• หลังจากที่ import build สำเร็จ คุณก็พร้อมที่จะเริ่มเขียนโค้ดสำหรับ Joern

QueryDB (ปลั๊กอินแบบสอบถาม)

วิธีที่รวดเร็วในการพัฒนาและทดสอบ QueryDB:

 sbt stage
./querydb-install.sh
./joern-scan --list-query-names

คำสั่งสุดท้ายจะพิมพ์ข้อความค้นหาที่มีอยู่ทั้งหมด - เพิ่มข้อความค้นหาของคุณเองใน querydb เรียกใช้คำสั่งด้านบนอีกครั้งเพื่อดูว่าคำค้นหาของคุณได้รับการปรับใช้แล้ว รายละเอียดเพิ่มเติมใน QueryDB readme แยกต่างหาก