From ea0c3e290e6e1cc6cfd60d1c4f09f4b86324140d Mon Sep 17 00:00:00 2001 From: Justin Smith Date: Tue, 3 Sep 2024 11:52:17 -0400 Subject: [PATCH] Cleanup; Address #495 --- .github/workflows/integration.yml | 4 ---- book/src/requirements/apple.md | 6 ++++++ book/src/requirements/windows.md | 10 +++++++++- 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml index 544873332bf..50ba720a43c 100644 --- a/.github/workflows/integration.yml +++ b/.github/workflows/integration.yml @@ -153,10 +153,6 @@ jobs: args: - publish --dry-run steps: - - uses: actions/setup-go@v4 - with: - go-version: '>=1.18' - - run: go version - uses: actions/checkout@v3 with: submodules: 'recursive' diff --git a/book/src/requirements/apple.md b/book/src/requirements/apple.md index d0584161d61..8d1e4921e5a 100644 --- a/book/src/requirements/apple.md +++ b/book/src/requirements/apple.md @@ -54,6 +54,12 @@ brew install llvm cargo install --force --locked bindgen-cli ``` +## FIPS build + +Building with the "fips" feature on this platform will result in the creation of shared libraries (named like +`libaws_lc_fips_0_xx_yy_crypto.dylib` and `libaws_lc_fips_0_xx_yy_rust_wrapper.dylib`). These shared libraries will +likely need to be distributed alongside any executable that depends on **aws-lc-rs**. + ## Troubleshooting See our [troubleshooting section](../resources.md#troubleshooting). diff --git a/book/src/requirements/windows.md b/book/src/requirements/windows.md index a6d93b8aaa8..99efc52724b 100644 --- a/book/src/requirements/windows.md +++ b/book/src/requirements/windows.md @@ -63,7 +63,9 @@ The prebuilt NASM objects are checked into our repository and are [available for inspection](https://github.com/aws/aws-lc-rs/tree/main/aws-lc-sys/builder/prebuilt-nasm). For each PR submitted, [our CI verifies](https://github.com/aws/aws-lc-rs/blob/8fb6869fc7bde92529a5cca40cf79513820984f7/.github/workflows/tests.yml#L209-L241) -that the NASM objects newly built from source match the NASM objects currently in the repository.### No-assembly build +that the NASM objects newly built from source match the NASM objects currently in the repository. + +### No-assembly build It is possible to avoid the NASM requirement by setting the `AWS_LC_SYS_NO_ASM`/`AWS_LC_FIPS_SYS_NO_ASM` environment variables. However, this severely impacts performance and can only be used for un-optimized/debug builds. See the @@ -95,6 +97,12 @@ See the [requirements](https://rust-lang.github.io/rust-bindgen/requirements.htm cargo install --force --locked bindgen-cli ``` +## FIPS build + +Building with the "fips" feature on this platform will result in the creation of shared libraries (named like +`aws_lc_fips_0_xx_yy_crypto.dll` and `aws_lc_fips_0_xx_yy_rust_wrapper.dll`). These shared libraries will likely need to +be distributed alongside any executable that depends on **aws-lc-rs**. + ## Troubleshooting See our [troubleshooting section](../resources.md#troubleshooting).