Skip to content

[Backport 7.79.x] [ACTP] PAR: rshell allow-list redesign + per-env paths (#49825)#50090

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits into7.79.xfrom
backport-49825-to-7.79.x
Apr 29, 2026
Merged

[Backport 7.79.x] [ACTP] PAR: rshell allow-list redesign + per-env paths (#49825)#50090
gh-worker-dd-mergequeue-cf854d[bot] merged 2 commits into7.79.xfrom
backport-49825-to-7.79.x

Conversation

@julesmcrt
Copy link
Copy Markdown
Contributor

Backport of #49825 to 7.79.x.

Conflicts resolved:

  • pkg/privateactionrunner/adapters/config/BUILD.bazel dropped (7.79.x predates the Bazel migration).
  • test/new-e2e/go.{mod,sum} retidied against 7.79.x — adds pkg/config/setup + indirect deps at v0.79.0-rc.3.

julesmcrt and others added 2 commits April 29, 2026 15:46
Started as a bug fix and grew into a redesign of the operator-side allow-list contract for rshell, plus a new per-environment path-list feature. Three themes:

Fixes three bugs in the intersection layer for `private_action_runner.restricted_shell.{allowed_commands,allowed_paths}`:

- **YAML `[]` was treated as "operator unset."** `GetStringSlice` returns nil for a YAML empty sequence, indistinguishable from "key absent." The kill-switch row of the truth table didn't work.
- **Path intersection used plain string equality.** An operator entry narrower than a backend entry (e.g. `/host/var/log/par-probe.txt` against backend `/host/var/log`) was dropped instead of admitted.
- **Bare operator command entries silently produced empty intersections.** Backend ships `rshell:<name>`; operator-written `cat` never matched. Now warned at startup pointing the operator at the corrected form.

Replaces the three-way `nil` / `[]` / `[X]` slice contract with a uniform "always intersect" contract using sentinel defaults:

- `allowed_paths` default is `["/"]`. `pathContains("/", X)` is true for any absolute path, so the intersection passes the backend list through when the operator hasn't narrowed.
- `allowed_commands` default is `["rshell:*"]`. The wildcard token is a special-case in the operator-side intersection: when present, every backend entry in the `rshell:` namespace is admitted (scoped via `onlyRshellPrefixedCommands`).

The `IsConfigured` gate and the handler's nil-pass-through bypass are gone. End-user behavior is preserved: unset operator config gets the backend list as-is on both axes, explicit empty list is the kill-switch, explicit non-empty narrows.

`RunCommandInputs.AllowedPaths` is now `map[string][]string` keyed by environment (`default` / `containerized`). `wf-actions-server` ships one task with both keys; the runner picks the relevant slice based on `env.IsContainerized()`, then the slice flows through the same intersection logic. This lets a single Balto rule cover both host-installed agents (which see `/var/log`) and containerized agents (which see `/host/var/log`).

> **⚠️ Wire-format change**: `allowedPaths` is no longer a slice. The runner side ships in this PR; Balto / `wf-actions-server` need to ship the new shape concurrently. Coordinate the rollout — old tasks (slice shape) will fail to deserialize on the new runner.

- Pure path utilities live in `helper.go`: `cleanPathList`, `reducePathListToBroadest`, `intersectPathLists`, `commonPath`, `onlyRshellPrefixedCommands`, `backendPathsForEnv`.
- Handler methods (`filterAllowedCommands`, `filterAllowedPaths`) and `Run` stay in `run_command.go`.
- Two advisory warnings at config load surface misconfigurations: backslash entries (forward-slash contract) and non-directory entries (rshell's `os.Root` sandbox is directory-only).

Discovered during end-to-end PAR validation against a prod-connected test drive. Findings and reproduction traces: [experimental/.../rshell-permission-test.md](https://github.com/DataDog/experimental/blob/main/users/jules.macret/q_branch/agent_mcp/k8s_setup/rshell-permission-test.md). Parent PRs:

- #49536 (operator-side intersection)
- DataDog/dd-source#414468 (backend injects allowedPaths into every task)

Confluence: [Rshell permission model (allow lists)](https://datadoghq.atlassian.net/wiki/spaces/agent/pages/6608848267/Rshell+permission+model+allow+lists).

- **Unit tests.** 118 tests pass across `pkg/privateactionrunner/...` and `pkg/config/setup`. Linter clean (`dda inv linter.go` → 0 issues).
  - Helper tests in `helper_test.go` cover `commonPath`, `cleanPathList`, `reducePathListToBroadest` (including idempotence + order-independence properties), `intersectPathLists`, `onlyRshellPrefixedCommands`, and `backendPathsForEnv`.
  - Method tests in `run_command_test.go` pin `filterAllowedCommands` and `filterAllowedPaths` matrices.
  - YAML-backed transform tests exercise the real config-load path (the original bug #1 escaped because earlier tests used `SetWithoutSource`, which doesn't reproduce the nil-from-YAML behavior).
- **End-to-end validation** against image `v109530495-91d30ac1-7-arm64` on a prod-connected test drive. Behavior matched the Confluence contract (v13) on every scenario in this table. The contract has shifted since (sentinel defaults, per-env paths) — a fresh E2E pass on the latest image should follow before merge.

  | Scenario | Works as documented? |
  |---|---|
  | Operator `[]` + `[]` kill-switch | Yes — effective `[]` on both axes |
  | Narrower commands `["rshell:cat"]` | Yes — only `cat` works |
  | File-level path entry | Yes — WARN at load; entry silently dropped by rshell sandbox |
  | Directory sub-path `["/host/var/log/nginx"]` | Yes — narrower wins |
  | Bare command name `["cat"]` | Yes — WARN at load; intersection empty |
  | Disjoint non-empty | Yes — effective `[]`, everything blocked |
  | Prefix-sibling `/var/logger` vs `/var/log` | Yes — separator boundary honored |

- The startup warnings (unnamespaced commands, backslash paths, non-directory paths) are advisory. Entries still flow through to the handler; the warnings make silent-failure modes observable in agent logs.
- Confluence will need a follow-up update once the per-env path shape is finalized in Balto.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: matt-dz <matthew.deguzman@datadoghq.com>
Co-authored-by: jules.macret <jules.macret@datadoghq.com>
(cherry picked from commit 114422d)
The cherry-pick added a new import of pkg/config/setup in
rshell_k8s_test.go. Pin the new direct + indirect deps to the
7.79.x release-candidate versions.
@julesmcrt julesmcrt requested review from a team as code owners April 29, 2026 13:50
@julesmcrt julesmcrt requested review from rahulkaukuntla and ross-m-young and removed request for a team April 29, 2026 13:50
@dd-octo-sts dd-octo-sts Bot added the internal Identify a non-fork PR label Apr 29, 2026
@github-actions github-actions Bot added the long review PR is complex, plan time to review it label Apr 29, 2026
@julesmcrt julesmcrt added changelog/no-changelog No changelog entry needed qa/rc-required Only for a PR that requires validation on the Release Candidate labels Apr 29, 2026
@dd-octo-sts
Copy link
Copy Markdown
Contributor

dd-octo-sts Bot commented Apr 29, 2026

Files inventory check summary

File checks results against ancestor f08efaa6:

Results for datadog-agent_7.79.0~rc.3.git.13.05ac22d.pipeline.110440027-1_amd64.deb:

No change detected

@gh-worker-dd-mergequeue-cf854d gh-worker-dd-mergequeue-cf854d Bot merged commit 70c2220 into 7.79.x Apr 29, 2026
322 of 523 checks passed
@gh-worker-dd-mergequeue-cf854d gh-worker-dd-mergequeue-cf854d Bot deleted the backport-49825-to-7.79.x branch April 29, 2026 14:37
@github-actions github-actions Bot added this to the 7.79.0 milestone Apr 29, 2026
@cit-pr-commenter-54b7da
Copy link
Copy Markdown

cit-pr-commenter-54b7da Bot commented Apr 29, 2026

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: f7358109-049a-4c03-9388-985cdecf0c88

Baseline: f08efaa
Comparison: 05ac22d
Diff

Optimization Goals: ✅ No significant changes detected

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization -0.59 [-3.62, +2.44] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
ddot_metrics_sum_delta memory utilization +0.49 [+0.31, +0.67] 1 Logs
docker_containers_memory memory utilization +0.39 [+0.31, +0.47] 1 Logs
ddot_metrics memory utilization +0.35 [+0.16, +0.54] 1 Logs
quality_gate_metrics_logs memory utilization +0.24 [+0.01, +0.47] 1 Logs bounds checks dashboard
ddot_metrics_sum_cumulative memory utilization +0.23 [+0.08, +0.38] 1 Logs
file_tree memory utilization +0.13 [+0.07, +0.19] 1 Logs
otlp_ingest_metrics memory utilization +0.13 [-0.03, +0.28] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.13 [-0.31, +0.56] 1 Logs
ddot_metrics_sum_cumulativetodelta_exporter memory utilization +0.07 [-0.16, +0.29] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.06 [-0.33, +0.45] 1 Logs
uds_dogstatsd_to_api_v3 ingress throughput +0.01 [-0.18, +0.21] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.01 [-0.09, +0.10] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.20, +0.20] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.02 [-0.53, +0.49] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.03 [-0.09, +0.04] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.06 [-0.18, +0.07] 1 Logs
quality_gate_idle memory utilization -0.07 [-0.12, -0.01] 1 Logs bounds checks dashboard
ddot_logs memory utilization -0.15 [-0.20, -0.09] 1 Logs
otlp_ingest_logs memory utilization -0.17 [-0.27, -0.06] 1 Logs
quality_gate_idle_all_features memory utilization -0.45 [-0.49, -0.42] 1 Logs bounds checks dashboard
quality_gate_logs % cpu utilization -0.49 [-2.02, +1.04] 1 Logs bounds checks dashboard
docker_containers_cpu % cpu utilization -0.59 [-3.62, +2.44] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.66 [-0.85, -0.47] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed observed_value links
docker_containers_cpu simple_check_run 10/10 713 ≥ 26
docker_containers_memory memory_usage 10/10 279.87MiB ≤ 370MiB
docker_containers_memory simple_check_run 10/10 707 ≥ 26
file_to_blackhole_0ms_latency memory_usage 10/10 0.19GiB ≤ 1.20GiB
file_to_blackhole_0ms_latency missed_bytes 10/10 0B = 0B
file_to_blackhole_1000ms_latency memory_usage 10/10 0.24GiB ≤ 1.20GiB
file_to_blackhole_1000ms_latency missed_bytes 10/10 0B = 0B
file_to_blackhole_100ms_latency memory_usage 10/10 0.20GiB ≤ 1.20GiB
file_to_blackhole_100ms_latency missed_bytes 10/10 0B = 0B
file_to_blackhole_500ms_latency memory_usage 10/10 0.22GiB ≤ 1.20GiB
file_to_blackhole_500ms_latency missed_bytes 10/10 0B = 0B
quality_gate_idle intake_connections 10/10 4 = 4 bounds checks dashboard
quality_gate_idle memory_usage 10/10 175.21MiB ≤ 181MiB bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 4 = 4 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 498.85MiB ≤ 550MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 4 ≤ 6 bounds checks dashboard
quality_gate_logs memory_usage 10/10 211.16MiB ≤ 220MiB bounds checks dashboard
quality_gate_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 355.80 ≤ 2000 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 4 ≤ 6 bounds checks dashboard
quality_gate_metrics_logs memory_usage 10/10 397.93MiB ≤ 475MiB bounds checks dashboard
quality_gate_metrics_logs missed_bytes 10/10 0B = 0B 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, 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_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check intake_connections: 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 missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.

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

Labels

changelog/no-changelog No changelog entry needed internal Identify a non-fork PR long review PR is complex, plan time to review it qa/rc-required Only for a PR that requires validation on the Release Candidate team/action-platform team/agent-configuration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants