Skip to content

Commit 6be9ad2

Browse files
Merge pull request #748 from pyathena-dev/docs/security-policy
Add a security policy
2 parents ce8feb7 + 77da967 commit 6be9ad2

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

‎SECURITY.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Security Policy
2+
3+
## Supported versions
4+
5+
Security fixes are released for the latest version of PyAthena only. There are no backports to
6+
earlier release series, so please upgrade to the latest release before reporting an issue.
7+
8+
## Reporting a vulnerability
9+
10+
Please report security vulnerabilities privately, not through a public issue or pull request,
11+
since a public report discloses the problem before a fix is available.
12+
13+
Use GitHub's private vulnerability reporting: go to the
14+
[Security tab](https://github.com/pyathena-dev/PyAthena/security) of this repository and click
15+
**Report a vulnerability**. This opens a private channel visible only to the maintainers.
16+
17+
A report is most useful when it includes:
18+
19+
- the PyAthena version you tested against
20+
- the affected code path, and the API you called to reach it
21+
- steps to reproduce, ideally without requiring a live AWS account
22+
- what an attacker can do with it
23+
24+
Proof-of-concept code is welcome but not required. Please do not test against AWS accounts or
25+
data that you do not own.
26+
27+
## What to expect
28+
29+
This is a community-maintained project, so response times depend on maintainer availability.
30+
The usual process is:
31+
32+
1. The report is acknowledged and the affected code path is confirmed.
33+
2. A fix is prepared privately, along with regression tests.
34+
3. The fix is released to PyPI, and a
35+
[GitHub Security Advisory](https://github.com/pyathena-dev/PyAthena/security/advisories) is
36+
published the same day, so that users are notified only once an upgrade is available.
37+
4. Reporters are credited in the advisory unless they ask not to be.
38+
39+
If a CVE ID is warranted, it is requested through GitHub or coordinated with the CNA that
40+
assigned it.

0 commit comments

Comments
 (0)