Improve Sign1Message.Sign1() docs #85
Merged
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
Signed-off-by: qmuntal <qmuntaldiaz@microsoft.com>
thomas-fossati
approved these changes
Jul 4, 2022
| // The signature is stored in m.Signature. | ||
| // | ||
| // Note that m.Signature is only valid as long as m.Headers.Protected and | ||
| // m.Payload remain unchanged after calling this method. |
There was a problem hiding this comment.
another condition that may be worth to flag is when external has changed
There was a problem hiding this comment.
external is not kept in any Sign1Message field but encoded as part of the signature, so modifying external after calling Sign1 should be a problem.
There was a problem hiding this comment.
yes, I'm not sure here we want to highlight all possible ways the computed signature can be invalidated, or only those conditions that depend on the state of the message that we store. That's why I left it to your judgement :-)
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.
Fix #68
Signed-off-by: qmuntal qmuntaldiaz@microsoft.com