Commit f7b4213
authored
auth: add file-based credential storage (PRINFRA-123) (#17)
## Description
### What This Adds
This PR adds **persistent local authentication** to the CLI.
`heygen auth login` reads an API key from stdin (interactive prompt or pipe), stores it in the CLI config directory with **restrictive file permissions** (0600), and returns structured JSON. This gives the CLI a real local login flow instead of requiring users to export `HEYGEN_API_KEY` for every session.
### Login Flow
`auth login` **skips the global pre-run auth check** via Cobra annotations (`skipAuth: "true"`). Before this change, `PersistentPreRunE` tried to resolve credentials for every command, which blocked the login command itself when no API key existed yet.
### Credential Resolution Order
Credential lookup uses a chain resolver with priority order:
1. `HEYGEN_API_KEY` env var — for CI, Docker, and agent workflows
2. `~/.heygen/credentials` file — written by `heygen auth login`
### Error Handling
The auth layer distinguishes between:
- A credential source that is **absent** (`ErrNotConfigured`) — falls through to the next resolver
- A credential source that is **present but broken** (permission denied, empty file) — surfaces immediately with an actionable hint pointing to the actual credential path
### No `--key` flag
Industry standard (gh, AWS, Stripe, gcloud) is to never pass secrets as CLI flags — they leak into `ps` output and shell history. Instead:
- **Agents/CI**: `HEYGEN_API_KEY` env var (no login needed)
- **Humans (interactive)**: `heygen auth login` → prompt with hidden input
- **Humans (scripted)**: `echo "$KEY" | heygen auth login`
### Example Outputs
**Successful login:**
```
$ echo "$KEY" | heygen auth login
{
"message": "API key saved to ~/.heygen/credentials"
}
```
**Empty input:**
```
$ echo "" | heygen auth login
{
"error": {
"code": "usage_error",
"message": "no API key provided"
}
}
```
**No credentials configured (on any API command):**
```
$ heygen video list
{
"error": {
"code": "auth_error",
"message": "no API key found",
"hint": "Set HEYGEN_API_KEY env var or run: heygen auth login"
}
}
```
**Linear issue:** PRINFRA-123
## Testing
### Automated (16 tests)
- **Chain resolver** (4): first-wins, fallthrough on ErrNotConfigured, all-not-configured → auth error, broken-source → surfaces immediately
- **File resolver** (4): reads key, missing file → ErrNotConfigured, empty file → real error, whitespace trimming
- **File store** (4): save + read back, creates directory with 0700, file permissions 0600 (skipped on Windows), overwrite existing
- **Auth login command** (4): success via stdin pipe, empty input → exit 2, overwrite, skipAuth bypass (no HEYGEN_API_KEY needed)
- All existing M0 tests pass unchanged
### Manual smoke tests
- `echo "key" | ./bin/heygen auth login` — exit 0, credentials saved with 0600 perms
- `echo "" | ./bin/heygen auth login` — exit 2, `usage_error`
- Overwrite: second key wins
- Credential chain: `unset HEYGEN_API_KEY`, CLI resolves from credentials file
- `heygen auth login --help` — shows `HEYGEN_API_KEY` env var hint for agents1 parent 54faf6f commit f7b4213
20 files changed
Lines changed: 660 additions & 66 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
9 | | - | |
10 | 8 | | |
11 | | - | |
12 | 9 | | |
13 | 10 | | |
14 | 11 | | |
15 | 12 | | |
16 | 13 | | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | 14 | | |
26 | 15 | | |
27 | 16 | | |
| |||
32 | 21 | | |
33 | 22 | | |
34 | 23 | | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | | - | |
46 | | - | |
47 | | - | |
48 | | - | |
49 | | - | |
50 | | - | |
51 | | - | |
52 | | - | |
| 24 | + | |
53 | 25 | | |
54 | 26 | | |
55 | 27 | | |
| |||
58 | 30 | | |
59 | 31 | | |
60 | 32 | | |
| 33 | + | |
61 | 34 | | |
62 | 35 | | |
63 | 36 | | |
| |||
76 | 49 | | |
77 | 50 | | |
78 | 51 | | |
79 | | - | |
80 | | - | |
81 | | - | |
82 | | - | |
83 | | - | |
84 | | - | |
85 | | - | |
86 | | - | |
87 | | - | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
92 | | - | |
93 | | - | |
| 52 | + | |
94 | 53 | | |
95 | 54 | | |
96 | 55 | | |
97 | 56 | | |
98 | 57 | | |
99 | 58 | | |
100 | 59 | | |
| 60 | + | |
101 | 61 | | |
102 | 62 | | |
103 | 63 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
6 | 7 | | |
7 | 8 | | |
8 | 9 | | |
| |||
60 | 61 | | |
61 | 62 | | |
62 | 63 | | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
63 | 69 | | |
64 | 70 | | |
65 | 71 | | |
66 | 72 | | |
67 | 73 | | |
68 | | - | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
69 | 77 | | |
70 | 78 | | |
71 | 79 | | |
72 | 80 | | |
73 | 81 | | |
74 | 82 | | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
75 | 86 | | |
76 | 87 | | |
77 | 88 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
| 13 | + | |
| 14 | + | |
13 | 15 | | |
14 | 16 | | |
15 | 17 | | |
| |||
22 | 24 | | |
23 | 25 | | |
24 | 26 | | |
| 27 | + | |
25 | 28 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
50 | 54 | | |
51 | 55 | | |
52 | 56 | | |
| |||
0 commit comments