Document mbedtls_pk_can_do_ext() return for non-allowed algorithms and usage flags

Signed-off-by: Neil Armstrong <narmstrong@baylibre.com>
This commit is contained in:
Neil Armstrong 2022-05-20 09:28:12 +02:00
parent 81d391f773
commit a724f7ae17

View file

@ -430,7 +430,8 @@ int mbedtls_pk_can_do( const mbedtls_pk_context *ctx, mbedtls_pk_type_t type );
* *
* \return 1 if the context can do operations on the given type. * \return 1 if the context can do operations on the given type.
* \return 0 if the context cannot do the operations on the given * \return 0 if the context cannot do the operations on the given
* type. This is always the case for a context that has * type, or for non-allowed algorithms and usage flags.
* This is always the case for a context that has
* been initialized but not set up, or that has been * been initialized but not set up, or that has been
* cleared with mbedtls_pk_free(). * cleared with mbedtls_pk_free().
*/ */