action octoscan

إجراء GitHub يقوم بفحص أمني لإجراءات GitHub الخاصة بك.

يعتمد هذا الإجراء على octoscan

• 🤸 الاستخدام
• التخصيص
  • المدخلات
  • المخرجات
  • الصلاحيات

🤸 الاستخدام

فيما يلي مثال أساسي لاستخدام هذا الإجراء. سيعمل هذا مع أحداث push و pull_request على حد سواء.

---
name: Octoscan

on:
  workflow_dispatch:
  pull_request:
    paths:
      - '.github/workflows/*'
  push:
    paths:
      - '.github/workflows/*'

permissions:
  security-events: write
  actions: read
  contents: read

jobs:
  octoscan:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - id: octoscan
        name: Run octoscan
        uses: synacktiv/action-octoscan@v1

      - name: Upload SARIF file to GitHub
        uses: github/codeql-action/upload-sarif@v3
        with:
          sarif_file: "${{steps.octoscan.outputs.sarif_output}}"
          category: octoscan

يمكن مراجعة النتائج الأمنية في تبويب أمان الكود إذا كان لديك صلاحيات الكتابة على المستودع المستهدف:

أو مباشرة في طلب السحب:

التخصيص

المدخلات

تعتمد المدخلات على خيارات octoscan، يمكنك العثور عليها هنا.

ما يلي اختياري كمفاتيح step.with:

💡 ليس من الممكن استخدام enable_rules و disable_rules في نفس الوقت.

المخرجات

يمكن الوصول إلى المخرجات التالية عبر ${{ steps.<step-id>.outputs }} من هذا الإجراء

الصلاحيات

يتطلب هذا الإجراء الصلاحيات التالية على رمز تكامل GitHub:

permissions:
  security-events: write
  actions: read
  contents: read

يُستخدم security-events لدفع مخرجات octoscan إلى فحص الكود في GitHub.