Skip to content

[DATASEC-330] Scrub scanning rules - #56761

Open
aimenebelfodil wants to merge 8 commits into
mainfrom
aimene.belfodil/datasec-330/hide-sds-rules-from-integration-configs
Open

aimenebelfodil wants to merge 8 commits into
mainfrom
aimene.belfodil/datasec-330/hide-sds-rules-from-integration-configs

Conversation

@aimenebelfodil

@aimenebelfodil aimenebelfodil commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

What does this PR do?

  • Masks the regex (pattern) of each SDS rule in the datasecurity check scanning_rules wherever the Agent scrubs configs. Other rule fields are kept, and pattern keys outside scanning_rules (e.g. log_processing_rules) are left untouched.
  • Fixes an existing leak: connection passwords (password, ssl_password) were not scrubbed in the trace-level scheduling log, because the Data Security check instance was scheduled as compact JSON instead of YAML, so the Agent's YAML-based scrubbers never applied.

Details

  • Data Security provider schedules YAML (checkInstance.toYAML): marshals through JSON (rules are raw JSON, forwarded as-is), then round-trips to YAML like other providers. Rules decode identically in the check (checked on the full RC rule set).
  • Two default replacers in pkg/util/scrubber/default.go:
    • scanningRulesYaml (object-based): exercised by the reported integration config (instance_config), agent configcheck and flare YAML files. Masks every pattern under scanning_rules.
      scanning_rules:
        - id: rule-1
          pattern: "********"   # was '\d+'
    • scanningRulesPatternReplacer (text): exercised by the trace-level scheduling log, which prints the instance as single-line YAML via conf.Dump(false) (autoconfig.go#L820-L829). On lines containing scanning_rules, masks from pattern: to the end of the line.
      ...scanning_rules:\n    - id: rule-1\n      pattern: '\\d{6}'\ntask_id: t\n")  ->  ...scanning_rules:\n    - id: rule-1\n      pattern: "********"
      

Motivation

SDS scanning rule patterns are Datadog IP. They are sent to the Agent through Remote Config to run the Data Security scan, but they must never be output or shown: not in logs, not in the CLI, and not reported back as part of the integration config.

Describe how you validated your changes

Tested with the CI-generated Agent Docker image from this PR (image registry.ddbuild.io/ci/datadog-agent/agent:v139460438-2db1d6e0-7-amd64), with a Data Security scan task sent through Remote Config against a Postgres instance.

agent configcheck

agent configcheck datasecurity

Each rule pattern is replaced by "********" (alongside the already-scrubbed password/ssl_password), while the other rule fields and the rest of the instance config are still shown.

Resulting agent configcheck datasecurity output
=== datasecurity check ===
Configuration provider: file
Configuration source: file:/etc/datadog-agent/conf.d/datasecurity.d/conf.yaml
Config for instance ID: datasecurity:367ed38a1d347940
min_collection_interval: 0
scan_data:
  - connection:
      dbname: dbm
      host: dbm-postgres
      password: "********"
      port: 5432
      ssl: verify-full
      ssl_cert: /etc/datadog-agent/certs/client.crt
      ssl_key: /etc/datadog-agent/certs/client.key
      ssl_password: "********"
      ssl_root_cert: /etc/datadog-agent/certs/ca.crt
      username: datadog
    entity:
      database: dbm
      database_cluster_name: local-dev-cluster
      database_instance_name: local-dev-instance
      platform: postgres
      schema: public
      table: users
    query: SELECT * FROM users
    sub_task_id: jKb-Dpc-DwU
    timeout_seconds: 30
  - connection:
      dbname: dbm
      host: dbm-postgres
      password: "********"
      port: 5432
      ssl: verify-full
      ssl_cert: /etc/datadog-agent/certs/client.crt
      ssl_key: /etc/datadog-agent/certs/client.key
      ssl_password: "********"
      ssl_root_cert: /etc/datadog-agent/certs/ca.crt
      username: datadog
    entity:
      database: dbm
      database_cluster_name: local-dev-cluster
      database_instance_name: local-dev-instance
      platform: postgres
      schema: public
      table: movies
    query: SELECT * FROM movies
    sub_task_id: 6ND-xzm-d3M
    timeout_seconds: 30
scanning_rules:
  - id: 2b9d78a5-f32d-5ecf-9d97-8fb8f0bb0392
    license: Datadog Confidential and Proprietary, subject to End User License Agreement athttps://www.datadoghq.com/legal/eula  (Copyright 2026 Datadog)
    pattern: '********'
    suppressions:
      starts_with:
        - alice
  - id: 581ae10c-56e7-51a8-afd0-091dfa4a1df7
    pattern: '********'
task_id: fIk-jnc-jaz
~
===

Trace log

With DD_LOG_LEVEL=TRACE, the Remote Config scheduling log (conf.Dump(false)) shows every rule with its pattern scrubbed, while the other rule fields are kept.

Resulting trace log (excerpt)
data-security-agent-pr-56761  | 2026-09-23 14:29:39 UTC | CORE | TRACE | (comp/core/autodiscovery/impl/autoconfig.go:829 in applyChanges) | Scheduling integration.Config = { Name: "datasecurity", Instances: { []byte("min_collection_interval: 0\nscan_data:\n    - connection:\n        dbname: dbm\n        host: dbm-postgres\n        password: "********"

Fleet Automation

The data security config shown in Fleet Automation has each pattern scrubbed.

Fleet Automation shown data security config check -- pattern scrubbed image

@dd-octo-sts dd-octo-sts Bot added internal Identify a non-fork PR team/agent-runtimes labels Sep 22, 2026
@github-actions github-actions Bot added the short review PR is simple enough to be reviewed quickly label Sep 22, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI review by Codex (OpenAI) - workflow run

patch is incorrect: the new text replacer does not match the compact JSON emitted by the datasecurity provider, leaving scanning rules exposed in text-scrubbed logs and flares.

Comment thread pkg/util/scrubber/default.go Outdated
@datadog-official

datadog-official Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

🎯 Code Coverage (details)
Patch Coverage: 81.82%
Overall Coverage: 56.72% (+0.01%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 2db1d6e | Docs | Give us feedback!

@dd-octo-sts

dd-octo-sts Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Files inventory check summary

File checks results against ancestor 248a7560:

Results for datadog-agent_7.85.0~devel.git.527.2db1d6e.pipeline.139460438-1_amd64.deb:

No change detected

Results for datadog-iot-agent_7.85.0~devel.git.527.2db1d6e.pipeline.139460438-1_amd64.deb:

No change detected

@dd-octo-sts

dd-octo-sts Bot commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 248a756
📊 Static Quality Gates Dashboard
🔗 SQG Job

Successful checks

Info

Quality gate Change Size (prev → curr → max)
agent_deb_amd64 +40.73 KiB (0.01% increase, -2.36% of buffer) 784.292 → 784.332 → 785.980
agent_deb_amd64_fips +32.73 KiB (0.00% increase, -1.45% of buffer) 717.007 → 717.039 → 719.210
agent_heroku_amd64 +12.0 KiB (0.00% increase, -0.20% of buffer) 317.438 → 317.450 → 323.180
agent_msi +38.5 KiB (0.01% increase, -0.25% of buffer) 653.755 → 653.793 → 668.830
agent_rpm_amd64 +40.73 KiB (0.01% increase, -2.38% of buffer) 784.276 → 784.316 → 785.950
agent_rpm_amd64_fips +32.73 KiB (0.00% increase, -1.44% of buffer) 716.990 → 717.022 → 719.210
agent_rpm_arm64 +28.35 KiB (0.00% increase, -0.92% of buffer) 754.903 → 754.931 → 757.920
agent_rpm_arm64_fips +28.7 KiB (0.00% increase, -0.75% of buffer) 693.225 → 693.253 → 696.980
agent_suse_amd64 +40.73 KiB (0.01% increase, -2.38% of buffer) 784.276 → 784.316 → 785.950
agent_suse_amd64_fips +32.73 KiB (0.00% increase, -1.44% of buffer) 716.990 → 717.022 → 719.210
agent_suse_arm64 +28.35 KiB (0.00% increase, -0.92% of buffer) 754.903 → 754.931 → 757.920
agent_suse_arm64_fips +28.7 KiB (0.00% increase, -0.75% of buffer) 693.225 → 693.253 → 696.980
docker_agent_amd64 +36.74 KiB (0.00% increase, -14.99% of buffer) 843.321 → 843.357 → 843.560
docker_agent_arm64 +28.36 KiB (0.00% increase, -0.95% of buffer) 838.965 → 838.992 → 841.880
docker_agent_jmx_amd64 +36.73 KiB (0.00% increase, -15.24% of buffer) 1034.235 → 1034.271 → 1034.470
docker_agent_jmx_arm64 +28.35 KiB (0.00% increase, -0.95% of buffer) 1018.658 → 1018.686 → 1021.570
docker_dogstatsd_amd64 +4.01 KiB (0.01% increase, -0.38% of buffer) 39.398 → 39.402 → 40.440
docker_host_profiler_amd64 +5.62 KiB (0.00% increase, -0.05% of buffer) 307.871 → 307.877 → 319.490
dogstatsd_deb_amd64 +4.0 KiB (0.01% increase, -0.36% of buffer) 30.136 → 30.140 → 31.220
dogstatsd_deb_arm64 +8.0 KiB (0.03% increase, -0.54% of buffer) 28.148 → 28.156 → 29.590
dogstatsd_rpm_amd64 +4.0 KiB (0.01% increase, -0.36% of buffer) 30.136 → 30.140 → 31.220
dogstatsd_suse_amd64 +4.0 KiB (0.01% increase, -0.36% of buffer) 30.136 → 30.140 → 31.220
iot_agent_deb_amd64 +4.0 KiB (0.01% increase, -0.38% of buffer) 46.513 → 46.517 → 47.550
iot_agent_deb_arm64 +4.0 KiB (0.01% increase, -0.36% of buffer) 43.142 → 43.146 → 44.220
iot_agent_deb_armhf +4.0 KiB (0.01% increase, -0.37% of buffer) 43.964 → 43.968 → 45.020
iot_agent_rpm_amd64 +4.0 KiB (0.01% increase, -0.38% of buffer) 46.514 → 46.518 → 47.550
iot_agent_suse_amd64 +4.0 KiB (0.01% increase, -0.38% of buffer) 46.513 → 46.517 → 47.550
docker_cluster_agent_arm64 +63.98 KiB (0.03% increase, -24.90% of buffer) 226.409 → 226.472 → 226.660
5 successful checks with minimal change (< 2 KiB)
Quality gate Current Size
docker_cws_instrumentation_amd64 7.439 MiB
docker_cws_instrumentation_arm64 6.877 MiB
docker_dogstatsd_arm64 37.503 MiB
docker_host_profiler_arm64 319.077 MiB
docker_cluster_agent_amd64 213.464 MiB

@cit-pr-commenter-54b7da

cit-pr-commenter-54b7da Bot commented Sep 22, 2026

Copy link
Copy Markdown

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Job ID: bb5f52a9-3333-4597-a543-a8580473bcf3

Baseline: 248a756
Comparison: 2db1d6e
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +1.23 [+0.37, +2.09] 1 Logs bounds checks dashboard
quality_gate_metrics_logs memory utilization +0.87 [+0.64, +1.11] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization +0.62 [+0.59, +0.66] 1 Logs bounds checks dashboard
quality_gate_private_action_runner memory utilization +0.15 [+0.02, +0.27] 1 Logs bounds checks dashboard
quality_gate_security_mean_fs_load memory utilization +0.11 [+0.05, +0.17] 1 Logs bounds checks dashboard
dsd_uds_10mb_3k_timestamped_contexts_cpu % cpu utilization +0.03 [-0.20, +0.27] 1 Logs
quality_gate_security_idle memory utilization -0.01 [-0.05, +0.03] 1 Logs bounds checks dashboard
quality_gate_security_no_fs_load memory utilization -0.04 [-0.10, +0.02] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization -0.19 [-0.24, -0.15] 1 Logs bounds checks dashboard
dsd_uds_10mb_3k_timestamped_contexts_memory memory utilization -0.75 [-0.96, -0.53] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed observed_value links
quality_gate_idle intake_connections 10/10 4 ≤ 5 bounds checks dashboard
quality_gate_idle memory_usage 10/10 176.02MiB ≤ 179MiB bounds checks dashboard
quality_gate_idle total_bytes_received 10/10 751.17KiB ≤ 819.20KiB bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 4 ≤ 5 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 519.33MiB ≤ 537MiB bounds checks dashboard
quality_gate_idle_all_features total_bytes_received 10/10 1.14MiB ≤ 1.25MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 19 ≤ 40 bounds checks dashboard
quality_gate_logs memory_usage 10/10 214.82MiB ≤ 228MiB bounds checks dashboard
quality_gate_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_logs total_bytes_received 10/10 263.68MiB ≤ 292MiB bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 375.41 ≤ 2000 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 19 ≤ 40 bounds checks dashboard
quality_gate_metrics_logs memory_usage 10/10 427.41MiB ≤ 455MiB bounds checks dashboard
quality_gate_metrics_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_metrics_logs total_bytes_received 10/10 0.94GiB ≤ 1.04GiB bounds checks dashboard
quality_gate_private_action_runner memory_usage 10/10 73.78MiB ≤ 75MiB bounds checks dashboard
quality_gate_security_idle cpu_usage 10/10 30.22 ≤ 100 bounds checks dashboard
quality_gate_security_idle memory_usage 10/10 325.86MiB ≤ 355MiB bounds checks dashboard
quality_gate_security_mean_fs_load cpu_usage 10/10 63.45 ≤ 200 bounds checks dashboard
quality_gate_security_mean_fs_load memory_usage 10/10 307.43MiB ≤ 335MiB bounds checks dashboard
quality_gate_security_no_fs_load cpu_usage 10/10 22.39 ≤ 100 bounds checks dashboard
quality_gate_security_no_fs_load memory_usage 10/10 312.25MiB ≤ 345MiB bounds checks dashboard

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_idle_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_mean_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_idle, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_private_action_runner, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
  • quality_gate_security_no_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_security_no_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@aimenebelfodil
aimenebelfodil marked this pull request as ready for review September 23, 2026 07:29
@aimenebelfodil
aimenebelfodil requested a review from a team as a code owner September 23, 2026 07:29
@aimenebelfodil aimenebelfodil added the qa/done QA done before merge and regressions are covered by tests label Sep 23, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI review by Codex (OpenAI) - workflow run

The patch is correct. The new replacers cover structured configuration scrubbing and compact JSON scheduling logs, with focused tests for both paths. No actionable regressions found. Review was static; tests were not run in the read-only environment.

@github-actions github-actions Bot added medium review PR review might take time and removed short review PR is simple enough to be reviewed quickly labels Sep 23, 2026
@aimenebelfodil
aimenebelfodil requested a review from a team as a code owner September 23, 2026 11:58
@aimenebelfodil

Copy link
Copy Markdown
Contributor Author

/review

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Identify a non-fork PR medium review PR review might take time qa/done QA done before merge and regressions are covered by tests team/agent-runtimes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants