diff --git a/.github/codeql/README.md b/.github/codeql/README.md new file mode 100644 index 000000000..f0ef0bd07 --- /dev/null +++ b/.github/codeql/README.md @@ -0,0 +1,9 @@ +# Security analysis + +The CodeQL workflow runs the `security-extended` query suite for the SDK language and GitHub Actions on pull requests, pushes, merge queues and a weekly schedule. It can also be started manually. + +The SDK scan traces a clean Maven reactor build with the `with-auth-api` profile, which includes the authentication API, and test compilation disabled. + +Results are published to **Security and quality → Code scanning**, with a separate category for each language. Review initial findings and record a reason for every dismissed alert. + +After merging, require both **CodeQL (java-kotlin)** and **CodeQL (actions)** job checks for supported branches. Also enable **Require code scanning results → CodeQL → Security alerts: High or higher** in the branch ruleset. Successful workflow execution alone does not enforce this threshold. Track the latest analysis commit/date, extraction errors and open findings by security severity. diff --git a/.github/codeql/actions.yml b/.github/codeql/actions.yml new file mode 100644 index 000000000..57959b9da --- /dev/null +++ b/.github/codeql/actions.yml @@ -0,0 +1,4 @@ +name: GitHub Actions security baseline + +queries: + - uses: security-extended diff --git a/.github/codeql/sdk.yml b/.github/codeql/sdk.yml new file mode 100644 index 000000000..61d31213b --- /dev/null +++ b/.github/codeql/sdk.yml @@ -0,0 +1,4 @@ +name: SDK security baseline + +queries: + - uses: security-extended diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 000000000..bdd590097 --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,65 @@ +name: CodeQL + +on: + push: + branches: ["master", "develop", "release*"] + pull_request: + branches: ["master", "develop", "release*"] + merge_group: + schedule: + - cron: '23 3 * * 1' + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: codeql-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + +jobs: + analyze: + name: CodeQL (${{ matrix.language }}) + runs-on: ubuntu-24.04 + timeout-minutes: 45 + permissions: + contents: read + security-events: write + strategy: + fail-fast: false + matrix: + include: + - language: java-kotlin + build-mode: manual + config: .github/codeql/sdk.yml + - language: actions + build-mode: none + config: .github/codeql/actions.yml + steps: + - name: Checkout + uses: actions/checkout@v6 + + - name: Set up Java + if: matrix.language == 'java-kotlin' + uses: actions/setup-java@v5 + with: + distribution: temurin + java-version: '17' + cache: maven + + - name: Initialize CodeQL + uses: github/codeql-action/init@v4 + with: + languages: ${{ matrix.language }} + build-mode: ${{ matrix.build-mode }} + config-file: ${{ matrix.config }} + + - name: Build Java SDK and authentication API + if: matrix.language == 'java-kotlin' + run: | + mvn --batch-mode --no-transfer-progress -Pwith-auth-api -Dmaven.test.skip=true clean package + + - name: Analyze and upload results + uses: github/codeql-action/analyze@v4 + with: + category: /language:${{ matrix.language }}