From 5e225e0c8b2fb1ceb290fe91170b0e2d5bc46259 Mon Sep 17 00:00:00 2001 From: Valerio Setti Date: Tue, 8 Oct 2024 17:29:41 +0200 Subject: [PATCH] tinycrypt: deprecate the library Since we now have PSA Crypto APIs/Mbed TLS alternatives for crypto operations in all Zephyr's codebase we can start the deprecation of the TinyCrypt libary (as planned from #43712). This commit is only the inital step: updates documentation and add the DEPRECATED Kconfig option to the TINYCRYPT one. Signed-off-by: Valerio Setti --- doc/releases/migration-guide-4.0.rst | 13 +++++++++++++ doc/releases/release-notes-4.0.rst | 10 ++++++++++ modules/Kconfig.tinycrypt | 1 + 3 files changed, 24 insertions(+) diff --git a/doc/releases/migration-guide-4.0.rst b/doc/releases/migration-guide-4.0.rst index 6c0f35ac5d4..b54ceca8366 100644 --- a/doc/releases/migration-guide-4.0.rst +++ b/doc/releases/migration-guide-4.0.rst @@ -75,6 +75,19 @@ Mbed TLS corresponding build symbol was removed in Mbed TLS 3.1.0 and is now assumed to be enabled. (:github:`77657`) +TinyCrypt +========= + +* Starting from this release the library is marked as deprecated (:github:`79566`). + The reasons for this are (:github:`43712``): + + * the upstream version of this library is unmaintained. + + * to reduce the number of crypto libraries available in Zephyr (currently there are + 3 different implementations: TinyCrypt, MbedTLS and PSA Crypto APIs). + + The PSA Crypto API is now the de-facto standard to perform crypto operations. + Trusted Firmware-M ================== diff --git a/doc/releases/release-notes-4.0.rst b/doc/releases/release-notes-4.0.rst index b470f5c4f2c..d13c4233726 100644 --- a/doc/releases/release-notes-4.0.rst +++ b/doc/releases/release-notes-4.0.rst @@ -56,6 +56,16 @@ Deprecated in this release * The :ref:`kscan_api` subsystem has been marked as deprecated. +* The TinyCrypt library was marked as deprecated (:github:`79566`). The reasons + for this are (:github:`43712``): + + * the upstream version of this library is unmaintained. + + * to reduce the number of crypto libraries available in Zephyr (currently there are + 3 different implementations: TinyCrypt, MbedTLS and PSA Crypto APIs). + + The PSA Crypto API is now the de-facto standard to perform crypto operations. + Architectures ************* diff --git a/modules/Kconfig.tinycrypt b/modules/Kconfig.tinycrypt index 168e05ed799..b54ad764128 100644 --- a/modules/Kconfig.tinycrypt +++ b/modules/Kconfig.tinycrypt @@ -9,6 +9,7 @@ config ZEPHYR_TINYCRYPT_MODULE config TINYCRYPT bool "TinyCrypt Support" depends on ZEPHYR_TINYCRYPT_MODULE + select DEPRECATED help This option enables the TinyCrypt cryptography library.