-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
chore: add SECURITY.md #7724
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
Merged
+47
−0
Merged
chore: add SECURITY.md #7724
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
c5de7e3
chore: add SECURITY.md
martinjagodic 4e2dfae
Update SECURITY.md
martinjagodic fdcd656
Apply suggestions from code review
martinjagodic 5527b9b
fix: switch to GitHub Security Advisories for reporting
martinjagodic 0074e97
Merge branch 'main' into security_md
martinjagodic File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| # Security Policy | ||
|
|
||
| Decap CMS takes security seriously. This document outlines our security policy, supported versions, and how to report security vulnerabilities. | ||
|
|
||
| ## Supported Versions | ||
|
|
||
| Security updates are provided for: | ||
|
|
||
| | Version | Status | Lifecycle | | ||
| |---------|--------|-----------| | ||
| | 3.x | ✅ Actively Supported | Current stable release | | ||
| | 2.x (Netlify CMS) | ❌ Unsupported | Legacy - no updates | | ||
| | 1.x (Netlify CMS) | ❌ Unsupported | Legacy - no updates | | ||
|
|
||
| **Note:** Decap CMS was renamed from Netlify CMS in February 2023. Versions 1.x and 2.x are no longer maintained. We recommend upgrading to version 3.x for security updates and new features. | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| If you discover a security vulnerability in Decap CMS, please report it **confidentially** through our dedicated reporting process. | ||
|
|
||
| **Submit your report at:** https://decapcms.org/report-vulnerability | ||
|
|
||
| Please include the following information: | ||
|
|
||
| - **Vulnerability Title**: Brief summary of the issue | ||
| - **Description**: Detailed explanation of the vulnerability | ||
| - **Affected Version(s)**: Which version(s) of Decap CMS are affected | ||
| - **Steps to Reproduce**: Clear steps to demonstrate the vulnerability (if applicable) | ||
| - **Impact Assessment**: Potential impact on users (e.g., data exposure, unauthorized access, content integrity) | ||
| - **Your Name**: For attribution and follow-up communication | ||
| - **Your Email**: Primary contact method | ||
| - **Publish Credit**: Would you like to be credited publicly when this is disclosed? | ||
|
|
||
| ### What NOT to Do | ||
|
|
||
| - Do not open a public GitHub issue for the vulnerability | ||
| - Do not post details on social media or public forums | ||
| - Do not attempt to exploit the vulnerability beyond confirming it exists | ||
| - Do not access data beyond what's necessary to demonstrate the issue | ||
|
|
||
| ## Response Timeline | ||
|
|
||
| This project follows a 90-day disclosure timeline. | ||
|
|
||
| ## Coordinated Disclosure | ||
|
|
||
| We follow responsible disclosure practices: | ||
|
|
||
| 1. You submit a vulnerability report via our form | ||
| 2. Our security team acknowledges receipt | ||
| 3. We investigate and determine severity and scope | ||
martinjagodic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 4. We develop a fix and prepare a security release | ||
| 5. We notify you of resolution and next steps | ||
martinjagodic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 6. We release the security update to users | ||
| 7. We publish a security advisory (with your attribution, if approved) | ||
|
|
||
| ## Security Practices | ||
|
|
||
|
|
||
| - Dependabot is enabled for automated security update checks | ||
| - All code changes are tested in CI including linting | ||
martinjagodic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - End-to-end tests provide coverage of critical functionality | ||
| - All pull requests require code review before merging | ||
| - Passwords are not stored by Decap CMS; authentication is delegated to providers | ||
|
|
||
| ## Known Limitations | ||
|
|
||
| - This is a **community-maintained open-source project**, not a commercial product with dedicated security resources | ||
| - Security depends on the stability and practices of underlying dependencies and backend providers | ||
| - Some vulnerabilities in dependencies may not be immediately patchable if they break backwards compatibility | ||
| - This is a project with a long history and many legacy dependencies can't be updated without significant refactoring | ||
martinjagodic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This link doesn't work for me.nevermind, just saw it is open in a decap-website PRI think we should allow multiple reporting sources, the form will not always be available, and we want to make it as convenient as possible so that the more security issues are reported. For example, I think we can enable GitHub's security advisory and add an security email like
security@decapcms.org.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's go with GitHub Security Advisories only for now. I updated the document.