[WIP] Add secure error and exception handling framework#3035
Draft
mathur07 wants to merge 1 commit intotektoncd:mainfrom
Draft
[WIP] Add secure error and exception handling framework#3035mathur07 wants to merge 1 commit intotektoncd:mainfrom
mathur07 wants to merge 1 commit intotektoncd:mainfrom
Conversation
Implements secure error handling utilities to prevent sensitive information leakage through error messages, logs, and Kubernetes events. This addresses SRVKP-4185 T159 requirements for secure error handling: - Centralized error message generation and handling - Automatic sanitization of sensitive data (passwords, tokens, API keys, secrets) - Generic error messages that don't reveal internal system details - Secure logging with debug-level internal details - Error categorization for better classification - Integration with Kubernetes reconcilers and event recording Components added: - pkg/common/secerrors: Core secure error handling package - SecureError type with user/internal message separation - Automatic pattern-based sanitization (passwords, tokens, keys, etc.) - Error categories (authentication, authorization, configuration, etc.) - Secure logging utilities with zap integration - ReconcilerErrorHandler for consistent reconciler error handling - Comprehensive test coverage (100% of core functions) - Documentation: - docs/SecureErrorHandling.md: Complete usage guide and best practices - docs/SecureErrorHandlingExamples.md: Real-world code examples - docs/SecureErrorHandling_ReconcilerUpdateExample.md: Migration guide - pkg/common/secerrors/README.md: Package documentation Features: - Detects and redacts: passwords, API keys, tokens, secrets, private keys, AWS keys, JWT tokens, credentials in URLs, base64-encoded secrets - Preserves error chains for errors.Is() and errors.As() compatibility - Pre-defined common errors for reuse - Zero dependencies beyond existing project dependencies All tests passing with no linter errors. Future work: Update existing reconcilers to use secure error handling (tracked separately). Signed-off-by: Shubham Mathur <shumathu@redhat.com>
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
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.
Implements secure error handling utilities to prevent sensitive information leakage through error messages, logs, and Kubernetes events.
This addresses SRVKP-4185 T159 requirements for secure error handling:
Components added:
pkg/common/secerrors: Core secure error handling package
Documentation:
Features:
All tests passing with no linter errors.
Future work: Update existing reconcilers to use secure error handling (tracked separately).
Changes
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
make test lintbefore submitting a PRSee the contribution guide for more details.
Release Notes