mirror of
https://github.com/larksuite/cli.git
synced 2026-07-06 16:18:05 +08:00
* feat(contentsafety): add extension interface layer with Provider, Alert, and registry Change-Id: Ibeac6366c7201293057bc3b063f75ac34565bcd5 * feat(contentsafety): add normalize utility for JSON type conversion Change-Id: I7d4729a5ddcab2553abc110f8f6ecc88435ae921 * feat(contentsafety): add tree walker and regex scanner Change-Id: I215dad7cf3072711d05e45f7d384162e1f8752d4 * feat(contentsafety): add config loading with lazy creation, default rules, and allowlist matching Change-Id: I75e10df28f1f8d4f433cb2b469a0ff317af3bf70 * feat(contentsafety): add regex provider with config-driven scanning and allowlist Change-Id: I658889b3647cbbbde6881e0c5f7c13887a1eb1d4 * feat(contentsafety): add output core with mode parsing, path normalization, and scan orchestration Change-Id: I1cb9df75f1a4d176d660e2e7a9561314c3787191 * feat(contentsafety): add ScanForSafety entry point and Envelope alert field Change-Id: I5fdb311e1c8d983a35a58667970b9fd3ac729a5c * feat(contentsafety): integrate scanning into shortcut Out() and OutFormat() Change-Id: I33eef1dba14c8a9bd1998857311bdd611f33b916 * feat(contentsafety): integrate scanning into API/service output paths and register provider Change-Id: Ic3981db6c546a19eadea095d82175f92f4783bec * fix(contentsafety): emit stderr notice when lazy-creating default config Change-Id: Ia2491f7a17caceea3125ff9fb58d750dc196d7e7 * style: gofmt factory_default and exitcode Change-Id: I86c5afdfbbdb68d8137f0ca09ef3b5a1139f4b4e * fix(contentsafety): vfs for config I/O, mutex for lazy-create, sort matched rules, emit warn on --output path Change-Id: Ib4982cd54e1bfe0580a0eb03368e6ca818304e1b * fix(contentsafety): isolate scan goroutine errOut to prevent race on timeout Change-Id: Ia5a770d7387ba6d3b7fa318fc5f1384214ea10b7 * fix(contentsafety): deep-normalize typed slices so scanner can walk shortcut data Change-Id: I641e89113d1a2f2285ac6109bd3d7264f5845ea7 * fix(contentsafety): file perms 0600/0700, no result mutation, timeout test, scanTimeout comment Change-Id: Ie45a2e365ee7098e214e94f8871026cc12029d83
133 lines
3.1 KiB
Go
133 lines
3.1 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package output
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"strings"
|
|
"time"
|
|
|
|
extcs "github.com/larksuite/cli/extension/contentsafety"
|
|
"github.com/larksuite/cli/internal/envvars"
|
|
)
|
|
|
|
type mode uint8
|
|
|
|
const (
|
|
modeOff mode = iota
|
|
modeWarn
|
|
modeBlock
|
|
)
|
|
|
|
// scanTimeout caps the content-safety scan so it cannot dominate CLI latency.
|
|
// 100 ms is generous for a regex walk of a typical API response (KB-scale JSON);
|
|
// larger responses hit maxDepth/maxStringBytes well before this fires.
|
|
const scanTimeout = 100 * time.Millisecond
|
|
|
|
// modeFromEnv reads LARKSUITE_CLI_CONTENT_SAFETY_MODE.
|
|
func modeFromEnv(errOut io.Writer) mode {
|
|
raw := strings.TrimSpace(os.Getenv(envvars.CliContentSafetyMode))
|
|
if raw == "" {
|
|
return modeOff
|
|
}
|
|
switch strings.ToLower(raw) {
|
|
case "off":
|
|
return modeOff
|
|
case "warn":
|
|
return modeWarn
|
|
case "block":
|
|
return modeBlock
|
|
default:
|
|
fmt.Fprintf(errOut,
|
|
"warning: unknown %s value %q, falling back to off\n",
|
|
envvars.CliContentSafetyMode, raw)
|
|
return modeOff
|
|
}
|
|
}
|
|
|
|
// normalizeCommandPath converts cobra CommandPath() to dotted form.
|
|
// "lark-cli im +messages-search" -> "im.messages_search"
|
|
func normalizeCommandPath(cobraPath string) string {
|
|
segs := strings.Fields(cobraPath)
|
|
if len(segs) <= 1 {
|
|
return ""
|
|
}
|
|
segs = segs[1:]
|
|
for i, s := range segs {
|
|
s = strings.TrimPrefix(s, "+")
|
|
s = strings.ReplaceAll(s, "-", "_")
|
|
segs[i] = s
|
|
}
|
|
return strings.Join(segs, ".")
|
|
}
|
|
|
|
var errBlocked = fmt.Errorf("content safety blocked")
|
|
|
|
// runContentSafety orchestrates the scan: mode check -> provider -> scan with timeout + panic recovery.
|
|
func runContentSafety(cobraPath string, data any, errOut io.Writer) (*extcs.Alert, error) {
|
|
m := modeFromEnv(errOut)
|
|
if m == modeOff {
|
|
return nil, nil
|
|
}
|
|
|
|
p := extcs.GetProvider()
|
|
if p == nil {
|
|
return nil, nil
|
|
}
|
|
|
|
cmdPath := normalizeCommandPath(cobraPath)
|
|
if cmdPath == "" {
|
|
return nil, nil
|
|
}
|
|
|
|
type result struct {
|
|
alert *extcs.Alert
|
|
err error
|
|
}
|
|
ch := make(chan result, 1)
|
|
ctx, cancel := context.WithTimeout(context.Background(), scanTimeout)
|
|
defer cancel()
|
|
|
|
// Give the goroutine its own writer so it cannot race on errOut after timeout.
|
|
// On success, we copy any provider notices to the real errOut.
|
|
// On timeout, the buffer is owned by the goroutine until it finishes; no shared access.
|
|
scanErrBuf := &bytes.Buffer{}
|
|
go func() {
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
ch <- result{nil, fmt.Errorf("content safety panic: %v", r)}
|
|
}
|
|
}()
|
|
a, e := p.Scan(ctx, extcs.ScanRequest{Path: cmdPath, Data: data, ErrOut: scanErrBuf})
|
|
ch <- result{a, e}
|
|
}()
|
|
|
|
var res result
|
|
select {
|
|
case res = <-ch:
|
|
if scanErrBuf.Len() > 0 {
|
|
_, _ = io.Copy(errOut, scanErrBuf)
|
|
}
|
|
case <-ctx.Done():
|
|
return nil, nil // timeout, fail-open; scanErrBuf stays with the goroutine
|
|
}
|
|
|
|
if res.err != nil {
|
|
fmt.Fprintf(errOut, "warning: content safety scan error: %v\n", res.err)
|
|
return nil, nil // fail-open
|
|
}
|
|
if res.alert == nil {
|
|
return nil, nil
|
|
}
|
|
|
|
if m == modeBlock {
|
|
return res.alert, errBlocked
|
|
}
|
|
return res.alert, nil
|
|
}
|