From 6bce0103a0d1fec3fac0e46081b61c2fb7c99d92 Mon Sep 17 00:00:00 2001 From: Spencer Wilson Date: Tue, 30 Jan 2024 16:03:15 -0500 Subject: [PATCH] Update BIKE documentation to exclude x86 (#1679) * Update BIKE documentation to exclude x86; clarify comments in alg_support * Update Markdown --- .CMake/alg_support.cmake | 6 +++--- docs/algorithms/kem/bike.md | 6 +++--- docs/algorithms/kem/bike.yml | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.CMake/alg_support.cmake b/.CMake/alg_support.cmake index c9e1bc4a8e..b313206163 100644 --- a/.CMake/alg_support.cmake +++ b/.CMake/alg_support.cmake @@ -75,10 +75,10 @@ if(OQS_DIST_X86_64_BUILD OR OQS_USE_AVX2_INSTRUCTIONS) endif() endif() -# BIKE is not supported on Windows, 32-bit ARM, S390X (big endian) and PPC64 (big endian) +# BIKE is not supported on Windows, 32-bit ARM, X86, S390X (big endian) and PPC64 (big endian) cmake_dependent_option(OQS_ENABLE_KEM_BIKE "Enable BIKE algorithm family" ON "NOT WIN32; NOT ARCH_ARM32v7; NOT ARCH_X86; NOT ARCH_S390X; NOT ARCH_PPC64" OFF) -# BIKE doesn't work on any 32bit platform except x86: -if(CMAKE_SIZEOF_VOID_P MATCHES "4" AND NOT ARCH_X86) +# BIKE doesn't work on any 32-bit platform +if(CMAKE_SIZEOF_VOID_P MATCHES "4") set(OQS_ENABLE_KEM_BIKE OFF) endif() cmake_dependent_option(OQS_ENABLE_KEM_bike_l1 "" ON "OQS_ENABLE_KEM_BIKE" OFF) diff --git a/docs/algorithms/kem/bike.md b/docs/algorithms/kem/bike.md index bbb2ebdc71..10741ad398 100644 --- a/docs/algorithms/kem/bike.md +++ b/docs/algorithms/kem/bike.md @@ -23,7 +23,7 @@ | Implementation source | Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage?‡ | |:---------------------------------:|:-------------------------|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:----------------------| -| [Primary Source](#primary-source) | master | little endian | Linux,Darwin | None | True | True | False | +| [Primary Source](#primary-source) | master | 64-bit little-endian | Linux,Darwin | None | True | True | False | | [Primary Source](#primary-source) | master | x86\_64 | Linux,Darwin | AVX2,AVX512,PCLMUL,SSE2 | True | True | False | Are implementations chosen based on runtime CPU feature detection? **Yes**. @@ -34,7 +34,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**. | Implementation source | Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? | |:---------------------------------:|:-------------------------|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------| -| [Primary Source](#primary-source) | master | little endian | Linux,Darwin | None | True | True | False | +| [Primary Source](#primary-source) | master | 64-bit little-endian | Linux,Darwin | None | True | True | False | | [Primary Source](#primary-source) | master | x86\_64 | Linux,Darwin | AVX2,AVX512,PCLMUL,SSE2 | True | True | False | Are implementations chosen based on runtime CPU feature detection? **Yes**. @@ -43,7 +43,7 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**. | Implementation source | Identifier in upstream | Supported architecture(s) | Supported operating system(s) | CPU extension(s) used | No branching-on-secrets claimed? | No branching-on-secrets checked by valgrind? | Large stack usage? | |:---------------------------------:|:-------------------------|:----------------------------|:--------------------------------|:------------------------|:-----------------------------------|:-----------------------------------------------|:---------------------| -| [Primary Source](#primary-source) | master | little endian | Linux,Darwin | None | True | True | False | +| [Primary Source](#primary-source) | master | 64-bit little-endian | Linux,Darwin | None | True | True | False | | [Primary Source](#primary-source) | master | x86\_64 | Linux,Darwin | AVX2,AVX512,PCLMUL,SSE2 | True | True | False | Are implementations chosen based on runtime CPU feature detection? **Yes**. diff --git a/docs/algorithms/kem/bike.yml b/docs/algorithms/kem/bike.yml index da78cb8f6e..c2afe74a89 100644 --- a/docs/algorithms/kem/bike.yml +++ b/docs/algorithms/kem/bike.yml @@ -40,7 +40,7 @@ parameter-sets: - upstream: primary-upstream upstream-id: master supported-platforms: - - architecture: little endian + - architecture: 64-bit little-endian operating_systems: - Linux - Darwin @@ -76,7 +76,7 @@ parameter-sets: - upstream: primary-upstream upstream-id: master supported-platforms: - - architecture: little endian + - architecture: 64-bit little-endian operating_systems: - Linux - Darwin @@ -112,7 +112,7 @@ parameter-sets: - upstream: primary-upstream upstream-id: master supported-platforms: - - architecture: little endian + - architecture: 64-bit little-endian operating_systems: - Linux - Darwin