feat: add --siem flag to security-audit report for NDJSON export#1905
Open
jlima8900 wants to merge 4 commits intoKeeper-Security:masterfrom
Open
feat: add --siem flag to security-audit report for NDJSON export#1905jlima8900 wants to merge 4 commits intoKeeper-Security:masterfrom
jlima8900 wants to merge 4 commits intoKeeper-Security:masterfrom
Conversation
Adds NDJSON output for SIEM ingestion (Splunk, Elastic, Datadog). - --siem flag produces one JSON object per line - Rejects --siem + --record-details combination - Warns when --siem overrides explicit --format - Empty reports produce empty output - security_score field only emitted in non-BreachWatch mode - Output file written with 0o600 permissions
Address PR Keeper-Security#1876 review from @aaunario-keeper: - --siem + --format now raises CommandError instead of silently ignoring the format flag, making the override explicit in the CLI contract - Add clarifying parentheses on empty-report ternary to make precedence obvious (behavior unchanged — empty list already produced '')
Address review feedback: - Reject --siem + --record-details combination with clear error - Reject --siem + --format combination (SIEM is NDJSON-only) - Fix empty report producing blank line instead of empty output - Mask sensitive fields in SIEM NDJSON output (CodeQL finding)
- Add os.fchmod(fd, 0o600) to ensure existing files get restrictive permissions (os.open mode only applies on creation) - Add 25 tests covering NDJSON format, PII masking, risk factors, empty report handling, file permissions, flag validation, and BreachWatch mode
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
Adds SIEM-ready output to
security-audit reportusing NDJSON format (one JSON event per line). The existingaudit-logcommand has SIEM export (Splunk, syslog, Sumo, Azure) for event streams, but the security-audit report had no machine-readable output.Test plan