codeql-sdk/.github/workflows/codeql-audit.yml at main · BunsDev/codeql-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
name: clawhub.ai CodeQL Security Audit

on:
  push:
    branches: [main, master]
  pull_request:
    branches: [main, master]
  schedule:
    # Run daily at 02:00 UTC
    - cron: '0 2 * * *'
  workflow_dispatch:
    inputs:
      skill_path:
        description: 'Path to skill directory to audit (relative to repo root)'
        required: false
        default: 'examples/vulnerable-skill'

permissions:
  contents: read
  security-events: write  # Required to upload SARIF results to GitHub Security tab
  actions: read

jobs:
  # -------------------------------------------------------------------------
  # Job 1: Build and test the TypeScript SDK
  # -------------------------------------------------------------------------
  sdk-build-test:
    name: Build & Test SDK
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Build TypeScript
        run: npm run build

      - name: Run tests
        run: npm test -- --coverage

      - name: Upload coverage
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: coverage-report
          path: coverage/

  # -------------------------------------------------------------------------
  # Job 2: CodeQL audit of the example vulnerable skill
  # -------------------------------------------------------------------------
  codeql-audit:
    name: CodeQL Security Audit
    runs-on: ubuntu-latest
    needs: sdk-build-test

    strategy:
      fail-fast: false
      matrix:
        skill:
          - path: examples/vulnerable-skill
            name: vulnerable-skill
          - path: examples/secure-skill
            name: secure-skill

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Build TypeScript
        run: npm run build

      - name: Set up CodeQL CLI
        id: setup-codeql
        uses: github/codeql-action/setup-codeql@v3

      - name: Install CodeQL pack dependencies
        run: '"${CODEQL_PATH}" pack install'
        env:
          CODEQL_PATH: ${{ steps.setup-codeql.outputs.codeql-path }}

      - name: Run SDK audit
        run: |
          mkdir -p results
          node dist/cli.js audit "${{ matrix.skill.path }}" \
            --format sarif \
            --output "results/${{ matrix.skill.name }}.sarif" \
            --min-severity note
        env:
          CODEQL_PATH: ${{ steps.setup-codeql.outputs.codeql-path }}

      - name: Upload SARIF to GitHub Security tab
        uses: github/codeql-action/upload-sarif@v3
        if: github.event_name != 'pull_request'
        with:
          sarif_file: results/${{ matrix.skill.name }}.sarif
          category: "clawhub-security/${{ matrix.skill.name }}"

      - name: Upload SARIF artifact
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: sarif-${{ matrix.skill.name }}
          path: results/${{ matrix.skill.name }}.sarif

  # -------------------------------------------------------------------------
  # Job 3: Lint the CodeQL queries
  # -------------------------------------------------------------------------
  codeql-lint:
    name: Lint CodeQL Queries
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up CodeQL CLI
        id: setup-codeql
        uses: github/codeql-action/setup-codeql@v3

      - name: Install CodeQL pack dependencies
        run: '"${CODEQL_PATH}" pack install'
        env:
          CODEQL_PATH: ${{ steps.setup-codeql.outputs.codeql-path }}

      - name: Lint CodeQL queries
        run: |
          "${CODEQL_PATH}" query compile \
            --check-only \
            --search-path=. \
            -- \
            queries/skills/
        env:
          CODEQL_PATH: ${{ steps.setup-codeql.outputs.codeql-path }}

  # -------------------------------------------------------------------------
  # Job 4: Dependency audit
  # -------------------------------------------------------------------------
  dependency-audit:
    name: Dependency Security Audit
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Run npm audit
        run: npm audit --audit-level=high