feat: Add --redact-body-fields option to prevent credentials in tapes #655
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
Add
--redact-body-fieldsCLI option to redact sensitive JSON fields in request and response bodies during tape recording. This prevents credentials like passwords, tokens, and API keys from being written to disk.What was done
Implemented body field redaction in Proxay core:
1. CLI Option
2. Implementation Details
src/persistence.ts(redaction before serialization)XXXX(matches existing--redact-headerspattern)3. Example
Before redaction:
{"email": "[email protected]", "password": "secret123"}After redaction:
{"email": "[email protected]", "password": "XXXX"}Changes
Core Files
src/cli.ts- Added--redact-body-fieldsoptionsrc/server.ts- Wired option to Persistence layersrc/persistence.ts- Implemented redaction logicredactBodyFields()- Main entry pointredactBufferFields()- JSON parsing and Buffer conversionredactObjectFields()- Recursive field redactionTests Added (9 comprehensive tests)