Fix SRP6 tests, review and refactor SRP6 modules
#65
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
Previously, we were calling this documentation the "C++ Botan documentation". Calling it "C++ API reference" is closer to what the handbook calls it at https://botan.randombit.net/handbook/api_ref/contents.html
jorisdral
changed the title
SRP6 modulesSRP6 tests, review and refactor SRP6 modules
The test-suite was disabled because it fails to run successfully. The test-suite is enabled again, even though the tests still fail. Fixes for these tests will be included in coming commits.
Reduced levels of indentation means we have more horizontal real estate to work with in Haskell files. Putting `::` on the same line as function definitions improves syntax highlighting.
jorisdral
force-pushed
the
jdral/srp6
branch
2 times, most recently
from
5b92c14 to
f8eb95d
Compare
This includes only the relevant modules from `botan-bindings` and `botan-low`. In particular, we work around a bug in `srp6ServerSessionStep1` in `botan-low` where an exception is thrown from C code by `botan_srp6_server_session_step1` because it is called twice by `srp6ServerSessionStep1`. This is bug in the Botan C++ library, see randombit/botan#5112. The best we can do for now is to try to not trigger the exception. The work-around we introduce is to make sure we call the erroring function (`botan_srp6_server_session_step1`) only once. Previously, we were calling it once to "query" the size of output buffers, and then again with the correct sizes of output buffers. We can instead use `botan_srp6_group_size`/`srp6GroupSize` to determine the correct sizes of output buffers immediately. This is now done this way automatically where appropriate in `botan-low`, but not in `botan-bindings`. Moreover, users can still call `botan_srp6_server_session_step1`/`srp6ServerSessionStep1` twice if they want to, meaning that the exception can still be triggered. To warn against this, we make sure to include appropriate warnings in the Haddock documentation. The other smaller changes do not affect the functionality of the code, only documentation and such.
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.
Resolves #28