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

Make default block_len a multiple of blake2 blocksize and tidy docs. #195

Merged
merged 17 commits into from May 16, 2020

Conversation

dbaarda
Copy link
Member

@dbaarda dbaarda commented May 14, 2020

Make the default blocksize a multiple of the 128 byte blake2b block size, which is 2x the md4sum blocksize of 64. This makes calculating both blake2b and md4sum strongsums a tiny bit faster.

Update docs and docstrings to include rs_sig_args() and rs_build_hash_table(). Update TODO and add a heading. Add exported file utils to docs. Remove instructions about setting job->sig_file_bytes to pre-allocate the signature because this is not publicly exposed. Update and tidy format.md for new magic types.

Update doc/Doxyfile.in with doxygen -u.

Update NEWS.md with all additions since v2.3.0 so far.

dbaarda added 17 commits May 12, 2020
…ize.

Note the md4sum blocksize is 64, so using 128 ensures it is an integer
multiple of the strongsum blocksize for both kinds of strongsum.

This makes calculating both blake2b and md4sum strongsums a tiny bit faster,
since they don't need to add a padded tail block when finalizing the sum.
Add suggestion of strong_len=20 as a good compromize between safety against
attacks and signature size.

Add suggestion to use rs_sig_size() and argument defaults to rs_sig_file().
Change the titles and refer to the api's as "Streaming API", "Callback API"
and "Whole-file API".

Add instructions about using rs_sig_args() and rs_build_hash_table().

Remove instructions about setting job->sig_file_bytes to pre-allocate the
signature because this is not publicly exposed... the rs_job_t structure is
not public.
All other references use '\' as the doxygen escape, so be consistent.
This updates a heap of comments and removes some obsolete settings.
This means we use an updated doxygen to match the updated config.
This reverts commit 5cd40a7.

This didn't help. The bionic version of doxygen has a bug and emits even more
warnings that the xenial version.
@dbaarda dbaarda merged commit b005057 into librsync:master May 16, 2020
1 check passed
@dbaarda dbaarda deleted the opt/sigargs1 branch May 16, 2020
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.

None yet

1 participant