Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Improve security documentation (#13580)

Damian Legawieca14d5b46b638
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
new file mode 100644
index 0000000000..cc19f8c480
--- /dev/null
+++ b/.github/SECURITY.md
@@ -0,0 +1,52 @@
+# Security Policy
+
+## Supported Versions
+
+The following versions are actively maintained and receive security patches.
+
+| Version | Release date | End of life |
+| ------- | ------------ | ----------- |
+| 5.0 | 26.03.2025 | 26.03.2028 |
+| 4.10 | 06.09.2024 | 06.09.2027 |
+
+Versions that are not listed above will not receive any security patches or fixes.
+
+## Reporting a Vulnerability
+
+**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
+
+Instead, please send an email to [[email protected]](mailto:[email protected]).
+
+Please include as much of the following information as possible to help us triage your report:
+
+- Type of vulnerability (e.g. SQL injection, XSS, CSRF, etc.)
+- Affected version(s)
+- Step-by-step instructions to reproduce the issue
+- Proof of concept or exploit code (if available)
+- Impact assessment of the vulnerability
+
+### Submitting a Patch
+
+If you would like to provide a patch yourself for the security issue **do not open a pull request for it**. Instead, create a commit on your fork of Spree and run this command:
+
+```bash
+git format-patch HEAD~1..HEAD --stdout > patch.txt
+```
+
+Email a description of the patch along with the `patch.txt` file to [[email protected]](mailto:[email protected]).
+
+### Disclosure Process
+
+1. Security report is received and acknowledged within **48 hours**.
+2. The issue is confirmed and a severity level is assigned.
+3. A fix is developed and tested against all supported versions.
+4. A new release is published with the fix and a [GitHub Security Advisory](https://github.com/spree/spree/security/advisories) is created.
+5. Reporter is credited in the advisory (unless anonymity is requested).
+
+## Security Advisories
+
+Published security advisories can be found at [GitHub Security Advisories](https://github.com/spree/spree/security/advisories).
+
+## More Information
+
+For detailed security documentation including best practices and enterprise security features, see the [Spree Security Documentation](https://spreecommerce.org/docs/developer/security/security_policy).
diff --git a/SECURITY.md b/SECURITY.md
index 9c5ae28c68..d76ffa15d0 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -1 +1 @@
-Please see [Spree Guides Security section](https://spreecommerce.org/docs/developer/security/security_policy).
+Please see [.github/SECURITY.md](.github/SECURITY.md) or the [Spree Security Documentation](https://spreecommerce.org/docs/developer/security/security_policy).
diff --git a/docs/developer/security/security_policy.mdx b/docs/developer/security/security_policy.mdx
index bdf8018692..53addbf384 100644
--- a/docs/developer/security/security_policy.mdx
+++ b/docs/developer/security/security_policy.mdx
@@ -1,23 +1,40 @@
+---
+title: "Security Policy"
+description: "How to report vulnerabilities, supported versions, and Spree's security practices."
+---
+
## Overview
-Proper application design, intelligent programming, and secure infrastructure are all essential in creating a secure e-commerce store using any software (Spree included). The Spree team has done its best to provide you with the tools to create a secure and profitable web presence, but it is up to you to take these tools and put them in good practice. We highly recommend reading and understanding the [Rails Security Guide](http://guides.rubyonrails.org/security.html).
+Proper application design, intelligent programming, and secure infrastructure are all essential in creating a secure e-commerce store using any software (Spree included). The Spree team has done its best to provide you with the tools to create a secure and profitable web presence, but it is up to you to take these tools and put them in good practice. We highly recommend reading and understanding the [Rails Security Guide](https://guides.rubyonrails.org/security.html).
## Supported Versions
-This is a list of all Spree versions currently being supported by the Spree team.
+The following versions are actively maintained and receive security patches.
-| Version | Release date | EOL date |
-| ------- | ------------ | ---------- |
-| 5.0 | 26.03.2025 | 26.03.2028 |
-| 4.10 | 06.09.2024 | 06.09.2027 |
+| Version | Release date | End of life |
+| ------- | ------------ | ----------- |
+| 5.0 | 26.03.2025 | 26.03.2028 |
+| 4.10 | 06.09.2024 | 06.09.2027 |
If you're using an older version [please upgrade](../upgrades/). Have trouble upgrading? [Contact us for support](https://spreecommerce.org/contact/).
-**Versions that aren't supported will not receive any security patches and fixes!**
+**Versions that are not listed above will not receive any security patches or fixes.**
## Reporting Security Issues
-Please do not announce potential security vulnerabilities in public. We have a dedicated email address [[email protected]](mailto:[email protected]). We will work quickly to determine the severity of the issue and provide a fix for the appropriate versions. We will credit you with the discovery of this patch by naming you in a blog post.
+**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
+
+Instead, please send an email to [[email protected]](mailto:[email protected]).
+
+Please include as much of the following information as possible to help us triage your report:
+
+- Type of vulnerability (e.g. SQL injection, XSS, CSRF, etc.)
+- Affected version(s)
+- Step-by-step instructions to reproduce the issue
+- Proof of concept or exploit code (if available)
+- Impact assessment of the vulnerability
+
+### Submitting a Patch
If you would like to provide a patch yourself for the security issue **do not open a pull request for it**. Instead, create a commit on your fork of Spree and run this command:
@@ -25,4 +42,27 @@ If you would like to provide a patch yourself for the security issue **do not op
git format-patch HEAD~1..HEAD --stdout > patch.txt
```
-This command will generate a file called `patch.txt` with your changes. Please email a description of the patch along with the patch itself to our [dedicated email address](mailto:[email protected]).
+Email a description of the patch along with the `patch.txt` file to [[email protected]](mailto:[email protected]).
+
+### Disclosure Process
+
+1. Security report is received and acknowledged within **48 hours**.
+2. The issue is confirmed and a severity level is assigned.
+3. A fix is developed and tested against all supported versions.
+4. A new release is published with the fix and a [GitHub Security Advisory](https://github.com/spree/spree/security/advisories) is created.
+5. Reporter is credited in the advisory (unless anonymity is requested).
+
+### Security Advisories
+
+Published security advisories can be found at [GitHub Security Advisories](https://github.com/spree/spree/security/advisories).
+
+## Security Best Practices
+
+Spree is built on **Ruby on Rails** which provides strong security defaults including protection against SQL injection, CSRF, and XSS. For more details on how Spree handles security in production environments, see the [Enterprise Security Overview](/user/security).
+
+We recommend:
+
+- Keeping Spree and all dependencies up to date
+- Following the [Rails Security Guide](https://guides.rubyonrails.org/security.html)
+- Using [bundler-audit](https://github.com/rubysec/bundler-audit) to scan for known vulnerabilities in dependencies
+- Running [brakeman](https://github.com/presidentbeef/brakeman) for static security analysis