Mbed-TLS / mbedtls

An open source, portable, easy to use, readable and flexible TLS library, and reference implementation of the PSA Cryptography API. Releases are on a varying cadence, typically around 3 - 6 months between releases.
https://www.trustedfirmware.org/projects/mbed-tls/
Other
5.56k stars 2.61k forks source link

Clarify the status and possibly rename of intended-private PSA_xxx and psa_xxx identifiers #4415

Open gilles-peskine-arm opened 3 years ago

gilles-peskine-arm commented 3 years ago

PSA crypto headers define a number of PSA_xxx macro names that are not part of the PSA specification. Originally, the identifiers that were part of the specification were exactly the identifiers that had Doxygen documentation, although it's possible that there has been some divergence.

We should also make it clear which names are part of the Mbed TLS API and which ones are internal names that may change in future versions.

Goal of this task:

gilles-peskine-arm commented 3 months ago

What we should do in TF-PSA-Crypto 1.0:

gilles-peskine-arm commented 3 months ago

Preferably we should also ensure that it's clear to users which macros are part of the public API and which aren't. In particular, undocumented macros should not be included in Doxygen.