Skip to content

chore: Update security guidelines - #4468

Open
DrewBloechl wants to merge 1 commit into
NVIDIA:mainfrom
DrewBloechl:drew/update-security-guidelines
Open

chore: Update security guidelines#4468
DrewBloechl wants to merge 1 commit into
NVIDIA:mainfrom
DrewBloechl:drew/update-security-guidelines

Conversation

@DrewBloechl

Copy link
Copy Markdown
Contributor

This updates the project security guidelines using the internal generate-security-md skill via Codex.

Changes:

  • Replace the top-level SECURITY.md with a more specific/verbose version generated by the skill.
  • Replace the rest-api/SECURITY.md doc to reference the one in the repo root.
  • Add a .security-triage.yaml document (with myself filled in as the confirmation for the classifications).

Related issues

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes

Testing

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No testing required (docs, internal refactor, etc.)

@DrewBloechl
DrewBloechl requested a review from a team as a code owner July 31, 2026 22:49
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Summary by CodeRabbit

  • Documentation
    • Expanded security guidance with vulnerability reporting channels, supported versions, scope, security controls, threat scenarios, deployment assumptions, and hardening recommendations.
    • Added REST API-specific security guidance, including covered security surfaces and instructions for responsible vulnerability reporting.
  • Security
    • Added repository and service exposure classifications with supporting evidence and confirmation details.
    • Documented handling for false positives, accepted risks, and suppressed vulnerabilities.

Walkthrough

The change adds security triage metadata and replaces generic security guidance with NICo-specific repository and REST API policies.

Changes

Security governance

Layer / File(s) Summary
Security triage classification
.security-triage.yaml
Adds repository and service exposure classifications, supporting evidence, confirmation metadata, update metadata, and empty exception lists.
Canonical NICo security policy
SECURITY.md
Documents reporting procedures, architecture, trust boundaries, security controls, threats, deployment assumptions, hardening requirements, supported updates, scope, and dependency security.
REST API security policy
rest-api/SECURITY.md
Defines REST API security surfaces, references the repository policy, and directs vulnerability reports to NVIDIA PSIRT without public disclosure details.

Estimated code review effort: 2 (Simple) | ~15 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the primary change: updating the project's security guidelines.
Description check ✅ Passed The description accurately explains the security documentation updates and the addition of the triage configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@chet chet added the rest-api Add this label when an issue or PR concerns NICo REST API label Jul 31, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
SECURITY.md (2)

252-259: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick win

Make supported security channels operator-verifiable.

This section tells operators to use maintained branches, tagged images, or designated commits. It does not identify the maintained branches or tags, support dates, or the method to verify that a commit is designated. Add a canonical support matrix or release-policy reference.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@SECURITY.md` around lines 252 - 259, Update the “Supported Versions and
Security Updates” section in SECURITY.md to reference a canonical support matrix
or release-policy document that identifies maintained branches, supported tags,
support dates, and how operators can verify maintainer- or NVIDIA
PSIRT-designated commits.

56-69: 🗄️ Data Integrity & Integration | 🔵 Trivial | ⚡ Quick win

Make .security-triage.yaml the canonical source. The classification values match SECURITY.md, but the basis text is duplicated and no validation prevents drift. Generate the classification section or add a CI consistency check.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@SECURITY.md` around lines 56 - 69, Make .security-triage.yaml the canonical
source for repository and service exposure classifications, then add CI
validation that compares the corresponding SECURITY.md classification section
against the canonical values and basis text. Update the documentation workflow
or generation step to prevent manual drift, using the existing classification
symbols and section as the synchronization target.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@SECURITY.md`:
- Around line 13-18: Update the vulnerability-reporting guidance in SECURITY.md
to match the repository’s actual configuration: enable GitHub private
vulnerability reporting before retaining the Security tab route, or remove that
route if it will remain disabled. Keep the NVIDIA disclosure and email options
unchanged.

---

Nitpick comments:
In `@SECURITY.md`:
- Around line 252-259: Update the “Supported Versions and Security Updates”
section in SECURITY.md to reference a canonical support matrix or release-policy
document that identifies maintained branches, supported tags, support dates, and
how operators can verify maintainer- or NVIDIA PSIRT-designated commits.
- Around line 56-69: Make .security-triage.yaml the canonical source for
repository and service exposure classifications, then add CI validation that
compares the corresponding SECURITY.md classification section against the
canonical values and basis text. Update the documentation workflow or generation
step to prevent manual drift, using the existing classification symbols and
section as the synchronization target.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 6934524e-11cf-415e-80a1-f5efb104a4c5

📥 Commits

Reviewing files that changed from the base of the PR and between 00e989f and da70da4.

📒 Files selected for processing (3)
  • .security-triage.yaml
  • SECURITY.md
  • rest-api/SECURITY.md

Comment thread SECURITY.md
Comment on lines +13 to +18
- Report via the [NVIDIA Vulnerability Disclosure Program](https://www.nvidia.com/en-us/security/) (preferred).
- E-Mail: [psirt@nvidia.com](mailto:psirt@nvidia.com)
- We encourage you to use the following PGP key for secure email communication:
[NVIDIA public PGP Key](https://www.nvidia.com/en-us/security/pgp-key)
- GitHub: Use the **Security** tab > **Report a vulnerability** to submit a
private report directly on this repository.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔒 Security & Privacy | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/sh
set -eu

for url in \
  "https://www.nvidia.com/en-us/security/" \
  "https://www.nvidia.com/en-us/security/pgp-key" \
  "https://www.nvidia.com/en-us/security/psirt-policies/" \
  "https://github.com/NVIDIA/infra-controller/security/advisories/new"
do
  curl -fsSIL --location --max-time 15 "$url" >/dev/null
done

gh api repos/NVIDIA/infra-controller --jq '.security_and_analysis // {}'

Repository: NVIDIA/infra-controller

Length of output: 164


🏁 Script executed:

set +e
for endpoint in \
  "repos/NVIDIA/infra-controller/private-vulnerability-reporting" \
  "repos/NVIDIA/infra-controller/security-and-analysis" \
  "repos/NVIDIA/infra-controller"
do
  echo "=== $endpoint ==="
  gh api "$endpoint" --include 2>&1 | sed -n '1,80p'
  echo "status=${PIPESTATUS[0]}"
done

Repository: NVIDIA/infra-controller

Length of output: 10713


Enable private vulnerability reporting before publishing.

NVIDIA/infra-controller reports {"enabled":false}, so the GitHub Security tab does not provide the private reporting route described here. Enable it or remove this route from SECURITY.md.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@SECURITY.md` around lines 13 - 18, Update the vulnerability-reporting
guidance in SECURITY.md to match the repository’s actual configuration: enable
GitHub private vulnerability reporting before retaining the Security tab route,
or remove that route if it will remain disabled. Keep the NVIDIA disclosure and
email options unchanged.

Source: Path instructions

@github-actions

Copy link
Copy Markdown

🔐 TruffleHog Secret Scan

No secrets or credentials found!

Your code has been scanned for 700+ types of secrets and credentials. All clear! 🎉

🔗 View scan details

🕐 Last updated: 2026-07-31 22:54:59 UTC | Commit: da70da4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rest-api Add this label when an issue or PR concerns NICo REST API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants