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

[Backport 7.64.x] Build cryptography against embedded OpenSSL for FIPS Windows Agent #34725

Merged
merged 1 commit into from
Mar 4, 2025

Conversation

agent-platform-auto-pr[bot]
Copy link
Contributor

Backport 09d81f6 from #34619.


What does this PR do?

Builds the Python cryptography library inside Omnibus for the FIPS Agent, solving openssl init-related errors coming from conflicting OpenSSL configurations.

It also injects a .pth file into the site-packages such that Python extensions can find DLL's in the Agent's DLL folder, as needed for the rust OpenSSL bindings to find the OpenSSL DLL's shipped with the Agent.

Motivation

BARX-668

Describe how you validated your changes

Manually tested on a VM by running the following script using the Agent's embedded Python:

import paramiko
from cryptography.hazmat.backends.openssl import backend; backend._enable_fips()

And checking that no exception is raised.

Possible Drawbacks / Trade-offs

Note that this is not intended as a permanent solution. There are a couple of significant drawbacks currently:

  • The version of cryptography is hardcoded and could run out of sync with whatever is specified by integrations-core.
  • It bypasses our existing separation between the build of the Agent and that of Python deps for integrations; thus, this gives up the advantages of having such a separation, including a higher risk of regular Agent pipelines failing, and a (relatively small) time penalty.

There will be follow-up work to find a more permanent solution to the problem at hand.

Additional Notes

<!--

  • Anything else we should know when reviewing?
  • Include benchmarking information here whenever possible.
  • Include info about alternatives that were considered and why the proposed
    version was chosen.
    -->…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl…d to the Agent's openssl

@agent-platform-auto-pr agent-platform-auto-pr bot requested review from a team as code owners March 4, 2025 14:20
@agent-platform-auto-pr agent-platform-auto-pr bot added changelog/no-changelog team/windows-agent qa/done QA done before merge and regressions are covered by tests backport bot team/agent-delivery medium review PR review might take time labels Mar 4, 2025
@github-actions github-actions bot added short review PR is simple enough to be reviewed quickly and removed medium review PR review might take time labels Mar 4, 2025
@agent-platform-auto-pr
Copy link
Contributor Author

Gitlab CI Configuration Changes

⚠️ Diff too large to display on Github.

Changes Summary

Removed Modified Added Renamed
0 220 0 0

ℹ️ Diff available in the job log.

@agent-platform-auto-pr
Copy link
Contributor Author

[Fast Unit Tests Report]

On pipeline 57644544 (CI Visibility). The following jobs did not run any unit tests:

Jobs:
  • tests_deb-arm64-py3
  • tests_deb-x64-py3
  • tests_flavor_dogstatsd_deb-x64
  • tests_flavor_heroku_deb-x64
  • tests_flavor_iot_deb-x64
  • tests_rpm-arm64-py3
  • tests_rpm-x64-py3
  • tests_windows-x64

If you modified Go files and expected unit tests to run in these jobs, please double check the job logs. If you think tests should have been executed reach out to #agent-devx-help

@agent-platform-auto-pr
Copy link
Contributor Author

Uncompressed package size comparison

Comparison with ancestor 6205bcf815e98e57d6d7d4125fe4f43f9812e12d

Diff per package
package diff status size ancestor threshold
datadog-agent-x86_64-rpm 0.14MB ⚠️ 878.93MB 878.79MB 0.50MB
datadog-agent-x86_64-suse 0.14MB ⚠️ 878.93MB 878.79MB 0.50MB
datadog-agent-aarch64-rpm 0.13MB ⚠️ 868.22MB 868.09MB 0.50MB
datadog-agent-amd64-deb 0.12MB ⚠️ 869.14MB 869.02MB 0.50MB
datadog-agent-arm64-deb 0.11MB ⚠️ 858.45MB 858.34MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.01MB ⚠️ 62.10MB 62.09MB 0.50MB
datadog-iot-agent-x86_64-suse 0.01MB ⚠️ 62.10MB 62.09MB 0.50MB
datadog-iot-agent-amd64-deb 0.01MB ⚠️ 62.03MB 62.02MB 0.50MB
datadog-heroku-agent-amd64-deb 0.01MB ⚠️ 446.35MB 446.34MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.34MB 59.33MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.27MB 59.26MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 41.48MB 41.48MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 41.48MB 41.48MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 41.40MB 41.40MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 39.66MB 39.66MB 0.50MB

Decision

⚠️ Warning

@agent-platform-auto-pr
Copy link
Contributor Author

Static quality checks ✅

Please find below the results from static quality gates

Successful checks

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 840.64MiB 847.49MiB 203.07MiB 212.33MiB
static_quality_gate_agent_deb_arm64 830.51MiB 836.66MiB 182.77MiB 192.5MiB
static_quality_gate_agent_rpm_amd64 840.76MiB 847.82MiB 205.99MiB 215.76MiB
static_quality_gate_agent_rpm_arm64 830.44MiB 836.66MiB 185.37MiB 194.24MiB
static_quality_gate_agent_suse_amd64 840.77MiB 847.82MiB 205.99MiB 215.76MiB
static_quality_gate_agent_suse_arm64 830.56MiB 836.66MiB 185.37MiB 194.24MiB
static_quality_gate_dogstatsd_deb_amd64 39.56MiB 49.7MiB 10.55MiB 20.6MiB
static_quality_gate_dogstatsd_deb_arm64 37.9MiB 48.1MiB 9.13MiB 19.1MiB
static_quality_gate_dogstatsd_rpm_amd64 39.56MiB 49.7MiB 10.56MiB 20.6MiB
static_quality_gate_dogstatsd_suse_amd64 39.56MiB 49.7MiB 10.56MiB 20.6MiB
static_quality_gate_iot_agent_deb_amd64 59.23MiB 69.0MiB 14.88MiB 24.8MiB
static_quality_gate_iot_agent_deb_arm64 56.6MiB 66.4MiB 12.83MiB 22.8MiB
static_quality_gate_iot_agent_rpm_amd64 59.23MiB 69.0MiB 14.91MiB 24.8MiB
static_quality_gate_iot_agent_rpm_arm64 56.6MiB 66.4MiB 12.85MiB 22.8MiB
static_quality_gate_iot_agent_suse_amd64 59.23MiB 69.0MiB 14.91MiB 24.8MiB
static_quality_gate_docker_agent_amd64 925.02MiB 931.7MiB 309.11MiB 318.67MiB
static_quality_gate_docker_agent_arm64 938.09MiB 944.08MiB 294.11MiB 303.0MiB
static_quality_gate_docker_agent_jmx_amd64 1.1GiB 1.1GiB 384.22MiB 393.75MiB
static_quality_gate_docker_agent_jmx_arm64 1.1GiB 1.1GiB 365.17MiB 373.71MiB
static_quality_gate_docker_dogstatsd_amd64 47.7MiB 57.88MiB 18.26MiB 28.29MiB
static_quality_gate_docker_dogstatsd_arm64 46.09MiB 56.27MiB 17.02MiB 27.06MiB
static_quality_gate_docker_cluster_agent_amd64 264.96MiB 274.78MiB 106.35MiB 116.28MiB
static_quality_gate_docker_cluster_agent_arm64 280.92MiB 290.82MiB 101.19MiB 111.12MiB

Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 07ab97ab-17e3-4395-9cc0-6ccbfc228924

Baseline: f680f9a
Comparison: f4aca06
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
tcp_syslog_to_blackhole ingress throughput +0.86 [+0.77, +0.95] 1 Logs
quality_gate_idle memory utilization +0.39 [+0.35, +0.42] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization +0.38 [+0.33, +0.44] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency egress throughput +0.18 [-0.59, +0.95] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.12 [-0.36, +0.59] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.07 [-0.71, +0.86] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.03 [-0.75, +0.81] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.02 [-0.26, +0.30] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.01 [-0.01, +0.02] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.00 [-0.61, +0.62] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.00 [-0.81, +0.81] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.00 [-0.64, +0.63] 1 Logs
file_tree memory utilization -0.03 [-0.09, +0.02] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.03 [-0.90, +0.83] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.64 [-1.56, +0.28] 1 Logs
quality_gate_logs % cpu utilization -3.87 [-6.80, -0.95] 1 Logs

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

@sabrina-datadog sabrina-datadog merged commit 1c517e7 into 7.64.x Mar 4, 2025
345 checks passed
@sabrina-datadog sabrina-datadog deleted the backport-34619-to-7.64.x branch March 4, 2025 18:25
@github-actions github-actions bot added this to the 7.64.0 milestone Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport bot changelog/no-changelog qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/agent-delivery team/windows-agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants