Skip to content

SECURITY.md update to follow CRA template - #2846

Open
dominikkawka wants to merge 2 commits into
containers:mainfrom
dominikkawka:ramalamaCRA
Open

SECURITY.md update to follow CRA template#2846
dominikkawka wants to merge 2 commits into
containers:mainfrom
dominikkawka:ramalamaCRA

Conversation

@dominikkawka

Copy link
Copy Markdown
Collaborator

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Expanded security vulnerability reporting guidance with a structured checklist covering report title, reporter details, technical description, affected versions, reproduction steps, optional impact assessment, optional suggested fix, and disclosure status.
    • Reorganized the guidance by adding dedicated “Response Timeline” and “Contact Information” sections and updating “What to Expect” with acknowledgement and update timing.
    • Added an EU Cyber Resilience Act open-source steward statement with steward contact details and relevant references.

Walkthrough

SECURITY.md replaces its short vulnerability-report template with a structured checklist, adds response timeline and contact guidance, reformats expectations, and appends an EU Cyber Resilience Act open-source steward statement.

Changes

Security Guidance

Layer / File(s) Summary
Reporting and response guidance
SECURITY.md
Defines report fields, adds a 48-hour acknowledgement target and security advisory contact, and formats expectations for acknowledgement, updates, and credit.
CRA stewardship statement
SECURITY.md
Adds Red Hat, Inc. as project steward with a contact address and links to CRA and security-practices references.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: jhjaggars, maxamillion, rhatdan, mikebonnet, cgruver

Poem

A rabbit updates the guide,
With report fields tucked inside.
Timelines hop in, contacts too,
Steward notes join the crew.
Safer paths now neatly run.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: updating SECURITY.md to follow the CRA template.
Description check ✅ Passed The description links to CRA template and stewardship guideline sources relevant to the SECURITY.md update.
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

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the SECURITY.md file to expand on the required details for reporting vulnerabilities, add a response timeline, clarify supported versions, and include an EU Cyber Resilience Act steward statement. Feedback was provided regarding a contradiction between the newly added response timeline (1 week) and the existing expectation section (48 hours) for acknowledging reports, suggesting they be aligned.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread SECURITY.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 4

🤖 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 47-52: Update the EU Cyber Resilience Act statement to use the
hyphenated legal term “open-source software steward” in the steward description,
leaving the surrounding attribution and links unchanged.
- Around line 25-39: Make the acknowledgement SLA consistent between “Response
Timeline” and “What to Expect” in SECURITY.md: either use the same timeframe in
both sections or clarify that the 48-hour commitment covers receipt
acknowledgement while the one-week commitment covers a later assessment or
triage update.
- Around line 29-33: Update the Contact Information section in SECURITY.md to
explicitly document how security incidents should be reported, stating whether
they use the existing security advisory page or a separate
steward/infrastructure escalation route. Keep the vulnerability-reporting
guidance intact and make the incident path unambiguous.
- Around line 43-45: Update the Supported Versions section in SECURITY.md to
link directly to the project’s support matrix or lifecycle policy, ensuring
readers can find supported release lines, EOL dates, and documented backport
exceptions while preserving the existing security-support wording.
🪄 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: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 108cd965-1c5b-4dc6-8174-18b5658ce491

📥 Commits

Reviewing files that changed from the base of the PR and between e8e1f0f and 61ae498.

📒 Files selected for processing (1)
  • SECURITY.md

Comment thread SECURITY.md
Comment thread SECURITY.md
Comment thread SECURITY.md Outdated
Comment on lines +43 to +45
### Supported Versions

We regularly perform patch releases for the supported [latest version](https://github.com/containers/ramalama/releases), which contains fixes for relevant security vulnerabilities and important bugs. Prior releases might receive critical security fixes on a best-effort basis. However, we cannot guarantee that security fixes will get back-ported to these unsupported versions, unless stated otherwise.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔒 Security & Privacy | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== SECURITY.md excerpt ==\n'
nl -ba SECURITY.md | sed -n '1,120p'

printf '\n== Search for support matrix / lifecycle references ==\n'
rg -n --hidden --no-ignore-vcs -S "support matrix|lifecycle|EOL|end[- ]of[- ]life|supported versions|backport|security fixes|security policy" .

Repository: containers/ramalama

Length of output: 224


🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== SECURITY.md excerpt ==\n'
awk 'NR>=1 && NR<=120 {printf "%4d  %s\n", NR, $0}' SECURITY.md

printf '\n== Search for support matrix / lifecycle references ==\n'
rg -n --hidden --no-ignore-vcs -S "support matrix|lifecycle|EOL|end[- ]of[- ]life|supported versions|backport|security fixes|security policy|support period" .

Repository: containers/ramalama

Length of output: 50376


🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '== SECURITY.md lines 35-55 ==\n'
awk 'NR>=35 && NR<=55 {printf "%4d  %s\n", NR, $0}' SECURITY.md

printf '\n== Support/lifecycle references in docs and top-level policy files ==\n'
rg -n --hidden --no-ignore-vcs -S \
  "support matrix|lifecycle|EOL|end[- ]of[- ]life|supported versions|backport|security fixes|support period|release lines|maintenance" \
  SECURITY.md README* docs/ .github/ . 2>/dev/null | head -n 200

Repository: containers/ramalama

Length of output: 50376


Link the support matrix or lifecycle policy here. The current text only points to the latest release and a general security policy; it still doesn’t identify supported release lines, EOL dates, or where backport exceptions are tracked.

🤖 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 43 - 45, Update the Supported Versions section in
SECURITY.md to link directly to the project’s support matrix or lifecycle
policy, ensuring readers can find supported release lines, EOL dates, and
documented backport exceptions while preserving the existing security-support
wording.

Comment thread SECURITY.md
Comment on lines +47 to +52
## EU Cyber Resilience Act — Open Source Steward Statement

This project is stewarded by **Red Hat, Inc.**, an open source software steward as defined in Article 3(14) of the [EU Cyber Resilience Act (Regulation 2024/2847)](https://eur-lex.europa.eu/eli/reg/2024/2847/oj/eng).
Contact: [cra-steward@redhat.com](mailto:cra-steward@redhat.com)

Refer to [Red Hat's security practices and vulnerability management policy](https://access.redhat.com/security/) for detailed information. No newline at end of file

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Use the CRA’s hyphenated legal term.

Change “open source software steward” to “open-source software steward” on Line [49] to match the terminology defined in Article 3(14). (eur-lex.europa.eu)

🧰 Tools
🪛 LanguageTool

[grammar] ~49-~49: Use a hyphen to join words.
Context: ... stewarded by Red Hat, Inc., an open source software steward as defined in Ar...

(QB_NEW_EN_HYPHEN)

🤖 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 47 - 52, Update the EU Cyber Resilience Act
statement to use the hyphenated legal term “open-source software steward” in the
steward description, leaving the surrounding attribution and links unchanged.

Source: Linters/SAST tools

Comment thread SECURITY.md Outdated

Thank you for helping keep RamaLama and its users secure!

### Supported Versions

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Does this apply? We currently just have a rolling latest version, no supported versions to backport to.

Signed-off-by: dominikkawka <dominikkawka2002@gmail.com>

Update SECURITY.md

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Dominik Kawka  <31955648+dominikkawka@users.noreply.github.com>
Signed-off-by: dominikkawka <dominikkawka2002@gmail.com>

updates to SECURITY.md

Signed-off-by: dominikkawka <dominikkawka2002@gmail.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 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`:
- Line 15: Update the “Reporter Details” section in SECURITY.md to mark the
reporter’s identity and affiliation as optional, and explicitly state that
security reports may be submitted anonymously. Apply the same clarification to
the corresponding reporter-details text at the referenced later section.
- Around line 12-13: Update the vulnerability-reporting instructions in
SECURITY.md and the corresponding section of CONTRIBUTING.md to use one
identical authoritative reporting route, preferably the process defined in
containers/common/SECURITY.md. Replace the conflicting GitHub Security Advisory
link and ensure both documents consistently direct reporters through the
selected process.
🪄 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: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 4530ccfc-44dc-4065-a20a-17ca96d13c2a

📥 Commits

Reviewing files that changed from the base of the PR and between e439df3 and 36a7a58.

📒 Files selected for processing (1)
  • SECURITY.md

Comment thread SECURITY.md
Comment on lines 12 to 13
1. Go to [our security advisory page](https://github.com/containers/ramalama/security/advisories/new) to privately report the vulnerability.
2. Provide detailed information about the vulnerability, including:

@coderabbitai coderabbitai Bot Jul 16, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔒 Security & Privacy | 🟠 Major | ⚡ Quick win

Align the reporting route with CONTRIBUTING.md.

CONTRIBUTING.md tells reporters to use the process in containers/common/SECURITY.md, while these lines direct them to RamaLama’s GitHub Security Advisory page. Choose one authoritative route and update both documents consistently; otherwise reports may be misdirected or delayed.

Also applies to: 33-34

🤖 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 12 - 13, Update the vulnerability-reporting
instructions in SECURITY.md and the corresponding section of CONTRIBUTING.md to
use one identical authoritative reporting route, preferably the process defined
in containers/common/SECURITY.md. Replace the conflicting GitHub Security
Advisory link and ensure both documents consistently direct reporters through
the selected process.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@dominikkawka looks valid?

@dominikkawka dominikkawka Jul 30, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

+1, Shall I update the CONTRIBUTING.md to include the GitHub advisory page

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants