Skip to content

Commit c964490

Browse files
authored
Enhance security policy with reporting guidelines
Expanded the security policy to include guidelines for reporting vulnerabilities, including the use of AI-assisted reports and a structured format for submissions. New PR since old one was auto closed by mistake from deleting older branch
1 parent 086e3af commit c964490

1 file changed

Lines changed: 50 additions & 2 deletions

File tree

SECURITY.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,56 @@
22

33
## Supported Versions
44

5-
It is recommended to use the [latest](https://github.com/tinyauthapp/tinyauth/releases/latest) available version of tinyauth. This is because it includes security fixes, new features and dependency updates. Older versions, especially major ones, are not supported and won't receive security or patch updates.
5+
It is recommended to use the [latest](https://github.com/tinyauthapp/tinyauth/releases/latest) available version of Tinyauth. This is because it includes security fixes, new features and dependency updates. Older versions, especially major ones, are not supported and won't receive security or patch updates.
66

77
## Reporting a Vulnerability
88

9-
Due to the nature of this app, it needs to be secure. If you discover any security issues or vulnerabilities in the app please contact me as soon as possible at <security@tinyauth.app>. Please do not use the issues section to report security issues as I won't be able to patch them in time and they may get exploited by malicious actors.
9+
Please **do not** report security vulnerabilities through public GitHub issues, discussions, or pull requests as I won't be able to patch them in time and they may get exploited by malicious actors.
10+
11+
Instead, report them privately using [GitHub's Private Vulnerability Reporting](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability) via the **Security** tab of this repository.
12+
13+
Or send us an email at <security@tinyauth.app>.
14+
15+
### A note on AI-assisted reports
16+
17+
If AI tooling (LLMs, automated scanners, agentic assistants, etc.) helped you discover, analyse, or write up this issue, please say so in your report. This isn't a judgement - AI-assisted findings are welcome - but disclosing it up front helps maintainers calibrate how much additional verification a report needs, and tends to make the report itself clearer.
18+
19+
When submitting a report, please use the structure below so it can be triaged quickly.
20+
21+
---
22+
23+
### 1. Summary
24+
25+
A short, one-paragraph description of the vulnerability and its impact (e.g. what an attacker can achieve, who is affected, and under what conditions).
26+
27+
### 2. Steps to Reproduce / Proof of Concept
28+
29+
Provide a minimal, reliable reproduction:
30+
31+
1. Step one
32+
2. Step two
33+
3. Step three
34+
35+
Include any required input, payloads, configuration, or code snippets. Attach a PoC script or screenshots where helpful.
36+
37+
### 3. Expected vs. Actual Behaviour
38+
39+
- **Expected:** what *should* happen
40+
- **Actual:** what *does* happen, and why it's a security issue
41+
42+
### 4. Suggested Fix or Mitigation *(optional)*
43+
44+
If you have an idea for how to address the issue, describe it here. A private gist link is welcome but not required.
45+
46+
- **Have you tested this fix?** Yes / No
47+
- **If yes,** briefly describe how it was tested and what was verified.
48+
49+
---
50+
51+
## What to Expect
52+
53+
- **Acknowledgement** within a reasonable timeframe after receiving your report
54+
- **Updates** as the issue is investigated and addressed
55+
- **Public credit** in the resulting advisory, along with any **CVE assigned**, unless you'd prefer to stay anonymous
56+
57+
We follow a **90-day coordinated disclosure** window: please allow up to 90 days from the date of your report for the issue to be investigated and patched before publicly disclosing it. The publication date - whether earlier if a fix lands sooner, or later if more time is genuinely needed - will be agreed with you in advance.

0 commit comments

Comments
 (0)