docs(security): document security module components#432
Merged
Conversation
Add comprehensive SECURITY_GUIDE.md covering all security module components: - Audit logger: HMAC-signed tamper-evident logging - Log sanitizer: PII/sensitive data masking with built-in and custom patterns - Path validator: Path traversal prevention and filename validation - Secure key storage: Secure key generation, storage, and retrieval - Signal manager: Signal-safe emergency log flushing Includes threat model, architecture diagrams, API documentation, usage examples, and compliance considerations (SOX, HIPAA, GDPR, PCI-DSS). Closes #428
6 tasks
kcenon
added a commit
that referenced
this pull request
Apr 13, 2026
Add comprehensive SECURITY_GUIDE.md covering all security module components: - Audit logger: HMAC-signed tamper-evident logging - Log sanitizer: PII/sensitive data masking with built-in and custom patterns - Path validator: Path traversal prevention and filename validation - Secure key storage: Secure key generation, storage, and retrieval - Signal manager: Signal-safe emergency log flushing Includes threat model, architecture diagrams, API documentation, usage examples, and compliance considerations (SOX, HIPAA, GDPR, PCI-DSS). Closes #428
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
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.
Closes #428
Summary
Added comprehensive security module documentation (
docs/SECURITY_GUIDE.md) covering all 6 security components:audit_logger.h): HMAC-signed tamper-evident logging with JSON format, ISO 8601 timestamps, and OpenSSL 3.x/1.1.x compatibilitylog_sanitizer.h): PII/sensitive data detection and masking (credit cards, SSNs, API keys, passwords, emails, IPs, phone numbers) with custom pattern supportpath_validator.h): Path traversal prevention, symlink validation, and filename character restrictionssecure_key_storage.h): Secure key generation (RAND_bytes), RAII memory management, and 0600 permission enforcementsignal_manager.h,signal_manager_interface.h): Signal-safe emergency log flushing for SIGSEGV/SIGABRT/SIGTERM/SIGINTDocumentation Content
Test Plan