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

Manually implement Zeroize #411

Merged
merged 1 commit into from
Jul 17, 2024
Merged

Manually implement Zeroize #411

merged 1 commit into from
Jul 17, 2024

Conversation

gardk
Copy link
Contributor

@gardk gardk commented Jul 8, 2024

Removes dependence on proc-macros when enabling the zeroize feature.

As the macros previously made sure that all fields were zeroed, I opted for destructuring self in the impls so that a compile error will be triggered if a field is added and not handled.

Used as_mut_slice().zeroize() on arrays even though they implement Zeroize. This is because the implementation on slices zeroes the whole slice then issues an atomic_fence() call, while the array implementation calls it for every element. Don't know and haven't tested if there's a difference in optimizations. Both implementations produce the same result anyway :)

@oconnor663
Copy link
Member

Thank you! This seems reasonable. Could you help me address a few points?

  • Is there a measurable clean build time difference before and after?
  • Can you confirm that something fails (either the build or existing tests) if any of these impls is deleted?
  • Could you add inline comments next to spots where you're doing destructuring, with a quick explanation of why you're doing it?
  • Similarly, could you comment on the array vs slice distinction inline, so that future readers (i.e. future me) will know why the difference matters.

@gardk
Copy link
Contributor Author

gardk commented Jul 12, 2024

Added comments. Reverted to array implementation as the atomic_fence() call I was so worried about doesn't actually generate any code, and looking at the assembly the array implementation looks much better. No real difference in performance between the two either way.

Here's the difference in clean build time on my machine.

# Manual
Time (mean ± σ):      1.356 s ±  0.202 s    [User: 2.496 s, System: 0.591 s]
Range (min … max):    1.197 s …  1.806 s    10 runs

# Derive
Time (mean ± σ):      3.720 s ±  0.212 s    [User: 9.807 s, System: 1.430 s]
Range (min … max):    3.564 s …  4.298 s    10 runs

Every impl is already used by existing tests added in #309, removing any one of them causes those to fail compiling.

Removes dependence on proc-macros when enabling the zeroize feature.
@oconnor663 oconnor663 merged commit 84a4ec3 into BLAKE3-team:master Jul 17, 2024
51 checks passed
@oconnor663
Copy link
Member

Oh wow yeah, that's a huge difference. Looks great, thanks again!

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.

2 participants