action octoscan

एक GitHub Action जो आपके GitHub actions की सुरक्षा स्कैन करता है।

यह action octoscan पर आधारित है।

• 🤸 Usage
• Customizing
  • inputs
  • outputs
  • Permissions

🤸 Usage

इस action का उपयोग कैसे करें इसका एक बुनियादी उदाहरण यहाँ दिया गया है। यह 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

सुरक्षा परिणामों को कोड सुरक्षा टैब में समीक्षा की जा सकती है यदि आपके पास लक्षित रिपॉजिटरी पर लेखन पहुँच है:

या सीधे पुल रिक्वेस्ट में:

Customizing

inputs

Inputs, octoscan के विकल्पों पर आधारित हैं, आप उन्हें यहाँ पा सकते हैं।

निम्नलिखित step.with कुंजियों के रूप में वैकल्पिक हैं:

💡 एक ही समय में enable_rules और disable_rules का उपयोग करना संभव नहीं है।

outputs

निम्नलिखित आउटपुट को इस action से ${{ steps.<step-id>.outputs }} के माध्यम से एक्सेस किया जा सकता है।

Permissions

इस Action को GitHub इंटीग्रेशन टोकन पर निम्नलिखित अनुमतियों की आवश्यकता होती है:

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

security-events का उपयोग octoscan के आउटपुट को GitHub कोड स्कैनिंग में पुश करने के लिए किया जाता है।