Skip to content

[PoC] add mTLS-like capabilities to agent gRPC server #37338

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

[PoC] add mTLS-like capabilities to agent gRPC server #37338

wants to merge 5 commits into from
+127 −26

Conversation

misteriaud
Copy link
Contributor

@misteriaud misteriaud commented May 23, 2025 •
edited
Loading

What does this PR do?

This PR enables client provided certificate verification by gRPC server during TLS Handshake.

Motivation

Having mTLS enabled for gRPC IPC communications improves the Agent IPC security.

Describe how you validated your changes

You can test the following setup:

# build the Agent and RemoteAgent example

# run the Agent with Remote Agent Registry enabled
$ DD_REMOTE_AGENT_REGISTRY_ENABLED=true ./bin/agent/agent start -c ./bin/agent/dist/datadog.yaml

# run the remote Agent with a different cert (for example the one of your host Agent)
$ ./bin/remote-agent \
-agent-auth-token-file ./bin/agent/dist/auth_token \
-agent-ipc-address localhost:5001 \
-listen-addr localhost:8081 \
-display-name test \
-agent-id 10 \
-agent-cert-file /opt/datadog-agent/etc/ipc_cert.pem

2025/05/23 18:46:56 Spawned remote agent gRPC server on localhost:8081.
2025/05/23 18:46:56 Registering with Core Agent at localhost:5001...
2025/05/23 18:46:56 failed to register remote agent: rpc error: code = Unauthenticated desc = client certificate validation failed: client certificate does not match server certificate

# run the remote Agent with the same cert file
$ ./bin/remote-agent \
-agent-auth-token-file ./bin/agent/dist/auth_token \
-agent-ipc-address localhost:5001 \
-listen-addr localhost:8081 \
-display-name test \
-agent-id 10 \
-agent-cert-file ./bin/agent/dist/ipc_cert.pem
2025/05/23 18:46:16 Spawned remote agent gRPC server on localhost:8081.
2025/05/23 18:46:16 Registering with Core Agent at localhost:5001...
2025/05/23 18:46:16 Registered with Core Agent. Recommended refresh interval of 10 seconds.

Possible Drawbacks / Trade-offs

Enabling mTLS for the gRPC CMD API will prevent external clients from accessing this API. Based on its schema-based design, we are reasonably confident that no external components currently consume the gRPC API.

One caveat is that, to enable mTLS exclusively for gRPC, we must set the TLS configuration option ClientAuth to tls.VerifyClientCertIfGiven. This setting verifies the client certificate if one is provided. While this should not affect clients that do not present a certificate, if a customer is using the CMD API with a client that does provide a certificate, the connection may break.

@github-actions github-actions bot added team/agent-runtimes short review PR is simple enough to be reviewed quickly labels May 23, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 23, 2025 •
edited
Loading

Uncompressed package size comparison

Comparison with ancestor ff96c692e8eb8fccce284966788d81c6f5193f4f

Size reduction summary
package diff status size ancestor threshold
datadog-iot-agent-amd64-deb -0.00MB ✅ 62.79MB 62.79MB 0.50MB
datadog-iot-agent-x86_64-rpm -0.00MB ✅ 62.87MB 62.88MB 0.50MB
datadog-iot-agent-x86_64-suse -0.00MB ✅ 62.87MB 62.87MB 0.50MB
datadog-agent-aarch64-rpm -0.01MB ✅ 768.32MB 768.33MB 0.50MB
datadog-agent-x86_64-rpm -0.01MB ✅ 782.40MB 782.41MB 0.50MB
datadog-agent-x86_64-suse -0.01MB ✅ 782.40MB 782.41MB 0.50MB
datadog-agent-amd64-deb -0.01MB ✅ 773.45MB 773.46MB 0.50MB
datadog-agent-arm64-deb -0.01MB ✅ 759.39MB 759.40MB 0.50MB
datadog-heroku-agent-amd64-deb -0.01MB ✅ 380.17MB 380.17MB 0.50MB
datadog-iot-agent-aarch64-rpm -0.01MB ✅ 59.44MB 59.45MB 0.50MB
datadog-iot-agent-arm64-deb -0.01MB ✅ 59.36MB 59.37MB 0.50MB
Diff per package
package diff status size ancestor threshold
datadog-dogstatsd-amd64-deb 0.00MB ✅ 31.99MB 31.99MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB ✅ 32.07MB 32.07MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB ✅ 32.07MB 32.07MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB ✅ 30.47MB 30.47MB 0.50MB

Decision

✅ Passed

@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 May 23, 2025
@cit-pr-commenter cit-pr-commenter
Copy link

cit-pr-commenter bot commented May 23, 2025 •
edited
Loading

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: c8275346-38d7-4cdc-841c-8eb864c60b76

Baseline: 1e89f14
Comparison: 6aca762
Diff

Optimization Goals: ❌ Regression(s) detected

perf experiment goal Δ mean % Δ mean % CI trials links
❌ quality_gate_logs % cpu utilization +6540.11 [+6537.37, +6542.86] 1 Logs bounds checks dashboard
❌ docker_containers_cpu % cpu utilization +2720.10 [+2717.17, +2723.03] 1 Logs
❌ uds_dogstatsd_to_api_cpu % cpu utilization +76.32 [+75.52, +77.11] 1 Logs
✅ otlp_ingest_logs memory utilization -6.20 [-6.37, -6.03] 1 Logs
✅ otlp_ingest_metrics memory utilization -9.85 [-10.05, -9.65] 1 Logs
❌ tcp_syslog_to_blackhole ingress throughput -13.20 [-13.26, -13.15] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
❌ quality_gate_logs % cpu utilization +6540.11 [+6537.37, +6542.86] 1 Logs bounds checks dashboard
❌ docker_containers_cpu % cpu utilization +2720.10 [+2717.17, +2723.03] 1 Logs
❌ uds_dogstatsd_to_api_cpu % cpu utilization +76.32 [+75.52, +77.11] 1 Logs
➖ file_tree memory utilization +4.78 [+4.68, +4.88] 1 Logs
➖ uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization +4.32 [+4.29, +4.36] 1 Logs
➖ quality_gate_idle memory utilization +3.09 [+3.04, +3.14] 1 Logs bounds checks dashboard
➖ docker_containers_memory memory utilization +2.30 [+2.22, +2.38] 1 Logs
➖ quality_gate_idle_all_features memory utilization +2.29 [+2.22, +2.36] 1 Logs bounds checks dashboard
➖ file_to_blackhole_0ms_latency_http1 egress throughput +0.18 [-0.46, +0.81] 1 Logs
➖ file_to_blackhole_0ms_latency egress throughput +0.12 [-0.53, +0.78] 1 Logs
➖ file_to_blackhole_0ms_latency_http2 egress throughput +0.10 [-0.55, +0.76] 1 Logs
➖ file_to_blackhole_1000ms_latency_linear_load egress throughput +0.08 [-0.16, +0.31] 1 Logs
➖ file_to_blackhole_1000ms_latency egress throughput +0.06 [-0.61, +0.73] 1 Logs
➖ tcp_dd_logs_filter_exclude ingress throughput +0.01 [-0.02, +0.03] 1 Logs
➖ uds_dogstatsd_to_api ingress throughput +0.00 [-0.26, +0.26] 1 Logs
➖ file_to_blackhole_500ms_latency egress throughput -0.03 [-0.64, +0.58] 1 Logs
➖ file_to_blackhole_100ms_latency egress throughput -0.05 [-0.68, +0.59] 1 Logs
➖ file_to_blackhole_300ms_latency egress throughput -0.08 [-0.74, +0.58] 1 Logs
➖ ddot_metrics memory utilization -1.96 [-2.12, -1.80] 1 Logs
➖ ddot_logs memory utilization -3.97 [-4.16, -3.77] 1 Logs
✅ otlp_ingest_logs memory utilization -6.20 [-6.37, -6.03] 1 Logs
✅ otlp_ingest_metrics memory utilization -9.85 [-10.05, -9.65] 1 Logs
❌ tcp_syslog_to_blackhole ingress throughput -13.20 [-13.26, -13.15] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
❌ docker_containers_memory memory_usage 0/10
✅ docker_containers_cpu simple_check_run 10/10
✅ docker_containers_memory simple_check_run 10/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 lost_bytes 10/10
✅ file_to_blackhole_0ms_latency_http1 memory_usage 10/10
✅ file_to_blackhole_0ms_latency_http2 lost_bytes 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 intake_connections 10/10 bounds checks dashboard
✅ quality_gate_idle memory_usage 10/10 bounds checks dashboard
✅ quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
✅ quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
✅ quality_gate_logs intake_connections 10/10 bounds checks dashboard
✅ quality_gate_logs lost_bytes 10/10 bounds checks dashboard
✅ quality_gate_logs memory_usage 10/10 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 memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, 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 memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 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.

@misteriaud misteriaud changed the title add mTLS-like capacity to agent gRPC server [PoC] add mTLS-like capacity to agent gRPC server May 23, 2025
@misteriaud misteriaud changed the title [PoC] add mTLS-like capacity to agent gRPC server [PoC] add mTLS-like capabilities to agent gRPC server May 23, 2025
GustavoCaso
GustavoCaso reviewed May 26, 2025
View reviewed changes
GustavoCaso
GustavoCaso reviewed May 26, 2025
View reviewed changes
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 27, 2025 •
edited
Loading

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 1e89f14

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
✅ agent_deb_amd64 $${\color{green}-0.01}$$ $${\color{green}747.39}$$ < $${752.99}$$ $${\color{green}-0.05}$$ $${\color{green}185.05}$$ < $${187.44}$$
✅ agent_deb_amd64_fips $${\color{green}-0.01}$$ $${\color{green}745.76}$$ < $${751.36}$$ $${\color{green}-0.04}$$ $${\color{green}184.48}$$ < $${187.06}$$
✅ agent_heroku_amd64 $${\color{green}-0}$$ $${\color{green}368.86}$$ < $${369.68}$$ $${\color{red}+0}$$ $${\color{green}98.7}$$ < $${99.55}$$
✅ agent_msi $${\color{green}-0.04}$$ $${\color{green}986.27}$$ < $${987.01}$$ $${\color{red}+0.02}$$ $${\color{green}149.82}$$ < $${150.72}$$
✅ agent_rpm_amd64 $${\color{green}-0.01}$$ $${\color{green}747.38}$$ < $${752.98}$$ $${\color{green}-0}$$ $${\color{green}186.62}$$ < $${190.03}$$
✅ agent_rpm_amd64_fips $${\color{green}-0.01}$$ $${\color{green}745.75}$$ < $${751.35}$$ $${\color{green}-0.02}$$ $${\color{green}186.29}$$ < $${189.81}$$
✅ agent_rpm_arm64 $${\color{green}-0.01}$$ $${\color{green}734.01}$$ < $${739.42}$$ $${\color{red}+0}$$ $${\color{green}168.71}$$ < $${171.23}$$
✅ agent_rpm_arm64_fips $${\color{green}-0}$$ $${\color{green}732.51}$$ < $${737.91}$$ $${\color{green}-0}$$ $${\color{green}167.74}$$ < $${170.22}$$
✅ agent_suse_amd64 $${\color{green}-0.01}$$ $${\color{green}747.38}$$ < $${752.98}$$ $${\color{green}-0}$$ $${\color{green}186.62}$$ < $${190.03}$$
✅ agent_suse_amd64_fips $${\color{green}-0.01}$$ $${\color{green}745.75}$$ < $${751.35}$$ $${\color{green}-0.02}$$ $${\color{green}186.29}$$ < $${189.81}$$
✅ agent_suse_arm64 $${\color{green}-0.01}$$ $${\color{green}734.01}$$ < $${739.42}$$ $${\color{red}+0}$$ $${\color{green}168.71}$$ < $${171.23}$$
✅ agent_suse_arm64_fips $${\color{green}-0}$$ $${\color{green}732.51}$$ < $${737.91}$$ $${\color{green}-0}$$ $${\color{green}167.74}$$ < $${170.22}$$
✅ docker_agent_amd64 $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_agent_arm64 $${\color{green}-0.01}$$ $${\color{green}841.26}$$ < $${858.97}$$ $${\color{red}+0.01}$$ $${\color{green}268.4}$$ < $${274.36}$$
✅ docker_agent_jmx_amd64 $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_agent_jmx_arm64 $${\color{green}-0.01}$$ $${\color{green}841.26}$$ < $${858.97}$$ $${\color{red}+0.01}$$ $${\color{green}268.4}$$ < $${274.36}$$
✅ docker_agent_windows1809 $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_agent_windows1809_core $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_agent_windows1809_core_jmx $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_agent_windows1809_jmx $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_agent_windows2022 $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_agent_windows2022_core $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_agent_windows2022_core_jmx $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_agent_windows2022_jmx $${\color{green}-0.01}$$ $${\color{green}831.18}$$ < $${849.39}$$ $${\color{red}+0.01}$$ $${\color{green}282.31}$$ < $${288.34}$$
✅ docker_cluster_agent_amd64 $${\color{green}-0}$$ $${\color{green}259.1}$$ < $${259.73}$$ $${\color{red}+0}$$ $${\color{green}102.84}$$ < $${103.68}$$
✅ docker_cluster_agent_arm64 $${\color{green}-0}$$ $${\color{green}273.56}$$ < $${274.24}$$ $${\color{green}-0}$$ $${\color{green}97.57}$$ < $${98.45}$$
✅ docker_cws_instrumentation_amd64 $${\color{red}+0}$$ $${\color{green}7.08}$$ < $${7.12}$$ $${\color{red}+0}$$ $${\color{green}2.95}$$ < $${3.29}$$
✅ docker_cws_instrumentation_arm64 $${\color{green}0}$$ $${\color{green}6.69}$$ < $${6.92}$$ $${\color{green}-0}$$ $${\color{green}2.7}$$ < $${3.07}$$
✅ docker_dogstatsd_amd64 $${\color{green}-0}$$ $${\color{green}38.92}$$ < $${39.57}$$ $${\color{green}-0}$$ $${\color{green}14.95}$$ < $${15.76}$$
✅ docker_dogstatsd_arm64 $${\color{green}0}$$ $${\color{green}37.52}$$ < $${38.2}$$ $${\color{red}+0}$$ $${\color{green}13.96}$$ < $${14.83}$$
✅ dogstatsd_deb_amd64 $${\color{green}0}$$ $${\color{green}30.6}$$ < $${31.52}$$ $${\color{green}-0}$$ $${\color{green}8.03}$$ < $${8.97}$$
✅ dogstatsd_deb_arm64 $${\color{green}0}$$ $${\color{green}29.16}$$ < $${30.08}$$ $${\color{red}+0}$$ $${\color{green}6.97}$$ < $${7.92}$$
✅ dogstatsd_rpm_amd64 $${\color{green}0}$$ $${\color{green}30.6}$$ < $${31.52}$$ $${\color{green}-0}$$ $${\color{green}8.04}$$ < $${8.98}$$
✅ dogstatsd_suse_amd64 $${\color{green}0}$$ $${\color{green}30.6}$$ < $${31.52}$$ $${\color{green}-0}$$ $${\color{green}8.04}$$ < $${8.98}$$
✅ iot_agent_deb_amd64 $${\color{green}-0}$$ $${\color{green}59.93}$$ < $${60.17}$$ $${\color{green}-0}$$ $${\color{green}14.98}$$ < $${15.82}$$
✅ iot_agent_deb_arm64 $${\color{green}-0.01}$$ $${\color{green}56.66}$$ < $${56.94}$$ $${\color{red}+0}$$ $${\color{green}12.86}$$ < $${13.86}$$
✅ iot_agent_deb_armhf $${\color{green}-0.01}$$ $${\color{green}56.1}$$ < $${56.41}$$ $${\color{green}-0}$$ $${\color{green}13.0}$$ < $${13.86}$$
✅ iot_agent_rpm_amd64 $${\color{green}-0}$$ $${\color{green}59.93}$$ < $${60.18}$$ $${\color{red}+0}$$ $${\color{green}15.0}$$ < $${15.84}$$
✅ iot_agent_rpm_arm64 $${\color{green}-0.01}$$ $${\color{green}56.66}$$ < $${56.94}$$ $${\color{green}-0.01}$$ $${\color{green}12.87}$$ < $${13.76}$$
✅ iot_agent_suse_amd64 $${\color{green}-0}$$ $${\color{green}59.93}$$ < $${60.18}$$ $${\color{red}+0}$$ $${\color{green}15.0}$$ < $${15.84}$$

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

@GustavoCaso GustavoCaso GustavoCaso left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
medium review PR review might take time team/agent-runtimes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@misteriaud @GustavoCaso