prompt_guard.go 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. package securityaudit
  2. import (
  3. "context"
  4. "errors"
  5. "sync"
  6. "time"
  7. )
  8. type GuardEvaluator struct {
  9. scanner PromptScanner
  10. repo JobRepository
  11. metrics Metrics
  12. clock Clock
  13. global chan struct{}
  14. perNodeLimit int
  15. nodeMu sync.Mutex
  16. nodes map[string]chan struct{}
  17. }
  18. func NewGuardEvaluator(scanner PromptScanner, repo JobRepository, metrics Metrics) *GuardEvaluator {
  19. return newGuardEvaluator(scanner, repo, metrics, 64, 16)
  20. }
  21. func newGuardEvaluator(scanner PromptScanner, repo JobRepository, metrics Metrics, globalLimit, perNodeLimit int) *GuardEvaluator {
  22. if globalLimit < 1 {
  23. globalLimit = 64
  24. }
  25. if perNodeLimit < 1 {
  26. perNodeLimit = 16
  27. }
  28. return &GuardEvaluator{scanner: scanner, repo: repo, metrics: metrics, clock: realClock{},
  29. global: make(chan struct{}, globalLimit), perNodeLimit: perNodeLimit, nodes: map[string]chan struct{}{}}
  30. }
  31. func (g *GuardEvaluator) Evaluate(ctx context.Context, cfg ActiveConfig, snapshot PromptSnapshot) (*PromptDecision, error) {
  32. if g == nil || g.scanner == nil {
  33. if g != nil && g.metrics != nil {
  34. g.metrics.Observe(DecisionUnavailable, 0)
  35. }
  36. logGuardFailure(snapshot, cfg, DecisionUnavailable, ErrorCodeUnavailable, "", 0)
  37. return nil, &GuardError{Code: ErrorCodeUnavailable}
  38. }
  39. start := g.clock.Now()
  40. baseFields := snapshotLogFields(snapshot)
  41. baseFields["config_version"] = cfg.ConfigVersion
  42. endpoints := cfg.EnabledEndpoints()
  43. if len(endpoints) == 0 {
  44. if g.metrics != nil {
  45. g.metrics.Observe(DecisionUnavailable, g.clock.Now().Sub(start))
  46. }
  47. logGuardFailure(snapshot, cfg, DecisionUnavailable, ErrorCodeUnavailable, "", g.clock.Now().Sub(start))
  48. return nil, &GuardError{Code: ErrorCodeUnavailable}
  49. }
  50. select {
  51. case g.global <- struct{}{}:
  52. defer func() { <-g.global }()
  53. default:
  54. if g.metrics != nil {
  55. g.metrics.IncBulkheadFull()
  56. g.metrics.Observe(DecisionUnavailable, g.clock.Now().Sub(start))
  57. }
  58. logGuardFailure(snapshot, cfg, DecisionUnavailable, ErrorCodeUnavailable, "", g.clock.Now().Sub(start))
  59. return nil, &GuardError{Code: ErrorCodeUnavailable}
  60. }
  61. timeout := time.Duration(endpoints[0].TimeoutMS) * time.Millisecond
  62. if timeout <= 0 {
  63. timeout = DefaultTimeoutMS * time.Millisecond
  64. }
  65. evalCtx, cancel := context.WithTimeout(ctx, timeout)
  66. defer cancel()
  67. inputLimit := minimumInputLimit(endpoints)
  68. chunks := SplitRunes(snapshot.ScanText, inputLimit)
  69. if len(chunks) == 0 {
  70. if g.metrics != nil {
  71. g.metrics.Observe(DecisionAllow, g.clock.Now().Sub(start))
  72. }
  73. return &PromptDecision{Kind: DecisionAllow, AllowNextStage: true}, nil
  74. }
  75. LogInfo(EventEvaluationStarted, mergeLogFields(baseFields, map[string]any{"chunk_total": len(chunks), "status": "started"}))
  76. results := make([]*NormalizedResult, 0, len(chunks))
  77. for index, chunk := range chunks {
  78. chunkStarted := g.clock.Now()
  79. LogInfo(EventChunkStarted, mergeLogFields(baseFields, map[string]any{
  80. "chunk_index": index + 1, "chunk_total": len(chunks),
  81. "chunk_chars": len([]rune(chunk)), "input_chars": snapshot.PromptLength, "input_limit": inputLimit,
  82. "status": "started",
  83. }))
  84. result, err := g.scanChunk(evalCtx, cfg, endpoints, chunk)
  85. if err != nil {
  86. code := guardErrorCode(err)
  87. LogWarn(EventChunkFailed, mergeLogFields(baseFields, map[string]any{
  88. "chunk_index": index + 1, "chunk_total": len(chunks),
  89. "chunk_chars": len([]rune(chunk)), "input_chars": snapshot.PromptLength, "input_limit": inputLimit,
  90. "latency_ms": g.clock.Now().Sub(chunkStarted).Milliseconds(), "error_code": code, "status": "failed",
  91. }))
  92. kind := DecisionUnavailable
  93. if code == ErrorCodeInvalidResponse {
  94. kind = DecisionInvalid
  95. }
  96. if g.metrics != nil {
  97. g.metrics.Observe(kind, g.clock.Now().Sub(start))
  98. var guardErr *GuardError
  99. if errors.As(err, &guardErr) && guardErr.Timeout {
  100. g.metrics.IncTimeout()
  101. }
  102. }
  103. logGuardFailure(snapshot, cfg, kind, code, "", g.clock.Now().Sub(start))
  104. return nil, err
  105. }
  106. result.ChunkTotal = len(chunks)
  107. results = append(results, result)
  108. LogInfo(EventChunkCompleted, mergeLogFields(baseFields, map[string]any{
  109. "chunk_index": index + 1, "chunk_total": len(chunks),
  110. "chunk_chars": len([]rune(chunk)), "input_chars": snapshot.PromptLength, "input_limit": inputLimit,
  111. "guard_endpoint_id": result.GuardEndpointID, "action": result.Action,
  112. "latency_ms": g.clock.Now().Sub(chunkStarted).Milliseconds(), "status": "completed",
  113. }))
  114. if result.Action == ActionBlock {
  115. break
  116. }
  117. }
  118. aggregated, err := AggregateResults(results, g.clock.Now().Sub(start))
  119. if err != nil {
  120. if g.metrics != nil {
  121. g.metrics.Observe(DecisionInvalid, g.clock.Now().Sub(start))
  122. }
  123. logGuardFailure(snapshot, cfg, DecisionInvalid, ErrorCodeInvalidResponse, "", g.clock.Now().Sub(start))
  124. return nil, &GuardError{Code: ErrorCodeInvalidResponse, Cause: err}
  125. }
  126. aggregated.ChunkTotal = len(chunks)
  127. kind := DecisionAllow
  128. if aggregated.Action == ActionWarn {
  129. kind = DecisionFlag
  130. }
  131. if aggregated.Action == ActionBlock {
  132. kind = DecisionBlock
  133. }
  134. decision := &PromptDecision{Kind: kind, Result: aggregated, AllowNextStage: kind == DecisionAllow || kind == DecisionFlag}
  135. if kind == DecisionBlock {
  136. decision.ErrorCode = ErrorCodeBlocked
  137. }
  138. if g.metrics != nil {
  139. g.metrics.Observe(kind, g.clock.Now().Sub(start))
  140. }
  141. LogInfo(EventChunksAggregated, mergeLogFields(baseFields, map[string]any{
  142. "decision": kind,
  143. "risk_level": aggregated.RiskLevel, "action": aggregated.Action, "chunk_total": aggregated.ChunkTotal,
  144. "latency_ms": aggregated.LatencyMS, "guard_endpoint_id": aggregated.GuardEndpointID, "stage": snapshot.Stage,
  145. "status": "completed",
  146. }))
  147. if g.repo != nil {
  148. if _, recordErr := g.repo.RecordBlocking(ctx, snapshot.Redacted(), cfg.ConfigVersion, aggregated, cfg.StorePassEvents); recordErr != nil {
  149. if g.metrics != nil {
  150. g.metrics.IncRecordFailed()
  151. }
  152. LogWarn(EventResultRecordFailed, mergeLogFields(baseFields, map[string]any{
  153. "decision": kind, "error_code": "result_record_failed", "stage": snapshot.Stage,
  154. "status": "failed",
  155. }))
  156. }
  157. }
  158. if kind == DecisionBlock {
  159. LogWarn(EventGuardBlocked, mergeLogFields(baseFields, map[string]any{
  160. "guard_endpoint_id": aggregated.GuardEndpointID,
  161. "decision": kind, "risk_level": aggregated.RiskLevel, "action": aggregated.Action, "chunk_total": aggregated.ChunkTotal,
  162. "latency_ms": aggregated.LatencyMS, "status": "blocked", "error_code": ErrorCodeBlocked,
  163. "stage": snapshot.Stage, "upstream_dispatched": false, "billing_preconsumed": false,
  164. }))
  165. } else {
  166. LogInfo(EventGuardAllowed, mergeLogFields(baseFields, map[string]any{
  167. "decision": kind, "risk_level": aggregated.RiskLevel, "action": aggregated.Action,
  168. "guard_endpoint_id": aggregated.GuardEndpointID, "chunk_total": aggregated.ChunkTotal,
  169. "latency_ms": aggregated.LatencyMS, "stage": snapshot.Stage, "status": "allowed",
  170. }))
  171. }
  172. return decision, nil
  173. }
  174. func logGuardFailure(snapshot PromptSnapshot, cfg ActiveConfig, kind DecisionKind, code, guardEndpointID string, latency time.Duration) {
  175. fields := snapshotLogFields(snapshot)
  176. fields["config_version"] = cfg.ConfigVersion
  177. LogWarn(EventGuardFailed, mergeLogFields(fields, map[string]any{
  178. "decision": kind, "guard_endpoint_id": guardEndpointID, "latency_ms": latency.Milliseconds(),
  179. "status": "failed", "error_code": code, "upstream_dispatched": false, "billing_preconsumed": false,
  180. }))
  181. }
  182. func (g *GuardEvaluator) scanChunk(ctx context.Context, cfg ActiveConfig, endpoints []ActiveEndpoint, chunk string) (*NormalizedResult, error) {
  183. var lastErr error
  184. for index, endpoint := range endpoints {
  185. semaphore := g.nodeSemaphore(endpoint.ID)
  186. select {
  187. case semaphore <- struct{}{}:
  188. case <-ctx.Done():
  189. return nil, &GuardError{Code: ErrorCodeUnavailable, Retryable: true, Timeout: errors.Is(ctx.Err(), context.DeadlineExceeded), Cause: ctx.Err()}
  190. default:
  191. if g.metrics != nil {
  192. g.metrics.IncBulkheadFull()
  193. }
  194. lastErr = &GuardError{Code: ErrorCodeUnavailable, Retryable: true}
  195. if index < len(endpoints)-1 && g.metrics != nil {
  196. g.metrics.IncFailover()
  197. }
  198. continue
  199. }
  200. result, err := callPromptScanner(ctx, g.scanner, endpoint, chunk, cfg.Scanners)
  201. <-semaphore
  202. if err == nil && result != nil {
  203. return result, nil
  204. }
  205. if err == nil {
  206. err = &GuardError{Code: ErrorCodeInvalidResponse, Retryable: false}
  207. }
  208. lastErr = err
  209. var guardErr *GuardError
  210. if !errors.As(err, &guardErr) || !guardErr.Retryable {
  211. return nil, err
  212. }
  213. if index < len(endpoints)-1 && g.metrics != nil {
  214. g.metrics.IncFailover()
  215. }
  216. }
  217. if lastErr == nil {
  218. lastErr = &GuardError{Code: ErrorCodeUnavailable}
  219. }
  220. return nil, lastErr
  221. }
  222. func callPromptScanner(ctx context.Context, scanner PromptScanner, endpoint ActiveEndpoint, chunk string, scanners []string) (result *NormalizedResult, err error) {
  223. defer func() {
  224. if recover() != nil {
  225. result = nil
  226. err = &GuardError{Code: ErrorCodeUnavailable, Retryable: false}
  227. }
  228. }()
  229. return scanner.Scan(ctx, endpoint, chunk, scanners)
  230. }
  231. func (g *GuardEvaluator) nodeSemaphore(id string) chan struct{} {
  232. g.nodeMu.Lock()
  233. defer g.nodeMu.Unlock()
  234. semaphore := g.nodes[id]
  235. if semaphore == nil {
  236. semaphore = make(chan struct{}, g.perNodeLimit)
  237. g.nodes[id] = semaphore
  238. }
  239. return semaphore
  240. }
  241. func minimumInputLimit(endpoints []ActiveEndpoint) int {
  242. limit := DefaultInputLimit
  243. for index, endpoint := range endpoints {
  244. value := endpoint.InputLimit
  245. if value <= 0 {
  246. value = DefaultInputLimit
  247. }
  248. if index == 0 || value < limit {
  249. limit = value
  250. }
  251. }
  252. return limit
  253. }
  254. func guardErrorCode(err error) string {
  255. var guardErr *GuardError
  256. if errors.As(err, &guardErr) && guardErr.Code != "" {
  257. return guardErr.Code
  258. }
  259. return ErrorCodeUnavailable
  260. }
  261. func pointerLogID(value *int64) int64 {
  262. if value == nil {
  263. return 0
  264. }
  265. return *value
  266. }