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

incorrect OQSPROVIDER_VERSION_TEXT in 0.7.0 release #550

Open
jschauma opened this issue Oct 17, 2024 · 10 comments
Open

incorrect OQSPROVIDER_VERSION_TEXT in 0.7.0 release #550

jschauma opened this issue Oct 17, 2024 · 10 comments
Labels
bug Something isn't working

Comments

@jschauma
Copy link
Contributor

Describe the bug
After installing the 0.7.0 release, openssl list -providers shows:

  oqsprovider
    name: OpenSSL OQS Provider
    version: 0.7.1-dev
    status: active

This is due to 60417e9, which erroneously was included in the 0.7.0 release, it seems.

@jschauma jschauma added the bug Something isn't working label Oct 17, 2024
@baentsch
Copy link
Member

Hmm -- how did you test this? There was an error in the initial release but when I built right now against tag "0.7.0", the release ID is correct.

@jschauma
Copy link
Contributor Author

$ curl -L -O https://github.com/open-quantum-safe/oqs-provider/archive/0.7.0.tar.gz
$ md5 0.7.0.tar.gz 
MD5 (0.7.0.tar.gz) = a82cb549c32c118139507f6fa72d7cff
$ tar zxf 0.7.0.tar.gz
$ md5 oqs-provider-0.7.0/CMakeLists.txt 
MD5 (oqs-provider-0.7.0/CMakeLists.txt) = 18613ab96caba07c0dd00bee99f567b7
$ grep OQSPROVIDER_VERSION oqs-provider-0.7.0/CMakeLists.txt 
set(OQSPROVIDER_VERSION_TEXT "0.7.1-dev")

@baentsch
Copy link
Member

Ahh, thanks for the description @jschauma . @praveksharma , was there a reason the artifacts of the release didn't get corrected (to also be) in line with the release tag?

@praveksharma
Copy link
Member

praveksharma commented Oct 23, 2024

Thank you for catching this @jschauma. I've fixed this, the artifacts should be correct now. The release notes should also include reflect that. Could you please check again?

@baentsch I am not entirely certain. I believe I followed the same process then that I did right now.

@jschauma
Copy link
Contributor Author

Yes, confirmed that the release archive now has the right version in it.

However, this brings with it a problem: the release archive was changed, but the version hasn't changed. This will trip up package management systems that verify archives against known checksums (e.g., NetBSD's pkgsrc). It'd be ideal if any time a release archive is changed, its version number changes. So you might e.g., include additional micro numbers or some other signifier to indicate to the user that this is a different archive from the previously published one (e.g., 0.7.0.1 or 0.7.0r1).

@praveksharma
Copy link
Member

praveksharma commented Oct 23, 2024

This will trip up package management systems that verify archives against known checksums (e.g., NetBSD's pkgsrc).

I see, this makes sense. @baentsch should we do a 0.7.2 patch release to avoid this and any other issues that may arrise due to the mistakes made in #534? I say 0.7.2 specifically to avoid the 0.7.0/0.7.1 ambiguity caused by said error.

netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Oct 23, 2024
Upstream had reported the wrong release version in the module and the fix
updated the already released archive without bumping the version.

See:
open-quantum-safe/oqs-provider#550
@jschauma
Copy link
Contributor Author

Yeah, that would work. I have no strong preference for how you bump versions, but even though this seems like a cosmetic change, it might be easiest to just jump to 0.7.2 and then roll forward with every change.

@iyanmv
Copy link
Member

iyanmv commented Oct 30, 2024

However, this brings with it a problem: the release archive was changed, but the version hasn't changed. This will trip up package management systems that verify archives against known checksums (e.g., NetBSD's pkgsrc). It'd be ideal if any time a release archive is changed, its version number changes. So you might e.g., include additional micro numbers or some other signifier to indicate to the user that this is a different archive from the previously published one (e.g., 0.7.0.1 or 0.7.0r1).

+1 to this comment

I maintain the AUR package for Arch Linux and only now I noticed the checksum mismatch when setting up a new device.

iyanmv added a commit to iyanmv/PKGBUILDs that referenced this issue Oct 30, 2024
@baentsch
Copy link
Member

@praveksharma as you volunteered doing a release fixing this issue, what about doing it now? The latest additions bringing the code in line with the different specs (IANA code points, Composite) IMO justifies, possibly even warrants, a release.

@ghen2
Copy link

ghen2 commented Nov 1, 2024

You may want to hold off a little bit, as IANA will likely still alter the MLKEM codepoints: https://mailarchive.ietf.org/arch/msg/tls/0mVA6kJugR5XhSjqLLhLUActjQM/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

5 participants