Skip to content

Commit 5a342c7

Browse files
authored
Merge pull request #2691 from NoodlesNZ/security-policy
Add Github Security policy
2 parents 07a3ca9 + dea5ed7 commit 5a342c7

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

SECURITY.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Security fixes are applied to the latest release only. We do not backport
6+
fixes to older versions.
7+
8+
| Version | Supported |
9+
|---------|-----------|
10+
| 1.15+ ||
11+
| <1.15 ||
12+
13+
## Reporting a Vulnerability
14+
15+
**Please do not report security vulnerabilities through public GitHub issues.**
16+
17+
Use GitHub's private vulnerability reporting instead:
18+
1. Go to the **Security** tab of this repository
19+
2. Click **Report a vulnerability**
20+
3. Fill in the details and submit
21+
22+
### What to include
23+
24+
A useful report tells us:
25+
- Which component or file is affected
26+
- What an attacker can do (impact) and under what conditions
27+
- A minimal reproduction case or proof-of-concept if you have one
28+
- Whether you believe it is remotely exploitable
29+
30+
You do not need a working exploit to report. An incomplete report is better
31+
than no report.
32+
33+
## What to expect
34+
35+
This is a volunteer-maintained open-source project. We will do our best to
36+
respond in a reasonable timeframe, but cannot commit to specific deadlines.
37+
38+
We ask that you give us a fair opportunity to investigate and address the
39+
issue before any public disclosure. If you have not heard back after
40+
**90 days**, feel free to follow up or proceed with disclosure at your
41+
discretion.
42+
43+
## Scope
44+
45+
In scope:
46+
- Remote code execution, memory corruption, or denial-of-service via crafted
47+
radio packets
48+
- Authentication or encryption bypasses
49+
- Vulnerabilities in the packet routing or path handling logic
50+
51+
Out of scope:
52+
- Physical access attacks (e.g., JTAG, UART extraction of keys)
53+
- Regulatory compliance (duty cycle, frequency restrictions)
54+
- Jamming or other physical-layer radio interference
55+
- Issues in third-party libraries (RadioLib, Crypto, etc.) — report those
56+
upstream
57+
- "Best practice" suggestions without a demonstrated attack path

0 commit comments

Comments
 (0)