docs: align docs with code + alignment regression guard#3
Merged
Conversation
…jection, counts) Fix documentation claims that drifted from the actual code, found via a doc-vs-code alignment audit (read-only, evidence cross-checked): - README/README_zh Security Pipeline: exact-value redaction runs before PII redaction and is the first response-side filter; note untrusted/system-prompt guards are constructed but not in the default policy. - README_zh §2.3: compat port routing requires AEGIS_COMPAT_ALLOWED_PORTS (empty = fail-closed 403), matching the English README. - README_zh §5.2: tool_call_injection default action is `review`, not an unconditional force-block (action_map.injection_detector.tool_call_injection). - README_zh tool_call_guard wording: file-write tools skip only path-reference rules; bash/shell are dangerous-tool-name flagged (default review) and still fully scanned. Pattern counts corrected (~26 tool_call_injection, ~10 command). - SKILL.md: v2 requires AEGIS_V2_TARGET_ALLOWLIST (empty = deny-all); register response example includes whitelist_key. - config/README.md: system_prompt_guard is neither listed in default.yaml nor enabled by its flag (corrected the example). - OTHER_TERMINAL_CLIENTS_USAGE.md: /v1/messages is native to the v1 adapter. Docs only; no code or behavior change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Pin the facts user-facing docs rely on so future drift fails CI instead of a manual audit: concrete filter-class count (13), compat model whitelist appears in both READMEs, and tool_call_injection default action stays `review`. Track the new test via the .gitignore whitelist (aegisgate/tests/* is ignored). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Scope
README.md,README_zh.md,SKILL.md,config/README.md,OTHER_TERMINAL_CLIENTS_USAGE.md) + new testaegisgate/tests/test_doc_alignment.py+.gitignorewhitelist.Security Impact
Security details
tool_call_injectionis documented as defaultreview(was wrongly listed as unconditional force-block). Behavior was alreadyreviewinsecurity_filters.yaml; only the doc now matches.Confirmation Flow Changes
RAG and Poisoning Controls
Config and Compatibility
AEGIS_COMPAT_ALLOWED_PORTSempty=deny,AEGIS_V2_TARGET_ALLOWLISTempty=deny).Testing
Targeted tests
pytest aegisgate/tests/test_doc_alignment.py -qFull test suite
pytest aegisgate/tests/ --collect-only -q(collection sanity; full run not executed in this session).test_multipart_routesfailures noted previously; untouched by this change.Observability
Rollback Plan
Release Notes (copy-ready)