[SDK-3606] Describe the types of key returned by generateRandomKey
#1320
Conversation
This file contains 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
My understanding of the intended use case of this method is that it allows a user to generate a key which they can then share with other parties through some side channel in order to establish encrypted communication with those parties. Hence, the output of generateRandomKey should not be an opaque value — the user needs to know how to interact with this value so that they can serialise it. Resolves #1296.
owenpearson
approved these changes
Jun 12, 2023
lawrence-forooghian
deleted the
1296-document-generateRandomKey-return-type
branch
hayleynewton
changed the title
generateRandomKeygenerateRandomKey
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.
My understanding of the intended use case of this method is that it allows a user to generate a key which they can then share with other parties through some side channel in order to establish encrypted communication with those parties. Hence, the output of
generateRandomKeyshould not be an opaque value — the user needs to know how to interact with this value so that they can serialise it.Resolves #1296 (this commit was originally included in #1299, why is why that PR claimed to resolve this issue, but I accidentally dropped this commit from that PR at some point).