Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.8.0 rc1 branch #593

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

0.8.0 rc1 branch #593

wants to merge 6 commits into from

Conversation

praveksharma
Copy link
Member

Please see the relevant pre-release (currently in draft): https://github.com/open-quantum-safe/oqs-provider/releases/tag/untagged-e8b2d0985929c684a8d5

This PR makes the following changes:

  • Bumps the version string,
  • stores a copy of generate.yml as generate.yml-0.12.0,
  • Updates SECURITY.md,
  • Updates RELEASE.md,
  • Points CI to liboqs 0.12.0, and
  • Points CI to OpenSSL 3.4.0.

Checks done:

  • Stable under generate.py and do_code_format.sh,
  • CI is green,
  • 'LIBOQS_BRANCH=0.12.0 OPENSSL_BRANCH=openssl-3.4.0 ./scripts/fullbuild.sh -F && ./scripts/runtests.sh -V` runs OK,
  • release-tests.sh with liboqs 0.12.0 and openssl 3.4.0 runs OK,
  • nginx, curl, and httpd docker images build OK, and
  • OpenSSL external test integration passes when run locally with gh act --job external-tests-providers. (Logs attached: logs.txt. Note that the external-tests-providers jobs fails because the tests for pkcs11-provider fail but oqs-provider passes.).

This PR will not land; once approved, a new 0.8.0-release PR will be made.

Signed-off-by: Pravek Sharma <sharmapravek@gmail.com>
Signed-off-by: Pravek Sharma <sharmapravek@gmail.com>
Signed-off-by: Pravek Sharma <sharmapravek@gmail.com>
Signed-off-by: Pravek Sharma <sharmapravek@gmail.com>
Signed-off-by: Pravek Sharma <sharmapravek@gmail.com>
RELEASE.md Outdated
@@ -14,7 +14,47 @@ Further details on building, testing and use can be found in [README.md](https:/

## Release notes

This is version 0.7.1-dev of oqs-provider which continues from the earlier 0.7.0 release. This release is fully tested to be used in conjunction with the main branch of [liboqs](https://github.com/open-quantum-safe/liboqs) and is guaranteed to be in sync with v0.12.0 of `liboqs` as and when released.
This is version 0.8.0-rc1 of oqs-provider which continues from the earlier 0.7.0 release. This release is fully tested to be used in conjunction with the main branch of [liboqs](https://github.com/open-quantum-safe/liboqs) and is guaranteed to be in sync with v0.12.0 of `liboqs` as and when released.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: suggest deletion of trailing "as and when released".

RELEASE.md Outdated

### Deprecation notice

The associated liboqs v0.12.0 release will be the last liboqs release to include Kyber (that is, the NIST Round 3 version of Kyber, prior to its standardization by NIST as ML-KEM in FIPS 203). Applications should switch to ML-KEM (FIPS 203).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this phrased in liboqs terms? This is oqsprovider and the ramifications for its users should be documented, e.g., "This is to notify users of kyber algorithms to switch to the standardized "mlkem" algorithms as support for Kyber will be removed with the next release of liboqs and oqsprovider."

Presence/absence of APIs invisible/inaccessible to users of oqsprovider IMO do not need to be documented at all in the release notes.

RELEASE.md Outdated
In addition to improving testing, CI, and fixing platform specific build issues this release of oqs-provider:

* Updates IANA code points for ML-KEM.
* Adds support for ML-DSA (FIPS 204 final version) along with support for context strings (when built against an OpenSSL verision also supporting that feature).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: typo.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition: The context string support in oqsprovider is a (new) feature entirely independent of ML-DSA and warrants its own line item.

Signed-off-by: Pravek Sharma <sharmapravek@gmail.com>
@praveksharma
Copy link
Member Author

Thank you for the suggestions @baentsch! I've included the changes here and on the draft pre-release: https://github.com/open-quantum-safe/oqs-provider/releases/tag/untagged-0fb2ad16a1ba976ea75a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants