aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJanne Peltonen <janne.peltonen@nokia.com>2023-02-20 19:29:35 +0200
committerMatias Elo <matias.elo@nokia.com>2023-04-12 15:52:37 +0300
commit037a579d6af0ef1313e53c9141d637ee1760faa6 (patch)
tree2e697931eff8eb5122f3cbec308596724230f6c2 /include
parent31f1882ae2386011a5220ece9aec0b3b9d5e3b68 (diff)
api: crypto: clarify that algorithm order is ignored with null algs
When either the cipher or the authentication algorithm is null, the auth_cipher_text session parameter that specifies the processing order of the algorithms does not have any effect but both orders are supposed to work. Clarify the semantics by stating that the parameter is ignored when one of the algorithms is null. Signed-off-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Anoob Joseph <anoobj@marvell.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
Diffstat (limited to 'include')
-rw-r--r--include/odp/api/spec/crypto_types.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/odp/api/spec/crypto_types.h b/include/odp/api/spec/crypto_types.h
index 7ddb7b19f..0a5051d07 100644
--- a/include/odp/api/spec/crypto_types.h
+++ b/include/odp/api/spec/crypto_types.h
@@ -578,7 +578,8 @@ typedef struct odp_crypto_session_param_t {
* indicates the reverse order of operation.
*
* The value is ignored with authenticated encryption algorithms
- * such as AES-GCM.
+ * such as AES-GCM. The value is also ignored when one of the
+ * algorithms is null.
*
* true: Authenticate cipher text
* false: Authenticate plain text