Skip to content

Commit efbdfa0

Browse files
authored
Add SECURITY.md (#93)
* Add SECURITY.md Responsible disclosure policy, credential storage documentation, and supported versions. Resolves the OpenSSF Scorecard SecurityPolicy finding. * Fix credential fallback path in SECURITY.md The credstore uses ~/.config/fizzy/credentials/ (a directory with individual files), not a single credentials.json file.
1 parent 56a8d07 commit efbdfa0

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

SECURITY.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
Please report security vulnerabilities to **security@37signals.com**.
6+
7+
Do **NOT** open public GitHub issues for security vulnerabilities.
8+
9+
We will acknowledge receipt within 48 hours and aim to provide a fix within 90 days depending on severity.
10+
11+
## Credential Storage
12+
13+
The Fizzy CLI stores API tokens securely using your operating system's native credential storage:
14+
15+
| Platform | Storage |
16+
|----------|---------|
17+
| macOS | Keychain |
18+
| Windows | Credential Manager |
19+
| Linux | Secret Service (GNOME Keyring, KWallet) |
20+
21+
### File-based Fallback
22+
23+
If system keyring is unavailable (headless servers, containers), set:
24+
25+
```bash
26+
export FIZZY_NO_KEYRING=1
27+
```
28+
29+
Credentials will be stored as individual files in `~/.config/fizzy/credentials/`, each created with `0600` permissions.
30+
31+
## Supported Versions
32+
33+
| Version | Supported |
34+
|---------|-----------|
35+
| Latest | Yes |
36+
| < Latest | No |
37+
38+
We only provide security fixes for the latest release. Users should upgrade promptly.

0 commit comments

Comments
 (0)