crypto/cipher: document that GCM AEADs are safe for concurrent use#80341
Open
soreavis wants to merge 1 commit into
Open
crypto/cipher: document that GCM AEADs are safe for concurrent use#80341soreavis wants to merge 1 commit into
soreavis wants to merge 1 commit into
Conversation
The AEAD returned by NewGCM keeps no mutable state after construction: Seal and Open read only the key material and tables set up at construction time and write only to the destination and stack-local buffers. It is therefore safe for concurrent use whenever the underlying cipher.Block is, as is the case for the Block returned by aes.NewCipher. Note that through the legacy gcmAble hook a Block can supply its own AEAD implementation, whose concurrency behavior this package cannot guarantee; the hook is unexported and slated for removal, so the wording treats concurrency safety as a requirement on such implementations. Document this on NewGCM, and add a test that shares one AEAD across goroutines running Seal and Open round-trips with distinct nonces, so the race detector can check the property. The test covers the AES and fallback implementations via testAllImplementations. Fixes golang#41689
Contributor
|
This PR (HEAD: fcdbeb0) has been imported to Gerrit for code review. Please visit Gerrit at https://go-review.googlesource.com/c/go/+/799066. Important tips:
|
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
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.
The AEAD returned by NewGCM keeps no mutable state after construction:
Seal and Open read only the key material and tables set up at
construction time and write only to the destination and stack-local
buffers. It is therefore safe for concurrent use whenever the
underlying cipher.Block is, as is the case for the Block returned by
aes.NewCipher.
Note that through the legacy gcmAble hook a Block can supply its own
AEAD implementation, whose concurrency behavior this package cannot
guarantee; the hook is unexported and slated for removal, so the
wording treats concurrency safety as a requirement on such
implementations.
Document this on NewGCM, and add a test that shares one AEAD across
goroutines running Seal and Open round-trips with distinct nonces, so
the race detector can check the property. The test covers the AES and
fallback implementations via testAllImplementations.
Fixes #41689