Skip to content

Commit 382ca62

Browse files
committed
Add SECURITY.md and PR template
- Add responsible disclosure policy for crypto library security - Add pull request template with checklist
1 parent 3e33957 commit 382ca62

2 files changed

Lines changed: 56 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## What
2+
3+
Brief description of the change.
4+
5+
## Why
6+
7+
What problem does this solve or what feature does it add?
8+
9+
## How
10+
11+
Key implementation details or approach taken.
12+
13+
## Checklist
14+
15+
- [ ] `zig build test` passes
16+
- [ ] `zig fmt --check src/ tests/` passes
17+
- [ ] New functionality includes tests
18+
- [ ] No external dependencies added
19+
- [ ] CHANGELOG.md updated (if user-facing change)

SECURITY.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported |
6+
|---------|-----------|
7+
| 0.1.x | Yes |
8+
9+
## Reporting a Vulnerability
10+
11+
If you discover a security vulnerability in eth.zig, please report it responsibly.
12+
13+
**Do not open a public GitHub issue for security vulnerabilities.**
14+
15+
Instead, email **security@strobelabs.com** with:
16+
17+
1. A description of the vulnerability
18+
2. Steps to reproduce
19+
3. Potential impact
20+
4. Suggested fix (if any)
21+
22+
We will acknowledge receipt within 48 hours and aim to provide a fix or mitigation within 7 days for critical issues.
23+
24+
## Scope
25+
26+
eth.zig includes cryptographic primitives (secp256k1 ECDSA, Keccak-256, BIP-32/39/44) implemented in pure Zig. Security issues in these components are treated as critical.
27+
28+
Areas of particular concern:
29+
30+
- **Private key handling** -- memory leaks, timing attacks, improper zeroing
31+
- **Signature generation** -- RFC 6979 nonce generation, low-S normalization
32+
- **Transaction signing** -- replay protection, chain ID encoding
33+
- **ABI encoding/decoding** -- buffer overflows, incorrect padding
34+
35+
## Recognition
36+
37+
We credit reporters in the CHANGELOG (with permission) when a vulnerability is confirmed and fixed.

0 commit comments

Comments
 (0)