Doc: botan_cipher_update() byte generation behavior #4088
Merged
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.
This is in response to a downstream user question. Before finalization, when passing
x
input bytes tobotan_cipher_update
it will at most generatex
output bytes. However, it might generate less bytes. For instance, SIV-mode won't generate any output until the message is finalized. Typically, the number of output bytes produced will be equal to the number of input bytes consumed. Note however, thatbotan_cipher_update
might not consume all input bytes provided.Note that, during finalization
botan_cipher_update()
may generate more output bytes than input bytes. Namely, when encrypting using an AEAD, the authentication tag is added. If there's not enough space in the user-provided output buffer,BOTAN_FFI_ERROR_INSUFFICIENT_BUFFER_SPACE
will be returned andoutput_written
will be set to the number of bytes required for a successful finalization.