Spaces:
Runtime error
Runtime error
File size: 17,314 Bytes
02422e3 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 | """
sidecar/app.py β GenAI Shield V2 Sidecar Proxy (FastAPI).
A language-agnostic sidecar that sits in front of any LLM API and provides:
β’ Pre-inference guard (Prompt Guard model + regex) β runs in parallel with LLM
β’ Sentence-level streaming β users see output word-by-word
β’ Post-inference monitoring β each sentence checked concurrently in background
β’ Block signal mid-stream β if output turns harmful, client is notified instantly
Endpoints
---------
POST /v1/chat β streaming or blocking chat with full shield
GET /v1/health β liveness probe
GET /v1/stats β guard model statistics
GET /v1/metrics β last-request latency breakdown
SSE Event Schema (stream=true)
-------------------------------
{ "type": "chunk", "text": "..." }
{ "type": "sentence", "text": "...", "sentence_id": 1 }
{ "type": "block_signal", "sentence_id": 3, "reason": "...", "threat_score": 85, "flags": [...] }
{ "type": "done", "threat_score": 5, "flags": [], "latency_ms": 420,
"guard_ms": 98, "sentences": 4 }
{ "type": "blocked", "reason": "...", "threat_score": 100, "flags": [...],
"pg_score": 0.97, "guard_ms": 102 }
Configure via environment variables (see sidecar/config.py).
"""
import json
import logging
import os
import sys
import time
from pathlib import Path
from typing import AsyncGenerator, Optional
import uvicorn
from fastapi import FastAPI, HTTPException, Request
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import FileResponse, StreamingResponse
from fastapi.staticfiles import StaticFiles
from pydantic import BaseModel
# ββ Path fix so imports work from project root ββββββββββββββββββββββββββββββββ
_ROOT = Path(__file__).parent.parent
if str(_ROOT) not in sys.path:
sys.path.insert(0, str(_ROOT))
from sidecar.config import (
GATE_GUARD_TIMEOUT_SEC,
GEMINI_API_KEY,
GEMINI_MODEL,
LLM_BACKEND,
LOG_LEVEL,
MONITOR_BLOCK_THRESHOLD,
MONITOR_WORKERS,
OPENAI_API_KEY,
OPENAI_BASE_URL,
OPENAI_MODEL,
PROMPT_GUARD_MODEL_DIR,
SENTENCE_MIN_CHARS,
SIDECAR_HOST,
SIDECAR_PORT,
SYSTEM_PROMPT,
)
from sidecar.gate import BlockEvent, ShieldGate, TokenEvent
from sidecar.sentence_splitter import SentenceEvent, SentenceSplitter
from sidecar.stream_monitor import BlockSignal, StreamMonitor
from sidecar.pipeline_events import RequestTrace, subscribe, unsubscribe
# Existing shield modules
from prompt_guard_engine import PromptGuardEngine
from prompt_guard_text_guard import PromptGuardTextGuard
from text_monitor import TextMonitor
# ββ Logging βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
logging.basicConfig(
level = getattr(logging, LOG_LEVEL.upper(), logging.INFO),
format = "[%(asctime)s] %(levelname)-8s %(name)s β %(message)s",
datefmt = "%H:%M:%S",
)
log = logging.getLogger("sidecar")
# ββ FastAPI app βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
app = FastAPI(
title = "GenAI Shield Sidecar",
description = "Transparent LLM proxy with pre/post-inference security screening",
version = "2.0.0",
)
app.add_middleware(
CORSMiddleware,
allow_origins = ["*"],
allow_methods = ["*"],
allow_headers = ["*"],
)
# Serve static files if the sidecar runs standalone
_STATIC_DIR = _ROOT / "static"
_TEMPLATES_DIR = _ROOT / "templates"
if _STATIC_DIR.exists():
app.mount("/static", StaticFiles(directory=str(_STATIC_DIR)), name="static")
# ββ Initialise shield components ββββββββββββββββββββββββββββββββββββββββββββββ
log.info("Loading Prompt Guard engine...")
_PG_ENGINE = PromptGuardEngine(model_path=Path(PROMPT_GUARD_MODEL_DIR)).load()
_GUARD = PromptGuardTextGuard(_PG_ENGINE)
log.info("Prompt Guard ready.")
# ββ Initialise LLM adapter ββββββββββββββββββββββββββββββββββββββββββββββββββββ
if LLM_BACKEND == "openai":
from openai_adapter import OpenAIAdapter
_ADAPTER = OpenAIAdapter(
api_key = OPENAI_API_KEY,
base_url = OPENAI_BASE_URL,
model = OPENAI_MODEL,
system_prompt = SYSTEM_PROMPT,
)
else:
from gemini_adapter import GeminiAdapter
_ADAPTER = GeminiAdapter(
api_key = GEMINI_API_KEY,
model_name = GEMINI_MODEL,
system_prompt = SYSTEM_PROMPT,
)
log.info("LLM adapter: %s (%s)", LLM_BACKEND, _ADAPTER.get_model_name())
# ββ Shared monitor (stateful β tracks behavioural drift across requests) ββββββ
_TEXT_MONITOR = TextMonitor(_ADAPTER, system_prompt=SYSTEM_PROMPT)
_STREAM_MONITOR = StreamMonitor(_TEXT_MONITOR, block_threshold=MONITOR_BLOCK_THRESHOLD, max_workers=MONITOR_WORKERS)
# ββ Last-request metrics (lightweight, single-threaded access via asyncio) ββββ
_LAST_METRICS: dict = {}
# ββ Request schema ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
class ChatRequest(BaseModel):
prompt: str
stream: bool = True
system_prompt: Optional[str] = None
source: Optional[str] = "sidecar"
# ββ Routes ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
@app.get("/")
async def root():
"""Serve the sidecar streaming UI (standalone mode)."""
ui_file = _TEMPLATES_DIR / "sidecar.html"
if ui_file.exists():
return FileResponse(str(ui_file), media_type="text/html")
return {"message": "GenAI Shield Sidecar", "docs": "/docs"}
@app.get("/dataflow")
async def dataflow_ui():
"""Serve the real-time data flow visualization dashboard."""
ui_file = _TEMPLATES_DIR / "dataflow.html"
if ui_file.exists():
return FileResponse(str(ui_file), media_type="text/html")
return {"message": "dataflow.html not found"}
@app.get("/v1/pipeline-stream")
async def pipeline_stream():
"""
SSE stream of structured pipeline telemetry events.
The data flow dashboard subscribes here to get real-time stage data.
"""
async def _gen():
import asyncio
q = subscribe()
try:
while True:
try:
# Poll queue with a short timeout so we can yield keepalives
payload = q.get_nowait()
yield f"data: {json.dumps(payload)}\n\n"
except Exception:
# No event β send keepalive comment
yield ": keepalive\n\n"
await asyncio.sleep(0.5)
except asyncio.CancelledError:
pass
finally:
unsubscribe(q)
return StreamingResponse(
_gen(),
media_type = "text/event-stream",
headers = {"Cache-Control": "no-cache", "X-Accel-Buffering": "no"},
)
@app.get("/v1/health")
async def health():
return {
"status": "ok",
"guard_ready": _PG_ENGINE.ready,
"model": _ADAPTER.get_model_name(),
"backend": LLM_BACKEND,
}
@app.get("/v1/stats")
async def stats():
return _PG_ENGINE.stats()
@app.get("/v1/metrics")
async def metrics():
return _LAST_METRICS or {"message": "No requests processed yet"}
@app.post("/v1/chat")
async def chat(req: ChatRequest):
"""
Main chat endpoint.
- stream=true β Server-Sent Events (SSE) with sentence-level output
- stream=false β Blocking JSON response (legacy-compatible)
"""
if not req.prompt.strip():
raise HTTPException(status_code=400, detail="Empty prompt")
sys_prompt = req.system_prompt or SYSTEM_PROMPT
if req.stream:
return StreamingResponse(
_stream_handler(req.prompt, sys_prompt, req.source or "sidecar"),
media_type = "text/event-stream",
headers = {
"Cache-Control": "no-cache",
"X-Accel-Buffering": "no", # disable nginx buffering
},
)
else:
return await _blocking_handler(req.prompt, sys_prompt, req.source or "sidecar")
# ββ Streaming handler βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
async def _stream_handler(
prompt: str,
sys_prompt: str,
source: str,
) -> AsyncGenerator[str, None]:
"""
Full streaming pipeline:
Gate (guard β₯ LLM) β SentenceSplitter β StreamMonitor (background)
"""
t_total = time.perf_counter()
gate = ShieldGate(_GUARD, _ADAPTER, guard_timeout_sec=GATE_GUARD_TIMEOUT_SEC)
splitter = SentenceSplitter(min_chars=SENTENCE_MIN_CHARS)
_STREAM_MONITOR.reset()
# ββ Telemetry trace for this request ββββββββββββββββββββββββββββββββββ
trace = RequestTrace()
trace.on_request_in(prompt)
guard_ms_ref = 0.0
all_flags: list = []
threat_score = 0
block_fired = False
sentences_sent = 0
total_tokens = 0
def sse(event_dict: dict) -> str:
"""Format a dict as an SSE data line."""
return f"data: {json.dumps(event_dict)}\n\n"
async for gate_event in gate.run(prompt, sys_prompt, trace=trace):
# ββ Guard blocked the prompt βββββββββββββββββββββββββββββββββββββββ
if isinstance(gate_event, BlockEvent):
all_flags = gate_event.flags
threat_score = gate_event.threat_score
guard_ms_ref = gate_event.guard_ms
yield sse({
"type": "blocked",
"reason": gate_event.reason,
"threat_score": gate_event.threat_score,
"flags": gate_event.flags,
"pg_score": gate_event.pg_score,
"guard_ms": gate_event.guard_ms,
})
block_fired = True
break
# ββ LLM token received βββββββββββββββββββββββββββββββββββββββββββββ
if isinstance(gate_event, TokenEvent):
total_tokens += 1
splitter_events = splitter.feed(gate_event.text)
for ev in splitter_events:
if isinstance(ev, type(ev)) and ev.type == "chunk":
yield sse({"type": "chunk", "text": ev.text})
elif ev.type == "sentence":
sentences_sent += 1
trace.on_sentence_ready(ev.sentence_id, ev.text)
yield sse({
"type": "sentence",
"text": ev.text,
"sentence_id": ev.sentence_id,
})
# Submit to background monitor (non-blocking)
trace.on_monitor_start(ev.sentence_id)
await _STREAM_MONITOR.submit(ev.sentence_id, ev.text, prompt)
if block_fired:
total_ms = round((time.perf_counter() - t_total) * 1000, 2)
trace.on_request_done(threat_score, all_flags, blocked=True)
_update_metrics(threat_score, all_flags, guard_ms_ref, 0, 0, total_ms)
return
# ββ Stream ended β flush remaining buffer ββββββββββββββββββββββββββββββ
for ev in splitter.flush():
sentences_sent += 1
trace.on_sentence_ready(ev.sentence_id, ev.text)
yield sse({"type": "sentence", "text": ev.text, "sentence_id": ev.sentence_id})
trace.on_monitor_start(ev.sentence_id)
await _STREAM_MONITOR.submit(ev.sentence_id, ev.text, prompt)
trace.on_stream_done(total_tokens, sentences_sent)
# ββ Collect background monitor results βββββββββββββββββββββββββββββββββ
signals = await _STREAM_MONITOR.collect(timeout=1.5)
for sig in signals:
threat_score = max(threat_score, sig.threat_score)
all_flags.extend(sig.flags)
trace.on_monitor_result(sig.sentence_id, sig.threat_score, sig.flags, blocked=True)
yield sse({
"type": "block_signal",
"sentence_id": sig.sentence_id,
"reason": sig.reason,
"threat_score": sig.threat_score,
"flags": sig.flags,
})
total_ms = round((time.perf_counter() - t_total) * 1000, 2)
trace.on_request_done(threat_score, list(set(all_flags)), blocked=False)
yield sse({
"type": "done",
"threat_score": threat_score,
"flags": list(set(all_flags)),
"latency_ms": total_ms,
"sentences": sentences_sent,
})
_update_metrics(threat_score, all_flags, 0, 0, total_ms, total_ms)
# ββ Blocking handler (non-streaming, backward-compatible) βββββββββββββββββββββ
async def _blocking_handler(prompt: str, sys_prompt: str, source: str) -> dict:
"""
Non-streaming path β guard first, then full LLM call, then monitor.
Compatible with existing /genai-chat behaviour.
"""
import asyncio
t_start = time.perf_counter()
# Guard (in thread β synchronous)
loop = asyncio.get_event_loop()
guard_result = await loop.run_in_executor(None, _GUARD.screen, prompt)
guard_ms = round((time.perf_counter() - t_start) * 1000, 2)
pg_score = guard_result.get("checks", {}).get("prompt_guard", {}).get("malicious_score", 0.0)
if guard_result["blocked"]:
return {
"blocked": True,
"response": None,
"reason": guard_result["reason"],
"threat_score": guard_result["threat_score"],
"flags": guard_result["flags"],
"pg_score": pg_score,
"latency_breakdown": {"guard_ms": guard_ms, "model_ms": 0, "monitor_ms": 0},
}
# LLM call (blocking adapter)
t_model = time.perf_counter()
response = await loop.run_in_executor(None, _ADAPTER.chat, prompt, sys_prompt)
model_ms = round((time.perf_counter() - t_model) * 1000, 2)
# Post-monitor
t_monitor = time.perf_counter()
mon_result = await loop.run_in_executor(None, _TEXT_MONITOR.analyze, prompt, response)
monitor_ms = round((time.perf_counter() - t_monitor) * 1000, 2)
total_ms = round(guard_ms + model_ms + monitor_ms, 2)
threat_score = max(guard_result["threat_score"], mon_result["threat_score"])
all_flags = guard_result["flags"] + mon_result["flags"]
_update_metrics(threat_score, all_flags, guard_ms, model_ms, monitor_ms, total_ms)
return {
"blocked": False,
"response": response,
"threat_score": threat_score,
"flags": all_flags,
"pg_score": pg_score,
"latency_ms": total_ms,
"model": _ADAPTER.get_model_name(),
"latency_breakdown": {
"guard_ms": guard_ms,
"model_ms": model_ms,
"monitor_ms": monitor_ms,
},
}
# ββ Metrics helper βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
def _update_metrics(threat_score, flags, guard_ms, model_ms, monitor_ms, total_ms):
global _LAST_METRICS
_LAST_METRICS = {
"threat_score": threat_score,
"flags": flags,
"guard_ms": guard_ms,
"model_ms": model_ms,
"monitor_ms": monitor_ms,
"total_ms": total_ms,
"model": _ADAPTER.get_model_name(),
"timestamp": time.strftime("%H:%M:%S"),
}
# ββ Entry point βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
if __name__ == "__main__":
log.info("Starting GenAI Shield Sidecar on %s:%d", SIDECAR_HOST, SIDECAR_PORT)
uvicorn.run(
"sidecar.app:app",
host = SIDECAR_HOST,
port = SIDECAR_PORT,
log_level = LOG_LEVEL.lower(),
reload = False,
)
|