add bulk decryption API /v1/key/bulk/decrypt
#210
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
This commit adds a new bulk API:
```
/v1/key/bulk/decrypt
```
Now, a client can request the corresponding
plaintext / context pairs for multiple
ciphertext / context pairs in a single call.
Before, a client had to send each plaintext / context
pair to the server using the `/v1/key/decrypt` API.
The new bulk API expects an array of ciphertext / context
pairs. Each context is still optional but must match
the context used during encryption:
```json
[
{
"ciphertext": "...",
"context":"..."
},
{
"ciphertext":"..."
},
{
"ciphertext":"...",
"context":"..."
}
]
```
It will respond either with an array of plaintexts
or the first decryption error. It only returns
plaintexts if and only if it decrypted
all ciphertexts successfully.
```json
[
{
"plaintext": "...",
},
{
"plaintext":"..."
},
{
"plaintext":"...",
}
]
```
At the moment, the `/v1/key/bulk/decrypt` API limits
the number of ciphertext / context pairs to `1000`
within a single API call.
Signed-off-by: Andreas Auernhammer <hi@aead.dev>
harshavardhana
approved these changes
Mar 22, 2022
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.
This commit adds a new bulk API:
Now, a client can request the corresponding
plaintext / context pairs for multiple
ciphertext / context pairs in a single call.
Before, a client had to send each plaintext / context
pair to the server using the
/v1/key/decryptAPI.The new bulk API expects an array of ciphertext / context
pairs. Each context is still optional but must match
the context used during encryption:
[ { "ciphertext": "...", "context":"..." }, { "ciphertext":"..." }, { "ciphertext":"...", "context":"..." } ]It will respond either with an array of plaintexts
or the first decryption error. It only returns
plaintexts if and only if it decrypted
all ciphertexts successfully.
[ { "plaintext": "...", }, { "plaintext":"..." }, { "plaintext":"...", } ]At the moment, the
/v1/key/bulk/decryptAPI limitsthe number of ciphertext / context pairs to
1000within a single API call.