squash

Signed-off-by: Felipe Ventura <[email protected]>
open-quantum-safe · Mar 13, 2024 · 8ffaeda · 8ffaeda
1 parent b7fe232
commit 8ffaeda
Show file tree

Hide file tree

Showing 74 changed files with 10,460 additions and 1,294 deletions.
diff --git a/.CMake/toolchain_windows_amd64.cmake b/.CMake/toolchain_windows_amd64.cmake
@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: MIT
+
+set(CMAKE_SYSTEM_NAME Windows)
+
+set(CMAKE_SYSTEM_PROCESSOR AMD64)
+
+set(CMAKE_CROSSCOMPILING OFF)
+
+set(CMAKE_GENERATOR_PLATFORM
+    x64
+    CACHE STRING "Platform" FORCE
+)
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -166,7 +166,7 @@ jobs:
       - when:
           condition:
             not:
-              equal: [ openssl@3.1, << parameters.OPENSSL_PREINSTALL >> ]
+              equal: [ openssl@3, << parameters.OPENSSL_PREINSTALL >> ]
           steps:
             - run:
                 name: Clone and build OpenSSL(3) master
@@ -186,7 +186,7 @@ jobs:
                   fi
       - when:
           condition:
-              equal: [ openssl@3.1, << parameters.OPENSSL_PREINSTALL >> ]
+              equal: [ openssl@3, << parameters.OPENSSL_PREINSTALL >> ]
           steps:
             - run:
                 name: Build OQS-OpenSSL provider
@@ -301,12 +301,12 @@ workflows:
       - macOS:
           name: macOS-shared
           CMAKE_ARGS: -DBUILD_SHARED_LIBS=ON -DOQS_DIST_BUILD=OFF -DOQS_ENABLE_KEM_CLASSIC_MCELIECE=OFF
-          OPENSSL_PREINSTALL: openssl@3.1
+          OPENSSL_PREINSTALL: openssl@3
       - macOS:
           name: macOS-static
           OQS_PROVIDER_BUILD_STATIC: true
           CMAKE_ARGS: -DOQS_DIST_BUILD=OFF -DOQS_ENABLE_KEM_CLASSIC_MCELIECE=OFF
-          OPENSSL_PREINSTALL: openssl@3.1
+          OPENSSL_PREINSTALL: openssl@3
   on-main-branch:
     when:
       or:

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -2,7 +2,7 @@
 name: Bug report
 about: Create a report to help us improve
 title: ''
-labels: ''
+labels: 'bug'
 assignees: ''
 
 ---

diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md
@@ -0,0 +1,25 @@
+---
+name: Question, Feature, Documentation
+labels: 'question'
+about: Ask question, request feature or documentation update
+---
+
+### Thank you for taking the time to share your thoughts with us.
+
+We welcome all suggestions for new features or documentation updates
+helping others to make better use of this project.
+
+As with any other topic you'd like to discuss with the community,
+we'd primarily like to invite you to [open a discussion](https://github.com/open-quantum-safe/oqs-provider/discussions)
+item with your concern.
+
+If you have a bug to report please use the [Bug report template](https://github.com/open-quantum-safe/oqs-provider/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=).
+
+If you have an issue with the project that does not qualify as a bug
+and have already explored the code to the extent that you can make a
+proposal how to handle the issue, please feel free to open a
+"blank issue" providing all information you have already collected.
+
+Please remember to tell us which code version/branch you are using and
+then briefly describe the issue and proposal how to resolve it if
+available.
diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml
@@ -8,6 +8,26 @@ on:
 
 jobs:
 
+  linux_baseline:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        cmake-params: [ "", "-DOQS_KEM_ENCODERS=ON" ]
+    container:
+      image: openquantumsafe/ci-ubuntu-jammy:latest
+    env:
+      MAKE_PARAMS: "-j 18"
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Full build
+        run: OQSPROV_CMAKE_PARAMS=${{ matrix.cmake-params}} ./scripts/fullbuild.sh
+      - name: Enable sibling oqsprovider for testing
+        run: cd _build/lib && ln -s oqsprovider.so oqsprovider2.so
+      - name: Test
+        run: ./scripts/runtests.sh -V
+
   linux_intel:
     runs-on: ubuntu-latest
     strategy:
@@ -30,7 +50,7 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
       - name: Full build
-        run: OPENSSL_BRANCH=${{ matrix.ossl-branch }} ./scripts/fullbuild.sh
+        run: OPENSSL_BRANCH=${{ matrix.ossl-branch }} LIBOQS_BRANCH=main ./scripts/fullbuild.sh
       - name: Enable sibling oqsprovider for testing
         run: cd _build/lib && ln -s oqsprovider.so oqsprovider2.so
       - name: Test
@@ -45,6 +65,7 @@ jobs:
           ! pip3 install -r oqs-template/requirements.txt 2>&1 | grep ERROR && \
           python3 oqs-template/generate.py && \
           find . -type f -and '(' -name '*.h' -or -name '*.c' -or -name '*.inc' ')' | xargs clang-format -i && \
+          git diff && \
           ! git status | grep modified
       - name: Build .deb install package
         run: cpack

diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml
@@ -70,7 +70,14 @@ jobs:
         working-directory: _build
       # Try brew install of head: If error message below appears, build and test passed successfully
       - name: brew install test
-        run: brew install --HEAD --formula -s oqsprovider.rb 2>&1 | grep "Empty installation"
+        # try this only if brew'd liboqs knows about ML-KEM:
+        run: |
+          bash -c 'brew install liboqs && FIND_MLKEM=`brew info liboqs | grep files | awk "{print $1}"`
+            if [[ `echo $FIND_MLKEM | grep ML_KEM` ]]; then
+               brew install --HEAD --formula -s oqsprovider.rb 2>&1 | grep "Empty installation"
+            else
+               echo "ML-KEM not present in liboqs. Skipping test."
+            fi'
         working-directory: scripts
       - name: Retain oqsprovider.dylib
         uses: actions/upload-artifact@v3

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,58 @@
+name: Release tests
+
+on:
+  repository_dispatch:
+    types: [ "liboqs-release" ]
+
+# To trigger this job, generate a GitHub personal access token and run the following command:
+#
+# curl --request POST \
+#      --header "Accept: application/vnd.github+json" \
+#      --header "Authorization: Bearer YOUR_TOKEN_HERE" \
+#      --header "X-GitHub-Api-Version: 2022-11-28" \
+#      --data '{
+#                "event_type": "liboqs-release",
+#                "client_payload": {
+#                                    "provider_ref": "PROVIDER_BRANCH_OR_TAG_HERE",
+#                                    "liboqs_ref": "LIBOQS_BRANCH_OR_TAG_HERE"
+#                                  }
+#              }' \
+#      https://api.github.com/repos/open-quantum-safe/oqs-provider/dispatches
+
+jobs:
+  release-test:
+    runs-on: ubuntu-latest
+    container:
+      image: openquantumsafe/ci-ubuntu-jammy:latest
+
+    steps:
+      - name: Check if requested ref exists
+        env:
+          provider_ref: ${{ github.event.client_payload.provider_ref }}
+        run: |
+          # try both branch and tag
+          wget --quiet \
+               --header "Accept: application/vnd.github+json" \
+               --header "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+               --header "X-GitHub-Api-Version: 2022-11-28" \
+               https://api.github.com/repos/open-quantum-safe/oqs-provider/branches/$provider_ref || \
+          wget --quiet \
+               --header "Accept: application/vnd.github+json" \
+               --header "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+               --header "X-GitHub-Api-Version: 2022-11-28" \
+               https://api.github.com/repos/open-quantum-safe/oqs-provider/git/ref/tags/$provider_ref \
+            && echo "provider_ref=$provider_ref" >> "$GITHUB_ENV" \
+            || echo "provider_ref=main" >> "$GITHUB_ENV"
+      - name: Checkout oqs-provider on requested ref if it exists; otherwise, fall back to main
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.provider_ref }}
+      # This is designed to be triggered automatically from liboqs CI, so don't bother validating the liboqs ref.
+      - name: Checkout liboqs at requested ref
+        uses: actions/checkout@v4
+        with:
+          repository: open-quantum-safe/liboqs
+          path: liboqs
+          ref: ${{ github.event.client_payload.liboqs_ref }}
+      - name: Run release tests
+        run: OPENSSL_BRANCH=master ./scripts/release-test-ci.sh
diff --git a/.github/workflows/standalone.yml b/.github/workflows/standalone.yml
@@ -8,7 +8,7 @@ on:
 
 jobs:
 
-  macos_intel:
+  standalone_macos_intel:
     runs-on: macos-13
     strategy:
       fail-fast: false
@@ -17,12 +17,17 @@ jobs:
         run: brew install liboqs
       - name: Checkout oqsprovider code
         uses: actions/checkout@v2
-      - name: Build oqsprovider
-        run: cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl@3 -S . -B _build && cmake --build _build
-      - name: Test oqsprovider
-        run: ctest --parallel 5 --test-dir _build
+      - name: Build and test oqsprovider
+        # try this only if brew'd liboqs knows about ML-KEM:
+        run: |
+          bash -c 'FIND_MLKEM=`brew info liboqs | grep files | awk "{print $1}"`
+            if [[ `echo $FIND_MLKEM | grep ML_KEM` ]]; then
+               cmake -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl@3 -S . -B _build && cmake --build _build && ctest --parallel 5 --test-dir _build
+            else
+               echo "ML-KEM not present in liboqs. Skipping test."
+            fi'
 
-  linux_intel:
+  standalone_linux_intel:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false

diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml
@@ -96,12 +96,13 @@ jobs:
     strategy:
       matrix:
         os:
+# liboqs doesn't check Windows 2019
           - windows-2019
-#          - windows-2022
+          - windows-2022
         platform:
           - arch: win64
             oqsconfig: -DOQS_ALGS_ENABLED=STD
-            osslconfig: no-shared no-fips VC-WIN64A-masm
+            osslconfig: no-shared no-fips VC-WIN64A
 #          - arch: win32
 #            oqsconfig: -DOQS_ALGS_ENABLED=STD
 #            osslconfig: --strict-warnings no-fips enable-quic
@@ -125,6 +126,7 @@ jobs:
         with:
           set-safe-directory: true
           repository: open-quantum-safe/liboqs
+          ref: main
           path: liboqs
       - uses: ilammy/msvc-dev-cmd@v1
         with:
@@ -148,7 +150,7 @@ jobs:
           cmake --version
           mkdir build
           cd build
-          cmake -GNinja -DCMAKE_C_FLAGS="/wd5105" -DCMAKE_VERBOSE_MAKEFILE=ON -DCMAKE_INSTALL_PREFIX="c:\liboqs" ${{ matrix.platform.oqsconfig }} -DOQS_DIST_BUILD=ON ..
+          cmake -GNinja -DCMAKE_C_COMPILER="cl" -DCMAKE_C_FLAGS="/wd5105" -DCMAKE_VERBOSE_MAKEFILE=ON -DCMAKE_INSTALL_PREFIX="c:\liboqs" ${{ matrix.platform.oqsconfig }} -DOQS_DIST_BUILD=ON ..
           ninja
           ninja install
         working-directory: liboqs
@@ -187,7 +189,7 @@ jobs:
           key: ${{ runner.os }}-msvcopenssl32
       - name: build oqs-provider
         run: |
-          cmake -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_FLAGS="/wd5105" -DOPENSSL_ROOT_DIR="c:\openssl32" -Dliboqs_DIR="c:\liboqs\lib\cmake\liboqs" -S . -B _build
+          cmake -GNinja -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER="cl" -DCMAKE_C_FLAGS="/wd5105" -DOPENSSL_ROOT_DIR="c:\openssl32" -Dliboqs_DIR="c:\liboqs\lib\cmake\liboqs" -S . -B _build
           cd _build
           ninja
       - name: Run tests
@@ -237,6 +239,7 @@ jobs:
           with:
             set-safe-directory: true
             repository: open-quantum-safe/liboqs
+            ref: main
             path: liboqs
         - uses: ilammy/msvc-dev-cmd@v1
           with:
@@ -292,7 +295,7 @@ jobs:
             key: ${{ runner.os }}-msvcopenssl32n
         - name: build oqs-provider
           run: |
-            cmake -DCMAKE_BUILD_TYPE=${{ matrix.type }} -DCMAKE_C_FLAGS="/wd5105" -DOPENSSL_ROOT_DIR="c:\openssl32n" -Dliboqs_DIR="c:\liboqs\lib\cmake\liboqs" -S . -B _build
+            cmake --toolchain ${{ matrix.toolchain }} -DCMAKE_BUILD_TYPE=${{ matrix.type }} -DCMAKE_C_COMPILER="cl"  -DCMAKE_C_FLAGS="/wd5105" -DOPENSSL_ROOT_DIR="c:\openssl32n" -Dliboqs_DIR="c:\liboqs\lib\cmake\liboqs" -S . -B _build
             cmake --build _build --config=${{ matrix.type }}
         - name: Run tests
           run: |

diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,7 @@ tmp
 interop.log
 # pycache
 oqs-template/__pycache__
+scripts/__pycache__
 
 # Visual Studio Code
 .vscode