aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)AuthorFilesLines
26 hoursAdapt documentationRonald Cron1-3/+3
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2024-03-18Replace reference to masterDave Rodgman1-1/+1
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2024-03-15Merge pull request #8923 from bensze01/drop-old-compilersBence Szépkúti1-3/+3
Drop Support for MSVC 2013, 2015 and Arm Compiler 5
2024-03-13missing wordGilles Peskine1-1/+1
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2024-03-13Update compilers list in docs and changelogBence Szépkúti1-3/+3
Drop support for MSVC 2013, 2015 and Arm Compiler 5 Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com>
2024-03-04Note the need to tell git to set up the submoduleGilles Peskine1-0/+4
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2023-11-03README improvements to 3rdparty sectionDave Rodgman1-2/+2
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-11-03Update license for p256-mDave Rodgman1-1/+1
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-11-02Update documentationDave Rodgman1-1/+1
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-07-26Have a single source of truth for licensing informationTom Cosgrove1-1/+2
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-26Clarify in README.md that 'the project' is Mbed TLSTom Cosgrove1-1/+1
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
2023-07-07Merge pull request #7867 from gilles-peskine-arm/readme-python3.8Dave Rodgman1-2/+2
Officially require Python 3.8
2023-07-06Merge pull request #7492 from gilles-peskine-arm/psa-driver-doc-entry-pointDave Rodgman1-6/+8
README: add section about drivers
2023-07-06Link to the guide for writing a driverGilles Peskine1-5/+1
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-03Officially require Python 3.8Gilles Peskine1-2/+2
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-03Correct Python requirements in releasesGilles Peskine1-1/+1
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-04-28Add warnings to documentation stating that p256-m code may be out of date ↵Aditya Deshpande1-2/+2
with upstream, plus other minor grammatical fixes. Signed-off-by: Aditya Deshpande <aditya.deshpande@arm.com>
2023-04-28Add 3rdparty license information to the READMEAditya Deshpande1-0/+6
Signed-off-by: Aditya Deshpande <aditya.deshpande@arm.com>
2023-04-25README: add section about driversGilles Peskine1-6/+12
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-03-07Improve pip instructionsGilles Peskine1-2/+3
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-02-10Document SIZE_MAX requirement in README.mdDave Rodgman1-0/+1
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2023-01-11Update README and add changelog entryDave Rodgman1-1/+1
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-12-15Point to docker images used in the CIManuel Pégourié-Gonnard1-0/+2
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2022-12-01Clarify support for mixed-endian platformsDave Rodgman1-0/+1
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-31Update PSA links in README.mdDave Rodgman1-7/+3
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-26Remove unused perl dependency scriptsAndrzej Kurek1-1/+1
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-12Improve wording re: PSA CryptoDave Rodgman1-1/+1
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-12Update documentation linksDave Rodgman1-6/+8
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-07-04Tune description of PSA crypto implementationManuel Pégourié-Gonnard1-3/+1
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2022-07-04Update README about USE_PSA_CRYPTOManuel Pégourié-Gonnard1-1/+1
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2022-03-31Update references to old Github organisationDave Rodgman1-2/+2
Replace references to ARMmbed organisation with the new org, Mbed-TLS, following project migration. Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-12-09readme: Addressed review comments #2minosgalanakis1-1/+1
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com> Co-authored-by: davidhorstmann-arm <70948878+davidhorstmann-arm@users.noreply.github.com>
2021-12-09readme: Addressed review commentsMinos Galanakis1-6/+5
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
2021-12-09Updated readmeMinos Galanakis1-0/+9
This patch adds explicit implementation requirements for platforms architecture dependencies Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
2021-11-17Add requirement on Jinja to integrate driversGilles Peskine1-1/+4
Driver implementers need to regenerate wrappers. This will use Jinja2 as discussed in https://github.com/ARMmbed/mbedtls/pull/5067#discussion_r738794607 On the development branch, driver integration is always needed to generate the driver wrapper and thus to build the library, so this requirement applies to everyone, not just driver implementers. In releases, we plan to include a default driver wrapper with support for basic use cases only, meaning that the line `-r driver.requirements.txt` should be removed from `basic.requirements.txt` in releases. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2021-11-03DT_NEEDED for shared builds in makefileHarmen Stoppels1-1/+1
The makefile build specifies -L. -lmbedx509 -lmbedcrypto flags first, and only then object files referencing symbols from those libraries. In this order the linker will not add the linked libraries to the DT_NEEDED section because they are not referenced yet (at least that happens for me on ubuntu 20.04 with the default gnu compiler tools). By first specifying the object files and then the linked libraries, we do end up with libmbedx509 and libmbedcrypto in the DT_NEEDED sections. This way running dlopen(...) on libmedtls.so just works. Note that the CMake build does this by default. Signed-off-by: Harmen Stoppels <harmenstoppels@gmail.com>
2021-10-25Document the CMake generated files capabilityDavid Horstmann1-0/+1
Add a line in the README explaining that CMake will generate the files it needs automatically on non-Windows systems when not cross-compiling. Signed-off-by: David Horstmann <david.horstmann@arm.com>
2021-09-30Add contact information directly on the home pageGilles Peskine1-0/+7
This information was already present in SECURITY.md and SUPPORT.md, but that wasn't very apparent. Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2021-07-01Remove warning of development instability from READMEDave Rodgman1-5/+0
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-28Rename config.h to mbedtls_config.hBence Szépkúti1-3/+3
This commit was generated using the following script: # ======================== #!/bin/sh git ls-files | grep -v '^ChangeLog' | xargs sed -b -E -i ' s/((check|crypto|full|mbedtls|query)_config)\.h/\1\nh/g s/config\.h/mbedtls_config.h/g y/\n/./ ' mv include/mbedtls/config.h include/mbedtls/mbedtls_config.h # ======================== Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com>
2021-06-25Merge pull request #4259 from CJKay/cmake-configDave Rodgman1-0/+27
Add CMake package config file
2021-06-07Update README to document minimum tool versionsDave Rodgman1-5/+8
Fixes #4379. Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-04Add CMake package config fileChris Kay1-0/+27
This change enables automatic detection and consumption of Mbed TLS library targets from within other CMake projects. By generating an `MbedTLSConfig.cmake` file, consuming projects receive a more complete view of these targets, allowing them to be used as dependencies which properly inherit the transitive dependencies of the libraries. This is fairly fragile, as it seems Mbed TLS's libraries do not appear to properly model their dependencies on other targets, including third-party dependencies. It is, however, sufficient for building and linking the compiled Mbed TLS libraries when there are no third-party dependencies involved. Further work is needed for more complex use-cases, but this will likely meet the needs of most projects. Resolves #298. Probably useful for #2857. Signed-off-by: Chris Kay <chris.kay@arm.com>
2021-05-20Document how to build the generated source filesGilles Peskine1-2/+23
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2021-04-26Documentation updates for Mbed TLS 3.0Dave Rodgman1-0/+5
Update documentation to reflect the branch changes. Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-02-25Add cross-doc links, avoid redundanciesManuel Pégourié-Gonnard1-0/+2
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2020-11-10psa: Move from key handle to key identifierRonald Cron1-1/+1
Move all the PSA crypto APIs using key handles to use key identifiers but psa_key_open() and psa_key_close(). This is done without modifying any test as key handles and key identifiers are now the same. Update the library modules using PSA crypto APIs to get rid of key handles. Programs and unit tests are updated to not use key handles in subsequent commits, not in this one. Signed-off-by: Ronald Cron <ronald.cron@arm.com>
2020-04-03docs: show cross platform instructionsCarlos Gomes Martinho1-2/+2
Signed-off-by: Carlos Gomes Martinho <carlos.gomes_martinho@siemens.com>
2020-03-19Fix extra coma in README.mdManuel Pégourié-Gonnard1-1/+1
Co-Authored-By: Andrzej Kurek <andrzej.kurek@arm.com>
2020-03-09Don't use the PSA specification as Mbed TLS documentationGilles Peskine1-2/+4
The Doxygen-generated manual includes PSA interfaces, so we don't need to tell people to read the specification instead. Do link to the specification portal, but from the PSA API section, not from the Mbed TLS documentation section.
generated by cgit v1.1 at 2024-07-11 08:38:37 +0000