Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update filesystem permission to restrict access to datadog user #31770

Merged
merged 19 commits into from
Dec 9, 2024

Conversation

jack0x2
Copy link
Contributor

@jack0x2 jack0x2 commented Dec 5, 2024

What does this PR do?

Updates file permissions to restrict to admin and datadog agent user on windows.

Motivation

https://datadoghq.atlassian.net/browse/WINA-445

Better mirrors how linux handles setup of auth_token files to make sure they are readable by less privileges agent processes.

Describe how you validated your changes

Tested through added unit tests and existing e2e tests.

Possible Drawbacks / Trade-offs

Additional Notes

@jack0x2 jack0x2 added the qa/done QA done before merge and regressions are covered by tests label Dec 5, 2024
pkg/util/winutil/users.go Show resolved Hide resolved
pkg/util/filesystem/permission_windows_test.go Outdated Show resolved Hide resolved
Copy link

cit-pr-commenter bot commented Dec 5, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 538b1bb5-167a-4178-abfb-7659bf9df8eb

Baseline: cefb01c
Comparison: bec0bae
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 +3.86 [+0.84, +6.88] 1 Logs
file_tree memory utilization +0.41 [+0.28, +0.53] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.11 [-0.35, +0.57] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.10 [-0.67, +0.87] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.07 [-0.80, +0.94] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.10, +0.11] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.75, +0.73] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.03 [-0.91, +0.85] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.04 [-0.83, +0.74] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.08 [-0.71, +0.56] 1 Logs
quality_gate_idle memory utilization -0.08 [-0.13, -0.03] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency_http1 egress throughput -0.12 [-1.03, +0.78] 1 Logs
otel_to_otel_logs ingress throughput -0.44 [-1.12, +0.25] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.86 [-0.93, -0.79] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -1.33 [-2.04, -0.61] 1 Logs
quality_gate_idle_all_features memory utilization -1.53 [-1.65, -1.40] 1 Logs bounds checks dashboard

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency_http1 lost_bytes 9/10
file_to_blackhole_0ms_latency_http2 lost_bytes 9/10
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_0ms_latency_http1 memory_usage 10/10
file_to_blackhole_0ms_latency_http2 memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency_linear_load memory_usage 10/10
file_to_blackhole_100ms_latency lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency lost_bytes 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs lost_bytes 10/10
quality_gate_logs memory_usage 10/10

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 memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@github-actions github-actions bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Dec 5, 2024
@jack0x2 jack0x2 force-pushed the jack.phillips/restrict-access-dduser-windows branch from 80d28fd to 054893a Compare December 5, 2024 20:13
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 5, 2024

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv aws.create-vm --pipeline-id=50626822 --os-family=ubuntu

Note: This applies to commit bec0bae

@jack0x2 jack0x2 marked this pull request as ready for review December 6, 2024 03:31
@jack0x2 jack0x2 requested review from a team as code owners December 6, 2024 03:31
Comment on lines -71 to 78
github.com/DataDog/datadog-agent/pkg/util/log v0.59.0 // indirect
github.com/DataDog/datadog-agent/pkg/util/log v0.59.1 // indirect
github.com/DataDog/datadog-agent/pkg/util/log/setup v0.58.0-devel // indirect
github.com/DataDog/datadog-agent/pkg/util/pointer v0.59.0 // indirect
github.com/DataDog/datadog-agent/pkg/util/scrubber v0.59.0 // indirect
github.com/DataDog/datadog-agent/pkg/util/scrubber v0.59.1 // indirect
github.com/DataDog/datadog-agent/pkg/util/system v0.59.0 // indirect
github.com/DataDog/datadog-agent/pkg/util/system/socket v0.59.0 // indirect
github.com/DataDog/datadog-agent/pkg/util/winutil v0.59.0 // indirect
github.com/DataDog/datadog-agent/pkg/util/winutil v0.59.1 // indirect
github.com/DataDog/datadog-agent/pkg/version v0.56.0 // indirect
Copy link
Contributor

Choose a reason for hiding this comment

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

❓ question: ‏ Why are all those dependencies bumped? Is this intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added a winutil dependency to the filesystem package and it updated all of these dependencies.

pkg/util/filesystem/permission_windows.go Outdated Show resolved Hide resolved
pkg/util/winutil/users.go Show resolved Hide resolved
pkg/util/winutil/users_test.go Outdated Show resolved Hide resolved
pkg/util/filesystem/permission_windows.go Outdated Show resolved Hide resolved
Copy link
Member

@L3n41c L3n41c left a comment

Choose a reason for hiding this comment

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

👍🏻 LGTM for file owned by @DataDog/container-integrations.

Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

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

Some feedback on spelling and capitalization.

@jack0x2 jack0x2 requested a review from rtrieu December 9, 2024 15:27
@jack0x2
Copy link
Contributor Author

jack0x2 commented Dec 9, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 9, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-09 15:54:16 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2024-12-09 19:53:37 UTC ⚠️ MergeQueue: This merge request was unqueued

This merge request was unqueued

@jack0x2
Copy link
Contributor Author

jack0x2 commented Dec 9, 2024

/merge

@agent-platform-auto-pr
Copy link
Contributor

Package size comparison

Comparison with ancestor cefb01ce6f8d35672b2fca8dc3cd8939fc1dff0b

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 1270.97MB 1270.97MB 140.00MB
datadog-iot-agent-amd64-deb 0.00MB 113.20MB 113.20MB 10.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.32MB 78.32MB 10.00MB
datadog-heroku-agent-amd64-deb 0.00MB 526.44MB 526.44MB 70.00MB
datadog-agent-x86_64-rpm 0.00MB ⚠️ 1280.20MB 1280.20MB 140.00MB
datadog-agent-x86_64-suse 0.00MB ⚠️ 1280.20MB 1280.20MB 140.00MB
datadog-iot-agent-x86_64-rpm 0.00MB 113.26MB 113.26MB 10.00MB
datadog-iot-agent-x86_64-suse 0.00MB 113.26MB 113.26MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.40MB 78.40MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.40MB 78.40MB 10.00MB
datadog-agent-arm64-deb 0.00MB 1005.13MB 1005.13MB 140.00MB
datadog-iot-agent-arm64-deb 0.00MB 108.67MB 108.67MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.59MB 55.59MB 10.00MB
datadog-agent-aarch64-rpm 0.00MB 1014.35MB 1014.35MB 140.00MB
datadog-iot-agent-aarch64-rpm 0.00MB 108.74MB 108.74MB 10.00MB

Decision

⚠️ Warning

@dd-devflow
Copy link

dd-devflow bot commented Dec 9, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-09 20:04:20 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2024-12-09 20:29:52 UTC ℹ️ MergeQueue: merge request added to the queue

The median merge time in main is 24m.

@dd-mergequeue dd-mergequeue bot merged commit 4f0073d into main Dec 9, 2024
235 checks passed
@dd-mergequeue dd-mergequeue bot deleted the jack.phillips/restrict-access-dduser-windows branch December 9, 2024 21:02
@github-actions github-actions bot added this to the 7.62.0 milestone Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-shared-components team/windows-agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.