Skip to content

Commit a69bfcd

Browse files
ryanhill1TheGupta2012claude
authored
Add SECURITY.md with a private vulnerability disclosure path (#383)
* Add SECURITY.md with a private disclosure path * Clarify supported version range per review * Widen dependency guidance to direct dependencies, not only extras * docs: add a changelog entry for the security policy Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: TheGupta2012 <harshit@qbraid.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent d5b40bb commit a69bfcd

2 files changed

Lines changed: 48 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Types of changes:
2929
### Dependencies
3030

3131
### Other
32+
- Added a `SECURITY.md` with a private vulnerability disclosure path. There was no documented way to report one, leaving a public issue or a guessed email address as the only options. Reports now go through this repository's GitHub security advisory form. ([#383](https://github.com/qBraid/pyqasm/pull/383))
3233

3334
## Past Release Notes
3435

SECURITY.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
qBraid actively supports security updates for the latest minor release line of `pyqasm`:
6+
the most recent `MAJOR.MINOR` version together with every patch release within it. For
7+
example, if the current release is `1.2.3`, then `1.2.x` is supported and `1.1.x` is not.
8+
9+
Older minor lines receive fixes only where an issue is judged severe and a straightforward
10+
backport exists.
11+
12+
## Reporting a Vulnerability
13+
14+
The qBraid team takes the security of our software seriously, across every repository in
15+
this organization. We encourage responsible disclosure of any security vulnerability.
16+
17+
### How to report
18+
19+
Use GitHub's private security advisory form for this repository:
20+
21+
[Report a security vulnerability](https://github.com/qBraid/pyqasm/security/advisories/new)
22+
23+
Please **do not** report security vulnerabilities through public GitHub issues, pull
24+
requests, or discussions.
25+
26+
### Vulnerabilities in dependencies
27+
28+
If an issue originates in an upstream dependency rather than in `pyqasm` itself, whether a
29+
direct dependency or one reached through an optional extra, please report it to that
30+
project as well and tell us here. We will assess whether users are exposed through a path
31+
this package creates, and advise them accordingly.
32+
33+
### What to expect
34+
35+
- Acknowledgment of your report within two business days.
36+
- An assessment of severity and scope, and a request for any further detail we need.
37+
- Progress updates while we work on a fix.
38+
- Notification when the issue is resolved, including the release carrying the fix, and
39+
credit in the advisory unless you prefer otherwise.
40+
41+
### What to include
42+
43+
- The type of issue and its impact.
44+
- The version of `pyqasm` affected, and the Python version and platform.
45+
- Full paths of the source files involved, if known.
46+
- Steps to reproduce, ideally a minimal example.
47+
- Any proof-of-concept or exploit code you are willing to share.

0 commit comments

Comments
 (0)