joern

جويرن - منضدة عمل صائد الحشرات

Jorn عبارة عن منصة لتحليل التعليمات البرمجية المصدرية والكود الثانوي والملفات التنفيذية الثنائية. يقوم بإنشاء رسوم بيانية لخصائص التعليمات البرمجية (CPGs)، وهي تمثيل بياني للتعليمات البرمجية لتحليل التعليمات البرمجية عبر اللغات. يتم تخزين الرسوم البيانية لخصائص التعليمات البرمجية في قاعدة بيانات الرسم البياني المخصصة. يسمح هذا باستخراج التعليمات البرمجية باستخدام استعلامات البحث التي تمت صياغتها بلغة استعلام خاصة بالمجال تعتمد على Scala. تم تطوير Jorn بهدف توفير أداة مفيدة لاكتشاف الثغرات الأمنية والبحث في تحليل البرامج الثابتة.

موقع الكتروني: https://joern.io

التوثيق: https://docs.joern.io/

المواصفات: https://cpg.joern.io

الأخبار / سجل التغيير

• يهاجر Jorn v4.0.0 من overflowdb إلى flatgraph
• ترقية Jorn v2.0.0 من Scala2 إلى Scala3
• يقوم Jorn v1.2.0 بإزالة فئة overflowdb.traversal.Traversal . هذا التغيير غير متوافق تمامًا مع الإصدارات السابقة. انظر هنا للحصول على كتابة مفصلة.

متطلبات

• JDK 21 ( قد تعمل الإصدارات الأخرى، ولكن لم يتم اختبارها بشكل صحيح)
• اختياري : gcc وg++ (للاكتشاف التلقائي لملفات رأس نظام C/C++ إذا تم تضمينها/استخدامها في كود C/C++ الخاص بك)

متطلبات التطوير

• 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 أن تدعم وحدة المعالجة المركزية 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

الإصدارات

يتم إنشاء إصدار جديد تلقائيًا مرة واحدة يوميًا. يمكن للمساهمين أيضًا تشغيل سير عمل الإصدار يدويًا إذا كانوا بحاجة إلى الإصدار عاجلاً.

المطورين

إرشادات المساهمة

شكرًا لك على الوقت الذي أمضيته للمساهمة في Jorn! فيما يلي بعض الإرشادات لضمان دمج طلب السحب الخاص بك في أقرب وقت ممكن:

• حاول الاستفادة من القوالب قدر الإمكان، إلا أنها قد لا تناسب جميع الاحتياجات. الحد الأدنى الذي نود رؤيته هو:
  • عنوان يصف بإيجاز التغيير والغرض من العلاقات العامة، ويفضل أن يكون ذلك مع الوحدة المتأثرة بين قوسين مربعين، على سبيل المثال [javasrc2cpg] Addition Operator Fix .
  • وصف موجز للتغيرات في جسم العلاقات العامة. يمكن أن يكون هذا في نقاط أو فقرات.
  • رابط أو إشارة إلى المشكلة ذات الصلة، إن وجدت.
• لا:
  • على الفور يرسل CC/@/ بريدًا إلكترونيًا غير مرغوب فيه إلى المساهمين الآخرين، وسيقوم الفريق بمراجعة العلاقات العامة وتعيين المساهم الأكثر ملاءمة لمراجعة العلاقات العامة. تتم صيانة Jorn من قبل شركاء الصناعة والباحثين على حدٍ سواء، في الغالب بأهدافهم وأولوياتهم الخاصة، والمساعدة الإضافية هي إلى حد كبير العمل التطوعي. إذا أصبحت العلاقات العامة الخاصة بك قديمة، فتواصل معنا في تعليقات المتابعة مع مطالبة @ بتوضيح الأولوية أو التخطيط للوقت الذي يمكن معالجته فيه (إذا حدث ذلك، اعتمادًا على الجودة).
  • اترك نص الوصف فارغًا، فهذا يجعل مراجعة الغرض من العلاقات العامة أمرًا صعبًا.
• تذكر أن:
  • تذكر تنسيق التعليمات البرمجية الخاصة بك، أي تشغيل sbt scalafmt Test/scalafmt
  • أضف اختبار الوحدة للتحقق من التغيير.

إعداد إيد

فكرة ذكية

• تحميل مجتمع Intellij
• تثبيته وتشغيله
• قم بتثبيت Scala Plugin - ما عليك سوى البحث والتثبيت من داخل 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 ، تصبح جاهزًا لبدء كتابة التعليمات البرمجية لـ Jorn

QueryDB (البرنامج المساعد للاستعلامات)

طريقة سريعة لتطوير واختبار QueryDB:

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

يقوم الأمر الأخير بطباعة جميع الاستعلامات المتاحة - قم بإضافة استعلامك الخاص في querydb، وقم بتشغيل الأوامر المذكورة أعلاه مرة أخرى لترى أنه تم نشر استعلامك. مزيد من التفاصيل في الملف التمهيدي querydb المنفصل