Repository navigation
v1.3.0
mlkem-native v1.3.0
Release notes
mlkem-native v1.3.0 adds configuration options to control which KEM operations are included in a build. It also improves AArch64 feature detection and runtime dispatch, and introduces ABI compliance checks for assembly backends. Embedded testing now uses Zephyr across a broader range of Arm targets, while assembly namespacing and source naming improve integration with projects such as AWS-LC.
See the full change log here: v1.2.0...v1.3.0
What's next? mlkem-native v2
This is expected to be the last release prior to mlkem-native v2. Between v1.3.0 and v2, breaking changes to the main branch will be made.
Long-Term Support
release/v1.3 will act as a support branch until 6 months after mlkem-native v2 is established. It will receive bugfixes, but no new features. We do currently not plan to offer long-term support for mlkem-native v1.x beyond that timeframe.
If you are deploying mlkem-native v1.3 and expect to be unable to upgrade to mlkem-native v2 within 6 months of its release, please contact us to discuss a potential extension of the support schedule.
What's New
Configuration / API
- Add
MLK_CONFIG_NO_KEYPAIR_API,MLK_CONFIG_NO_ENCAPS_API, andMLK_CONFIG_NO_DECAPS_API, allowing unused KEM operations and their internal dependencies to be excluded. All non-empty API combinations are covered in CI. (#1787) - Gate the AArch64 arithmetic and FIPS-202 backends on compile-time NEON availability and the new
MLK_SYS_CAP_NEONruntime capability. Integrators can now fall back to portable C on AArch64 systems without usable NEON. (#1805, #1809) - Add
MLK_SYS_AARCH64_FAST_SHA3to select the pure-Neon Armv8.4-A SHA3 implementation on CPUs with sufficient SHA3 execution capacity, including Graviton5. (#1784)
Assurance / Testing
- Fix deterministic-only builds using
MLK_CONFIG_NO_RANDOMIZED_API, including test, example, and stack-measurement coverage. (#1816) - Upgrade CBMC to v6.10.0, the newest release of CBMC including the fix cbmc/#9011 to the Z3 soundness issue z3/#9550. mlkem-native v1.2 had pinned CBMC to an unstable version between v6.9 and v6.10 which already included that fix. (#1762)
- Add assembly ABI checkers for AArch64, x86_64 SysV, ppc64le ELFv2, and Armv8.1-M MVE. The checkers verify preservation of callee-saved registers and run as part of the standard test suite. (#1135)
- Add Zephyr-based testing for QEMU Cortex-M3, M4, M7, M33, and M55 targets, replacing the previous custom MPS baremetal platforms. Add test and benchmark support for the NUCLEO-N657X0-Q board. (#1750, #1547)
- Strengthen HOL Light tooling with cross-architecture proof execution and checks that every expected theorem is present (#1634)
- Strengthen Wycheproof validation by checking newly specified fields, rejecting unknown schema fields, and tracking upstream vector changes. (#1801)
- Extend Windows MSVC coverage to allocation-failure, RNG-failure, and Wycheproof tests (#1738)
- Add emulated testing on x86_64 without AVX2. (#1753)
- Correct decapsulation stack measurements, which previously returned before the full operation and understated peak stack use by around 10%. (#1823)
Integration / Upgrade Notes
- Namespace assembly-local labels with an
mlk_prefix, preventing collisions when mlkem-native and other projects are combined into one assembly unit. (#1813) - Rename backend assembly files to be self-identifying. Arithmetic assembly filenames now use an
mlkem_prefix. Downstream build systems with explicit source lists must update those paths. (#1821) - Move context-parameter support into the new
mlkem/src/context.h; downstream source manifests must include this file. (#1768)
What's Changed
- CI: Run x86_64 functional tests on an emulated non-AVX2 CPU by @mkannwischer in #1753
- Add ABI checkers for x86_64, AArch64, PPC64le, Armv8.1-M by @hanno-becker in #1135
- AArch64: Remove dead instructions from NTT, invNTT, rej_uniform by @hanno-becker in #1754
- CI: Build macOS FIPS202 sanitizer tests with clang 22 by @hanno-becker in #1761
- Upgrade to tagged release of CBMC 6.10.0 by @rod-chapman in #1762
- AArch64: Synchronize clean and optimized assembly by @hanno-becker in #1756
- CI: Install sqlite3 via apt instead of nix profile by @mkannwischer in #1765
- Add Windows MSVC test support: rng_fail, alloc, wycheproof by @willieyz in #1738
- Add Zephyr-based test platform for QEMU MPS boards by @mkannwischer in #1750
- nix: Pull CBMC 6.10.0 from nixos-unstable binary cache by @mkannwischer in #1778
- bench: Add Graviton5 (c9g) to EC2 benchmark matrix by @mkannwischer in #1782
- AArch64: Add MLK_SYS_AARCH64_FAST_SHA3 for fast SHA3 CPUs by @mkannwischer in #1784
- CI: Update GitHub action dependencies by @mkannwischer in #1779
- Create Nucleo N657x0-Q Platform by @bremoran in #1547
- HOL-Light: improve tooling and CI by @L-series in #1634
- zephyr: keep project CFLAGS off Zephyr internals by @mkannwischer in #1791
- README: Replace stale sub-workflow badges with all.yml by @mkannwischer in #1789
- autogen: Improve wording and reduce verbosity of documentation by @hanno-becker in #1758
- common: Split context-parameter machinery into context.h by @mkannwischer in #1768
- zephyr: fix NUCLEO benchmark timing and TCM layout by @bremoran in #1796
- Add gcc to the NIX shell on macOS to support CBMC by @rod-chapman in #1780
- Correct name of poly_getnoise_eta1_4x_native harness file by @rod-chapman in #1800
- CI: Track upstream Wycheproof ML-KEM vector updates by @hanno-becker in #1801
- AArch64: Add runtime NEON capability gate to native backend by @hanno-becker in #1805
- AArch64: Add compile-time guard for Neon by @hanno-becker in #1809
- Backends: Namespace assembly local labels with mlk_ prefix by @hanno-becker in #1813
- Make tests and examples compatible with reduced-API configurations by @hanno-becker in #1787
- Fix build for MLK_CONFIG_NO_RANDOMIZED_API by @hanno-becker in #1816
- test_stack: Use a valid secret key for the decaps measurement by @mkannwischer in #1823
- Backends: Prefix assembly filenames with mlkem_ by @hanno-becker in #1821
- CI: Test import into AWS-LC v5.4.0 by @hanno-becker in #1831
- Fix stale filename references by @mkannwischer in #1833
- CI: Run on release branches by @mkannwischer in #1837