mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-04-17 11:43:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Remove USE_PSA references from X509 documentation

Browse Source 
MBEDTLS_USE_PSA_CRYPTO is now always enabled we need to update the
documentation accordingly.

Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
Janos Follath 2024-11-19 16:17:07 +00:00
parent 130ece0b6e
commit 582ecd0ce1
3 changed files with 22 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
include/mbedtls/x509_crl.h
View File

@ -95,9 +95,8 @@ mbedtls_x509_crl;
/** /**
* \brief Parse a DER-encoded CRL and append it to the chained list * \brief Parse a DER-encoded CRL and append it to the chained list
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param chain points to the start of the chain * \param chain points to the start of the chain
* \param buf buffer holding the CRL data in DER format * \param buf buffer holding the CRL data in DER format
@ -113,9 +112,8 @@ int mbedtls_x509_crl_parse_der(mbedtls_x509_crl *chain,
* *
* \note Multiple CRLs are accepted only if using PEM format * \note Multiple CRLs are accepted only if using PEM format
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param chain points to the start of the chain * \param chain points to the start of the chain
* \param buf buffer holding the CRL data in PEM or DER format * \param buf buffer holding the CRL data in PEM or DER format
@ -132,9 +130,8 @@ int mbedtls_x509_crl_parse(mbedtls_x509_crl *chain, const unsigned char *buf, si
* *
* \note Multiple CRLs are accepted only if using PEM format * \note Multiple CRLs are accepted only if using PEM format
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param chain points to the start of the chain * \param chain points to the start of the chain
* \param path filename to read the CRLs from (in PEM or DER encoding) * \param path filename to read the CRLs from (in PEM or DER encoding)

25
include/mbedtls/x509_crt.h
View File

@ -345,9 +345,8 @@ extern const mbedtls_x509_crt_profile mbedtls_x509_crt_profile_none;
* \brief Parse a single DER formatted certificate and add it * \brief Parse a single DER formatted certificate and add it
* to the end of the provided chained list. * to the end of the provided chained list.
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param chain The pointer to the start of the CRT chain to attach to. * \param chain The pointer to the start of the CRT chain to attach to.
* When parsing the first CRT in a chain, this should point * When parsing the first CRT in a chain, this should point
@ -410,9 +409,8 @@ typedef int (*mbedtls_x509_crt_ext_cb_t)(void *p_ctx,
* \brief Parse a single DER formatted certificate and add it * \brief Parse a single DER formatted certificate and add it
* to the end of the provided chained list. * to the end of the provided chained list.
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param chain The pointer to the start of the CRT chain to attach to. * \param chain The pointer to the start of the CRT chain to attach to.
* When parsing the first CRT in a chain, this should point * When parsing the first CRT in a chain, this should point
@ -464,9 +462,8 @@ int mbedtls_x509_crt_parse_der_with_ext_cb(mbedtls_x509_crt *chain,
* temporary ownership of the CRT buffer until the CRT * temporary ownership of the CRT buffer until the CRT
* is destroyed. * is destroyed.
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param chain The pointer to the start of the CRT chain to attach to. * \param chain The pointer to the start of the CRT chain to attach to.
* When parsing the first CRT in a chain, this should point * When parsing the first CRT in a chain, this should point
@ -508,9 +505,8 @@ int mbedtls_x509_crt_parse_der_nocopy(mbedtls_x509_crt *chain,
* long as the certificates are enclosed in the PEM specific * long as the certificates are enclosed in the PEM specific
* '-----{BEGIN/END} CERTIFICATE-----' delimiters. * '-----{BEGIN/END} CERTIFICATE-----' delimiters.
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param chain The chain to which to add the parsed certificates. * \param chain The chain to which to add the parsed certificates.
* \param buf The buffer holding the certificate data in PEM or DER format. * \param buf The buffer holding the certificate data in PEM or DER format.
@ -536,9 +532,8 @@ int mbedtls_x509_crt_parse(mbedtls_x509_crt *chain, const unsigned char *buf, si
* of failed certificates it encountered. If none complete * of failed certificates it encountered. If none complete
* correctly, the first error is returned. * correctly, the first error is returned.
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param chain points to the start of the chain * \param chain points to the start of the chain
* \param path filename to read the certificates from * \param path filename to read the certificates from

15
include/mbedtls/x509_csr.h
View File

@ -79,9 +79,8 @@ mbedtls_x509write_csr;
* ignored, unless the critical flag is set, in which case * ignored, unless the critical flag is set, in which case
* the CSR is rejected. * the CSR is rejected.
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param csr CSR context to fill * \param csr CSR context to fill
* \param buf buffer holding the CRL data * \param buf buffer holding the CRL data
@ -135,9 +134,8 @@ typedef int (*mbedtls_x509_csr_ext_cb_t)(void *p_ctx,
* the result of the callback function decides whether * the result of the callback function decides whether
* CSR is rejected. * CSR is rejected.
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param csr CSR context to fill * \param csr CSR context to fill
* \param buf buffer holding the CRL data * \param buf buffer holding the CRL data
@ -158,9 +156,8 @@ int mbedtls_x509_csr_parse_der_with_ext_cb(mbedtls_x509_csr *csr,
* *
* \note See notes for \c mbedtls_x509_csr_parse_der() * \note See notes for \c mbedtls_x509_csr_parse_der()
* *
* \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto * \note The PSA crypto subsystem must have been initialized by
* subsystem must have been initialized by calling * calling psa_crypto_init() before calling this function.
* psa_crypto_init() before calling this function.
* *
* \param csr CSR context to fill * \param csr CSR context to fill
* \param buf buffer holding the CRL data * \param buf buffer holding the CRL data