Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update More Info link of SECURITY.md #22042

Merged
merged 1 commit into from
Oct 2, 2024

Conversation

tianyeyouyou
Copy link
Contributor

@tianyeyouyou tianyeyouyou commented Oct 2, 2024

Description

Since cosmos/security has moved to interchainio/security, some links are not valid now.

The link to Example could be found in the new repo, others couldn't, so I deleted them...

Summary by CodeRabbit

  • Documentation
    • Updated the Coordinated Vulnerability Disclosure Policy for enhanced clarity on reporting security vulnerabilities.
    • Added a warning against opening public issues for security concerns.
    • Specified reporting methods and clarified that reports to [email protected] are not eligible for bounty rewards.
    • Updated the link for EXAMPLES.md to a new resource related to real-world examples.

@tianyeyouyou tianyeyouyou requested a review from a team as a code owner October 2, 2024 08:23
Copy link
Contributor

coderabbitai bot commented Oct 2, 2024

📝 Walkthrough

Walkthrough

The changes in the SECURITY.md document focus on enhancing the Coordinated Vulnerability Disclosure Policy. Key modifications include a warning against public issues for security vulnerabilities, clarification on the scope of security updates, and updates to the reporting methods. The document now specifies that reports sent to [email protected] are ineligible for bounty rewards unless submitted through HackerOne. Additionally, guidelines for researchers have been expanded, and the link to EXAMPLES.md has been updated to point to a new resource.

Changes

File Change Summary
SECURITY.md - Added warning against public issues for security vulnerabilities.
- Clarified scope of security updates for the latest release tag and main branch.
- Updated reporting methods table to specify bounty eligibility.
- Expanded guidelines for researchers on confidentiality.
- Modified link for EXAMPLES.md to a new resource.

Possibly related PRs

Suggested labels

backport/v0.52.x, Type: ADR

Suggested reviewers

  • sontrinh16
  • julienrbrt

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@tianyeyouyou tianyeyouyou changed the title docs: Update More Info link docs: Update More Info link of SECURITY.md Oct 2, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
SECURITY.md (1)

Line range hint 22-34: Clear distinction between reporting methods

The updated table clearly distinguishes between bounty-eligible and non-eligible reporting methods. This is a valuable clarification for potential reporters.

Consider adding a brief explanation of why email reports are not bounty-eligible to provide more context to the readers.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between c85fbae and 1c061f8.

📒 Files selected for processing (1)
  • SECURITY.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
SECURITY.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🔇 Additional comments (4)
SECURITY.md (4)

Line range hint 1-9: Excellent addition of the security warning

The new warning effectively emphasizes the importance of not disclosing security vulnerabilities publicly. This addition enhances the document's clarity and aligns well with best practices for responsible disclosure.


Line range hint 11-20: Clear definition of supported versions

The scope section now clearly defines that security updates are supported for the latest release tag and the main branch. This clarification is valuable for users and contributors.


Line range hint 36-58: Comprehensive guidelines for researchers

The expanded guidelines provide clear and specific instructions for researchers. The emphasis on confidentiality and avoiding disruption to production systems is particularly valuable. These additions will help ensure responsible vulnerability reporting.


60-64: Updated link to examples

The link to EXAMPLES.md has been correctly updated to reflect the new repository location. The new link points to a more specific resource (Classification Matrix with real-world examples), which should provide valuable context for users.

To ensure the new link is correct and accessible, please run the following command:

This command will check if the new URL is accessible. If it returns a status code of 200, the link is valid.

✅ Verification successful

Link Update Verified

The updated link to EXAMPLES.md is accessible and returns a status code of 200.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the accessibility of the new link
curl -I https://github.com/interchainio/security/blob/main/resources/CLASSIFICATION_MATRIX.md

Length of output: 4967

Copy link
Contributor

@mizmo18 mizmo18 left a comment

Choose a reason for hiding this comment

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

Looks good

@tac0turtle tac0turtle added this pull request to the merge queue Oct 2, 2024
Merged via the queue into cosmos:main with commit e2decc6 Oct 2, 2024
72 of 76 checks passed
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.

4 participants