دليل اختبارات Trail of Bits

دليل اختبارات Trail of Bits هو مورد للمطورين ومحترفي الأمن حول تكوين وتحسين وأتمتة العديد من أدوات التحليل الثابت والديناميكي التي نستخدمها في Trail of Bits.

معاينة دليل الاختبارات: https://appsec.guide 🌐

لماذا هذا ضروري؟ ✨

• 📃 غالبًا ما تكون توثيقات تكوين الأدوات الحالية وتحسينها غير ودية للمطورين، لأنها غالبًا مخصصة لمحترفي الأمن. وينطبق هذا بشكل خاص على أدوات التفحيم (Fuzzing). وقد يؤدي ذلك إلى الإحباط وضعف الاعتماد على أدوات الأمن التي يفترض أن يكون تكوينها مباشرًا.
• ⚙️ حتى إذا كان تكوين الأداة سهلًا محليًا، فقد يكون من الصعب تكوينها في خطوط أنابيب CI/CD. غالبًا ما يتم إعداد أدوات الأمن باتباع التوثيقات عبر الإنترنت، لكن نادرًا ما يكون تكوينها محسّنًا. قد يؤدي هذا إلى أداة صاخبة يصعب صيانتها أكثر من قيمتها.
• 🧠 نهدف إلى جعل إعداد أدوات الأمن بفعالية أمرًا سهلًا قدر الإمكان. ومن خلال ذلك، نأمل أيضًا في إزالة الغموض عن تقنيات التحليل الثابت والديناميكي مثل التفحيم (Fuzzing) وتحليل التلوث (Taint Analysis).

الفصول

✅ الصادرة

🎥 ندوات عبر الإنترنت

🚧 قيد الإنشاء

• kAFL
• Rust
• التحقق الرسمي وTamarin

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

إذا كنت ترغب في المساهمة في دليل الاختبارات، فإليك بعض الإرشادات لمساعدتك على البدء:

1. إضافة أداة جديدة: إذا كنت تريد تغطية أداة جديدة في دليل الاختبارات، فاقترح موضوعًا في GitHub Issues. وبعد ذلك، يمكنك العمل على طلب سحب (Pull Request) جديد.
2. تحسين الفصول الحالية: إذا كانت لديك فكرة لتحسين فصل معين، يمكنك إضافة GitHub Issue.
3. تنفيذ مهام صغيرة: إذا لم يكن لديك وقت كبير ولكنك لا تزال ترغب في المساهمة، يمكنك اختيار أي مهمة صغيرة من قائمة قضايا GitHub.
4. الإبلاغ عن المشكلات: إذا وجدت مشكلة تقنية صغيرة أو خطأ إملائيًا، فأنشئ GitHub Issue جديدة و/أو أصلحها في طلب السحب الجديد.

إعداد سريع للتطوير المريح

1. ثبّت Hugo على نظامك

   root@kitploit:~

   brew install hugo
   

2. استنسخ المستودع

   root@kitploit:~

   git clone --recurse-submodules https://github.com/trailofbits/testing-handbook.git
   

3. أنشئ فرعًا جديدًا أو اختر فرعًا تريد العمل عليه

   root@kitploit:~

   cd testing-handbook
   # then
   git checkout -b name-of-your-new-branch
   # or
   git checkout name-of-existing-branch
   

4. شغّل خادم Hugo مع تفعيل المسودات (-D) من الدليل الجذر للمشروع. سيتم تحديث متصفحك تلقائيًا مع أي تغيير تحفظه في ملف.

   root@kitploit:~

   hugo server -D
   

5. أضف أداة جديدة كـ "doc"، وشغّل ما يلي من الدليل الجذر للمشروع.

   root@kitploit:~

   hugo new docs/<name of tool>
   

   ملاحظة: يستخدم هذا المشروع قالب Hugo نفسه المستخدم في zkdocs. يشير القالب إلى كل صفحة جديدة باسم "doc"، وليس منشور (post). لهذا السبب ستحتاج إلى كتابة hugo new docs/<name of tool> وليس post/my-new-post.

6. عدّل وأضف وأنشئ طلبات سحب لدمج تغييراتك في main.

الإرشادات

• يجب أن يكون التنسيق متسقًا بين كل "مستند" (doc). عند إضافة مستند جديد (أي عند إضافة أداة جديدة)، اتبع القالب الموجود في content/docs/template.md. أرسل طلب سحب (PR) لهذا الملف مع التغييرات المقترحة حسب الحاجة.

• أنشئ فرعًا جديدًا بتغييراتك، وأنشئ طلب سحب لدمجه في main عندما تنتهي.

• يتحقق سير عمل GitHub في هذا المستودع من صحة ملفات Markdown عبر ثلاثة فحوصات:

  1. فحص روابط Markdown: تستخرج هذه الخطوة الروابط من ملفات Markdown وتتحقق من صحتها وإمكانية الوصول إليها. وتستخدم إجراء lychee لفحص الروابط.
  2. مدقق Markdown اللغوي: تضمن هذه الخطوة التزام ملفات Markdown بالنمط وقواعد التنسيق المطلوبة. وتستخدم ملف إعداد مخصص (.github/workflows/.markdownlint.jsonc) وإجراء markdownlint-cli2-action. استخدم إضافة markdownlint مع Visual Studio Code لتجربة استخدام أفضل أثناء العمل على دليل الاختبارات.
  3. التدقيق الإملائي: تتحقق هذه الخطوة من الإملاء في ملفات Markdown (مبنية على retext وremark). وتستخدم إجراء tbroadley/spellchecker-cli-action.

• تعرّف على قالب Hugo Book لأنه يوفر بعض الميزات الرائعة (أزرار، وغيرها).

• تواصل معنا في قناة #testing-handbook على Slack الخاصة بمجتمع Empire Hacking إذا كانت لديك أي أسئلة.

التحرير

إرشادات الكتابة

• يجب كتابة مصطلح "Testing Handbook" بأحرف كبيرة كلما ظهر على الموقع (سواء في عنوان رئيسي أو فرعي أو في النص الجاري)، لأنه عنوان مستند. ولكن إذا أردت تجنب الكتابة بالأحرف الكبيرة لأنها تبدو غريبة، يمكنك استبدال "Testing Handbook" بعبارة "this handbook" (لأن عنوان الدليل واضح بما فيه الكفاية).

سير العمل: من مستندات Google

يمكنك تصدير المستند من مستندات Google بصيغة Markdown. افتح المستند في مستندات Google. انقر فوق File > Download، ثم اختر Markdown (.md).

بيئات مخصصة

{{< customFigure "Caption" >}}
{{< /customFigure >}}

{{< resourceFigure "cov1.png" >}}
{{< /resourceFigure >}}

{{< hint info >}}
{{< /hint >}}