-
Notifications
You must be signed in to change notification settings - Fork 0
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
Classic McEliece Cryptodoc #186
base: main
Are you sure you want to change the base?
Conversation
Re:sourceref: I'll have a go at the discussion we had in the FrodoKEM PR. Let's see how we can integrate this. But having an explicit way to shorten the reference links is certainly a good idea. Edit: I cherry-picked your path elision feature in #188. Let's rebase once that is merged. |
17432c2
to
c04c0ea
Compare
Rebased to main, resolved pending merge conflicts and removed the commit adding the truncation feature to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice, I like it a lot! I added some editorial comments
b78f90f
to
f953875
Compare
Thanks for your comprehensive review, @atreiber94! I addressed your comments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, lgtm!
I left open some minor things, most notably I think we should explicitly rule out introducing timing side channels by utilizing the bitvector class when we mention that only parts of the functionality are constant time.
Addressed all the comments |
Co-authored-by: Amos Treiber <[email protected]>
Co-authored-by: weitkaemper-bsi <[email protected]>
Postponed once more into Botan 3.7.0 |
Crypto documentation for Botan's Classic McEliece implementation.
Truncated Source Links
I experimented with the
:srcref:
restructuredText role for this documentation. I think the file location lists are unnecessarily bulked with redundant data. I introduced a truncated:srcref
view that addresses this problem. In Classic McEliece, I name the Classic McEliece directory once for the reader and then use something like::srcref:`[src/lib/pubkey/classic_mceliece]/cmce_types.h`
which is displayed as.../cmce_types.h
. The link works properly, of course.Note that the CI fails until randombit/botan#3883 is merged.
TODO Tracker