libcrux icon indicating copy to clipboard operation
libcrux copied to clipboard

Update Readmes

Open jschneider-bensch opened this issue 1 year ago • 3 comments

This PR adds some basic Readme files to subcrates, indicating their verification status. In the description of the status on the top-level, I indicate that each crate should contain a more detailed note describing its verification status, beyond the binary verified/pre-verification distinction. These notes are not yet part of the PR.

jschneider-bensch avatar Jul 29 '24 14:07 jschneider-bensch

What needs to be done to get this in @jschneider-bensch ?

franziskuskiefer avatar Aug 14 '24 05:08 franziskuskiefer

@karthikbhargavan suggested a further distinction between verified algorithms and verified APIs on top, which would clarify the situation in cases like libcrux-hkdf, where we have a thin unverified API on top of verified algorithms.

jschneider-bensch avatar Aug 14 '24 06:08 jschneider-bensch

Ok, if you think that's worth doing, let's do it. Should be pretty quick. Otherwise we should get this merged.

franziskuskiefer avatar Aug 14 '24 06:08 franziskuskiefer

@jschneider-bensch let's get this in either as is (after resolving the conflicts) with a follow-up on the verified APIs, or do that right in here if it's quick enough. But this has been sitting here for long enough.

franziskuskiefer avatar Sep 10 '24 12:09 franziskuskiefer

I'll file a follow-up to provide more detailed verification status.

jschneider-bensch avatar Sep 10 '24 12:09 jschneider-bensch