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

platform support documentation [skip ci] #1605

Merged
merged 8 commits into from
Dec 16, 2023
Merged

platform support documentation [skip ci] #1605

merged 8 commits into from
Dec 16, 2023

Conversation

baentsch
Copy link
Member

@baentsch baentsch commented Nov 6, 2023

Implements results of discussion on platforms supported.

  • [no] Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from x.y.z to x.(y+1).0.)
  • [no] Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in fully supported downstream projects dependent on these, i.e., oqs-provider and OQS-OpenSSH will also need to be ready for review and merge by the time this is merged.)

@baentsch baentsch requested a review from a team November 6, 2023 12:27
PLATFORMS.md Outdated Show resolved Hide resolved
PLATFORMS.md Show resolved Hide resolved
PLATFORMS.md Show resolved Hide resolved
@baentsch baentsch marked this pull request as ready for review December 2, 2023 11:07
PLATFORMS.md Show resolved Hide resolved
PLATFORMS.md Show resolved Hide resolved
PLATFORMS.md Outdated Show resolved Hide resolved
@baentsch
Copy link
Member Author

baentsch commented Dec 5, 2023

Additional thought: "Tier 0" sounds a bit .... "close to negative" :), i.e., to me feels not properly denominating the "highest" tier. Also, what about platforms for which there shall be formally verified implementations available (that also should be CT & side-channel attack resistant & code-reviewed & fuzzed & .... etc.): Shouldn't those represent the highest tier? Slight disadvantage of such tier: It would have no entries right now...

@SWilson4
Copy link
Member

SWilson4 commented Dec 5, 2023

Additional thought: "Tier 0" sounds a bit .... "close to negative" :), i.e., to me feels not properly denominating the "highest" tier. Also, what about platforms for which there shall be formally verified implementations available (that also should be CT & side-channel attack resistant & code-reviewed & fuzzed & .... etc.): Shouldn't those represent the highest tier? Slight disadvantage of such tier: It would have no entries right now...

What about keeping them as "Tier 1" but marking them with an asterisk? We can add extra modifiers as needed for additional tested properties. I agree that we don't want to run up against the well-ordering principle. ;)

@dstebila dstebila added this to the 0.10.0 milestone Dec 7, 2023
@baentsch baentsch mentioned this pull request Dec 14, 2023
@baentsch baentsch requested a review from SWilson4 December 15, 2023 15:03
Copy link
Member

@SWilson4 SWilson4 left a comment

Choose a reason for hiding this comment

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

I made one (very, very minor) suggestion to change the asterisk to a dagger, as I realized that asterisks (1) don't stand out much to a reader and (2) are used for a wide variety of other meanings in documentation. Plus we already use a dagger in the README.

PLATFORMS.md Outdated Show resolved Hide resolved
PLATFORMS.md Outdated Show resolved Hide resolved
@baentsch baentsch merged commit 8449e54 into main Dec 16, 2023
52 checks passed
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.

6 participants