Clarify the failure states for multi-part operation setup functions - #380
Open
athoelke wants to merge 1 commit into
Open
Clarify the failure states for multi-part operation setup functions#380athoelke wants to merge 1 commit into
athoelke wants to merge 1 commit into
Conversation
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.
In version 1.1, the error condition descriptions were clarified and aligned across the whole API, but in the process an error was introduced in the description of multi-part operation objects when the setup function returned an error. The typical wording is as follows:
The first statement is only true if the operation was inactive prior to the call. If the operation was not inactive then calling the setup function is going to return
PSA_ERROR_BAD_STATE(as the call is out of sequence) and put the operation object into an error state. TF-PSA-Crypto still implements the original MbedTLS behaviour from before Crypto API 1.1 - which is to put the object into an error state if it was not inactive prior to the setup call.This PR clarifies the behaviour and restores the missing (v1.0) conditions to all of the setup functions.