1
0
mirror of https://github.com/ARMmbed/mbedtls.git synced 2025-10-21 14:51:23 +08:00
Commit Graph

118 Commits

Author SHA1 Message Date
Ronald Cron
63180eb132 README.md: Adjust CMake minimum version
Adjust CMake minimum version to 3.20.2.
That is the version in CentOS which is
the rolling-delivery upstream of
RHEL 9.

Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-06 11:12:44 +02:00
Ronald Cron
864c31a1f8 README.md: IAR not currently used in our testing
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-06 11:12:43 +02:00
Ronald Cron
b906301e10 Various minor improvements
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-06 11:11:18 +02:00
Ronald Cron
8267196b8b README.md: Add mention to topics.html for Doxygen documentation
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-05 18:13:17 +02:00
Ronald Cron
74a4984eac README.md: Fix/Improve CMake section
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-03 11:27:48 +02:00
Ronald Cron
c9998d399b README.md: Fix/Update the "Git usage" section
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-03 11:27:42 +02:00
Ronald Cron
c9d79ff0d4 README.md: Various small improvements
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-02 19:14:20 +02:00
Ronald Cron
e2d4684ec4 README.md: Update tests section
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-02 14:57:48 +02:00
Ronald Cron
4ccdaf1cd5 README.md: Update minimum version of tools
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-02 14:57:33 +02:00
Ronald Cron
7cf78b4c2c README.md: Update build sections
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-02 13:33:36 +02:00
Ronald Cron
200b89bb87 README.md: Update/Fix documentation section
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-02 13:33:36 +02:00
Ronald Cron
0f2ef4a896 README.md: Update Configuration section
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-02 13:33:36 +02:00
Ronald Cron
eef87b348f README.md: Microsoft Visual Studio is not directly supported anymore
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-02 13:33:36 +02:00
Ronald Cron
d196cbd3e5 README.md: The crypto code is provided by TF-PSA-Crypto
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-10-02 13:33:31 +02:00
Ronald Cron
ee63b64892 Update README.md
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-09-22 18:00:26 +02:00
David Horstmann
24e3388cf3 Clarify use of CC and friends for file generation
Add more detail around how generation of configuration-independent files
chooses a C compiler. Mention that setting HOSTCC or CC is recommended
where there are multiple toolchains.

Mention that the fallback location is the cc executable, which may help
users troubleshooting when the file generation picks up the wrong
toolchain (as in Mbed-TLS/mbedtls#10360).

Signed-off-by: David Horstmann <david.horstmann@arm.com>
2025-08-19 16:56:25 +01:00
Ronald Cron
444db895f7 Remove check-generated-files.sh
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2025-03-31 17:18:03 +02:00
David Horstmann
e35672940c Update broken link to PSA driver dev examples
This link is broken in development as the document has been moved to the
TF-PSA-Crypto repository.

Signed-off-by: David Horstmann <david.horstmann@arm.com>
2025-03-13 16:53:27 +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
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
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
Ronald Cron
8126a686d9 cmake: Rename mbedcrypto library to tfpsacrypto
Do not do the same in the make build system yet,
cmake build system only scope for this PR.

Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2024-11-14 09:28:27 +01:00
Ronald Cron
cf1af5a6b3 Adapt some documentation
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2024-07-19 10:07:27 +02:00
Ronald Cron
bdd8df852f Adapt documentation
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2024-07-10 08:10:40 +02:00
Dave Rodgman
0da8c514c3 Replace reference to master
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2024-03-18 15:25:53 +00:00
Bence Szépkúti
567591eec7 Merge pull request #8923 from bensze01/drop-old-compilers
Drop Support for MSVC 2013, 2015 and Arm Compiler 5
2024-03-15 12:56:21 +00:00
Gilles Peskine
93b282232f missing word
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2024-03-13 13:08:57 +01:00
Bence Szépkúti
ae0d97ab8b Update compilers list in docs and changelog
Drop support for MSVC 2013, 2015 and Arm Compiler 5

Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com>
2024-03-13 11:23:16 +01:00
Gilles Peskine
0c3f0e998d Note the need to tell git to set up the submodule
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2024-03-04 17:12:59 +01:00
Dave Rodgman
af54378af4 README improvements to 3rdparty section
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-11-03 11:34:40 +00:00
Dave Rodgman
fffeae8387 Update license for p256-m
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-11-03 09:31:36 +00:00
Dave Rodgman
8ce51708da Update documentation
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-11-02 19:52:22 +00:00
Tom Cosgrove
f884e603b9 Have a single source of truth for licensing information
We had information in both README.md and CONTRIBUTING.md about Mbed TLS licensing,
but the information in CONTRIBUTING.md was missing that authors still need to
accept that their contributions may be distributed under both Apache 2.0 and
GPLv2-or-later.

Move all but the most high-level “Mbed TLS files are provided under the
Apache-2.0 license” statement to CONTRIBUTING.md, and tidy up the text a bit.

Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
2023-07-26 11:46:31 +01:00
Tom Cosgrove
e0ac2ffbf0 Clarify in README.md that 'the project' is Mbed TLS
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
2023-07-26 11:46:31 +01:00
Dave Rodgman
1917ee7cd1 Merge pull request #7867 from gilles-peskine-arm/readme-python3.8
Officially require Python 3.8
2023-07-07 09:58:15 +01:00
Dave Rodgman
aa00e81901 Merge pull request #7492 from gilles-peskine-arm/psa-driver-doc-entry-point
README: add section about drivers
2023-07-06 15:35:18 +01:00
Gilles Peskine
e1d5b07304 Link to the guide for writing a driver
Don't link to the proposed specifications: they aren't good entry points
because they describe what we want to achieve, not what exists today. The
guide links to them, that's enough.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2023-07-06 13:13:43 +02:00
Gilles Peskine
958346917c Officially require Python 3.8
Our code is still compatible with Python 3.5 at the time of writing, but we
don't want to commit to that.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2023-07-03 17:59:37 +02:00
Gilles Peskine
552c9ab8c4 Correct Python requirements in releases
The wording wasn't quite right for 3.0.0 and up: there's nothing special
about Python and sample programs (that was true in the end times of 2.x, but
not since 3.0). Python is not needed in a release unless you want to build
the tests or you want to integrate PSA drivers without writing your own C
wrappers.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2023-07-03 17:54:26 +02:00
Aditya Deshpande
f100f00679 Add warnings to documentation stating that p256-m code may be out of date with upstream, plus other minor grammatical fixes.
Signed-off-by: Aditya Deshpande <aditya.deshpande@arm.com>
2023-04-28 17:54:15 +01:00
Aditya Deshpande
8d99f2590c Add 3rdparty license information to the README
Signed-off-by: Aditya Deshpande <aditya.deshpande@arm.com>
2023-04-28 17:54:15 +01:00
Gilles Peskine
17467c59b2 README: add section about drivers
Everything discussed in "Upcoming features" section is now available as a
usable, but incomplete feature (except "wider set of cryptographic
algorithms", but that doesn't need to be said). So replace it by a section
that briefly presents these features: drivers, and MBEDTLS_PSA_CRYPTO_CONFIG
which is primarily useful with drivers and thus doesn't get its own section.

Include an explicit note that the driver interface can still change. At this
time, it's the only place where we say that the driver interface is not
covered by the (application) interface stability promise.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2023-04-25 21:17:03 +02:00
Gilles Peskine
429e90153c Improve pip instructions
Our build scripts invoke `python3` in preference to `python`, so make the
default instruction use `python3`. On many systems (macOS, some Linux),
`python` invokes Python 2 which our scripts do not support.

Suggest --user by default. It's usually the right thing outside of venvs.

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2023-03-07 20:40:04 +01:00
Dave Rodgman
37296a413a Document SIZE_MAX requirement in README.md
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-02-10 15:39:22 +00:00
Dave Rodgman
05bdb13be3 Update README and add changelog entry
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-01-11 18:56:11 +00:00
Manuel Pégourié-Gonnard
59626b6179 Point to docker images used in the CI
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2022-12-15 10:08:26 +01:00
Dave Rodgman
28f424f238 Clarify support for mixed-endian platforms
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-12-01 09:49:44 +00:00
Dave Rodgman
12cee78ea7 Update PSA links in README.md
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-31 15:34:11 +00:00
Andrzej Kurek
29c002ebdf Remove unused perl dependency scripts
curves.pl, depends-hashes.pl, key-exchanges.pl and depends-pkalgs.pl are now superseded by depends.py.
Update all references to them accordingly.
Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com>
2022-10-26 08:26:58 -04:00
Dave Rodgman
7dbfed3b44 Improve wording re: PSA Crypto
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-12 17:27:32 +01:00