-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Add FIPS switch #19179
Merged
Merged
Add FIPS switch #19179
Changes from 1 commit
Commits
Show all changes
45 commits
Select commit
Hold shift + click to select a range
12da4e1
Add FIPS workflow file
dkirov-dd a815513
Add Windows steps
dkirov-dd f7d5b4e
Experiment with download from S3 for Windows
dkirov-dd a441988
Revert to building openssl
dkirov-dd fa42ba9
Switch Windows steps to download from S3
dkirov-dd 7e0040d
Remove unnecessary steps
dkirov-dd 6dc5ae4
Add FIPS_MODULE_VERSION for Linux
dkirov-dd ff1b42e
Finish handling Python in setup
dkirov-dd 08942db
Remove unnecessary steps
dkirov-dd c8393cd
Add md5 tests
dkirov-dd 4a74187
Make md5 tests pass
dkirov-dd c1ffd27
Try separating FIPS and non-FIPS md5 tests
dkirov-dd 2a85b00
Add e2e tests for TLS FIPS
dkirov-dd fe18202
Make TLS E2E tests pass
dkirov-dd 470bca7
Switch from env vars to C bindings
dkirov-dd e7d4f3c
Revert to using env vars
dkirov-dd 413ca9d
Add option for e2e env vars in workflow
dkirov-dd c624089
Remove unnecessary comments from start-server.sh
dkirov-dd f98c4d1
Rework enable_fips for user env var overwrite
dkirov-dd 6ceb4d2
Disable FIPS tests by default in master
dkirov-dd 8c2ba4c
Add changelogs
dkirov-dd 944dbd1
Fix license headers
dkirov-dd e07659e
Remove unfinished tests
dkirov-dd 8837acd
Remove openssl.cnf workaround
dkirov-dd 6ac9008
Remove unused compose file
dkirov-dd 7c62aef
Fix license headers
dkirov-dd 31a90a2
Bring back integration tests
dkirov-dd 2d3b7d2
Experiment with integration tests
dkirov-dd c2976fa
Remove integration test files
dkirov-dd efb8109
Restore pr.yml and test-target.yml
dkirov-dd 2ac8ada
Move FIPS workflow to test-fips.yml
dkirov-dd 8cec105
Fix pytest "not fips" args
dkirov-dd e54f3fa
Update test-fips.yml
dkirov-dd 2594fcd
Fix unvalid workflow
dkirov-dd db66922
Modify JOB_NAME env var
dkirov-dd 77508be
Re-introduce experimental integration tests
dkirov-dd a2061aa
Merge e2e tests and clean test-fips workflow
dkirov-dd 285fa3b
Merge integration tests and use monkeypatch in setup fixture
dkirov-dd 7eae96f
Attemp to fix experimental workflow
dkirov-dd fda181f
Replace ddev with pytest in experimental workflow
dkirov-dd ea88fce
Revert "Replace ddev with pytest in experimental workflow"
dkirov-dd 6390fd8
Remove experimental tests from PR
dkirov-dd 610bcb7
Add unit tests for env var logic
dkirov-dd 3e3e51a
Switch to using marks to exclude fips from test-target
dkirov-dd 08d3a37
Revert "Switch to using marks to exclude fips from test-target"
dkirov-dd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Re-introduce experimental integration tests
- Loading branch information
commit 77508bee754939d4cd8eb5a20276a598f5743a84
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,224 @@ | ||
name: Test FIPS experimental | ||
|
||
on: | ||
workflow_dispatch: | ||
inputs: | ||
zip_url: | ||
required: true | ||
type: string | ||
pull_request: | ||
path: | ||
- datadog_checks_base/datadog_checks/** | ||
schedule: | ||
- cron: '0 0,8,16 * * *' | ||
|
||
defaults: | ||
run: | ||
shell: bash | ||
|
||
jobs: | ||
test: | ||
strategy: | ||
matrix: | ||
include: | ||
- platform: "Windows" | ||
runner: "windows-2022" | ||
zip_url: "" | ||
- platform: "Linux" | ||
runner: "ubuntu-22.04" | ||
zip_url: "" | ||
name: FIPS test on ${{ matrix.platform }} | ||
runs-on: ${{ matrix.runner }} | ||
|
||
env: | ||
FORCE_COLOR: "1" | ||
DEBIAN_FRONTEND: "noninteractive" | ||
OPENSSL_FIPS: "1" | ||
PYTHON_VERSION: "3.12" | ||
OPENSSL_VERSION: "3.0.15" | ||
FIPS_MODULE_VERSION: "3.0.9" | ||
|
||
steps: | ||
|
||
- uses: actions/checkout@v4 | ||
|
||
- name: Install System Dependencies | ||
if: runner.os == 'Linux' | ||
run: | | ||
sudo apt update | ||
sudo apt install -y --no-install-recommends \ | ||
wget \ | ||
build-essential \ | ||
gcc \ | ||
make \ | ||
perl \ | ||
libc6-dev | ||
|
||
- name: Build FIPS Module | ||
if: runner.os == 'Linux' | ||
run: | | ||
wget https://www.openssl.org/source/openssl-${{ env.FIPS_MODULE_VERSION }}.tar.gz \ | ||
&& tar -xvzf openssl-${{ env.FIPS_MODULE_VERSION }}.tar.gz \ | ||
&& cd openssl-${{ env.FIPS_MODULE_VERSION }} \ | ||
&& ./Configure enable-fips \ | ||
&& make \ | ||
&& sudo make install | ||
|
||
- name: Build OpenSSL | ||
if: runner.os == 'Linux' | ||
run: | | ||
wget https://www.openssl.org/source/openssl-${{ env.OPENSSL_VERSION }}.tar.gz \ | ||
&& tar -xvzf openssl-${{ env.OPENSSL_VERSION }}.tar.gz \ | ||
&& cd openssl-${{ env.OPENSSL_VERSION }} \ | ||
&& ./Configure enable-fips \ | ||
&& make \ | ||
&& sudo make install | ||
|
||
- name: Build Python from Source with Custom OpenSSL | ||
if: runner.os == 'Linux' | ||
run: | | ||
|
||
# Install dependencies for building Python | ||
sudo apt-get update && sudo apt-get install -y \ | ||
build-essential \ | ||
zlib1g-dev \ | ||
libffi-dev \ | ||
libssl-dev \ | ||
libncurses5-dev \ | ||
libsqlite3-dev \ | ||
libreadline-dev \ | ||
libbz2-dev \ | ||
liblzma-dev \ | ||
tk-dev \ | ||
uuid-dev \ | ||
libgdbm-dev \ | ||
wget | ||
|
||
# Download and extract Python source | ||
wget https://www.python.org/ftp/python/${{ env.PYTHON_VERSION }}/Python-${{ env.PYTHON_VERSION }}.tgz | ||
tar -xvzf Python-${{ env.PYTHON_VERSION }}.tgz -C python_dir | ||
cd python_dir | ||
|
||
# Configure and build Python with custom OpenSSL | ||
./configure --enable-optimizations --with-openssl=$(pwd)/../openssl-${{ env.OPENSSL_VERSION }} | ||
make -j$(nproc) | ||
sudo make altinstall | ||
|
||
- name: Download python-windows-combined | ||
if: runner.os == 'Windows' | ||
shell: powershell | ||
run: | | ||
Invoke-WebRequest -Uri ${{ inputs.zip_url || 'https://agent-ints-python-build-sandbox.s3.eu-north-1.amazonaws.com/python-windows-combined-v3.12.6-openssl-3.0.15-openssl-3.0.9-amd64.zip' }} -OutFile 'python_combined.zip' | ||
|
||
- name: Unzip python_combined.zip | ||
if: runner.os == 'Windows' | ||
shell: powershell | ||
run: | | ||
Expand-Archive -Path python_combined.zip -DestinationPath .\python_dir | ||
|
||
- name: Run fipsintall.exe | ||
if: runner.os == 'Windows' | ||
working-directory: .\python_dir | ||
shell: powershell | ||
run: | | ||
.\openssl.exe fipsinstall -module .\ossl-modules\fips.dll -out fipsmodule.cnf | ||
|
||
- name: Configure OpenSSL for FIPS | ||
if: runner.os == 'Windows' | ||
working-directory: .\python_dir | ||
shell: powershell | ||
run: | | ||
# Create openssl.cnf to enable FIPS mode | ||
$OpenSSLConf = @" | ||
config_diagnostics = 1 | ||
openssl_conf = openssl_init | ||
|
||
.include fipsmodule.cnf | ||
|
||
[openssl_init] | ||
providers = provider_sect | ||
alg_section = algorithm_sect | ||
|
||
[provider_sect] | ||
fips = fips_sect | ||
base = base_sect | ||
|
||
[base_sect] | ||
activate = 1 | ||
|
||
[algorithm_sect] | ||
default_properties = fips=yes | ||
"@ | ||
$OpenSSLConf | Set-Content -Path ".\openssl.cnf" | ||
|
||
- name: Verify OpenSSL | ||
if: runner.os == 'Windows' | ||
working-directory: .\python_dir | ||
shell: powershell | ||
run: | | ||
.\openssl.exe version -a | ||
.\openssl.exe list -providers | ||
|
||
- name: Verify OpenSSL with FIPS ENV vars | ||
if: runner.os == 'Windows' | ||
working-directory: .\python_dir | ||
shell: powershell | ||
run: | | ||
$env:OPENSSL_MODULES = ".\ossl-modules" | ||
$env:OPENSSL_CONF = ".\openssl.cnf" | ||
.\openssl.exe list -providers | ||
|
||
- name: Add Python to PATH Windows | ||
if: runner.os == 'Windows' | ||
shell: powershell | ||
run: | | ||
Add-Content -Path $env:GITHUB_ENV -Value "PATH=$(pwd)\python_dir;$(pwd)\python_dir\Scripts;$env:PATH" | ||
|
||
- name: Add Python to PATH Linux | ||
if: runner.os == 'Linux' | ||
run: | | ||
echo "PATH=$(pwd)/python_dir:$PATH" >> $GITHUB_ENV | ||
|
||
- name: Install pip | ||
run: | | ||
python -m ensurepip | ||
|
||
- name: Restore cache | ||
uses: actions/cache/restore@v4 | ||
with: | ||
path: ${{ runner.os == 'Windows' && '~\AppData\Local\pip\Cache' || '~/.cache/pip' }} | ||
key: >- | ||
${{ format( | ||
'v01-python-{0}-{1}-{2}-{3}', | ||
env.pythonLocation, | ||
hashFiles('datadog_checks_base/pyproject.toml'), | ||
hashFiles('datadog_checks_dev/pyproject.toml'), | ||
hashFiles('ddev/pyproject.toml') | ||
)}} | ||
restore-keys: |- | ||
v01-python-${{ env.pythonLocation }} | ||
|
||
- name: Install ddev from local folder | ||
run: | | ||
python.exe -m pip install -e ./datadog_checks_dev[cli] | ||
python.exe -m pip install -e ./ddev | ||
|
||
- name: Configure ddev | ||
run: | | ||
ddev config set repos.core . | ||
ddev config set repo core | ||
|
||
- name: Test | ||
if: runner.os == 'Windows' | ||
working-directory: .\python_dir | ||
shell: powershell | ||
run: | | ||
$env:PATH_TO_OPENSSL_CONF = "$(pwd)\openssl.cnf" | ||
$env:PATH_TO_OPENSSL_MODULES = "$(pwd)\ossl-modules" | ||
$env:OPENSSL_CONF = "$(pwd)\openssl.cnf" | ||
$env:OPENSSL_MODULES = "$(pwd)\ossl-modules" | ||
.\openssl.exe list -providers | ||
.\openssl.exe md5 | ||
ddev test --cov --junit datadog_checks_base -- -k before_fips | ||
ddev test --cov --junit datadog_checks_base -- -k after_fips | ||
python -c "import ssl; ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT).set_ciphers('MD5')" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# (C) Datadog, Inc. 2024-present | ||
# All rights reserved | ||
# Licensed under a 3-clause BSD style license (see LICENSE) | ||
import os | ||
from typing import Any # noqa: F401 | ||
|
||
import pytest | ||
|
||
from datadog_checks.base.utils.fips import enable_fips | ||
|
||
PATH_TO_OPENSSL_CONF = os.getenv("PATH_TO_OPENSSL_CONF") | ||
PATH_TO_OPENSSL_MODULES = os.getenv("PATH_TO_OPENSSL_MODULES") | ||
|
||
|
||
@pytest.fixture(scope="function") | ||
def clean_environment(): | ||
os.environ["GOFIPS"] = "0" | ||
os.environ["OPENSSL_CONF"] = "" | ||
os.environ["OPENSSL_MODULES"] = "" | ||
yield | ||
|
||
|
||
def test_ssl_md5_after_fips(clean_environment): | ||
import ssl | ||
|
||
enable_fips(path_to_openssl_conf=PATH_TO_OPENSSL_CONF, path_to_openssl_modules=PATH_TO_OPENSSL_MODULES) | ||
with pytest.raises(ssl.SSLError, match='No cipher can be selected.'): | ||
ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) | ||
ctx.set_ciphers("MD5") | ||
|
||
|
||
def test_cryptography_md5_after_fips(clean_environment): | ||
from cryptography.exceptions import InternalError | ||
from cryptography.hazmat.primitives import hashes | ||
|
||
enable_fips(path_to_openssl_conf=PATH_TO_OPENSSL_CONF, path_to_openssl_modules=PATH_TO_OPENSSL_MODULES) | ||
with pytest.raises(InternalError, match='Unknown OpenSSL error.'): | ||
hashes.Hash(hashes.MD5()) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# (C) Datadog, Inc. 2024-present | ||
# All rights reserved | ||
# Licensed under a 3-clause BSD style license (see LICENSE) | ||
import os | ||
from typing import Any # noqa: F401 | ||
|
||
import pytest | ||
|
||
|
||
@pytest.fixture(scope="function") | ||
def clean_environment(): | ||
os.environ["GOFIPS"] = "0" | ||
os.environ["OPENSSL_CONF"] = "" | ||
os.environ["OPENSSL_MODULES"] = "" | ||
yield | ||
|
||
|
||
def test_ssl_md5_before_fips(clean_environment): | ||
import ssl | ||
|
||
ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) | ||
ctx.set_ciphers("MD5") | ||
assert True | ||
|
||
|
||
def test_cryptography_md5_before_fips(clean_environment): | ||
from cryptography.hazmat.primitives import hashes | ||
|
||
hashes.Hash(hashes.MD5()) | ||
assert True | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This test and the test above it are just ensuring that no exception is being thrown?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes