Add Readme #4
Open
Add Readme #4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jonas Schneider-Bensch <[email protected]>
Signed-off-by: Jonas Schneider-Bensch <[email protected]>
Signed-off-by: Jonas Schneider-Bensch <[email protected]>
Signed-off-by: Jonas Schneider-Bensch <[email protected]>
Signed-off-by: Jonas Schneider-Bensch <[email protected]>
Signed-off-by: Jonas Schneider-Bensch <[email protected]>
Signed-off-by: Jonas Schneider-Bensch <[email protected]>
franziskuskiefer
approved these changes
Jul 15, 2025
| in your project directory, or add | ||
|
|
||
| ``` | ||
| libcrux-ml-kem = "0.0.2" |
There was a problem hiding this comment.
Suggested change
| libcrux-ml-kem = "0.0.2" | |
| libcrux-ml-kem = "0.0.3" |
| APIs follow the general structure of the ML-KEM APIs. | ||
| - `check-secret-independence`: All operations on ring elements in the | ||
| portable implementation use the integer types of the | ||
| `libcrux-secrets` crate under the hood. That crate allows checking a |
There was a problem hiding this comment.
Shall we link the secrets crate here?
Suggested change
| `libcrux-secrets` crate under the hood. That crate allows checking a | |
| [`libcrux-secrets`](https://crates.io/crates/libcrux-secrets) crate under the hood. That crate allows checking a |
| - `check-secret-independence`: All operations on ring elements in the | ||
| portable implementation use the integer types of the | ||
| `libcrux-secrets` crate under the hood. That crate allows checking a | ||
| program operating on these types for secret indepence at compile |
There was a problem hiding this comment.
Suggested change
| program operating on these types for secret indepence at compile | |
| program operating on these types for secret independence at compile |
Comment on lines
+117
to
+118
| values are not used in operations that are known to be | ||
| non-constant time. While the implementation of constant time |
There was a problem hiding this comment.
Suggested change
| values are not used in operations that are known to be | |
| non-constant time. While the implementation of constant time | |
| values are not used in operations that are known to have | |
| data-dependent execution time. While the implementation of constant time |
Comment on lines
+146
to
+147
| ## FAQ | ||
| TBD |
There was a problem hiding this comment.
I can't really think of anything here right now. Let's just drop it for now and add it when we have content.
Suggested change
| ## FAQ | |
| TBD |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR provides a
README.mdformlkem-rust-libcrux.It tries to follow the proposed structure from pq-code-package/tsc#151
[ ] 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.)