WIP: Remove our copy of the driver interface proposal #462

Draft
gilles-peskine-arm wants to merge 1 commit from gilles-peskine-arm/psa-driver-interface-spec-remove into development
gilles-peskine-arm commented 2025-09-17 06:36:35 -05:00 (Migrated from github.com)

The document is now owned by PSA.

Note: I'm not sure if we should remove our copy. If so, we shouldn't remove it just yet, we should at least wait until https://github.com/ARM-software/psa-api/pull/299 is merged.

Argument for keeping: we've published links to it. But these are links to the mbedtls repository, not to the crypto repository, so the mbedtls development branch is where people would look for it.

Argument for keeping: it describes what we're doing. The PSA spec may evolve and until we catch up with it, there would no longer be any documentation of what we're doing.

Argument for removal: if you want this document, it exists in the 3.6 LTS branch. (One change has been done since 3.6.0: 92673db5db, in the random section, which we don't implement.)

Argument for removal: we don't implement the whole document anyway, and we don't have anything written about which parts we do implement. So as long as PSA doesn't make incompatible changes, the PSA document is as good as our.

PR checklist

Please remove the segment/s on either side of the | symbol as appropriate, and add any relevant link/s to the end of the line.
If the provided content is part of the present PR remove the # symbol.

  • changelog provided | not required because:
  • framework PR provided Mbed-TLS/mbedtls-framework# | not required
  • mbedtls development PR provided Mbed-TLS/mbedtls# | not required because:
  • mbedtls 3.6 PR provided Mbed-TLS/mbedtls# | not required because:
  • tests provided | not required because:

Notes for the submitter

Please refer to the contributing guidelines, especially the
checklist for PR contributors.

Help make review efficient:

  • Multiple simple commits
    • please structure your PR into a series of small commits, each of which does one thing
  • Avoid force-push
    • please do not force-push to update your PR - just add new commit(s)
  • See our Guidelines for Contributors for more details about the review process.
The document is now owned by PSA. Note: I'm not sure if we _should_ remove our copy. If so, we shouldn't remove it just yet, we should at least wait until https://github.com/ARM-software/psa-api/pull/299 is merged. Argument for keeping: we've published links to it. But these are links to the mbedtls repository, not to the crypto repository, so the mbedtls development branch is where people would look for it. Argument for keeping: it describes what we're doing. The PSA spec may evolve and until we catch up with it, there would no longer be any documentation of what we're doing. Argument for removal: if you want this document, it exists in the 3.6 LTS branch. (One change has been done since 3.6.0: 92673db5db061562dd6713ec76150b4904c7a122, in the random section, which we don't implement.) Argument for removal: we don't implement the whole document anyway, and we don't have anything written about which parts we do implement. So as long as PSA doesn't make incompatible changes, the PSA document is as good as our. ## PR checklist Please remove the segment/s on either side of the | symbol as appropriate, and add any relevant link/s to the end of the line. If the provided content is part of the present PR remove the # symbol. - [ ] **changelog** provided | not required because: - [ ] **framework PR** provided Mbed-TLS/mbedtls-framework# | not required - [ ] **mbedtls development PR** provided Mbed-TLS/mbedtls# | not required because: - [ ] **mbedtls 3.6 PR** provided Mbed-TLS/mbedtls# | not required because: - **tests** provided | not required because: ## Notes for the submitter Please refer to the [contributing guidelines](https://github.com/Mbed-TLS/TF-PSA-Crypto/blob/development/CONTRIBUTING.md), especially the checklist for PR contributors. Help make review efficient: * Multiple simple commits - please structure your PR into a series of small commits, each of which does one thing * Avoid force-push - please do not force-push to update your PR - just add new commit(s) * See our [Guidelines for Contributors](https://mbed-tls.readthedocs.io/en/latest/reviews/review-for-contributors/) for more details about the review process.
gilles-peskine-arm (Migrated from github.com) reviewed 2025-10-03 08:53:24 -05:00
@ -3,1465 +3,8 @@ PSA Cryptoprocessor Driver Interface
gilles-peskine-arm (Migrated from github.com) commented 2025-10-03 08:53:24 -05:00

If we remove the substance of this document, we should stop linking to it in README.md and elsewhere in our code base.

If we remove the substance of this document, we should stop linking to it in `README.md` and elsewhere in our code base.
This pull request is broken due to missing fork information.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin 'gilles-peskine-arm/psa-driver-interface-spec-remove:gilles-peskine-arm/psa-driver-interface-spec-remove'
git switch 'gilles-peskine-arm/psa-driver-interface-spec-remove'

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch 'development'
git merge --no-ff 'gilles-peskine-arm/psa-driver-interface-spec-remove'
git switch 'gilles-peskine-arm/psa-driver-interface-spec-remove'
git rebase 'development'
git switch 'development'
git merge --ff-only 'gilles-peskine-arm/psa-driver-interface-spec-remove'
git switch 'gilles-peskine-arm/psa-driver-interface-spec-remove'
git rebase 'development'
git switch 'development'
git merge --no-ff 'gilles-peskine-arm/psa-driver-interface-spec-remove'
git switch 'development'
git merge --squash 'gilles-peskine-arm/psa-driver-interface-spec-remove'
git switch 'development'
git merge --ff-only 'gilles-peskine-arm/psa-driver-interface-spec-remove'
git switch 'development'
git merge 'gilles-peskine-arm/psa-driver-interface-spec-remove'
git push origin 'development'
Sign in to join this conversation.
No reviewers
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!462
No description provided.