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

New issue

Open

opened 2021-04-26 04:14:19 -05:00 by gilles-peskine-arm · 2 comments

gilles-peskine-arm commented

2021-04-26 04:14:19 -05:00

(Migrated from github.com)

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:

Make it clear in the Mbed TLS documentation (both when reading headers and when reading Doxygen documentation) which identifiers are from a PSA standard, which are specific to the Mbed TLS API, and which are specific to the current version of Mbed TLS.
Possibly rename identifers that are not PSA standard or PSA standard track to start with MBEDTLS_xxx.
Possibly rename functions and types that are not PSA standard (track) to mbedtls_xxx.

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: * Make it clear in the Mbed TLS documentation (both when reading headers and when reading Doxygen documentation) which identifiers are from a PSA standard, which are specific to the Mbed TLS API, and which are specific to the current version of Mbed TLS. * Possibly rename identifers that are not PSA standard or PSA standard track to start with `MBEDTLS_xxx`. * Possibly rename functions and types that are not PSA standard (track) to `mbedtls_xxx`.

gilles-peskine-arm commented

2024-08-07 09:55:53 -05:00

(Migrated from github.com)

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

Rename all the mbedtls_xxx functions and types defined in psa/*.h to tfc_xxx.
Also, consistently, rename the psa_xxx that are not on track for PSA standardization.
Also a few types need to be renamed.

What we should do in TF-PSA-Crypto 1.0: * Rename all the `mbedtls_xxx` functions and types defined in `psa/*.h` to `tfc_xxx`. * Also, consistently, rename the `psa_xxx` that are not on track for PSA standardization. * Also a few types need to be renamed.

gilles-peskine-arm commented

2024-08-08 09:22:11 -05:00

(Migrated from github.com)

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.

No milestone

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

gh-Mbed-TLS/TF-PSA-Crypto#608

No description provided.

Rows
Columns