|
1 | 1 | # Security Policy |
2 | 2 |
|
3 | 3 | ## Overview |
4 | | -Security is of paramount importance to this project, especially since it deals with login functionalities. |
5 | | -That being said, an oopsie may happen and it is crucial for me to be informed promptly. This document provides an overview of the supported |
6 | | -versions and instructions on reporting any security-related issues or vulnerabilities you might discover. |
| 4 | + |
| 5 | +`fastapi-sso` handles logins, so a bug here can become someone else's account takeover. Security reports are the most |
| 6 | +useful thing you can send me, and they get priority over everything else in the tracker. |
7 | 7 |
|
8 | 8 | ## Supported Versions |
9 | | -`fastapi-sso` is still in its developmental phases, and we haven't rolled out a 1.0.0 release yet. Currently, I am offering support for all releases `0.7.0` and newer. |
10 | 9 |
|
11 | | -| Version | Supported | |
12 | | -| -----------| ------------------ | |
13 | | -| >= 0.7.0 | :white_check_mark: | |
| 10 | +Fixes ship in a new release built from `master`. There are no maintenance branches and no backports, so only the |
| 11 | +latest release receives security fixes. |
| 12 | + |
| 13 | +| Version | Supported | |
| 14 | +| -------------- | ------------------ | |
| 15 | +| Latest release | :white_check_mark: | |
| 16 | +| Anything older | :x: | |
| 17 | + |
| 18 | +Upgrade to the latest release before reporting, so we don't spend time on something already fixed. |
14 | 19 |
|
15 | 20 | ## Reporting a Vulnerability |
16 | | -Addressing security issues can be time-consuming, but rest assured, I take them very seriously and endeavor to resolve them as swiftly as possible. If you identify a security vulnerability in `fastapi-sso`, I urge you to notify me. |
17 | 21 |
|
18 | | -### Steps to Report a Vulnerability: |
19 | | -1. Create a new issue in our [Issue Tracker](https://github.com/tomasvotava/fastapi-sso/issues). |
20 | | -2. Assign the `security` label to the issue. |
21 | | -3. Furnish a detailed description of the issue, specifying where the vulnerability occurs, the steps to reproduce it, and its potential impacts. |
| 22 | +**Report privately, not in the public issue tracker.** |
| 23 | + |
| 24 | +Use GitHub's private vulnerability reporting, which is enabled on this repository: |
| 25 | + |
| 26 | +1. Open [Report a vulnerability](https://github.com/tomasvotava/fastapi-sso/security/advisories/new). |
| 27 | +2. Describe the issue, the version you tested against, and the impact you think it has. |
| 28 | +3. Include steps to reproduce, ideally a short runnable snippet. |
| 29 | +4. Suggest a severity if you have one in mind. I may end up disagreeing, and that is a normal part of triage. |
| 30 | + |
| 31 | +Only you and the maintainers can see the report. It stays private until an advisory is published. |
| 32 | + |
| 33 | +If you have already opened a public issue before reading this, don't worry about it. Say so in the private report and |
| 34 | +I will handle the cleanup. |
22 | 35 |
|
23 | | -### What to Expect |
24 | | -I will acknowledge the receipt of your vulnerability report and keep you posted on the progress regularly. |
| 36 | +## What to Expect |
25 | 37 |
|
26 | | -### Disclosure Policy |
27 | | -In the realm of coding etiquette, it is generally frowned upon to publicly disclose issues without prior communication with me. |
28 | | -Therefore, I ask you to discuss any grievances or concerns about `fastapi-sso` with me before publicizing them. |
| 38 | +- An acknowledgement that I received the report. |
| 39 | +- Triage, where I confirm or dispute the finding and we agree on severity. |
| 40 | +- A fix, released as a new version. |
| 41 | +- A published GitHub Security Advisory naming you as the reporter, unless you would rather stay anonymous. |
| 42 | +- A CVE, requested through GitHub, for anything that affects users on the default configuration. |
29 | 43 |
|
30 | | -In other words, if there's something concerning `fastapi-sso` you'd like to bitch about, let me know and we'll bitch about it together. |
| 44 | +This is a side project maintained by one person, so response times depend on what else my week looks like. I would |
| 45 | +rather tell you that up front than promise a turnaround I cannot keep. |
| 46 | + |
| 47 | +## Disclosure Policy |
| 48 | + |
| 49 | +Disclosure is coordinated. The advisory goes public once the fixed version is on PyPI, so that everyone reading it has |
| 50 | +somewhere to upgrade to. Please hold off on publishing details until then. |
| 51 | + |
| 52 | +If a fix is taking unreasonably long, tell me. Agreeing on a disclosure date is fair, going around me without saying |
| 53 | +anything is not. |
| 54 | + |
| 55 | +## Non-Security Issues |
| 56 | + |
| 57 | +Everything that is not a vulnerability belongs in the [issue tracker](https://github.com/tomasvotava/fastapi-sso/issues), |
| 58 | +including things you are annoyed about. If there is something concerning `fastapi-sso` you would like to bitch about, |
| 59 | +let me know and we'll bitch about it together. |
31 | 60 |
|
32 | 61 | ## Thank You |
33 | | -Raising an issue is a significant contribution, and I always appreciate discovering that people are using `fastapi-sso`. I am thankful for any insights or feedback provided. |
| 62 | + |
| 63 | +Reporting takes real effort and I appreciate every report I get, including the ones that turn out to be false alarms. |
0 commit comments