mirror of
https://github.com/larksuite/cli.git
synced 2026-07-09 18:34:03 +08:00
* feat(sidecar): add sidecar proxy for sandbox credential isolation
Keep real secrets (app_secret, access_token) out of sandbox environments.
CLI instances inside sandboxes connect to a trusted sidecar process via
HTTP; the sidecar verifies HMAC-signed requests and injects real tokens
before forwarding to the Lark API.
Key components:
- `auth proxy` subcommand to start the sidecar server (build tag: authsidecar)
- Noop credential provider returns sentinel tokens in sidecar mode
- Transport interceptor rewrites requests to sidecar with HMAC signature
- Env provider yields to sidecar provider when AUTH_PROXY is set
- Supports both feishu and lark brand endpoints
* feat(sidecar): implement priority ordering for credential providers
* feat(sidecar): strip client-supplied auth headers and improve shutdown logging
* feat(sidecar): buffer request body to prevent HMAC mismatches on read errors
* feat(sidecar): fix CI
* refactor(sidecar): publish protocol package and move server to reference demo
The sidecar server is no longer shipped as a `lark-cli auth proxy`
subcommand. Instead, the CLI provides only the standard sidecar *client*
(via `-tags authsidecar`), while the wire-protocol utilities are exposed
as a public package for integrators to implement their own server.
Changes:
- Move `internal/sidecar/` → `sidecar/` so external integrators can
import HMAC signing, headers, sentinels and address validators.
- Remove `cmd/auth/proxy.go`, `proxy_stub.go`, `proxy_test.go` and the
conditional registration in `cmd/auth/auth.go`.
- Add `sidecar/server-demo/` — a reference server implementation behind
the `authsidecar_demo` build tag. It reuses the lark-cli credential
pipeline for local development; production integrators are expected
to replace the credential layer with their own secrets source.
- Update all internal imports from `internal/sidecar` to `sidecar`.
Rationale:
- Each integrator has different secrets management / HA / multi-tenant
requirements, so a one-size-fits-all server doesn't belong in the
shipped CLI.
- Keeping the client in-tree guarantees all sandbox-side code stays
protocol-compatible without a second repo to sync.
- The public `sidecar/` package pins the wire protocol as a stable
contract third-party servers must conform to.
Build matrix after this change:
- `go build` → standard CLI, no sidecar code
- `go build -tags authsidecar` → CLI + sidecar client
- `go build -tags authsidecar_demo \
./sidecar/server-demo/` → reference server binary
No production users are affected today because the server was not yet
released; existing sidecar-client users are unchanged.
* feat(sidecar): close 5 pre-release security gaps
- Server: enforce https-only target (no path/query/userinfo), pin
forwardURL to https:// — blocks cleartext token leak
- Protocol v1: canonical now covers version/identity/auth-header,
blocks identity-flip replay within drift window
- Client: ValidateProxyAddr requires loopback or same-host alias,
rejects userinfo and https (interceptor is http-only); cross-machine
is out of scope
- Build: non-authsidecar builds exit(2) when AUTH_PROXY is set,
preventing silent fallback to env credentials
- Demo: whitelist auth-header to Authorization / X-Lark-MCP-{UAT,TAT},
blocks token injection into Cookie / UA / X-Forwarded-For exfil paths
189 lines
4.8 KiB
Go
189 lines
4.8 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
//go:build authsidecar
|
|
|
|
package sidecar
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/larksuite/cli/extension/credential"
|
|
"github.com/larksuite/cli/internal/envvars"
|
|
"github.com/larksuite/cli/sidecar"
|
|
)
|
|
|
|
func setEnv(t *testing.T, key, value string) {
|
|
t.Helper()
|
|
old, hadOld := os.LookupEnv(key)
|
|
os.Setenv(key, value)
|
|
t.Cleanup(func() {
|
|
if hadOld {
|
|
os.Setenv(key, old)
|
|
} else {
|
|
os.Unsetenv(key)
|
|
}
|
|
})
|
|
}
|
|
|
|
func unsetEnv(t *testing.T, key string) {
|
|
t.Helper()
|
|
old, hadOld := os.LookupEnv(key)
|
|
os.Unsetenv(key)
|
|
t.Cleanup(func() {
|
|
if hadOld {
|
|
os.Setenv(key, old)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestResolveAccount_NotActive(t *testing.T) {
|
|
unsetEnv(t, envvars.CliAuthProxy)
|
|
|
|
p := &Provider{}
|
|
acct, err := p.ResolveAccount(context.Background())
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
if acct != nil {
|
|
t.Fatal("expected nil account when AUTH_PROXY not set")
|
|
}
|
|
}
|
|
|
|
func TestResolveAccount_Active(t *testing.T) {
|
|
setEnv(t, envvars.CliAuthProxy, "http://127.0.0.1:16384")
|
|
setEnv(t, envvars.CliProxyKey, "test-key")
|
|
setEnv(t, envvars.CliAppID, "cli_test123")
|
|
setEnv(t, envvars.CliBrand, "lark")
|
|
unsetEnv(t, envvars.CliDefaultAs)
|
|
unsetEnv(t, envvars.CliStrictMode)
|
|
|
|
p := &Provider{}
|
|
acct, err := p.ResolveAccount(context.Background())
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
if acct == nil {
|
|
t.Fatal("expected non-nil account")
|
|
}
|
|
if acct.AppID != "cli_test123" {
|
|
t.Errorf("AppID = %q, want %q", acct.AppID, "cli_test123")
|
|
}
|
|
if acct.Brand != credential.BrandLark {
|
|
t.Errorf("Brand = %q, want %q", acct.Brand, credential.BrandLark)
|
|
}
|
|
if acct.AppSecret != credential.NoAppSecret {
|
|
t.Errorf("AppSecret should be NoAppSecret, got %q", acct.AppSecret)
|
|
}
|
|
if acct.SupportedIdentities != credential.SupportsAll {
|
|
t.Errorf("SupportedIdentities = %d, want %d (SupportsAll)", acct.SupportedIdentities, credential.SupportsAll)
|
|
}
|
|
}
|
|
|
|
func TestResolveAccount_MissingProxyKey(t *testing.T) {
|
|
setEnv(t, envvars.CliAuthProxy, "http://127.0.0.1:16384")
|
|
unsetEnv(t, envvars.CliProxyKey)
|
|
setEnv(t, envvars.CliAppID, "cli_test")
|
|
|
|
p := &Provider{}
|
|
_, err := p.ResolveAccount(context.Background())
|
|
if err == nil {
|
|
t.Fatal("expected error when PROXY_KEY is missing")
|
|
}
|
|
if _, ok := err.(*credential.BlockError); !ok {
|
|
t.Fatalf("expected BlockError, got %T: %v", err, err)
|
|
}
|
|
}
|
|
|
|
func TestResolveAccount_MissingAppID(t *testing.T) {
|
|
setEnv(t, envvars.CliAuthProxy, "http://127.0.0.1:16384")
|
|
setEnv(t, envvars.CliProxyKey, "test-key")
|
|
unsetEnv(t, envvars.CliAppID)
|
|
|
|
p := &Provider{}
|
|
_, err := p.ResolveAccount(context.Background())
|
|
if err == nil {
|
|
t.Fatal("expected error when APP_ID is missing")
|
|
}
|
|
if _, ok := err.(*credential.BlockError); !ok {
|
|
t.Fatalf("expected BlockError, got %T: %v", err, err)
|
|
}
|
|
}
|
|
|
|
func TestResolveAccount_StrictMode(t *testing.T) {
|
|
setEnv(t, envvars.CliAuthProxy, "http://127.0.0.1:16384")
|
|
setEnv(t, envvars.CliProxyKey, "test-key")
|
|
setEnv(t, envvars.CliAppID, "cli_test")
|
|
|
|
tests := []struct {
|
|
mode string
|
|
want credential.IdentitySupport
|
|
}{
|
|
{"bot", credential.SupportsBot},
|
|
{"user", credential.SupportsUser},
|
|
{"off", credential.SupportsAll},
|
|
{"", credential.SupportsAll},
|
|
}
|
|
|
|
p := &Provider{}
|
|
for _, tt := range tests {
|
|
t.Run("strict_"+tt.mode, func(t *testing.T) {
|
|
if tt.mode == "" {
|
|
unsetEnv(t, envvars.CliStrictMode)
|
|
} else {
|
|
setEnv(t, envvars.CliStrictMode, tt.mode)
|
|
}
|
|
acct, err := p.ResolveAccount(context.Background())
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
if acct.SupportedIdentities != tt.want {
|
|
t.Errorf("SupportedIdentities = %d, want %d", acct.SupportedIdentities, tt.want)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestResolveToken_NotActive(t *testing.T) {
|
|
unsetEnv(t, envvars.CliAuthProxy)
|
|
|
|
p := &Provider{}
|
|
tok, err := p.ResolveToken(context.Background(), credential.TokenSpec{Type: credential.TokenTypeUAT})
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
if tok != nil {
|
|
t.Fatal("expected nil token when AUTH_PROXY not set")
|
|
}
|
|
}
|
|
|
|
func TestResolveToken_Sentinels(t *testing.T) {
|
|
setEnv(t, envvars.CliAuthProxy, "http://127.0.0.1:16384")
|
|
setEnv(t, envvars.CliProxyKey, "test-key")
|
|
|
|
p := &Provider{}
|
|
|
|
// UAT
|
|
tok, err := p.ResolveToken(context.Background(), credential.TokenSpec{Type: credential.TokenTypeUAT})
|
|
if err != nil {
|
|
t.Fatalf("UAT: unexpected error: %v", err)
|
|
}
|
|
if tok.Value != sidecar.SentinelUAT {
|
|
t.Errorf("UAT value = %q, want %q", tok.Value, sidecar.SentinelUAT)
|
|
}
|
|
if tok.Scopes != "" {
|
|
t.Errorf("UAT scopes should be empty, got %q", tok.Scopes)
|
|
}
|
|
|
|
// TAT
|
|
tok, err = p.ResolveToken(context.Background(), credential.TokenSpec{Type: credential.TokenTypeTAT})
|
|
if err != nil {
|
|
t.Fatalf("TAT: unexpected error: %v", err)
|
|
}
|
|
if tok.Value != sidecar.SentinelTAT {
|
|
t.Errorf("TAT value = %q, want %q", tok.Value, sidecar.SentinelTAT)
|
|
}
|
|
}
|