tree 8ec6a8683ea8ce76e3f9d8f07bd37a2d6f105e40
parent 40d79cef351cba835392d42803bb47421f4d8174
author Gilles Peskine <Gilles.Peskine@arm.com> 1678216971 +0100
committer Gilles Peskine <Gilles.Peskine@arm.com> 1678217102 +0100

Document the need to call psa_crypto_init() with USE_PSA_CRYPTO

When MBEDTLS_USE_PSA_CRYPTO is enabled, the application must call
psa_crypto_init() before directly or indirectly calling cipher or PK code
that will use PSA under the hood. Document this explicitly for some
functions.

To avoid clutter, this commit only documents the need to call
psa_crypto_init() in common, non-obvious cases: using a PK object that was
not constructed using PSA, X.509 processing, or setting up an SSL context.
Functions that are normally only called after such a function (for example,
using a cipher or PK context constructed from a PSA key), or where the need
for PSA is obvious because they take a key ID as argument, do not need more
explicit documentaion.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>