mirror of
https://github.com/larksuite/cli.git
synced 2026-07-03 14:02:43 +08:00
50b3f0a2af
* feat(platform): support multiple policy rules per plugin
Extend the command policy framework from single-Rule to multi-Rule
semantics. A plugin (or policy.yml) may now contribute several scoped
Rules; the engine combines them with OR -- a command is allowed when it
satisfies every axis of at least one rule. This lets one integration
apply different risk ceilings and identity restrictions to different
command groups.
The cross-plugin fail-closed boundary is preserved: two distinct plugins
both calling Restrict still aborts startup (multiple_restrict_plugins).
Single-Rule behaviour is fully backward compatible -- the rejection
reason_code / rule_name / envelope shape are byte-for-byte unchanged;
multi-rule rejection surfaces the aggregate reason_code no_matching_rule.
- engine: New keeps single-rule compat, add NewSet for OR over rules
- resolver: dedupe by owner (one plugin may contribute many rules),
return []*Rule; yaml gains a top-level rules: list
- registrar/builder/staging: Restrict may be called more than once;
retire the double_restrict error
- config policy show / config plugins show: emit a rules array
- inventory: PluginEntry.Rules is now a slice (fixes last-rule-wins
overwrite when a plugin contributes multiple rules)
* fix(platform): clone rules in Builder.Restrict and inventory snapshot
Address review feedback. Builder.Restrict stored the caller's *Rule
directly, so reusing and mutating one Rule object across multiple
Restrict calls collapsed entries to the last mutation; clone the rule and
its slices on append, mirroring the staging registrar.
BuildInventory likewise reused the source Allow/Deny/Identities slices;
copy them when building the RuleView snapshot instead of relying on
cloneInventory downstream.
Add a regression test: reusing and mutating one Rule across two Restrict
calls now yields two independent rules.
* fix(platform): skip yaml when a plugin owns policy; reject empty rules list
Two policy-config robustness fixes from review:
- A malformed ~/.lark-cli/policy.yml could abort a plugin-governed
binary. applyUserPolicyPruning read yaml before resolving, and
build.go fail-closes on any policy error when a plugin is present.
Plugin rules shadow yaml anyway, so skip reading yaml entirely when a
plugin contributed rules -- an unrelated broken file on the user's
machine can no longer lock the CLI.
- A present-but-empty "rules: []" collapsed to a single all-zero Rule
that allows every annotated command ("looks like policy, enforces
almost nothing"). yaml.Parse now distinguishes absent from
present-but-empty (Rules is a pointer) and rejects the empty list.
Add regression tests for both.
102 lines
3.4 KiB
Go
102 lines
3.4 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package config
|
|
|
|
import (
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/larksuite/cli/internal/cmdutil"
|
|
"github.com/larksuite/cli/internal/output"
|
|
internalplatform "github.com/larksuite/cli/internal/platform"
|
|
)
|
|
|
|
// NewCmdConfigPlugins exposes the plugin inventory diagnostic command.
|
|
//
|
|
// `config policy show` is intentionally focused on the user-layer Rule
|
|
// (Restrict). Plugins also contribute hooks (Observe / Wrap / Lifecycle)
|
|
// that are not policy gates but still mutate the CLI's runtime behaviour.
|
|
// This command surfaces both halves so an operator can answer "what is
|
|
// this binary doing differently from stock lark-cli?" in one place.
|
|
//
|
|
// Like config policy show, the dispatch path is exempt from policy
|
|
// enforcement (see internal/cmdpolicy/diagnostic.go) so it remains
|
|
// usable under any Rule.
|
|
func NewCmdConfigPlugins(f *cmdutil.Factory) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "plugins",
|
|
Hidden: true, // diagnostic-only; kept callable, omitted from --help so it stays out of AI-agent context
|
|
Short: "Inspect installed plugins and their hook contributions",
|
|
// Same leaf-level no-op as config policy: the parent `config`
|
|
// group's PersistentPreRunE requires builtin credential, but
|
|
// this is a read-only diagnostic that must work everywhere.
|
|
PersistentPreRunE: func(c *cobra.Command, _ []string) error {
|
|
c.SilenceUsage = true
|
|
return nil
|
|
},
|
|
}
|
|
cmd.AddCommand(newCmdConfigPluginsShow(f))
|
|
return cmd
|
|
}
|
|
|
|
func newCmdConfigPluginsShow(f *cmdutil.Factory) *cobra.Command {
|
|
cmd := &cobra.Command{
|
|
Use: "show",
|
|
Short: "List successfully installed plugins, their rules, and registered hooks",
|
|
Long: `Print every plugin that committed during bootstrap, including:
|
|
|
|
- name / version / capabilities (FailurePolicy, Restricts, RequiredCLIVersion)
|
|
- rule (when the plugin called r.Restrict)
|
|
- hooks: observers (Before / After), wrappers, lifecycle handlers
|
|
|
|
Hooks are attributed by their namespaced name -- the framework prepends
|
|
the plugin name as the prefix at registration time, so an entry
|
|
"secaudit.audit-pre" belongs to plugin "secaudit".`,
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
return runConfigPluginsShow(f)
|
|
},
|
|
}
|
|
cmdutil.SetRisk(cmd, "read")
|
|
return cmd
|
|
}
|
|
|
|
func runConfigPluginsShow(f *cmdutil.Factory) error {
|
|
inv := internalplatform.GetActiveInventory()
|
|
if inv == nil {
|
|
// Always emit the same field set as the populated branch so
|
|
// AI agents and CI scripts don't have to branch on whether
|
|
// `total` is present. `note` makes the unusual state explicit
|
|
// for human readers.
|
|
output.PrintJson(f.IOStreams.Out, map[string]any{
|
|
"plugins": []any{},
|
|
"total": 0,
|
|
"note": "no inventory recorded; bootstrap did not finish",
|
|
})
|
|
return nil
|
|
}
|
|
|
|
plugins := make([]map[string]any, 0, len(inv.Plugins))
|
|
for _, p := range inv.Plugins {
|
|
entry := map[string]any{
|
|
"name": p.Name,
|
|
"version": p.Version,
|
|
"capabilities": p.Capabilities,
|
|
}
|
|
if len(p.Rules) > 0 {
|
|
entry["rules"] = p.Rules
|
|
}
|
|
entry["hooks"] = map[string]any{
|
|
"observers": p.Observers,
|
|
"wrappers": p.Wrappers,
|
|
"lifecycle": p.Lifecycles,
|
|
"count": len(p.Observers) + len(p.Wrappers) + len(p.Lifecycles),
|
|
}
|
|
plugins = append(plugins, entry)
|
|
}
|
|
output.PrintJson(f.IOStreams.Out, map[string]any{
|
|
"plugins": plugins,
|
|
"total": len(plugins),
|
|
})
|
|
return nil
|
|
}
|