Skip to content

Commit 018aee1

Browse files
committed
Remove unnecessary section
1 parent d9a6f25 commit 018aee1

File tree

1 file changed

+0
-43
lines changed

1 file changed

+0
-43
lines changed

processor/redactionprocessor/README.md

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -170,23 +170,6 @@ are `md5`, `sha1`, `sha3` (SHA-256), `hmac-sha256`, and `hmac-sha512`.
170170

171171
For enhanced security, especially when dealing with low-entropy data like IP addresses, HMAC (Hash-based Message Authentication Code) hash functions are recommended over simple hash functions like MD5, SHA1, or SHA3.
172172

173-
**Why HMAC?**
174-
175-
Simple hash functions are vulnerable to rainbow table attacks for low-entropy data:
176-
- IPv4 address space: only 2^32 ≈ 4.3 billion possible values
177-
- Attackers can pre-compute all possible IPv4 hashes to reverse the hashing
178-
179-
HMAC uses a secret key, making it practically impossible to:
180-
- Reverse-engineer the original value without the key
181-
- Use pre-computed rainbow tables
182-
- Brute-force the hash even if the algorithm is known
183-
184-
**Benefits:**
185-
- ✅ Consistency: Same input + same key = same output (required for pattern analysis)
186-
- ✅ Irreversibility: Cannot reverse without the secret key
187-
- ✅ Rainbow table resistant: Pre-computed hash tables are useless
188-
- ✅ GDPR compliant: Meets true pseudonymization requirements per Article 4(5)
189-
190173
**Configuration Example:**
191174

192175
```yaml
@@ -218,32 +201,6 @@ export REDACTION_SECRET_KEY=$(openssl rand -hex 32)
218201
# Never commit keys to version control!
219202
```
220203

221-
**Security Notes:**
222-
- Use at least 256-bit (32-byte) random keys for HMAC-SHA256
223-
- Use at least 512-bit (64-byte) random keys for HMAC-SHA512
224-
- Store keys separately from log data
225-
- Rotate keys periodically according to your security policy
226-
- Document which key version was used for each time period
227-
- HMAC-SHA256 provides sufficient security for most use cases
228-
- HMAC-SHA512 offers additional security margin with minimal performance cost (~10-20% CPU overhead vs simple hashes)
229-
230-
**Key Validation:**
231-
232-
The processor automatically validates HMAC keys at startup:
233-
- HMAC-SHA256 requires keys of at least 32 bytes (256 bits)
234-
- HMAC-SHA512 requires keys of at least 64 bytes (512 bits)
235-
- Empty keys are not allowed when HMAC hash functions are configured
236-
- Configuration will fail if the key doesn't meet minimum requirements
237-
238-
This ensures that weak keys cannot be used accidentally, maintaining the security guarantees of HMAC hashing.
239-
240-
**GDPR Compliance:**
241-
242-
HMAC satisfies GDPR Article 4(5) pseudonymization requirements:
243-
- Without the key, personal data cannot be attributed to a specific data subject
244-
- Provides technical measures to ensure data protection
245-
- Key and data are stored separately
246-
247204
The `url_sanitizer` configuration enables sanitization of URLs in specified attributes by removing potentially sensitive information like UUIDs, timestamps, and other non-essential path segments. This is particularly useful for reducing cardinality in telemetry data while preserving the essential parts of URLs for troubleshooting.
248205

249206
### Span Name Sanitization

0 commit comments

Comments
 (0)