a0dd989c81
Compared the auth subtree (login/logout/list/status/refresh/token)
against gh CLI's auth implementation. Three gaps closed:
1. `auth login --with-token` validates the API key against `/auth/me`
before persisting (mirrors gh's pre-persist GetCurrentLogin probe).
A typo'd / expired / wrong-host key fails fast with
`auth.bad_credential` (exit 3) and nothing is written to the
keyring. Side benefit: api-key contexts now carry the resolved
`user` + `tenant_id` at rest, so `auth list` reflects who owns
the key — previously these columns were blank for `--with-token`
contexts because we never queried the server.
2. `auth login` prints a stderr advisory when the secrets store falls
back to the 0600 plaintext file (keychain unavailable — typical on
headless CI, WSL without DBus, agent containers). `weknora doctor`
carried the same info in its credential_storage check, but users
who go straight to `auth login` could miss it. gh has the same
silent-fallback gap; we're stricter here.
3. AGENTS.md adds an "Auth security contract" section documenting:
- Credential storage (keychain primary, 0600 file fallback)
- `--with-token` reads stdin (not flag value), pre-validated
- No env-var token bypass — by design, to avoid the
`/proc/<pid>/environ` / `ps -E` leak surface that
`GH_TOKEN`-style env vars expose
- `auth status` / `auth list` never emit token values
- `auth refresh --json` returns only `{context}` (never the
new tokens)
- `auth token` stdout has no trailing newline + TTY stderr hint
- `auth logout` is local-only (no server-side revocation)
Verified against gh CLI behavior (cli.github.com manual + cli/cli
trunk source):
| dimension | gh | weknora v0.4 |
|---------------------------------|----------------|--------------|
| pre-persist token validation | ✓ | ✓ (new) |
| OS keychain primary | go-keyring | go-keyring |
| stderr warning on file fallback | ✗ silent | ✓ (new) |
| `auth status` default token | masked prefix | not shown |
| `auth token` TTY warning | ✗ | ✓ |
| env-var token bypass | ✓ (GH_TOKEN) | ✗ by design |
| process-args / `ps` leak surface| ✗ stdin only | ✗ stdin only |
169 lines
5.8 KiB
Go
169 lines
5.8 KiB
Go
package auth
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
"github.com/Tencent/WeKnora/cli/internal/secrets"
|
|
"github.com/Tencent/WeKnora/cli/internal/testutil"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakeLoginService captures the email/password it received.
|
|
type fakeLoginService struct {
|
|
resp *sdk.LoginResponse
|
|
err error
|
|
got struct{ email, password string }
|
|
}
|
|
|
|
func (f *fakeLoginService) Login(_ context.Context, req sdk.LoginRequest) (*sdk.LoginResponse, error) {
|
|
f.got.email = req.Email
|
|
f.got.password = req.Password
|
|
return f.resp, f.err
|
|
}
|
|
|
|
// scriptedPrompter satisfies prompt.Prompter with predetermined values.
|
|
type scriptedPrompter struct{ email, password string }
|
|
|
|
func (s scriptedPrompter) Input(string, string) (string, error) { return s.email, nil }
|
|
func (s scriptedPrompter) Password(string) (string, error) { return s.password, nil }
|
|
func (s scriptedPrompter) Confirm(string, bool) (bool, error) { return true, nil }
|
|
|
|
func newTestFactoryWithConfig(t *testing.T, p prompt.Prompter) (*cmdutil.Factory, *secrets.MemStore) {
|
|
t.Helper()
|
|
testutil.XDGTempDir(t)
|
|
store := secrets.NewMemStore()
|
|
return &cmdutil.Factory{
|
|
Config: func() (*config.Config, error) { return config.Load() },
|
|
Client: func() (*sdk.Client, error) { panic("client") },
|
|
Prompter: func() prompt.Prompter { return p },
|
|
Secrets: func() (secrets.Store, error) { return store, nil },
|
|
}, store
|
|
}
|
|
|
|
func TestRunLogin_PasswordMode(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
f, store := newTestFactoryWithConfig(t, scriptedPrompter{email: "a@b.c", password: "secret"})
|
|
svc := &fakeLoginService{resp: &sdk.LoginResponse{
|
|
Success: true,
|
|
Token: "jwt-access",
|
|
User: &sdk.AuthUser{ID: "u1", Email: "a@b.c", TenantID: 7},
|
|
}}
|
|
opts := &LoginOptions{
|
|
Host: "https://kb.example.com",
|
|
Context: "prod",
|
|
}
|
|
require.NoError(t, runLogin(context.Background(), opts, nil, f, svc))
|
|
|
|
assert.Equal(t, "a@b.c", svc.got.email)
|
|
assert.Equal(t, "secret", svc.got.password)
|
|
|
|
got, _ := store.Get("prod", "access")
|
|
assert.Equal(t, "jwt-access", got)
|
|
}
|
|
|
|
func TestRunLogin_WithToken(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
f, store := newTestFactoryWithConfig(t, prompt.AgentPrompter{})
|
|
restore := stubAPIKeyValidator(func(_ context.Context, _, _ string) (*sdk.AuthUser, error) {
|
|
return &sdk.AuthUser{ID: "u1", Email: "ci@example.com", TenantID: 7}, nil
|
|
})
|
|
defer restore()
|
|
opts := &LoginOptions{
|
|
Host: "https://kb.example.com",
|
|
Context: "ci",
|
|
WithToken: true,
|
|
StdinReader: strings.NewReader(" sk-1234 \n"),
|
|
}
|
|
require.NoError(t, runLogin(context.Background(), opts, nil, f, nil))
|
|
got, _ := store.Get("ci", "api_key")
|
|
assert.Equal(t, "sk-1234", got)
|
|
cfg, _ := f.Config()
|
|
assert.Equal(t, "ci@example.com", cfg.Contexts["ci"].User, "validator-returned user should be persisted")
|
|
assert.Equal(t, uint64(7), cfg.Contexts["ci"].TenantID)
|
|
}
|
|
|
|
func TestRunLogin_WithToken_ServerRejects(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
f, _ := newTestFactoryWithConfig(t, prompt.AgentPrompter{})
|
|
restore := stubAPIKeyValidator(func(_ context.Context, _, _ string) (*sdk.AuthUser, error) {
|
|
return nil, errors.New("HTTP 401: invalid api key")
|
|
})
|
|
defer restore()
|
|
opts := &LoginOptions{
|
|
Host: "https://kb.example.com",
|
|
Context: "ci",
|
|
WithToken: true,
|
|
StdinReader: strings.NewReader("sk-bad"),
|
|
}
|
|
err := runLogin(context.Background(), opts, nil, f, nil)
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeAuthBadCredential, typed.Code,
|
|
"server-side rejection must surface as auth.bad_credential, not persist the key")
|
|
}
|
|
|
|
// stubAPIKeyValidator swaps defaultAPIKeyValidator for the test and returns
|
|
// a restore func to defer.
|
|
func stubAPIKeyValidator(fn apiKeyValidator) func() {
|
|
saved := defaultAPIKeyValidator
|
|
defaultAPIKeyValidator = fn
|
|
return func() { defaultAPIKeyValidator = saved }
|
|
}
|
|
|
|
func TestRunLogin_WithToken_Empty(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
f, _ := newTestFactoryWithConfig(t, prompt.AgentPrompter{})
|
|
// Validator must NOT be called when stdin is empty — verify by setting
|
|
// a panic-on-call sentinel.
|
|
restore := stubAPIKeyValidator(func(_ context.Context, _, _ string) (*sdk.AuthUser, error) {
|
|
t.Fatal("validator should not be called on empty stdin")
|
|
return nil, nil
|
|
})
|
|
defer restore()
|
|
opts := &LoginOptions{
|
|
Host: "https://kb.example.com",
|
|
Context: "ci",
|
|
WithToken: true,
|
|
StdinReader: strings.NewReader(""),
|
|
}
|
|
err := runLogin(context.Background(), opts, nil, f, nil)
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "input.missing_flag")
|
|
}
|
|
|
|
func TestRunLogin_BadHost(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
f, _ := newTestFactoryWithConfig(t, prompt.AgentPrompter{})
|
|
err := runLogin(context.Background(), &LoginOptions{Host: "ftp://nope"}, nil, f, nil)
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "input.invalid_argument")
|
|
}
|
|
|
|
func TestRunLogin_LoginRefused(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
f, _ := newTestFactoryWithConfig(t, scriptedPrompter{email: "a@b.c", password: "x"})
|
|
svc := &fakeLoginService{resp: &sdk.LoginResponse{Success: false, Message: "bad password"}}
|
|
err := runLogin(context.Background(), &LoginOptions{Host: "https://x", Context: "p"}, nil, f, svc)
|
|
require.Error(t, err)
|
|
assert.Contains(t, err.Error(), "auth.bad_credential")
|
|
}
|
|
|
|
func TestValidateHost(t *testing.T) {
|
|
require.NoError(t, validateHost("https://kb.example.com"))
|
|
require.NoError(t, validateHost("http://localhost:8080"))
|
|
require.Error(t, validateHost(""))
|
|
require.Error(t, validateHost("ftp://x"))
|
|
require.Error(t, validateHost("not a url"))
|
|
}
|