Skip to content

Commit ec363d1

Browse files
committed
docs: security policy
1 parent 5e8fb8a commit ec363d1

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Noise for Kotlin
22

3-
This project contains example code for implementing [Noise](https://noiseprotocol.org) protocols based on Diffie-Hellman key agreement. It may evolve into a usable library. [Contact me](mailto:[email protected]) if you are interested in helping out to realize this.
3+
**Noise for Kotlin** contains example code for implementing [Noise](https://noiseprotocol.org) protocols based on Diffie-Hellman key agreement. It may evolve into a usable library. [Contact me](mailto:[email protected]) if you are interested in helping out to realize this.
44

55
> **Warning**: Reasons why you **may not** use any of this code in production yet:
66
>
@@ -32,3 +32,8 @@ Instead of `test`, use `jar` to create a JAR in `build/distributions`.
3232
- Support only Curve25519, ChaCha20-Poly1305, and SHA-256 to reduce the need to choose and since these are available on most platforms.
3333
- Consequence: it should be easy to use with [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html)).
3434
- Use only Kotlin types and functions, and nothing directly from Java SE or libraries.
35+
36+
## Related resources
37+
38+
- [License](LICENSE.md)
39+
- [Security policy](SECURITY.md)

SECURITY.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security policy
2+
3+
> **Warning**: Do not use this code in production. Expect vulnerabilities. See the [README](README.md) for details.
4+
5+
## Supported versions
6+
7+
Currently only snapshot versions are available. Any vulnerability should be mitigated in a next snapshot version.
8+
9+
## Reporting a vulnerability
10+
11+
Report vulnerabilities to [Sander](mailto:[email protected]) in private, mentioning the project name in the mail subject header. Indicate if and how you want to be identified when publishing about the vulnerability. Expect to get a response within 7 days, but usually within 48 hours, indicating whether the report is accepted. I make my best effort to share fixes for vulnerabilities and publish about the reports when appropriate.

0 commit comments

Comments
 (0)