1
0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-08-05 19:35:48 +03:00
Commit Graph

1080 Commits

Author SHA1 Message Date
Gilles Peskine
159a652096 Minor clarifications
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
5acb3a5969 Copyediting
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
ac18d0c0db Fix spelling of mbedtls_low_level_strerr
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
9b69972589 Remove crypto error codes, refer to the crypto guide instead
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
bf92bae959 Copy error-codes.md from tf-psa-crypto
Much of it also applies to Mbed TLS.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
d3a6cbb6bb Subsection for the removal of explicit RNG contexts
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
2649aa283b TLS key exchange removals
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
fbab8c1df1 General notes about the transition to PSA
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
72968cca33 Generalize the section on function prototype changes
Not everything will be about PSA.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
826225fe31 Migration guide entries for removed deprecated functions
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
a0e06dd6d3 Don't mention changes to fields that were already private
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
15037deab3 Consolidate changes to mbedtls_ssl_ticket_setup()
Describe the change to the cipher mechanism specification. Consolidate that
with the removal of the RNG arguments.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
663b6df522 Generalize section to other function prototype changes
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
617ee75e98 Copyediting and wording improvements
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
cd5abfe7b4 Move the X.509 and SSL content from the crypto migration guide
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
2607918066 Move PSA transition document to TF-PSA-Crypto
It went with Mbed TLS in the repository split, but belongs in TF-PSA-Crypto.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
1c2d9a3d74 Migration guide for OID
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-30 13:17:23 +02:00
Gilles Peskine
c10c233676 Migration guide: more info about private elements in public headers
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-25 15:39:35 +02:00
Gilles Peskine
2c77014bc0 Copy of text about private identifiers from crypto
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2025-06-25 15:39:10 +02:00
Gabor Mezei
10018fc82e Do not remeove macro from design doc
Signed-off-by: Gabor Mezei <gabor.mezei@arm.com>
2025-03-20 17:55:30 +01:00
Gabor Mezei
e1e27300a2 Remove MBEDTLS_KEY_EXCHANGE_RSA_ENABLED config option
Signed-off-by: Gabor Mezei <gabor.mezei@arm.com>
2025-03-20 17:53:01 +01:00
David Horstmann
1d181102fe Reword slightly to be more tentative
We don't guarantee ABI stability, but we do try to maintain it where we
can.

Signed-off-by: David Horstmann <david.horstmann@arm.com>
2025-03-14 10:50:20 +00:00
David Horstmann
079d7909a1 Add note about MBEDTLS_PRIVATE() in 3.6
Note that in the Mbed TLS 3.6 LTS, users can generally rely on being
able to access struct members through the MBEDTLS_PRIVATE() macro, since
we try to maintain ABI stability within an LTS version.

Signed-off-by: David Horstmann <david.horstmann@arm.com>
2025-03-13 16:49:08 +00:00
David Horstmann
edebcc04f8 Fix typos in the 3.0 migration guide
Signed-off-by: David Horstmann <david.horstmann@arm.com>
2025-03-13 15:52:00 +00:00
Harry Ramsey
f6fb2f0cb4 Update documentation regarding test_zeroize
This commit updates the paths in documentation for test_zeroize since
it has been moved to MbedTLS Framework.

Signed-off-by: Harry Ramsey <harry.ramsey@arm.com>
2025-02-19 15:30:25 +00:00
Valerio Setti
f886924eec docs: remove references to DHE-RSA
Signed-off-by: Valerio Setti <valerio.setti@nordicsemi.no>
2025-02-06 10:12:01 +01:00
Ronald Cron
189dcf630f Merge pull request #9910 from valeriosetti/issue9684
Remove DHE-PSK key exchange
2025-01-27 11:15:10 +00:00
Valerio Setti
27bc56303a docs: remove references of DHE-PSK
Signed-off-by: Valerio Setti <valerio.setti@nordicsemi.no>
2025-01-24 11:49:59 +01:00
Manuel Pégourié-Gonnard
490e30599b Stop recommended deprecated function in migration guide
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2025-01-23 09:33:59 +01:00
Janos Follath
3c4c647328 Merge pull request #9818 from yanesca/remove_USE_PSA_from_standalone_doc_9632
Remove discussions of MBEDTLS_USE_PSA_CRYPTO in standalone documentation
2025-01-02 15:45:03 +00:00
Janos Follath
e0037af243 Fix broken references in docs
Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 19:44:38 +00:00
Janos Follath
12438969fc Remove psa-migration/strategy.md
This document is mainly about a plan that was driven by backward
compatibility constraints that no longer exist in 4.0.

Although some of it is still of interest to explain why 4.0 is the way
it is (and more complicated than one would expect based on the APIs that
are left in 4.0). But for this it should suffice to consult earlier
versions and does not worth to maintain it.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:15:51 +00:00
Gilles Peskine
2301a10927 Distinguish between MBEDTLS_PSA_CRYPTO_C and MBEDTLS_PSA_CRYPTO_CLIENT
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2024-12-17 18:15:51 +00:00
Janos Follath
b51b73351d Fix sentences after removal of USE_PSA
Some sentences or paragraphs became confusing or meaningless after
removing USE_PSA and only fixing the local context/semantics.

Fix the semantics where needed and remove parts that became meaningless.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:15:17 +00:00
Janos Follath
3102c5985e Remove docs/use-psa-crypto.md
The original purpose of this document was to answer the following
question in more detail than the documentation of MBEDTLS_USE_PSA_CRYPTO
in config.h: as a user, what do I gain and lose if I enable
MBEDTLS_USE_PSA_CRYPTO? This question is no longer relevant.

- General considerations section: not relevant as mentioned above
- New APIs/API extensions: these are not new or extensions anymore.
  Also, for detailed information this section refers to the API
  documentation, which contains all the information the user needs.
- Internal changes: these are discussed in detail in
  docs/architecture/psa-migration/psa-limitations.md.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:12:02 +00:00
Janos Follath
62a1def446 Remove psa-migration/psa-legacy-bridges.md
This is an architecture document focusing on how PSA APIs can be mixed
with non-PSA APIs, notably including PK (and in fact, it's mostly about
PK, since we didn't identify work to be done in other areas). It is not
really relevant in 4.0/1.0, where the goals will be different — to do
without low-level legacy APIs.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:12:02 +00:00
Janos Follath
5e79f6a9ed Remove psa-migration/md-cipher-dispatch.md
This is an architecture document focusing on how parts of the code base
can accommodate both builds with PSA crypto disabled and builds with
driver-only mechanisms. Going forward, this coexistence is no longer
relevant.

The document does explain why some parts of md and cipher are the way
they are. In the future, we'll want to remove legacy code paths and keep
only the PSA code paths. But for that, it isn't particularly useful to
know how the dual code paths came about, or what constraints they had to
obey. Those constraints no longer apply.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:12:02 +00:00
Janos Follath
bd445afa27 Remove USE_PSA from remaining documentation
MBED_TLS_USE_PSA_CRYPTO is now always enabled we need to remove
documentation discussing cases when it is disabled.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:12:02 +00:00
Janos Follath
5b2ad4eda2 Remove USE_PSA from psa-migration/strategy.md
MBED_TLS_USE_PSA_CRYPTO is now always enabled we need to remove
documentation discussing cases when it is disabled.

The goal is not to update the document, only to remove
MBED_TLS_USE_PSA_CRYPTO, while making a minimal local context of the
occurrance up to date and sensible.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:08:55 +00:00
Janos Follath
2028b78793 Remove architecture/psa-migration/testing.md
This document is describes the testing strategy for the
`MBEDTLS_USE_PSA_CRYPTO` option. This option is now always on, can't be
disabled and the corresponding behaviour is the only library behaviour.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:08:55 +00:00
Janos Follath
d23266dc1f Remove USE_PSA from md-cipher-dispatch.md
MBED_TLS_USE_PSA_CRYPTO is now always enabled we need to remove
documentation discussing cases when it is disabled.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:08:55 +00:00
Janos Follath
1eb85624a6 Remove USE_PSA from use-psa-crypto.md
MBED_TLS_USE_PSA_CRYPTO is now always enabled we need to remove
documentation discussing cases when it is disabled.

Signed-off-by: Janos Follath <janos.follath@arm.com>
2024-12-17 18:08:55 +00:00
Minos Galanakis
fd6a810011 config_split.md: Removed reference to MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED.
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
2024-12-16 15:00:26 +00:00
Ronald Cron
9fb40d7e01 Move PSA documentation to tf-psa-crypto
Move the docuumentation files that after
the split will fit better in TF-PSA-Crypto
than Mbed TLS. No comment update.

Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2024-12-10 16:56:49 +01:00
Ronald Cron
ce3c2dd30c Merge pull request #9806 from ronald-cron-arm/finalize-split-preparation-1
Finalize split preparation-1
2024-12-05 13:23:09 +00:00
Ronald Cron
6a2cbe77fa Move driver wrappers generation to tf-psa-crypto
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2024-12-04 14:25:02 +01:00
Minos Galanakis
cb32d084aa crypto_config: Migrated newer configuration options.
This commit, moves configuration entries that were not present
during the design-review.

It also updates the proposal accordingly.

Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
2024-12-04 09:50:09 +00:00
Minos Galanakis
f33250fcc1 crypto_config: Migrated MBEDTLS_NULL_CIPHER in legacy-crypto
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
2024-12-04 09:49:55 +00:00
Manuel Pégourié-Gonnard
f27c10596b Merge pull request #9780 from emmanuel-ferdman/development
Update `crypto_se_driver.h` reference
2024-11-25 16:06:10 +00:00
Ronald Cron
93ba625b96 Remove MBEDTLS_PSA_CRYPTO_CONFIG configuration option
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2024-11-21 15:52:06 +01:00