mirror of
https://github.com/larksuite/cli.git
synced 2026-07-04 14:38:53 +08:00
99e314fe0b
Every failure on the authentication, authorization, and configuration
path now surfaces as a typed structured error instead of an ad-hoc
envelope. Users and scripts that consume CLI output get:
- a fixed nine-category taxonomy on the wire, each mapped to a
stable shell exit code (authentication/authorization/config = 3,
network = 4, internal = 5, policy = 6, confirmation = 10)
- identity-aware detail fields (missing_scopes, requested_scopes,
granted_scopes, console_url, log_id, retryable, hint) carried
uniformly on the envelope
- a single canonical policy envelope at exit 6; the legacy
auth_error carve-out is retired
- per-subtype canonical message + hint that preserves Lark's
diagnostic phrasing and routes recovery to the right actor:
app developer (app_scope_not_applied), user (missing_scope,
token_scope_insufficient, user_unauthorized), or tenant admin
(app_unavailable, app_disabled)
- wrong app credentials classify as config/invalid_client whether
surfaced by the Open API endpoint (99991543) or the tenant
access-token mint endpoint (10003 / 10014), instead of
collapsing to a transport error or api/unknown
- local shortcut scope preflight emits the same
authorization/missing_scope envelope (identity + deterministic
missing-scope set) used by the post-call permission path, so AI
consumers read the same structured shape from precheck and from
server-returned permission denial
- streaming download/upload failures keep the same network subtype
split (timeout / TLS / DNS / transport) as the non-stream path
instead of collapsing every cause to a generic transport failure
- console_url is carried only on the bot-perspective
app_scope_not_applied envelope (where the recovery action is
"developer applies the scope at the developer console"); the
user-perspective missing_scope envelope drops the field, since
the only actionable user recovery is `lark-cli auth login --scope`
and pointing an end user at a console they cannot modify is
misleading
- bind workflows (Hermes / OpenClaw / lark-channel) flatten dynamic
Type tags to wire 'config' with the original module name kept
as a metric label
All 10 typed errors are cause-bearing, nil-safe on .Error() and
.Unwrap(), and defensively clone slice setter inputs. Four lint
rules (CheckNilSafeError / CheckBuilderImmutable / CheckUnwrapSymmetry
/ CheckBuildAPIErrorArms) lock these invariants on migrated paths.
92 lines
2.3 KiB
Go
92 lines
2.3 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package auth
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/larksuite/cli/errs"
|
|
larkauth "github.com/larksuite/cli/internal/auth"
|
|
"github.com/larksuite/cli/internal/cmdutil"
|
|
"github.com/larksuite/cli/internal/output"
|
|
)
|
|
|
|
// CheckOptions holds all inputs for auth check.
|
|
type CheckOptions struct {
|
|
Factory *cmdutil.Factory
|
|
Scope string
|
|
}
|
|
|
|
// NewCmdAuthCheck creates the auth check subcommand.
|
|
func NewCmdAuthCheck(f *cmdutil.Factory, runF func(*CheckOptions) error) *cobra.Command {
|
|
opts := &CheckOptions{Factory: f}
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "check",
|
|
Short: "Check if current token has specified scopes",
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
if runF != nil {
|
|
return runF(opts)
|
|
}
|
|
return authCheckRun(opts)
|
|
},
|
|
}
|
|
|
|
cmd.Flags().StringVar(&opts.Scope, "scope", "", "scopes to check (space-separated)")
|
|
cmd.MarkFlagRequired("scope")
|
|
cmdutil.SetRisk(cmd, "read")
|
|
|
|
return cmd
|
|
}
|
|
|
|
func authCheckRun(opts *CheckOptions) error {
|
|
f := opts.Factory
|
|
|
|
required := strings.Fields(opts.Scope)
|
|
if len(required) == 0 {
|
|
return errs.NewValidationError(errs.SubtypeInvalidArgument, "--scope cannot be empty").WithParam("--scope")
|
|
}
|
|
|
|
config, err := f.Config()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if config.UserOpenId == "" {
|
|
output.PrintJson(f.IOStreams.Out, map[string]interface{}{"ok": false, "error": "not_logged_in", "missing": required})
|
|
return output.ErrBare(1)
|
|
}
|
|
|
|
stored := larkauth.GetStoredToken(config.AppID, config.UserOpenId)
|
|
if stored == nil {
|
|
output.PrintJson(f.IOStreams.Out, map[string]interface{}{"ok": false, "error": "no_token", "missing": required})
|
|
return output.ErrBare(1)
|
|
}
|
|
|
|
missing := larkauth.MissingScopes(stored.Scope, required)
|
|
missingSet := make(map[string]bool, len(missing))
|
|
for _, s := range missing {
|
|
missingSet[s] = true
|
|
}
|
|
var granted []string
|
|
for _, s := range required {
|
|
if !missingSet[s] {
|
|
granted = append(granted, s)
|
|
}
|
|
}
|
|
|
|
ok := len(missing) == 0
|
|
result := map[string]interface{}{"ok": ok, "granted": granted, "missing": missing}
|
|
if len(missing) > 0 {
|
|
result["suggestion"] = fmt.Sprintf(`lark-cli auth login --scope "%s"`, strings.Join(missing, " "))
|
|
}
|
|
output.PrintJson(f.IOStreams.Out, result)
|
|
if !ok {
|
|
return output.ErrBare(1)
|
|
}
|
|
return nil
|
|
}
|