security: harden CI and add CodeQL automation

[mkarson1997]

Adds CodeQL security-extended analysis for C#, weekly Dependabot coverage for NuGet, GitHub Actions and Docker, scopes CI permissions to the build job, and replaces the hardcoded Compose validation password with a masked ephemeral value.

Summary by Sourcery

Harden continuous integration with automated security analysis, dependency updates, least-privilege permissions, and safer Compose validation credentials.

New Features:

• Add scheduled CodeQL security-extended analysis for C# on pushes, pull requests, and a weekly schedule.
• Enable weekly Dependabot updates for NuGet packages, GitHub Actions, and Docker images.

Bug Fixes:

• Replace the hardcoded Compose validation password with a masked ephemeral password generated during CI.

Enhancements:

• Scope CI read permissions to the build job and grant CodeQL only the permissions required for analysis.

CI:

• Add automated CodeQL security scanning to the CI workflows.
• Harden CI credential handling and workflow permissions.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[sourcery-ai]

Reviewer's Guide

Hardens CI configuration by minimizing build-job permissions and replacing the hardcoded Compose password with a masked ephemeral secret, while adding weekly Dependabot updates and CodeQL security-extended analysis for C# on pushes, pull requests, and a weekly schedule.

Sequence diagram for ephemeral Compose validation secret

sequenceDiagram
    participant CI as CI build job
    participant OpenSSL as openssl
    participant Env as GITHUB_ENV
    participant Compose as Docker Compose

    CI->>OpenSSL: rand -hex 24
    OpenSSL-->>CI: random value
    CI->>CI: add-mask password
    CI->>Env: write MSSQL_SA_PASSWORD
    CI->>Compose: docker compose config --quiet
    Compose-->>CI: validation result

Loading

Flow diagram for CodeQL C# analysis

flowchart LR
    Trigger["Push, pull request, or weekly schedule"] --> Checkout["actions/checkout@v4"]
    Checkout --> Setup["actions/setup-dotnet@v4"]
    Setup --> Init["github/codeql-action/init@v3"]
    Init --> Autobuild["github/codeql-action/autobuild@v3"]
    Autobuild --> Analyze["github/codeql-action/analyze@v3"]
    Analyze --> Results["Security events"]

Loading

File-Level Changes

Change	Details	Files
Adds scheduled dependency update coverage across application, workflow, and container dependencies.	Configures weekly NuGet updates with a limit of five open pull requests. Configures weekly GitHub Actions updates with a limit of five open pull requests. Configures weekly Docker updates with a limit of three open pull requests.	.github/dependabot.yml
Scopes CI workflow permissions to the build job and removes the committed Compose validation secret.	Moves read-only contents permission from workflow scope to the build-and-test job. Generates a random SQL Server password during the run, masks it, and exports it through GITHUB_ENV for Compose validation. Removes the hardcoded MSSQL_SA_PASSWORD environment value from the validation step.	.github/workflows/ci.yml
Introduces automated CodeQL security-extended analysis for the C# codebase.	Runs on main pushes, main pull requests, and a weekly scheduled scan. Grants only contents read and security-events write permissions to the analysis job. Initializes C# CodeQL with security-extended queries, autobuilds the .NET project, and uploads results using CodeQL v3 actions.	.github/workflows/codeql.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Needs a human reviewer. If the workflow or its permissions are wrong, CodeQL may fail to run or could write incorrect security findings, and the CI job may fail during Compose validation. Reverting stops the behavior, while any generated findings or cached workflow results would need to be cleared or rerun.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

[github-advanced-security]

You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool.

What Enabling Code Scanning Means:

• The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
• Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
• You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.