Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove discussions of MBEDTLS_USE_PSA_CRYPTO in documentation #9632

Closed
gilles-peskine-arm opened this issue Sep 24, 2024 · 3 comments
Closed
Labels
component-crypto Crypto primitives and low-level interfaces size-s Estimated task size: small (~2d)

Comments

@gilles-peskine-arm
Copy link
Contributor

Remove discussions of MBEDTLS_USE_PSA_CRYPTO in documentation. The documentation should now only what was formerly the behavior when MBEDTLS_USE_PSA_CRYPTO is enabled.

Note that while docs/use-psa-crypto.md will be partly obsolete (e.g. “why enable” is no longer relevant), some of the information is still relevant (at least limitations).

Follow-up to #9630

@gilles-peskine-arm gilles-peskine-arm added component-crypto Crypto primitives and low-level interfaces size-xs Estimated task size: extra small (a few hours at most) labels Sep 24, 2024
@gilles-peskine-arm gilles-peskine-arm moved this to Implementation needed in Mbed TLS 4.0 planning Sep 24, 2024
@gilles-peskine-arm gilles-peskine-arm added size-s Estimated task size: small (~2d) and removed size-xs Estimated task size: extra small (a few hours at most) labels Oct 9, 2024
@gilles-peskine-arm
Copy link
Contributor Author

gilles-peskine-arm commented Oct 9, 2024

I'm upping the size estimate. This is easy, but tedious: each place where MBEDTLS_USE_PSA_CRYPTO is mentioned is easy or trivial to update, but there are a lot of them.

@yanesca
Copy link
Contributor

yanesca commented Nov 19, 2024

Manually inspected the files coming up in

grep -rIn -i 'USE[-_]PSA' . | sed 's/\([a-zA-Z0-9/_.]*:\).*/\1/' | uniq

and arrived at the following categorisation:

No Changes

./ChangeLog.d/
./tests/ - Tracked in #9726, code or better done as part of #9631
./tf-psa-crypto/tests/ - Code or better done as part of #9631
./tf-psa-crypto/drivers/builtin/src - Code or better done as part of #9631
./programs/ - Code or better done as part of #9631
./library/ - Code or better done as part of #9631
./framework/scripts/ - Code or better done as part of #9631

API documentation

PR: #9781

./tf-psa-crypto/drivers/builtin/include
./include/
./configs/

Standalone documentation

PR: #9818

./docs/
./README.md:

@yanesca
Copy link
Contributor

yanesca commented Jan 3, 2025

Both PRs implementing this change have been merged.

@yanesca yanesca closed this as completed Jan 3, 2025
@github-project-automation github-project-automation bot moved this from Implementation needed to Done in Mbed TLS 4.0 planning Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component-crypto Crypto primitives and low-level interfaces size-s Estimated task size: small (~2d)
Projects
Status: Done
Status: PSA Crypto Always On
Development

No branches or pull requests

2 participants