Skip to content

Take control over your live stream video by running it yourself. Streaming + chat out of the box.

Update security reporting guidance (#5051)

Gabe Kangas498a7efeedbb
diff --git a/README.md b/README.md
index dbf647902f..1c2a9e2511 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,8 @@
<a href="https://owncast.online/faq/">FAQ</a>
·
<a href="https://github.com/owncast/owncast/issues">Report Bug</a>
+ ·
+ <a href="docs/SECURITY.md">Report Security Issue</a>
</p>
<!-- TABLE OF CONTENTS -->
@@ -41,6 +43,7 @@
- ⚛️ [Frontend](#frontend)
- 👏 [Contributing](#contributing)
- 💵 [Donors](#donors)
+- [Security](#security)
- 📝 [License](#license)
- [Contact](#contact)
@@ -141,7 +144,15 @@ Thank you to all our donors who help keep Owncast running by donating on OpenCol
<img alt="GitHub issues by-label" src="https://opencollective.com/owncast/tiers/backers.svg?avatarHeight=36&width=600" alt="Backer button">
</a>
</div>
-
+
+<!-- SECURITY -->
+
+## Security
+
+Report suspected security vulnerabilities privately to [[email protected]](mailto:[email protected]). This is the security-reporting address. The personal contact information in the Support section is for general contact, not vulnerability reports.
+
+See the repository [security policy](docs/SECURITY.md) for scope, disclosure, and credit details.
+
<!-- LICENSE -->
## License
diff --git a/docs/SECURITY.md b/docs/SECURITY.md
index 1345e51cc8..0d552ac2b9 100644
--- a/docs/SECURITY.md
+++ b/docs/SECURITY.md
@@ -1,19 +1,39 @@
-# Security Policy
+# Security policy
-Owncast appreciates efforts to improve the security of the software
-and follow the [GitHub coordinated disclosure of security vulnerabilities](https://docs.github.com/en/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities#about-reporting-and-disclosing-vulnerabilities-in-projects-on-github)
-for responsible disclosure and prompt mitigation.
+Owncast appreciates good-faith efforts to improve the security of the project.
-## Supported Versions
+## Supported versions
-The latest version of Owncast is seen as the supported version. As a small project we are unable to support previous versions and urge users of the software to stay up to date.
+The latest stable Owncast release is the supported version. Reports that affect the current `develop` branch are also welcome. Previous releases are not supported, so Owncast operators should stay up to date.
-## Reporting a Vulnerability
+## Scope
-To report a security issue with Owncast, [open an issue](https://github.com/owncast/owncast/issues/new
-) on the Owncast GitHub repository and *do not* mention vulnerability details in the issue. If you have a preferred next step on where to discuss the details of the disclosure, please mention that in the issue if it's appropriate for those details to be public.
+### In scope
-You may optionally [email Gabe](mailto:[email protected]) to alert him directly and provide specifics on how you wish to disclose the details of the issue.
+- Security vulnerabilities in the latest stable Owncast release or the current `develop` branch.
+- The Owncast server, viewer and admin interfaces, bundled APIs, chat, federation, authentication, and streaming features.
+- Vulnerabilities in third-party dependencies that can be exploited through Owncast.
+- Owncast-operated services under `owncast.online` when tested without disrupting the service or accessing other people's data.
-Owncast may open a draft [GitHub Security Advisory](https://docs.github.com/en/code-security/security-advisories/creating-a-security-advisory)
- to discuss the vulnerability details in private if it is warranted.
+### Out of scope
+
+- Independently operated Owncast instances and the content they stream. Contact that server's operator instead.
+- Issues that only affect an outdated Owncast version and are already fixed in the latest release.
+- Expected actions available to an authorized server administrator that do not cross a security boundary.
+- Self-XSS, best-practice suggestions, or automated scanner output without a reproducible security impact.
+- Vulnerabilities in third-party software that cannot be exploited through Owncast.
+- Social engineering, phishing, physical attacks, denial-of-service testing, and high-volume automated scanning.
+
+## Reporting a vulnerability
+
+Report suspected security vulnerabilities privately to [[email protected]](mailto:[email protected]). Do not open a public GitHub issue or discussion.
+
+Include the affected Owncast version or commit, steps to reproduce the issue, its potential impact, and any proof of concept that helps explain the report.
+
+## Disclosure and credit
+
+Please allow time for the issue to be investigated and fixed before sharing it publicly. Reports made in good faith and within the published scope are welcome.
+
+With the reporter's permission, Owncast credits valid reports after a fix is available. Credit can include the reporter's chosen name and one link. Reporters may remain anonymous.
+
+Owncast handles new reports by email and does not publish new GitHub Security Advisories as part of this process. CVEs may be requested when the severity and impact warrant one, at the project's discretion.