sharpetronics/liboqs
1
0
Fork 0
mirror of https://github.com/open-quantum-safe/liboqs.git synced 2025-10-04 00:02:01 -04:00
Code Issues Projects Releases Wiki Activity

0.8.0-rc1

Browse Source
This commit is contained in:
Douglas Stebila 2023-05-22 19:41:41 -04:00
parent 6e1f49aa48
commit 7728f20d4d
3 changed files with 106 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CMakeLists.txt
View File

@ -33,7 +33,7 @@ set(CMAKE_C_STANDARD 11)
set(CMAKE_C_STANDARD_REQUIRED ON)
set(CMAKE_POSITION_INDEPENDENT_CODE ON)
set(CMAKE_C_VISIBILITY_PRESET hidden)
set(OQS_VERSION_TEXT "0.8.0-dev")
set(OQS_VERSION_TEXT "0.8.0-rc1")
set(OQS_COMPILE_BUILD_TARGET "${CMAKE_SYSTEM_PROCESSOR}-${CMAKE_HOST_SYSTEM}")
set(OQS_MINIMAL_GCC_VERSION "7.1.0")
set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

191
RELEASE.md
View File

@ -1,5 +1,5 @@
liboqs version 0.7.2
====================
liboqs version 0.8.0-rc1
========================
About
-----
@ -11,7 +11,7 @@ The **Open Quantum Safe (OQS) project** has the goal of developing and prototypi
liboqs can be used with the following Open Quantum Safe application integrations:
- **OQS-OpenSSL 1.1.1**: A prototype integration of liboqs-based authentication and key exchange into TLS 1.3 in our fork of OpenSSL 1.1.1; see the [OQS-OpenSSL-1\_1\_1-stable](https://github.com/open-quantum-safe/openssl/tree/OQS-OpenSSL_1_1_1-stable) branch of our OpenSSL fork's repository.
- **oqs-provider**: A standalone prototype [OpenSSL 3 provider](https://www.openssl.org/docs/manmaster/man7/provider.html) enabling liboqs-based quantum-safe and hybrid key exchange for TLS 1.3, and post-quantum and hybrid X.509 certificate generation and CMS operations.
- **oqs-provider**: A standalone prototype [OpenSSL 3 provider](https://www.openssl.org/docs/manmaster/man7/provider.html) enabling liboqs-based quantum-safe and hybrid key authentication and exchange for TLS 1.3, X.509 certificate generation and CMS operations.
- **OQS-BoringSSL**: A prototype integration of liboqs-based authentication and key exchange into TLS 1.3 in our fork of BoringSSL; see https://github.com/open-quantum-safe/boringssl.
- **OQS-OpenSSH**: A prototype integration of liboqs-based authentication and key exchange into Secure Shell (SSH) version 2 in our fork of OpenSSH; see https://github.com/open-quantum-safe/openssh.
@ -29,109 +29,126 @@ liboqs can also be used in the following programming languages via language-spec
Release notes
=============
This is version 0.7.2 of liboqs. It was released on August 21, 2022.
Security considerations
-----------------------
This release removes Rainbow level 1 and all variants of SIDH and SIKE due to cryptanalytic breaks of those algorithms. Users are advised to move away from use of those algorithms immediately.
This is release candidate 1 of version 0.8.0 of liboqs. It was released on May 22, 2023.
What's New
----------
This release continues from the 0.7.1 release of liboqs.
This release continues from the 0.7.2 release of liboqs.
The goal of this release is to provide a final release for algorithms that were included in Round 3 of the NIST Post-Quantum Standardization project. As the security status of some algorithms changed during Round 3, it drops algorithms known to be broken as of release (Rainbow level 1, SIKE). Some algorithms also updated their specification during Round 3; version 0.7.2 does not incorporate any algorithm changes that result in different input/output behaviour compared to version 0.7.1; such changes will included in version 0.8.0.
The next release of liboqs, version 0.8.0, will remove some algorithms that did not advance beyond NIST Round 3, update implementations based on algorithm/specification revisions that happened during Round 3, and begin to incorporate Round 4 changes. Discussion of algorithms to be removed in version 0.8.0 can be found in https://github.com/open-quantum-safe/liboqs/issues/1245.
This release features many algorithm updates, including removal of algorithms and variants no longer proceeding through NIST standardization and updates to newer versions. See the detailed list of algorithm updates below.
### Key encapsulation mechanisms
- Kyber: Update implementation and switch use of symmetric crypto to OQS common code
- HQC: Fix build on gcc-12
- SIKE: Remove SIKE due to break (https://eprint.iacr.org/2022/975)
- BIKE: updated to Round 4 version.
- Kyber: 90s variants were removed.
- NTRU Prime: All variants were removed, except for sntrup761.
- Saber: removed.
### Digital signature schemes
- Dilithium: Add ARMv8 optimized implementation and switch use of symmetric crypto to OQS common code
- Picnic: Update implementation
- Rainbow: Remove Rainbow level 1 due to break (https://eprint.iacr.org/2022/214)
- Dilithium; AES variants were removed.
- Falcon: updated to the 2023-02-07 version.
- Picnic: removed.
- Rainbow: removed.
- SPHINCS+: updated to version 3.1; SPHINCS+-Haraka variants were removed; SPHINCS+-SHA256 and SPHINCS+-SHAKE variants were renamed
### Other changes
- Add support for building on powerpc64
- Update XKCP implementation
- Improve SHA2 implementation on ARMv8
- Improve AES implementation on ARMv8
- Add aarch64 CPU feature detection on FreeBSD
- Improve cross-compiling on Windows
- Enable integration of liboqs into other CMake-based projects
- Add Cryptographic Bill of Materials (CBOM)
- Improve building on ARM platforms
- Improve performance when using OpenSSL 3 for symmetric cryptography
- Increment shared object library version
- New configure-time options for algorithm selections
- pkgconfig file now available
---
Detailed changelog
------------------
* Update Picnic to 3.0.8 by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1158
* XCode update by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1162
* Add support for powerpc64 by @pkubaj in https://github.com/open-quantum-safe/liboqs/pull/1160
* remove picnic from cygwin build by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1171
* adding constant time test as weekly github action by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1170
* extend weekly run timeout [skip ci] by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1172
* Update XKCP and avoid assembler .ifdef directives by @jschanck in https://github.com/open-quantum-safe/liboqs/pull/1173
* Updated constant_time suppression files after picnic update by @christianpaquin in https://github.com/open-quantum-safe/liboqs/pull/1174
* Update to Picnic 3.0.9 by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1167
* Mark stack non-executable when compiling with clang or gcc by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1161
* extend timeout to 10h by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1175
* skip sphincs,rainbow in shortened weekly testing by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1176
* Fixed build issue on arm based macs when using gcc11 by @Martyrshot in https://github.com/open-quantum-safe/liboqs/pull/1177
* disable BIKE on all 32bitters except x86 by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1180
* Update to picnic 3.0.11 (fixes #1178) by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1181
* Weekly run update by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1182
* weekly job moved to Sunday [skip ci] by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1183
* Resolves an issue when building sha2 using arm crypto extensions with gcc11 by @Martyrshot in https://github.com/open-quantum-safe/liboqs/pull/1184
* Suppress constant time check for public matrix generation on Kyber AVX2 by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1189
* create and install cmake import files by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1191
* adding warning re Rainbow to documentation [skip ci] by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1193
* ARMv8 optimized Dilithium by @Martyrshot in https://github.com/open-quantum-safe/liboqs/pull/1194
* skip yamllint test for good by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1196
* Edits to key scheduling for AES on ARM to be constant time by @tedeaton in https://github.com/open-quantum-safe/liboqs/pull/1200
* Correct OQS_DIST_BUILD for ARM by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1202
* Deal with some issues identified by clang scan-build by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1211
* Issues and passes for aarch64 const time checks by @tedeaton in https://github.com/open-quantum-safe/liboqs/pull/1214
* Use `SecRandomCopyBytes` for system randomness on iOS (to allow building on iOS) by @zanebeckwith in https://github.com/open-quantum-safe/liboqs/pull/1219
* workaround for picnic under msys2 by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1220
* Adding aarch64 CPU feature detection for FreeBSD by @Martyrshot in https://github.com/open-quantum-safe/liboqs/pull/1210
* Added typecasts to tests/ds_benchmark.h to silence clang warnings by @Martyrshot in https://github.com/open-quantum-safe/liboqs/pull/1225
* doxygen update by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1228
* Link documentation and code by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1229
* Integrates pqcrystals with common-aes / extends common code AES CTR-API by @bhess in https://github.com/open-quantum-safe/liboqs/pull/1221
* Adds AES context release in Dilithium-AES / fix memory leak by @bhess in https://github.com/open-quantum-safe/liboqs/pull/1238
* Update Picnic to 3.0.14 (fixes #1212) by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1237
* improve Windows crosscompile handling by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1236
* Bump Picnic to 3.0.15 by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1241
* Updated Dilithium sign.c patch with AES context release (2) by @bhess in https://github.com/open-quantum-safe/liboqs/pull/1242
* adding scan-build test by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1240
* adding memory leak testing by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1234
* disable msys2 testing by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1243
* docs: Add valgrind as test dependencies in README.md by @yin19941005 in https://github.com/open-quantum-safe/liboqs/pull/1251
* Sync Kyber with upstream, enable Scan-Build with Kyber by @bhess in https://github.com/open-quantum-safe/liboqs/pull/1252
* Deal with the issue identified by valgrind by @splasky in https://github.com/open-quantum-safe/liboqs/pull/1250
* pqclean_hqc: Fix build on GCC-12 by @vt-alt in https://github.com/open-quantum-safe/liboqs/pull/1254
* Remove Rainbow level 1 by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1263
* Updated to SIKE v3.5.1 by @christianpaquin in https://github.com/open-quantum-safe/liboqs/pull/1231
* update PR template to include oqs-provider (OSSL dependency) [skip ci] by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1269
* Update to Picnic 3.0.16 (fixes #1253) by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1271
* Remove SIDH and SIKE by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1272
* fixing FreeBSD runtime ARM CPU feature detection by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1267
* Update CODEOWNERS by @vsoftco in https://github.com/open-quantum-safe/liboqs/pull/1274
* adding library version retrieval function by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1273
* fixup dilithium-avx2 valgrind test file by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1283
* Add option to all pytests to skip particular algorithms by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1282
* Update to Picnic 3.0.17 by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1280
* Update release notes by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1281
* add warning about HQC [skip ci] by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1284
* Cover SHA3/SHAKE-implementation specific code paths in Picnic suppres… by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1286
* Add missing requirements to the requirements.txt by @thb-sb in https://github.com/open-quantum-safe/liboqs/pull/1295
* Solve '-Wstrict-prototypes' for clang >= 15.0 by @thb-sb in https://github.com/open-quantum-safe/liboqs/pull/1293
* Ensure build without an executable stack (fixes #1285) by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1294
* Fix typo in Picnic's NEON detection by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1298
* ARM32 gcc12 build workaround by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1297
* Fallback code for `aligned_alloc` and use of `explicit_bzero` by @sebastinas in https://github.com/open-quantum-safe/liboqs/pull/1300
* update version string indicating dev status by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1305
* addressing sig length questions by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1306
* Integer overflow leading to incorrect SHA3 computation by @jschanck in https://github.com/open-quantum-safe/liboqs/pull/1312
* Fixing OQS ARM inconsistencies by @Martyrshot in https://github.com/open-quantum-safe/liboqs/pull/1307
* automatically activate USE_RASPBERRY_PI define by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1313
* update Kyber and Dilithium from upstream by @bhess in https://github.com/open-quantum-safe/liboqs/pull/1316
* Remove rainbow by @xvzcf in https://github.com/open-quantum-safe/liboqs/pull/1321
* Removed Picnic signature scheme. by @xvzcf in https://github.com/open-quantum-safe/liboqs/pull/1323
* Removed NTRU-Prime. by @xvzcf in https://github.com/open-quantum-safe/liboqs/pull/1325
* Removed SABER. by @xvzcf in https://github.com/open-quantum-safe/liboqs/pull/1326
* add valgrind option by @malbert1 in https://github.com/open-quantum-safe/liboqs/pull/1327
* Removed NTRU. by @xvzcf in https://github.com/open-quantum-safe/liboqs/pull/1335
* Add ntruprime by @ryndia in https://github.com/open-quantum-safe/liboqs/pull/1328
* fix: initialize context after reset in ossl_sha3x4 by @bhess in https://github.com/open-quantum-safe/liboqs/pull/1339
* Enable algorithm filtering by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1333
* Revert "Enable algorithm filtering (#1333)" by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1351
* llvm15 update by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1350
* Adds CBOM for liboqs by @bhess in https://github.com/open-quantum-safe/liboqs/pull/1337
* Fix Doxygen Markdown failures by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1349
* Build dump_alg_info in tests by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1353
* Build Doxygen docs in whatever the CMake build directory is by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1357
* NIST std algs list selection enablement by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1355
* Config update by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1361
* add cpack (for .deb packages) by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1362
* Updated PQClean commit in `copy_from_upstream.yml` by @xvzcf in https://github.com/open-quantum-safe/liboqs/pull/1359
* Bump gitpython from 3.0.7 to 3.1.30 in /scripts/copy_from_upstream by @dependabot in https://github.com/open-quantum-safe/liboqs/pull/1354
* Fixed mismatch between YAML and markdown docs for some algorithms. by @xvzcf in https://github.com/open-quantum-safe/liboqs/pull/1365
* adding OpenSSL3 test; activating sanitizer test by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1363
* re-enabling msys2 testing after picnic is gone by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1373
* Use OQS_STATUS types in FrodoKEM by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1377
* compiler future-proofing Release builds by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1378
* BIKE Round-4 update by @dkostic in https://github.com/open-quantum-safe/liboqs/pull/1369
* Fix rendering error in Markdown by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1384
* Update Falcon to 20230207 by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1386
* Revert "Update Falcon to 20230207 (PQClean commit 96dfee95cc56207d1ec… by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1392
* Add full-cycle speed test by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1391
* update BIKE documentation by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1387
* correct free in test_kem/sig by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1399
* Copy from upstream (Kyber), add pqcrystals-* licenses to README by @bhess in https://github.com/open-quantum-safe/liboqs/pull/1403
* Update Falcon implementation by @thomwiggers in https://github.com/open-quantum-safe/liboqs/pull/1395
* adding issue template [skip ci] by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1410
* Copy_from_upstream: no subprocess call & update_cbom fix for CI. by @bhess in https://github.com/open-quantum-safe/liboqs/pull/1412
* CI test copy_from_upstream by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1405
* Fix constant time failure for Falcon AVX2 by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1415
* clarify OpenSSL config [skip ci] by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1429
* Make BIKE decode function void to avoid ct issues by @dkostic in https://github.com/open-quantum-safe/liboqs/pull/1400
* rm duped "the" in pull_request_template.md by @Rudxain in https://github.com/open-quantum-safe/liboqs/pull/1439
* fix "ths" typo by @Rudxain in https://github.com/open-quantum-safe/liboqs/pull/1438
* Generate and install pkgconfig file by @tranzystorek-io in https://github.com/open-quantum-safe/liboqs/pull/1435
* Initial fetching of MD and Cipher objects from OpenSSL(3) by @beldmit in https://github.com/open-quantum-safe/liboqs/pull/1431
* Use CMake flag for -Werror by @thomwiggers in https://github.com/open-quantum-safe/liboqs/pull/1444
* Add missing x86 check in CMakeLists by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1445
* src/common/common.c (set_available_cpu_extensions): Cope without `HWCAP_SHA3' by @distorted-mdw in https://github.com/open-quantum-safe/liboqs/pull/1447
* Limit gcc version supported by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1451
* disable OpenSSL if neither AES,SHA2, or SHA3 are OSSL-provided by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1453
* Fixing OpenSSL SHA2 incremental API integration by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1454
* Update SPHINCS+ by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1420
* Remove remaining references to SPHINCS+-Haraka, Kyber 90s, Dilithium-AES by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1465
* relax OpenSSL initialization error handling by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1463
* once OSSL init by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1469
* Renamed sphincs-sha256-X to sphincs-sha2-X and sphincs-shake256-X to … by @xvzcf in https://github.com/open-quantum-safe/liboqs/pull/1467
* Extend test_hash to cover more input lengths by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1468
* protect ossl cleanup from multithreading errors by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1472
* Update SPHINCS+ specification version [skip ci] by @dstebila in https://github.com/open-quantum-safe/liboqs/pull/1477
* Patch AVX2 support: No Win for Sphincs+ by @baentsch in https://github.com/open-quantum-safe/liboqs/pull/1478
**Full Changelog**: https://github.com/open-quantum-safe/liboqs/compare/0.7.1...0.7.2
New Contributors
----------------
* @thb-sb made their first contribution in https://github.com/open-quantum-safe/liboqs/pull/1295
* @malbert1 made their first contribution in https://github.com/open-quantum-safe/liboqs/pull/1327
* @ryndia made their first contribution in https://github.com/open-quantum-safe/liboqs/pull/1328
* @dependabot made their first contribution in https://github.com/open-quantum-safe/liboqs/pull/1354
* @Rudxain made their first contribution in https://github.com/open-quantum-safe/liboqs/pull/1439
* @tranzystorek-io made their first contribution in https://github.com/open-quantum-safe/liboqs/pull/1435
* @beldmit made their first contribution in https://github.com/open-quantum-safe/liboqs/pull/1431
* @distorted-mdw made their first contribution in https://github.com/open-quantum-safe/liboqs/pull/1447
**Full Changelog**: https://github.com/open-quantum-safe/liboqs/compare/0.7.2...0.8.0-rc1

2
src/CMakeLists.txt
View File

@ -75,7 +75,7 @@ set_target_properties(oqs
ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib"
LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib"
VERSION ${OQS_VERSION_TEXT}
SOVERSION 2
SOVERSION 3
# For Windows DLLs
RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin")