diff options
| author | Janne Peltonen <janne.peltonen@nokia.com> | 2021-11-16 11:55:47 +0200 |
|---|---|---|
| committer | Petri Savolainen <petri.savolainen@nokia.com> | 2021-12-08 16:14:46 +0200 |
| commit | 2f6012475efd1a6dc1333f13d77b56259d20a08b (patch) | |
| tree | 7ab210d18596ae58c5acfcb188730856179a2d25 /include/odp/api/spec/crypto.h | |
| parent | fda95dde38de4abd30a8c86fa968ab87a9170b96 (diff) | |
api: crypto: clarify that session parameters can be freed
Mention explicitly that session creation parameters, including the
key and IV data, can be freed after session creation. This has always
been the intention but maybe not clear enough in the API spec.
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/odp/api/spec/crypto.h')
| -rw-r--r-- | include/odp/api/spec/crypto.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/odp/api/spec/crypto.h b/include/odp/api/spec/crypto.h index bfda0bcee..d3e3c9a07 100644 --- a/include/odp/api/spec/crypto.h +++ b/include/odp/api/spec/crypto.h @@ -1053,6 +1053,9 @@ int odp_crypto_auth_capability(odp_auth_alg_t auth, * default values. If call ends up with an error no new session will be * created. * + * The parameter structure as well as the key and IV data pointed to by it + * can be freed after the call. + * * @param param Session parameters * @param[out] session Created session else ODP_CRYPTO_SESSION_INVALID * @param[out] status Failure code if unsuccessful |