pq_crypto 0.6.3 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aee26c8aa17143d9a17bd24b9435f073cc5d40beff39cbc90d0685d2221ff8d9
-  data.tar.gz: b0d51294d4639587c619fd5854d2c33d01b5aaa82929aae759dcb8f5776fefbe
+  metadata.gz: 68e8c2cd661300cb364be85b4939787590eb88217a2f3cb3463e262b66c4c662
+  data.tar.gz: fef5359500d367c68b50b2a72b54cfc8980b3c6dfd6b0e132998212e34cbd47a
 SHA512:
-  metadata.gz: a293e6386c7a350be36b271f9e26fef69f1f3e6050fd3eca5e5f69a7f039c39ad08d152cecf46918b1fa8d60908746c2784de27cae3e0351082cb1c63470fe49
-  data.tar.gz: e12be8a7ad95c42cb27659215c4bfe9201d5b18d531c344279707c2ce74d5fb981328c28beb79e72815e182acc0790b9a5682af8adf17c8b737a12e691d830ec
+  metadata.gz: 12bfac65233efde5fa34a30df51494bc6da59985287ae2b3954b377dc9afa949f16b509e98db25d7af2a61a7f3b6a4e572b21f33ff85e797a153ee0e0dde10a0
+  data.tar.gz: 25ccfe8a57150355da41a115c401d7ccee2b10a0a6a42957f8335cd3c97024d14261188ee676bc6a122557f52a4ea5894d67062dace53f983b51b4244d9d1a6a

data/.github/workflows/ci.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   vendor-verify:
     name: vendor-verify
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
       - name: Checkout
@@ -30,8 +30,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest]
-        ruby: ["3.1", "3.4", "4.0"]
+        os: [ubuntu-24.04, macos-latest]
+        ruby: ["2.7.2", "3.1", "3.4", "4.0"]
 
     steps:
       - name: Checkout
@@ -48,15 +48,139 @@ jobs:
         with:
           go-version: "1.26.0"
 
+      - name: Select system OpenSSL 3 for Ruby 2.7 on Linux
+        if: matrix.os == 'ubuntu-24.04' && matrix.ruby == '2.7.2'
+        shell: bash
+        run: |
+          set -euxo pipefail
+
+          sudo apt-get update
+          sudo apt-get install -y libssl-dev pkg-config
+
+          multiarch="$(dpkg-architecture -qDEB_HOST_MULTIARCH)"
+          system_pc_path="/usr/lib/${multiarch}/pkgconfig:/usr/lib/pkgconfig:/usr/share/pkgconfig"
+
+          version="$(
+            PKG_CONFIG_PATH="${system_pc_path}" \
+            PKG_CONFIG_LIBDIR="${system_pc_path}" \
+            pkg-config --modversion openssl
+          )"
+
+          case "${version}" in
+            3.*) ;;
+            *)
+              echo "Expected system OpenSSL 3.x, got ${version}"
+              exit 1
+              ;;
+          esac
+
+          {
+            echo "OPENSSL_ROOT_DIR=/usr"
+            echo "OPENSSL_DIR="
+            echo "PKG_CONFIG_PATH=${system_pc_path}"
+            echo "PKG_CONFIG_LIBDIR=${system_pc_path}"
+          } >> "${GITHUB_ENV}"
+
+          echo "System OpenSSL selected: ${version}"
+          PKG_CONFIG_PATH="${system_pc_path}" PKG_CONFIG_LIBDIR="${system_pc_path}" \
+            pkg-config --variable=includedir openssl
+          PKG_CONFIG_PATH="${system_pc_path}" PKG_CONFIG_LIBDIR="${system_pc_path}" \
+            pkg-config --variable=libdir openssl
+
       - name: Verify vendored sources
         run: bundle exec rake vendor:verify
 
       - name: Compile extension
-        run: bundle exec rake compile
+        run: bundle exec rake clean compile
+
+      - name: Verify linked OpenSSL 3 on Linux Ruby 2.7
+        if: matrix.os == 'ubuntu-24.04' && matrix.ruby == '2.7.2'
+        shell: bash
+        run: |
+          set -euxo pipefail
+
+          extension="lib/pqcrypto/pqcrypto_secure.so"
+          test -f "${extension}"
+          ldd "${extension}" | tee linked-libraries.txt
+          # The extension uses libcrypto only (SHA3/SHAKE/EVP/RAND); it links no
+          # TLS symbols, so libssl is intentionally not a dependency.
+          grep -E 'libcrypto\.so\.3([[:space:]]|$)' linked-libraries.txt
+          if grep -E 'libssl\.so' linked-libraries.txt; then
+            echo "Unexpected libssl linkage; the extension should need libcrypto only" >&2
+            exit 1
+          fi
+
+      - name: Verify linked OpenSSL 3 on macOS Ruby 2.7
+        if: matrix.os == 'macos-latest' && matrix.ruby == '2.7.2'
+        shell: bash
+        run: |
+          set -euxo pipefail
+
+          extension="lib/pqcrypto/pqcrypto_secure.bundle"
+          test -f "${extension}"
+          otool -L "${extension}" | tee linked-libraries.txt
+          # libcrypto only; the extension links no TLS symbols, so libssl is
+          # intentionally not a dependency.
+          grep -E 'libcrypto\.3\.dylib' linked-libraries.txt
+          if grep -E 'libssl\.3\.dylib' linked-libraries.txt; then
+            echo "Unexpected libssl linkage; the extension should need libcrypto only" >&2
+            exit 1
+          fi
 
       - name: Run tests
         run: bundle exec rake test
 
+      - name: Build and install source gem on Linux Ruby 2.7
+        if: matrix.os == 'ubuntu-24.04' && matrix.ruby == '2.7.2'
+        shell: bash
+        run: |
+          set -euxo pipefail
+
+          gem build pq_crypto.gemspec
+
+          gem_file="$(
+            ruby -Ilib -rpq_crypto/version \
+              -e 'print "pq_crypto-#{PQCrypto::VERSION}.gem"'
+          )"
+
+          gem install "./${gem_file}" --no-document
+
+          ruby -e '
+            require "pq_crypto"
+
+            kem = PQCrypto::KEM.generate(:ml_kem_768)
+            encapsulation = kem.public_key.encapsulate
+            shared_secret = kem.secret_key.decapsulate(encapsulation.ciphertext)
+            raise "ML-KEM mismatch" unless shared_secret == encapsulation.shared_secret
+
+            signature_key = PQCrypto::Signature.generate(:ml_dsa_65)
+            message = "ruby-2.7.2-built-gem".b
+            signature = signature_key.secret_key.sign(message)
+            raise "ML-DSA verify failed" unless signature_key.public_key.verify(message, signature)
+          '
+
+          installed_extension="$(
+            ruby -e '
+              spec = Gem::Specification.find_by_name("pq_crypto")
+              path = Dir[File.join(spec.full_gem_path, "lib", "pqcrypto", "pqcrypto_secure.so")].first
+              abort "installed extension not found" unless path
+              print path
+            '
+          )"
+
+          ldd "${installed_extension}" | tee installed-linked-libraries.txt
+          grep -E 'libcrypto\.so\.3([[:space:]]|$)' installed-linked-libraries.txt
+          if grep -E 'libssl\.so' installed-linked-libraries.txt; then
+            echo "Unexpected libssl linkage; the extension should need libcrypto only" >&2
+            exit 1
+          fi
+
+      - name: Show mkmf logs on failure
+        if: failure()
+        shell: bash
+        run: |
+          find tmp -name mkmf.log -print -exec cat {} \; || true
+
   interop-openssl-3-5-required:
     needs: vendor-verify
     name: interop-openssl-3.5-required
@@ -81,12 +205,12 @@ jobs:
           sudo ldconfig
           /opt/openssl-3.5/bin/openssl version
           /opt/openssl-3.5/bin/openssl version | grep -E '^OpenSSL 3\.(5|[6-9]|[1-9][0-9])\.'
-          echo /opt/openssl-3.5/bin >> "$GITHUB_PATH"
+          echo /opt/openssl-3.5/bin >> "${GITHUB_PATH}"
           {
             echo "OPENSSL_ROOT_DIR=/opt/openssl-3.5"
             echo "PKG_CONFIG_PATH=/opt/openssl-3.5/lib64/pkgconfig"
             echo "LD_LIBRARY_PATH=/opt/openssl-3.5/lib64"
-          } >> "$GITHUB_ENV"
+          } >> "${GITHUB_ENV}"
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
@@ -103,7 +227,7 @@ jobs:
         run: bundle exec rake vendor:verify
 
       - name: Compile extension
-        run: bundle exec rake compile
+        run: bundle exec rake clean compile
 
       - name: Run tests
         run: |
@@ -117,10 +241,17 @@ jobs:
             exit 1
           fi
 
+      - name: Show mkmf logs on failure
+        if: failure()
+        shell: bash
+        run: |
+          find tmp -name mkmf.log -print -exec cat {} \; || true
+
   linux-native-backend:
     needs: test
     name: linux-native-backend
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
+
     env:
       PQCRYPTO_NATIVE_ASM: "1"
 
@@ -148,18 +279,19 @@ jobs:
             require "pq_crypto"
 
             kem = PQCrypto::KEM.generate(:ml_kem_768)
-            enc = kem.public_key.encapsulate
-            raise "ML-KEM mismatch" unless kem.secret_key.decapsulate(enc.ciphertext) == enc.shared_secret
+            encapsulation = kem.public_key.encapsulate
+            shared_secret = kem.secret_key.decapsulate(encapsulation.ciphertext)
+            raise "ML-KEM mismatch" unless shared_secret == encapsulation.shared_secret
 
-            sig = PQCrypto::Signature.generate(:ml_dsa_65)
-            msg = "linux-native-backend".b
-            signature = sig.secret_key.sign(msg)
-            raise "ML-DSA verify failed" unless sig.public_key.verify(msg, signature)
+            signature_key = PQCrypto::Signature.generate(:ml_dsa_65)
+            message = "linux-native-backend".b
+            signature = signature_key.secret_key.sign(message)
+            raise "ML-DSA verify failed" unless signature_key.public_key.verify(message, signature)
           '
 
       - name: Verify AVX2 native symbols
         run: |
           set -euxo pipefail
-          so="lib/pqcrypto/pqcrypto_secure.so"
-          test -f "$so"
-          nm "$so" | grep -E "pqcr_(mlkem|mldsa).*avx2|keccak.*avx2"
+          extension="lib/pqcrypto/pqcrypto_secure.so"
+          test -f "${extension}"
+          nm "${extension}" | grep -E "pqcr_(mlkem|mldsa).*avx2|keccak.*avx2"

data/CHANGELOG.md

@@ -1,5 +1,78 @@
 # Changelog
 
+## [0.6.5] - 2026-08-04
+
+### Changed
+
+- update native mlkem `v1.2.0` -> `v1.3.0`
+
+  Upstream is a feature/integration release with no security fixes and no
+  changes to the ML-KEM algorithm implementation. Everything relevant to this
+  gem is unchanged: the exported symbol set, all key/ciphertext/shared-secret
+  sizes, and the derived key material for ML-KEM-512/768/1024 (verified
+  byte-for-byte against `v1.2.0` for both the portable and the AVX2 build,
+  including the implicit-rejection path and the SHAKE256/SHA3-256 helpers used
+  by the X-Wing combiner).
+
+  What upstream changed that is visible in the vendored tree:
+  - new opt-in `MLK_CONFIG_NO_{KEYPAIR,ENCAPS,DECAPS}_API` build options; the
+    gem needs all three operations and does not set them
+  - the AArch64 arithmetic and FIPS-202 backends are now gated on compile-time
+    NEON availability (`MLK_SYS_AARCH64_NEON`) and on the new `MLK_SYS_CAP_NEON`
+    runtime capability, which defaults to "available"
+  - new opt-in `MLK_SYS_AARCH64_FAST_SHA3` for CPUs with high SHA3 throughput
+  - backend assembly files renamed with an `mlkem_` prefix and assembly-local
+    labels namespaced with `mlk_`; both are internal to the vendored aggregator
+    `mlkem_native_asm.S` and transparent to this build
+  - context-parameter machinery moved into the new `mlkem/src/context.h`
+
+  Note that `mlkem-native` v1.3.0 is the last release before a breaking v2;
+  `release/v1.3` is the upstream support branch.
+
+- `mldsa-native` remains pinned at `v1.0.0-beta2`, which is still the latest
+  upstream tag.
+
+### Testing
+
+- Added `test/native_api_conformance`, a compile-only check that validates the
+  hand-written declarations in `ext/pqcrypto/pqcrypto_native_api.h` against the
+  vendored upstream headers. The extension deliberately never includes
+  `mlkem_native.h` / `mldsa_native.h`, so nothing else in the build could catch
+  size or prototype drift after a vendor bump.
+
+### CI
+
+- Run the native API conformance check right after `vendor:verify`.
+- Verify that the AArch64 assembly backends are actually compiled in on
+  macOS ARM runners, and smoke-test ML-KEM and ML-DSA against that build.
+
+## [0.6.4] - 2026-07-18
+
+### Compatibility
+
+- Lowered the minimum supported Ruby version from `>= 3.1` to `>= 2.7.1`.
+- Kept the Ruby 3.4+ scheduler-aware `RB_NOGVL_OFFLOAD_SAFE` path unchanged.
+- Ruby 2.7.1-3.3 use the existing no-GVL compatibility path without claiming Fiber Scheduler offload guarantees.
+- Made the test-only `async` dependency conditional so development dependencies resolve on Ruby 2.7.1.
+
+### CI
+
+- Added an Ubuntu Ruby 2.7 compatibility job on Ruby 2.7.2, including the full test suite and a built-gem install smoke test. Ruby 2.7.1 remains the declared floor; the hosted Linux job uses 2.7.2 because exact 2.7.1 is not available through the runner toolchain.
+
+### Build
+
+- Fixed OpenSSL 3 discovery on Intel and Apple Silicon macOS by resolving the Homebrew `openssl@3` prefix dynamically.
+- Ignore stale OpenSSL 1.1 `pkg-config` metadata instead of injecting incompatible headers into native builds.
+- Validate the selected OpenSSL prefix and link against the OpenSSL 3 API during configuration, preventing mixed headers/library builds.
+- Link the validated OpenSSL libraries by absolute path, preventing Ruby 2.7 Linux toolchains from selecting their bundled OpenSSL 1.1 while preserving mkmf's libruby-safe default path precedence.
+- Prefer Linux multiarch OpenSSL library directories over generic `lib` directories when resolving an explicit installation prefix.
+- Avoid Clang macro-expansion warnings on Ruby 2.7 by using the function-form `rb_intern2` API without changing symbol semantics.
+- Remove only Ruby 2.7's obsolete macOS `-multiply_defined,suppress` linker option, preserving all other inherited linker flags including `-undefined,dynamic_lookup`.
+
+### Documentation
+
+- Documented the Ruby 2.7.1+ support policy and the concurrency guarantees for compatibility runtimes.
+
 ## [0.6.3] - 2026-06-24
 
 ### Changed

data/GET_STARTED.md

@@ -445,7 +445,7 @@ On Ruby 3.4 and later, signing and verification keep Ruby's scheduler-aware
 that implements `blocking_operation_wait`, blocking native work can be moved
 off the event loop.
 
-Ruby 3.1-3.3 are supported as a compatibility path: native operations still
+Ruby 2.7.1-3.3 are supported as a compatibility path: native operations still
 release the GVL, but `RB_NOGVL_OFFLOAD_SAFE` is not available there, so the gem
 does not claim Fiber Scheduler offload guarantees on those runtimes.
 

data/README.md

@@ -63,9 +63,9 @@ original algorithms:
 
 ## Requirements
 
-- Ruby 3.1 or later
+- Ruby 2.7.1 or later
   - Ruby 3.4+ keeps the optimized Fiber Scheduler offload path via `RB_NOGVL_OFFLOAD_SAFE`
-  - Ruby 3.1-3.3 use the compatibility no-GVL path without scheduler offload guarantees
+  - Ruby 2.7.1-3.3 use the compatibility no-GVL path without scheduler offload guarantees
 - a C toolchain with C11 support
 - OpenSSL 3.0 or later with SHA3-256 and SHAKE256 available
 - vendored minimal PQ Code Package native snapshot in `ext/pqcrypto/vendor`
@@ -87,6 +87,11 @@ bundle exec rake vendor
 bundle exec rake compile
 ```
 
+Upstream pins are recorded in `ext/pqcrypto/vendor/.vendored` and enforced by
+`bundle exec rake vendor:verify`. `mlkem-native` is pinned at `v1.3.0`, which
+upstream describes as the last release before a breaking `v2`; `release/v1.3` is
+the upstream support branch. `mldsa-native` is pinned at `v1.0.0-beta2`.
+
 The default build uses the portable native source path. Upstream native assembly
 can be tested explicitly with: