Files
larksuite-cli/internal/security/contentsafety/provider.go
MaxHuang22 600fa50517 feat: add configurable content-safety scanning (#606)
* 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
2026-04-23 17:18:29 +08:00

82 lines
1.9 KiB
Go

// Copyright (c) 2026 Lark Technologies Pte. Ltd.
// SPDX-License-Identifier: MIT
package contentsafety
import (
"context"
"io"
"sort"
"sync"
extcs "github.com/larksuite/cli/extension/contentsafety"
"github.com/larksuite/cli/internal/core"
)
// regexProvider implements extcs.Provider using regex rules from config file.
// Config is loaded on every Scan() call (no caching) so changes take
// effect immediately. mu serializes lazy config creation.
type regexProvider struct {
configDir string
mu sync.Mutex
}
func (p *regexProvider) Name() string { return "regex" }
func (p *regexProvider) Scan(ctx context.Context, req extcs.ScanRequest) (*extcs.Alert, error) {
cfg, err := p.loadOrCreate(req.ErrOut)
if err != nil {
return nil, err
}
if !IsAllowlisted(req.Path, cfg.Allowlist) {
return nil, nil
}
if len(cfg.Rules) == 0 {
return nil, nil
}
data := normalize(req.Data)
s := &scanner{rules: cfg.Rules}
hits := make(map[string]struct{})
s.walk(ctx, data, hits, 0)
if len(hits) == 0 {
return nil, nil
}
matched := make([]string, 0, len(hits))
for id := range hits {
matched = append(matched, id)
}
sort.Strings(matched)
return &extcs.Alert{Provider: p.Name(), MatchedRules: matched}, nil
}
// loadOrCreate loads config, creating the default on first use.
// mu serializes creation so concurrent Scan calls don't race on first-use.
func (p *regexProvider) loadOrCreate(errOut io.Writer) (*Config, error) {
cfg, err := LoadConfig(p.configDir)
if err == nil {
return cfg, nil
}
p.mu.Lock()
defer p.mu.Unlock()
// Re-check after acquiring the lock (another goroutine may have created it).
cfg, err = LoadConfig(p.configDir)
if err == nil {
return cfg, nil
}
if errC := EnsureDefaultConfig(p.configDir, errOut); errC != nil {
return nil, err
}
return LoadConfig(p.configDir)
}
func init() {
extcs.Register(&regexProvider{
configDir: core.GetConfigDir(),
})
}