getsentry / getsentry/sentry-java

Sanitize SQL queries

未关闭
#6,019 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Feature Java Platform: Java Spans
主要语言
Kotlin
星标
1.4k
派生
478
平均合并
2 天 23 小时
30 天内合并 PR
67

描述

### Problem Statement

Our JDBC and Android SQLite integrations currently use caller-provided SQL directly as the span description. If a customer interpolates values instead of using placeholders, literals and comments can contain PII, credentials, or other sensitive data and are sent to Sentry. The Java SDK has no SQL sanitizer today.

### Solution Brainstorm

Introduce a shared internal SQL analyzer used by sentry-jdbc and sentry-android-sqlite.

Requirements:
- Sanitize every statement, including prepared-statement text.
- Replace literal values with placeholders while preserving SQL structure and existing parameter markers.
- Remove or redact line and block comments.
- Handle database dialect differences conservatively.
- Never fall back to, attach, or log the original query if analysis fails; fail closed to safe structural metadata.
- Use sanitized query text as the transaction-based span description.
- Cover JDBC, SupportSQLiteOpenHelper, and SQLiteDriver instrumentation.
- Add malformed-input, dialect, secret-canary, fuzz/robustness, and performance tests.

OpenTelemetry Java's Apache-2.0 JFlex `SqlSanitizerWithSummary.jflex` is strong prior art and can likely be adapted, but should not be vendored unchanged: OTel preserves comments, may skip sanitization for prepared statements, and preserves unknown fragments. Vendoring requires source attribution and a THIRD_PARTY_NOTICES.md entry.

贡献指南

打开贡献指南

调研方向

Locate the sentry-jdbc and sentry-android-sqlite instrumentation, including the SupportSQLiteOpenHelper and SQLiteDriver entry points, and review OpenTelemetry Java's SqlSanitizerWithSummary.jflex as prior art. Done means all statements produce safe structural span descriptions without exposing literals or comments, with malformed-input, dialect, secret-canary, fuzz/robustness, and performance coverage.

由索引模型根据 Issue 内容生成。

评估

技术栈
android, java, kotlin, sql, sqlite
领域
databases, observability, security
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
活跃
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。