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: add SECURITY.md template #356

Merged
merged 5 commits into from
Feb 21, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ Migrate existing projects

Don't worry about making the contents match, Starbase's is very specific.

#. ``SECURITY.md`` - Match up the content of your project's ``SECURITY.md`` file as
closely as you can to the structure of `the Starbase template <SECURITY.md>`_. Be sure to read
the comments in the template closely.

#. Run all the linters: ``make lint``

#. ``mypy``:
Expand Down
48 changes: 48 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Security policy

## Release cycle

<!---
The information under this header may not be strictly accurate for all applications.
Review the wording carefully and only copy it if the support offered makes sense. If it
seems wrong, speak with Canonical Security Engineering about refining a version for
your application.
-->

Only the latest minor version of major versions supported in an Ubuntu LTS release
receive security support. Backports to previous minor releases or other unsupported
releases are made on a best-effort basis and will typically only be done for critical
vulnerabilities.

This support tracks the Ubuntu LTS release cycle. The most recent major version will
always support Ubuntu LTS series still in their regular maintenance lifecycle. When a
major Starcraft release drops support for an Ubuntu LTS series, the previous major
release remains supported for only the dropped LTS series until the end of its extended
support lifecycle.

Once an LTS release of Ubuntu is sunset, new security fixes for this software will no
longer be provided.

## Reporting a vulnerability

<!---
Replace the first link in this section with your repository's advisories board. See
GitHub's documentation for enabling the security advisory tab on a repository:
https://docs.github.com/en/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository
-->

To report a security issue, file a [Private Security Report] with a description of the
issue, the steps you took to create the issue, affected versions, and, if known,
mitigations for the issue.

The [Ubuntu Security disclosure and embargo policy] contains more information about
what you can expect when you contact us and what we expect from you.

This support tracks the Ubuntu LTS release cycle. The most recent major version will
always support Ubuntu LTS series still in their regular maintenance lifecycle. When a
major Starcraft release drops support for an Ubuntu LTS series, the previous major
release remains supported for only the dropped LTS series until the end of its extended
support lifecycle.

[Private Security Report]: https://github.com/canonical/starcraft/security/advisories/new
[Ubuntu Security disclosure and embargo policy]: https://ubuntu.com/security/disclosure-policy
Loading