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

Create SECURITY.md #3827

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
70 changes: 70 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Security Policy
ricab marked this conversation as resolved.
Show resolved Hide resolved


## What is a vulnerability?

All vulnerabilities are bugs, but not every bug is a vulnerability. Vulnerabilities compromise one or more of:

- Confidentiality (personal and corporate confidential data).
ricab marked this conversation as resolved.
Show resolved Hide resolved
- Integrity (trustworthiness and correctness).
ricab marked this conversation as resolved.
Show resolved Hide resolved
- Availability (uptime and service).
ricab marked this conversation as resolved.
Show resolved Hide resolved

If you discover a security vulnerability within Multipass, we encourage responsible disclosure.
If you're not sure whether you found a vulnerability, a bug, or something else, please use the process below for reporting a vulnerability.
We will then assess and triage accordingly.

## Reporting a Vulnerability
ricab marked this conversation as resolved.
Show resolved Hide resolved

Multipass accepts private reports of security vulnerabilities made through
ricab marked this conversation as resolved.
Show resolved Hide resolved
[GitHub Security Advisories](https://docs.github.com/en/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories).
ricab marked this conversation as resolved.
Show resolved Hide resolved
Here is the link to open a [new security adivory](https://github.com/canonical/multipass/security/advisories/new).
ricab marked this conversation as resolved.
Show resolved Hide resolved
For detailed instructions, please review the documentation on [privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For detailed instructions, please review the documentation on [privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability).
For detailed instructions, please review GitHub documentation on [privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I went with "GitHub's". WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

@ricab Here I suggested "GitHub documentation" as in "Multipass documentation" or "Python documentation", meaning that the documentation is about GitHub and its features, not in the sense that the documentation is owned by GitHub. But it's a subtlety, so I guess it's fine either way :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OK, I will apply your suggestion on this one too.


### Steps to Report a Vulnerability
ricab marked this conversation as resolved.
Show resolved Hide resolved

1. Go to the [Security Advisories Page](https://github.com/canonical/multipass/security/advisories) of the `multipass` repository.
ricab marked this conversation as resolved.
Show resolved Hide resolved
2. Click "Report a Vulnerability."
ricab marked this conversation as resolved.
Show resolved Hide resolved
3. Provide detailed information about the vulnerability, including steps to reproduce, affected versions, and potential impact.
ricab marked this conversation as resolved.
Show resolved Hide resolved

## Response to vulnerabilities
ricab marked this conversation as resolved.
Show resolved Hide resolved

Vulnerabilities are classified by risk, which factors in impact and likelihood.
The Multipass project will prioritize responding to all High and Critical severity vulnerabilities.

When we receive an issue, we will work with the reporter to determine how best to proceed.
After a fix is available to a confirmed vulnerability, we will also coordinate disclosing and releasing to the various platforms.
ricab marked this conversation as resolved.
Show resolved Hide resolved

## Supported version
ricab marked this conversation as resolved.
Show resolved Hide resolved

Multipass is released as a snap on Linux, an MSI package on Windows, and an installer package on macOS.
In each of these platforms, we support the latest stable version of Multipass.
ricab marked this conversation as resolved.
Show resolved Hide resolved
Multipass notifies you of newer releases on all platforms.
On Linux, updates are handled automatically by the snap machinery.

Please ensure you are using the latest version, to benefit from the latest patches.
ricab marked this conversation as resolved.
Show resolved Hide resolved

### Release of security fixes

Security updates are distributed with a new release, which becomes the new supported version.
This can be either a bug-fix, minor, or major release, depending on what other modifications it includes.

The urgency of the fixes included - security and otherwise - determines the urgency of the release.
We are committed to fixing high-risk security issues and releasing them as quickly as possible.

In addition, the candidate channel of the Multipass snap provides frequent rebuilds of the stable channel with updated dependencies.
ricab marked this conversation as resolved.
Show resolved Hide resolved
These builds are produced from the same Multipass code, but with up-to-date deb packages.
ricab marked this conversation as resolved.
Show resolved Hide resolved
Candidate snaps are later promoted to the stable channel from time to time.
ricab marked this conversation as resolved.
Show resolved Hide resolved

### Finding versions
ricab marked this conversation as resolved.
Show resolved Hide resolved

Multipass can tell you its version with:
ricab marked this conversation as resolved.
Show resolved Hide resolved

```
multipass version
```

The snap command provides information on exact revisions and build dates:
ricab marked this conversation as resolved.
Show resolved Hide resolved

```
snap info multipass
```
Loading