e623e8208f
Removes the entire envelope machinery now that every success path
emits bare JSON:
- cli/internal/format/envelope.go (Envelope, Success, Failure,
SuccessWithRisk, WriteEnvelope, Meta, Notice, UpdateNotice,
VersionSkewNotice, Risk, RiskLevel, ErrorBody) + tests.
- cli/internal/format/filter.go envelope-specific helpers
(WriteEnvelopeFiltered, marshalEnvelope, applyFieldFilter,
filterDataPayload, filterObjectData); the reusable
filterArrayItems / filterObjectKeys / writeJQ stay for bare.go.
- cli/internal/cmdutil/exporter.go + tests (envelope-only).
- cli/internal/cmdutil/PrintErrorEnvelope + ToErrorBody +
operationRiskOf + Error.OperationRisk field + OperationRisk struct.
Error path: all errors now go to stderr via cmdutil.PrintError in
`code: message\nhint: ...` form, regardless of --json. Stdout stays
empty (or holds the partial-success the command already wrote) so
downstream `--json | jq` pipelines never have to filter error shapes
out of the success stream. Typed exit codes (3 auth.* / 4
resource.not_found / 5 input.* / 6 server.rate_limited / 7 server.*
+ network.* / 10 input.confirmation_required) carry the failure
class for agents that branch on it.
Acceptance contract:
- envelope_test.go → wire_test.go (TestEnvelopeGolden → TestWireGolden).
- testdata/envelopes/ → testdata/wire/.
- Error-path cases assert the typed code substring on stderr.
- Orphan whoami.*.json goldens deleted.
AGENTS.md + README.md rewritten for the bare-data contract:
- Drop envelope schema section + dry-run rule.
- Document bare JSON on stdout + `code: msg\nhint: …` on stderr.
- ADR-3 reframed around bare data and why error separation matters
for `--json | jq` pipelines.
WriteJSONFiltered short-circuits to WriteJSON when both filters are
empty (skip the marshal-buffer round-trip for the common case).
Final review pass:
- Fix wire-contract bug: `--json id,name` (space form) is broken by
pflag's NoOptDefVal; AGENTS.md / README.md / SetAgentHelp + the
field-discovery help text all switched to `--json=id,name`.
- Fix `weknora api --jq` silently ignored: api.go now routes through
WriteJSONFiltered with jopts.JQ.
- AGENTS.md: drop the false claim that `auth logout` honors `-y`
(logout is local-only with no ConfirmDestructive guard); list the
actual destructive commands instead.
- Rewrite cli/acceptance/e2e/e2e_test.go for the bare-data wire shape
(was still parsing `out["data"]` / `env["ok"]`).
- Add `JSONOptions.Emit(w, v)` helper; collapse ~33 repeated
`format.WriteJSONFiltered(iostreams.IO.Out, X, jopts.Fields,
jopts.JQ)` sites to `jopts.Emit(iostreams.IO.Out, X)` — drops the
format import from 22 cmd/* files.
- Delete single-caller `cmdutil.MustRequireFlag`; inline as
`_ = cmd.MarkFlagRequired(...)` everywhere.
- Add `_ = cmd.MarkFlagRequired("name")` to `kb create`; it was the
only write command relying on runtime --name validation while
`context add` already used the cobra-level mark.
- `context use`: register `--json` / `--jq` (was always emitting JSON
unconditionally with no human path and no flag — diverged from
every other write command); human mode now prints
`✓ Switched context to X (was Y)`.
- Replace per-package `confirmPrompter` / `scriptedConfirm` /
`errPrompter` test doubles with `testutil.ConfirmPrompter`.
- Rename `chatService` → `ChatService` (export to match siblings
`ListService` / `ViewService`); rename `printUploadSuccess` →
`renderUploadSuccess` (siblings use `render*`).
- `defaultHint(CodeResourceNotFound)`: drop the hardcoded
"list available with `weknora kb list`" — misleading on agent /
doc / session 404. Replaced with "verify the resource ID and try
again".
- Strip stale `v0.2/v0.3` / "envelope" / "v0.0/v0.1 supports only"
historical tags from production comments and a few test
descriptions.
243 lines
8.3 KiB
Go
243 lines
8.3 KiB
Go
package auth
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/aiclient"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// authLoginFields enumerates the fields surfaced for `--json` discovery on
|
|
// `auth login`. The post-login summary has no token values — they stay in the
|
|
// keyring; agents who need to verify the credential should re-run
|
|
// `auth status`.
|
|
var authLoginFields = []string{
|
|
"context", "host", "mode", "user", "tenant_id",
|
|
}
|
|
|
|
// LoginOptions is the configuration captured from flags + prompts.
|
|
type LoginOptions struct {
|
|
Host string // --host
|
|
Context string // --name: context name to write into config.yaml
|
|
WithToken bool // --with-token: read api key from stdin instead of prompting password
|
|
APIKey string // populated by --with-token from stdin
|
|
Email string
|
|
Password string
|
|
StdinReader io.Reader // override for tests
|
|
}
|
|
|
|
// LoginService is the narrow SDK surface auth login depends on.
|
|
// *sdk.Client satisfies it implicitly via the new Login(ctx, LoginRequest)
|
|
// signature added in client/auth.go.
|
|
type LoginService interface {
|
|
Login(ctx context.Context, req sdk.LoginRequest) (*sdk.LoginResponse, error)
|
|
}
|
|
|
|
// NewCmdLogin builds the `weknora auth login` command. runF is the testable
|
|
// entrypoint (left nil for production; see cli/cmd/auth/login_test.go).
|
|
func NewCmdLogin(f *cmdutil.Factory, runF func(context.Context, *LoginOptions, *cmdutil.JSONOptions, *cmdutil.Factory, LoginService) error) *cobra.Command {
|
|
opts := &LoginOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "login",
|
|
Short: "Authenticate against a WeKnora server and persist credentials",
|
|
Long: `Log in by email + password (interactive prompt) or pipe an API key with --with-token.
|
|
|
|
Credentials are persisted to the OS keyring when available; otherwise to a
|
|
0600 file under $XDG_CONFIG_HOME/weknora/secrets. The named context becomes
|
|
the current_context in ~/.config/weknora/config.yaml.`,
|
|
Args: cobra.NoArgs,
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
jopts, err := cmdutil.CheckJSONFlags(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
run := runF
|
|
if run == nil {
|
|
run = runLogin
|
|
}
|
|
svc := loginServiceFor(opts.Host)
|
|
if opts.StdinReader == nil {
|
|
opts.StdinReader = iostreams.IO.In
|
|
}
|
|
return run(c.Context(), opts, jopts, f, svc)
|
|
},
|
|
}
|
|
cmd.Flags().StringVar(&opts.Host, "host", "", "WeKnora server URL, e.g. https://kb.example.com")
|
|
cmd.Flags().StringVar(&opts.Context, "name", "default", "Context name to register in config.yaml")
|
|
cmd.Flags().BoolVar(&opts.WithToken, "with-token", false, "Read an API key from stdin instead of prompting for password")
|
|
cmdutil.AddJSONFlags(cmd, authLoginFields)
|
|
_ = cmd.MarkFlagRequired("host")
|
|
aiclient.SetAgentHelp(cmd, "Authenticates and stores credentials. --with-token reads an API key from stdin (no password prompt, agent-safe). Otherwise email/password prompts fire — non-TTY callers must pipe `--with-token` or pre-set --name. Errors: auth.bad_credential on wrong password; input.invalid_argument on bad --host; input.missing_flag when --with-token has empty stdin.")
|
|
return cmd
|
|
}
|
|
|
|
// loginServiceFor returns a fresh SDK client targeting host. login.go cannot
|
|
// reuse Factory.Client because that closure requires an existing context.
|
|
func loginServiceFor(host string) LoginService {
|
|
if host == "" {
|
|
return nil
|
|
}
|
|
return sdk.NewClient(host)
|
|
}
|
|
|
|
func runLogin(ctx context.Context, opts *LoginOptions, jopts *cmdutil.JSONOptions, f *cmdutil.Factory, svc LoginService) error {
|
|
if err := validateHost(opts.Host); err != nil {
|
|
return err
|
|
}
|
|
|
|
if opts.WithToken {
|
|
key, err := readStdinTrimmed(opts.StdinReader)
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "read stdin")
|
|
}
|
|
if key == "" {
|
|
return cmdutil.NewError(cmdutil.CodeInputMissingFlag, "--with-token requires an API key piped to stdin")
|
|
}
|
|
opts.APIKey = key
|
|
return persistAPIKey(opts, jopts, f)
|
|
}
|
|
|
|
// Interactive: prompt for email + password.
|
|
if svc == nil {
|
|
return cmdutil.NewError(cmdutil.CodeServerError, "login: no SDK client (host missing?)")
|
|
}
|
|
if opts.Email == "" || opts.Password == "" {
|
|
p := f.Prompter()
|
|
if opts.Email == "" {
|
|
email, err := p.Input("Email", "")
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeInputMissingFlag, err, "email prompt")
|
|
}
|
|
opts.Email = email
|
|
}
|
|
if opts.Password == "" {
|
|
pw, err := p.Password("Password")
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeInputMissingFlag, err, "password prompt")
|
|
}
|
|
opts.Password = pw
|
|
}
|
|
}
|
|
|
|
resp, err := svc.Login(ctx, sdk.LoginRequest{Email: opts.Email, Password: opts.Password})
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeAuthBadCredential, err, "login")
|
|
}
|
|
if !resp.Success || resp.Token == "" {
|
|
return cmdutil.NewError(cmdutil.CodeAuthBadCredential, fmt.Sprintf("login refused: %s", resp.Message))
|
|
}
|
|
|
|
return persistJWT(opts, jopts, f, resp)
|
|
}
|
|
|
|
// persistAPIKey saves the --with-token API key and writes the context.
|
|
func persistAPIKey(opts *LoginOptions, jopts *cmdutil.JSONOptions, f *cmdutil.Factory) error {
|
|
store, err := f.Secrets()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if err := store.Set(opts.Context, "api_key", opts.APIKey); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalKeychainDenied, err, "save api key")
|
|
}
|
|
return saveContextRef(opts, jopts, f, &config.Context{
|
|
Host: opts.Host,
|
|
APIKeyRef: store.Ref(opts.Context, "api_key"),
|
|
}, nil)
|
|
}
|
|
|
|
// persistJWT saves access + refresh tokens and writes the context.
|
|
func persistJWT(opts *LoginOptions, jopts *cmdutil.JSONOptions, f *cmdutil.Factory, resp *sdk.LoginResponse) error {
|
|
store, err := f.Secrets()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if err := store.Set(opts.Context, "access", resp.Token); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalKeychainDenied, err, "save access token")
|
|
}
|
|
if resp.RefreshToken != "" {
|
|
if err := store.Set(opts.Context, "refresh", resp.RefreshToken); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalKeychainDenied, err, "save refresh token")
|
|
}
|
|
}
|
|
c := &config.Context{
|
|
Host: opts.Host,
|
|
TokenRef: store.Ref(opts.Context, "access"),
|
|
RefreshRef: store.Ref(opts.Context, "refresh"),
|
|
}
|
|
if resp.User != nil {
|
|
c.User = resp.User.Email
|
|
c.TenantID = resp.User.TenantID
|
|
}
|
|
return saveContextRef(opts, jopts, f, c, resp.User)
|
|
}
|
|
|
|
// loginResult is the typed payload emitted by `--json`. mode is derived from
|
|
// whether the server returned a user (password flow) vs API-key flow.
|
|
type loginResult struct {
|
|
Context string `json:"context"`
|
|
Host string `json:"host"`
|
|
Mode string `json:"mode"` // ModeBearer or ModeAPIKey
|
|
User string `json:"user,omitempty"`
|
|
TenantID uint64 `json:"tenant_id,omitempty"`
|
|
}
|
|
|
|
// saveContextRef writes the context to config.yaml and prints success.
|
|
func saveContextRef(opts *LoginOptions, jopts *cmdutil.JSONOptions, f *cmdutil.Factory, ctx *config.Context, user *sdk.AuthUser) error {
|
|
cfg, err := f.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if cfg.Contexts == nil {
|
|
cfg.Contexts = map[string]config.Context{}
|
|
}
|
|
cfg.Contexts[opts.Context] = *ctx
|
|
cfg.CurrentContext = opts.Context
|
|
if err := config.Save(cfg); err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "save config")
|
|
}
|
|
if jopts.Enabled() {
|
|
result := loginResult{Context: opts.Context, Host: opts.Host, Mode: ModeAPIKey}
|
|
if user != nil {
|
|
result.Mode = ModeBearer
|
|
result.User = user.Email
|
|
result.TenantID = user.TenantID
|
|
}
|
|
return jopts.Emit(iostreams.IO.Out, result)
|
|
}
|
|
who := opts.Context
|
|
if user != nil {
|
|
who = user.Email
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Out, "✓ Logged in to %s as %s (context=%s)\n", opts.Host, who, opts.Context)
|
|
return nil
|
|
}
|
|
|
|
// validateHost rejects empty / non-http URLs early so we surface a clean
|
|
// flag error instead of failing inside the SDK transport.
|
|
func validateHost(host string) error {
|
|
_, err := cmdutil.NormalizeHost(host)
|
|
return err
|
|
}
|
|
|
|
// readStdinTrimmed reads all of r and returns the result with surrounding
|
|
// whitespace stripped. Empty result is returned as-is for the caller to
|
|
// validate.
|
|
func readStdinTrimmed(r io.Reader) (string, error) {
|
|
if r == nil {
|
|
return "", nil
|
|
}
|
|
b, err := io.ReadAll(r)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
return strings.TrimSpace(string(b)), nil
|
|
}
|