كاراكال

كاراكال هي أداة تحليل ثابتة تعمل على تمثيل SIERRA للعقود الذكية لـ Starknet.

الميزات

• كاشفات لاكتشاف كود Cairo الضعيف
• طابعات لتقارير المعلومات
• تحليل التلوث
• إطار تحليل تدفق البيانات
• سهولة التشغيل في مشاريع Scarb

التثبيت

الملفات الثنائية المجمعة مسبقاً

الملفات الثنائية المجمعة مسبقاً متوفرة في صفحة الإصدارات. إذا كنت تستخدم مترجم Cairo 1.x.x فاستخدم الإصدار الثنائي v0.1.x، وإذا كنت تستخدم مترجم Cairo 2.x.x فاستخدم v0.2.x.

البناء من المصدر

تحتاج إلى مترجم Rust و Cargo. البناء من git:

cargo install --git https://github.com/crytic/caracal --profile release --force

البناء من نسخة محلية:

git clone https://github.com/crytic/caracal
cd caracal
cargo install --path . --profile release --force

الاستخدام

عرض الكاشفات:

caracal detectors

عرض الطابعات:

caracal printers

استخدام مستقل

لاستخدامه مع ملف Cairo مستقل ولديك مترجم Cairo محلي ثنائي، يكفي توجيهه إلى الملف. وإلا، يتم استخدام مترجم مدمج وتحتاج إلى تمرير مسار مكتبة corelib إما باستخدام خيار --corelib أو بتعيين متغير البيئة CORELIB_PATH.
تشغيل الكاشفات:

caracal detect path/file/to/analyze

caracal detect path/file/to/analyze --corelib path/to/corelib/src

تشغيل الطابعات:

caracal print path/file/to/analyze --printer printer_to_use --corelib path/to/corelib/src

مشروع Cairo

إذا كان لديك مشروع Cairo يحتوي على عدة ملفات وعقود، فقد تحتاج إلى تحديد العقود باستخدام --contract-path. يتم استخدام مترجم Cairo المحلي الثنائي إذا كان متاحاً، وإلا يتم استخدام مترجم مدمج. في الحالة الأخيرة، تحتاج أيضاً إلى تحديد corelib كما هو موضح أعلاه للحالة المستقلة. المسار هو الدليل الذي يحتوي على ملف cairo_project.toml.
تشغيل الكاشفات:

caracal detect path/to/dir

caracal detect path/to/dir --contract-path token::myerc20::... token::myerc721::...

تشغيل الطابعات:

caracal print path/to/dir --printer printer_to_use

Scarb

إذا كان لديك مشروع يستخدم Scarb، فأنت بحاجة إلى إضافة ما يلي في ملف Scarb.toml:

[[target.starknet-contract]]
sierra = true

[cairo]
sierra-replace-ids = true

ثم قم بتمرير المسار إلى الدليل الذي يحتوي على ملف Scarb.toml. تشغيل الكاشفات:

caracal detect path/to/dir

تشغيل الطابعات:

caracal print path/to/dir --printer printer_to_use

الكاشفات

يمثل عمود Cairo إصدار (إصدارات) المترجم الذي يكون الكاشف صالحاً له.

الطابعات

• cfg: تصدير CFG لكل دالة إلى ملف .dot
• callgraph: تصدير رسم بياني لاستدعاءات الدوال إلى ملف .dot

كيفية المساهمة

اطلع على الويكي في المواضيع التالية:

• كيفية كتابة كاشف
• كيفية كتابة طابعة

القيود

• لا يتم التعامل مع الدوال المضمنة بشكل صحيح.
• بما أنه يعمل على تمثيل SIERRA، فليس من الممكن الإبلاغ عن مكان الخطأ في الكود المصدري، ولكن يمكننا فقط الإبلاغ عن تعليمات SIERRA / ما هو متاح في برنامج SIERRA.