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

[ASCII-2582] Add certificate generation and retrieval for IPC communications #31838

Merged

Conversation

misteriaud
Copy link
Contributor

@misteriaud misteriaud commented Dec 6, 2024

What does this PR do?

This PR introduce the generation of an IPC dedicated certificate and key pair, used to allow Agent API server to authenticate it. This generation/retrieval process takes places during the initialization of the auth_token.

The next steps are using this generated certificate in the different API servers:

Motivation

This PR is part of a plan to improve the security of the Agent's inter-process communication (IPC).

Describe how you validated your changes

Some unit tests have been added to cover the new generation/retrieval steps.

Additional Notes

The comp/api/authtoken component has been updated to provide the IPC TLS configurations based on the generated certificate. The component's name should be updated in a subsequent pull request to better reflect its behavior.

Copy link

cit-pr-commenter bot commented Dec 6, 2024

Go Package Import Differences

Baseline: 2491564
Comparison: 2036141

binaryosarchchange
agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
agentdarwinamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
agentdarwinarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
iot-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
iot-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
heroku-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
cluster-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
cluster-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
cluster-agent-cloudfoundrylinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
cluster-agent-cloudfoundrylinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
dogstatsdlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
dogstatsdlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
process-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
process-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
process-agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
process-agentdarwinamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
process-agentdarwinarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
heroku-process-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
security-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
security-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
security-agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
serverlesslinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
serverlesslinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
system-probelinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
system-probelinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
system-probewindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
trace-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
trace-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
trace-agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
trace-agentdarwinamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
trace-agentdarwinarm64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert
heroku-trace-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/pkg/api/security/cert

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 6, 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=50858196 --os-family=ubuntu

Note: This applies to commit 2036141

pkg/api/util/util.go Fixed Show fixed Hide fixed
@misteriaud misteriaud force-pushed the misteriaud/ASCII-2582-implement-IPC-cert/key-creation branch from 7d2f18a to b6aa3e2 Compare December 6, 2024 17:16
@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 6, 2024
@misteriaud misteriaud changed the title add configuration entry to set cert filepath [ASCII-2582] Add certificate generation and retrieval for IPC communications Dec 6, 2024
@misteriaud misteriaud force-pushed the misteriaud/ASCII-2582-implement-IPC-cert/key-creation branch from 3e1db37 to d1bd1c3 Compare December 9, 2024 09:14
@misteriaud misteriaud marked this pull request as ready for review December 9, 2024 09:38
@misteriaud misteriaud requested a review from a team as a code owner December 9, 2024 09:38
@misteriaud misteriaud requested a review from dustmop December 9, 2024 09:38
Copy link
Contributor

@dustmop dustmop left a comment

Choose a reason for hiding this comment

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

Great PR overall! I have a couple of comments about things to fix, but I think this is close to getting merged.

comp/api/authtoken/fetchonlyimpl/authtoken.go Outdated Show resolved Hide resolved
comp/api/authtoken/fetchonlyimpl/authtoken.go Outdated Show resolved Hide resolved
comp/api/authtoken/fetchonlyimpl/authtoken.go Outdated Show resolved Hide resolved
pkg/api/util/util.go Outdated Show resolved Hide resolved
pkg/api/util/util.go Outdated Show resolved Hide resolved
comp/api/authtoken/component.go Show resolved Hide resolved
comp/api/authtoken/createandfetchimpl/authtoken_test.go Outdated Show resolved Hide resolved
"github.com/DataDog/datadog-agent/pkg/config/model"
"github.com/DataDog/datadog-agent/pkg/util/log"
)

var (
tokenLock sync.RWMutex
token string
Copy link
Contributor

Choose a reason for hiding this comment

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

I know it's a larger change that this PR is intending to fix, but it would be great if one day we could get rid of this global var. Perhaps instead this could be converted into a component?

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 completely agree ! The authtoken.Component already try to tackle this by wrapping it around.
The problem is that a lot of places in the code are relying on the auth_token, some in pkg.
The work involved in bringing the getter down to these points is quite big.

pkg/api/util/util.go Outdated Show resolved Hide resolved
pkg/api/security/cert/cert_getter_test.go Show resolved Hide resolved
Copy link

cit-pr-commenter bot commented Dec 10, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 54e65d88-e93c-4911-a5cc-9247b42dba7d

Baseline: 2491564
Comparison: 8bab3e7
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +2.08 [+1.34, +2.81] 1 Logs
otel_to_otel_logs ingress throughput +1.40 [+0.72, +2.09] 1 Logs
quality_gate_logs % cpu utilization +0.95 [-2.04, +3.93] 1 Logs
file_tree memory utilization +0.73 [+0.59, +0.86] 1 Logs
quality_gate_idle_all_features memory utilization +0.58 [+0.46, +0.69] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency egress throughput +0.43 [-0.35, +1.21] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.23 [+0.18, +0.29] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.16 [-0.62, +0.94] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.05 [-0.63, +0.72] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.10, +0.08] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.02 [-0.49, +0.45] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.03 [-0.82, +0.75] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.09 [-0.72, +0.54] 1 Logs
quality_gate_idle memory utilization -0.78 [-0.82, -0.73] 1 Logs bounds checks dashboard

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency 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.

@misteriaud
Copy link
Contributor Author

/trigger-ci --variable RUN_ALL_BUILDS=true --variable RUN_KITCHEN_TESTS=true --variable RUN_E2E_TESTS=on --variable RUN_UNIT_TESTS=on --variable RUN_KMT_TESTS=on

@dd-devflow
Copy link

dd-devflow bot commented Dec 11, 2024

Devflow running: /trigger-ci --variable RUN_ALL_BUILDS=true --varia...

View all feedbacks in Devflow UI.


2024-12-11 11:55:26 UTC ℹ️ Branch synced on Gitlab

Branch misteriaud/ASCII-2582-implement-IPC-cert/key-creation was out-of-sync on Gitlab - it has been resynced


2024-12-11 11:55:57 UTC ℹ️ Gitlab pipeline started

Started pipeline #50818940

@misteriaud
Copy link
Contributor Author

/trigger-ci --variable RUN_ALL_BUILDS=true --variable RUN_KITCHEN_TESTS=true --variable RUN_E2E_TESTS=on --variable RUN_UNIT_TESTS=on --variable RUN_KMT_TESTS=on

@dd-devflow
Copy link

dd-devflow bot commented Dec 11, 2024

Devflow running: /trigger-ci --variable RUN_ALL_BUILDS=true --varia...

View all feedbacks in Devflow UI.


2024-12-11 12:23:50 UTC ℹ️ Gitlab pipeline started

Started pipeline #50821464

pkg/api/util/util.go Fixed Show fixed Hide fixed
Copy link
Contributor

@dustmop dustmop left a comment

Choose a reason for hiding this comment

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

Thanks for the fixes! I have just a couple more small things, but am approving now, please feel free to merge once they are handled.

comp/api/authtoken/component.go Show resolved Hide resolved
pkg/api/security/cert/cert_getter_test.go Show resolved Hide resolved
pkg/api/util/util.go Show resolved Hide resolved
pkg/api/util/util.go Show resolved Hide resolved
@misteriaud misteriaud added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests labels Dec 11, 2024
pkg/api/util/util.go Dismissed Show dismissed Hide dismissed
@misteriaud
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 11, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-11 16:21:08 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 25m.


2024-12-11 16:38:24 UTC ⚠️ MergeQueue: This merge request was unqueued

This merge request was unqueued

@misteriaud
Copy link
Contributor Author

/merge -c

@misteriaud
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 12, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-12 07:12:07 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-12 07:39:32 UTC ℹ️ MergeQueue: merge request added to the queue

The median merge time in main is 26m.


2024-12-12 08:19:36 UTC ℹ️ MergeQueue: This merge request was merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants