Skip to content

Commit b448ed4

Browse files
authored
Security doc (#5)
1 parent 821610c commit b448ed4

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

SECURITY.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Security policy
2+
3+
## Reporting a vulnerability
4+
5+
Please report security issues privately, not in a public issue or pull
6+
request. That gives the fix time to ship before the problem is widely known.
7+
8+
Use GitHub's private reporting: go to the **Security** tab and choose
9+
**Report a vulnerability**
10+
([Security Advisories](https://github.com/VictorUvarov/stunner/security/advisories/new)).
11+
It opens a private thread with the maintainer.
12+
13+
Helpful things to include, if you have them:
14+
15+
- what you were doing and what happened,
16+
- the smallest steps or input that reproduce it,
17+
- the affected version or commit, and
18+
- the impact you think it has.
19+
20+
You don't need all of that to report — send what you have.
21+
22+
## What to expect
23+
24+
- An acknowledgement within a few days.
25+
- An honest assessment of whether it's a vulnerability and how severe.
26+
- A fix on a private branch, then a release, then public disclosure crediting
27+
you (unless you'd rather stay anonymous).
28+
29+
## Supported versions
30+
31+
stunner is pre-1.0 and moves fast. Fixes land on the latest release and on
32+
`main`; there are no backports to older tags. Run a recent build.
33+
34+
## Scope
35+
36+
stunner speaks STUN on the network and, when configured, terminates TLS and
37+
DTLS and checks long-term credentials. Reports about any of that — the wire
38+
protocol parsing, the auth handshake, the transports, rate limiting, or the
39+
`stund`/`stunc` commands — are in scope.
40+
41+
Out of scope: how you deploy it (firewall rules, TLS certificate management,
42+
credential storage), and issues in third-party dependencies, which should go
43+
to those projects directly.

0 commit comments

Comments
 (0)