Skip to content

SECURITY.md

Latest commit

 

History

History
123 lines (88 loc) · 4.77 KB

SECURITY.md

File metadata and controls

123 lines (88 loc) · 4.77 KB

Security Policy

Supported versions

OpenAURA is pre-1.0. Only the latest minor release receives security patches.

Version Supported
0.1.x ✅
older ❌

Reporting a vulnerability

Do not open a public GitHub issue for security problems. Instead, use:

GitHub Security Advisory (preferred, and currently the only channel): Report a vulnerability

A dedicated disclosure email will be published here once the openaura.org domain is live. Until then, please use the Security Advisory link above — it's private by default and gives both parties an audit trail.

Please include:

  • A description of the issue and the impact you expect.
  • Steps to reproduce, or a proof-of-concept if available.
  • The version / commit SHA you tested.
  • Your disclosure preferences (coordinated vs. immediate).

Response SLA

Stage Target
Initial acknowledgement within 3 business days
Triage / severity assessment within 7 business days
Fix released for critical / high within 30 days of triage
Fix released for medium / low within 90 days

We publish a GitHub Security Advisory once a fix ships, crediting the reporter unless anonymity is requested.

Scope

In scope

  • Code in this repository (the openaura Python package and shipped CI templates).
  • Default configurations and documented use patterns.
  • Supply-chain concerns (tampering with releases, build provenance).

Out of scope

  • Vulnerabilities in upstream dependencies — please report those to the upstream project.
  • Findings requiring a compromised local machine, physical access, or exfiltrated secrets.
  • Denial-of-service against a user's own CI minutes budget via misconfigured schedules.

Secrets handling expectations

OpenAURA runs in CI and reads signals from external APIs. It:

  • Accepts secrets only from environment variables (never from config files).
  • Never logs secret values; tokens are redacted in error messages.
  • Refuses to send SMTP credentials over plaintext unless AURA_ALLOW_INSECURE_SMTP=1.
  • Requires https:// base URLs on all connector calls.

If you find a path where a secret leaks to logs, output briefs, or any third party, that is always in scope and qualifies for a security advisory regardless of severity.

Agentic development security expectations

Open AURA allows AI-assisted and agentic development, but generated changes are never accepted on trust alone. A human contributor and human reviewer must review agentic changes for security and licensing impact before merge.

For agentic changes, reviewers should pay special attention to:

  • secret handling, logging, and redaction paths
  • connector authentication and external API calls
  • CI/CD, release, provenance, and signing workflows
  • new or changed dependencies, including license compatibility
  • file I/O, shell execution, network access, and generated templates

AI agents must not certify the DCO or make license assertions on behalf of a human contributor. The human submitter remains responsible for reviewing generated code, ensuring Apache-2.0 compatibility, and documenting any relevant attribution or notices.

Hardening this project ships with

  • CodeQL scans on every push and PR.
  • OpenSSF Scorecard runs weekly.
  • Dependabot proposes dependency updates daily.
  • Third-party GitHub Actions pinned to full commit SHAs.
  • PyPI releases via Trusted Publishing (OIDC) with SLSA build provenance attestations.
  • Sigstore signatures on release artifacts.

Security automation

This repository keeps security automation under .github/:

  • .github/workflows/codeql.yml runs CodeQL on pushes to main, pull requests to main, Mondays at 06:37 UTC, and manual dispatch.
  • .github/workflows/scorecard.yml runs OpenSSF Scorecard on pushes to main, Tuesdays at 04:15 UTC, and manual dispatch.
  • .github/workflows/ci.yml runs linting, type checks, Bandit, tests, coverage, dependency audit, package build, twine check, and install smoke testing.
  • .github/workflows/release.yml publishes tagged releases to PyPI via Trusted Publishing, generates build provenance attestations, signs artifacts with Sigstore, and creates GitHub Releases.
  • .github/release.yml configures GitHub's automatically generated release notes.
  • .github/dependabot.yml proposes dependency and GitHub Actions updates.

To run either security review on demand:

  1. Open the repository on GitHub.
  2. Go to Actions.
  3. Select CodeQL or OpenSSF Scorecard.
  4. Click Run workflow on main.

You can also trigger them from the GitHub CLI:

gh workflow run CodeQL --ref main
gh workflow run "OpenSSF Scorecard" --ref main